outseta library

Dart API client for the Outseta.com REST API V1

This library provides a type-safe interface to the Outseta REST API, allowing you to interact with CRM, Billing, Marketing, and Support functions.

Classes

Account
Account model representing a customer account in the Outseta CRM
Address
Address model representing a physical address in the Outseta API
ApiKeyAuth
API key authentication for server-side use
BaseModel
Base class for all Outseta API models
BaseModelWithMetadata
Base class for models that include metadata
BearerTokenAuth
Bearer token authentication for client-side use
BillingApi
The Billing API client for managing subscriptions, invoices, and payments
CrmApi
The CRM API client for managing people, accounts, and deals
Deal
Deal model representing a sales opportunity in the Outseta CRM
Email
Email model representing an email campaign in the Outseta Marketing API
EmailList
EmailList model representing an email list in the Outseta Marketing API
Invoice
Invoice model representing a billing invoice in the Outseta API
MarketingApi
The Marketing API client for managing email campaigns, lists, and subscribers
Metadata
A class that represents metadata fields that are included in some API responses
OutsetaAuth
Base class for Outseta authentication methods
OutsetaClient
The main client for interacting with the Outseta API
PaginatedResponse<T>
A paginated response from the Outseta API
Pagination
A class that represents pagination metadata from the Outseta API responses
Payment
Payment model representing a payment transaction in the Outseta API
Person
Person model representing a contact in the Outseta CRM
Plan
Plan model representing a subscription plan in the Outseta API
Profile
Profile model representing a user profile in the Outseta API
Subscription
Subscription model representing a customer subscription in the Outseta API
SupportApi
The Support API client for managing help desk tickets
Ticket
Ticket model representing a support ticket in the Outseta API
UserProfileApi
The User Profile API client for managing user profiles

Functions

getAuthToken({required String baseUrl, required String username, required String password}) Future<String>
Function that generates a bearer token from username and password This should be used server-side only to get a token for client-side use

Exceptions / Errors

ApiException
Exceptions thrown by the Outseta API client
BadRequestException
Exception thrown when the request is malformed
ForbiddenException
Exception thrown when the request is forbidden
NotFoundException
Exception thrown when the requested resource is not found
RateLimitExceededException
Exception thrown when the rate limit is exceeded
UnauthorizedException
Exception thrown when authentication fails