exsited library

Dart client library for the Exsited v4 REST API: payloads go out as written, and the API's response comes back unchanged. This library carries the core and the accounts and items families; each other family is its own library, imported with a prefix (import 'package:exsited/payments.dart' as payments;), because 15 top-level names are declared by more than one family and export can neither rename nor prefix them.

Classes

Account: One account, read from a {"account": {...}} detail body or a listing entry.
AccountAccountingCode: A Account's accounting_code.
AccountAddress: What getAccountAddress answers, under account.
AccountAddressAddresses: A AccountAddress's addresses.
AccountCancelBody: The body that cancels an account, under an account envelope.
AccountCommunicationPreference: One entry of a Account's communication_preferences.
AccountComponentObject: What getAccountComponentObject answers, under custom_component_object: the fields of one entry of the listing getAccountComponentObjects answers.
AccountContact: What getAccountContact answers, under account.
AccountContactContacts: A AccountContact's contacts.
AccountContactContactsAddress: A AccountContactContacts's address.
AccountContactContactsCreatedBy: A AccountContactContacts's created_by.
AccountContactContactsEmail: A AccountContactContacts's email.
AccountContactContactsLastUpdatedBy: A AccountContactContacts's last_updated_by.
AccountContactContactsMobile: A AccountContactContacts's mobile.
AccountContactContactsName: A AccountContactContacts's name.
AccountContactContactsPhone: A AccountContactContacts's phone.
AccountContactEntry: One entry of a Account's contacts.
AccountContactEntryAddress: A AccountContactEntry's address.
AccountContactEntryCreatedBy: A AccountContactEntry's created_by.
AccountContactEntryCustomAttribute: One entry of a AccountContactEntry's custom_attributes.
AccountContactEntryEmail: A AccountContactEntry's email.
AccountContactEntryFax: A AccountContactEntry's fax.
AccountContactEntryLastUpdatedBy: A AccountContactEntry's last_updated_by.
AccountContactEntryMobile: A AccountContactEntry's mobile.
AccountContactEntryName: A AccountContactEntry's name.
AccountContactEntryPhone: A AccountContactEntry's phone.
AccountCreditNote: One entry of a AccountCreditNoteList's data.
AccountCreditNoteAccount: A AccountCreditNote's account.
AccountCreditNoteCreatedBy: A AccountCreditNote's created_by.
AccountCreditNoteCurrency: A AccountCreditNote's currency.
AccountCreditNoteCustomAttribute: One entry of a AccountCreditNote's custom_attributes.
AccountCreditNoteInvoice: One entry of a AccountCreditNote's invoices.
AccountCreditNoteLastUpdatedBy: A AccountCreditNote's last_updated_by.
AccountCreditNoteList: One page of what getAccountCreditNotes lists, under data.
AccountCreditNotePayment: A AccountCreditNote's payment.
AccountCustomAttribute: One entry of a Account's custom_attributes.
AccountCustomObject: One entry of a Account's custom_objects.
AccountCustomObjectEntry: One entry of a AccountCustomObjectList's data.
AccountCustomObjectList: One page of what getAccountCustomObjects lists, under data.
AccountCustomObjectRead: What getAccountCustomObject answers, under custom_object: the schema, with the account's instances of it and their own pagination.
AccountFinancialSummary: What getAccountFinancialSummary answers, under account: its name and the financial_summary itself.
AccountFinancialSummaryDetail: A AccountFinancialSummary's financial_summary.
AccountImageView: The account's image as a URI, not image bytes; null when there is none.
AccountInventories: What getAccountInventories answers, under account.
AccountInvoice: One entry of a AccountInvoiceList's data.
AccountInvoiceAccount: A AccountInvoice's account.
AccountInvoiceCreatedBy: A AccountInvoice's created_by.
AccountInvoiceCurrency: A AccountInvoice's currency.
AccountInvoiceCustomForm: A AccountInvoice's custom_form.
AccountInvoiceLastPayment: A AccountInvoice's last_payment.
AccountInvoiceLastUpdatedBy: A AccountInvoice's last_updated_by.
AccountInvoiceList: One page of what getAccountInvoices lists, under data.
AccountInvoiceOrder: A AccountInvoice's order.
AccountKpis: What getAccountKpis answers, under account_kpis.
AccountList: A listing of accounts; each record under data is written without its account envelope, as the API sends it.
AccountNote: The account note body.
AccountNoteAccount: A AccountNote's account.
AccountNoteAttachment: One entry of a AccountNote's attachments.
AccountNoteCreatedBy: A AccountNote's created_by.
AccountNoteFile: What getAccountNoteFile answers, under file.
AccountNoteFileEntry: One entry of a AccountNoteFileList's data.
AccountNoteFileList: One page of what getAccountNoteFiles lists, under data.
AccountNoteLastUpdatedBy: A AccountNote's last_updated_by.
AccountNoteList: A page of AccountNote records.
AccountNotes: What createAccountNote answers, under note.
AccountNotesAccount: A AccountNotes's account.
AccountNotesAttachment: One entry of a AccountNotes's attachments.
AccountNotesCreatedBy: A AccountNotes's created_by.
AccountNotesLastUpdatedBy: A AccountNotes's last_updated_by.
AccountNotesWatcher: One entry of a AccountNotes's watchers.
AccountNoteWatcher: One entry of a AccountNote's watchers.
AccountPaymentMethod: What getAccountPaymentMethod answers, under account.
AccountPaymentMethodPaymentMethod: A AccountPaymentMethod's payment_method.
AccountPaymentMethodPaymentMethodCreatedBy: A AccountPaymentMethodPaymentMethod's created_by.
AccountPaymentMethodPaymentMethodLastUpdatedBy: A AccountPaymentMethodPaymentMethod's last_updated_by.
AccountPaymentMethodPaymentMethodProcessor: A AccountPaymentMethodPaymentMethod's processor.
AccountQuotePartialInvoices: What getAccountQuotePartialInvoices answers, under account.
AccountSetPasswordBody: The set-password body, at the top level with no envelope.
AccountsResource: The accounts endpoints with client already applied.
AccountsUrls
Address: An address as it reads back; AddressWrite is the form a write takes.
AddressesCreate: A list under addresses, at the top level with no account envelope.
AddressWrite: One address as it is written: postCode against the read's postal_code.
ApiResponse<T>: One HTTP exchange, readable four ways: data follows responseFormat, while map, json and dto always answer their own form. T is the typed view the endpoint names; dto is null on a call that failed.
AuthConfig: Credentials for one Exsited instance: exactly the four the token endpoint takes.
BoundResource: A resource family with its client already applied, looked up by name.
BundleDetail: One component of a bundle.
CallOptions: The send parameters as one bundle; the flat named parameters on ExsitedClient.sendApiRequest win over it.
ClientRegistry: Several instances open at once: one cached client per registered credentials block, built on first use. Call close to close every client it built.
Console: Rendering one exchange for a human at a terminal - presentation only, and everything shown passes through the redactor first. What is printed is also put through encodeForConsole, so a rune the console cannot carry is shown as its escape instead of being substituted.
Currency: An account's currency, as a reference.
CustomForm: The custom form an item was created under. Present on every item.
Dto: Base for every typed view in this SDK: a read-only view over a decoded body, or a payload handed to an endpoint.
ErrorCategory: A failure classification that declares its wire spelling through wireName.
ExsitedClient: Authenticated access to one Exsited instance: config in, ApiResponse out. Call close when done; a request after that is refused before any I/O.
FamilyDetail: One member of an item family: the id and name only, with no object and no href.
FieldError: One field-level failure, as the v4 error envelope reports it.
FileTokenStore: The web stand-in for the file-backed store: constructing one throws.
InsecureTransportWarning: Transport that cannot be trusted: TLS verification off, or plain http:// to a remote host. A warning, not an SdkError: construction still succeeds.
InventoryAdd: {"item": {"inventories": {"warehouses": [{name, quantity, accounting_code}]}}} - name, where the read side calls the same thing warehouse.
InventoryAdjustment: One inventory movement.
InventoryAdjustmentList: The listing envelope for inventory adjustments.
InventoryProperties: The inventory settings block.
InventoryPropertiesPreorderConfiguration: One entry of a InventoryProperties's preorder_configuration.
Item: One item, as getItem and the listing return it.
ItemBundleDetailsWrite: {"item": {"bundle_details": [{id, quantity}]}} - a bare list, the opposite of how family_details is written.
ItemCode: One entry of codes: a named code slot.
ItemCreate: The body createItem takes.
ItemCurrency: One entry of currencies; all four flags are always present and always booleans.
ItemCustomAttribute: One entry of a Item's custom_attributes.
ItemFamilyDetails: What getItemFamilyDetails answers, under item.
ItemFamilyDetailsFamilyDetail: One entry of a ItemFamilyDetails's family_details.
ItemFamilyDetailsWrite: {"item": {"family_details": {"add": ["ITEM-0002"]}}} - an object with an add list, not a bare list.
ItemImageUpload: Base64 in a JSON body, as on an account - not a multipart upload, and the one write in this family with no item envelope.
ItemInformationUpdate: The body updateItemInformation takes. Partial: send only what changes.
ItemInventories: An item's inventory block.
ItemInventoriesView: {item: {id, name, inventories}}, id the String path code.
ItemInventoriesWrite: {"item": {"inventories": {...}}}.
ItemList: The listing envelope. Items page by cursor, like accounts: every pagination block carries has_more, limit, links, next_cursor and prev_cursor. There is no offset shape here.
ItemNoteFile: What getItemNoteFile answers, under file.
ItemPackageDetail: What getItemPackageDetail answers, under item.
ItemPackageDetailPackageDetail: One entry of a ItemPackageDetail's package_details.
ItemPackageDetailPackageDetailBillingPeriod: One entry of a ItemPackageDetailPackageDetail's billing_periods.
ItemPackageDetailPackageDetailCreatedBy: A ItemPackageDetailPackageDetail's created_by.
ItemPackageDetailPackageDetailItem: One entry of a ItemPackageDetailPackageDetail's items.
ItemPackageDetails: What getItemPackageDetails answers, under item.
ItemPackageDetailsPackageDetail: One entry of a ItemPackageDetails's package_details.
ItemPackageDetailsPackageDetailBillingPeriod: One entry of a ItemPackageDetailsPackageDetail's billing_periods.
ItemPackageDetailsPackageDetailCreatedBy: A ItemPackageDetailsPackageDetail's created_by.
ItemPackageDetailsPackageDetailItem: One entry of a ItemPackageDetailsPackageDetail's items.
ItemPackageDetailsWrite: {"item": {"package_details": {...}}}.
ItemPurchase: An item's purchase configuration.
ItemPurchasePurchaseProperty: One entry of a ItemPurchase's purchase_properties.
ItemPurchaseSupplier: One entry of a ItemPurchase's suppliers.
ItemPurchaseSupplierPricing: A ItemPurchaseSupplier's pricing.
ItemPurchaseSupplierTaxConfiguration: A ItemPurchaseSupplier's tax_configuration.
ItemPurchaseSupplierTaxConfigurationTaxCode: A ItemPurchaseSupplierTaxConfiguration's tax_code.
ItemPurchaseView: {item: {id, name, purchase}}, id an int.
ItemPurchaseWrite: {"item": {"purchase": {...}, "currencies": [...]}}.
ItemSale: An item's sale configuration.
ItemSaleHeight: A ItemSale's height.
ItemSaleLength: A ItemSale's length.
ItemSalePaymentProperty: One entry of a ItemSale's payment_properties.
ItemSalePricingLevel: One entry of a ItemSale's pricing_levels.
ItemSaleView: What getItemSale answers: a stub, not the item.
ItemSaleWeight: A ItemSale's weight.
ItemSaleWidth: A ItemSale's width.
ItemSaleWrite: The body the sale create and update take.
ItemsResource: The items endpoints with client already applied.
ItemsUrls
ItemVariationsWrite: The body updateItemVariations takes, in one of two forms: a parent declares configure_variations; a child sets parent_item_id and use_variations.
MemoryTokenStore
Note: One note on an item.
NoteAttachment: One file on a note.
NoteFileList: The listing envelope for a note's attachments.
NoteLastUpdatedBy: A Note's last_updated_by.
NoteList: The listing envelope for an item's notes.
NoteWatcher: One entry of a Note's watchers.
PackageDetail: One package on an item.
PackageDetailBillingPeriod: One entry of a PackageDetail's billing_periods.
PackageDetailItem: One entry of a PackageDetail's items.
Pagination: The paging block, either shape: a response fills one and the other reads null.
PaginationLinks: A Pagination's links.
Pricing: The pricing block on a sale or purchase.
PricingPricingModule: One entry of a Pricing's pricing_module.
QueryParams: Normalises each query parameter to its wire form; a nested object or a nested sequence throws SdkUsageError.
Redaction: The secret redactor: one static surface over every redaction rule.
Reference: v4's standard embedded pointer to another record.
RequestDetail: The slice of a request record that SdkError.explain reads.
RequestInfo: An immutable record of the request behind a response: secrets redacted and containers detached at construction.
RetryPolicy: Retry decisions and backoff timing.
SaleCharge: The charge block on a sale.
SaleChargeProperty: One entry of a SaleCharge's properties.
Sdk: The version the SDK reports, and the User-Agent built from it.
SdkConfig: Immutable SDK behaviour: timeouts, retries, TLS, logging, printing. Credentials live on AuthConfig. Validated at construction, all at once.
SocialLinks: An account's social links; present on every account, each value usually null.
TaxConfiguration: Whether a price is entered inclusive of tax.
TaxConfigurationTaxCode: A TaxConfiguration's tax_code.
TokenProvider
TokenRecord: A minted token and when it stops being usable.
TokenStore
Transport: HTTP execution over package:http: retries, per-attempt timeouts and decoding. Redirects are not followed.
TransportRequest: One request, snapshotted at construction: method normalised, query merged into wireUrl and body encoded, so every attempt and replay sends the same bytes.
UrlBuilder: URL assembly for Exsited paths with {name} placeholders. A dot-only value is refused: .. would still resolve to another endpoint.
User: Whoever created or last updated a record. The invoice family sends created_by as a plain string and does not use this type.
VariationOption: One variation axis, in configure_variations or use_variations.
VariationOptionValue: One entry of a VariationOption's values.
WarehouseInventory: One warehouse's stock line.
WarehouseInventoryWarehouse: A WarehouseInventory's warehouse.

Enums

ApiVersion: The API version this SDK speaks; one value, and an enum so a later one is an addition.
ErrorType: Classification of a failed call, from the HTTP status and, for a 2xx, a v4 body that names itself an error.
ResponseFormat: The three SdkConfig.responseFormats as an enum, for the resource functions' per-call responseFormat.
SortDirection: Sort direction for query parameters; serialises to its wire value.
TransportFailureKind: Which side of delivery a transport failure falls on, and so whether replaying the request could duplicate what it asked for.

Constants

circular → const String: What replaces a container that contains itself.
cursorParam → const String: The query parameters the pager owns.
defaultLockWait → const Duration: How long an acquisition waits before giving up and refusing the work.
defaultMaxResponseBytes → const int: The default response-body ceiling, as SdkConfig.defaultMaxResponseBytes.
defaultRecordKey → const String: The envelope key holding a page's records; some listings use the resource name.
defaultRetryableHttpCodes → const Set<int>: The statuses the SDK retries by default on a safe method - {429, 500, 502, 503, 504}.
defaultTokenCacheFilename → const String
defaultUnsafeRetryableHttpCodes → const Set<int>: The statuses the SDK retries by default even on a state-changing method - empty: no status alone replays a write.
defaultUserAgent → const String: The default User-Agent; the same value as Sdk.defaultUserAgent.
expirySkew → const Duration: Refreshed this long before expiry, so a token never expires mid-flight.
filterOperators → const List<String>: The v4 filter operators, the union of the per-type lists the API serves; eq is spelled by no suffix at all.
idempotencyHeader → const String: The header v4 uses to collapse a repeated create into one.
idempotencyKeyMethods → const Set<String>: The methods the SDK generates an idempotencyHeader for: POST alone, the one method a retry or the 401 replay could otherwise turn into two records.
idempotentMethods → const Set<String>: Alias of idempotencyKeyMethods; not RFC 9110's idempotent set, which is RetryPolicy.idempotentMethods.
jsonMediaType → const String
limitParam → const String
listOperators → const List<String>: The operators that take a comma-separated list in one parameter; see filterValues.
maxRedactionDepth → const int: How deep Redaction.redactValue walks before writing Redaction.tooDeep.
maxTokenCacheBytes → const int: The most of the cache file this SDK will read, and the size above which it refuses the file instead.
maxTokenTtl → const Duration: The longest lifetime believed from the server.
noNextPage → const String: The string the offset shape uses to mean "no next page".
offsetParam → const String
presenceOperators → const List<String>: The presence checks, which read no value: pair one with true, never null, since a null parameter is dropped and the listing comes back unfiltered.
redacted → const String: What a redacted value is replaced with.
responseFormatEnvVar → const String: Alias of SdkConfig.responseFormatEnvironmentVariable.
safeMethods → const Set<String>: The methods a status retry may treat as harmless, as RetryPolicy.safeMethods.
sdkVersion → const String: The SDK version this package reports; the same value as Sdk.version.
sensitiveKeyMarkers → const List<String>: The key-name markers that make a field a secret.
staleLockDuration → const Duration: How long a lock is believed before it is treated as abandoned.
tooDeep → const String: What replaces a structure nested deeper than maxRedactionDepth.

Functions

addItemInventories(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/{api_version}/items/{item_id}/inventories/add
addItemInventory(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/inventory/add - add stock to a warehouse.
areValidTokenCredentials(String accessToken, String? refreshToken) → bool: Whether both credentials satisfy their own grammar.
buildClient({Object? instance, List<Object>? credentials, AuthConfig? auth, ApiVersion? apiVersion, double? timeoutSeconds, double? connectTimeoutSeconds, int? maxRetries, Set<int>? retryableHttpCodes, Set<int>? unsafeRetryableHttpCodes, double? retryBackoffSeconds, double? retryBackoffMaxSeconds, bool? verifySsl, Object? caBundle = _unset, Object? proxyUrl = _unset, int? poolMaxsize, int? maxResponseBytes, int? maxRequestBytes, int? maxRequestSourceBytes, int? maxMultipartOverheadBytes, int? maxTokenCacheBytes, int? maxCaBundleBytes, Map<String, String>? defaultHeaders, bool? raiseOnError, String? userAgent, String? logLevel, bool? logBodies, Object? logFile = _unset, bool? printApiInfo, bool? printRequestPayload, bool? printResponseBody, bool? printHeaders, bool? printCurl, bool? printOnlyOnError, String? printFormat, bool? printColor, int? printMaxChars, String? responseFormat, Client? httpClient}) → ExsitedClient: Build a client for one registered instance: the default, or the one instance names by index or clientName.
buildCredentialsNamespace(String baseUrl, String clientId, [String clientSecret = '', String grantType = '']) → String: Fingerprint a set of credentials, for keying a shared token file.
buildCurlCommand(ApiResponse<Object?> response, Object? payload, Map<String, Object?>? files, SdkConfig config, {bool formEncoded = false}) → String: A copy-pasteable curl reproducing the call, for a POSIX shell.
buildQueryParams([Map<String, Object?>? params]) → Map<String, Object?>: Apply the query-value table to every parameter; null values are dropped.
buildUrl(String baseUrl, String path) → String: Join a base URL and a path, refusing another origin.
cancelAccount(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/v4/accounts/{account_id}/cancel - cancel an account on a date.
createAccount(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/{api_version}/accounts
createAccountAddresses(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/v4/accounts/{account_id}/addresses - add one or more addresses.
createAccountContacts(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/{api_version}/accounts/{account_id}/contacts
createAccountCustomObjectInstance(ExsitedClient client, Object accountId, Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/accounts/{account_id}/custom_objects/{custom_object_id}
createAccountNote(ExsitedClient client, Object accountId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNotes>>: POST /api/v4/accounts/{account_id}/notes - attach a note.
createAccountPaymentMethod(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/{api_version}/accounts/{account_id}/payment_methods
createItem(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items - create an item.
createItemFamilyDetails(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/family_details - add members to an item family.
createItemInventories(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/{api_version}/items/{item_id}/inventories
createItemInventory(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/{api_version}/items/{item_id}/inventory
createItemNote(ExsitedClient client, Object itemId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Note>>: POST /api/v4/items/{item_id}/notes - attach a note.
createItemPackageDetails(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/package_details - add a package.
createItemPurchase(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/purchase - answers 409 already_exists if one exists.
createItemSale(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/sale - create the sale configuration.
deactivateItem(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/deactivate - deactivate an item. Takes no body.
defaultTokenCachePath() → String: There is no platform cache path here, because there is no filesystem.
deleteAccount(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id} - delete an account.
deleteAccountAddress(ExsitedClient client, Object accountId, Object addressId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id}/addresses/{address_id} - delete one address.
deleteAccountContact(ExsitedClient client, Object accountId, Object contactType, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id}/contacts/{contact_type} - delete one contact.
deleteAccountImage(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id}/image - remove the profile image.
deleteAccountNote(ExsitedClient client, Object accountId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id}/notes/{note_id} - delete one note.
deleteAccountNoteFile(ExsitedClient client, Object accountId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/accounts/{account_id}/notes/{note_id}/files/{file_id}
deleteAccountPaymentMethod(ExsitedClient client, Object accountId, Object paymentMethodId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/accounts/{account_id}/payment_methods/{payment_method_id} - delete one method.
deleteItem(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/items/{item_id} - delete an item.
deleteItemNote(ExsitedClient client, Object itemId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/items/{item_id}/notes/{note_id} - delete one note.
deleteItemNoteFile(ExsitedClient client, Object itemId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/items/{item_id}/notes/{note_id}/files/{file_id}
deleteItemPackageDetail(ExsitedClient client, Object itemId, Object packageDetailId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/v4/items/{item_id}/package_details/{package_detail_id} - delete one package.
deriveEndpointTemplate(String url) → String: The path of a resolved URL with every identifying segment replaced by {id} and the query dropped.
filterParam(String field, [String operator = 'eq']) → String: The flat v4 filter name, filter_<field>[_<operator>]. Only the operator name is checked: the API answers a wrong operator for the field's type better.
filterValues(Iterable<Object?> values) → String: The value of an in or nin filter: comma separated in one parameter, since a repeated key is answered 200 with the wrong rows.
getAccount(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id} - retrieve one account.
getAccountAddress(ExsitedClient client, Object accountId, Object addressId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountAddress>>: GET /api/v4/accounts/{account_id}/addresses/{address_id} - one address by its id.
getAccountAddresses(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id}/addresses - the account's addresses.
getAccountBillingPreferences(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id}/billing_preferences - the billing preferences.
getAccountComponentObject(ExsitedClient client, Object accountId, Object componentId, Object componentObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountComponentObject>>: GET /api/{api_version}/accounts/{account_id}/component/{component_id}/{component_object_id}
getAccountComponentObjects(ExsitedClient client, Object accountId, Object componentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjects>>: GET /api/{api_version}/accounts/{account_id}/component/{component_id}
getAccountContact(ExsitedClient client, Object accountId, Object contactType, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountContact>>: GET /api/v4/accounts/{account_id}/contacts/{contact_type} - one contact, addressed by type.
getAccountContacts(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id}/contacts - the account's contacts.
getAccountCreditNotes(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountCreditNoteList>>: GET /api/v4/accounts/{account_id}/credit_notes - the account's credit notes.
getAccountCustomObject(ExsitedClient client, Object accountId, Object customObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountCustomObjectRead>>: GET /api/{api_version}/accounts/{account_id}/custom_objects/{custom_object_id}
getAccountCustomObjectInstance(ExsitedClient client, Object accountId, Object customObjectId, Object customObjectInstanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/accounts/{account_id}/custom_objects/{custom_object_id}/instances/{custom_object_instance_id}
getAccountCustomObjects(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountCustomObjectList>>: GET /api/v4/accounts/{account_id}/custom_objects - the account's custom objects.
getAccountEmail(ExsitedClient client, Object accountId, Object emailId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountCommunicationsEmail>>: GET /api/v4/accounts/{account_id}/communications/emails/{email_id} - one email.
getAccountEmails(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountCommunicationsEmailList>>: GET /api/v4/accounts/{account_id}/communications/emails - emails sent to the account.
getAccountFinancialSummary(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountFinancialSummary>>: GET /api/{api_version}/accounts/{account_id}/financial_summary
getAccountImage(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountImageView>>: GET /api/v4/accounts/{account_id}/image - the profile image reference.
getAccountInformation(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id}/information - the account's core information.
getAccountInventories(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountInventories>>: GET /api/v4/accounts/{account_id}/inventories - the account's inventories.
getAccountInvoices(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountInvoiceList>>: GET /api/v4/accounts/{account_id}/invoices - the account's invoices.
getAccountKpis(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountKpis>>: GET /api/{api_version}/accounts/{account_id}/kpis
getAccountNote(ExsitedClient client, Object accountId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNote>>: GET /api/v4/accounts/{account_id}/notes/{note_id} - one note.
getAccountNoteFile(ExsitedClient client, Object accountId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNoteFile>>: GET /api/v4/accounts/{account_id}/notes/{note_id}/files/{file_id} - one attachment.
getAccountNoteFiles(ExsitedClient client, Object accountId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNoteFileList>>: GET /api/v4/accounts/{account_id}/notes/{note_id}/files - a note's attachments.
getAccountNotes(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNoteList>>: GET /api/v4/accounts/{account_id}/notes - the account's notes.
getAccountOrders(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountOrders>>: GET /api/v4/accounts/{account_id}/orders - the account's orders.
getAccountPaymentMethod(ExsitedClient client, Object accountId, Object paymentMethodId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPaymentMethod>>: GET /api/v4/accounts/{account_id}/payment_methods/{payment_method_id} - one payment method.
getAccountPaymentMethods(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: GET /api/v4/accounts/{account_id}/payment_methods - the account's payment methods.
getAccountPayments(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPayments>>: GET /api/v4/accounts/{account_id}/payments - the account's payments.
getAccountPurchaseInvoices(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPurchaseInvoices>>: GET /api/v4/accounts/{account_id}/purchase_invoices - the account's purchase invoices.
getAccountPurchaseOrders(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPurchaseOrders>>: GET /api/v4/accounts/{account_id}/purchase_orders - the account's purchase orders.
getAccountPurchasePayments(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPurchasePayments>>: GET /api/v4/accounts/{account_id}/purchase_payments - the account's purchase payments.
getAccountPurchaseRefunds(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountPurchaseRefunds>>: GET /api/v4/accounts/{account_id}/purchase_refunds - the account's purchase refunds.
getAccountQuotePartialInvoices(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountQuotePartialInvoices>>: GET /api/v4/accounts/{account_id}/quote_partial_invoices - partial invoices from quotes.
getAccountRefunds(ExsitedClient client, Object accountId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountRefunds>>: GET /api/v4/accounts/{account_id}/refunds - the account's refunds.
getAccounts(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountList>>: GET /api/v4/accounts - list accounts, filtered, sorted and paged.
getItem(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: GET /api/v4/items/{item_id} - retrieve one item.
getItemFamilyDetails(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemFamilyDetails>>: GET /api/v4/items/{item_id}/family_details - the members of an item family.
getItemInformation(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: GET /api/v4/items/{item_id}/information - the item's core information.
getItemInventories(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemInventoriesView>>: GET /api/v4/items/{item_id}/inventories - configuration and stock.
getItemInventoryAdjustments(ExsitedClient client, Object itemId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InventoryAdjustmentList>>: GET /api/v4/items/{item_id}/inventory_adjustments - the item's stock movements.
getItemKpis(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/items/{item_id}/kpis
getItemNote(ExsitedClient client, Object itemId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Note>>: GET /api/v4/items/{item_id}/notes/{note_id} - one note. Answers {"note": {...}}.
getItemNoteFile(ExsitedClient client, Object itemId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemNoteFile>>: GET /api/v4/items/{item_id}/notes/{note_id}/files/{file_id} - one attachment.
getItemNoteFiles(ExsitedClient client, Object itemId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteFileList>>: GET /api/v4/items/{item_id}/notes/{note_id}/files - a note's attachments.
getItemNotes(ExsitedClient client, Object itemId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteList>>: GET /api/v4/items/{item_id}/notes - the item's notes.
getItemPackageDetail(ExsitedClient client, Object itemId, Object packageDetailId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemPackageDetail>>: GET /api/v4/items/{item_id}/package_details/{package_detail_id} - one package.
getItemPackageDetails(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemPackageDetails>>: GET /api/v4/items/{item_id}/package_details - the item's packages.
getItemPurchase(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemPurchaseView>>: GET /api/v4/items/{item_id}/purchase - a stub, as the sale read is.
getItems(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemList>>: GET /api/v4/items - list items, filtered, sorted and paged.
getItemSale(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemSaleView>>: GET /api/v4/items/{item_id}/sale - the item's sale configuration.
getItemWarehouseInventories(ExsitedClient client, Object itemId, Object warehouseName, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ItemInventoriesView>>: GET /api/v4/items/{item_id}/warehouses/{warehouse_name}/inventories - one warehouse's stock.
getRegisteredInstances() → List<SdkConfig>: The instances registered by registerInstances, first entry the default.
isJsonContentType(String? contentType) → bool: Whether a raw Content-Type header labels a JSON body.
isJsonMediaType(String mediaType) → bool: Whether this lowered type/subtype labels a JSON body.
isValidAccessToken(String token) → bool: Whether token satisfies RFC 6750 2.1 b64token.
isValidRefreshToken(String? token) → bool: Whether token satisfies RFC 6749 5.1 visible ASCII.
itemFilterParam(String field, [String operator = 'eq']) → String: Build a filter_* parameter name, refusing one the API rejects.
iterPages(ExsitedClient client, String path, {Map<String, String> pathParams = const {}, Map<String, Object?>? queryParams, int? maxPages, String recordKey = defaultRecordKey}) → Stream<ApiResponse<Object?>>: One ApiResponse per page; queryParams rides every page, as a position is only valid within its filtered, sorted listing.
iterRecords(ExsitedClient client, String path, {Map<String, String> pathParams = const {}, Map<String, Object?>? queryParams, int? maxPages, String recordKey = defaultRecordKey}) → Stream<Object?>: Each record of a listing, across every page.
listInstanceNames() → List<String>: One label per registered instance, default first.
mediaTypeOf(String value) → String: Reduce a Content-Type to the lowered type/subtype used for comparison.
purgeAccount(ExsitedClient client, Object accountId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/accounts/{account_id}/purge
reactivateAccount(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/{api_version}/accounts/{account_id}/reactivate
reactivateItem(ExsitedClient client, Object itemId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/reactivate - reactivate an item. Takes no body.
readClientName(Object block) → String?: The logical name a credentials block carries, or null when it names none.
readNextCursor(Map<String, Object?> block) → String?: The next cursor, or null; has_more wins, as some last pages keep a stale one.
redactMapping(Map<String, String>? headers) → Map<String, String>: A copy of headers with every secret value replaced.
redactText(String value) → String: value with any secret inside a URL or a JSON fragment replaced.
redactValue(Object? value) → Object?: A JSON-shaped copy of value with every secret replaced.
registeredResourceNames() → List<String>: Every registered resource name, sorted, so the order does not depend on registration order.
registerGeneratedResources() → void: Make every v4 family reachable by name. A no-op: the registry starts with all 94 families registered.
registerInstances(List<Object> credentials) → void: Register every instance this isolate can talk to; the first is the default.
registerResourceModule(String resourceName, ResourceFactory factory) → void: Make a resource family reachable as client.resourceByName(resourceName).
renderExchange(ApiResponse<Object?> response, Object? body, Map<String, Object?>? files, SdkConfig config, {bool formEncoded = false}) → String: The text to print for one exchange, per the config's print flags.
replaceAccount(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PUT /api/{api_version}/accounts/{account_id}
replaceAccountAddress(ExsitedClient client, Object accountId, Object addressId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PUT /api/{api_version}/accounts/{account_id}/addresses/{address_id}
replaceAccountBillingPreferences(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PUT /api/v4/accounts/{account_id}/billing_preferences - replace the preferences.
replaceAccountContact(ExsitedClient client, Object accountId, Object contactType, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PUT /api/v4/accounts/{account_id}/contacts/{contact_type} - replace one contact.
replaceAccountPaymentMethod(ExsitedClient client, Object accountId, Object paymentMethodId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PUT /api/{api_version}/accounts/{account_id}/payment_methods/{payment_method_id}
resolveBoxGlyphs({ConsoleEncodingProbe? canEncode}) → Map<String, String>: Box-drawing characters the current console can print; every value is probed, so a glyph added later is guarded on arrival.
resolveResourceModule(String resourceName) → ResourceFactory: The factory registered under resourceName.
selectCredentials(List<Object> credentials, [Object? instance]) → Object: Choose one credentials block, as SdkConfig.selectCredentials does.
sendAccountEmail(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/accounts/{account_id}/communications/emails
setAccountPassword(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/v4/accounts/{account_id}/set-password - set the portal password.
shouldRedact(String key) → bool: Whether a key names a secret.
sortParam(String field, [SortDirection direction = SortDirection.asc]) → String: A sort value: the field name, prefixed - to descend. The families that take order_by and direction instead ignore it silently.
sortParams(String field, {bool descending = false}) → Map<String, Object?>: Build this family's sort parameters.
substitutePathParams(String pathTemplate, Map<String, Object?>? pathParams) → String: Fill the {name} placeholders in a path template.
updateAccountAddress(ExsitedClient client, Object accountId, Object addressId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PATCH /api/v4/accounts/{account_id}/addresses/{address_id} - update one address.
updateAccountContact(ExsitedClient client, Object accountId, Object contactType, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PATCH /api/v4/accounts/{account_id}/contacts/{contact_type} - update one contact.
updateAccountCustomObjectInstance(ExsitedClient client, Object accountId, Object customObjectInstanceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PATCH /api/{api_version}/accounts/{account_id}/custom_objects_instances/{custom_object_instance_id}
updateAccountInformation(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PATCH /api/v4/accounts/{account_id}/information - update core information.
updateAccountNote(ExsitedClient client, Object accountId, Object noteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountNotes>>: PATCH /api/v4/accounts/{account_id}/notes/{note_id} - update a note's text.
updateAccountPaymentMethod(ExsitedClient client, Object accountId, Object paymentMethodId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: PATCH /api/v4/accounts/{account_id}/payment_methods/{payment_method_id} - update one method.
updateItemBundleDetails(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/bundle_details - set a bundle's components.
updateItemInformation(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/information - update core information. Partial.
updateItemInventories(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/inventories - update the inventory configuration.
updateItemNote(ExsitedClient client, Object itemId, Object noteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Note>>: PATCH /api/v4/items/{item_id}/notes/{note_id} - update a note's text.
updateItemPackageDetail(ExsitedClient client, Object itemId, Object packageDetailId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/{api_version}/items/{item_id}/package_details/{package_detail_id}
updateItemPurchase(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/purchase - update the purchase configuration.
updateItemSale(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/sale - update the sale configuration. Partial.
updateItemVariations(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: PATCH /api/v4/items/{item_id}/variations - configure an item's variations.
uploadAccountImage(ExsitedClient client, Object accountId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Account>>: POST /api/v4/accounts/{account_id}/image - set the profile image.
uploadItemImage(ExsitedClient client, Object itemId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Item>>: POST /api/v4/items/{item_id}/image - set the item's image.
validateTokenCredentials(String accessToken, String? refreshToken) → void: Refuse a pair of credentials that this SDK will not send.

Typedefs

DtoDecoder = Object? Function(Object? body): The reader an endpoint threads through a call to name the typed view its ApiResponse.dto produces.
ResourceFactory = Object Function(ExsitedClient client): Builds one resource family over a client.
SdkAttributeException = SdkAttributeError: Alias of SdkAttributeError.
SdkAuthException = SdkAuthError: Alias of SdkAuthError.
SdkConfigException = SdkConfigError: Alias of SdkConfigError.
SdkException = SdkError: Alias of SdkError.
SdkTokenCacheException = SdkTokenCacheError: Alias of SdkTokenCacheError.
SdkTokenLockException = SdkTokenLockError: Alias of SdkTokenLockError.
SdkUsageException = SdkUsageError: Alias of SdkUsageError.

Exceptions / Errors

SdkAttributeError: A name that does not exist on a client or on a bound resource.
SdkAuthError: Authentication failed: the token endpoint rejected the credentials, or a 401/403.
SdkConfigError: Configuration is missing or invalid; raised at construction, lists every problem.
SdkError: Base class for every error the SDK raises, and thrown for a non-2xx response. Its default rendering is structural; explain opts into the sensitive detail.
SdkTokenCacheError: The token cache file is present and cannot be used; an absent one is not this. The read reports it and the write refuses, so no other entry is truncated away.
SdkTokenLockError: There was no cross-process lock to take, so the work it guards was refused. AuthConfig.inMemoryToken is the way to choose the token over the exclusion.
SdkUsageError: A caller mistake the SDK caught before any network I/O.

exsited library

Classes

Enums

Constants

Functions

Typedefs

Exceptions / Errors

exsited package

exsited library