Skip to content

panoratech/typescript-sdk

BranchesTags

Repository files navigation

@panora/sdk

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

Summary

Panora API: A unified API to ship integrations

Table of Contents

SDK Installation

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

NPM

npm add @panora/sdk

PNPM

pnpm add @panora/sdk

Bun

bun add @panora/sdk

Yarn

yarn add @panora/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 { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello();

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

run();

Available Resources and Operations

Available methods

accounting

accounting.accounts

accounting.addresses

accounting.attachments

accounting.balancesheets

  • list - List BalanceSheets
  • retrieve - Retrieve BalanceSheets

accounting.cashflowstatements

  • list - List CashflowStatements
  • retrieve - Retrieve Cashflow Statements

accounting.companyinfos

  • list - List CompanyInfos
  • retrieve - Retrieve Company Infos

accounting.contacts

accounting.creditnotes

accounting.expenses

accounting.incomestatements

  • list - List IncomeStatements
  • retrieve - Retrieve Income Statements

accounting.invoices

accounting.items

accounting.journalentries

  • list - List JournalEntrys
  • create - Create Journal Entries
  • retrieve - Retrieve Journal Entries

accounting.payments

accounting.phonenumbers

  • list - List PhoneNumbers
  • retrieve - Retrieve Phone Numbers

accounting.purchaseorders

  • list - List PurchaseOrders
  • create - Create Purchase Orders
  • retrieve - Retrieve Purchase Orders

accounting.taxrates

accounting.trackingcategories

  • list - List TrackingCategorys
  • retrieve - Retrieve Tracking Categories

accounting.transactions

accounting.vendorcredits

  • list - List VendorCredits
  • retrieve - Retrieve Vendor Credits

auth

auth.login

connections

  • list - List Connections

crm

crm.companies

crm.contacts

crm.deals

crm.engagements

crm.notes

crm.stages

crm.tasks

crm.users

ecommerce

ecommerce.customers

ecommerce.fulfillments

ecommerce.orders

ecommerce.products

events

fieldMappings

filestorage

filestorage.files

filestorage.folders

filestorage.groups

filestorage.users

linkedUsers

marketingautomation

marketingautomation.actions

marketingautomation.automations

marketingautomation.campaigns

marketingautomation.contacts

marketingautomation.emails

marketingautomation.events

marketingautomation.lists

marketingautomation.messages

marketingautomation.templates

marketingautomation.users

Panora SDK

passthrough

  • request - Make a passthrough request

passthrough.retryid

projects

rag

  • query - Query using RAG Search

sync

ticketing

ticketing.accounts

ticketing.attachments

ticketing.collections

ticketing.comments

ticketing.contacts

ticketing.tags

ticketing.teams

ticketing.tickets

ticketing.users

webhooks

Error Handling

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

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

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised 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 hello method may throw the following errors:

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */* 
import { Panora } from "@panora/sdk";
import { SDKValidationError } from "@panora/sdk/models/errors";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  let result;
  try {
    result = await panora.hello();

    // 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;
      }
      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

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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
0 https://api.panora.dev
1 https://api-sandbox.panora.dev
2 https://api-dev.panora.dev

Example

import { Panora } from "@panora/sdk";

const panora = new Panora({
  serverIdx: 2,
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello();

  // 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: string optional parameter when initializing the SDK client instance. For example:

import { Panora } from "@panora/sdk";

const panora = new Panora({
  serverURL: "https://api.panora.dev",
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello();

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

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

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello({
    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 { Panora } from "@panora/sdk";

const panora = new Panora({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello();

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

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
apiKey apiKey API key

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

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.hello();

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

run();

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

Here's an example of one such pagination call:

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.filestorage.files.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });

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

run();

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

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

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

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

2 forks
Report repository

Releases 33

typescript - v0.14.0 - 2024-11-18 18:11:29 Latest
Nov 18, 2024
+ 32 releases

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages