Platform

Manage the building blocks of Codat, including companies, connections, and more.

SDK Installation

NPM

npm add ryan-tim-platform

PNPM

pnpm add ryan-tim-platform

Bun

bun add ryan-tim-platform

Yarn

yarn add ryan-tim-platform 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 { CodatPlatform } from "ryan-tim-platform";

const codatPlatform = new CodatPlatform({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatPlatform.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

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

run();

Available Resources and Operations

companies

• list - List companies
• create - Create company
• get - Get company
• delete - Delete a company
• update - Update company

connections

• list - List connections
• create - Create connection
• get - Get connection
• delete - Delete connection
• unlink - Unlink connection
• updateAuthorization - Update authorization

connectionManagement

• getAccessToken - Get access token

connectionManagement.corsSettings

• get - Get CORS settings
• set - Set CORS settings

refreshData

• all - Refresh all data
• byDataType - Refresh data type
• get - Get data status
• listPullOperations - List pull operations
• getPullOperation - Get pull operation

groups

• addCompany - Add company
• removeCompany - Remove company
• list - List groups
• create - Create group

webhooks

• ~~list~~ - List webhooks :warning: Deprecated
• ~~create~~ - Create webhook :warning: Deprecated
• ~~get~~ - Get webhook :warning: Deprecated
• listConsumers - List webhook consumers
• createConsumer - Create webhook consumer
• deleteConsumer - Delete webhook consumer

integrations

• list - List integrations
• get - Get integration
• getBranding - Get branding

settings

• getProfile - Get profile
• updateProfile - Update profile
• getSyncSettings - Get sync settings
• updateSyncSettings - Update all sync settings
• listApiKeys - List API keys
• createApiKey - Create API key
• deleteApiKey - Delete API key

pushData

• getModelOptions - Get push options
• listOperations - List push operations
• getOperation - Get push operation

supplementalData

• configure - Configure
• getConfiguration - Get configuration

customDataType

• configure - Configure custom data type
• getConfiguration - Get custom data configuration
• refresh - Refresh custom data type
• list - List custom data type records

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 { CodatPlatform } from "ryan-tim-platform";

const codatPlatform = new CodatPlatform({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatPlatform.companies.list(
        {
            page: 1,
            pageSize: 100,
            query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            orderBy: "-modifiedDate",
        },
        {
            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 { CodatPlatform } from "ryan-tim-platform";

const codatPlatform = new CodatPlatform({
    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 codatPlatform.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

    // 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.

| Error Object | Status Code | Content Type | | ------------------------------- | ------------------------------- | ------------------------------- | | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | / |

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 { CodatPlatform } from "ryan-tim-platform";
import { SDKValidationError } from "ryan-tim-platform/sdk/models/errors";

const codatPlatform = new CodatPlatform({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    let result;
    try {
        result = await codatPlatform.companies.list({
            page: 1,
            pageSize: 100,
            query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            orderBy: "-modifiedDate",
        });
    } 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:

| # | Server | Variables | | - | ------ | --------- | | 0 | https://api.codat.io | None |

import { CodatPlatform } from "ryan-tim-platform";

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

async function run() {
    const result = await codatPlatform.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

    // 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 { CodatPlatform } from "ryan-tim-platform";

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

async function run() {
    const result = await codatPlatform.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

    // 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 { CodatPlatform } from "ryan-tim-platform";
import { HTTPClient } from "ryan-tim-platform/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 CodatPlatform({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------------ | ------------ | | authHeader | apiKey | API key |

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

import { CodatPlatform } from "ryan-tim-platform";

const codatPlatform = new CodatPlatform({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatPlatform.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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