@panora/sdk

v0.13.8

Published

2 months ago

<div align="left"> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.

Downloads

0High
0Medium
0Low

rflih_

nael-panora

@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:

[ ] 🛠 Make your SDK feel handcrafted by customizing it
[ ] ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
[ ] 🎁 Publish your SDK to package managers by configuring automatic publishing
[ ] ✨ When ready to productionize, delete this section from the README

Summary

Panora API: A unified API to ship integrations

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

accounting

accounting.accounts

list - List Accounts
create - Create Accounts
retrieve - Retrieve Accounts

accounting.addresses

list - List Addresss
retrieve - Retrieve Addresses

accounting.attachments

list - List Attachments
create - Create Attachments
retrieve - Retrieve 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

list - List Contacts
create - Create Contacts
retrieve - Retrieve Contacts

accounting.creditnotes

list - List CreditNotes
retrieve - Retrieve Credit Notes

accounting.expenses

list - List Expenses
create - Create Expenses
retrieve - Retrieve Expenses

accounting.incomestatements

list - List IncomeStatements
retrieve - Retrieve Income Statements

accounting.invoices

list - List Invoices
create - Create Invoices
retrieve - Retrieve Invoices

accounting.items

list - List Items
retrieve - Retrieve Items

accounting.journalentries

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

accounting.payments

list - List Payments
create - Create Payments
retrieve - Retrieve 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

list - List TaxRates
retrieve - Retrieve Tax Rates

accounting.trackingcategories

list - List TrackingCategorys
retrieve - Retrieve Tracking Categories

accounting.transactions

list - List Transactions
retrieve - Retrieve Transactions

accounting.vendorcredits

list - List VendorCredits
retrieve - Retrieve Vendor Credits

ats

ats.activities

list - List Activities
create - Create Activities
retrieve - Retrieve Activities

ats.applications

list - List Applications
create - Create Applications
retrieve - Retrieve Applications

ats.attachments

list - List Attachments
create - Create Attachments
retrieve - Retrieve Attachments

ats.candidates

list - List Candidates
create - Create Candidates
retrieve - Retrieve Candidates

ats.departments

list - List Departments
retrieve - Retrieve Departments

ats.eeocs

list - List Eeocss
retrieve - Retrieve Eeocs

ats.interviews

list - List Interviews
create - Create Interviews
retrieve - Retrieve Interviews

ats.jobinterviewstages

list - List JobInterviewStages
retrieve - Retrieve Job Interview Stages

ats.jobs

list - List Jobs
retrieve - Retrieve Jobs

ats.offers

list - List Offers
retrieve - Retrieve Offers

ats.offices

list - List Offices
retrieve - Retrieve Offices

ats.rejectreasons

list - List RejectReasons
retrieve - Retrieve Reject Reasons

ats.scorecards

list - List ScoreCards
retrieve - Retrieve Score Cards

ats.tags

list - List Tags
retrieve - Retrieve Tags

ats.users

list - List Users
retrieve - Retrieve Users

auth

auth.login

signIn - Log In

connections

list - List Connections

crm

crm.companies

list - List Companies
create - Create Companies
retrieve - Retrieve Companies

crm.contacts

list - List CRM Contacts
create - Create Contacts
retrieve - Retrieve Contacts

crm.deals

list - List Deals
create - Create Deals
retrieve - Retrieve Deals

crm.engagements

list - List Engagements
create - Create Engagements
retrieve - Retrieve Engagements

crm.notes

list - List Notes
create - Create Notes
retrieve - Retrieve Notes

crm.stages

list - List Stages
retrieve - Retrieve Stages

crm.tasks

list - List Tasks
create - Create Tasks
retrieve - Retrieve Tasks

crm.users

list - List Users
retrieve - Retrieve Users

ecommerce

ecommerce.customers

list - List Customers
retrieve - Retrieve Customers

ecommerce.fulfillments

list - List Fulfillments
retrieve - Retrieve Fulfillments

ecommerce.orders

list - List Orders
create - Create Orders
retrieve - Retrieve Orders

ecommerce.products

list - List Products
create - Create Products
retrieve - Retrieve Products

events

getPanoraCoreEvents - List Events

fieldMappings

getFieldMappingValues - Retrieve field mappings values
getFieldMappingsEntities - Retrieve field mapping entities
getFieldMappings - Retrieve field mappings
definitions - Define target Field
defineCustomField - Create Custom Field
map - Map Custom Field

filestorage

filestorage.files

list - List Files
create - Create Files
retrieve - Retrieve Files

filestorage.folders

list - List Folders
create - Create Folders
retrieve - Retrieve Folders

filestorage.groups

list - List Groups
retrieve - Retrieve Groups

filestorage.users

list - List Users
retrieve - Retrieve Users

hris

hris.bankinfos

list - List Bank Info
retrieve - Retrieve Bank Info

hris.benefits

list - List Benefits
retrieve - Retrieve Benefit

hris.companies

list - List Companies
retrieve - Retrieve Company

hris.dependents

list - List Dependents
retrieve - Retrieve Dependent

hris.employeepayrollruns

list - List Employee Payroll Runs
retrieve - Retrieve Employee Payroll Run

hris.employees

list - List Employees
create - Create Employees
retrieve - Retrieve Employee

hris.employerbenefits

list - List Employer Benefits
retrieve - Retrieve Employer Benefit

hris.employments

list - List Employments
retrieve - Retrieve Employment

hris.groups

list - List Groups
retrieve - Retrieve Group

hris.locations

list - List Locations
retrieve - Retrieve Location

hris.paygroups

list - List Pay Groups
retrieve - Retrieve Pay Group

hris.payrollruns

list - List Payroll Runs
retrieve - Retrieve Payroll Run

hris.timeoffbalances

list - List TimeoffBalances
retrieve - Retrieve Time off Balances

hris.timeoffs

list - List Time Offs
create - Create Timeoffs
retrieve - Retrieve Time Off

hris.timesheetentries

list - List Timesheetentries
create - Create Timesheetentrys
retrieve - Retrieve Timesheetentry

linkedUsers

remoteId - Retrieve a Linked User From A Remote Id
create - Create Linked Users
list - List Linked Users
importBatch - Add Batch Linked Users
retrieve - Retrieve Linked Users

marketingautomation

marketingautomation.actions

list - List Actions
create - Create Action
retrieve - Retrieve Actions

marketingautomation.automations

list - List Automations
create - Create Automation
retrieve - Retrieve Automation

marketingautomation.campaigns

list - List Campaigns
create - Create Campaign
retrieve - Retrieve Campaign

marketingautomation.contacts

list - List Contacts
create - Create Contact
retrieve - Retrieve Contacts

marketingautomation.emails

list - List Emails
retrieve - Retrieve Email

marketingautomation.events

list - List Events
retrieve - Retrieve Event

marketingautomation.lists

list - List Lists
create - Create Lists
retrieve - Retrieve List

marketingautomation.messages

list - List Messages
retrieve - Retrieve Messages

marketingautomation.templates

list - List Templates
create - Create Template
retrieve - Retrieve Template

marketingautomation.users

list - List Users
retrieve - Retrieve Users

Panora SDK

passthrough

request - Make a passthrough request

passthrough.retryid

getRetriedRequestResponse - Retrieve response of a failed passthrough request due to rate limits

projects

getProjects - Retrieve projects
create - Create a project

rag

query - Query using RAG Search

sync

status - Retrieve sync status of a certain vertical
resync - Resync common objects across a vertical
updatePullFrequency - Update pull frequency for verticals
getPullFrequency - Get pull frequency for verticals

ticketing

ticketing.accounts

list - List Accounts
retrieve - Retrieve Accounts

ticketing.attachments

list - List Attachments
create - Create Attachments
retrieve - Retrieve Attachments

ticketing.collections

list - List Collections
retrieve - Retrieve Collections

ticketing.comments

list - List Comments
create - Create Comments
retrieve - Retrieve Comment

ticketing.contacts

list - List Contacts
retrieve - Retrieve Contact

ticketing.tags

list - List Tags
retrieve - Retrieve Tag

ticketing.teams

list - List Teams
retrieve - Retrieve Teams

ticketing.tickets

list - List Tickets
create - Create Tickets
retrieve - Retrieve Tickets

ticketing.users

list - List Users
retrieve - Retrieve User

webhooks

list - List webhooks
create - Create webhook
delete - Delete Webhook
updateStatus - Update webhook status
verifyEvent - Verify payload signature of the webhook

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.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 { 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();

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.panora.dev | None | | 1 | https://api-sandbox.panora.dev | None | | 2 | https://api-dev.panora.dev | None |

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

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!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@panora/sdk

🏗 Welcome to your new SDK! 🏗

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Available Resources and Operations