apideck

Developer-friendly & type-safe Typescript SDK specifically catered to leverage apideck API.

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

* apideck
* SDK Installation
* Requirements
* SDK Example Usage
* Available Resources and Operations
* Standalone functions
* Pagination
* File uploads
* Retries
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Debugging
* Development
* Maturity
* Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

``bash npm add @apideck/unify`

`$3`

`bash pnpm add @apideck/unify`

`$3`

`bash bun add @apideck/unify`

`$3`

`bash yarn add @apideck/unify`

`Requirements`

For supported JavaScript runtimes, please consult RUNTIMES.md.

`SDK Example Usage`

`$3`

`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

`Available Resources and Operations`


Available methods
$3
* get - Get Aged Creditors
$3
* get - Get Aged Debtors
$3
* list - List Attachments
* upload - Upload attachment
* get - Get Attachment
* delete - Delete Attachment
* download - Download Attachment
$3
* get - Get BalanceSheet
$3
* list - List Bank Accounts
* create - Create Bank Account
* get - Get Bank Account
* update - Update Bank Account
* delete - Delete Bank Account
$3
* list - List Bank Feed Accounts
* create - Create Bank Feed Account
* get - Get Bank Feed Account
* update - Update Bank Feed Account
* delete - Delete Bank Feed Account
$3
* list - List Bank Feed Statements
* create - Create Bank Feed Statement
* get - Get Bank Feed Statement
* update - Update Bank Feed Statement
* delete - Delete Bank Feed Statement
$3
* list - List Bill Payments
* create - Create Bill Payment
* get - Get Bill Payment
* update - Update Bill Payment
* delete - Delete Bill Payment
$3
* list - List Bills
* create - Create Bill
* get - Get Bill
* update - Update Bill
* delete - Delete Bill
$3
* list - List Categories
* get - Get Category
$3
* get - Get company info
$3
* list - List Credit Notes
* create - Create Credit Note
* get - Get Credit Note
* update - Update Credit Note
* delete - Delete Credit Note
$3
* list - List Customers
* create - Create Customer
* get - Get Customer
* update - Update Customer
* delete - Delete Customer
$3
* list - List Departments
* create - Create Department
* get - Get Department
* update - Update Department
* delete - Delete Department
$3
* list - List Expenses
* create - Create Expense
* get - Get Expense
* update - Update Expense
* delete - Delete Expense
$3
* list - List Invoice Items
* create - Create Invoice Item
* get - Get Invoice Item
* update - Update Invoice Item
* delete - Delete Invoice Item
$3
* list - List Invoices
* create - Create Invoice
* get - Get Invoice
* update - Update Invoice
* delete - Delete Invoice
$3
* list - List Journal Entries
* create - Create Journal Entry
* get - Get Journal Entry
* update - Update Journal Entry
* delete - Delete Journal Entry
$3
* list - List Ledger Accounts
* create - Create Ledger Account
* get - Get Ledger Account
* update - Update Ledger Account
* delete - Delete Ledger Account
$3
* list - List Locations
* create - Create Location
* get - Get Location
* update - Update Location
* delete - Delete Location
$3
* list - List Payments
* create - Create Payment
* get - Get Payment
* update - Update Payment
* delete - Delete Payment
$3
* get - Get Profit and Loss
$3
* list - List projects
* create - Create project
* get - Get project
* update - Update project
* delete - Delete project
$3
* list - List Purchase Orders
* create - Create Purchase Order
* get - Get Purchase Order
* update - Update Purchase Order
* delete - Delete Purchase Order
$3
* list - List Quotes
* create - Create Quote
* get - Get Quote
* update - Update Quote
* delete - Delete Quote
$3
* list - List Subsidiaries
* create - Create Subsidiary
* get - Get Subsidiary
* update - Update Subsidiary
* delete - Delete Subsidiary
$3
* list - List Suppliers
* create - Create Supplier
* get - Get Supplier
* update - Update Supplier
* delete - Delete Supplier
$3
* list - List Tax Rates
* create - Create Tax Rate
* get - Get Tax Rate
* update - Update Tax Rate
* delete - Delete Tax Rate
$3
* list - List Tracking Categories
* create - Create Tracking Category
* get - Get Tracking Category
* update - Update Tracking Category
* delete - Delete Tracking Category
$3
* list - List Applicants
* create - Create Applicant
* get - Get Applicant
* update - Update Applicant
* delete - Delete Applicant
$3
* list - List Applications
* create - Create Application
* get - Get Application
* update - Update Application
* delete - Delete Application
$3
* list - List Jobs
* get - Get Job
$3
* get - Get API Resource Coverage
$3
* get - Get API Resource
$3
* list - List APIs
* get - Get API
$3
* get - Get Connector Doc content
$3
* get - Get Connector Resource
$3
* list - List Connectors
* get - Get Connector
$3
* list - List activities
* create - Create activity
* get - Get activity
* update - Update activity
* delete - Delete activity
$3
* list - List companies
* create - Create company
* get - Get company
* update - Update company
* delete - Delete company
$3
* list - List contacts
* create - Create contact
* get - Get contact
* update - Update contact
* delete - Delete contact
$3
* list - List custom objects
* create - Create custom object
* get - Get custom object
* update - Update custom object
* delete - Delete custom object
$3
* list - List custom object schemas
* create - Create custom object schema
* get - Get custom object schema
* update - Update custom object schema
* delete - Delete custom object schema
$3
* list - List leads
* create - Create lead
* get - Get lead
* update - Update lead
* delete - Delete lead
$3
* list - List notes
* create - Create note
* get - Get note
* update - Update note
* delete - Delete note
$3
* list - List opportunities
* create - Create opportunity
* get - Get opportunity
* update - Update opportunity
* delete - Delete opportunity
$3
* list - List pipelines
* create - Create pipeline
* get - Get pipeline
* update - Update pipeline
* delete - Delete pipeline
$3
* list - List users
* create - Create user
* get - Get user
* update - Update user
* delete - Delete user
$3
* list - List Customers
* get - Get Customer
$3
* list - List Orders
* get - Get Order
$3
* list - List Products
* get - Get Product
$3
* get - Get Store
$3
* list - List DriveGroups
* create - Create DriveGroup
* get - Get DriveGroup
* update - Update DriveGroup
* delete - Delete DriveGroup
$3
* list - List Drives
* create - Create Drive
* get - Get Drive
* update - Update Drive
* delete - Delete Drive
$3
* list - List Files
* search - Search Files
* get - Get File
* update - Rename or move File
* delete - Delete File
* download - Download File
* export - Export File
$3
* create - Create Folder
* get - Get Folder
* update - Rename or move Folder
* delete - Delete Folder
* copy - Copy Folder
$3
* list - List Shared Links
* create - Create Shared Link
* get - Get Shared Link
* update - Update Shared Link
* delete - Delete Shared Link
$3
* create - Start Upload Session
* get - Get Upload Session
* upload - Upload part of File to Upload Session
* delete - Abort Upload Session
* finish - Finish Upload Session
$3
* list - List Companies
* create - Create Company
* get - Get Company
* update - Update Company
* delete - Delete Company
$3
* list - List Departments
* create - Create Department
* get - Get Department
* update - Update Department
* delete - Delete Department
$3
* list - List Employee Payrolls
* get - Get Employee Payroll
$3
* list - List Employees
* create - Create Employee
* get - Get Employee
* update - Update Employee
* delete - Delete Employee
$3
* list - List Employee Schedules
$3
* list - List Payroll
* get - Get Payroll
$3
* list - List Time Off Requests
* create - Create Time Off Request
* get - Get Time Off Request
* update - Update Time Off Request
* delete - Delete Time Off Request
$3
* list - List Collections
* get - Get Collection
$3
* list - List Tags
$3
* list - List Comments
* create - Create Comment
* get - Get Comment
* update - Update Comment
* delete - Delete Comment
$3
* list - List Tickets
* create - Create Ticket
* get - Get Ticket
* update - Update Ticket
* delete - Delete Ticket
$3
* list - List Users
* get - Get user
$3
* list - List Messages
* create - Create Message
* get - Get Message
* update - Update Message
* delete - Delete Message
$3
* update - Update consent state
$3
* list - Get consent records
$3
* list - List connection custom mappings
$3
* list - Get all connections
* get - Get connection
* update - Update connection
* delete - Deletes a connection
* imports - Import connection
* token - Authorize Access Token
$3
* list - Get resource settings
* update - Update settings
$3
* list - Consumer request counts
$3
* create - Create consumer
* list - Get all consumers
* get - Get consumer
* update - Update consumer
* delete - Delete consumer
$3
* state - Create Callback State
$3
* list - Get resource custom fields
$3
* list - List custom mappings
$3
* list - Get all consumer request logs
$3
* create - Create Session
$3
* state - Validate Connection State
$3
* list - List event logs
$3
* list - List webhook subscriptions
* create - Create webhook subscription
* get - Get webhook subscription
* update - Update webhook subscription
* delete - Delete webhook subscription



Standalone functions
All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.


Available standalone functions



Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the [for await...of][for-await-of] syntax.

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

`File uploads`

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP] > > Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory: > > - Node.js v20+: Since v20, Node.js comes with a nativeopenAsBlob function in node:fs. > - Bun: The nativeBun.filefunction produces a file handle that can be used for streaming file uploads. > - Browsers: All supported browsers return an instance to aFile when reading the value from an element. > - Node.js v18: A file stream can be created using thefileFrom helper from fetch-blob/from.js.

`typescript import { Apideck } from "@apideck/unify"; import { openAsBlob } from "node:fs";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

async function run() { const result = await apideck.accounting.attachments.upload({ referenceType: "invoice", referenceId: "123456", xApideckMetadata: "{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}", serviceId: "salesforce", requestBody: await openAsBlob("example.file"), });

console.log(result); }

run();

`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:`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

async function run() { const result = await apideck.accounting.taxRates.list({ serviceId: "salesforce", filter: { assets: true, equity: true, expenses: true, liabilities: true, revenue: true, }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }, { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, });

for await (const page of result) { console.log(page); } }

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:`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ retryConfig: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

`Error Handling`

ApideckError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------------- | ---------- | --------------------------------------------------------------------------------------- | |error.message | string| Error message | |error.httpMeta.response | Response| HTTP response. Access to headers and more. | |error.httpMeta.request | Request| HTTP request. Access to headers and more. | |error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

`$3`

typescript
import { Apideck } from "@apideck/unify";
import * as errors from "@apideck/unify/models/errors";
const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});
async function run() {
  try {
    const result = await apideck.accounting.taxRates.list({
      serviceId: "salesforce",
      filter: {
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
      },
      passThrough: {
        "search": "San Francisco",
      },
      fields: "id,updated_at",
    });
    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ApideckError) {
      console.log(error.message);
      console.log(error.httpMeta.response.status);
      console.log(error.httpMeta.response.headers);
      console.log(error.httpMeta.request);
      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestResponse) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.error); // string
        console.log(error.data$.typeName); // string
        console.log(error.data$.message); // string
        console.log(error.data$.detail); // errors.Detail
      }
    }
  }
}
run();

`$3`


Primary errors:
*

ApideckError

: The base class for HTTP error responses.
  *

UnauthorizedResponse: Unauthorized. Status code 401

.
  *

PaymentRequiredResponse: Payment Required. Status code 402

NotFoundResponse: The specified resource was not found. Status code 404.

BadRequestResponse: Bad Request. Status code 400.

UnprocessableResponse: Unprocessable. Status code 422`.

Less common errors (6)

apideck

Developer-friendly & type-safe Typescript SDK specifically catered to leverage apideck API.

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

``bash npm add @apideck/unify`

`$3`

`bash pnpm add @apideck/unify`

`$3`

`bash bun add @apideck/unify`

`$3`

`bash yarn add @apideck/unify`

`Requirements`

For supported JavaScript runtimes, please consult RUNTIMES.md.

`SDK Example Usage`

`$3`

`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

`Available Resources and Operations`


Available methods
$3
* get - Get Aged Creditors
$3
* get - Get Aged Debtors
$3
* list - List Attachments
* upload - Upload attachment
* get - Get Attachment
* delete - Delete Attachment
* download - Download Attachment
$3
* get - Get BalanceSheet
$3
* list - List Bank Accounts
* create - Create Bank Account
* get - Get Bank Account
* update - Update Bank Account
* delete - Delete Bank Account
$3
* list - List Bank Feed Accounts
* create - Create Bank Feed Account
* get - Get Bank Feed Account
* update - Update Bank Feed Account
* delete - Delete Bank Feed Account
$3
* list - List Bank Feed Statements
* create - Create Bank Feed Statement
* get - Get Bank Feed Statement
* update - Update Bank Feed Statement
* delete - Delete Bank Feed Statement
$3
* list - List Bill Payments
* create - Create Bill Payment
* get - Get Bill Payment
* update - Update Bill Payment
* delete - Delete Bill Payment
$3
* list - List Bills
* create - Create Bill
* get - Get Bill
* update - Update Bill
* delete - Delete Bill
$3
* list - List Categories
* get - Get Category
$3
* get - Get company info
$3
* list - List Credit Notes
* create - Create Credit Note
* get - Get Credit Note
* update - Update Credit Note
* delete - Delete Credit Note
$3
* list - List Customers
* create - Create Customer
* get - Get Customer
* update - Update Customer
* delete - Delete Customer
$3
* list - List Departments
* create - Create Department
* get - Get Department
* update - Update Department
* delete - Delete Department
$3
* list - List Expenses
* create - Create Expense
* get - Get Expense
* update - Update Expense
* delete - Delete Expense
$3
* list - List Invoice Items
* create - Create Invoice Item
* get - Get Invoice Item
* update - Update Invoice Item
* delete - Delete Invoice Item
$3
* list - List Invoices
* create - Create Invoice
* get - Get Invoice
* update - Update Invoice
* delete - Delete Invoice
$3
* list - List Journal Entries
* create - Create Journal Entry
* get - Get Journal Entry
* update - Update Journal Entry
* delete - Delete Journal Entry
$3
* list - List Ledger Accounts
* create - Create Ledger Account
* get - Get Ledger Account
* update - Update Ledger Account
* delete - Delete Ledger Account
$3
* list - List Locations
* create - Create Location
* get - Get Location
* update - Update Location
* delete - Delete Location
$3
* list - List Payments
* create - Create Payment
* get - Get Payment
* update - Update Payment
* delete - Delete Payment
$3
* get - Get Profit and Loss
$3
* list - List projects
* create - Create project
* get - Get project
* update - Update project
* delete - Delete project
$3
* list - List Purchase Orders
* create - Create Purchase Order
* get - Get Purchase Order
* update - Update Purchase Order
* delete - Delete Purchase Order
$3
* list - List Quotes
* create - Create Quote
* get - Get Quote
* update - Update Quote
* delete - Delete Quote
$3
* list - List Subsidiaries
* create - Create Subsidiary
* get - Get Subsidiary
* update - Update Subsidiary
* delete - Delete Subsidiary
$3
* list - List Suppliers
* create - Create Supplier
* get - Get Supplier
* update - Update Supplier
* delete - Delete Supplier
$3
* list - List Tax Rates
* create - Create Tax Rate
* get - Get Tax Rate
* update - Update Tax Rate
* delete - Delete Tax Rate
$3
* list - List Tracking Categories
* create - Create Tracking Category
* get - Get Tracking Category
* update - Update Tracking Category
* delete - Delete Tracking Category
$3
* list - List Applicants
* create - Create Applicant
* get - Get Applicant
* update - Update Applicant
* delete - Delete Applicant
$3
* list - List Applications
* create - Create Application
* get - Get Application
* update - Update Application
* delete - Delete Application
$3
* list - List Jobs
* get - Get Job
$3
* get - Get API Resource Coverage
$3
* get - Get API Resource
$3
* list - List APIs
* get - Get API
$3
* get - Get Connector Doc content
$3
* get - Get Connector Resource
$3
* list - List Connectors
* get - Get Connector
$3
* list - List activities
* create - Create activity
* get - Get activity
* update - Update activity
* delete - Delete activity
$3
* list - List companies
* create - Create company
* get - Get company
* update - Update company
* delete - Delete company
$3
* list - List contacts
* create - Create contact
* get - Get contact
* update - Update contact
* delete - Delete contact
$3
* list - List custom objects
* create - Create custom object
* get - Get custom object
* update - Update custom object
* delete - Delete custom object
$3
* list - List custom object schemas
* create - Create custom object schema
* get - Get custom object schema
* update - Update custom object schema
* delete - Delete custom object schema
$3
* list - List leads
* create - Create lead
* get - Get lead
* update - Update lead
* delete - Delete lead
$3
* list - List notes
* create - Create note
* get - Get note
* update - Update note
* delete - Delete note
$3
* list - List opportunities
* create - Create opportunity
* get - Get opportunity
* update - Update opportunity
* delete - Delete opportunity
$3
* list - List pipelines
* create - Create pipeline
* get - Get pipeline
* update - Update pipeline
* delete - Delete pipeline
$3
* list - List users
* create - Create user
* get - Get user
* update - Update user
* delete - Delete user
$3
* list - List Customers
* get - Get Customer
$3
* list - List Orders
* get - Get Order
$3
* list - List Products
* get - Get Product
$3
* get - Get Store
$3
* list - List DriveGroups
* create - Create DriveGroup
* get - Get DriveGroup
* update - Update DriveGroup
* delete - Delete DriveGroup
$3
* list - List Drives
* create - Create Drive
* get - Get Drive
* update - Update Drive
* delete - Delete Drive
$3
* list - List Files
* search - Search Files
* get - Get File
* update - Rename or move File
* delete - Delete File
* download - Download File
* export - Export File
$3
* create - Create Folder
* get - Get Folder
* update - Rename or move Folder
* delete - Delete Folder
* copy - Copy Folder
$3
* list - List Shared Links
* create - Create Shared Link
* get - Get Shared Link
* update - Update Shared Link
* delete - Delete Shared Link
$3
* create - Start Upload Session
* get - Get Upload Session
* upload - Upload part of File to Upload Session
* delete - Abort Upload Session
* finish - Finish Upload Session
$3
* list - List Companies
* create - Create Company
* get - Get Company
* update - Update Company
* delete - Delete Company
$3
* list - List Departments
* create - Create Department
* get - Get Department
* update - Update Department
* delete - Delete Department
$3
* list - List Employee Payrolls
* get - Get Employee Payroll
$3
* list - List Employees
* create - Create Employee
* get - Get Employee
* update - Update Employee
* delete - Delete Employee
$3
* list - List Employee Schedules
$3
* list - List Payroll
* get - Get Payroll
$3
* list - List Time Off Requests
* create - Create Time Off Request
* get - Get Time Off Request
* update - Update Time Off Request
* delete - Delete Time Off Request
$3
* list - List Collections
* get - Get Collection
$3
* list - List Tags
$3
* list - List Comments
* create - Create Comment
* get - Get Comment
* update - Update Comment
* delete - Delete Comment
$3
* list - List Tickets
* create - Create Ticket
* get - Get Ticket
* update - Update Ticket
* delete - Delete Ticket
$3
* list - List Users
* get - Get user
$3
* list - List Messages
* create - Create Message
* get - Get Message
* update - Update Message
* delete - Delete Message
$3
* update - Update consent state
$3
* list - Get consent records
$3
* list - List connection custom mappings
$3
* list - Get all connections
* get - Get connection
* update - Update connection
* delete - Deletes a connection
* imports - Import connection
* token - Authorize Access Token
$3
* list - Get resource settings
* update - Update settings
$3
* list - Consumer request counts
$3
* create - Create consumer
* list - Get all consumers
* get - Get consumer
* update - Update consumer
* delete - Delete consumer
$3
* state - Create Callback State
$3
* list - Get resource custom fields
$3
* list - List custom mappings
$3
* list - Get all consumer request logs
$3
* create - Create Session
$3
* state - Validate Connection State
$3
* list - List event logs
$3
* list - List webhook subscriptions
* create - Create webhook subscription
* get - Get webhook subscription
* update - Update webhook subscription
* delete - Delete webhook subscription



Standalone functions
All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.


Available standalone functions



Pagination

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

`File uploads`

`typescript import { Apideck } from "@apideck/unify"; import { openAsBlob } from "node:fs";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

console.log(result); }

run();

`Retries`

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:`typescript import { Apideck } from "@apideck/unify";

const apideck = new Apideck({ consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", apiKey: process.env["APIDECK_API_KEY"] ?? "", });

for await (const page of result) { console.log(page); } }

run();

for await (const page of result) { console.log(page); } }

run();

`Error Handling`

ApideckError is the base class for all HTTP error responses. It has the following properties:

`$3`

typescript
import { Apideck } from "@apideck/unify";
import * as errors from "@apideck/unify/models/errors";
const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});
async function run() {
  try {
    const result = await apideck.accounting.taxRates.list({
      serviceId: "salesforce",
      filter: {
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
      },
      passThrough: {
        "search": "San Francisco",
      },
      fields: "id,updated_at",
    });
    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ApideckError) {
      console.log(error.message);
      console.log(error.httpMeta.response.status);
      console.log(error.httpMeta.response.headers);
      console.log(error.httpMeta.request);
      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestResponse) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.error); // string
        console.log(error.data$.typeName); // string
        console.log(error.data$.message); // string
        console.log(error.data$.detail); // errors.Detail
      }
    }
  }
}
run();

`$3`


Primary errors:
*

ApideckError

: The base class for HTTP error responses.
  *

UnauthorizedResponse: Unauthorized. Status code 401

.
  *

PaymentRequiredResponse: Payment Required. Status code 402

NotFoundResponse: The specified resource was not found. Status code 404.

BadRequestResponse: Bad Request. Status code 400.

UnprocessableResponse: Unprocessable. Status code 422`.

Less common errors (6)

@apideck/unify

apideck

Summary

Table of Contents

SDK Installation

$3

$3

$3

$3

Requirements

SDK Example Usage

$3

Available Resources and Operations

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

`$3`

`$3`

`$3`

`Requirements`

`SDK Example Usage`

`$3`

`Available Resources and Operations`

`File uploads`

`Retries`

`Error Handling`

`$3`

`$3`

`$3`

`$3`

`$3`

`Requirements`

`SDK Example Usage`

`$3`

`Available Resources and Operations`