Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@apideck/sdk

Package Overview
Dependencies
Maintainers
0
Versions
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@apideck/sdk

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

  • 0.11.3
  • latest
  • npm
  • Socket score
Version published
Maintainers
0
Created
Source

apideck

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



[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

Table of Contents

SDK Installation

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

NPM

npm add @apideck/sdk

PNPM

pnpm add @apideck/sdk

Bun

bun add @apideck/sdk

Yarn

yarn add @apideck/sdk zod

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Apideck } from "@apideck/sdk";

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

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",
  });

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

run();

Available Resources and Operations

Available methods

accounting

accounting.attachments
accounting.balanceSheet
  • get - Get BalanceSheet
accounting.billPayments
  • list - List Bill Payments
  • create - Create Bill Payment
  • get - Get Bill Payment
  • update - Update Bill Payment
  • delete - Delete Bill Payment
accounting.bills
accounting.companyInfo
  • get - Get company info
accounting.creditNotes
  • list - List Credit Notes
  • create - Create Credit Note
  • get - Get Credit Note
  • update - Update Credit Note
  • delete - Delete Credit Note
accounting.customers
accounting.departments
accounting.expenses
accounting.invoiceItems
  • list - List Invoice Items
  • create - Create Invoice Item
  • get - Get Invoice Item
  • update - Update Invoice Item
  • delete - Delete Invoice Item
accounting.invoices
accounting.journalEntries
  • list - List Journal Entries
  • create - Create Journal Entry
  • get - Get Journal Entry
  • update - Update Journal Entry
  • delete - Delete Journal Entry
accounting.ledgerAccounts
  • list - List Ledger Accounts
  • create - Create Ledger Account
  • get - Get Ledger Account
  • update - Update Ledger Account
  • delete - Delete Ledger Account
accounting.locations
accounting.payments
accounting.profitAndLoss
  • get - Get Profit and Loss
accounting.purchaseOrders
  • list - List Purchase Orders
  • create - Create Purchase Order
  • get - Get Purchase Order
  • update - Update Purchase Order
  • delete - Delete Purchase Order
accounting.subsidiaries
accounting.suppliers
accounting.taxRates
accounting.trackingCategories
  • list - List Tracking Categories
  • create - Create Tracking Category
  • get - Get Tracking Category
  • update - Update Tracking Category
  • delete - Delete Tracking Category

ats

ats.applicants
ats.applications
  • list - List Applications
  • create - Create Application
  • get - Get Application
  • update - Update Application
  • delete - Delete Application
ats.jobs

connector

connector.apiResourceCoverage
  • get - Get API Resource Coverage
connector.apiResources
  • get - Get API Resource
connector.apis
connector.connectorDocs
  • get - Get Connector Doc content
connector.connectorResources
  • get - Get Connector Resource
connector.connectors
  • list - List Connectors
  • get - Get Connector

crm

crm.activities
crm.companies
crm.contacts
crm.leads
crm.notes
crm.opportunities
  • list - List opportunities
  • create - Create opportunity
  • get - Get opportunity
  • update - Update opportunity
  • delete - Delete opportunity
crm.pipelines
crm.users

ecommerce

ecommerce.customers
  • list - List Customers
  • get - Get Customer
ecommerce.orders
ecommerce.products
  • list - List Products
  • get - Get Product
ecommerce.stores
  • get - Get Store

fileStorage

fileStorage.driveGroups
fileStorage.drives
fileStorage.files
fileStorage.folders
fileStorage.sharedLinks
  • list - List SharedLinks
  • create - Create Shared Link
  • get - Get Shared Link
  • update - Update Shared Link
  • delete - Delete Shared Link
fileStorage.uploadSessions
  • create - Start Upload Session
  • get - Get Upload Session
  • delete - Abort Upload Session
  • finish - Finish Upload Session

hris

hris.companies
hris.departments
hris.employeePayrolls
  • list - List Employee Payrolls
  • get - Get Employee Payroll
hris.employees
hris.employeeSchedules
  • list - List Employee Schedules
hris.payrolls
  • list - List Payroll
  • get - Get Payroll
hris.timeOffRequests
  • 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

issueTracking

issueTracking.collections
  • list - List Collections
  • get - Get Collection
issueTracking.collectionTags
issueTracking.collectionTicketComments
issueTracking.collectionTickets
issueTracking.collectionUsers

sms

sms.messages

vault

vault.connectionCustomMappings
  • list - List connection custom mappings
vault.connections
  • list - Get all connections
  • get - Get connection
  • update - Update connection
  • delete - Deletes a connection
  • imports - Import connection
  • token - Authorize Access Token
vault.connectionSettings
  • list - Get resource settings
  • update - Update settings
vault.consumerRequestCounts
  • list - Consumer request counts
vault.consumers
vault.createCallback
  • state - Create Callback State
vault.customFields
  • list - Get resource custom fields
vault.customMappings
  • list - List custom mappings
vault.logs
  • list - Get all consumer request logs
vault.sessions
vault.validateConnection
  • state - Validate Connection State

webhook

webhook.eventLogs
  • list - List event logs
webhook.webhooks
  • 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

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 { Apideck } from "@apideck/sdk";

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

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,
    },
  });

  // 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 { Apideck } from "@apideck/sdk";

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

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",
  });

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

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.APIError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

HTTP Client ErrorDescription
RequestAbortedErrorHTTP request was aborted by the client
RequestTimeoutErrorHTTP request timed out due to an AbortSignal signal
ConnectionErrorHTTP client was unable to make a request to a server
InvalidRequestErrorAny input used to create a request is invalid
UnexpectedClientErrorUnrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:

Error TypeStatus CodeContent Type
errors.BadRequestResponse400application/json
errors.UnauthorizedResponse401application/json
errors.PaymentRequiredResponse402application/json
errors.NotFoundResponse404application/json
errors.UnprocessableResponse422application/json
errors.APIError4XX, 5XX*/*
import { Apideck } from "@apideck/sdk";
import {
  BadRequestResponse,
  NotFoundResponse,
  PaymentRequiredResponse,
  SDKValidationError,
  UnauthorizedResponse,
  UnprocessableResponse,
} from "@apideck/sdk/models/errors";

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

async function run() {
  let result;
  try {
    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",
    });

    // Handle the result
    console.log(result);
  } 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 BadRequestResponse): {
        // Handle err.data$: BadRequestResponseData
        console.error(err);
        return;
      }
      case (err instanceof UnauthorizedResponse): {
        // Handle err.data$: UnauthorizedResponseData
        console.error(err);
        return;
      }
      case (err instanceof PaymentRequiredResponse): {
        // Handle err.data$: PaymentRequiredResponseData
        console.error(err);
        return;
      }
      case (err instanceof NotFoundResponse): {
        // Handle err.data$: NotFoundResponseData
        console.error(err);
        return;
      }
      case (err instanceof UnprocessableResponse): {
        // Handle err.data$: UnprocessableResponseData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

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.

Server Selection

Override Server URL Per-Client

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

import { Apideck } from "@apideck/sdk";

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

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",
  });

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

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { Apideck } from "@apideck/sdk";

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

async function run() {
  const result = await apideck.fileStorage.uploadSessions.create({
    serviceId: "salesforce",
    createUploadSessionRequest: {
      name: "Documents",
      parentFolderId: "1234",
      driveId: "1234",
      size: 1810673,
      passThrough: [
        {
          serviceId: "<id>",
          extendPaths: [
            {
              path: "$.nested.property",
              value: {
                "TaxClassificationRef": {
                  "value": "EUC-99990201-V1-00020000",
                },
              },
            },
          ],
        },
      ],
    },
  }, {
    serverURL: "https://upload.apideck.com",
  });

  // 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 { Apideck } from "@apideck/sdk";
import { HTTPClient } from "@apideck/sdk/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 Apideck({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeSchemeEnvironment Variable
apiKeyapiKeyAPI keyAPIDECK_API_KEY

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

import { Apideck } from "@apideck/sdk";

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

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",
  });

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

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Apideck } from "@apideck/sdk";

const sdk = new Apideck({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable APIDECK_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

FAQs

Package last updated on 27 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts

Research

Security News

Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts

Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.

By Kirill Boychenko  -  Dec 20, 2024
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc