Package: codat-sync-for-commerce
Sync for Commerce﻿Embedded accounting integrations for POS and eCommerce platforms.SDK Installationpipinstallcodat-sync-for-commerceExample UsageSDK Example UsageExampleimportcodatsynccommercefromcodatsynccommerce.modelsimportoperations,shareds=codatsynccommerce.CodatSyncCommerce(security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req)ifres.localization_infoisnotNone:# handle responsepassAvailable Resources and Operationssync_flow_settingsget_config_text_sync_flow- Get preferences for text fieldsget_visible_accounts- List visible accountsupdate_config_text_sync_flow- Update preferences for text fieldsupdate_visible_accounts_sync_flow- Update visible accountsadvanced_controlscreate_company- Create companyget_configuration- Get company configurationlist_companies- List companiesset_configuration- Set configurationconnectionscreate- Create connectionget_sync_flow_url- Start new sync flowlist- List connectionsupdate_authorization- Update authorizationupdate_connection- Update connectionsyncget- Get sync statusget_last_successful_sync- Last successful syncget_latest_sync- Latest sync statusget_status- Get sync statuslist- List sync statusesrequest- Initiate new syncrequest_for_date_range- Initiate sync for specific rangeintegrationsget_branding- Get branding for an integrationlist- List integrationsRetriesSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.To change the default retry strategy for a single API call, simply provide aRetryConfigobject to the call:importcodatsynccommercefromcodatsynccommerce.modelsimportoperations,sharedfromcodatsynccommerce.utilsimportBackoffStrategy,RetryConfigs=codatsynccommerce.CodatSyncCommerce(security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req,RetryConfig('backoff',BackoffStrategy(1,50,1.1,100),False))ifres.localization_infoisnotNone:# handle responsepassIf you'd like to override the default retry strategy for all operations that support retries, you can use theretry_configoptional parameter when initializing the SDK:importcodatsynccommercefromcodatsynccommerce.modelsimportoperations,sharedfromcodatsynccommerce.utilsimportBackoffStrategy,RetryConfigs=codatsynccommerce.CodatSyncCommerce(retry_config=RetryConfig('backoff',BackoffStrategy(1,50,1.1,100),False)security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req)ifres.localization_infoisnotNone:# handle responsepassError HandlingHandling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.Error ObjectStatus CodeContent Typeerrors.ErrorMessage401,402,403,429,500,503application/jsonerrors.SDKError4x-5xx/Exampleimportcodatsynccommercefromcodatsynccommerce.modelsimporterrors,operations,shareds=codatsynccommerce.CodatSyncCommerce(security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=Nonetry:res=s.sync_flow_settings.get_config_text_sync_flow(req)excepterrors.ErrorMessagease:# handle exceptionraise(e)excepterrors.SDKErrorase:# handle exceptionraise(e)ifres.localization_infoisnotNone:# handle responsepassServer SelectionSelect Server by IndexYou can override the default server globally by passing a server index to theserver_idx: intoptional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:#ServerVariables0https://api.codat.ioNoneExampleimportcodatsynccommercefromcodatsynccommerce.modelsimportoperations,shareds=codatsynccommerce.CodatSyncCommerce(server_idx=0,security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req)ifres.localization_infoisnotNone:# handle responsepassOverride Server URL Per-ClientThe default server can also be overridden globally by passing a URL to theserver_url: stroptional parameter when initializing the SDK client instance. For example:importcodatsynccommercefromcodatsynccommerce.modelsimportoperations,shareds=codatsynccommerce.CodatSyncCommerce(server_url="https://api.codat.io",security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req)ifres.localization_infoisnotNone:# handle responsepassCustom HTTP ClientThe Python SDK makes API calls using therequestsHTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a customrequests.Sessionobject.For example, you could specify a header for every request that this sdk makes as follows:importcodatsynccommerceimportrequestshttp_client=requests.Session()http_client.headers.update({'x-custom-header':'someValue'})s=codatsynccommerce.CodatSyncCommerce(client:http_client)AuthenticationPer-Client Security SchemesThis SDK supports the following security scheme globally:NameTypeSchemeauth_headerapiKeyAPI keyYou can set the security parameters through thesecurityoptional parameter when initializing the SDK client instance. For example:importcodatsynccommercefromcodatsynccommerce.modelsimportoperations,shareds=codatsynccommerce.CodatSyncCommerce(security=shared.Security(auth_header="Basic BASE_64_ENCODED(API_KEY)",),)req=operations.GetConfigTextSyncFlowRequest(locale=shared.Locale.EN_US,)res=s.sync_flow_settings.get_config_text_sync_flow(req)ifres.localization_infoisnotNone:# handle responsepassSupportIf you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance.
You can raise any issues by contacting your dedicated Codat representative or reaching out to oursupport team.
We're here to help ensure a smooth experience for you.Library generated bySpeakeasy