ExsitedClient class

Authenticated access to one Exsited instance: config in, ApiResponse out. Call close when done; a request after that is refused before any I/O.

Constructors

ExsitedClient(SdkConfig config, {TokenStore? tokenStore, Transport? transport, RetryPolicy? retryPolicy, TokenProvider? tokenProvider, Client? httpClient, void onLog(String message)?, void onWarning(InsecureTransportWarning warning)?})
Build a client over one instance's configuration; the optional collaborators are injection points, and an injected transport or httpClient stays open after close.

Properties

abaFiles → AbaFilesResource
The aba files endpoints, bound to this client.
no setter
accountEmails → AccountEmailsResource
The account emails endpoints, bound to this client.
no setter
accountGroups → AccountGroupsResource
The account groups endpoints, bound to this client.
no setter
accountingCodes → AccountingCodesResource
The accounting codes endpoints, bound to this client.
no setter
accounts → AccountsResource
The accounts endpoints, bound to this client.
no setter
actionScripts → ActionScriptsResource
The action scripts endpoints, bound to this client.
no setter
additionalCodes → AdditionalCodesResource
The additional codes endpoints, bound to this client.
no setter
alertResponsibilities → AlertResponsibilitiesResource
The alert responsibilities endpoints, bound to this client.
no setter
alertResponsibility → AlertResponsibilityResource
The alert responsibility endpoints, bound to this client.
no setter
alerts → AlertsResource
The alerts endpoints, bound to this client.
no setter
applications → ApplicationsResource
The applications endpoints, bound to this client.
no setter
approvalProfiles → ApprovalProfilesResource
The approval profiles endpoints, bound to this client.
no setter
approvals → ApprovalsResource
The approvals endpoints, bound to this client.
no setter
approvalUserGroups → ApprovalUserGroupsResource
The approval user groups endpoints, bound to this client.
no setter
attributeAttachments → AttributeAttachmentsResource
The attribute attachments endpoints, bound to this client.
no setter
billingPeriods → BillingPeriodsResource
The billing periods endpoints, bound to this client.
no setter
bookings → BookingsResource
The bookings endpoints, bound to this client.
no setter
chargingPeriods → ChargingPeriodsResource
The charging periods endpoints, bound to this client.
no setter
communicationProfiles → CommunicationProfilesResource
The communication profiles endpoints, bound to this client.
no setter
communications → CommunicationsResource
The communications endpoints, bound to this client.
no setter
config → SdkConfig
The configuration this client was built with.
final
countries → CountriesResource
The countries endpoints, bound to this client.
no setter
creditNoteApplications → CreditNoteApplicationsResource
The credit note applications endpoints, bound to this client.
no setter
creditNotes → CreditNotesResource
The credit notes endpoints, bound to this client.
no setter
customAttributes → CustomAttributesResource
The custom attributes endpoints, bound to this client.
no setter
customComponents → CustomComponentsResource
The custom components endpoints, bound to this client.
no setter
customEvents → CustomEventsResource
The custom events endpoints, bound to this client.
no setter
customFeatures → CustomFeaturesResource
The custom features endpoints, bound to this client.
no setter
customFields → CustomFieldsResource
The custom fields endpoints, bound to this client.
no setter
customForms → CustomFormsResource
The custom forms endpoints, bound to this client.
no setter
dayOfMonth → DayOfMonthResource
The day of month endpoints, bound to this client.
no setter
departments → DepartmentsResource
The departments endpoints, bound to this client.
no setter
designations → DesignationsResource
The designations endpoints, bound to this client.
no setter
documentTemplates → DocumentTemplatesResource
The document templates endpoints, bound to this client.
no setter
emailTemplates → EmailTemplatesResource
The email templates endpoints, bound to this client.
no setter
employees → EmployeesResource
The employees endpoints, bound to this client.
no setter
events → EventsResource
The events endpoints, bound to this client.
no setter
express → ExpressResource
The express endpoints, bound to this client.
no setter
externalDatabases → ExternalDatabasesResource
The external databases endpoints, bound to this client.
no setter
fulfillmentProfiles → FulfillmentProfilesResource
The fulfillment profiles endpoints, bound to this client.
no setter
fulfillmentTerms → FulfillmentTermsResource
The fulfillment terms endpoints, bound to this client.
no setter
giftCertificates → GiftCertificatesResource
The gift certificates endpoints, bound to this client.
no setter
hashCode → int
The hash code for this object.
no setterinherited
integrationConnections → IntegrationConnectionsResource
The integration connections endpoints, bound to this client.
no setter
inventoryAdjustments → InventoryAdjustmentsResource
The inventory adjustments endpoints, bound to this client.
no setter
invoices → InvoicesResource
The invoices endpoints, bound to this client.
no setter
invoiceTerms → InvoiceTermsResource
The invoice terms endpoints, bound to this client.
no setter
isClosed → bool
Whether close has been called; a closed client is not reopened.
no setter
itemFulfillments → ItemFulfillmentsResource
The item fulfillments endpoints, bound to this client.
no setter
itemReceipts → ItemReceiptsResource
The item receipts endpoints, bound to this client.
no setter
items → ItemsResource
The items endpoints, bound to this client.
no setter
labours → LaboursResource
The labours endpoints, bound to this client.
no setter
milestones → MilestonesResource
The milestones endpoints, bound to this client.
no setter
name → String
The logical name of this instance.
no setter
noteAttachments → NoteAttachmentsResource
The note attachments endpoints, bound to this client.
no setter
noteGroups → NoteGroupsResource
The note groups endpoints, bound to this client.
no setter
operatorGroups → OperatorGroupsResource
The operator groups endpoints, bound to this client.
no setter
operators → OperatorsResource
The operators endpoints, bound to this client.
no setter
orders → OrdersResource
The orders endpoints, bound to this client.
no setter
organisation → OrganisationResource
The organisation endpoints, bound to this client.
no setter
organisations → OrganisationsResource
The organisations endpoints, bound to this client.
no setter
payments → PaymentsResource
The payments endpoints, bound to this client.
no setter
portals → PortalsResource
The portals endpoints, bound to this client.
no setter
pricingPeriods → PricingPeriodsResource
The pricing periods endpoints, bound to this client.
no setter
proformaInvoices → ProformaInvoicesResource
The proforma invoices endpoints, bound to this client.
no setter
purchaseCreditNoteApplications → PurchaseCreditNoteApplicationsResource
The purchase credit note applications endpoints, bound to this client.
no setter
purchaseCreditNotes → PurchaseCreditNotesResource
The purchase credit notes endpoints, bound to this client.
no setter
purchaseExpress → PurchaseExpressResource
The purchase express endpoints, bound to this client.
no setter
purchaseInvoices → PurchaseInvoicesResource
The purchase invoices endpoints, bound to this client.
no setter
purchaseOrders → PurchaseOrdersResource
The purchase orders endpoints, bound to this client.
no setter
purchasePayments → PurchasePaymentsResource
The purchase payments endpoints, bound to this client.
no setter
purchaseRefunds → PurchaseRefundsResource
The purchase refunds endpoints, bound to this client.
no setter
quoteOrders → QuoteOrdersResource
The quote orders endpoints, bound to this client.
no setter
receiveTerms → ReceiveTermsResource
The receive terms endpoints, bound to this client.
no setter
reconciliations → ReconciliationsResource
The reconciliations endpoints, bound to this client.
no setter
refunds → RefundsResource
The refunds endpoints, bound to this client.
no setter
rentalAssets → RentalAssetsResource
The rental assets endpoints, bound to this client.
no setter
reports → ReportsResource
The reports endpoints, bound to this client.
no setter
returnMerchandiseAuthorisations → ReturnMerchandiseAuthorisationsResource
The return merchandise authorisations endpoints, bound to this client.
no setter
returnVendorAuthorizations → ReturnVendorAuthorizationsResource
The return vendor authorizations endpoints, bound to this client.
no setter
roles → RolesResource
The roles endpoints, bound to this client.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
salesReps → SalesRepsResource
The sales reps endpoints, bound to this client.
no setter
salutations → SalutationsResource
The salutations endpoints, bound to this client.
no setter
settings → SettingsResource
The settings endpoints, bound to this client.
no setter
settingsWorkflows → SettingsWorkflowsResource
The settings workflows endpoints, bound to this client.
no setter
shippingPackages → ShippingPackagesResource
The shipping packages endpoints, bound to this client.
no setter
shippingRules → ShippingRulesResource
The shipping rules endpoints, bound to this client.
no setter
systemEvents → SystemEventsResource
The system events endpoints, bound to this client.
no setter
tasks → TasksResource
The tasks endpoints, bound to this client.
no setter
teams → TeamsResource
The teams endpoints, bound to this client.
no setter
timePeriods → TimePeriodsResource
The time periods endpoints, bound to this client.
no setter
timesheets → TimesheetsResource
The timesheets endpoints, bound to this client.
no setter
uom → UomResource
The uom endpoints, bound to this client.
no setter
usages → UsagesResource
The usages endpoints, bound to this client.
no setter
userSettings → UserSettingsResource
The user settings endpoints, bound to this client.
no setter
webhooks → WebhooksResource
The webhooks endpoints, bound to this client.
no setter
workflows → WorkflowsResource
The workflows endpoints, bound to this client.
no setter
zones → ZonesResource
The zones endpoints, bound to this client.
no setter

Methods

close() → void
Release pooled connections and the logFile handle, and refuse later requests.
closeClient() → void
Release pooled connections and the logFile handle. An alias for close.
listResourceNames() → List<String>
Every resource reachable as a property on this client, sorted.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resourceByName(String name) → Object
One resource by a name listResourceNames reports, or an SdkAttributeError naming what is available.
sendApiRequest<T>(String httpMethod, String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
Send one request and return the response; jsonBody takes a map, a list, a raw JSON String sent byte for byte, or a payload DTO. A flat argument wins over the same field on options, and dtoDecoder wins over buildDto.
sendDeleteRequest<T>(String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
DELETE a path. One delegating call to sendApiRequest.
sendGetRequest<T>(String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
GET a path. One delegating call to sendApiRequest.
sendPatchRequest<T>(String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
PATCH a path. One delegating call to sendApiRequest.
sendPostRequest<T>(String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
POST a path. One delegating call to sendApiRequest.
sendPutRequest<T>(String path, {Map<String, Object?>? pathParams, Map<String, Object?>? queryParams, Object? jsonBody, Map<String, Object?>? formData, Map<String, Object?>? files, Map<String, String>? headers, bool authenticated = true, bool? raiseOnError, String? responseFormat, DtoDecoder? dtoDecoder, CallOptions? options, T buildDto(Map<String, Object?>)?}) → Future<ApiResponse<T>>
PUT a path. One delegating call to sendApiRequest.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

resetWarningDeduplication() → void
Re-arm the once-per-isolate insecure-transport warning.