@codat/common

Common

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

SDK Installation

NPM

npm add @codat/common

Yarn

yarn add @codat/common

Example Usage

import { CodatCommon } from "@codat/common";

(async () => {
    const sdk = new CodatCommon({
        security: {
            authHeader: "",
        },
    });

    const res = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        name: "Bank of Dave",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Available Resources and Operations

companies

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

connections

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

integrations

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

pushData

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

refreshData

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

settings

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

supplementalData

• configure - Configure
• getConfiguration - Get configuration

webhooks

• create - Create webhook
• get - Get webhook
• list - List webhooks

Library generated by Speakeasy