@panora/sdk
Advanced tools
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
Panora API: A unified API to ship integrations
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @panora/sdk
pnpm add @panora/sdk
bun add @panora/sdk
yarn add @panora/sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
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();
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.
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 |
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();
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();
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 });
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();
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();
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();
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.
accountingAccountsCreate - Create AccountsaccountingAccountsList - List AccountsaccountingAccountsRetrieve - Retrieve AccountsaccountingAddressesList - List AddresssaccountingAddressesRetrieve - Retrieve AddressesaccountingAttachmentsCreate - Create AttachmentsaccountingAttachmentsList - List AttachmentsaccountingAttachmentsRetrieve - Retrieve AttachmentsaccountingBalancesheetsList - List BalanceSheetsaccountingBalancesheetsRetrieve - Retrieve BalanceSheetsaccountingCashflowstatementsList - List CashflowStatementsaccountingCashflowstatementsRetrieve - Retrieve Cashflow StatementsaccountingCompanyinfosList - List CompanyInfosaccountingCompanyinfosRetrieve - Retrieve Company InfosaccountingContactsCreate - Create ContactsaccountingContactsList - List ContactsaccountingContactsRetrieve - Retrieve ContactsaccountingCreditnotesList - List CreditNotesaccountingCreditnotesRetrieve - Retrieve Credit NotesaccountingExpensesCreate - Create ExpensesaccountingExpensesList - List ExpensesaccountingExpensesRetrieve - Retrieve ExpensesaccountingIncomestatementsList - List IncomeStatementsaccountingIncomestatementsRetrieve - Retrieve Income StatementsaccountingInvoicesCreate - Create InvoicesaccountingInvoicesList - List InvoicesaccountingInvoicesRetrieve - Retrieve InvoicesaccountingItemsList - List ItemsaccountingItemsRetrieve - Retrieve ItemsaccountingJournalentriesCreate - Create Journal EntriesaccountingJournalentriesList - List JournalEntrysaccountingJournalentriesRetrieve - Retrieve Journal EntriesaccountingPaymentsCreate - Create PaymentsaccountingPaymentsList - List PaymentsaccountingPaymentsRetrieve - Retrieve PaymentsaccountingPhonenumbersList - List PhoneNumbersaccountingPhonenumbersRetrieve - Retrieve Phone NumbersaccountingPurchaseordersCreate - Create Purchase OrdersaccountingPurchaseordersList - List PurchaseOrdersaccountingPurchaseordersRetrieve - Retrieve Purchase OrdersaccountingTaxratesList - List TaxRatesaccountingTaxratesRetrieve - Retrieve Tax RatesaccountingTrackingcategoriesList - List TrackingCategorysaccountingTrackingcategoriesRetrieve - Retrieve Tracking CategoriesaccountingTransactionsList - List TransactionsaccountingTransactionsRetrieve - Retrieve TransactionsaccountingVendorcreditsList - List VendorCreditsaccountingVendorcreditsRetrieve - Retrieve Vendor CreditsauthLoginSignIn - Log InconnectionsList - List ConnectionscrmCompaniesCreate - Create CompaniescrmCompaniesList - List CompaniescrmCompaniesRetrieve - Retrieve CompaniescrmContactsCreate - Create ContactscrmContactsList - List CRM ContactscrmContactsRetrieve - Retrieve ContactscrmDealsCreate - Create DealscrmDealsList - List DealscrmDealsRetrieve - Retrieve DealscrmEngagementsCreate - Create EngagementscrmEngagementsList - List EngagementscrmEngagementsRetrieve - Retrieve EngagementscrmNotesCreate - Create NotescrmNotesList - List NotescrmNotesRetrieve - Retrieve NotescrmStagesList - List StagescrmStagesRetrieve - Retrieve StagescrmTasksCreate - Create TaskscrmTasksList - List TaskscrmTasksRetrieve - Retrieve TaskscrmUsersList - List UserscrmUsersRetrieve - Retrieve UsersecommerceCustomersList - List CustomersecommerceCustomersRetrieve - Retrieve CustomersecommerceFulfillmentsList - List FulfillmentsecommerceFulfillmentsRetrieve - Retrieve FulfillmentsecommerceOrdersCreate - Create OrdersecommerceOrdersList - List OrdersecommerceOrdersRetrieve - Retrieve OrdersecommerceProductsCreate - Create ProductsecommerceProductsList - List ProductsecommerceProductsRetrieve - Retrieve ProductseventsGetPanoraCoreEvents - List EventsfieldMappingsDefineCustomField - Create Custom FieldfieldMappingsDefinitions - Define target FieldfieldMappingsGetFieldMappings - Retrieve field mappingsfieldMappingsGetFieldMappingsEntities - Retrieve field mapping entitiesfieldMappingsGetFieldMappingValues - Retrieve field mappings valuesfieldMappingsMap - Map Custom FieldfilestorageFilesCreate - Create FilesfilestorageFilesList - List FilesfilestorageFilesRetrieve - Retrieve FilesfilestorageFoldersCreate - Create FoldersfilestorageFoldersList - List FoldersfilestorageFoldersRetrieve - Retrieve FoldersfilestorageGroupsList - List GroupsfilestorageGroupsRetrieve - Retrieve GroupsfilestorageUsersList - List UsersfilestorageUsersRetrieve - Retrieve UsershealthhellolinkedUsersCreate - Create Linked UserslinkedUsersImportBatch - Add Batch Linked UserslinkedUsersList - List Linked UserslinkedUsersRemoteId - Retrieve a Linked User From A Remote IdlinkedUsersRetrieve - Retrieve Linked UsersmarketingautomationActionsCreate - Create ActionmarketingautomationActionsList - List ActionsmarketingautomationActionsRetrieve - Retrieve ActionsmarketingautomationAutomationsCreate - Create AutomationmarketingautomationAutomationsList - List AutomationsmarketingautomationAutomationsRetrieve - Retrieve AutomationmarketingautomationCampaignsCreate - Create CampaignmarketingautomationCampaignsList - List CampaignsmarketingautomationCampaignsRetrieve - Retrieve CampaignmarketingautomationContactsCreate - Create ContactmarketingautomationContactsList - List ContactsmarketingautomationContactsRetrieve - Retrieve ContactsmarketingautomationEmailsList - List EmailsmarketingautomationEmailsRetrieve - Retrieve EmailmarketingautomationEventsList - List EventsmarketingautomationEventsRetrieve - Retrieve EventmarketingautomationListsCreate - Create ListsmarketingautomationListsList - List ListsmarketingautomationListsRetrieve - Retrieve ListmarketingautomationMessagesList - List MessagesmarketingautomationMessagesRetrieve - Retrieve MessagesmarketingautomationTemplatesCreate - Create TemplatemarketingautomationTemplatesList - List TemplatesmarketingautomationTemplatesRetrieve - Retrieve TemplatemarketingautomationUsersList - List UsersmarketingautomationUsersRetrieve - Retrieve UserspassthroughRequest - Make a passthrough requestpassthroughRetryidGetRetriedRequestResponse - Retrieve response of a failed passthrough request due to rate limitsprojectsCreate - Create a projectprojectsGetProjects - Retrieve projectsragQuery - Query using RAG SearchsyncGetPullFrequency - Get pull frequency for verticalssyncResync - Resync common objects across a verticalsyncStatus - Retrieve sync status of a certain verticalsyncUpdatePullFrequency - Update pull frequency for verticalsticketingAccountsList - List AccountsticketingAccountsRetrieve - Retrieve AccountsticketingAttachmentsCreate - Create AttachmentsticketingAttachmentsList - List AttachmentsticketingAttachmentsRetrieve - Retrieve AttachmentsticketingCollectionsList - List CollectionsticketingCollectionsRetrieve - Retrieve CollectionsticketingCommentsCreate - Create CommentsticketingCommentsList - List CommentsticketingCommentsRetrieve - Retrieve CommentticketingContactsList - List ContactsticketingContactsRetrieve - Retrieve ContactticketingTagsList - List TagsticketingTagsRetrieve - Retrieve TagticketingTeamsList - List TeamsticketingTeamsRetrieve - Retrieve TeamsticketingTicketsCreate - Create TicketsticketingTicketsList - List TicketsticketingTicketsRetrieve - Retrieve TicketsticketingUsersList - List UsersticketingUsersRetrieve - Retrieve UserwebhooksCreate - Create webhookwebhooksDelete - Delete WebhookwebhooksList - List webhookswebhooksUpdateStatus - Update webhook statuswebhooksVerifyEvent - Verify payload signature of the webhookYou 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 });
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.
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!
FAQs
<a href="https://opensource.
The npm package @panora/sdk receives a total of 1 weekly downloads. As such, @panora/sdk popularity was classified as not popular.
We found that @panora/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.