@codat/sync-for-commerce v4.0.0

Sync for Commerce

Embedded accounting integrations for POS and eCommerce platforms.

SDK Installation

NPM

npm add @codat/sync-for-commerce

PNPM

pnpm add @codat/sync-for-commerce

Bun

bun add @codat/sync-for-commerce

Yarn

yarn add @codat/sync-for-commerce zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Example Usage

SDK Example Usage

Example

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl({
        commerceKey: "<value>",
        accountingKey: "<value>",
    });

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

connections

• getSyncFlowUrl - Start new sync flow
• list - List connections
• create - Create connection
• updateConnection - Update connection
• updateAuthorization - Update authorization

advancedControls

• listCompanies - List companies
• createCompany - Create company
• getConfiguration - Get company configuration
• setConfiguration - Set configuration

integrations

• list - List integrations
• getBranding - Get branding for an integration

syncFlowSettings

• getConfigTextSyncFlow - Get preferences for text fields
• updateConfigTextSyncFlow - Update preferences for text fields
• getVisibleAccounts - List visible accounts
• updateVisibleAccountsSyncFlow - Update visible accounts

sync

• request - Initiate new sync
• requestForDateRange - Initiate sync for specific range
• getStatus - Get sync status
• getLastSuccessfulSync - Last successful sync
• getLatestSync - Latest sync status
• get - Get sync status
• list - List sync statuses

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Retries

Some 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 a retryConfig object to the call:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl(
        {
            commerceKey: "<value>",
            accountingKey: "<value>",
        },
        {
            retries: {
                strategy: "backoff",
                backoff: {
                    initialInterval: 1,
                    maxInterval: 50,
                    exponent: 1.1,
                    maxElapsedTime: 100,
                },
                retryConnectionErrors: false,
            },
        }
    );

    // Handle the result
    console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    retryConfig: {
        strategy: "backoff",
        backoff: {
            initialInterval: 1,
            maxInterval: 50,
            exponent: 1.1,
            maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
    },
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl({
        commerceKey: "<value>",
        accountingKey: "<value>",
    });

    // Handle the result
    console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { CodatSyncCommerce } from "@codat/sync-for-commerce";
import { SDKValidationError } from "@codat/sync-for-commerce/sdk/models/errors";

const codatSyncCommerce = new CodatSyncCommerce({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    let result;
    try {
        result = await codatSyncCommerce.connections.getSyncFlowUrl({
            commerceKey: "<value>",
            accountingKey: "<value>",
        });
    } catch (err) {
        switch (true) {
            case err instanceof SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.ErrorMessage: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional 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:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    serverIdx: 0,
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl({
        commerceKey: "<value>",
        accountingKey: "<value>",
    });

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    serverURL: "https://api.codat.io",
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl({
        commerceKey: "<value>",
        accountingKey: "<value>",
    });

    // Handle the result
    console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";
import { HTTPClient } from "@codat/sync-for-commerce/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CodatSyncCommerce({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:

import { CodatSyncCommerce } from "@codat/sync-for-commerce";

const codatSyncCommerce = new CodatSyncCommerce({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncCommerce.connections.getSyncFlowUrl({
        commerceKey: "<value>",
        accountingKey: "<value>",
    });

    // Handle the result
    console.log(result);
}

run();

Support

If 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 our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy