diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 44f231bf..b4f18864 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: caaaa8c3-6dd7-43a5-841e-c3193e68cc73 management: - docChecksum: 73ce3778a891c9bdb1d0d00c8a42490f + docChecksum: 6285cb7ccee4454432a81b1d7aaf3a30 docVersion: "1.0" speakeasyVersion: 1.352.2 generationVersion: 2.385.2 - releaseVersion: 0.5.1 - configChecksum: 36082a99a0f6afb5f706af6e12de6dbe + releaseVersion: 0.6.0 + configChecksum: b367c72f5dc7f7633c5f0b19b3a43714 repoURL: https://github.com/panoratech/typescript-sdk.git installationURL: https://github.com/panoratech/typescript-sdk published: true @@ -23,6 +23,7 @@ features: groups: 2.81.2 nameOverrides: 2.81.2 nullables: 0.1.0 + pagination: 2.82.6 responseFormat: 0.2.3 retries: 2.83.0 sdkHooks: 0.1.0 @@ -52,13 +53,8 @@ generatedFiles: - src/sdk/tasks.ts - src/sdk/panorausers.ts - src/sdk/crm.ts - - src/sdk/batch.ts - - src/sdk/id.ts - - src/sdk/fromremoteid.ts - src/sdk/linkedusers.ts - src/sdk/projects.ts - - src/sdk/define.ts - - src/sdk/map.ts - src/sdk/fieldmappings.ts - src/sdk/events.ts - src/sdk/passthrough.ts @@ -203,8 +199,8 @@ generatedFiles: - src/models/components/projectresponse.ts - src/models/components/createprojectdto.ts - src/models/components/customfieldresponse.ts - - src/models/components/customfieldcreatedto.ts - src/models/components/definetargetfielddto.ts + - src/models/components/customfieldcreatedto.ts - src/models/components/mapfieldtoproviderdto.ts - src/models/components/eventresponse.ts - src/models/components/passthroughresponse.ts @@ -577,12 +573,12 @@ generatedFiles: - docs/models/components/createprojectdto.md - docs/models/components/customfieldresponsedatatype.md - docs/models/components/customfieldresponse.md - - docs/models/components/customfieldcreatedtoobjecttypeowner.md - - docs/models/components/customfieldcreatedtodatatype.md - - docs/models/components/customfieldcreatedto.md - docs/models/components/objecttypeowner.md - docs/models/components/datatype.md - docs/models/components/definetargetfielddto.md + - docs/models/components/customfieldcreatedtoobjecttypeowner.md + - docs/models/components/customfieldcreatedtodatatype.md + - docs/models/components/customfieldcreatedto.md - docs/models/components/mapfieldtoproviderdto.md - docs/models/components/eventresponsetype.md - docs/models/components/eventresponsestatus.md @@ -706,6 +702,7 @@ generatedFiles: - docs/models/operations/verifyeventresponsebody.md - docs/models/operations/listticketingticketrequest.md - docs/models/operations/listticketingticketresponsebody.md + - docs/models/operations/listticketingticketresponse.md - docs/models/operations/createticketingticketrequest.md - docs/models/operations/retrieveticketingticketrequest.md - docs/models/operations/listticketingusersrequest.md @@ -1014,13 +1011,8 @@ generatedFiles: - docs/sdks/tasks/README.md - docs/sdks/panorausers/README.md - docs/sdks/linkedusers/README.md - - docs/sdks/batch/README.md - - docs/sdks/id/README.md - - docs/sdks/fromremoteid/README.md - docs/sdks/projects/README.md - docs/sdks/fieldmappings/README.md - - docs/sdks/define/README.md - - docs/sdks/map/README.md - docs/sdks/events/README.md - docs/sdks/passthrough/README.md - docs/sdks/hris/README.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index d437153e..fba5744b 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.5.1 + version: 0.6.0 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 9d39eb12..26abaa1c 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.352.2 sources: panora-open-api-swagger: sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:c2c6829443735d39ca07b71f8c269c09be36206f348f4607daffe3bc2071df24 - sourceBlobDigest: sha256:00c5d274f2ad4ceebaaf0cc9f3efa30f4e7005931d28203635e0b1f593157336 + sourceRevisionDigest: sha256:4ffa359f331f43e3e75ab59b81e40983030d3e1d77aead527f51665a08484a61 + sourceBlobDigest: sha256:342c552d930e33efaa3246ae82cfeda95537b63ceef0bda067bb2bfbf5d0278b tags: - latest - main @@ -11,10 +11,10 @@ targets: my-first-target: source: panora-open-api-swagger sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:c2c6829443735d39ca07b71f8c269c09be36206f348f4607daffe3bc2071df24 - sourceBlobDigest: sha256:00c5d274f2ad4ceebaaf0cc9f3efa30f4e7005931d28203635e0b1f593157336 + sourceRevisionDigest: sha256:4ffa359f331f43e3e75ab59b81e40983030d3e1d77aead527f51665a08484a61 + sourceBlobDigest: sha256:342c552d930e33efaa3246ae82cfeda95537b63ceef0bda067bb2bfbf5d0278b codeSamplesNamespace: code-samples-typescript-my-first-target - codeSamplesRevisionDigest: sha256:53d6ca387a5e6b481c642e6f1f8a532cf1ba5ac5fe80f57d917f0e2c2b8eebcc + codeSamplesRevisionDigest: sha256:1b062b14013988d8449345ca4fb430d07a582c943372443727b1deded72eb838 outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/README.md b/README.md index f5f5d2da..442e902e 100644 --- a/README.md +++ b/README.md @@ -207,18 +207,9 @@ run(); * [create](docs/sdks/linkedusers/README.md#create) - Create Linked Users * [list](docs/sdks/linkedusers/README.md#list) - List Linked Users - -### [linkedUsers.batch](docs/sdks/batch/README.md) - -* [importBatch](docs/sdks/batch/README.md#importbatch) - Add Batch Linked Users - -### [linkedUsers.id](docs/sdks/id/README.md) - -* [retrieve](docs/sdks/id/README.md#retrieve) - Retrieve Linked Users - -### [linkedUsers.fromremoteid](docs/sdks/fromremoteid/README.md) - -* [remoteId](docs/sdks/fromremoteid/README.md#remoteid) - Retrieve a Linked User From A Remote Id +* [importBatch](docs/sdks/linkedusers/README.md#importbatch) - Add Batch Linked Users +* [retrieve](docs/sdks/linkedusers/README.md#retrieve) - Retrieve Linked Users +* [remoteId](docs/sdks/linkedusers/README.md#remoteid) - Retrieve a Linked User From A Remote Id ### [projects](docs/sdks/projects/README.md) @@ -227,15 +218,9 @@ run(); ### [fieldMappings](docs/sdks/fieldmappings/README.md) +* [definitions](docs/sdks/fieldmappings/README.md#definitions) - Define target Field * [defineCustomField](docs/sdks/fieldmappings/README.md#definecustomfield) - Create Custom Field - -### [fieldMappings.define](docs/sdks/define/README.md) - -* [definitions](docs/sdks/define/README.md#definitions) - Define target Field - -### [fieldMappings.map](docs/sdks/map/README.md) - -* [map](docs/sdks/map/README.md#map) - Map Custom Field +* [map](docs/sdks/fieldmappings/README.md#map) - Map Custom Field ### [events](docs/sdks/events/README.md) @@ -844,6 +829,43 @@ 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`][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 { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.ticketing.tickets.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); + + for await (const page of result) { + // handle page + } +} + +run(); + +``` + + # Development diff --git a/RELEASES.md b/RELEASES.md index d34831c4..007e4349 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -118,4 +118,14 @@ Based on: ### Generated - [typescript v0.5.1] . ### Releases -- [NPM v0.5.1] https://www.npmjs.com/package/@panora/sdk/v/0.5.1 - . \ No newline at end of file +- [NPM v0.5.1] https://www.npmjs.com/package/@panora/sdk/v/0.5.1 - . + +## 2024-08-06 01:00:15 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.352.2 (2.385.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.6.0] . +### Releases +- [NPM v0.6.0] https://www.npmjs.com/package/@panora/sdk/v/0.6.0 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index 72f91559..859af588 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -3,11 +3,11 @@ info: title: CodeSamples overlay for typescript target version: 0.0.0 actions: - - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] + - target: $["paths"]["/ticketing/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPurchaseOrder + label: listTicketingContacts source: |- import { Panora } from "@panora/sdk"; @@ -16,10 +16,11 @@ actions: }); async function run() { - const result = await panora.accounting.purchaseorders.retrieve({ + const result = await panora.ticketing.contacts.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -27,11 +28,17 @@ actions: } run(); - - target: $["paths"]["/ats/eeocs/{id}"]["get"] + - target: $["paths"]["/sync/status/{vertical}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsEeocs + label: status + source: "import { Panora } from \"@panora/sdk\";\nimport { Vertical } from \"@panora/sdk/models/operations\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.sync.status({\n vertical: Vertical.Ticketing,\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/marketingautomation/messages"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listMarketingautomationMessages source: |- import { Panora } from "@panora/sdk"; @@ -40,9 +47,11 @@ actions: }); async function run() { - const result = await panora.ats.eeocs.retrieve({ + const result = await panora.marketingautomation.messages.list({ xConnectionToken: "", - id: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -50,11 +59,11 @@ actions: } run(); - - target: $["paths"]["/hris/dependents"]["get"] + - target: $["paths"]["/filestorage/folders"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisDependents + label: listFilestorageFolder source: |- import { Panora } from "@panora/sdk"; @@ -63,8 +72,11 @@ actions: }); async function run() { - const result = await panora.hris.dependents.list({ + const result = await panora.filestorage.folders.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -72,11 +84,11 @@ actions: } run(); - - target: $["paths"]["/hris/employees"]["post"] + - target: $["paths"]["/ticketing/teams/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createHrisEmployee + label: retrieveTicketingTeam source: |- import { Panora } from "@panora/sdk"; @@ -85,9 +97,10 @@ actions: }); async function run() { - const result = await panora.hris.employees.create({ + const result = await panora.ticketing.teams.retrieve({ xConnectionToken: "", - unifiedHrisEmployeeInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -95,11 +108,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] + - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEmail + label: retrieveAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; @@ -108,7 +121,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.emails.retrieve({ + const result = await panora.ats.jobinterviewstages.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -119,11 +132,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/tags"]["get"] + - target: $["paths"]["/accounting/items"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTags + label: listAccountingItem source: |- import { Panora } from "@panora/sdk"; @@ -132,8 +145,11 @@ actions: }); async function run() { - const result = await panora.ticketing.tags.list({ + const result = await panora.accounting.items.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -141,11 +157,11 @@ actions: } run(); - - target: $["paths"]["/linked_users/fromRemoteId"]["get"] + - target: $["paths"]["/accounting/items/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: remoteId + label: retrieveAccountingItem source: |- import { Panora } from "@panora/sdk"; @@ -154,8 +170,10 @@ actions: }); async function run() { - const result = await panora.linkedUsers.fromremoteid.remoteId({ - remoteId: "id_1", + const result = await panora.accounting.items.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -163,11 +181,11 @@ actions: } run(); - - target: $["paths"]["/hris/paygroups"]["get"] + - target: $["paths"]["/webhooks"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisPaygroups + label: listWebhooks source: |- import { Panora } from "@panora/sdk"; @@ -176,20 +194,18 @@ actions: }); async function run() { - const result = await panora.hris.paygroups.list({ - xConnectionToken: "", - }); + const result = await panora.webhooks.list(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] + - target: $["paths"]["/crm/deals/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationContact + label: retrieveCrmDeal source: |- import { Panora } from "@panora/sdk"; @@ -198,7 +214,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.retrieve({ + const result = await panora.crm.deals.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -209,11 +225,11 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["get"] + - target: $["paths"]["/filestorage/drives/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsActivity + label: retrieveFilestorageDrive source: |- import { Panora } from "@panora/sdk"; @@ -222,8 +238,10 @@ actions: }); async function run() { - const result = await panora.ats.activities.list({ + const result = await panora.filestorage.drives.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -231,11 +249,11 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts"]["get"] + - target: $["paths"]["/accounting/journalentries"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingAccounts + label: createAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; @@ -244,8 +262,10 @@ actions: }); async function run() { - const result = await panora.accounting.accounts.list({ + const result = await panora.accounting.journalentries.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingJournalentryInput: {}, }); // Handle the result @@ -253,11 +273,11 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts/{id}"]["get"] + - target: $["paths"]["/filestorage/files"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAccount + label: listFilestorageFile source: |- import { Panora } from "@panora/sdk"; @@ -266,10 +286,11 @@ actions: }); async function run() { - const result = await panora.accounting.accounts.retrieve({ + const result = await panora.filestorage.files.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -277,17 +298,11 @@ actions: } run(); - - target: $["paths"]["/auth/login"]["post"] - update: - x-codeSamples: - - lang: typescript - label: signIn - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.auth.login.signIn({\n idUser: \"\",\n email: \"Oda.Treutel97@hotmail.com\",\n passwordHash: \"\",\n });\n\n \n}\n\nrun();" - - target: $["paths"]["/webhooks/{id}"]["put"] + - target: $["paths"]["/connections"]["get"] update: x-codeSamples: - lang: typescript - label: updateStatus + label: getConnections source: |- import { Panora } from "@panora/sdk"; @@ -296,20 +311,18 @@ actions: }); async function run() { - const result = await panora.webhooks.updateStatus({ - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - }); + const result = await panora.connections.getConnections(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/linked_users"]["get"] + - target: $["paths"]["/webhooks"]["post"] update: x-codeSamples: - lang: typescript - label: listLinkedUsers + label: createWebhookPublic source: |- import { Panora } from "@panora/sdk"; @@ -318,18 +331,24 @@ actions: }); async function run() { - const result = await panora.linkedUsers.list(); + const result = await panora.webhooks.create({ + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", + scope: [ + "connection.created", + ], + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/collections"]["get"] + - target: $["paths"]["/ticketing/tags"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingCollections + label: listTicketingTags source: |- import { Panora } from "@panora/sdk"; @@ -338,8 +357,11 @@ actions: }); async function run() { - const result = await panora.ticketing.collections.list({ + const result = await panora.ticketing.tags.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -347,11 +369,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["post"] + - target: $["paths"]["/crm/users"]["get"] update: x-codeSamples: - lang: typescript - label: createHrisTimeoff + label: listCrmUsers source: |- import { Panora } from "@panora/sdk"; @@ -360,9 +382,11 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.create({ + const result = await panora.crm.users.list({ xConnectionToken: "", - unifiedHrisTimeoffInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -394,11 +418,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts"]["post"] + - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingAutomationContact + label: retrieveAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; @@ -407,10 +431,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.create({ + const result = await panora.accounting.purchaseorders.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedMarketingautomationContactInput: {}, }); // Handle the result @@ -418,11 +442,11 @@ actions: } run(); - - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] + - target: $["paths"]["/filestorage/folders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJobInterviewStage + label: retrieveFilestorageFolder source: |- import { Panora } from "@panora/sdk"; @@ -431,7 +455,7 @@ actions: }); async function run() { - const result = await panora.ats.jobinterviewstages.retrieve({ + const result = await panora.filestorage.folders.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -442,23 +466,67 @@ actions: } run(); - - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] + - target: $["paths"]["/ticketing/tickets"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingBalanceSheet + label: createTicketingTicket source: |- import { Panora } from "@panora/sdk"; + import { + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, + } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.balancesheets.retrieve({ + const result = await panora.ticketing.tickets.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedTicketingTicketInput: { + name: "Customer Service Inquiry", + status: UnifiedTicketingTicketInputStatus.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: UnifiedTicketingTicketInputType.Bug, + parentTicket: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + collections: "[\"801f9ede-c698-4e66-a7fc-48d19eebaa4f\"]", + tags: [ + "my_tag", + "urgent_tag", + ], + completedAt: new Date("2024-10-01T12:00:00Z"), + priority: UnifiedTicketingTicketInputPriority.High, + assignedTo: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + }, + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -466,11 +534,11 @@ actions: } run(); - - target: $["paths"]["/"]["get"] + - target: $["paths"]["/crm/tasks"]["get"] update: x-codeSamples: - lang: typescript - label: hello + label: listCrmTask source: |- import { Panora } from "@panora/sdk"; @@ -479,18 +547,23 @@ actions: }); async function run() { - const result = await panora.hello(); + const result = await panora.crm.tasks.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/attachments/{id}"]["get"] + - target: $["paths"]["/marketingautomation/events/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAttachment + label: retrieveMarketingautomationEvent source: |- import { Panora } from "@panora/sdk"; @@ -499,7 +572,7 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.retrieve({ + const result = await panora.marketingautomation.events.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -510,11 +583,11 @@ actions: } run(); - - target: $["paths"]["/crm/deals/{id}"]["get"] + - target: $["paths"]["/ats/offers"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmDeal + label: listAtsOffer source: |- import { Panora } from "@panora/sdk"; @@ -523,10 +596,11 @@ actions: }); async function run() { - const result = await panora.crm.deals.retrieve({ + const result = await panora.ats.offers.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -534,57 +608,23 @@ actions: } run(); - - target: $["paths"]["/crm/companies"]["post"] + - target: $["paths"]["/accounting/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmCompany + label: retrieveAccountingContact source: |- import { Panora } from "@panora/sdk"; - import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.crm.companies.create({ + const result = await panora.accounting.contacts.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedCrmCompanyInput: { - name: "Acme", - industry: UnifiedCrmCompanyInputIndustry.Accounting, - numberOfEmployees: 10, - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - emailAddresses: [ - { - emailAddress: "acme@gmail.com", - emailAddressType: EmailAddressType.Work, - }, - ], - addresses: [ - { - street1: "5th Avenue", - street2: "", - city: "New York", - state: "NY", - postalCode: "46842", - country: "USA", - addressType: AddressType.Work, - ownerType: "", - }, - ], - phoneNumbers: [ - { - phoneNumber: "+33660606067", - phoneType: PhoneType.Work, - }, - ], - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, }); // Handle the result @@ -592,11 +632,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/events"]["get"] + - target: $["paths"]["/health"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationEvents + label: health source: |- import { Panora } from "@panora/sdk"; @@ -605,20 +645,18 @@ actions: }); async function run() { - const result = await panora.marketingautomation.events.list({ - xConnectionToken: "", - }); + const result = await panora.health(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/collections/{id}"]["get"] + - target: $["paths"]["/crm/stages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCollection + label: retrieveCrmStage source: |- import { Panora } from "@panora/sdk"; @@ -627,7 +665,7 @@ actions: }); async function run() { - const result = await panora.ticketing.collections.retrieve({ + const result = await panora.crm.stages.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -638,11 +676,11 @@ actions: } run(); - - target: $["paths"]["/projects"]["post"] + - target: $["paths"]["/hris/timeoffs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createProject + label: retrieveHrisTimeoff source: |- import { Panora } from "@panora/sdk"; @@ -651,10 +689,10 @@ actions: }); async function run() { - const result = await panora.projects.create({ - name: "Project Name", - idOrganization: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - idUser: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.hris.timeoffs.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -662,35 +700,24 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["post"] + - target: $["paths"]["/ats/offices"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsActivity + label: listAtsOffice source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.activities.create({ + const result = await panora.ats.offices.list({ xConnectionToken: "", - remoteData: false, - unifiedAtsActivityInput: { - activityType: UnifiedAtsActivityInputActivityType.Note, - subject: "Email subject", - body: "Dear Diana, I love you", - visibility: UnifiedAtsActivityInputVisibility.Public, - candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -698,41 +725,24 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["post"] + - target: $["paths"]["/accounting/incomestatements"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsInterview + label: listAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.interviews.create({ + const result = await panora.accounting.incomestatements.list({ xConnectionToken: "", - remoteData: false, - unifiedAtsInterviewInput: { - status: UnifiedAtsInterviewInputStatus.Scheduled, - applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - jobInterviewStageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - organizedBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - interviewers: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - location: "San Francisco", - startAt: new Date("2024-10-01T12:00:00Z"), - endAt: new Date("2024-10-01T12:00:00Z"), - remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), - remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -740,21 +750,35 @@ actions: } run(); - - target: $["paths"]["/filestorage/groups"]["get"] + - target: $["paths"]["/ats/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: listFilestorageGroup + label: createAtsAttachment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.filestorage.groups.list({ + const result = await panora.ats.attachments.create({ xConnectionToken: "", + remoteData: false, + unifiedAtsAttachmentInput: { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: UnifiedAtsAttachmentInputAttachmentType.Resume, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -762,11 +786,11 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments"]["post"] + - target: $["paths"]["/accounting/addresses"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingAttachment + label: listAccountingAddress source: |- import { Panora } from "@panora/sdk"; @@ -775,10 +799,11 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.create({ + const result = await panora.accounting.addresses.list({ xConnectionToken: "", - remoteData: false, - unifiedAccountingAttachmentInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -786,11 +811,11 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices/{id}"]["get"] + - target: $["paths"]["/filestorage/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingInvoice + label: retrieveFilestorageUser source: |- import { Panora } from "@panora/sdk"; @@ -799,7 +824,7 @@ actions: }); async function run() { - const result = await panora.accounting.invoices.retrieve({ + const result = await panora.filestorage.users.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -810,11 +835,11 @@ actions: } run(); - - target: $["paths"]["/crm/notes/{id}"]["get"] + - target: $["paths"]["/marketingautomation/automations"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmNote + label: createMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; @@ -823,10 +848,10 @@ actions: }); async function run() { - const result = await panora.crm.notes.retrieve({ + const result = await panora.marketingautomation.automations.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedMarketingautomationAutomationInput: {}, }); // Handle the result @@ -834,21 +859,41 @@ actions: } run(); - - target: $["paths"]["/ats/jobs"]["get"] + - target: $["paths"]["/ats/interviews"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsJob + label: createAtsInterview source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.jobs.list({ + const result = await panora.ats.interviews.create({ xConnectionToken: "", + remoteData: false, + unifiedAtsInterviewInput: { + status: UnifiedAtsInterviewInputStatus.Scheduled, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobInterviewStageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + organizedBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + location: "San Francisco", + startAt: new Date("2024-10-01T12:00:00Z"), + endAt: new Date("2024-10-01T12:00:00Z"), + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -856,11 +901,11 @@ actions: } run(); - - target: $["paths"]["/ats/rejectreasons/{id}"]["get"] + - target: $["paths"]["/accounting/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsRejectReason + label: listAccountingAccounts source: |- import { Panora } from "@panora/sdk"; @@ -869,10 +914,11 @@ actions: }); async function run() { - const result = await panora.ats.rejectreasons.retrieve({ + const result = await panora.accounting.accounts.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -880,11 +926,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/teams"]["get"] + - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTeams + label: retrieveAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; @@ -893,8 +939,10 @@ actions: }); async function run() { - const result = await panora.ticketing.teams.list({ + const result = await panora.accounting.incomestatements.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -902,11 +950,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] + - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationMessage + label: retrieveAccountingPhonenumber source: |- import { Panora } from "@panora/sdk"; @@ -915,7 +963,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.messages.retrieve({ + const result = await panora.accounting.phonenumbers.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -926,40 +974,23 @@ actions: } run(); - - target: $["paths"]["/crm/engagements"]["post"] + - target: $["paths"]["/crm/engagements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmEngagement + label: retrieveCrmEngagement source: |- import { Panora } from "@panora/sdk"; - import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.crm.engagements.create({ + const result = await panora.crm.engagements.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedCrmEngagementInput: { - content: "Meeting call with CTO", - direction: UnifiedCrmEngagementInputDirection.Inbound, - subject: "Technical features planning", - startAt: new Date("2024-10-01T12:00:00Z"), - endTime: new Date("2024-10-01T22:00:00Z"), - type: UnifiedCrmEngagementInputType.Meeting, - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contacts: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, }); // Handle the result @@ -967,11 +998,11 @@ actions: } run(); - - target: $["paths"]["/hris/benefits"]["get"] + - target: $["paths"]["/crm/stages"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisBenefits + label: listCrmStages source: |- import { Panora } from "@panora/sdk"; @@ -980,8 +1011,11 @@ actions: }); async function run() { - const result = await panora.hris.benefits.list({ + const result = await panora.crm.stages.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -989,11 +1023,11 @@ actions: } run(); - - target: $["paths"]["/hris/groups"]["get"] + - target: $["paths"]["/ats/interviews/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisGroups + label: retrieveAtsInterview source: |- import { Panora } from "@panora/sdk"; @@ -1002,8 +1036,10 @@ actions: }); async function run() { - const result = await panora.hris.groups.list({ + const result = await panora.ats.interviews.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1011,11 +1047,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions"]["get"] + - target: $["paths"]["/ats/scorecards/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAction + label: retrieveAtsScorecard source: |- import { Panora } from "@panora/sdk"; @@ -1024,8 +1060,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.actions.list({ + const result = await panora.ats.scorecards.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1033,11 +1071,11 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses"]["post"] + - target: $["paths"]["/filestorage/folders"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingExpense + label: createFilestorageFolder source: |- import { Panora } from "@panora/sdk"; @@ -1046,10 +1084,23 @@ actions: }); async function run() { - const result = await panora.accounting.expenses.create({ + const result = await panora.filestorage.folders.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingExpenseInput: {}, + unifiedFilestorageFolderInput: { + name: "school", + size: "2048", + folderUrl: "https://example.com/school", + description: "All things school related", + driveId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + parentFolderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -1057,11 +1108,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/drives/{id}"]["get"] + - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageDrive + label: retrieveMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; @@ -1070,7 +1121,7 @@ actions: }); async function run() { - const result = await panora.filestorage.drives.retrieve({ + const result = await panora.marketingautomation.contacts.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1081,11 +1132,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["get"] + - target: $["paths"]["/ticketing/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationLists + label: listTicketingAccount source: |- import { Panora } from "@panora/sdk"; @@ -1094,8 +1145,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.lists.list({ + const result = await panora.ticketing.accounts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1103,11 +1157,11 @@ actions: } run(); - - target: $["paths"]["/ats/rejectreasons"]["get"] + - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsRejectReasons + label: retrieveMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; @@ -1116,8 +1170,10 @@ actions: }); async function run() { - const result = await panora.ats.rejectreasons.list({ + const result = await panora.marketingautomation.campaigns.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1125,11 +1181,11 @@ actions: } run(); - - target: $["paths"]["/hris/companies"]["get"] + - target: $["paths"]["/ats/users"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisCompanies + label: listAtsUsers source: |- import { Panora } from "@panora/sdk"; @@ -1138,8 +1194,11 @@ actions: }); async function run() { - const result = await panora.hris.companies.list({ + const result = await panora.ats.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1147,11 +1206,11 @@ actions: } run(); - - target: $["paths"]["/hris/bankinfos"]["get"] + - target: $["paths"]["/accounting/payments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisBankInfo + label: retrieveAccountingPayment source: |- import { Panora } from "@panora/sdk"; @@ -1160,8 +1219,10 @@ actions: }); async function run() { - const result = await panora.hris.bankinfos.list({ + const result = await panora.accounting.payments.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1169,11 +1230,11 @@ actions: } run(); - - target: $["paths"]["/hris/paygroups/{id}"]["get"] + - target: $["paths"]["/accounting/expenses"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisPaygroup + label: createAccountingExpense source: |- import { Panora } from "@panora/sdk"; @@ -1182,10 +1243,10 @@ actions: }); async function run() { - const result = await panora.hris.paygroups.retrieve({ + const result = await panora.accounting.expenses.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingExpenseInput: {}, }); // Handle the result @@ -1193,11 +1254,11 @@ actions: } run(); - - target: $["paths"]["/connections"]["get"] + - target: $["paths"]["/accounting/trackingcategories"]["get"] update: x-codeSamples: - lang: typescript - label: getConnections + label: listAccountingTrackingCategorys source: |- import { Panora } from "@panora/sdk"; @@ -1206,18 +1267,23 @@ actions: }); async function run() { - const result = await panora.connections.getConnections(); + const result = await panora.accounting.trackingcategories.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/teams/{id}"]["get"] + - target: $["paths"]["/"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTeam + label: hello source: |- import { Panora } from "@panora/sdk"; @@ -1226,22 +1292,18 @@ actions: }); async function run() { - const result = await panora.ticketing.teams.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); + const result = await panora.hello(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/attachments"]["get"] + - target: $["paths"]["/webhooks/{id}"]["put"] update: x-codeSamples: - lang: typescript - label: listTicketingAttachments + label: updateStatus source: |- import { Panora } from "@panora/sdk"; @@ -1250,8 +1312,8 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.list({ - xConnectionToken: "", + const result = await panora.webhooks.updateStatus({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -1259,11 +1321,11 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions/{id}"]["get"] + - target: $["paths"]["/ticketing/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTransaction + label: listTicketingAttachments source: |- import { Panora } from "@panora/sdk"; @@ -1272,10 +1334,11 @@ actions: }); async function run() { - const result = await panora.accounting.transactions.retrieve({ + const result = await panora.ticketing.attachments.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1283,11 +1346,11 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements"]["get"] + - target: $["paths"]["/hris/benefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCashflowStatement + label: retrieveHrisBenefit source: |- import { Panora } from "@panora/sdk"; @@ -1296,8 +1359,10 @@ actions: }); async function run() { - const result = await panora.accounting.cashflowstatements.list({ + const result = await panora.hris.benefits.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1305,11 +1370,11 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates"]["get"] + - target: $["paths"]["/accounting/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTaxRate + label: listAccountingAttachments source: |- import { Panora } from "@panora/sdk"; @@ -1318,8 +1383,11 @@ actions: }); async function run() { - const result = await panora.accounting.taxrates.list({ + const result = await panora.accounting.attachments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1327,11 +1395,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates"]["post"] + - target: $["paths"]["/ticketing/tags/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationTemplate + label: retrieveTicketingTag source: |- import { Panora } from "@panora/sdk"; @@ -1340,9 +1408,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.templates.create({ + const result = await panora.ticketing.tags.retrieve({ xConnectionToken: "", - unifiedMarketingautomationTemplateInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1350,11 +1419,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users/{id}"]["get"] + - target: $["paths"]["/crm/companies"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationUser + label: listCrmCompany source: |- import { Panora } from "@panora/sdk"; @@ -1363,10 +1432,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.users.retrieve({ + const result = await panora.crm.companies.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1374,11 +1444,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets/{id}"]["get"] + - target: $["paths"]["/ats/jobinterviewstages"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTicket + label: listAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; @@ -1387,10 +1457,11 @@ actions: }); async function run() { - const result = await panora.ticketing.tickets.retrieve({ + const result = await panora.ats.jobinterviewstages.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1398,11 +1469,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/tags/{id}"]["get"] + - target: $["paths"]["/ats/eeocs"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTag + label: listAtsEeocs source: |- import { Panora } from "@panora/sdk"; @@ -1411,10 +1482,11 @@ actions: }); async function run() { - const result = await panora.ticketing.tags.retrieve({ + const result = await panora.ats.eeocs.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1422,11 +1494,11 @@ actions: } run(); - - target: $["paths"]["/linked_users/{id}"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveLinkedUser + label: listMarketingautomationTemplates source: |- import { Panora } from "@panora/sdk"; @@ -1435,8 +1507,11 @@ actions: }); async function run() { - const result = await panora.linkedUsers.id.retrieve({ - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.marketingautomation.templates.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1444,11 +1519,11 @@ actions: } run(); - - target: $["paths"]["/ats/offers/{id}"]["get"] + - target: $["paths"]["/marketingautomation/users"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffer + label: listMarketingAutomationUsers source: |- import { Panora } from "@panora/sdk"; @@ -1457,10 +1532,11 @@ actions: }); async function run() { - const result = await panora.ats.offers.retrieve({ + const result = await panora.marketingautomation.users.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1468,11 +1544,11 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements"]["get"] + - target: $["paths"]["/ats/jobs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingIncomeStatement + label: retrieveAtsJob source: |- import { Panora } from "@panora/sdk"; @@ -1481,8 +1557,10 @@ actions: }); async function run() { - const result = await panora.accounting.incomestatements.list({ + const result = await panora.ats.jobs.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1490,11 +1568,11 @@ actions: } run(); - - target: $["paths"]["/webhooks/verifyEvent"]["post"] + - target: $["paths"]["/accounting/purchaseorders"]["get"] update: x-codeSamples: - lang: typescript - label: verifyEvent + label: listAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; @@ -1503,12 +1581,11 @@ actions: }); async function run() { - const result = await panora.webhooks.verifyEvent({ - payload: { - "key": "", - }, - signature: "", - secret: "", + const result = await panora.accounting.purchaseorders.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1516,11 +1593,11 @@ actions: } run(); - - target: $["paths"]["/crm/stages/{id}"]["get"] + - target: $["paths"]["/hris/dependents/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmStage + label: retrieveHrisDependent source: |- import { Panora } from "@panora/sdk"; @@ -1529,7 +1606,7 @@ actions: }); async function run() { - const result = await panora.crm.stages.retrieve({ + const result = await panora.hris.dependents.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1540,11 +1617,11 @@ actions: } run(); - - target: $["paths"]["/accounting/payments"]["get"] + - target: $["paths"]["/ats/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPayment + label: retrieveAtsUser source: |- import { Panora } from "@panora/sdk"; @@ -1553,8 +1630,10 @@ actions: }); async function run() { - const result = await panora.accounting.payments.list({ + const result = await panora.ats.users.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1562,11 +1641,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns"]["post"] + - target: $["paths"]["/filestorage/files/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationCampaign + label: retrieveFilestorageFile source: |- import { Panora } from "@panora/sdk"; @@ -1575,10 +1654,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.create({ + const result = await panora.filestorage.files.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedMarketingautomationCampaignInput: {}, }); // Handle the result @@ -1586,11 +1665,11 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes"]["get"] + - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCreditNote + label: retrieveAccountingBalanceSheet source: |- import { Panora } from "@panora/sdk"; @@ -1599,8 +1678,10 @@ actions: }); async function run() { - const result = await panora.accounting.creditnotes.list({ + const result = await panora.accounting.balancesheets.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1608,11 +1689,11 @@ actions: } run(); - - target: $["paths"]["/crm/engagements/{id}"]["get"] + - target: $["paths"]["/hris/employees/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmEngagement + label: retrieveHrisEmployee source: |- import { Panora } from "@panora/sdk"; @@ -1621,7 +1702,7 @@ actions: }); async function run() { - const result = await panora.crm.engagements.retrieve({ + const result = await panora.hris.employees.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1632,25 +1713,24 @@ actions: } run(); - - target: $["paths"]["/field_mappings/define"]["post"] + - target: $["paths"]["/hris/timeoffbalances"]["get"] update: x-codeSamples: - lang: typescript - label: definitions + label: listHrisTimeoffbalances source: |- import { Panora } from "@panora/sdk"; - import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.fieldMappings.define.definitions({ - objectTypeOwner: ObjectTypeOwner.Company, - name: "fav_dish", - description: "My favorite dish", - dataType: DataType.String, + const result = await panora.hris.timeoffbalances.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1658,11 +1738,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users"]["get"] + - target: $["paths"]["/ticketing/collections/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationUsers + label: retrieveCollection source: |- import { Panora } from "@panora/sdk"; @@ -1671,8 +1751,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.users.list({ + const result = await panora.ticketing.collections.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1680,11 +1762,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["post"] + - target: $["paths"]["/accounting/cashflowstatements"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAutomation + label: listAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; @@ -1693,10 +1775,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.create({ + const result = await panora.accounting.cashflowstatements.list({ xConnectionToken: "", - remoteData: false, - unifiedMarketingautomationAutomationInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1704,35 +1787,24 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["post"] + - target: $["paths"]["/accounting/vendorcredits"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsAttachment + label: listAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.attachments.create({ + const result = await panora.accounting.vendorcredits.list({ xConnectionToken: "", - remoteData: false, - unifiedAtsAttachmentInput: { - fileUrl: "https://example.com/file.pdf", - fileName: "file.pdf", - attachmentType: UnifiedAtsAttachmentInputAttachmentType.Resume, - remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), - remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), - candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1740,11 +1812,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments/{id}"]["get"] + - target: $["paths"]["/crm/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingComment + label: retrieveCrmUser source: |- import { Panora } from "@panora/sdk"; @@ -1753,9 +1825,10 @@ actions: }); async function run() { - const result = await panora.ticketing.comments.retrieve({ + const result = await panora.crm.users.retrieve({ xConnectionToken: "", - id: "", + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, }); // Handle the result @@ -1763,11 +1836,11 @@ actions: } run(); - - target: $["paths"]["/crm/users"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["post"] update: x-codeSamples: - lang: typescript - label: listCrmUsers + label: createMarketingautomationTemplate source: |- import { Panora } from "@panora/sdk"; @@ -1776,8 +1849,9 @@ actions: }); async function run() { - const result = await panora.crm.users.list({ + const result = await panora.marketingautomation.templates.create({ xConnectionToken: "", + unifiedMarketingautomationTemplateInput: {}, }); // Handle the result @@ -1785,11 +1859,11 @@ actions: } run(); - - target: $["paths"]["/hris/groups/{id}"]["get"] + - target: $["paths"]["/ats/scorecards"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisGroup + label: listAtsScorecard source: |- import { Panora } from "@panora/sdk"; @@ -1798,10 +1872,11 @@ actions: }); async function run() { - const result = await panora.hris.groups.retrieve({ + const result = await panora.ats.scorecards.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1809,11 +1884,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/drives"]["get"] + - target: $["paths"]["/filestorage/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageDrives + label: listFilestorageGroup source: |- import { Panora } from "@panora/sdk"; @@ -1822,8 +1897,11 @@ actions: }); async function run() { - const result = await panora.filestorage.drives.list({ + const result = await panora.filestorage.groups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -1831,11 +1909,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders/{id}"]["get"] + - target: $["paths"]["/ats/offers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFolder + label: retrieveAtsOffer source: |- import { Panora } from "@panora/sdk"; @@ -1844,7 +1922,7 @@ actions: }); async function run() { - const result = await panora.filestorage.folders.retrieve({ + const result = await panora.ats.offers.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1855,11 +1933,11 @@ actions: } run(); - - target: $["paths"]["/hris/employees"]["get"] + - target: $["paths"]["/ats/rejectreasons/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployees + label: retrieveAtsRejectReason source: |- import { Panora } from "@panora/sdk"; @@ -1868,8 +1946,10 @@ actions: }); async function run() { - const result = await panora.hris.employees.list({ + const result = await panora.ats.rejectreasons.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1877,11 +1957,11 @@ actions: } run(); - - target: $["paths"]["/hris/employments/{id}"]["get"] + - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployment + label: retrieveAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; @@ -1890,7 +1970,7 @@ actions: }); async function run() { - const result = await panora.hris.employments.retrieve({ + const result = await panora.accounting.cashflowstatements.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1901,11 +1981,11 @@ actions: } run(); - - target: $["paths"]["/hris/payrollruns/{id}"]["get"] + - target: $["paths"]["/ticketing/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisPayrollRun + label: retrieveTicketingAccount source: |- import { Panora } from "@panora/sdk"; @@ -1914,10 +1994,9 @@ actions: }); async function run() { - const result = await panora.hris.payrollruns.retrieve({ + const result = await panora.ticketing.accounts.retrieve({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + id: "", }); // Handle the result @@ -1925,21 +2004,34 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["get"] + - target: $["paths"]["/ticketing/comments"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsInterview + label: createTicketingComment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.interviews.list({ + const result = await panora.ticketing.comments.create({ xConnectionToken: "", + unifiedTicketingCommentInput: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingCommentInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + }, }); // Handle the result @@ -1947,11 +2039,11 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices"]["post"] + - target: $["paths"]["/ats/candidates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingInvoice + label: retrieveAtsCandidate source: |- import { Panora } from "@panora/sdk"; @@ -1960,10 +2052,10 @@ actions: }); async function run() { - const result = await panora.accounting.invoices.create({ + const result = await panora.ats.candidates.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedAccountingInvoiceInput: {}, }); // Handle the result @@ -1971,11 +2063,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/contacts"]["get"] + - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingContacts + label: retrieveAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; @@ -1984,8 +2076,10 @@ actions: }); async function run() { - const result = await panora.ticketing.contacts.list({ + const result = await panora.accounting.creditnotes.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1993,11 +2087,11 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments"]["get"] + - target: $["paths"]["/ticketing/tickets/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAttachments + label: retrieveTicketingTicket source: |- import { Panora } from "@panora/sdk"; @@ -2006,8 +2100,10 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.list({ + const result = await panora.ticketing.tickets.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2015,11 +2111,11 @@ actions: } run(); - - target: $["paths"]["/crm/engagements"]["get"] + - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmEngagements + label: retrieveHrisTimeoffbalance source: |- import { Panora } from "@panora/sdk"; @@ -2028,8 +2124,10 @@ actions: }); async function run() { - const result = await panora.crm.engagements.list({ + const result = await panora.hris.timeoffbalances.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2037,11 +2135,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs/{id}"]["get"] + - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoff + label: retrieveMarketingautomationTemplate source: |- import { Panora } from "@panora/sdk"; @@ -2050,7 +2148,7 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.retrieve({ + const result = await panora.marketingautomation.templates.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2061,11 +2159,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages"]["get"] + - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationMessages + label: retrieveMarketingautomationMessage source: |- import { Panora } from "@panora/sdk"; @@ -2074,8 +2172,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.messages.list({ + const result = await panora.marketingautomation.messages.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2083,11 +2183,11 @@ actions: } run(); - - target: $["paths"]["/crm/contacts/{id}"]["get"] + - target: $["paths"]["/crm/tasks/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmContact + label: retrieveCrmTask source: |- import { Panora } from "@panora/sdk"; @@ -2096,7 +2196,7 @@ actions: }); async function run() { - const result = await panora.crm.contacts.retrieve({ + const result = await panora.crm.tasks.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2107,11 +2207,11 @@ actions: } run(); - - target: $["paths"]["/crm/deals"]["get"] + - target: $["paths"]["/projects"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmDeals + label: getProjects source: |- import { Panora } from "@panora/sdk"; @@ -2120,20 +2220,18 @@ actions: }); async function run() { - const result = await panora.crm.deals.list({ - xConnectionToken: "", - }); + const result = await panora.projects.getProjects(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/crm/stages"]["get"] + - target: $["paths"]["/hris/companies"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmStages + label: listHrisCompanies source: |- import { Panora } from "@panora/sdk"; @@ -2142,8 +2240,11 @@ actions: }); async function run() { - const result = await panora.crm.stages.list({ + const result = await panora.hris.companies.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2151,11 +2252,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] + - target: $["paths"]["/accounting/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAutomation + label: retrieveAccountingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -2164,7 +2265,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.retrieve({ + const result = await panora.accounting.attachments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2175,11 +2276,11 @@ actions: } run(); - - target: $["paths"]["/hris/benefits/{id}"]["get"] + - target: $["paths"]["/ticketing/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBenefit + label: retrieveTicketingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -2188,7 +2289,7 @@ actions: }); async function run() { - const result = await panora.hris.benefits.retrieve({ + const result = await panora.ticketing.attachments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2199,21 +2300,57 @@ actions: } run(); - - target: $["paths"]["/ats/eeocs"]["get"] + - target: $["paths"]["/crm/companies"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsEeocs + label: createCrmCompany source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.eeocs.list({ + const result = await panora.crm.companies.create({ xConnectionToken: "", + remoteData: false, + unifiedCrmCompanyInput: { + name: "Acme", + industry: UnifiedCrmCompanyInputIndustry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "", + city: "New York", + state: "NY", + postalCode: "46842", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2221,36 +2358,24 @@ actions: } run(); - - target: $["paths"]["/crm/tasks"]["post"] + - target: $["paths"]["/hris/employeepayrollruns"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmTask + label: listHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; - import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.crm.tasks.create({ + const result = await panora.hris.employeepayrollruns.list({ xConnectionToken: "", - unifiedCrmTaskInput: { - subject: "Answer customers", - content: "Prepare email campaign", - status: UnifiedCrmTaskInputStatus.Pending, - dueDate: "2024-10-01T12:00:00Z", - finishedDate: "2024-10-01T12:00:00Z", - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2258,11 +2383,11 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses"]["get"] + - target: $["paths"]["/accounting/payments"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingExpense + label: createAccountingPayment source: |- import { Panora } from "@panora/sdk"; @@ -2271,8 +2396,10 @@ actions: }); async function run() { - const result = await panora.accounting.expenses.list({ + const result = await panora.accounting.payments.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingPaymentInput: {}, }); // Handle the result @@ -2280,11 +2407,11 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards"]["get"] + - target: $["paths"]["/filestorage/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsScorecard + label: retrieveFilestorageGroup source: |- import { Panora } from "@panora/sdk"; @@ -2293,8 +2420,10 @@ actions: }); async function run() { - const result = await panora.ats.scorecards.list({ + const result = await panora.filestorage.groups.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2302,11 +2431,11 @@ actions: } run(); - - target: $["paths"]["/accounting/companyinfos"]["get"] + - target: $["paths"]["/marketingautomation/lists"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingCompanyInfos + label: createMarketingautomationList source: |- import { Panora } from "@panora/sdk"; @@ -2315,8 +2444,9 @@ actions: }); async function run() { - const result = await panora.accounting.companyinfos.list({ + const result = await panora.marketingautomation.lists.create({ xConnectionToken: "", + unifiedMarketingautomationListInput: {}, }); // Handle the result @@ -2324,11 +2454,11 @@ actions: } run(); - - target: $["paths"]["/crm/deals"]["post"] + - target: $["paths"]["/crm/notes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmDeal + label: retrieveCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -2337,20 +2467,10 @@ actions: }); async function run() { - const result = await panora.crm.deals.create({ + const result = await panora.crm.notes.retrieve({ xConnectionToken: "", - unifiedCrmDealInput: { - name: "Huge Contract with Acme", - description: "Contract with Sales Operations Team", - amount: 1000, - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - stageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2358,11 +2478,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances"]["get"] + - target: $["paths"]["/hris/locations"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffbalances + label: listHrisLocations source: |- import { Panora } from "@panora/sdk"; @@ -2371,8 +2491,11 @@ actions: }); async function run() { - const result = await panora.hris.timeoffbalances.list({ + const result = await panora.hris.locations.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2380,11 +2503,11 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["get"] + - target: $["paths"]["/hris/payrollruns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPurchaseOrder + label: retrieveHrisPayrollRun source: |- import { Panora } from "@panora/sdk"; @@ -2393,8 +2516,10 @@ actions: }); async function run() { - const result = await panora.accounting.purchaseorders.list({ + const result = await panora.hris.payrollruns.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2402,11 +2527,11 @@ actions: } run(); - - target: $["paths"]["/webhooks/{id}"]["delete"] + - target: $["paths"]["/accounting/phonenumbers"]["get"] update: x-codeSamples: - lang: typescript - label: delete + label: listAccountingPhonenumber source: |- import { Panora } from "@panora/sdk"; @@ -2415,8 +2540,11 @@ actions: }); async function run() { - const result = await panora.webhooks.delete({ - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.accounting.phonenumbers.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2424,11 +2552,11 @@ actions: } run(); - - target: $["paths"]["/ats/candidates/{id}"]["get"] + - target: $["paths"]["/filestorage/users"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsCandidate + label: listFilestorageUsers source: |- import { Panora } from "@panora/sdk"; @@ -2437,10 +2565,11 @@ actions: }); async function run() { - const result = await panora.ats.candidates.retrieve({ + const result = await panora.filestorage.users.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2448,11 +2577,11 @@ actions: } run(); - - target: $["paths"]["/ats/offices"]["get"] + - target: $["paths"]["/ats/jobs"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffice + label: listAtsJob source: |- import { Panora } from "@panora/sdk"; @@ -2461,8 +2590,11 @@ actions: }); async function run() { - const result = await panora.ats.offices.list({ + const result = await panora.ats.jobs.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2470,11 +2602,11 @@ actions: } run(); - - target: $["paths"]["/hris/bankinfos/{id}"]["get"] + - target: $["paths"]["/ticketing/comments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBankInfo + label: listTicketingComments source: |- import { Panora } from "@panora/sdk"; @@ -2483,10 +2615,11 @@ actions: }); async function run() { - const result = await panora.hris.bankinfos.retrieve({ + const result = await panora.ticketing.comments.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2494,11 +2627,11 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["post"] + - target: $["paths"]["/linked_users"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingJournalEntry + label: createLinkedUser source: |- import { Panora } from "@panora/sdk"; @@ -2507,10 +2640,33 @@ actions: }); async function run() { - const result = await panora.accounting.journalentries.create({ + const result = await panora.linkedUsers.create({ + linkedUserOriginId: "id_1", + alias: "acme", + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/accounting/purchaseorders"]["post"] + update: + x-codeSamples: + - lang: typescript + label: createAccountingPurchaseOrder + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.accounting.purchaseorders.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingJournalentryInput: {}, + unifiedAccountingPurchaseorderInput: {}, }); // Handle the result @@ -2518,11 +2674,11 @@ actions: } run(); - - target: $["paths"]["/accounting/payments"]["post"] + - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingPayment + label: retrieveAccountingTrackingCategory source: |- import { Panora } from "@panora/sdk"; @@ -2531,10 +2687,10 @@ actions: }); async function run() { - const result = await panora.accounting.payments.create({ + const result = await panora.accounting.trackingcategories.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedAccountingPaymentInput: {}, }); // Handle the result @@ -2542,23 +2698,67 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["post"] + - target: $["paths"]["/ats/candidates"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingPurchaseOrder + label: createAtsCandidate source: |- import { Panora } from "@panora/sdk"; + import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.purchaseorders.create({ + const result = await panora.ats.candidates.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingPurchaseorderInput: {}, + unifiedAtsCandidateInput: { + firstName: "Joe", + lastName: "Doe", + company: "Acme", + title: "Analyst", + locations: "New York", + isPrivate: false, + emailReachable: true, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + lastInteractionAt: new Date("2024-10-01T12:00:00Z"), + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + applications: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + tags: [ + "tag_1", + "tag_2", + ], + urls: [ + { + url: "mywebsite.com", + urlType: "WEBSITE", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660688899", + phoneType: PhoneType.Work, + }, + ], + emailAddresses: [ + { + emailAddress: "joedoe@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2566,11 +2766,11 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns"]["get"] + - target: $["paths"]["/accounting/expenses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployeePayrollRun + label: retrieveAccountingExpense source: |- import { Panora } from "@panora/sdk"; @@ -2579,8 +2779,10 @@ actions: }); async function run() { - const result = await panora.hris.employeepayrollruns.list({ + const result = await panora.accounting.expenses.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2588,11 +2790,11 @@ actions: } run(); - - target: $["paths"]["/hris/employments"]["get"] + - target: $["paths"]["/linked_users/batch"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisEmployments + label: importBatch source: |- import { Panora } from "@panora/sdk"; @@ -2601,8 +2803,11 @@ actions: }); async function run() { - const result = await panora.hris.employments.list({ - xConnectionToken: "", + const result = await panora.linkedUsers.importBatch({ + linkedUserOriginIds: [ + "id_1", + ], + alias: "acme", }); // Handle the result @@ -2610,11 +2815,11 @@ actions: } run(); - - target: $["paths"]["/ats/offers"]["get"] + - target: $["paths"]["/hris/benefits"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffer + label: listHrisBenefits source: |- import { Panora } from "@panora/sdk"; @@ -2623,8 +2828,11 @@ actions: }); async function run() { - const result = await panora.ats.offers.list({ + const result = await panora.hris.benefits.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2632,11 +2840,11 @@ actions: } run(); - - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] + - target: $["paths"]["/ats/activities/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingVendorCredit + label: retrieveAtsActivity source: |- import { Panora } from "@panora/sdk"; @@ -2645,7 +2853,7 @@ actions: }); async function run() { - const result = await panora.accounting.vendorcredits.retrieve({ + const result = await panora.ats.activities.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2656,34 +2864,24 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments"]["post"] + - target: $["paths"]["/accounting/payments"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingComment + label: listAccountingPayment source: |- import { Panora } from "@panora/sdk"; - import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ticketing.comments.create({ + const result = await panora.accounting.payments.list({ xConnectionToken: "", - unifiedTicketingCommentInput: { - body: "Assigned to Eric !", - htmlBody: "

Assigned to Eric !

", - isPrivate: false, - creatorType: UnifiedTicketingCommentInputCreatorType.User, - ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - attachments: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2691,11 +2889,11 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] + - target: $["paths"]["/ats/departments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingIncomeStatement + label: retrieveAtsDepartment source: |- import { Panora } from "@panora/sdk"; @@ -2704,7 +2902,7 @@ actions: }); async function run() { - const result = await panora.accounting.incomestatements.retrieve({ + const result = await panora.ats.departments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2715,11 +2913,11 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates/{id}"]["get"] + - target: $["paths"]["/crm/deals"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTaxRate + label: createCrmDeal source: |- import { Panora } from "@panora/sdk"; @@ -2728,10 +2926,20 @@ actions: }); async function run() { - const result = await panora.accounting.taxrates.retrieve({ + const result = await panora.crm.deals.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + unifiedCrmDealInput: { + name: "Huge Contract with Acme", + description: "Contract with Sales Operations Team", + amount: 1000, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + stageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2739,22 +2947,34 @@ actions: } run(); - - target: $["paths"]["/ticketing/accounts/{id}"]["get"] + - target: $["paths"]["/passthrough"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAccount + label: request source: |- import { Panora } from "@panora/sdk"; + import { PassThroughRequestDtoMethod } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ticketing.accounts.retrieve({ - xConnectionToken: "", - id: "", + const result = await panora.passthrough.request({ + integrationId: "", + linkedUserId: "", + vertical: "", + passThroughRequestDto: { + method: PassThroughRequestDtoMethod.Get, + path: "/dev", + data: { + "key": "", + }, + headers: { + "key": "", + }, + }, }); // Handle the result @@ -2762,11 +2982,11 @@ actions: } run(); - - target: $["paths"]["/ats/departments"]["get"] + - target: $["paths"]["/hris/timeoffs"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsDepartments + label: createHrisTimeoff source: |- import { Panora } from "@panora/sdk"; @@ -2775,8 +2995,9 @@ actions: }); async function run() { - const result = await panora.ats.departments.list({ + const result = await panora.hris.timeoffs.create({ xConnectionToken: "", + unifiedHrisTimeoffInput: {}, }); // Handle the result @@ -2784,11 +3005,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["post"] + - target: $["paths"]["/marketingautomation/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: createFilestorageFile + label: listMarketingAutomationContacts source: |- import { Panora } from "@panora/sdk"; @@ -2797,22 +3018,11 @@ actions: }); async function run() { - const result = await panora.filestorage.files.create({ + const result = await panora.marketingautomation.contacts.list({ xConnectionToken: "", - remoteData: false, - unifiedFilestorageFileInput: { - name: "my_paris_photo.png", - fileUrl: "https://example.com/my_paris_photo.png", - mimeType: "application/pdf", - size: "1024", - folderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2820,11 +3030,11 @@ actions: } run(); - - target: $["paths"]["/ats/jobs/{id}"]["get"] + - target: $["paths"]["/ats/tags/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJob + label: retrieveAtsTag source: |- import { Panora } from "@panora/sdk"; @@ -2833,7 +3043,7 @@ actions: }); async function run() { - const result = await panora.ats.jobs.retrieve({ + const result = await panora.ats.tags.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2844,11 +3054,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["post"] + - target: $["paths"]["/ticketing/users"]["get"] update: x-codeSamples: - lang: typescript - label: createFilestorageFolder + label: listTicketingUsers source: |- import { Panora } from "@panora/sdk"; @@ -2857,23 +3067,11 @@ actions: }); async function run() { - const result = await panora.filestorage.folders.create({ + const result = await panora.ticketing.users.list({ xConnectionToken: "", - remoteData: false, - unifiedFilestorageFolderInput: { - name: "school", - size: "2048", - folderUrl: "https://example.com/school", - description: "All things school related", - driveId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - parentFolderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -2881,11 +3079,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/users"]["get"] + - target: $["paths"]["/accounting/transactions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageUsers + label: retrieveAccountingTransaction source: |- import { Panora } from "@panora/sdk"; @@ -2894,8 +3092,10 @@ actions: }); async function run() { - const result = await panora.filestorage.users.list({ + const result = await panora.accounting.transactions.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2903,11 +3103,11 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] + - target: $["paths"]["/ticketing/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCreditNote + label: retrieveTicketingUser source: |- import { Panora } from "@panora/sdk"; @@ -2916,7 +3116,7 @@ actions: }); async function run() { - const result = await panora.accounting.creditnotes.retrieve({ + const result = await panora.ticketing.users.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2927,11 +3127,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/events/{id}"]["get"] + - target: $["paths"]["/hris/bankinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEvent + label: retrieveHrisBankInfo source: |- import { Panora } from "@panora/sdk"; @@ -2940,7 +3140,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.events.retrieve({ + const result = await panora.hris.bankinfos.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2951,67 +3151,24 @@ actions: } run(); - - target: $["paths"]["/ats/candidates"]["post"] + - target: $["paths"]["/hris/employments"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsCandidate + label: listHrisEmployments source: |- import { Panora } from "@panora/sdk"; - import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.candidates.create({ + const result = await panora.hris.employments.list({ xConnectionToken: "", - remoteData: false, - unifiedAtsCandidateInput: { - firstName: "Joe", - lastName: "Doe", - company: "Acme", - title: "Analyst", - locations: "New York", - isPrivate: false, - emailReachable: true, - remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), - remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), - lastInteractionAt: new Date("2024-10-01T12:00:00Z"), - attachments: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - applications: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - tags: [ - "tag_1", - "tag_2", - ], - urls: [ - { - url: "mywebsite.com", - urlType: "WEBSITE", - }, - ], - phoneNumbers: [ - { - phoneNumber: "+33660688899", - phoneType: PhoneType.Work, - }, - ], - emailAddresses: [ - { - emailAddress: "joedoe@gmail.com", - emailAddressType: EmailAddressType.Work, - }, - ], - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3019,11 +3176,11 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts"]["post"] + - target: $["paths"]["/ats/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingAccount + label: listAtsAttachment source: |- import { Panora } from "@panora/sdk"; @@ -3032,10 +3189,11 @@ actions: }); async function run() { - const result = await panora.accounting.accounts.create({ + const result = await panora.ats.attachments.list({ xConnectionToken: "", - remoteData: false, - unifiedAccountingAccountInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3043,11 +3201,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["get"] + - target: $["paths"]["/ticketing/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffs + label: retrieveTicketingContact source: |- import { Panora } from "@panora/sdk"; @@ -3056,8 +3214,9 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.list({ + const result = await panora.ticketing.contacts.retrieve({ xConnectionToken: "", + id: "", }); // Handle the result @@ -3065,11 +3224,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts"]["get"] + - target: $["paths"]["/linked_users/fromRemoteId"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationContacts + label: remoteId source: |- import { Panora } from "@panora/sdk"; @@ -3078,8 +3237,8 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.list({ - xConnectionToken: "", + const result = await panora.linkedUsers.remoteId({ + remoteId: "id_1", }); // Handle the result @@ -3087,11 +3246,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] + - target: $["paths"]["/hris/employees"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationCampaign + label: createHrisEmployee source: |- import { Panora } from "@panora/sdk"; @@ -3100,10 +3259,9 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.retrieve({ + const result = await panora.hris.employees.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + unifiedHrisEmployeeInput: {}, }); // Handle the result @@ -3111,11 +3269,11 @@ actions: } run(); - - target: $["paths"]["/ats/users"]["get"] + - target: $["paths"]["/marketingautomation/automations"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsUsers + label: listMarketingautomationAutomations source: |- import { Panora } from "@panora/sdk"; @@ -3124,8 +3282,11 @@ actions: }); async function run() { - const result = await panora.ats.users.list({ + const result = await panora.marketingautomation.automations.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3133,11 +3294,11 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["get"] + - target: $["paths"]["/hris/paygroups"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingJournalEntry + label: listHrisPaygroups source: |- import { Panora } from "@panora/sdk"; @@ -3146,8 +3307,11 @@ actions: }); async function run() { - const result = await panora.accounting.journalentries.list({ + const result = await panora.hris.paygroups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3155,11 +3319,11 @@ actions: } run(); - - target: $["paths"]["/accounting/companyinfos/{id}"]["get"] + - target: $["paths"]["/ats/candidates"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCompanyInfo + label: listAtsCandidate source: |- import { Panora } from "@panora/sdk"; @@ -3168,10 +3332,11 @@ actions: }); async function run() { - const result = await panora.accounting.companyinfos.retrieve({ + const result = await panora.ats.candidates.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3179,11 +3344,11 @@ actions: } run(); - - target: $["paths"]["/webhooks"]["post"] + - target: $["paths"]["/accounting/companyinfos"]["get"] update: x-codeSamples: - lang: typescript - label: createWebhookPublic + label: listAccountingCompanyInfos source: |- import { Panora } from "@panora/sdk"; @@ -3192,12 +3357,11 @@ actions: }); async function run() { - const result = await panora.webhooks.create({ - url: "https://acme.com/webhook_receiver", - description: "Webhook to receive connection events", - scope: [ - "connection.created", - ], + const result = await panora.accounting.companyinfos.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3205,11 +3369,11 @@ actions: } run(); - - target: $["paths"]["/hris/locations"]["get"] + - target: $["paths"]["/filestorage/drives"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisLocations + label: listFilestorageDrives source: |- import { Panora } from "@panora/sdk"; @@ -3218,8 +3382,11 @@ actions: }); async function run() { - const result = await panora.hris.locations.list({ + const result = await panora.filestorage.drives.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3227,11 +3394,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["get"] + - target: $["paths"]["/ticketing/collections"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAutomations + label: listTicketingCollections source: |- import { Panora } from "@panora/sdk"; @@ -3240,8 +3407,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.list({ + const result = await panora.ticketing.collections.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3249,11 +3419,11 @@ actions: } run(); - - target: $["paths"]["/ats/tags/{id}"]["get"] + - target: $["paths"]["/hris/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsTag + label: retrieveHrisGroup source: |- import { Panora } from "@panora/sdk"; @@ -3262,7 +3432,7 @@ actions: }); async function run() { - const result = await panora.ats.tags.retrieve({ + const result = await panora.hris.groups.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3273,11 +3443,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["get"] + - target: $["paths"]["/marketingautomation/emails"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFolder + label: listMarketingautomationEmails source: |- import { Panora } from "@panora/sdk"; @@ -3286,8 +3456,11 @@ actions: }); async function run() { - const result = await panora.filestorage.folders.list({ + const result = await panora.marketingautomation.emails.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3295,11 +3468,11 @@ actions: } run(); - - target: $["paths"]["/crm/notes"]["get"] + - target: $["paths"]["/marketingautomation/lists"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmNote + label: listMarketingautomationLists source: |- import { Panora } from "@panora/sdk"; @@ -3308,8 +3481,11 @@ actions: }); async function run() { - const result = await panora.crm.notes.list({ + const result = await panora.marketingautomation.lists.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3317,11 +3493,11 @@ actions: } run(); - - target: $["paths"]["/crm/tasks"]["get"] + - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmTask + label: retrieveAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; @@ -3330,8 +3506,10 @@ actions: }); async function run() { - const result = await panora.crm.tasks.list({ + const result = await panora.accounting.vendorcredits.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3339,11 +3517,11 @@ actions: } run(); - - target: $["paths"]["/crm/tasks/{id}"]["get"] + - target: $["paths"]["/hris/payrollruns"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmTask + label: listHrisPayrollRuns source: |- import { Panora } from "@panora/sdk"; @@ -3352,10 +3530,11 @@ actions: }); async function run() { - const result = await panora.crm.tasks.retrieve({ + const result = await panora.hris.payrollruns.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3363,11 +3542,11 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts/{id}"]["get"] + - target: $["paths"]["/ats/activities"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingContact + label: listAtsActivity source: |- import { Panora } from "@panora/sdk"; @@ -3376,10 +3555,11 @@ actions: }); async function run() { - const result = await panora.accounting.contacts.retrieve({ + const result = await panora.ats.activities.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3387,11 +3567,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/users/{id}"]["get"] + - target: $["paths"]["/hris/locations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingUser + label: retrieveHrisLocation source: |- import { Panora } from "@panora/sdk"; @@ -3400,7 +3580,7 @@ actions: }); async function run() { - const result = await panora.ticketing.users.retrieve({ + const result = await panora.hris.locations.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3411,17 +3591,11 @@ actions: } run(); - - target: $["paths"]["/sync/status/{vertical}"]["get"] + - target: $["paths"]["/accounting/journalentries"]["get"] update: x-codeSamples: - lang: typescript - label: status - source: "import { Panora } from \"@panora/sdk\";\nimport { Vertical } from \"@panora/sdk/models/operations\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.sync.status({\n vertical: Vertical.Ticketing,\n });\n\n \n}\n\nrun();" - - target: $["paths"]["/sync/resync"]["post"] - update: - x-codeSamples: - - lang: typescript - label: resync + label: listAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; @@ -3430,18 +3604,23 @@ actions: }); async function run() { - const result = await panora.sync.resync(); + const result = await panora.accounting.journalentries.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/accounting/vendorcredits"]["get"] + - target: $["paths"]["/events"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingVendorCredit + label: getPanoraCoreEvents source: |- import { Panora } from "@panora/sdk"; @@ -3450,20 +3629,18 @@ actions: }); async function run() { - const result = await panora.accounting.vendorcredits.list({ - xConnectionToken: "", - }); + const result = await panora.events.getPanoraCoreEvents({}); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ats/activities/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsActivity + label: listMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -3472,10 +3649,11 @@ actions: }); async function run() { - const result = await panora.ats.activities.retrieve({ + const result = await panora.marketingautomation.actions.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3483,11 +3661,11 @@ actions: } run(); - - target: $["paths"]["/ats/departments/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAtsDepartment + label: createMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -3496,10 +3674,10 @@ actions: }); async function run() { - const result = await panora.ats.departments.retrieve({ + const result = await panora.marketingautomation.actions.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedMarketingautomationActionInput: {}, }); // Handle the result @@ -3507,11 +3685,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/users"]["get"] + - target: $["paths"]["/hris/employees"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingUsers + label: listHrisEmployees source: |- import { Panora } from "@panora/sdk"; @@ -3520,8 +3698,11 @@ actions: }); async function run() { - const result = await panora.ticketing.users.list({ + const result = await panora.hris.employees.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3529,56 +3710,24 @@ actions: } run(); - - target: $["paths"]["/crm/contacts"]["post"] + - target: $["paths"]["/ats/interviews"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmContact + label: listAtsInterview source: |- import { Panora } from "@panora/sdk"; - import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.crm.contacts.create({ + const result = await panora.ats.interviews.list({ xConnectionToken: "", - remoteData: false, - unifiedCrmContactInput: { - firstName: "John", - lastName: "Doe", - emailAddresses: [ - { - emailAddress: "Jena.Nienow28@yahoo.com", - emailAddressType: EmailAddressType.Personal, - }, - ], - phoneNumbers: [ - { - phoneNumber: "", - phoneType: PhoneType.Work, - }, - ], - addresses: [ - { - street1: "", - street2: "", - city: "Anytown", - state: "CA", - postalCode: "97398", - country: "USA", - addressType: AddressType.Personal, - ownerType: "", - }, - ], - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3586,11 +3735,11 @@ actions: } run(); - - target: $["paths"]["/crm/companies/{id}"]["get"] + - target: $["paths"]["/accounting/taxrates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmCompany + label: retrieveAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; @@ -3599,7 +3748,7 @@ actions: }); async function run() { - const result = await panora.crm.companies.retrieve({ + const result = await panora.accounting.taxrates.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3610,11 +3759,11 @@ actions: } run(); - - target: $["paths"]["/hris/dependents/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisDependent + label: retrieveMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -3623,7 +3772,7 @@ actions: }); async function run() { - const result = await panora.hris.dependents.retrieve({ + const result = await panora.marketingautomation.actions.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3634,11 +3783,11 @@ actions: } run(); - - target: $["paths"]["/ats/tags"]["get"] + - target: $["paths"]["/marketingautomation/campaigns"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsTags + label: listMarketingautomationCampaigns source: |- import { Panora } from "@panora/sdk"; @@ -3647,8 +3796,11 @@ actions: }); async function run() { - const result = await panora.ats.tags.list({ + const result = await panora.marketingautomation.campaigns.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3656,11 +3808,11 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["get"] + - target: $["paths"]["/marketingautomation/events"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsAttachment + label: listMarketingAutomationEvents source: |- import { Panora } from "@panora/sdk"; @@ -3669,8 +3821,11 @@ actions: }); async function run() { - const result = await panora.ats.attachments.list({ + const result = await panora.marketingautomation.events.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3678,11 +3833,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments"]["post"] + - target: $["paths"]["/ats/eeocs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingAttachment + label: retrieveAtsEeocs source: |- import { Panora } from "@panora/sdk"; @@ -3691,19 +3846,9 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.create({ + const result = await panora.ats.eeocs.retrieve({ xConnectionToken: "", - unifiedTicketingAttachmentInput: { - fileName: "features_planning.pdf", - fileUrl: "https://example.com/features_planning.pdf", - uploader: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - commentId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + id: "", }); // Handle the result @@ -3711,11 +3856,11 @@ actions: } run(); - - target: $["paths"]["/crm/contacts"]["get"] + - target: $["paths"]["/accounting/creditnotes"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmContacts + label: listAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; @@ -3724,8 +3869,11 @@ actions: }); async function run() { - const result = await panora.crm.contacts.list({ + const result = await panora.accounting.creditnotes.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3733,11 +3881,11 @@ actions: } run(); - - target: $["paths"]["/hris/payrollruns"]["get"] + - target: $["paths"]["/crm/engagements"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisPayrollRuns + label: listCrmEngagements source: |- import { Panora } from "@panora/sdk"; @@ -3746,8 +3894,11 @@ actions: }); async function run() { - const result = await panora.hris.payrollruns.list({ + const result = await panora.crm.engagements.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3755,11 +3906,11 @@ actions: } run(); - - target: $["paths"]["/linked_users/batch"]["post"] + - target: $["paths"]["/accounting/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: importBatch + label: retrieveAccountingAccount source: |- import { Panora } from "@panora/sdk"; @@ -3768,11 +3919,10 @@ actions: }); async function run() { - const result = await panora.linkedUsers.batch.importBatch({ - linkedUserOriginIds: [ - "id_1", - ], - alias: "acme", + const result = await panora.accounting.accounts.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3780,11 +3930,11 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] + - target: $["paths"]["/linked_users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployerBenefit + label: retrieveLinkedUser source: |- import { Panora } from "@panora/sdk"; @@ -3793,10 +3943,8 @@ actions: }); async function run() { - const result = await panora.hris.employerbenefits.retrieve({ - xConnectionToken: "", + const result = await panora.linkedUsers.retrieve({ id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, }); // Handle the result @@ -3804,21 +3952,28 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates"]["get"] + - target: $["paths"]["/field_mappings"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationTemplates + label: defineCustomField source: |- import { Panora } from "@panora/sdk"; + import { CustomFieldCreateDtoDataType, CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.marketingautomation.templates.list({ - xConnectionToken: "", + const result = await panora.fieldMappings.defineCustomField({ + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, + name: "my_favorite_dish", + description: "Favorite Dish", + dataType: CustomFieldCreateDtoDataType.String, + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -3826,11 +3981,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets"]["get"] + - target: $["paths"]["/hris/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTicket + label: retrieveHrisCompany source: |- import { Panora } from "@panora/sdk"; @@ -3839,8 +3994,10 @@ actions: }); async function run() { - const result = await panora.ticketing.tickets.list({ + const result = await panora.hris.companies.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3848,62 +4005,30 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets"]["post"] + - target: $["paths"]["/ats/activities"]["post"] update: x-codeSamples: - lang: typescript - label: createTicketingTicket + label: createAtsActivity source: |- import { Panora } from "@panora/sdk"; - import { - UnifiedTicketingTicketInputCreatorType, - UnifiedTicketingTicketInputPriority, - UnifiedTicketingTicketInputStatus, - UnifiedTicketingTicketInputType, - } from "@panora/sdk/models/components"; + import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ticketing.tickets.create({ + const result = await panora.ats.activities.create({ xConnectionToken: "", remoteData: false, - unifiedTicketingTicketInput: { - name: "Customer Service Inquiry", - status: UnifiedTicketingTicketInputStatus.Open, - description: "Help customer", - dueDate: new Date("2024-10-01T12:00:00Z"), - type: UnifiedTicketingTicketInputType.Bug, - parentTicket: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - collections: "[\"801f9ede-c698-4e66-a7fc-48d19eebaa4f\"]", - tags: [ - "my_tag", - "urgent_tag", - ], - completedAt: new Date("2024-10-01T12:00:00Z"), - priority: UnifiedTicketingTicketInputPriority.High, - assignedTo: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - comment: { - body: "Assigned to Eric !", - htmlBody: "

Assigned to Eric !

", - isPrivate: false, - creatorType: UnifiedTicketingTicketInputCreatorType.User, - ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - attachments: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - }, - accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - attachments: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], + unifiedAtsActivityInput: { + activityType: UnifiedAtsActivityInputActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: UnifiedAtsActivityInputVisibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), fieldMappings: { "fav_dish": "broccoli", "fav_color": "red", @@ -3916,11 +4041,11 @@ actions: } run(); - - target: $["paths"]["/crm/users/{id}"]["get"] + - target: $["paths"]["/projects"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmUser + label: createProject source: |- import { Panora } from "@panora/sdk"; @@ -3929,10 +4054,10 @@ actions: }); async function run() { - const result = await panora.crm.users.retrieve({ - xConnectionToken: "", - id: "b008e199-eda9-4629-bd41-a01b6195864a", - remoteData: true, + const result = await panora.projects.create({ + name: "Project Name", + idOrganization: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + idUser: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -3940,11 +4065,11 @@ actions: } run(); - - target: $["paths"]["/hris/employees/{id}"]["get"] + - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployee + label: retrieveHrisEmployerBenefit source: |- import { Panora } from "@panora/sdk"; @@ -3953,7 +4078,7 @@ actions: }); async function run() { - const result = await panora.hris.employees.retrieve({ + const result = await panora.hris.employerbenefits.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3964,11 +4089,11 @@ actions: } run(); - - target: $["paths"]["/hris/locations/{id}"]["get"] + - target: $["paths"]["/accounting/transactions"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisLocation + label: listAccountingTransaction source: |- import { Panora } from "@panora/sdk"; @@ -3977,10 +4102,11 @@ actions: }); async function run() { - const result = await panora.hris.locations.retrieve({ + const result = await panora.accounting.transactions.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -3988,11 +4114,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] + - target: $["paths"]["/filestorage/files"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationList + label: createFilestorageFile source: |- import { Panora } from "@panora/sdk"; @@ -4001,10 +4127,22 @@ actions: }); async function run() { - const result = await panora.marketingautomation.lists.retrieve({ + const result = await panora.filestorage.files.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedFilestorageFileInput: { + name: "my_paris_photo.png", + fileUrl: "https://example.com/my_paris_photo.png", + mimeType: "application/pdf", + size: "1024", + folderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4012,11 +4150,11 @@ actions: } run(); - - target: $["paths"]["/ats/offices/{id}"]["get"] + - target: $["paths"]["/accounting/accounts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffice + label: createAccountingAccount source: |- import { Panora } from "@panora/sdk"; @@ -4025,10 +4163,10 @@ actions: }); async function run() { - const result = await panora.ats.offices.retrieve({ + const result = await panora.accounting.accounts.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingAccountInput: {}, }); // Handle the result @@ -4036,33 +4174,11 @@ actions: } run(); - - target: $["paths"]["/accounting/phonenumbers"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listAccountingPhonenumber - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.accounting.phonenumbers.list({ - xConnectionToken: "", - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] + - target: $["paths"]["/marketingautomation/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAction + label: createMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; @@ -4071,10 +4187,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.actions.retrieve({ + const result = await panora.marketingautomation.contacts.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedMarketingautomationContactInput: {}, }); // Handle the result @@ -4082,11 +4198,11 @@ actions: } run(); - - target: $["paths"]["/linked_users"]["post"] + - target: $["paths"]["/accounting/expenses"]["get"] update: x-codeSamples: - lang: typescript - label: createLinkedUser + label: listAccountingExpense source: |- import { Panora } from "@panora/sdk"; @@ -4095,9 +4211,11 @@ actions: }); async function run() { - const result = await panora.linkedUsers.create({ - linkedUserOriginId: "id_1", - alias: "acme", + const result = await panora.accounting.expenses.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4105,11 +4223,11 @@ actions: } run(); - - target: $["paths"]["/ats/applications"]["post"] + - target: $["paths"]["/ticketing/teams"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsApplication + label: listTicketingTeams source: |- import { Panora } from "@panora/sdk"; @@ -4118,27 +4236,11 @@ actions: }); async function run() { - const result = await panora.ats.applications.create({ + const result = await panora.ticketing.teams.list({ xConnectionToken: "", - remoteData: false, - unifiedAtsApplicationInput: { - appliedAt: new Date("2024-10-01T12:00:00Z"), - rejectedAt: new Date("2024-10-01T12:00:00Z"), - offers: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - "12345678-1234-1234-1234-123456789012", - ], - source: "Source Name", - creditedTo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - currentStage: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - rejectReason: "Candidate not experienced enough", - candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4146,11 +4248,11 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments/{id}"]["get"] + - target: $["paths"]["/sync/resync"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAttachment + label: resync source: |- import { Panora } from "@panora/sdk"; @@ -4159,22 +4261,18 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); + const result = await panora.sync.resync(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/accounting/contacts"]["post"] + - target: $["paths"]["/hris/dependents"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingContact + label: listHrisDependents source: |- import { Panora } from "@panora/sdk"; @@ -4183,10 +4281,11 @@ actions: }); async function run() { - const result = await panora.accounting.contacts.create({ + const result = await panora.hris.dependents.list({ xConnectionToken: "", - remoteData: false, - unifiedAccountingContactInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4194,11 +4293,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions"]["post"] + - target: $["paths"]["/ats/rejectreasons"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAction + label: listAtsRejectReasons source: |- import { Panora } from "@panora/sdk"; @@ -4207,10 +4306,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.actions.create({ - xConnectionToken: "", - remoteData: false, - unifiedMarketingautomationActionInput: {}, + const result = await panora.ats.rejectreasons.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4218,11 +4318,11 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices"]["get"] + - target: $["paths"]["/accounting/companyinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingInvoice + label: retrieveAccountingCompanyInfo source: |- import { Panora } from "@panora/sdk"; @@ -4231,8 +4331,10 @@ actions: }); async function run() { - const result = await panora.accounting.invoices.list({ + const result = await panora.accounting.companyinfos.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4240,11 +4342,11 @@ actions: } run(); - - target: $["paths"]["/accounting/items/{id}"]["get"] + - target: $["paths"]["/ticketing/comments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingItem + label: retrieveTicketingComment source: |- import { Panora } from "@panora/sdk"; @@ -4253,10 +4355,9 @@ actions: }); async function run() { - const result = await panora.accounting.items.retrieve({ + const result = await panora.ticketing.comments.retrieve({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + id: "", }); // Handle the result @@ -4264,11 +4365,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/accounts"]["get"] + - target: $["paths"]["/hris/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingAccount + label: listHrisGroups source: |- import { Panora } from "@panora/sdk"; @@ -4277,8 +4378,11 @@ actions: }); async function run() { - const result = await panora.ticketing.accounts.list({ + const result = await panora.hris.groups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4286,11 +4390,11 @@ actions: } run(); - - target: $["paths"]["/events"]["get"] + - target: $["paths"]["/hris/timeoffs"]["get"] update: x-codeSamples: - lang: typescript - label: getPanoraCoreEvents + label: listHrisTimeoffs source: |- import { Panora } from "@panora/sdk"; @@ -4299,18 +4403,23 @@ actions: }); async function run() { - const result = await panora.events.getPanoraCoreEvents({}); + const result = await panora.hris.timeoffs.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/accounting/addresses"]["get"] + - target: $["paths"]["/marketingautomation/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAddress + label: retrieveMarketingAutomationUser source: |- import { Panora } from "@panora/sdk"; @@ -4319,8 +4428,10 @@ actions: }); async function run() { - const result = await panora.accounting.addresses.list({ + const result = await panora.marketingautomation.users.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4328,11 +4439,11 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] + - target: $["paths"]["/accounting/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCashflowStatement + label: createAccountingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -4341,10 +4452,10 @@ actions: }); async function run() { - const result = await panora.accounting.cashflowstatements.retrieve({ + const result = await panora.accounting.attachments.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingAttachmentInput: {}, }); // Handle the result @@ -4352,11 +4463,11 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions"]["get"] + - target: $["paths"]["/crm/notes"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingTransaction + label: createCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -4365,8 +4476,20 @@ actions: }); async function run() { - const result = await panora.accounting.transactions.list({ + const result = await panora.crm.notes.create({ xConnectionToken: "", + remoteData: false, + unifiedCrmNoteInput: { + content: "My notes taken during the meeting", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4374,11 +4497,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["get"] + - target: $["paths"]["/hris/employerbenefits"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFile + label: listHrisEmployerBenefits source: |- import { Panora } from "@panora/sdk"; @@ -4387,8 +4510,11 @@ actions: }); async function run() { - const result = await panora.filestorage.files.list({ + const result = await panora.hris.employerbenefits.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4396,11 +4522,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["post"] + - target: $["paths"]["/ats/tags"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationList + label: listAtsTags source: |- import { Panora } from "@panora/sdk"; @@ -4409,9 +4535,11 @@ actions: }); async function run() { - const result = await panora.marketingautomation.lists.create({ + const result = await panora.ats.tags.list({ xConnectionToken: "", - unifiedMarketingautomationListInput: {}, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4419,21 +4547,25 @@ actions: } run(); - - target: $["paths"]["/ats/candidates"]["get"] + - target: $["paths"]["/field_mappings/define"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsCandidate + label: definitions source: |- import { Panora } from "@panora/sdk"; + import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ats.candidates.list({ - xConnectionToken: "", + const result = await panora.fieldMappings.definitions({ + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, }); // Handle the result @@ -4441,11 +4573,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/groups/{id}"]["get"] + - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageGroup + label: retrieveHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; @@ -4454,7 +4586,7 @@ actions: }); async function run() { - const result = await panora.filestorage.groups.retrieve({ + const result = await panora.hris.employeepayrollruns.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4465,11 +4597,11 @@ actions: } run(); - - target: $["paths"]["/hris/companies/{id}"]["get"] + - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisCompany + label: retrieveMarketingautomationEmail source: |- import { Panora } from "@panora/sdk"; @@ -4478,7 +4610,7 @@ actions: }); async function run() { - const result = await panora.hris.companies.retrieve({ + const result = await panora.marketingautomation.emails.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4489,11 +4621,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns"]["get"] + - target: $["paths"]["/ats/applications"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationCampaigns + label: createAtsApplication source: |- import { Panora } from "@panora/sdk"; @@ -4502,8 +4634,27 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.list({ + const result = await panora.ats.applications.create({ xConnectionToken: "", + remoteData: false, + unifiedAtsApplicationInput: { + appliedAt: new Date("2024-10-01T12:00:00Z"), + rejectedAt: new Date("2024-10-01T12:00:00Z"), + offers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "12345678-1234-1234-1234-123456789012", + ], + source: "Source Name", + creditedTo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currentStage: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + rejectReason: "Candidate not experienced enough", + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4511,11 +4662,11 @@ actions: } run(); - - target: $["paths"]["/accounting/balancesheets"]["get"] + - target: $["paths"]["/crm/notes"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingBalanceSheets + label: listCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -4524,8 +4675,11 @@ actions: }); async function run() { - const result = await panora.accounting.balancesheets.list({ + const result = await panora.crm.notes.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4533,11 +4687,11 @@ actions: } run(); - - target: $["paths"]["/projects"]["get"] + - target: $["paths"]["/hris/bankinfos"]["get"] update: x-codeSamples: - lang: typescript - label: getProjects + label: listHrisBankInfo source: |- import { Panora } from "@panora/sdk"; @@ -4546,18 +4700,23 @@ actions: }); async function run() { - const result = await panora.projects.getProjects(); + const result = await panora.hris.bankinfos.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/field_mappings/map"]["post"] + - target: $["paths"]["/ticketing/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: map + label: createTicketingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -4566,11 +4725,19 @@ actions: }); async function run() { - const result = await panora.fieldMappings.map.map({ - attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - sourceCustomFieldId: "id_1", - sourceProvider: "hubspot", - linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.ticketing.attachments.create({ + xConnectionToken: "", + unifiedTicketingAttachmentInput: { + fileName: "features_planning.pdf", + fileUrl: "https://example.com/features_planning.pdf", + uploader: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + commentId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4578,11 +4745,11 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards/{id}"]["get"] + - target: $["paths"]["/crm/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsScorecard + label: listCrmContacts source: |- import { Panora } from "@panora/sdk"; @@ -4591,10 +4758,11 @@ actions: }); async function run() { - const result = await panora.ats.scorecards.retrieve({ + const result = await panora.crm.contacts.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4602,28 +4770,40 @@ actions: } run(); - - target: $["paths"]["/field_mappings"]["post"] + - target: $["paths"]["/crm/engagements"]["post"] update: x-codeSamples: - lang: typescript - label: defineCustomField + label: createCrmEngagement source: |- import { Panora } from "@panora/sdk"; - import { CustomFieldCreateDtoDataType, CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; + import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.fieldMappings.defineCustomField({ - objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, - name: "my_favorite_dish", - description: "Favorite Dish", - dataType: CustomFieldCreateDtoDataType.String, - sourceCustomFieldId: "id_1", - sourceProvider: "hubspot", - linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.crm.engagements.create({ + xConnectionToken: "", + remoteData: false, + unifiedCrmEngagementInput: { + content: "Meeting call with CTO", + direction: UnifiedCrmEngagementInputDirection.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementInputType.Meeting, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contacts: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4631,11 +4811,11 @@ actions: } run(); - - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] + - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPhonenumber + label: retrieveMarketingautomationList source: |- import { Panora } from "@panora/sdk"; @@ -4644,7 +4824,7 @@ actions: }); async function run() { - const result = await panora.accounting.phonenumbers.retrieve({ + const result = await panora.marketingautomation.lists.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4655,11 +4835,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/users/{id}"]["get"] + - target: $["paths"]["/ats/offices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageUser + label: retrieveAtsOffice source: |- import { Panora } from "@panora/sdk"; @@ -4668,7 +4848,7 @@ actions: }); async function run() { - const result = await panora.filestorage.users.retrieve({ + const result = await panora.ats.offices.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4679,11 +4859,11 @@ actions: } run(); - - target: $["paths"]["/webhooks"]["get"] + - target: $["paths"]["/webhooks/verifyEvent"]["post"] update: x-codeSamples: - lang: typescript - label: listWebhooks + label: verifyEvent source: |- import { Panora } from "@panora/sdk"; @@ -4692,18 +4872,24 @@ actions: }); async function run() { - const result = await panora.webhooks.list(); + const result = await panora.webhooks.verifyEvent({ + payload: { + "key": "", + }, + signature: "", + secret: "", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/contacts/{id}"]["get"] + - target: $["paths"]["/marketingautomation/campaigns"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingContact + label: createMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; @@ -4712,9 +4898,10 @@ actions: }); async function run() { - const result = await panora.ticketing.contacts.retrieve({ + const result = await panora.marketingautomation.campaigns.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedMarketingautomationCampaignInput: {}, }); // Handle the result @@ -4722,11 +4909,11 @@ actions: } run(); - - target: $["paths"]["/crm/companies"]["get"] + - target: $["paths"]["/ats/applications"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmCompany + label: listAtsApplication source: |- import { Panora } from "@panora/sdk"; @@ -4735,8 +4922,11 @@ actions: }); async function run() { - const result = await panora.crm.companies.list({ + const result = await panora.ats.applications.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4744,11 +4934,11 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] + - target: $["paths"]["/accounting/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployeePayrollRun + label: listAccountingContacts source: |- import { Panora } from "@panora/sdk"; @@ -4757,10 +4947,11 @@ actions: }); async function run() { - const result = await panora.hris.employeepayrollruns.retrieve({ + const result = await panora.accounting.contacts.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4768,11 +4959,11 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits"]["get"] + - target: $["paths"]["/accounting/journalentries/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployerBenefits + label: retrieveAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; @@ -4781,8 +4972,10 @@ actions: }); async function run() { - const result = await panora.hris.employerbenefits.list({ + const result = await panora.accounting.journalentries.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4790,21 +4983,56 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/emails"]["get"] + - target: $["paths"]["/crm/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationEmails + label: createCrmContact source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.marketingautomation.emails.list({ + const result = await panora.crm.contacts.create({ xConnectionToken: "", + remoteData: false, + unifiedCrmContactInput: { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Jena.Nienow28@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "", + street2: "", + city: "Anytown", + state: "CA", + postalCode: "97398", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4812,11 +5040,11 @@ actions: } run(); - - target: $["paths"]["/ats/applications"]["get"] + - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsApplication + label: retrieveMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; @@ -4825,8 +5053,10 @@ actions: }); async function run() { - const result = await panora.ats.applications.list({ + const result = await panora.marketingautomation.automations.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4858,11 +5088,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments"]["get"] + - target: $["paths"]["/ats/departments"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingComments + label: listAtsDepartments source: |- import { Panora } from "@panora/sdk"; @@ -4871,8 +5101,11 @@ actions: }); async function run() { - const result = await panora.ticketing.comments.list({ + const result = await panora.ats.departments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -4880,11 +5113,11 @@ actions: } run(); - - target: $["paths"]["/crm/notes"]["post"] + - target: $["paths"]["/accounting/addresses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmNote + label: retrieveAccountingAddress source: |- import { Panora } from "@panora/sdk"; @@ -4893,20 +5126,10 @@ actions: }); async function run() { - const result = await panora.crm.notes.create({ + const result = await panora.accounting.addresses.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedCrmNoteInput: { - content: "My notes taken during the meeting", - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, }); // Handle the result @@ -4914,11 +5137,11 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories"]["get"] + - target: $["paths"]["/accounting/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingTrackingCategorys + label: createAccountingContact source: |- import { Panora } from "@panora/sdk"; @@ -4927,8 +5150,10 @@ actions: }); async function run() { - const result = await panora.accounting.trackingcategories.list({ + const result = await panora.accounting.contacts.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingContactInput: {}, }); // Handle the result @@ -4936,11 +5161,11 @@ actions: } run(); - - target: $["paths"]["/ats/interviews/{id}"]["get"] + - target: $["paths"]["/accounting/invoices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsInterview + label: retrieveAccountingInvoice source: |- import { Panora } from "@panora/sdk"; @@ -4949,7 +5174,7 @@ actions: }); async function run() { - const result = await panora.ats.interviews.retrieve({ + const result = await panora.accounting.invoices.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4960,11 +5185,11 @@ actions: } run(); - - target: $["paths"]["/ats/users/{id}"]["get"] + - target: $["paths"]["/crm/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsUser + label: retrieveCrmCompany source: |- import { Panora } from "@panora/sdk"; @@ -4973,7 +5198,7 @@ actions: }); async function run() { - const result = await panora.ats.users.retrieve({ + const result = await panora.crm.companies.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4984,11 +5209,11 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts"]["get"] + - target: $["paths"]["/linked_users"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingContacts + label: listLinkedUsers source: |- import { Panora } from "@panora/sdk"; @@ -4997,20 +5222,18 @@ actions: }); async function run() { - const result = await panora.accounting.contacts.list({ - xConnectionToken: "", - }); + const result = await panora.linkedUsers.list(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/health"]["get"] + - target: $["paths"]["/hris/paygroups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: health + label: retrieveHrisPaygroup source: |- import { Panora } from "@panora/sdk"; @@ -5019,18 +5242,22 @@ actions: }); async function run() { - const result = await panora.health(); + const result = await panora.hris.paygroups.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/filestorage/files/{id}"]["get"] + - target: $["paths"]["/accounting/invoices"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFile + label: listAccountingInvoice source: |- import { Panora } from "@panora/sdk"; @@ -5039,10 +5266,11 @@ actions: }); async function run() { - const result = await panora.filestorage.files.retrieve({ + const result = await panora.accounting.invoices.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -5050,23 +5278,42 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] + - target: $["paths"]["/auth/login"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoffbalance + label: signIn + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.auth.login.signIn({\n idUser: \"\",\n email: \"Oda.Treutel97@hotmail.com\",\n passwordHash: \"\",\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/crm/tasks"]["post"] + update: + x-codeSamples: + - lang: typescript + label: createCrmTask source: |- import { Panora } from "@panora/sdk"; + import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.hris.timeoffbalances.retrieve({ + const result = await panora.crm.tasks.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + unifiedCrmTaskInput: { + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskInputStatus.Pending, + dueDate: "2024-10-01T12:00:00Z", + finishedDate: "2024-10-01T12:00:00Z", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -5074,11 +5321,11 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses/{id}"]["get"] + - target: $["paths"]["/accounting/invoices"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingExpense + label: createAccountingInvoice source: |- import { Panora } from "@panora/sdk"; @@ -5087,10 +5334,10 @@ actions: }); async function run() { - const result = await panora.accounting.expenses.retrieve({ + const result = await panora.accounting.invoices.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingInvoiceInput: {}, }); // Handle the result @@ -5098,11 +5345,11 @@ actions: } run(); - - target: $["paths"]["/accounting/items"]["get"] + - target: $["paths"]["/webhooks/{id}"]["delete"] update: x-codeSamples: - lang: typescript - label: listAccountingItem + label: delete source: |- import { Panora } from "@panora/sdk"; @@ -5111,8 +5358,8 @@ actions: }); async function run() { - const result = await panora.accounting.items.list({ - xConnectionToken: "", + const result = await panora.webhooks.delete({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -5120,11 +5367,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] + - target: $["paths"]["/ticketing/tickets"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationTemplate + label: listTicketingTicket source: |- import { Panora } from "@panora/sdk"; @@ -5133,22 +5380,24 @@ actions: }); async function run() { - const result = await panora.marketingautomation.templates.retrieve({ + const result = await panora.ticketing.tickets.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); - // Handle the result - console.log(result) + for await (const page of result) { + // handle page + } } run(); - - target: $["paths"]["/accounting/addresses/{id}"]["get"] + - target: $["paths"]["/field_mappings/map"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAddress + label: map source: |- import { Panora } from "@panora/sdk"; @@ -5157,10 +5406,11 @@ actions: }); async function run() { - const result = await panora.accounting.addresses.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + const result = await panora.fieldMappings.map({ + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -5168,11 +5418,11 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries/{id}"]["get"] + - target: $["paths"]["/accounting/taxrates"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingJournalEntry + label: listAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; @@ -5181,10 +5431,11 @@ actions: }); async function run() { - const result = await panora.accounting.journalentries.retrieve({ + const result = await panora.accounting.taxrates.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -5192,11 +5443,11 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] + - target: $["paths"]["/crm/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTrackingCategory + label: retrieveCrmContact source: |- import { Panora } from "@panora/sdk"; @@ -5205,7 +5456,7 @@ actions: }); async function run() { - const result = await panora.accounting.trackingcategories.retrieve({ + const result = await panora.crm.contacts.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -5216,34 +5467,24 @@ actions: } run(); - - target: $["paths"]["/passthrough"]["post"] + - target: $["paths"]["/crm/deals"]["get"] update: x-codeSamples: - lang: typescript - label: request + label: listCrmDeals source: |- import { Panora } from "@panora/sdk"; - import { PassThroughRequestDtoMethod } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.passthrough.request({ - integrationId: "", - linkedUserId: "", - vertical: "", - passThroughRequestDto: { - method: PassThroughRequestDtoMethod.Get, - path: "/dev", - data: { - "key": "", - }, - headers: { - "key": "", - }, - }, + const result = await panora.crm.deals.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result @@ -5251,11 +5492,11 @@ actions: } run(); - - target: $["paths"]["/ats/jobinterviewstages"]["get"] + - target: $["paths"]["/hris/employments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsJobInterviewStage + label: retrieveHrisEmployment source: |- import { Panora } from "@panora/sdk"; @@ -5264,8 +5505,10 @@ actions: }); async function run() { - const result = await panora.ats.jobinterviewstages.list({ + const result = await panora.hris.employments.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5273,11 +5516,11 @@ actions: } run(); - - target: $["paths"]["/accounting/payments/{id}"]["get"] + - target: $["paths"]["/accounting/balancesheets"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPayment + label: listAccountingBalanceSheets source: |- import { Panora } from "@panora/sdk"; @@ -5286,10 +5529,11 @@ actions: }); async function run() { - const result = await panora.accounting.payments.retrieve({ + const result = await panora.accounting.balancesheets.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/models/components/eventresponsetype.md b/docs/models/components/eventresponsetype.md index ef6ac5c0..2c6e11b0 100644 --- a/docs/models/components/eventresponsetype.md +++ b/docs/models/components/eventresponsetype.md @@ -53,7 +53,9 @@ Scope of the event | `AtsScorecardPulled` | ats.scorecard.pulled | | `AtsTagPulled` | ats.tag.pulled | | `AtsUserPulled` | ats.user.pulled | +| `FilestorageFileCreated` | filestorage.file.created | | `FilestorageFilePulled` | filestorage.file.pulled | +| `FilestorageFolderCreated` | filestorage.folder.created | | `FilestorageFolderPulled` | filestorage.folder.pulled | | `FilestorageGroupPulled` | filestorage.group.pulled | | `FilestorageUserPulled` | filestorage.user.pulled | diff --git a/docs/models/operations/listaccountingaccountsrequest.md b/docs/models/operations/listaccountingaccountsrequest.md index 8cb2231a..11788a35 100644 --- a/docs/models/operations/listaccountingaccountsrequest.md +++ b/docs/models/operations/listaccountingaccountsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingaddressrequest.md b/docs/models/operations/listaccountingaddressrequest.md index 28fee00d..c2b4c068 100644 --- a/docs/models/operations/listaccountingaddressrequest.md +++ b/docs/models/operations/listaccountingaddressrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingattachmentsrequest.md b/docs/models/operations/listaccountingattachmentsrequest.md index 9e4aaac9..c998ce60 100644 --- a/docs/models/operations/listaccountingattachmentsrequest.md +++ b/docs/models/operations/listaccountingattachmentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingbalancesheetsrequest.md b/docs/models/operations/listaccountingbalancesheetsrequest.md index af360f42..6195dc70 100644 --- a/docs/models/operations/listaccountingbalancesheetsrequest.md +++ b/docs/models/operations/listaccountingbalancesheetsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingcashflowstatementrequest.md b/docs/models/operations/listaccountingcashflowstatementrequest.md index fbe85272..e7d4230e 100644 --- a/docs/models/operations/listaccountingcashflowstatementrequest.md +++ b/docs/models/operations/listaccountingcashflowstatementrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingcompanyinfosrequest.md b/docs/models/operations/listaccountingcompanyinfosrequest.md index fdafbe8e..039d1d9f 100644 --- a/docs/models/operations/listaccountingcompanyinfosrequest.md +++ b/docs/models/operations/listaccountingcompanyinfosrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingcontactsrequest.md b/docs/models/operations/listaccountingcontactsrequest.md index 5165241a..38add106 100644 --- a/docs/models/operations/listaccountingcontactsrequest.md +++ b/docs/models/operations/listaccountingcontactsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingcreditnoterequest.md b/docs/models/operations/listaccountingcreditnoterequest.md index 3b126c21..72d5adbd 100644 --- a/docs/models/operations/listaccountingcreditnoterequest.md +++ b/docs/models/operations/listaccountingcreditnoterequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingexpenserequest.md b/docs/models/operations/listaccountingexpenserequest.md index d00eac18..5315e010 100644 --- a/docs/models/operations/listaccountingexpenserequest.md +++ b/docs/models/operations/listaccountingexpenserequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingincomestatementrequest.md b/docs/models/operations/listaccountingincomestatementrequest.md index 7ebe8a15..e02a5962 100644 --- a/docs/models/operations/listaccountingincomestatementrequest.md +++ b/docs/models/operations/listaccountingincomestatementrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountinginvoicerequest.md b/docs/models/operations/listaccountinginvoicerequest.md index edb31cbe..0dcea424 100644 --- a/docs/models/operations/listaccountinginvoicerequest.md +++ b/docs/models/operations/listaccountinginvoicerequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingitemrequest.md b/docs/models/operations/listaccountingitemrequest.md index 5ddb47c4..e781ecb2 100644 --- a/docs/models/operations/listaccountingitemrequest.md +++ b/docs/models/operations/listaccountingitemrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingjournalentryrequest.md b/docs/models/operations/listaccountingjournalentryrequest.md index 67a77072..add07064 100644 --- a/docs/models/operations/listaccountingjournalentryrequest.md +++ b/docs/models/operations/listaccountingjournalentryrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingpaymentrequest.md b/docs/models/operations/listaccountingpaymentrequest.md index 7bac2558..71f5c37a 100644 --- a/docs/models/operations/listaccountingpaymentrequest.md +++ b/docs/models/operations/listaccountingpaymentrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingphonenumberrequest.md b/docs/models/operations/listaccountingphonenumberrequest.md index 57578674..24bda25c 100644 --- a/docs/models/operations/listaccountingphonenumberrequest.md +++ b/docs/models/operations/listaccountingphonenumberrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingpurchaseorderrequest.md b/docs/models/operations/listaccountingpurchaseorderrequest.md index 0378bca3..73b9b575 100644 --- a/docs/models/operations/listaccountingpurchaseorderrequest.md +++ b/docs/models/operations/listaccountingpurchaseorderrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingtaxraterequest.md b/docs/models/operations/listaccountingtaxraterequest.md index eaace944..8b894dee 100644 --- a/docs/models/operations/listaccountingtaxraterequest.md +++ b/docs/models/operations/listaccountingtaxraterequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingtrackingcategorysrequest.md b/docs/models/operations/listaccountingtrackingcategorysrequest.md index 99351865..d2707284 100644 --- a/docs/models/operations/listaccountingtrackingcategorysrequest.md +++ b/docs/models/operations/listaccountingtrackingcategorysrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingtransactionrequest.md b/docs/models/operations/listaccountingtransactionrequest.md index 9adbaeb3..24af1a73 100644 --- a/docs/models/operations/listaccountingtransactionrequest.md +++ b/docs/models/operations/listaccountingtransactionrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listaccountingvendorcreditrequest.md b/docs/models/operations/listaccountingvendorcreditrequest.md index d235f9aa..aab74be3 100644 --- a/docs/models/operations/listaccountingvendorcreditrequest.md +++ b/docs/models/operations/listaccountingvendorcreditrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsactivityrequest.md b/docs/models/operations/listatsactivityrequest.md index 5c71f97a..7138f955 100644 --- a/docs/models/operations/listatsactivityrequest.md +++ b/docs/models/operations/listatsactivityrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsapplicationrequest.md b/docs/models/operations/listatsapplicationrequest.md index 457eb101..d3a5bd08 100644 --- a/docs/models/operations/listatsapplicationrequest.md +++ b/docs/models/operations/listatsapplicationrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsattachmentrequest.md b/docs/models/operations/listatsattachmentrequest.md index 96b0d679..b5004057 100644 --- a/docs/models/operations/listatsattachmentrequest.md +++ b/docs/models/operations/listatsattachmentrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatscandidaterequest.md b/docs/models/operations/listatscandidaterequest.md index 72050252..ad75c442 100644 --- a/docs/models/operations/listatscandidaterequest.md +++ b/docs/models/operations/listatscandidaterequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsdepartmentsrequest.md b/docs/models/operations/listatsdepartmentsrequest.md index c0d3c425..ddbdc512 100644 --- a/docs/models/operations/listatsdepartmentsrequest.md +++ b/docs/models/operations/listatsdepartmentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatseeocsrequest.md b/docs/models/operations/listatseeocsrequest.md index 19764425..18bd8873 100644 --- a/docs/models/operations/listatseeocsrequest.md +++ b/docs/models/operations/listatseeocsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsinterviewrequest.md b/docs/models/operations/listatsinterviewrequest.md index e1d4e891..9ef41211 100644 --- a/docs/models/operations/listatsinterviewrequest.md +++ b/docs/models/operations/listatsinterviewrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsjobinterviewstagerequest.md b/docs/models/operations/listatsjobinterviewstagerequest.md index 33d87861..ad89705e 100644 --- a/docs/models/operations/listatsjobinterviewstagerequest.md +++ b/docs/models/operations/listatsjobinterviewstagerequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsjobrequest.md b/docs/models/operations/listatsjobrequest.md index 34176d95..602c620b 100644 --- a/docs/models/operations/listatsjobrequest.md +++ b/docs/models/operations/listatsjobrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsofferrequest.md b/docs/models/operations/listatsofferrequest.md index d116d843..3cc15f4e 100644 --- a/docs/models/operations/listatsofferrequest.md +++ b/docs/models/operations/listatsofferrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsofficerequest.md b/docs/models/operations/listatsofficerequest.md index 303ef1bb..01988628 100644 --- a/docs/models/operations/listatsofficerequest.md +++ b/docs/models/operations/listatsofficerequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsrejectreasonsrequest.md b/docs/models/operations/listatsrejectreasonsrequest.md index 66d8ed48..a686bcba 100644 --- a/docs/models/operations/listatsrejectreasonsrequest.md +++ b/docs/models/operations/listatsrejectreasonsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsscorecardrequest.md b/docs/models/operations/listatsscorecardrequest.md index 58d2c1ca..eaba5954 100644 --- a/docs/models/operations/listatsscorecardrequest.md +++ b/docs/models/operations/listatsscorecardrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatstagsrequest.md b/docs/models/operations/listatstagsrequest.md index 254c1efc..88b85270 100644 --- a/docs/models/operations/listatstagsrequest.md +++ b/docs/models/operations/listatstagsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listatsusersrequest.md b/docs/models/operations/listatsusersrequest.md index 973c3872..08dfdb12 100644 --- a/docs/models/operations/listatsusersrequest.md +++ b/docs/models/operations/listatsusersrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmcompanyrequest.md b/docs/models/operations/listcrmcompanyrequest.md index 1a56af07..13075e01 100644 --- a/docs/models/operations/listcrmcompanyrequest.md +++ b/docs/models/operations/listcrmcompanyrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmcontactsrequest.md b/docs/models/operations/listcrmcontactsrequest.md index 6b9b029d..24076e06 100644 --- a/docs/models/operations/listcrmcontactsrequest.md +++ b/docs/models/operations/listcrmcontactsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmdealsrequest.md b/docs/models/operations/listcrmdealsrequest.md index 7f24de1b..e6ce9aed 100644 --- a/docs/models/operations/listcrmdealsrequest.md +++ b/docs/models/operations/listcrmdealsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmengagementsrequest.md b/docs/models/operations/listcrmengagementsrequest.md index 5d11f32b..a3d1d9fe 100644 --- a/docs/models/operations/listcrmengagementsrequest.md +++ b/docs/models/operations/listcrmengagementsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmnoterequest.md b/docs/models/operations/listcrmnoterequest.md index 4977c825..bc565d03 100644 --- a/docs/models/operations/listcrmnoterequest.md +++ b/docs/models/operations/listcrmnoterequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmstagesrequest.md b/docs/models/operations/listcrmstagesrequest.md index 5ec61089..1d25fb79 100644 --- a/docs/models/operations/listcrmstagesrequest.md +++ b/docs/models/operations/listcrmstagesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmtaskrequest.md b/docs/models/operations/listcrmtaskrequest.md index 3eac05a3..e7140214 100644 --- a/docs/models/operations/listcrmtaskrequest.md +++ b/docs/models/operations/listcrmtaskrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listcrmusersrequest.md b/docs/models/operations/listcrmusersrequest.md index 05b72d20..daeb1748 100644 --- a/docs/models/operations/listcrmusersrequest.md +++ b/docs/models/operations/listcrmusersrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listfilestoragedrivesrequest.md b/docs/models/operations/listfilestoragedrivesrequest.md index 8b0b1b40..91272ccd 100644 --- a/docs/models/operations/listfilestoragedrivesrequest.md +++ b/docs/models/operations/listfilestoragedrivesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listfilestoragefilerequest.md b/docs/models/operations/listfilestoragefilerequest.md index 4dbb9424..c9b98c9c 100644 --- a/docs/models/operations/listfilestoragefilerequest.md +++ b/docs/models/operations/listfilestoragefilerequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listfilestoragefolderrequest.md b/docs/models/operations/listfilestoragefolderrequest.md index c8056725..8c061bbc 100644 --- a/docs/models/operations/listfilestoragefolderrequest.md +++ b/docs/models/operations/listfilestoragefolderrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listfilestoragegrouprequest.md b/docs/models/operations/listfilestoragegrouprequest.md index 4af4a400..fc1617a5 100644 --- a/docs/models/operations/listfilestoragegrouprequest.md +++ b/docs/models/operations/listfilestoragegrouprequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listfilestorageusersrequest.md b/docs/models/operations/listfilestorageusersrequest.md index 242233b7..f485475c 100644 --- a/docs/models/operations/listfilestorageusersrequest.md +++ b/docs/models/operations/listfilestorageusersrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisbankinforequest.md b/docs/models/operations/listhrisbankinforequest.md index 72ddc2d0..334d4329 100644 --- a/docs/models/operations/listhrisbankinforequest.md +++ b/docs/models/operations/listhrisbankinforequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisbenefitsrequest.md b/docs/models/operations/listhrisbenefitsrequest.md index 886b7e7c..5961d2b3 100644 --- a/docs/models/operations/listhrisbenefitsrequest.md +++ b/docs/models/operations/listhrisbenefitsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhriscompaniesrequest.md b/docs/models/operations/listhriscompaniesrequest.md index 254bc44d..51660c13 100644 --- a/docs/models/operations/listhriscompaniesrequest.md +++ b/docs/models/operations/listhriscompaniesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisdependentsrequest.md b/docs/models/operations/listhrisdependentsrequest.md index 6b5fbea0..5342fe72 100644 --- a/docs/models/operations/listhrisdependentsrequest.md +++ b/docs/models/operations/listhrisdependentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisemployeepayrollrunrequest.md b/docs/models/operations/listhrisemployeepayrollrunrequest.md index 275e68d7..56ba7de1 100644 --- a/docs/models/operations/listhrisemployeepayrollrunrequest.md +++ b/docs/models/operations/listhrisemployeepayrollrunrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisemployeesrequest.md b/docs/models/operations/listhrisemployeesrequest.md index 8ee7c8fe..4b3e5175 100644 --- a/docs/models/operations/listhrisemployeesrequest.md +++ b/docs/models/operations/listhrisemployeesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisemployerbenefitsrequest.md b/docs/models/operations/listhrisemployerbenefitsrequest.md index a5c36a65..4e275c4a 100644 --- a/docs/models/operations/listhrisemployerbenefitsrequest.md +++ b/docs/models/operations/listhrisemployerbenefitsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisemploymentsrequest.md b/docs/models/operations/listhrisemploymentsrequest.md index 09ccdc8b..9b88c627 100644 --- a/docs/models/operations/listhrisemploymentsrequest.md +++ b/docs/models/operations/listhrisemploymentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrisgroupsrequest.md b/docs/models/operations/listhrisgroupsrequest.md index 3d83902b..bed31294 100644 --- a/docs/models/operations/listhrisgroupsrequest.md +++ b/docs/models/operations/listhrisgroupsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrislocationsrequest.md b/docs/models/operations/listhrislocationsrequest.md index 8a36d4ee..564f9901 100644 --- a/docs/models/operations/listhrislocationsrequest.md +++ b/docs/models/operations/listhrislocationsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrispaygroupsrequest.md b/docs/models/operations/listhrispaygroupsrequest.md index dbecf855..a5835110 100644 --- a/docs/models/operations/listhrispaygroupsrequest.md +++ b/docs/models/operations/listhrispaygroupsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhrispayrollrunsrequest.md b/docs/models/operations/listhrispayrollrunsrequest.md index 554040a7..d49f84c5 100644 --- a/docs/models/operations/listhrispayrollrunsrequest.md +++ b/docs/models/operations/listhrispayrollrunsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhristimeoffbalancesrequest.md b/docs/models/operations/listhristimeoffbalancesrequest.md index 304e3888..c6e4d5c1 100644 --- a/docs/models/operations/listhristimeoffbalancesrequest.md +++ b/docs/models/operations/listhristimeoffbalancesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listhristimeoffsrequest.md b/docs/models/operations/listhristimeoffsrequest.md index ead6895d..9dac1681 100644 --- a/docs/models/operations/listhristimeoffsrequest.md +++ b/docs/models/operations/listhristimeoffsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationactionrequest.md b/docs/models/operations/listmarketingautomationactionrequest.md index b0cf65eb..54275650 100644 --- a/docs/models/operations/listmarketingautomationactionrequest.md +++ b/docs/models/operations/listmarketingautomationactionrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationautomationsrequest.md b/docs/models/operations/listmarketingautomationautomationsrequest.md index b688902b..8a8d263e 100644 --- a/docs/models/operations/listmarketingautomationautomationsrequest.md +++ b/docs/models/operations/listmarketingautomationautomationsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationcampaignsrequest.md b/docs/models/operations/listmarketingautomationcampaignsrequest.md index 45cc4989..a4a77b0d 100644 --- a/docs/models/operations/listmarketingautomationcampaignsrequest.md +++ b/docs/models/operations/listmarketingautomationcampaignsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationcontactsrequest.md b/docs/models/operations/listmarketingautomationcontactsrequest.md index 9ff7c77c..91541447 100644 --- a/docs/models/operations/listmarketingautomationcontactsrequest.md +++ b/docs/models/operations/listmarketingautomationcontactsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationemailsrequest.md b/docs/models/operations/listmarketingautomationemailsrequest.md index 82a9019c..2728a987 100644 --- a/docs/models/operations/listmarketingautomationemailsrequest.md +++ b/docs/models/operations/listmarketingautomationemailsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationeventsrequest.md b/docs/models/operations/listmarketingautomationeventsrequest.md index ef4bd662..134a4cb0 100644 --- a/docs/models/operations/listmarketingautomationeventsrequest.md +++ b/docs/models/operations/listmarketingautomationeventsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationlistsrequest.md b/docs/models/operations/listmarketingautomationlistsrequest.md index 6c63eecf..f3420c8e 100644 --- a/docs/models/operations/listmarketingautomationlistsrequest.md +++ b/docs/models/operations/listmarketingautomationlistsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationmessagesrequest.md b/docs/models/operations/listmarketingautomationmessagesrequest.md index fe0aec64..e873ecec 100644 --- a/docs/models/operations/listmarketingautomationmessagesrequest.md +++ b/docs/models/operations/listmarketingautomationmessagesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationtemplatesrequest.md b/docs/models/operations/listmarketingautomationtemplatesrequest.md index e086fa61..b51b2cbc 100644 --- a/docs/models/operations/listmarketingautomationtemplatesrequest.md +++ b/docs/models/operations/listmarketingautomationtemplatesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationusersrequest.md b/docs/models/operations/listmarketingautomationusersrequest.md index 29305690..3deccd22 100644 --- a/docs/models/operations/listmarketingautomationusersrequest.md +++ b/docs/models/operations/listmarketingautomationusersrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingaccountrequest.md b/docs/models/operations/listticketingaccountrequest.md index 4379b455..13f8c382 100644 --- a/docs/models/operations/listticketingaccountrequest.md +++ b/docs/models/operations/listticketingaccountrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingattachmentsrequest.md b/docs/models/operations/listticketingattachmentsrequest.md index 50f4c9ab..3735805c 100644 --- a/docs/models/operations/listticketingattachmentsrequest.md +++ b/docs/models/operations/listticketingattachmentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingcollectionsrequest.md b/docs/models/operations/listticketingcollectionsrequest.md index db50b78f..1d8ec268 100644 --- a/docs/models/operations/listticketingcollectionsrequest.md +++ b/docs/models/operations/listticketingcollectionsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingcommentsrequest.md b/docs/models/operations/listticketingcommentsrequest.md index 98f98167..1439a392 100644 --- a/docs/models/operations/listticketingcommentsrequest.md +++ b/docs/models/operations/listticketingcommentsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingcontactsrequest.md b/docs/models/operations/listticketingcontactsrequest.md index 455da2ca..c0ab8ba3 100644 --- a/docs/models/operations/listticketingcontactsrequest.md +++ b/docs/models/operations/listticketingcontactsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingtagsrequest.md b/docs/models/operations/listticketingtagsrequest.md index d60d269a..60f6ed66 100644 --- a/docs/models/operations/listticketingtagsrequest.md +++ b/docs/models/operations/listticketingtagsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingteamsrequest.md b/docs/models/operations/listticketingteamsrequest.md index dd46fa2f..09c1451f 100644 --- a/docs/models/operations/listticketingteamsrequest.md +++ b/docs/models/operations/listticketingteamsrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingticketrequest.md b/docs/models/operations/listticketingticketrequest.md index 1f85e577..e7fea042 100644 --- a/docs/models/operations/listticketingticketrequest.md +++ b/docs/models/operations/listticketingticketrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/models/operations/listticketingticketresponse.md b/docs/models/operations/listticketingticketresponse.md new file mode 100644 index 00000000..22b14035 --- /dev/null +++ b/docs/models/operations/listticketingticketresponse.md @@ -0,0 +1,8 @@ +# ListTicketingTicketResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `result` | [operations.ListTicketingTicketResponseBody](../../models/operations/listticketingticketresponsebody.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listticketingusersrequest.md b/docs/models/operations/listticketingusersrequest.md index 4ce386b0..c92c4670 100644 --- a/docs/models/operations/listticketingusersrequest.md +++ b/docs/models/operations/listticketingusersrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | true | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | 10 | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | 1b8b05bb-5273-4012-b520-8657b0b90874 | \ No newline at end of file diff --git a/docs/sdks/accounts/README.md b/docs/sdks/accounts/README.md index f43b6116..d786ae87 100644 --- a/docs/sdks/accounts/README.md +++ b/docs/sdks/accounts/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.accounts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/actions/README.md b/docs/sdks/actions/README.md index a5eefb0c..6e9c7d67 100644 --- a/docs/sdks/actions/README.md +++ b/docs/sdks/actions/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.actions.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 38bc0e19..eeb4d436 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.activities.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/addresses/README.md b/docs/sdks/addresses/README.md index 2171f8ab..eb3afe49 100644 --- a/docs/sdks/addresses/README.md +++ b/docs/sdks/addresses/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.addresses.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md index 47923d60..b1712fac 100644 --- a/docs/sdks/applications/README.md +++ b/docs/sdks/applications/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.applications.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md index 69f3233e..2fc49c0d 100644 --- a/docs/sdks/attachments/README.md +++ b/docs/sdks/attachments/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.attachments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/automations/README.md b/docs/sdks/automations/README.md index 30ededbf..b5bd358e 100644 --- a/docs/sdks/automations/README.md +++ b/docs/sdks/automations/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.automations.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/balancesheets/README.md b/docs/sdks/balancesheets/README.md index 73e5e44d..6ad3f4ea 100644 --- a/docs/sdks/balancesheets/README.md +++ b/docs/sdks/balancesheets/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.balancesheets.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/bankinfos/README.md b/docs/sdks/bankinfos/README.md index 919d8be6..b08163e3 100644 --- a/docs/sdks/bankinfos/README.md +++ b/docs/sdks/bankinfos/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.bankinfos.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/batch/README.md b/docs/sdks/batch/README.md deleted file mode 100644 index ac89719d..00000000 --- a/docs/sdks/batch/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Batch -(*linkedUsers.batch*) - -### Available Operations - -* [importBatch](#importbatch) - Add Batch Linked Users - -## importBatch - -Add Batch Linked Users - -### Example Usage - -```typescript -import { Panora } from "@panora/sdk"; - -const panora = new Panora({ - apiKey: "", -}); - -async function run() { - const result = await panora.linkedUsers.batch.importBatch({ - linkedUserOriginIds: [ - "id_1", - ], - alias: "acme", - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateBatchLinkedUserDto](../../models/components/createbatchlinkeduserdto.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.LinkedUserResponse[]](../../models/.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/benefits/README.md b/docs/sdks/benefits/README.md index d206a165..ff98031b 100644 --- a/docs/sdks/benefits/README.md +++ b/docs/sdks/benefits/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.benefits.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/campaigns/README.md b/docs/sdks/campaigns/README.md index 1d59553d..10624940 100644 --- a/docs/sdks/campaigns/README.md +++ b/docs/sdks/campaigns/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.campaigns.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/candidates/README.md b/docs/sdks/candidates/README.md index 033a2c31..40962a45 100644 --- a/docs/sdks/candidates/README.md +++ b/docs/sdks/candidates/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.candidates.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/cashflowstatements/README.md b/docs/sdks/cashflowstatements/README.md index d6ff654a..b43ad6e1 100644 --- a/docs/sdks/cashflowstatements/README.md +++ b/docs/sdks/cashflowstatements/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.cashflowstatements.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md index 1aa05c6e..3119d383 100644 --- a/docs/sdks/collections/README.md +++ b/docs/sdks/collections/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.collections.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/comments/README.md b/docs/sdks/comments/README.md index 71dc557d..90915a96 100644 --- a/docs/sdks/comments/README.md +++ b/docs/sdks/comments/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.comments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index 1515ce3c..933238dc 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.companies.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/companyinfos/README.md b/docs/sdks/companyinfos/README.md index 4cec83e2..b007beb0 100644 --- a/docs/sdks/companyinfos/README.md +++ b/docs/sdks/companyinfos/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.companyinfos.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index 7c33a2c0..7a149320 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.contacts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index 9e83bec2..8b1c9b56 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.creditnotes.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/deals/README.md b/docs/sdks/deals/README.md index 3c27879b..fdc9e566 100644 --- a/docs/sdks/deals/README.md +++ b/docs/sdks/deals/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.deals.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/define/README.md b/docs/sdks/define/README.md deleted file mode 100644 index 26032836..00000000 --- a/docs/sdks/define/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# Define -(*fieldMappings.define*) - -### Available Operations - -* [definitions](#definitions) - Define target Field - -## definitions - -Define target Field - -### Example Usage - -```typescript -import { Panora } from "@panora/sdk"; -import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; - -const panora = new Panora({ - apiKey: "", -}); - -async function run() { - const result = await panora.fieldMappings.define.definitions({ - objectTypeOwner: ObjectTypeOwner.Company, - name: "fav_dish", - description: "My favorite dish", - dataType: DataType.String, - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.DefineTargetFieldDto](../../models/components/definetargetfielddto.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.CustomFieldResponse](../../models/components/customfieldresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md index 0c7d0599..a6befeba 100644 --- a/docs/sdks/departments/README.md +++ b/docs/sdks/departments/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.departments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/dependents/README.md b/docs/sdks/dependents/README.md index 0017f4e3..e56b53fa 100644 --- a/docs/sdks/dependents/README.md +++ b/docs/sdks/dependents/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.dependents.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md index 1295e5fb..d0c61dc8 100644 --- a/docs/sdks/drives/README.md +++ b/docs/sdks/drives/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.filestorage.drives.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/eeocs/README.md b/docs/sdks/eeocs/README.md index b87f9794..3fa27f01 100644 --- a/docs/sdks/eeocs/README.md +++ b/docs/sdks/eeocs/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.eeocs.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/emails/README.md b/docs/sdks/emails/README.md index 8e044a5b..503a9a19 100644 --- a/docs/sdks/emails/README.md +++ b/docs/sdks/emails/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.emails.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/employeepayrollruns/README.md b/docs/sdks/employeepayrollruns/README.md index f9dcd1d6..65070e88 100644 --- a/docs/sdks/employeepayrollruns/README.md +++ b/docs/sdks/employeepayrollruns/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.employeepayrollruns.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index f052cf07..30779646 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.employees.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/employerbenefits/README.md b/docs/sdks/employerbenefits/README.md index 259ba4a0..b1818a30 100644 --- a/docs/sdks/employerbenefits/README.md +++ b/docs/sdks/employerbenefits/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.employerbenefits.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/employments/README.md b/docs/sdks/employments/README.md index c8ed4858..a0d4de34 100644 --- a/docs/sdks/employments/README.md +++ b/docs/sdks/employments/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.employments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/engagements/README.md b/docs/sdks/engagements/README.md index 3c50b46d..e831104e 100644 --- a/docs/sdks/engagements/README.md +++ b/docs/sdks/engagements/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.engagements.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index c782ffac..14550751 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.expenses.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/fieldmappings/README.md b/docs/sdks/fieldmappings/README.md index 905412dd..580f8ec8 100644 --- a/docs/sdks/fieldmappings/README.md +++ b/docs/sdks/fieldmappings/README.md @@ -3,7 +3,57 @@ ### Available Operations +* [definitions](#definitions) - Define target Field * [defineCustomField](#definecustomfield) - Create Custom Field +* [map](#map) - Map Custom Field + +## definitions + +Define target Field + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; +import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.fieldMappings.definitions({ + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.DefineTargetFieldDto](../../models/components/definetargetfielddto.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.CustomFieldResponse](../../models/components/customfieldresponse.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | ## defineCustomField @@ -47,6 +97,53 @@ run(); | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +### Response + +**Promise\<[components.CustomFieldResponse](../../models/components/customfieldresponse.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | + +## map + +Map Custom Field + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.fieldMappings.map({ + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.MapFieldToProviderDto](../../models/components/mapfieldtoproviderdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + ### Response **Promise\<[components.CustomFieldResponse](../../models/components/customfieldresponse.md)\>** diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md index 32ed2436..9cd5806e 100644 --- a/docs/sdks/files/README.md +++ b/docs/sdks/files/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.filestorage.files.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md index 96a3dfef..7770d956 100644 --- a/docs/sdks/folders/README.md +++ b/docs/sdks/folders/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.filestorage.folders.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/fromremoteid/README.md b/docs/sdks/fromremoteid/README.md deleted file mode 100644 index b41525cb..00000000 --- a/docs/sdks/fromremoteid/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Fromremoteid -(*linkedUsers.fromremoteid*) - -### Available Operations - -* [remoteId](#remoteid) - Retrieve a Linked User From A Remote Id - -## remoteId - -Retrieve a Linked User From A Remote Id - -### Example Usage - -```typescript -import { Panora } from "@panora/sdk"; - -const panora = new Panora({ - apiKey: "", -}); - -async function run() { - const result = await panora.linkedUsers.fromremoteid.remoteId({ - remoteId: "id_1", - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.RemoteIdRequest](../../models/operations/remoteidrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.LinkedUserResponse](../../models/components/linkeduserresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/groups/README.md b/docs/sdks/groups/README.md index 016c1fda..28103bdb 100644 --- a/docs/sdks/groups/README.md +++ b/docs/sdks/groups/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.groups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/id/README.md b/docs/sdks/id/README.md deleted file mode 100644 index 42446af1..00000000 --- a/docs/sdks/id/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Id -(*linkedUsers.id*) - -### Available Operations - -* [retrieve](#retrieve) - Retrieve Linked Users - -## retrieve - -Retrieve Linked Users - -### Example Usage - -```typescript -import { Panora } from "@panora/sdk"; - -const panora = new Panora({ - apiKey: "", -}); - -async function run() { - const result = await panora.linkedUsers.id.retrieve({ - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.RetrieveLinkedUserRequest](../../models/operations/retrievelinkeduserrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.LinkedUserResponse](../../models/components/linkeduserresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/incomestatements/README.md b/docs/sdks/incomestatements/README.md index f31893e7..25b75323 100644 --- a/docs/sdks/incomestatements/README.md +++ b/docs/sdks/incomestatements/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.incomestatements.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/interviews/README.md b/docs/sdks/interviews/README.md index 7312b5c2..1161c7c0 100644 --- a/docs/sdks/interviews/README.md +++ b/docs/sdks/interviews/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.interviews.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index cb28925d..9485ad81 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.invoices.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/items/README.md b/docs/sdks/items/README.md index 9394eb99..38f2195f 100644 --- a/docs/sdks/items/README.md +++ b/docs/sdks/items/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.items.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/jobinterviewstages/README.md b/docs/sdks/jobinterviewstages/README.md index 7c69c7d7..994090df 100644 --- a/docs/sdks/jobinterviewstages/README.md +++ b/docs/sdks/jobinterviewstages/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.jobinterviewstages.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index 637524af..c89ddf74 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.jobs.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index 414e79b4..2ff78408 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.journalentries.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/linkedusers/README.md b/docs/sdks/linkedusers/README.md index 3338f1e2..214f58e3 100644 --- a/docs/sdks/linkedusers/README.md +++ b/docs/sdks/linkedusers/README.md @@ -5,6 +5,9 @@ * [create](#create) - Create Linked Users * [list](#list) - List Linked Users +* [importBatch](#importbatch) - Add Batch Linked Users +* [retrieve](#retrieve) - Retrieve Linked Users +* [remoteId](#remoteid) - Retrieve a Linked User From A Remote Id ## create @@ -91,3 +94,138 @@ run(); | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + +## importBatch + +Add Batch Linked Users + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.linkedUsers.importBatch({ + linkedUserOriginIds: [ + "id_1", + ], + alias: "acme", + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.CreateBatchLinkedUserDto](../../models/components/createbatchlinkeduserdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.LinkedUserResponse[]](../../models/.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | + +## retrieve + +Retrieve Linked Users + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.linkedUsers.retrieve({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.RetrieveLinkedUserRequest](../../models/operations/retrievelinkeduserrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.LinkedUserResponse](../../models/components/linkeduserresponse.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | + +## remoteId + +Retrieve a Linked User From A Remote Id + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.linkedUsers.remoteId({ + remoteId: "id_1", + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.RemoteIdRequest](../../models/operations/remoteidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.LinkedUserResponse](../../models/components/linkeduserresponse.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/lists/README.md b/docs/sdks/lists/README.md index ff2ca364..afee1fa9 100644 --- a/docs/sdks/lists/README.md +++ b/docs/sdks/lists/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.lists.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/locations/README.md b/docs/sdks/locations/README.md index 1d13c8f6..7513383a 100644 --- a/docs/sdks/locations/README.md +++ b/docs/sdks/locations/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.locations.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/map/README.md b/docs/sdks/map/README.md deleted file mode 100644 index 914a5453..00000000 --- a/docs/sdks/map/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Map -(*fieldMappings.map*) - -### Available Operations - -* [map](#map) - Map Custom Field - -## map - -Map Custom Field - -### Example Usage - -```typescript -import { Panora } from "@panora/sdk"; - -const panora = new Panora({ - apiKey: "", -}); - -async function run() { - const result = await panora.fieldMappings.map.map({ - attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - sourceCustomFieldId: "id_1", - sourceProvider: "hubspot", - linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.MapFieldToProviderDto](../../models/components/mapfieldtoproviderdto.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.CustomFieldResponse](../../models/components/customfieldresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index e85359d8..1ea2f6fe 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.messages.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/notes/README.md b/docs/sdks/notes/README.md index 14bec15c..5e276901 100644 --- a/docs/sdks/notes/README.md +++ b/docs/sdks/notes/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.notes.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/offers/README.md b/docs/sdks/offers/README.md index d6a2f22f..06b37804 100644 --- a/docs/sdks/offers/README.md +++ b/docs/sdks/offers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.offers.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/offices/README.md b/docs/sdks/offices/README.md index 786c8255..c5cf1115 100644 --- a/docs/sdks/offices/README.md +++ b/docs/sdks/offices/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.offices.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraaccountingcontacts/README.md b/docs/sdks/panoraaccountingcontacts/README.md index e4a8bce3..ec636c87 100644 --- a/docs/sdks/panoraaccountingcontacts/README.md +++ b/docs/sdks/panoraaccountingcontacts/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.contacts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraaccounts/README.md b/docs/sdks/panoraaccounts/README.md index 69a89ba6..9ff94b3f 100644 --- a/docs/sdks/panoraaccounts/README.md +++ b/docs/sdks/panoraaccounts/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.accounts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraatsusers/README.md b/docs/sdks/panoraatsusers/README.md index 6acb70c2..77e67fd1 100644 --- a/docs/sdks/panoraatsusers/README.md +++ b/docs/sdks/panoraatsusers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraattachments/README.md b/docs/sdks/panoraattachments/README.md index 70b9b155..a79fd4a2 100644 --- a/docs/sdks/panoraattachments/README.md +++ b/docs/sdks/panoraattachments/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.attachments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoracompanies/README.md b/docs/sdks/panoracompanies/README.md index 75588a4c..2dbc7ae3 100644 --- a/docs/sdks/panoracompanies/README.md +++ b/docs/sdks/panoracompanies/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.companies.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoracontacts/README.md b/docs/sdks/panoracontacts/README.md index a7f71c5f..ba8aae54 100644 --- a/docs/sdks/panoracontacts/README.md +++ b/docs/sdks/panoracontacts/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.contacts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraevents/README.md b/docs/sdks/panoraevents/README.md index 9cc851dc..ad8e37be 100644 --- a/docs/sdks/panoraevents/README.md +++ b/docs/sdks/panoraevents/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.events.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panorafilestorageusers/README.md b/docs/sdks/panorafilestorageusers/README.md index 9585376f..cb0eeb67 100644 --- a/docs/sdks/panorafilestorageusers/README.md +++ b/docs/sdks/panorafilestorageusers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.filestorage.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoragroups/README.md b/docs/sdks/panoragroups/README.md index 95578b5f..b3973cc2 100644 --- a/docs/sdks/panoragroups/README.md +++ b/docs/sdks/panoragroups/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.filestorage.groups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoramarketingautomationcontacts/README.md b/docs/sdks/panoramarketingautomationcontacts/README.md index 4c5a5ac4..193b1024 100644 --- a/docs/sdks/panoramarketingautomationcontacts/README.md +++ b/docs/sdks/panoramarketingautomationcontacts/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.contacts.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoramarketingautomationusers/README.md b/docs/sdks/panoramarketingautomationusers/README.md index 8f10b293..ebdf2c5e 100644 --- a/docs/sdks/panoramarketingautomationusers/README.md +++ b/docs/sdks/panoramarketingautomationusers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoratags/README.md b/docs/sdks/panoratags/README.md index 828df249..2f8d018a 100644 --- a/docs/sdks/panoratags/README.md +++ b/docs/sdks/panoratags/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.tags.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panoraticketingattachments/README.md b/docs/sdks/panoraticketingattachments/README.md index 81b3d0ac..095411cf 100644 --- a/docs/sdks/panoraticketingattachments/README.md +++ b/docs/sdks/panoraticketingattachments/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.attachments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/panorausers/README.md b/docs/sdks/panorausers/README.md index 3bbace23..2973968a 100644 --- a/docs/sdks/panorausers/README.md +++ b/docs/sdks/panorausers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/paygroups/README.md b/docs/sdks/paygroups/README.md index 0420267f..c21430d4 100644 --- a/docs/sdks/paygroups/README.md +++ b/docs/sdks/paygroups/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.paygroups.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index 449878e9..712d82ce 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.payments.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/payrollruns/README.md b/docs/sdks/payrollruns/README.md index 85d70de6..1f87e506 100644 --- a/docs/sdks/payrollruns/README.md +++ b/docs/sdks/payrollruns/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.payrollruns.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/phonenumbers/README.md b/docs/sdks/phonenumbers/README.md index e682bd00..0d318b75 100644 --- a/docs/sdks/phonenumbers/README.md +++ b/docs/sdks/phonenumbers/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.phonenumbers.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index 41b00688..da3a3d4c 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.purchaseorders.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/rejectreasons/README.md b/docs/sdks/rejectreasons/README.md index 5cd82b8e..2516867d 100644 --- a/docs/sdks/rejectreasons/README.md +++ b/docs/sdks/rejectreasons/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.rejectreasons.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/scorecards/README.md b/docs/sdks/scorecards/README.md index 1f660e7e..e61afbc2 100644 --- a/docs/sdks/scorecards/README.md +++ b/docs/sdks/scorecards/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ats.scorecards.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/stages/README.md b/docs/sdks/stages/README.md index 15366f7c..42fa708a 100644 --- a/docs/sdks/stages/README.md +++ b/docs/sdks/stages/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.stages.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/tags/README.md b/docs/sdks/tags/README.md index f5fd3fed..e675ba07 100644 --- a/docs/sdks/tags/README.md +++ b/docs/sdks/tags/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.tags.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/tasks/README.md b/docs/sdks/tasks/README.md index 905d98c3..f176723c 100644 --- a/docs/sdks/tasks/README.md +++ b/docs/sdks/tasks/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.crm.tasks.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/taxrates/README.md b/docs/sdks/taxrates/README.md index 6a8acb88..4ff3a5db 100644 --- a/docs/sdks/taxrates/README.md +++ b/docs/sdks/taxrates/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.taxrates.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/teams/README.md b/docs/sdks/teams/README.md index e332bd79..c5e25158 100644 --- a/docs/sdks/teams/README.md +++ b/docs/sdks/teams/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.teams.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/templates/README.md b/docs/sdks/templates/README.md index 9221d777..32718810 100644 --- a/docs/sdks/templates/README.md +++ b/docs/sdks/templates/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.marketingautomation.templates.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/tickets/README.md b/docs/sdks/tickets/README.md index a6a94a71..ca9145ca 100644 --- a/docs/sdks/tickets/README.md +++ b/docs/sdks/tickets/README.md @@ -23,10 +23,14 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.tickets.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); - // Handle the result - console.log(result) + for await (const page of result) { + // handle page + } } run(); @@ -44,7 +48,7 @@ run(); ### Response -**Promise\<[operations.ListTicketingTicketResponseBody](../../models/operations/listticketingticketresponsebody.md)\>** +**Promise\<[operations.ListTicketingTicketResponse](../../models/operations/listticketingticketresponse.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/timeoffbalances/README.md b/docs/sdks/timeoffbalances/README.md index 439d6f3b..a6cc7d2c 100644 --- a/docs/sdks/timeoffbalances/README.md +++ b/docs/sdks/timeoffbalances/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.timeoffbalances.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/timeoffs/README.md b/docs/sdks/timeoffs/README.md index 683c0f65..79f118c1 100644 --- a/docs/sdks/timeoffs/README.md +++ b/docs/sdks/timeoffs/README.md @@ -23,6 +23,9 @@ const panora = new Panora({ async function run() { const result = await panora.hris.timeoffs.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/trackingcategories/README.md b/docs/sdks/trackingcategories/README.md index 0710c4aa..f20e70a9 100644 --- a/docs/sdks/trackingcategories/README.md +++ b/docs/sdks/trackingcategories/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.trackingcategories.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md index 32050bd7..c798ae76 100644 --- a/docs/sdks/transactions/README.md +++ b/docs/sdks/transactions/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.transactions.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index d6b970f9..debf4b29 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.ticketing.users.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/docs/sdks/vendorcredits/README.md b/docs/sdks/vendorcredits/README.md index d0e0f8c1..fdbda049 100644 --- a/docs/sdks/vendorcredits/README.md +++ b/docs/sdks/vendorcredits/README.md @@ -22,6 +22,9 @@ const panora = new Panora({ async function run() { const result = await panora.accounting.vendorcredits.list({ xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); // Handle the result diff --git a/jsr.json b/jsr.json index 60d4efc0..8c88c48a 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@panora/sdk", - "version": "0.5.1", + "version": "0.6.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index f2659b8d..1b6409a2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@panora/sdk", - "version": "0.5.1", + "version": "0.6.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@panora/sdk", - "version": "0.5.1", + "version": "0.6.0", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index 2319d69d..a8fa927e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@panora/sdk", - "version": "0.5.1", + "version": "0.6.0", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/lib/config.ts b/src/lib/config.ts index 08b2f09f..03957a2f 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -63,7 +63,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0", - sdkVersion: "0.5.1", + sdkVersion: "0.6.0", genVersion: "2.385.2", - userAgent: "speakeasy-sdk/typescript 0.5.1 2.385.2 1.0 @panora/sdk", + userAgent: "speakeasy-sdk/typescript 0.6.0 2.385.2 1.0 @panora/sdk", } as const; diff --git a/src/models/components/eventresponse.ts b/src/models/components/eventresponse.ts index e053e3c2..b298f416 100644 --- a/src/models/components/eventresponse.ts +++ b/src/models/components/eventresponse.ts @@ -55,7 +55,9 @@ export enum EventResponseType { AtsScorecardPulled = "ats.scorecard.pulled", AtsTagPulled = "ats.tag.pulled", AtsUserPulled = "ats.user.pulled", + FilestorageFileCreated = "filestorage.file.created", FilestorageFilePulled = "filestorage.file.pulled", + FilestorageFolderCreated = "filestorage.folder.created", FilestorageFolderPulled = "filestorage.folder.pulled", FilestorageGroupPulled = "filestorage.group.pulled", FilestorageUserPulled = "filestorage.user.pulled", diff --git a/src/models/operations/listticketingticket.ts b/src/models/operations/listticketingticket.ts index 801f9c3c..9dc60c25 100644 --- a/src/models/operations/listticketingticket.ts +++ b/src/models/operations/listticketingticket.ts @@ -31,6 +31,10 @@ export type ListTicketingTicketResponseBody = { data: Array; }; +export type ListTicketingTicketResponse = { + result: ListTicketingTicketResponseBody; +}; + /** @internal */ export const ListTicketingTicketRequest$inboundSchema: z.ZodType< ListTicketingTicketRequest, @@ -145,3 +149,51 @@ export namespace ListTicketingTicketResponseBody$ { /** @deprecated use `ListTicketingTicketResponseBody$Outbound` instead. */ export type Outbound = ListTicketingTicketResponseBody$Outbound; } + +/** @internal */ +export const ListTicketingTicketResponse$inboundSchema: z.ZodType< + ListTicketingTicketResponse, + z.ZodTypeDef, + unknown +> = z + .object({ + Result: z.lazy(() => ListTicketingTicketResponseBody$inboundSchema), + }) + .transform((v) => { + return remap$(v, { + Result: "result", + }); + }); + +/** @internal */ +export type ListTicketingTicketResponse$Outbound = { + Result: ListTicketingTicketResponseBody$Outbound; +}; + +/** @internal */ +export const ListTicketingTicketResponse$outboundSchema: z.ZodType< + ListTicketingTicketResponse$Outbound, + z.ZodTypeDef, + ListTicketingTicketResponse +> = z + .object({ + result: z.lazy(() => ListTicketingTicketResponseBody$outboundSchema), + }) + .transform((v) => { + return remap$(v, { + result: "Result", + }); + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ListTicketingTicketResponse$ { + /** @deprecated use `ListTicketingTicketResponse$inboundSchema` instead. */ + export const inboundSchema = ListTicketingTicketResponse$inboundSchema; + /** @deprecated use `ListTicketingTicketResponse$outboundSchema` instead. */ + export const outboundSchema = ListTicketingTicketResponse$outboundSchema; + /** @deprecated use `ListTicketingTicketResponse$Outbound` instead. */ + export type Outbound = ListTicketingTicketResponse$Outbound; +} diff --git a/src/sdk/batch.ts b/src/sdk/batch.ts deleted file mode 100644 index 7e003314..00000000 --- a/src/sdk/batch.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { encodeJSON as encodeJSON$ } from "../lib/encodings.js"; -import * as m$ from "../lib/matchers.js"; -import * as schemas$ from "../lib/schemas.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { unwrap as unwrap$ } from "../types/fp.js"; -import * as z from "zod"; - -export class Batch extends ClientSDK { - /** - * Add Batch Linked Users - */ - async importBatch( - request: components.CreateBatchLinkedUserDto, - options?: RequestOptions - ): Promise> { - const input$ = request; - - const parsed$ = schemas$.safeParse( - input$, - (value$) => components.CreateBatchLinkedUserDto$outboundSchema.parse(value$), - "Input validation failed" - ); - const payload$ = unwrap$(parsed$); - const body$ = encodeJSON$("body", payload$, { explode: true }); - - const path$ = pathToFunc("/linked_users/batch")(); - - const headers$ = new Headers({ - "Content-Type": "application/json", - Accept: "application/json", - }); - - const apiKey$ = await extractSecurity(this.options$.apiKey); - const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; - const context = { - operationID: "importBatch", - oAuth2Scopes: [], - securitySource: this.options$.apiKey, - }; - const securitySettings$ = resolveGlobalSecurity(security$); - - const requestRes$ = this.createRequest$( - context, - { - security: securitySettings$, - method: "POST", - path: path$, - headers: headers$, - body: body$, - timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, - }, - options - ); - const request$ = unwrap$(requestRes$); - - const doResult = await this.do$(request$, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: options?.retries || this.options$.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }); - const response = unwrap$(doResult); - - const [result$] = await m$.match< - Array, - SDKError | SDKValidationError - >( - m$.json(201, z.array(components.LinkedUserResponse$inboundSchema)), - m$.fail(["4XX", "5XX"]) - )(response); - - return unwrap$(result$); - } -} diff --git a/src/sdk/define.ts b/src/sdk/define.ts deleted file mode 100644 index 4adde41f..00000000 --- a/src/sdk/define.ts +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { encodeJSON as encodeJSON$ } from "../lib/encodings.js"; -import * as m$ from "../lib/matchers.js"; -import * as schemas$ from "../lib/schemas.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { unwrap as unwrap$ } from "../types/fp.js"; - -export class Define extends ClientSDK { - /** - * Define target Field - */ - async definitions( - request: components.DefineTargetFieldDto, - options?: RequestOptions - ): Promise { - const input$ = request; - - const parsed$ = schemas$.safeParse( - input$, - (value$) => components.DefineTargetFieldDto$outboundSchema.parse(value$), - "Input validation failed" - ); - const payload$ = unwrap$(parsed$); - const body$ = encodeJSON$("body", payload$, { explode: true }); - - const path$ = pathToFunc("/field_mappings/define")(); - - const headers$ = new Headers({ - "Content-Type": "application/json", - Accept: "application/json", - }); - - const apiKey$ = await extractSecurity(this.options$.apiKey); - const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; - const context = { - operationID: "definitions", - oAuth2Scopes: [], - securitySource: this.options$.apiKey, - }; - const securitySettings$ = resolveGlobalSecurity(security$); - - const requestRes$ = this.createRequest$( - context, - { - security: securitySettings$, - method: "POST", - path: path$, - headers: headers$, - body: body$, - timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, - }, - options - ); - const request$ = unwrap$(requestRes$); - - const doResult = await this.do$(request$, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: options?.retries || this.options$.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }); - const response = unwrap$(doResult); - - const [result$] = await m$.match< - components.CustomFieldResponse, - SDKError | SDKValidationError - >( - m$.json(201, components.CustomFieldResponse$inboundSchema), - m$.fail(["4XX", "5XX"]) - )(response); - - return unwrap$(result$); - } -} diff --git a/src/sdk/fieldmappings.ts b/src/sdk/fieldmappings.ts index 3db94e2e..c3343405 100644 --- a/src/sdk/fieldmappings.ts +++ b/src/sdk/fieldmappings.ts @@ -12,18 +12,72 @@ import * as components from "../models/components/index.js"; import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { unwrap as unwrap$ } from "../types/fp.js"; -import { Define } from "./define.js"; -import { Map } from "./map.js"; export class FieldMappings extends ClientSDK { - private _define?: Define; - get define(): Define { - return (this._define ??= new Define(this.options$)); - } + /** + * Define target Field + */ + async definitions( + request: components.DefineTargetFieldDto, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => components.DefineTargetFieldDto$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = encodeJSON$("body", payload$, { explode: true }); + + const path$ = pathToFunc("/field_mappings/define")(); + + const headers$ = new Headers({ + "Content-Type": "application/json", + Accept: "application/json", + }); - private _map?: Map; - get map(): Map { - return (this._map ??= new Map(this.options$)); + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "definitions", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "POST", + path: path$, + headers: headers$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.CustomFieldResponse, + SDKError | SDKValidationError + >( + m$.json(201, components.CustomFieldResponse$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); } /** @@ -91,4 +145,70 @@ export class FieldMappings extends ClientSDK { return unwrap$(result$); } + + /** + * Map Custom Field + */ + async map( + request: components.MapFieldToProviderDto, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => components.MapFieldToProviderDto$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = encodeJSON$("body", payload$, { explode: true }); + + const path$ = pathToFunc("/field_mappings/map")(); + + const headers$ = new Headers({ + "Content-Type": "application/json", + Accept: "application/json", + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "map", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "POST", + path: path$, + headers: headers$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.CustomFieldResponse, + SDKError | SDKValidationError + >( + m$.json(201, components.CustomFieldResponse$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } } diff --git a/src/sdk/fromremoteid.ts b/src/sdk/fromremoteid.ts deleted file mode 100644 index 08fd56c0..00000000 --- a/src/sdk/fromremoteid.ts +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { encodeFormQuery as encodeFormQuery$ } from "../lib/encodings.js"; -import * as m$ from "../lib/matchers.js"; -import * as schemas$ from "../lib/schemas.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { unwrap as unwrap$ } from "../types/fp.js"; - -export class Fromremoteid extends ClientSDK { - /** - * Retrieve a Linked User From A Remote Id - */ - async remoteId( - request: operations.RemoteIdRequest, - options?: RequestOptions - ): Promise { - const input$ = request; - - const parsed$ = schemas$.safeParse( - input$, - (value$) => operations.RemoteIdRequest$outboundSchema.parse(value$), - "Input validation failed" - ); - const payload$ = unwrap$(parsed$); - const body$ = null; - - const path$ = pathToFunc("/linked_users/fromRemoteId")(); - - const query$ = encodeFormQuery$({ - remoteId: payload$.remoteId, - }); - - const headers$ = new Headers({ - Accept: "application/json", - }); - - const apiKey$ = await extractSecurity(this.options$.apiKey); - const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; - const context = { - operationID: "remoteId", - oAuth2Scopes: [], - securitySource: this.options$.apiKey, - }; - const securitySettings$ = resolveGlobalSecurity(security$); - - const requestRes$ = this.createRequest$( - context, - { - security: securitySettings$, - method: "GET", - path: path$, - headers: headers$, - query: query$, - body: body$, - timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, - }, - options - ); - const request$ = unwrap$(requestRes$); - - const doResult = await this.do$(request$, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: options?.retries || this.options$.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }); - const response = unwrap$(doResult); - - const [result$] = await m$.match< - components.LinkedUserResponse, - SDKError | SDKValidationError - >( - m$.json(200, components.LinkedUserResponse$inboundSchema), - m$.fail(["4XX", "5XX"]) - )(response); - - return unwrap$(result$); - } -} diff --git a/src/sdk/id.ts b/src/sdk/id.ts deleted file mode 100644 index 94db3716..00000000 --- a/src/sdk/id.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { encodeSimple as encodeSimple$ } from "../lib/encodings.js"; -import * as m$ from "../lib/matchers.js"; -import * as schemas$ from "../lib/schemas.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { unwrap as unwrap$ } from "../types/fp.js"; - -export class Id extends ClientSDK { - /** - * Retrieve Linked Users - */ - async retrieve( - request: operations.RetrieveLinkedUserRequest, - options?: RequestOptions - ): Promise { - const input$ = request; - - const parsed$ = schemas$.safeParse( - input$, - (value$) => operations.RetrieveLinkedUserRequest$outboundSchema.parse(value$), - "Input validation failed" - ); - const payload$ = unwrap$(parsed$); - const body$ = null; - - const pathParams$ = { - id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), - }; - - const path$ = pathToFunc("/linked_users/{id}")(pathParams$); - - const headers$ = new Headers({ - Accept: "application/json", - }); - - const apiKey$ = await extractSecurity(this.options$.apiKey); - const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; - const context = { - operationID: "retrieveLinkedUser", - oAuth2Scopes: [], - securitySource: this.options$.apiKey, - }; - const securitySettings$ = resolveGlobalSecurity(security$); - - const requestRes$ = this.createRequest$( - context, - { - security: securitySettings$, - method: "GET", - path: path$, - headers: headers$, - body: body$, - timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, - }, - options - ); - const request$ = unwrap$(requestRes$); - - const doResult = await this.do$(request$, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: options?.retries || this.options$.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }); - const response = unwrap$(doResult); - - const [result$] = await m$.match< - components.LinkedUserResponse, - SDKError | SDKValidationError - >( - m$.json(200, components.LinkedUserResponse$inboundSchema), - m$.fail(["4XX", "5XX"]) - )(response); - - return unwrap$(result$); - } -} diff --git a/src/sdk/linkedusers.ts b/src/sdk/linkedusers.ts index 02c89607..140bc5cf 100644 --- a/src/sdk/linkedusers.ts +++ b/src/sdk/linkedusers.ts @@ -2,7 +2,11 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ -import { encodeJSON as encodeJSON$ } from "../lib/encodings.js"; +import { + encodeFormQuery as encodeFormQuery$, + encodeJSON as encodeJSON$, + encodeSimple as encodeSimple$, +} from "../lib/encodings.js"; import * as m$ from "../lib/matchers.js"; import * as schemas$ from "../lib/schemas.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; @@ -11,28 +15,11 @@ import { pathToFunc } from "../lib/url.js"; import * as components from "../models/components/index.js"; import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; +import * as operations from "../models/operations/index.js"; import { unwrap as unwrap$ } from "../types/fp.js"; -import { Batch } from "./batch.js"; -import { Fromremoteid } from "./fromremoteid.js"; -import { Id } from "./id.js"; import * as z from "zod"; export class LinkedUsers extends ClientSDK { - private _batch?: Batch; - get batch(): Batch { - return (this._batch ??= new Batch(this.options$)); - } - - private _id?: Id; - get id(): Id { - return (this._id ??= new Id(this.options$)); - } - - private _fromremoteid?: Fromremoteid; - get fromremoteid(): Fromremoteid { - return (this._fromremoteid ??= new Fromremoteid(this.options$)); - } - /** * Create Linked Users */ @@ -149,4 +136,209 @@ export class LinkedUsers extends ClientSDK { return unwrap$(result$); } + + /** + * Add Batch Linked Users + */ + async importBatch( + request: components.CreateBatchLinkedUserDto, + options?: RequestOptions + ): Promise> { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => components.CreateBatchLinkedUserDto$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = encodeJSON$("body", payload$, { explode: true }); + + const path$ = pathToFunc("/linked_users/batch")(); + + const headers$ = new Headers({ + "Content-Type": "application/json", + Accept: "application/json", + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "importBatch", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "POST", + path: path$, + headers: headers$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + Array, + SDKError | SDKValidationError + >( + m$.json(201, z.array(components.LinkedUserResponse$inboundSchema)), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } + + /** + * Retrieve Linked Users + */ + async retrieve( + request: operations.RetrieveLinkedUserRequest, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => operations.RetrieveLinkedUserRequest$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = null; + + const pathParams$ = { + id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), + }; + + const path$ = pathToFunc("/linked_users/{id}")(pathParams$); + + const headers$ = new Headers({ + Accept: "application/json", + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "retrieveLinkedUser", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "GET", + path: path$, + headers: headers$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.LinkedUserResponse, + SDKError | SDKValidationError + >( + m$.json(200, components.LinkedUserResponse$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } + + /** + * Retrieve a Linked User From A Remote Id + */ + async remoteId( + request: operations.RemoteIdRequest, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => operations.RemoteIdRequest$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = null; + + const path$ = pathToFunc("/linked_users/fromRemoteId")(); + + const query$ = encodeFormQuery$({ + remoteId: payload$.remoteId, + }); + + const headers$ = new Headers({ + Accept: "application/json", + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "remoteId", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "GET", + path: path$, + headers: headers$, + query: query$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.LinkedUserResponse, + SDKError | SDKValidationError + >( + m$.json(200, components.LinkedUserResponse$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } } diff --git a/src/sdk/map.ts b/src/sdk/map.ts deleted file mode 100644 index 6c3ade07..00000000 --- a/src/sdk/map.ts +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { encodeJSON as encodeJSON$ } from "../lib/encodings.js"; -import * as m$ from "../lib/matchers.js"; -import * as schemas$ from "../lib/schemas.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { unwrap as unwrap$ } from "../types/fp.js"; - -export class Map extends ClientSDK { - /** - * Map Custom Field - */ - async map( - request: components.MapFieldToProviderDto, - options?: RequestOptions - ): Promise { - const input$ = request; - - const parsed$ = schemas$.safeParse( - input$, - (value$) => components.MapFieldToProviderDto$outboundSchema.parse(value$), - "Input validation failed" - ); - const payload$ = unwrap$(parsed$); - const body$ = encodeJSON$("body", payload$, { explode: true }); - - const path$ = pathToFunc("/field_mappings/map")(); - - const headers$ = new Headers({ - "Content-Type": "application/json", - Accept: "application/json", - }); - - const apiKey$ = await extractSecurity(this.options$.apiKey); - const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; - const context = { - operationID: "map", - oAuth2Scopes: [], - securitySource: this.options$.apiKey, - }; - const securitySettings$ = resolveGlobalSecurity(security$); - - const requestRes$ = this.createRequest$( - context, - { - security: securitySettings$, - method: "POST", - path: path$, - headers: headers$, - body: body$, - timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, - }, - options - ); - const request$ = unwrap$(requestRes$); - - const doResult = await this.do$(request$, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: options?.retries || this.options$.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }); - const response = unwrap$(doResult); - - const [result$] = await m$.match< - components.CustomFieldResponse, - SDKError | SDKValidationError - >( - m$.json(201, components.CustomFieldResponse$inboundSchema), - m$.fail(["4XX", "5XX"]) - )(response); - - return unwrap$(result$); - } -} diff --git a/src/sdk/tickets.ts b/src/sdk/tickets.ts index ce34938b..434d4567 100644 --- a/src/sdk/tickets.ts +++ b/src/sdk/tickets.ts @@ -2,6 +2,7 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ +import { dlv } from "../lib/dlv.js"; import { encodeFormQuery as encodeFormQuery$, encodeJSON as encodeJSON$, @@ -17,6 +18,7 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { unwrap as unwrap$ } from "../types/fp.js"; +import { createPageIterator, PageIterator, Paginator } from "../types/operations.js"; export class Tickets extends ClientSDK { /** @@ -25,7 +27,7 @@ export class Tickets extends ClientSDK { async list( request: operations.ListTicketingTicketRequest, options?: RequestOptions - ): Promise { + ): Promise> { const input$ = request; const parsed$ = schemas$.safeParse( @@ -85,15 +87,39 @@ export class Tickets extends ClientSDK { }); const response = unwrap$(doResult); - const [result$] = await m$.match< - operations.ListTicketingTicketResponseBody, + const responseFields$ = { + HttpMeta: { Response: response, Request: request$ }, + }; + + const [result$, raw$] = await m$.match< + operations.ListTicketingTicketResponse, SDKError | SDKValidationError >( - m$.json(200, operations.ListTicketingTicketResponseBody$inboundSchema), + m$.json(200, operations.ListTicketingTicketResponse$inboundSchema, { key: "Result" }), m$.fail(["4XX", "5XX"]) - )(response); + )(response, { extraFields: responseFields$ }); + + const nextFunc = ( + responseData: unknown + ): Paginator => { + const nextCursor = dlv(responseData, "next_cursor"); + + if (nextCursor == null) { + return () => null; + } + + return () => + this.list( + { + ...input$, + cursor: nextCursor, + }, + options + ); + }; - return unwrap$(result$); + const page$ = { ...unwrap$(result$), next: nextFunc(raw$) }; + return { ...page$, ...createPageIterator(page$, !result$.ok) }; } /**