diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index a0fa176a..1761b4cb 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,20 +1,20 @@ lockVersion: 2.0.0 id: caaaa8c3-6dd7-43a5-841e-c3193e68cc73 management: - docChecksum: 48ac6f67817965485d3501a5755fd4a6 + docChecksum: 124c1a4b77042f351cfd73fe0c3e5ac7 docVersion: "1.0" - speakeasyVersion: 1.366.0 - generationVersion: 2.396.0 - releaseVersion: 0.11.0 - configChecksum: 6c261756723602ccee557c16cdd8bcba + speakeasyVersion: 1.379.0 + generationVersion: 2.404.3 + releaseVersion: 0.12.0 + configChecksum: 07abd4346da89750c2377416f5799a45 repoURL: https://github.com/panoratech/typescript-sdk.git installationURL: https://github.com/panoratech/typescript-sdk published: true features: typescript: additionalDependencies: 0.1.0 - constsAndDefaults: 0.1.7 - core: 3.13.1 + constsAndDefaults: 0.1.11 + core: 3.14.1 defaultEnabledRetries: 0.1.0 envVarSecurityUsage: 0.1.1 globalSecurity: 2.82.11 @@ -1238,7 +1238,9 @@ generatedFiles: - docs/models/operations/remoteidrequest.md - docs/models/operations/getpanoracoreeventsrequest.md - docs/models/operations/requestrequest.md + - docs/models/operations/requestpassthroughresponsebody.md - docs/models/operations/requestresponsebody.md + - docs/models/operations/requestresponse.md - docs/models/operations/getretriedrequestresponserequest.md - docs/models/operations/listhrisbankinforequest.md - docs/models/operations/listhrisbankinforesponsebody.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 22bdc589..6f70b6b5 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.11.0 + version: 0.12.0 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index a9159a87..08b28ddd 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.366.0 +speakeasyVersion: 1.379.0 sources: panora-open-api-swagger: sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:0db8ab701ce7dd81f348b36d0adbdc7d7ad5708b004bed009ee414f0c796fc6b - sourceBlobDigest: sha256:132b52765c782c8d45dc35538b7792f878d777d3ad53af0272e423f5dddcf0b5 + sourceRevisionDigest: sha256:5f6278743ec5995469d41f144fd0e03f697266ee2d5fdc75b85de4502a055f56 + sourceBlobDigest: sha256:705b0127a8913a33f01a2d96901af5f10583aba93a6040902467f9e784956383 tags: - latest - main @@ -11,10 +11,10 @@ targets: my-first-target: source: panora-open-api-swagger sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:0db8ab701ce7dd81f348b36d0adbdc7d7ad5708b004bed009ee414f0c796fc6b - sourceBlobDigest: sha256:132b52765c782c8d45dc35538b7792f878d777d3ad53af0272e423f5dddcf0b5 + sourceRevisionDigest: sha256:5f6278743ec5995469d41f144fd0e03f697266ee2d5fdc75b85de4502a055f56 + sourceBlobDigest: sha256:705b0127a8913a33f01a2d96901af5f10583aba93a6040902467f9e784956383 codeSamplesNamespace: code-samples-typescript-my-first-target - codeSamplesRevisionDigest: sha256:ac7e50977ee0f9d2a68f0b9e0d3793f7cbc75d9f1d380a72bab1f50549ca0077 + codeSamplesRevisionDigest: sha256:f4b5135747535e718cd28fe13995abb5d18796c15b5419f6c8ca769c22486edc outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/README.md b/README.md index 3c3d28d8..8bc97c34 100644 --- a/README.md +++ b/README.md @@ -1159,7 +1159,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). ## Debugging -To log HTTP requests and responses, you can pass a logger that matches `console`'s interface as an SDK option. +You can setup your SDK to emit debug logs for SDK requests and responses. + +You can pass a logger that matches `console`'s interface as an SDK option. > [!WARNING] > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. diff --git a/RELEASES.md b/RELEASES.md index 5a980753..a96904a1 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -198,4 +198,14 @@ Based on: ### Generated - [typescript v0.11.0] . ### Releases -- [NPM v0.11.0] https://www.npmjs.com/package/@panora/sdk/v/0.11.0 - . \ No newline at end of file +- [NPM v0.11.0] https://www.npmjs.com/package/@panora/sdk/v/0.11.0 - . + +## 2024-08-26 20:04:19 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.379.0 (2.404.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.12.0] . +### Releases +- [NPM v0.12.0] https://www.npmjs.com/package/@panora/sdk/v/0.12.0 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index 3a34e14b..ef8dbcef 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -3,11 +3,17 @@ info: title: CodeSamples overlay for typescript target version: 0.0.0 actions: - - target: $["paths"]["/crm/engagements/{id}"]["get"] + - target: $["paths"]["/field_mappings/values"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmEngagement + label: getFieldMappingValues + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappingValues();\n\n \n}\n\nrun();" + - target: $["paths"]["/hris/employeepayrollruns"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; @@ -16,22 +22,24 @@ actions: }); async function run() { - const result = await panora.crm.engagements.retrieve({ + const result = await panora.hris.employeepayrollruns.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"]["/marketingautomation/campaigns"]["post"] + - target: $["paths"]["/marketingautomation/automations"]["post"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationCampaign + label: createMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; @@ -40,10 +48,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.create({ + const result = await panora.marketingautomation.automations.create({ xConnectionToken: "", remoteData: false, - unifiedMarketingautomationCampaignInput: {}, + unifiedMarketingautomationAutomationInput: {}, }); // Handle the result @@ -51,11 +59,11 @@ actions: } run(); - - target: $["paths"]["/ats/candidates"]["get"] + - target: $["paths"]["/ats/applications/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsCandidate + label: retrieveAtsApplication source: |- import { Panora } from "@panora/sdk"; @@ -64,30 +72,22 @@ actions: }); async function run() { - const result = await panora.ats.candidates.list({ + const result = await panora.ats.applications.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } 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 email: \"Oda.Treutel97@hotmail.com\",\n passwordHash: \"\",\n });\n\n \n}\n\nrun();" - - target: $["paths"]["/crm/engagements"]["get"] + - target: $["paths"]["/accounting/invoices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmEngagements + label: retrieveAccountingInvoice source: |- import { Panora } from "@panora/sdk"; @@ -96,48 +96,71 @@ actions: }); async function run() { - const result = await panora.crm.engagements.list({ + const result = await panora.accounting.invoices.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/crm/tasks"]["post"] + - target: $["paths"]["/hris/employees"]["post"] update: x-codeSamples: - lang: typescript - label: createCrmTask + label: createHrisEmployee source: |- import { Panora } from "@panora/sdk"; - import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; + import { + UnifiedHrisEmployeeInputEmploymentStatus, + UnifiedHrisEmployeeInputEthnicity, + UnifiedHrisEmployeeInputGender, + UnifiedHrisEmployeeInputMaritalStatus, + } 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.employees.create({ 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", + unifiedHrisEmployeeInput: { + groups: [ + "Group1", + "Group2", + ], + locations: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + employeeNumber: "EMP001", companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeInputGender.Male, + ethnicity: UnifiedHrisEmployeeInputEthnicity.AmericanIndianOrAlaskaNative, + maritalStatus: UnifiedHrisEmployeeInputMaritalStatus.MarriedFilingSeparately, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: UnifiedHrisEmployeeInputEmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, }, }); @@ -146,11 +169,11 @@ actions: } run(); - - target: $["paths"]["/hris/employees/{id}"]["get"] + - target: $["paths"]["/accounting/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployee + label: retrieveAccountingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -159,7 +182,7 @@ actions: }); async function run() { - const result = await panora.hris.employees.retrieve({ + const result = await panora.accounting.attachments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -170,23 +193,58 @@ actions: } run(); - - target: $["paths"]["/hris/employments/{id}"]["get"] + - target: $["paths"]["/accounting/journalentries"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployment + label: createAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAccountingJournalentryInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.hris.employments.retrieve({ + const result = await panora.accounting.journalentries.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingJournalentryInput: { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: [ + "payment1", + "payment2", + ], + appliedPayments: [ + "appliedPayment1", + "appliedPayment2", + ], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryInputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, }); // Handle the result @@ -194,11 +252,11 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts/{id}"]["get"] + - target: $["paths"]["/ecommerce/products"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingContact + label: listEcommerceProducts source: |- import { Panora } from "@panora/sdk"; @@ -207,22 +265,24 @@ actions: }); async function run() { - const result = await panora.accounting.contacts.retrieve({ + const result = await panora.ecommerce.products.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"]["/ats/jobs"]["get"] + - target: $["paths"]["/linked_users/batch"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsJob + label: importBatch source: |- import { Panora } from "@panora/sdk"; @@ -231,72 +291,35 @@ actions: }); async function run() { - const result = await panora.ats.jobs.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + const result = await panora.linkedUsers.importBatch({ + linkedUserOriginIds: [ + "id_1", + ], + alias: "acme", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/accounting/invoices"]["post"] + - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingInvoice + label: retrieveMarketingautomationTemplate source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingInvoiceInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.invoices.create({ + const result = await panora.marketingautomation.templates.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedAccountingInvoiceInput: { - type: "Sales", - number: "INV-001", - issueDate: new Date("2024-06-15T12:00:00Z"), - dueDate: new Date("2024-07-15T12:00:00Z"), - paidOnDate: new Date("2024-07-10T12:00:00Z"), - memo: "Payment for services rendered", - currency: UnifiedAccountingInvoiceInputCurrency.Usd, - exchangeRate: "1.2", - totalDiscount: 1000, - subTotal: 10000, - status: "Paid", - totalTaxAmount: 1000, - totalAmount: 11000, - balance: 0, - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - trackingCategories: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - lineItems: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "report_item_1234", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, - }, }); // Handle the result @@ -304,54 +327,23 @@ actions: } run(); - - target: $["paths"]["/ecommerce/orders"]["post"] + - target: $["paths"]["/ats/scorecards/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createEcommerceOrder + label: retrieveAtsScorecard source: |- import { Panora } from "@panora/sdk"; - import { - UnifiedEcommerceOrderInputCurrency, - UnifiedEcommerceOrderInputFulfillmentStatus, - UnifiedEcommerceOrderInputOrderStatus, - UnifiedEcommerceOrderInputPaymentStatus, - } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ecommerce.orders.create({ + const result = await panora.ats.scorecards.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedEcommerceOrderInput: { - orderStatus: UnifiedEcommerceOrderInputOrderStatus.Unshipped, - orderNumber: "19823838833", - paymentStatus: UnifiedEcommerceOrderInputPaymentStatus.Success, - currency: UnifiedEcommerceOrderInputCurrency.Aud, - totalPrice: 300, - totalDiscount: 10, - totalShipping: 120, - totalTax: 120, - fulfillmentStatus: UnifiedEcommerceOrderInputFulfillmentStatus.Pending, - customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - items: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "12345", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, - }, }); // Handle the result @@ -359,11 +351,11 @@ actions: } run(); - - target: $["paths"]["/crm/companies/{id}"]["get"] + - target: $["paths"]["/webhooks"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmCompany + label: createWebhookPublic source: |- import { Panora } from "@panora/sdk"; @@ -372,10 +364,12 @@ actions: }); async function run() { - const result = await panora.crm.companies.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + const result = await panora.webhooks.create({ + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", + scope: [ + "connection.created", + ], }); // Handle the result @@ -383,37 +377,11 @@ actions: } run(); - - target: $["paths"]["/ats/users"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listAtsUsers - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.ats.users.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); - - for await (const page of result) { - // handle page - } - } - - run(); - - target: $["paths"]["/ats/applications"]["get"] + - target: $["paths"]["/ticketing/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsApplication + label: retrieveTicketingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -422,24 +390,22 @@ actions: }); async function run() { - const result = await panora.ats.applications.list({ + const result = await panora.ticketing.attachments.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/crm/notes/{id}"]["get"] + - target: $["paths"]["/ats/departments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmNote + label: retrieveAtsDepartment source: |- import { Panora } from "@panora/sdk"; @@ -448,7 +414,7 @@ actions: }); async function run() { - const result = await panora.crm.notes.retrieve({ + const result = await panora.ats.departments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -459,17 +425,11 @@ actions: } run(); - - target: $["paths"]["/field_mappings/attributes"]["get"] - update: - x-codeSamples: - - lang: typescript - label: getFieldMappings - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappings();\n\n \n}\n\nrun();" - - target: $["paths"]["/hris/benefits"]["get"] + - target: $["paths"]["/hris/timesheetentries/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisBenefits + label: retrieveHrisTimesheetentry source: |- import { Panora } from "@panora/sdk"; @@ -478,36 +438,70 @@ actions: }); async function run() { - const result = await panora.hris.benefits.list({ + const result = await panora.hris.timesheetentries.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] + - target: $["paths"]["/accounting/invoices"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationList + label: createAccountingInvoice source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAccountingInvoiceInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.marketingautomation.lists.retrieve({ + const result = await panora.accounting.invoices.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingInvoiceInput: { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceInputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, }); // Handle the result @@ -515,35 +509,23 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["post"] + - target: $["paths"]["/accounting/payments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsActivity + label: retrieveAccountingPayment 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.accounting.payments.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", 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", - }, - }, }); // Handle the result @@ -551,11 +533,11 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] + - target: $["paths"]["/hris/paygroups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingIncomeStatement + label: retrieveHrisPaygroup source: |- import { Panora } from "@panora/sdk"; @@ -564,7 +546,7 @@ actions: }); async function run() { - const result = await panora.accounting.incomestatements.retrieve({ + const result = await panora.hris.paygroups.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -575,11 +557,11 @@ actions: } run(); - - target: $["paths"]["/connections"]["get"] + - target: $["paths"]["/marketingautomation/campaigns"]["post"] update: x-codeSamples: - lang: typescript - label: getConnections + label: createMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; @@ -588,18 +570,22 @@ actions: }); async function run() { - const result = await panora.connections.getConnections(); + const result = await panora.marketingautomation.campaigns.create({ + xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationCampaignInput: {}, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/linked_users/fromRemoteId"]["get"] + - target: $["paths"]["/marketingautomation/lists"]["get"] update: x-codeSamples: - lang: typescript - label: remoteId + label: listMarketingautomationLists source: |- import { Panora } from "@panora/sdk"; @@ -608,20 +594,24 @@ actions: }); async function run() { - const result = await panora.linkedUsers.remoteId({ - remoteId: "id_1", + const result = await panora.marketingautomation.lists.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(); - - target: $["paths"]["/ats/applications/{id}"]["get"] + - target: $["paths"]["/accounting/payments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsApplication + label: listAccountingPayment source: |- import { Panora } from "@panora/sdk"; @@ -630,22 +620,24 @@ actions: }); async function run() { - const result = await panora.ats.applications.retrieve({ + const result = await panora.accounting.payments.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"]["/ats/rejectreasons/{id}"]["get"] + - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsRejectReason + label: retrieveAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; @@ -654,7 +646,7 @@ actions: }); async function run() { - const result = await panora.ats.rejectreasons.retrieve({ + const result = await panora.ats.jobinterviewstages.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -665,11 +657,11 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts"]["get"] + - target: $["paths"]["/crm/users"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAccounts + label: listCrmUsers source: |- import { Panora } from "@panora/sdk"; @@ -678,7 +670,7 @@ actions: }); async function run() { - const result = await panora.accounting.accounts.list({ + const result = await panora.crm.users.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -691,11 +683,17 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets/{id}"]["get"] + - target: $["paths"]["/field_mappings/attributes"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTicket + label: getFieldMappings + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappings();\n\n \n}\n\nrun();" + - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveMarketingautomationEmail source: |- import { Panora } from "@panora/sdk"; @@ -704,7 +702,7 @@ actions: }); async function run() { - const result = await panora.ticketing.tickets.retrieve({ + const result = await panora.marketingautomation.emails.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -715,36 +713,61 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["post"] + - target: $["paths"]["/ats/activities"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsInterview + label: listAtsActivity 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.ats.activities.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); + + for await (const page of result) { + // handle page + } + } + + run(); + - target: $["paths"]["/ats/applications"]["post"] + update: + x-codeSamples: + - lang: typescript + label: createAtsApplication + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ats.applications.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: [ + 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", ], - 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"), + 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", @@ -757,11 +780,11 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] + - target: $["paths"]["/ticketing/tags/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTrackingCategory + label: retrieveTicketingTag source: |- import { Panora } from "@panora/sdk"; @@ -770,7 +793,7 @@ actions: }); async function run() { - const result = await panora.accounting.trackingcategories.retrieve({ + const result = await panora.ticketing.tags.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -781,11 +804,11 @@ actions: } run(); - - target: $["paths"]["/ats/eeocs"]["get"] + - target: $["paths"]["/ats/departments"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsEeocs + label: listAtsDepartments source: |- import { Panora } from "@panora/sdk"; @@ -794,7 +817,7 @@ actions: }); async function run() { - const result = await panora.ats.eeocs.list({ + const result = await panora.ats.departments.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -807,11 +830,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/teams"]["get"] + - target: $["paths"]["/accounting/vendorcredits"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTeams + label: listAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; @@ -820,7 +843,7 @@ actions: }); async function run() { - const result = await panora.ticketing.teams.list({ + const result = await panora.accounting.vendorcredits.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -833,11 +856,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments"]["post"] + - target: $["paths"]["/hris/bankinfos"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingAttachment + label: listHrisBankInfo source: |- import { Panora } from "@panora/sdk"; @@ -846,31 +869,24 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.create({ + const result = await panora.hris.bankinfos.list({ 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", - }, - }, + 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"]["/hris/payrollruns/{id}"]["get"] + - target: $["paths"]["/ats/interviews/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisPayrollRun + label: retrieveAtsInterview source: |- import { Panora } from "@panora/sdk"; @@ -879,7 +895,7 @@ actions: }); async function run() { - const result = await panora.hris.payrollruns.retrieve({ + const result = await panora.ats.interviews.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -890,17 +906,18 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["post"] + - target: $["paths"]["/ecommerce/orders"]["post"] update: x-codeSamples: - lang: typescript - label: createHrisTimeoff + label: createEcommerceOrder source: |- import { Panora } from "@panora/sdk"; import { - UnifiedHrisTimeoffInputRequestType, - UnifiedHrisTimeoffInputStatus, - UnifiedHrisTimeoffInputUnits, + UnifiedEcommerceOrderInputCurrency, + UnifiedEcommerceOrderInputFulfillmentStatus, + UnifiedEcommerceOrderInputOrderStatus, + UnifiedEcommerceOrderInputPaymentStatus, } from "@panora/sdk/models/components"; const panora = new Panora({ @@ -908,18 +925,33 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.create({ + const result = await panora.ecommerce.orders.create({ xConnectionToken: "", - unifiedHrisTimeoffInput: { - employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - status: UnifiedHrisTimeoffInputStatus.Requested, - employeeNote: "Annual vacation", - units: UnifiedHrisTimeoffInputUnits.Days, - amount: 5, - requestType: UnifiedHrisTimeoffInputRequestType.Vacation, - startTime: new Date("2024-07-01T09:00:00Z"), - endTime: new Date("2024-07-05T17:00:00Z"), + remoteData: false, + unifiedEcommerceOrderInput: { + orderStatus: UnifiedEcommerceOrderInputOrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: UnifiedEcommerceOrderInputPaymentStatus.Success, + currency: UnifiedEcommerceOrderInputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: UnifiedEcommerceOrderInputFulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], fieldMappings: {}, }, }); @@ -929,11 +961,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationCampaign + label: retrieveMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -942,7 +974,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.retrieve({ + const result = await panora.marketingautomation.actions.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -953,11 +985,11 @@ actions: } run(); - - target: $["paths"]["/linked_users"]["post"] + - target: $["paths"]["/filestorage/folders"]["get"] update: x-codeSamples: - lang: typescript - label: createLinkedUser + label: listFilestorageFolder source: |- import { Panora } from "@panora/sdk"; @@ -966,45 +998,47 @@ actions: }); async function run() { - const result = await panora.linkedUsers.create({ - linkedUserOriginId: "id_1", - alias: "acme", + const result = await panora.filestorage.folders.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(); - - target: $["paths"]["/accounting/accounts"]["post"] + - target: $["paths"]["/ats/activities"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingAccount + label: createAtsActivity source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingAccountInputCurrency } 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.accounting.accounts.create({ + const result = await panora.ats.activities.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingAccountInput: { - name: "Cash", - description: "Main cash account for daily operations", - classification: "Asset", - type: "Current Asset", - status: "Active", - currentBalance: 10000, - currency: UnifiedAccountingAccountInputCurrency.Usd, - accountNumber: "1000", - parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: {}, + 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", + }, }, }); @@ -1013,23 +1047,35 @@ actions: } run(); - - target: $["paths"]["/filestorage/files/{id}"]["get"] + - target: $["paths"]["/accounting/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFile + label: createAccountingContact source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAccountingContactInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.filestorage.files.retrieve({ + const result = await panora.accounting.contacts.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedAccountingContactInput: { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactInputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, }); // Handle the result @@ -1037,11 +1083,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/fulfillments"]["get"] + - target: $["paths"]["/accounting/taxrates"]["get"] update: x-codeSamples: - lang: typescript - label: listEcommerceFulfillments + label: listAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; @@ -1050,7 +1096,7 @@ actions: }); async function run() { - const result = await panora.ecommerce.fulfillments.list({ + const result = await panora.accounting.taxrates.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1063,11 +1109,11 @@ actions: } run(); - - target: $["paths"]["/crm/tasks"]["get"] + - target: $["paths"]["/webhooks/{id}"]["delete"] update: x-codeSamples: - lang: typescript - label: listCrmTask + label: delete source: |- import { Panora } from "@panora/sdk"; @@ -1076,24 +1122,20 @@ actions: }); async function run() { - const result = await panora.crm.tasks.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + const result = await panora.webhooks.delete({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/hris/companies"]["get"] + - target: $["paths"]["/ticketing/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisCompanies + label: listTicketingAttachments source: |- import { Panora } from "@panora/sdk"; @@ -1102,7 +1144,7 @@ actions: }); async function run() { - const result = await panora.hris.companies.list({ + const result = await panora.ticketing.attachments.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1115,11 +1157,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions"]["get"] + - target: $["paths"]["/crm/engagements"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAction + label: listCrmEngagements source: |- import { Panora } from "@panora/sdk"; @@ -1128,7 +1170,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.actions.list({ + const result = await panora.crm.engagements.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1141,11 +1183,11 @@ actions: } run(); - - target: $["paths"]["/ats/attachments/{id}"]["get"] + - target: $["paths"]["/hris/bankinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsAttachment + label: retrieveHrisBankInfo source: |- import { Panora } from "@panora/sdk"; @@ -1154,7 +1196,7 @@ actions: }); async function run() { - const result = await panora.ats.attachments.retrieve({ + const result = await panora.hris.bankinfos.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1165,11 +1207,11 @@ actions: } run(); - - target: $["paths"]["/ats/offices/{id}"]["get"] + - target: $["paths"]["/marketingautomation/campaigns"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffice + label: listMarketingautomationCampaigns source: |- import { Panora } from "@panora/sdk"; @@ -1178,22 +1220,24 @@ actions: }); async function run() { - const result = await panora.ats.offices.retrieve({ + const result = await panora.marketingautomation.campaigns.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"]["/ats/eeocs/{id}"]["get"] + - target: $["paths"]["/filestorage/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsEeocs + label: retrieveFilestorageUser source: |- import { Panora } from "@panora/sdk"; @@ -1202,9 +1246,10 @@ actions: }); async function run() { - const result = await panora.ats.eeocs.retrieve({ + const result = await panora.filestorage.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1212,11 +1257,11 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes"]["get"] + - target: $["paths"]["/hris/employerbenefits"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCreditNote + label: listHrisEmployerBenefits source: |- import { Panora } from "@panora/sdk"; @@ -1225,7 +1270,7 @@ actions: }); async function run() { - const result = await panora.accounting.creditnotes.list({ + const result = await panora.hris.employerbenefits.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1238,11 +1283,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/orders"]["get"] + - target: $["paths"]["/accounting/journalentries/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listEcommerceOrders + label: retrieveAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; @@ -1251,7 +1296,31 @@ actions: }); async function run() { - const result = await panora.ecommerce.orders.list({ + const result = await panora.accounting.journalentries.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/filestorage/files"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listFilestorageFile + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.filestorage.files.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1264,11 +1333,17 @@ actions: } run(); - - target: $["paths"]["/ecommerce/fulfillments/{id}"]["get"] + - target: $["paths"]["/auth/login"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveEcommerceFulfillment + 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 email: \"Oda.Treutel97@hotmail.com\",\n passwordHash: \"\",\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/ticketing/collections"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listTicketingCollections source: |- import { Panora } from "@panora/sdk"; @@ -1277,21 +1352,24 @@ actions: }); async function run() { - const result = await panora.ecommerce.fulfillments.retrieve({ + const result = await panora.ticketing.collections.list({ xConnectionToken: "", - id: "", + 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"]["/ats/tags"]["get"] + - target: $["paths"]["/ats/offers"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsTags + label: listAtsOffer source: |- import { Panora } from "@panora/sdk"; @@ -1300,7 +1378,7 @@ actions: }); async function run() { - const result = await panora.ats.tags.list({ + const result = await panora.ats.offers.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1313,11 +1391,11 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates/{id}"]["get"] + - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTaxRate + label: retrieveMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; @@ -1326,7 +1404,7 @@ actions: }); async function run() { - const result = await panora.accounting.taxrates.retrieve({ + const result = await panora.marketingautomation.automations.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1337,11 +1415,11 @@ actions: } run(); - - target: $["paths"]["/health"]["get"] + - target: $["paths"]["/accounting/companyinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: health + label: retrieveAccountingCompanyInfo source: |- import { Panora } from "@panora/sdk"; @@ -1350,68 +1428,34 @@ actions: }); async function run() { - const result = await panora.health(); + const result = await panora.accounting.companyinfos.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/employees"]["post"] + - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createHrisEmployee + label: retrieveMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; - import { - UnifiedHrisEmployeeInputEmploymentStatus, - UnifiedHrisEmployeeInputEthnicity, - UnifiedHrisEmployeeInputGender, - UnifiedHrisEmployeeInputMaritalStatus, - } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.hris.employees.create({ + const result = await panora.marketingautomation.contacts.retrieve({ xConnectionToken: "", - unifiedHrisEmployeeInput: { - groups: [ - "Group1", - "Group2", - ], - locations: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - employeeNumber: "EMP001", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - firstName: "John", - lastName: "Doe", - preferredName: "Johnny", - displayFullName: "John Doe", - username: "johndoe", - workEmail: "john.doe@company.com", - personalEmail: "john.doe@personal.com", - mobilePhoneNumber: "+1234567890", - employments: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - ssn: "123-45-6789", - gender: UnifiedHrisEmployeeInputGender.Male, - ethnicity: UnifiedHrisEmployeeInputEthnicity.AmericanIndianOrAlaskaNative, - maritalStatus: UnifiedHrisEmployeeInputMaritalStatus.MarriedFilingSeparately, - dateOfBirth: new Date("1990-01-01"), - startDate: new Date("2020-01-01"), - employmentStatus: UnifiedHrisEmployeeInputEmploymentStatus.Active, - terminationDate: new Date("2025-01-01"), - avatarUrl: "https://example.com/avatar.jpg", - managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: {}, - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1419,11 +1463,11 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] + - target: $["paths"]["/filestorage/files/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployerBenefit + label: retrieveFilestorageFile source: |- import { Panora } from "@panora/sdk"; @@ -1432,7 +1476,7 @@ actions: }); async function run() { - const result = await panora.hris.employerbenefits.retrieve({ + const result = await panora.filestorage.files.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1443,23 +1487,34 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] + - target: $["paths"]["/ticketing/comments"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAction + 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.marketingautomation.actions.retrieve({ + const result = await panora.ticketing.comments.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + 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 @@ -1467,11 +1522,11 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards"]["get"] + - target: $["paths"]["/linked_users/fromRemoteId"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsScorecard + label: remoteId source: |- import { Panora } from "@panora/sdk"; @@ -1480,24 +1535,20 @@ actions: }); async function run() { - const result = await panora.ats.scorecards.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + const result = await panora.linkedUsers.remoteId({ + remoteId: "id_1", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/hris/groups"]["get"] + - target: $["paths"]["/hris/dependents"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisGroups + label: listHrisDependents source: |- import { Panora } from "@panora/sdk"; @@ -1506,7 +1557,7 @@ actions: }); async function run() { - const result = await panora.hris.groups.list({ + const result = await panora.hris.dependents.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1519,11 +1570,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["get"] + - target: $["paths"]["/hris/employees"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAutomations + label: listHrisEmployees source: |- import { Panora } from "@panora/sdk"; @@ -1532,7 +1583,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.list({ + const result = await panora.hris.employees.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1545,11 +1596,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users/{id}"]["get"] + - target: $["paths"]["/hris/employments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationUser + label: retrieveHrisEmployment source: |- import { Panora } from "@panora/sdk"; @@ -1558,7 +1609,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.users.retrieve({ + const result = await panora.hris.employments.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1569,11 +1620,11 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] + - target: $["paths"]["/accounting/items"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCashflowStatement + label: listAccountingItem source: |- import { Panora } from "@panora/sdk"; @@ -1582,22 +1633,24 @@ actions: }); async function run() { - const result = await panora.accounting.cashflowstatements.retrieve({ + const result = await panora.accounting.items.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/payments/{id}"]["get"] + - target: $["paths"]["/accounting/trackingcategories"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPayment + label: listAccountingTrackingCategorys source: |- import { Panora } from "@panora/sdk"; @@ -1606,22 +1659,24 @@ actions: }); async function run() { - const result = await panora.accounting.payments.retrieve({ + const result = await panora.accounting.trackingcategories.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"]["/marketingautomation/events"]["get"] + - target: $["paths"]["/accounting/transactions"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationEvents + label: listAccountingTransaction source: |- import { Panora } from "@panora/sdk"; @@ -1630,7 +1685,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.events.list({ + const result = await panora.accounting.transactions.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1643,11 +1698,11 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] + - target: $["paths"]["/ticketing/teams/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPurchaseOrder + label: retrieveTicketingTeam source: |- import { Panora } from "@panora/sdk"; @@ -1656,7 +1711,7 @@ actions: }); async function run() { - const result = await panora.accounting.purchaseorders.retrieve({ + const result = await panora.ticketing.teams.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1667,11 +1722,11 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories"]["get"] + - target: $["paths"]["/projects"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingTrackingCategorys + label: createProject source: |- import { Panora } from "@panora/sdk"; @@ -1680,24 +1735,22 @@ actions: }); async function run() { - const result = await panora.accounting.trackingcategories.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + const result = await panora.projects.create({ + name: "Project Name", + idOrganization: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + idUser: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ticketing/contacts"]["get"] + - target: $["paths"]["/hris/timeoffs"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingContacts + label: listHrisTimeoffs source: |- import { Panora } from "@panora/sdk"; @@ -1706,7 +1759,7 @@ actions: }); async function run() { - const result = await panora.ticketing.contacts.list({ + const result = await panora.hris.timeoffs.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1719,11 +1772,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments/{id}"]["get"] + - target: $["paths"]["/ats/offers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAttachment + label: retrieveAtsOffer source: |- import { Panora } from "@panora/sdk"; @@ -1732,7 +1785,7 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.retrieve({ + const result = await panora.ats.offers.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1743,17 +1796,35 @@ actions: } run(); - - target: $["paths"]["/sync/status/{vertical}"]["get"] + - target: $["paths"]["/ats/rejectreasons/{id}"]["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"]["/crm/companies"]["get"] + label: retrieveAtsRejectReason + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ats.rejectreasons.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/hris/timeoffs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmCompany + label: retrieveHrisTimeoff source: |- import { Panora } from "@panora/sdk"; @@ -1762,41 +1833,33 @@ actions: }); async function run() { - const result = await panora.crm.companies.list({ + const result = await panora.hris.timeoffs.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/field_mappings"]["post"] + - target: $["paths"]["/ticketing/comments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: defineCustomField + label: retrieveTicketingComment 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.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.ticketing.comments.retrieve({ + xConnectionToken: "", + id: "", }); // Handle the result @@ -1804,11 +1867,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/drives"]["get"] + - target: $["paths"]["/crm/notes"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageDrives + label: listCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -1817,7 +1880,7 @@ actions: }); async function run() { - const result = await panora.filestorage.drives.list({ + const result = await panora.crm.notes.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1830,11 +1893,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/users"]["get"] + - target: $["paths"]["/hris/timesheetentries"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageUsers + label: listHrisTimesheetentries source: |- import { Panora } from "@panora/sdk"; @@ -1843,7 +1906,7 @@ actions: }); async function run() { - const result = await panora.filestorage.users.list({ + const result = await panora.hris.timesheetentries.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1856,11 +1919,11 @@ actions: } run(); - - target: $["paths"]["/hris/dependents"]["get"] + - target: $["paths"]["/accounting/addresses"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisDependents + label: listAccountingAddress source: |- import { Panora } from "@panora/sdk"; @@ -1869,7 +1932,7 @@ actions: }); async function run() { - const result = await panora.hris.dependents.list({ + const result = await panora.accounting.addresses.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -1882,11 +1945,11 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits"]["get"] + - target: $["paths"]["/projects"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployerBenefits + label: getProjects source: |- import { Panora } from "@panora/sdk"; @@ -1895,24 +1958,18 @@ actions: }); async function run() { - const result = await panora.hris.employerbenefits.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); + const result = await panora.projects.getProjects(); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/hris/employments"]["get"] + - target: $["paths"]["/hris/benefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployments + label: retrieveHrisBenefit source: |- import { Panora } from "@panora/sdk"; @@ -1921,24 +1978,22 @@ actions: }); async function run() { - const result = await panora.hris.employments.list({ + const result = await panora.hris.benefits.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] + - target: $["paths"]["/crm/deals/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPhonenumber + label: retrieveCrmDeal source: |- import { Panora } from "@panora/sdk"; @@ -1947,7 +2002,7 @@ actions: }); async function run() { - const result = await panora.accounting.phonenumbers.retrieve({ + const result = await panora.crm.deals.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1958,11 +2013,11 @@ actions: } run(); - - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] + - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingVendorCredit + label: retrieveMarketingautomationList source: |- import { Panora } from "@panora/sdk"; @@ -1971,7 +2026,7 @@ actions: }); async function run() { - const result = await panora.accounting.vendorcredits.retrieve({ + const result = await panora.marketingautomation.lists.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -1982,11 +2037,11 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["get"] + - target: $["paths"]["/ats/jobinterviewstages"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsActivity + label: listAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; @@ -1995,7 +2050,7 @@ actions: }); async function run() { - const result = await panora.ats.activities.list({ + const result = await panora.ats.jobinterviewstages.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2008,11 +2063,11 @@ actions: } run(); - - target: $["paths"]["/"]["get"] + - target: $["paths"]["/accounting/balancesheets"]["get"] update: x-codeSamples: - lang: typescript - label: hello + label: listAccountingBalanceSheets source: |- import { Panora } from "@panora/sdk"; @@ -2021,74 +2076,35 @@ actions: }); async function run() { - const result = await panora.hello(); + const result = await panora.accounting.balancesheets.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(); - - target: $["paths"]["/ats/candidates"]["post"] + - target: $["paths"]["/ticketing/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsCandidate + label: retrieveTicketingContact 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.ticketing.contacts.retrieve({ 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", - }, - }, + id: "", }); // Handle the result @@ -2096,11 +2112,11 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements"]["get"] + - target: $["paths"]["/ats/jobs"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingIncomeStatement + label: listAtsJob source: |- import { Panora } from "@panora/sdk"; @@ -2109,7 +2125,7 @@ actions: }); async function run() { - const result = await panora.accounting.incomestatements.list({ + const result = await panora.ats.jobs.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2122,11 +2138,11 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["get"] + - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingJournalEntry + label: retrieveAccountingTrackingCategory source: |- import { Panora } from "@panora/sdk"; @@ -2135,64 +2151,46 @@ actions: }); async function run() { - const result = await panora.accounting.journalentries.list({ + const result = await panora.accounting.trackingcategories.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/crm/contacts"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listCrmContacts - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.crm.contacts.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); - - for await (const page of result) { - // handle page - } - } - - run(); - - target: $["paths"]["/passthrough"]["post"] + - target: $["paths"]["/filestorage/folders"]["post"] update: x-codeSamples: - lang: typescript - label: request + label: createFilestorageFolder 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({ + const result = await panora.filestorage.folders.create({ xConnectionToken: "", - passThroughRequestDto: { - method: PassThroughRequestDtoMethod.Get, - path: "/dev", + 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", + }, }, }); @@ -2201,11 +2199,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates"]["get"] + - target: $["paths"]["/crm/companies"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationTemplates + label: listCrmCompany source: |- import { Panora } from "@panora/sdk"; @@ -2214,7 +2212,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.templates.list({ + const result = await panora.crm.companies.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2227,11 +2225,11 @@ actions: } run(); - - target: $["paths"]["/ats/jobs/{id}"]["get"] + - target: $["paths"]["/filestorage/drives/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJob + label: retrieveFilestorageDrive source: |- import { Panora } from "@panora/sdk"; @@ -2240,7 +2238,7 @@ actions: }); async function run() { - const result = await panora.ats.jobs.retrieve({ + const result = await panora.filestorage.drives.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2251,11 +2249,11 @@ actions: } run(); - - target: $["paths"]["/linked_users"]["get"] + - target: $["paths"]["/ticketing/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: listLinkedUsers + label: createTicketingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -2264,18 +2262,31 @@ actions: }); async function run() { - const result = await panora.linkedUsers.list(); + 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 console.log(result) } run(); - - target: $["paths"]["/crm/deals"]["get"] + - target: $["paths"]["/marketingautomation/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: listCrmDeals + label: createMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; @@ -2284,24 +2295,22 @@ actions: }); async function run() { - const result = await panora.crm.deals.list({ + const result = await panora.marketingautomation.contacts.create({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + remoteData: false, + unifiedMarketingautomationContactInput: {}, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ats/activities/{id}"]["get"] + - target: $["paths"]["/marketingautomation/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsActivity + label: retrieveMarketingAutomationUser source: |- import { Panora } from "@panora/sdk"; @@ -2310,7 +2319,7 @@ actions: }); async function run() { - const result = await panora.ats.activities.retrieve({ + const result = await panora.marketingautomation.users.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2321,11 +2330,11 @@ actions: } run(); - - target: $["paths"]["/webhooks/{id}"]["put"] + - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: updateStatus + label: retrieveAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; @@ -2334,8 +2343,10 @@ actions: }); async function run() { - const result = await panora.webhooks.updateStatus({ + const result = await panora.accounting.vendorcredits.retrieve({ + xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2343,11 +2354,11 @@ actions: } run(); - - target: $["paths"]["/hris/groups/{id}"]["get"] + - target: $["paths"]["/"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisGroup + label: hello source: |- import { Panora } from "@panora/sdk"; @@ -2356,22 +2367,18 @@ actions: }); async function run() { - const result = await panora.hris.groups.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); + const result = await panora.hello(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ats/interviews/{id}"]["get"] + - target: $["paths"]["/hris/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsInterview + label: retrieveHrisGroup source: |- import { Panora } from "@panora/sdk"; @@ -2380,7 +2387,7 @@ actions: }); async function run() { - const result = await panora.ats.interviews.retrieve({ + const result = await panora.hris.groups.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2391,11 +2398,11 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts/{id}"]["get"] + - target: $["paths"]["/crm/stages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAccount + label: retrieveCrmStage source: |- import { Panora } from "@panora/sdk"; @@ -2404,7 +2411,7 @@ actions: }); async function run() { - const result = await panora.accounting.accounts.retrieve({ + const result = await panora.crm.stages.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2415,11 +2422,17 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] + - target: $["paths"]["/field_mappings/entities"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCreditNote + label: getFieldMappingsEntities + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappingsEntities();\n\n \n}\n\nrun();" + - target: $["paths"]["/hris/benefits"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listHrisBenefits source: |- import { Panora } from "@panora/sdk"; @@ -2428,22 +2441,24 @@ actions: }); async function run() { - const result = await panora.accounting.creditnotes.retrieve({ + const result = await panora.hris.benefits.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"]["/ticketing/comments/{id}"]["get"] + - target: $["paths"]["/ats/activities/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingComment + label: retrieveAtsActivity source: |- import { Panora } from "@panora/sdk"; @@ -2452,9 +2467,10 @@ actions: }); async function run() { - const result = await panora.ticketing.comments.retrieve({ + const result = await panora.ats.activities.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2462,11 +2478,11 @@ actions: } run(); - - target: $["paths"]["/crm/contacts/{id}"]["get"] + - target: $["paths"]["/accounting/creditnotes"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmContact + label: listAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; @@ -2475,22 +2491,24 @@ actions: }); async function run() { - const result = await panora.crm.contacts.retrieve({ + const result = await panora.accounting.creditnotes.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"]["/hris/benefits/{id}"]["get"] + - target: $["paths"]["/filestorage/drives"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBenefit + label: listFilestorageDrives source: |- import { Panora } from "@panora/sdk"; @@ -2499,48 +2517,61 @@ actions: }); async function run() { - const result = await panora.hris.benefits.retrieve({ + const result = await panora.filestorage.drives.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/expenses"]["get"] + - target: $["paths"]["/crm/tasks"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingExpense + 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.accounting.expenses.list({ + const result = await panora.crm.tasks.create({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + 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", + }, + }, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ticketing/collections/{id}"]["get"] + - target: $["paths"]["/hris/dependents/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCollection + label: retrieveHrisDependent source: |- import { Panora } from "@panora/sdk"; @@ -2549,7 +2580,7 @@ actions: }); async function run() { - const result = await panora.ticketing.collections.retrieve({ + const result = await panora.hris.dependents.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2560,11 +2591,11 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates"]["get"] + - target: $["paths"]["/ats/users"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTaxRate + label: listAtsUsers source: |- import { Panora } from "@panora/sdk"; @@ -2573,7 +2604,7 @@ actions: }); async function run() { - const result = await panora.accounting.taxrates.list({ + const result = await panora.ats.users.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2586,11 +2617,11 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements"]["get"] + - target: $["paths"]["/accounting/companyinfos"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCashflowStatement + label: listAccountingCompanyInfos source: |- import { Panora } from "@panora/sdk"; @@ -2599,7 +2630,7 @@ actions: }); async function run() { - const result = await panora.accounting.cashflowstatements.list({ + const result = await panora.accounting.companyinfos.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2612,11 +2643,11 @@ actions: } run(); - - target: $["paths"]["/accounting/vendorcredits"]["get"] + - target: $["paths"]["/ticketing/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingVendorCredit + label: listTicketingAccount source: |- import { Panora } from "@panora/sdk"; @@ -2625,7 +2656,7 @@ actions: }); async function run() { - const result = await panora.accounting.vendorcredits.list({ + const result = await panora.ticketing.accounts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2638,11 +2669,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns"]["get"] + - target: $["paths"]["/hris/paygroups"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationCampaigns + label: listHrisPaygroups source: |- import { Panora } from "@panora/sdk"; @@ -2651,7 +2682,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.campaigns.list({ + const result = await panora.hris.paygroups.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2664,23 +2695,25 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] + - target: $["paths"]["/field_mappings/define"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationTemplate + 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.marketingautomation.templates.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + const result = await panora.fieldMappings.definitions({ + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, }); // Handle the result @@ -2688,37 +2721,40 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["get"] + - target: $["paths"]["/field_mappings"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsAttachment + 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.ats.attachments.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + 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", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/accounting/companyinfos"]["get"] + - target: $["paths"]["/ats/tags"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCompanyInfos + label: listAtsTags source: |- import { Panora } from "@panora/sdk"; @@ -2727,7 +2763,7 @@ actions: }); async function run() { - const result = await panora.accounting.companyinfos.list({ + const result = await panora.ats.tags.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2740,23 +2776,56 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders/{id}"]["get"] + - target: $["paths"]["/crm/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFolder + 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.filestorage.folders.retrieve({ + const result = await panora.crm.contacts.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedCrmContactInput: { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Jena.Nienow28@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2764,37 +2833,11 @@ actions: } run(); - - target: $["paths"]["/hris/locations"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listHrisLocations - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.hris.locations.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); - - for await (const page of result) { - // handle page - } - } - - run(); - - target: $["paths"]["/marketingautomation/contacts"]["get"] + - target: $["paths"]["/field_mappings/map"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationContacts + label: map source: |- import { Panora } from "@panora/sdk"; @@ -2803,24 +2846,23 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + const result = await panora.fieldMappings.map({ + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ats/tags/{id}"]["get"] + - target: $["paths"]["/ecommerce/products/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsTag + label: retrieveEcommerceProduct source: |- import { Panora } from "@panora/sdk"; @@ -2829,10 +2871,9 @@ actions: }); async function run() { - const result = await panora.ats.tags.retrieve({ + const result = await panora.ecommerce.products.retrieve({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + id: "", }); // Handle the result @@ -2840,11 +2881,11 @@ actions: } run(); - - target: $["paths"]["/webhooks"]["post"] + - target: $["paths"]["/ecommerce/orders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createWebhookPublic + label: retrieveEcommerceOrder source: |- import { Panora } from "@panora/sdk"; @@ -2853,12 +2894,9 @@ 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.ecommerce.orders.retrieve({ + xConnectionToken: "", + id: "", }); // Handle the result @@ -2866,11 +2904,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments"]["get"] + - target: $["paths"]["/ticketing/comments"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingAttachments + label: listTicketingComments source: |- import { Panora } from "@panora/sdk"; @@ -2879,7 +2917,7 @@ actions: }); async function run() { - const result = await panora.ticketing.attachments.list({ + const result = await panora.ticketing.comments.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2892,11 +2930,11 @@ actions: } run(); - - target: $["paths"]["/hris/timesheetentries/{id}"]["get"] + - target: $["paths"]["/hris/locations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimesheetentry + label: retrieveHrisLocation source: |- import { Panora } from "@panora/sdk"; @@ -2905,7 +2943,7 @@ actions: }); async function run() { - const result = await panora.hris.timesheetentries.retrieve({ + const result = await panora.hris.locations.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -2916,11 +2954,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages"]["get"] + - target: $["paths"]["/ats/interviews"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationMessages + label: listAtsInterview source: |- import { Panora } from "@panora/sdk"; @@ -2929,7 +2967,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.messages.list({ + const result = await panora.ats.interviews.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -2942,11 +2980,11 @@ actions: } run(); - - target: $["paths"]["/ats/applications"]["post"] + - target: $["paths"]["/accounting/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsApplication + label: retrieveAccountingAccount source: |- import { Panora } from "@panora/sdk"; @@ -2955,22 +2993,46 @@ actions: }); async function run() { - const result = await panora.ats.applications.create({ + const result = await panora.accounting.accounts.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedAtsApplicationInput: { - appliedAt: new Date("2024-10-01T12:00:00Z"), - rejectedAt: new Date("2024-10-01T12:00:00Z"), - offers: [ + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/crm/engagements"]["post"] + update: + x-codeSamples: + - lang: typescript + label: createCrmEngagement + 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({ + 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", - "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", @@ -2983,11 +3045,17 @@ actions: } run(); - - target: $["paths"]["/ats/offers"]["get"] + - target: $["paths"]["/passthrough/{retryId}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffer + label: getRetriedRequestResponse + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.passthrough.retryid.getRetriedRequestResponse({\n retryId: \"\",\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/crm/tasks"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listCrmTask source: |- import { Panora } from "@panora/sdk"; @@ -2996,7 +3064,7 @@ actions: }); async function run() { - const result = await panora.ats.offers.list({ + const result = await panora.crm.tasks.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3009,73 +3077,38 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices/{id}"]["get"] + - target: $["paths"]["/hris/timeoffs"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingInvoice + label: createHrisTimeoff source: |- import { Panora } from "@panora/sdk"; + import { + UnifiedHrisTimeoffInputRequestType, + UnifiedHrisTimeoffInputStatus, + UnifiedHrisTimeoffInputUnits, + } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.invoices.retrieve({ + const result = await panora.hris.timeoffs.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/sync/resync"]["post"] - update: - x-codeSamples: - - lang: typescript - label: resync - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.sync.resync(); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/passthrough/{retryId}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: getRetriedRequestResponse - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.passthrough.retryid.getRetriedRequestResponse({\n retryId: \"\",\n });\n\n \n}\n\nrun();" - - target: $["paths"]["/hris/paygroups/{id}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: retrieveHrisPaygroup - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.hris.paygroups.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + unifiedHrisTimeoffInput: { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffInputStatus.Requested, + employeeNote: "Annual vacation", + units: UnifiedHrisTimeoffInputUnits.Days, + amount: 5, + requestType: UnifiedHrisTimeoffInputRequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, + }, }); // Handle the result @@ -3083,11 +3116,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["post"] + - target: $["paths"]["/accounting/cashflowstatements"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationList + label: listAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; @@ -3096,21 +3129,24 @@ actions: }); async function run() { - const result = await panora.marketingautomation.lists.create({ + const result = await panora.accounting.cashflowstatements.list({ xConnectionToken: "", - unifiedMarketingautomationListInput: {}, + 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"]["/marketingautomation/templates"]["post"] + - target: $["paths"]["/accounting/purchaseorders"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationTemplate + label: listAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; @@ -3119,74 +3155,44 @@ actions: }); async function run() { - const result = await panora.marketingautomation.templates.create({ + const result = await panora.accounting.purchaseorders.list({ xConnectionToken: "", - unifiedMarketingautomationTemplateInput: {}, + 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/payments"]["post"] + - target: $["paths"]["/sync/resync"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingPayment + label: resync source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingPaymentInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.payments.create({ - xConnectionToken: "", - remoteData: false, - unifiedAccountingPaymentInput: { - invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - transactionDate: new Date("2024-06-15T12:00:00Z"), - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - currency: UnifiedAccountingPaymentInputCurrency.Usd, - exchangeRate: "1.2", - totalAmount: 10000, - type: "Credit Card", - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - trackingCategories: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - lineItems: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "report_item_1234", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, - }, - }); + const result = await panora.sync.resync(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/filestorage/users/{id}"]["get"] + - target: $["paths"]["/crm/tasks/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageUser + label: retrieveCrmTask source: |- import { Panora } from "@panora/sdk"; @@ -3195,7 +3201,7 @@ actions: }); async function run() { - const result = await panora.filestorage.users.retrieve({ + const result = await panora.crm.tasks.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3206,93 +3212,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["post"] - update: - x-codeSamples: - - lang: typescript - label: createFilestorageFile - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.filestorage.files.create({ - 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", - }, - }, - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/webhooks"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listWebhooks - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.webhooks.list(); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/ticketing/tickets"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listTicketingTicket - source: |- - 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(); - - target: $["paths"]["/ticketing/accounts"]["get"] + - target: $["paths"]["/accounting/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingAccount + label: listAccountingAccounts source: |- import { Panora } from "@panora/sdk"; @@ -3301,7 +3225,7 @@ actions: }); async function run() { - const result = await panora.ticketing.accounts.list({ + const result = await panora.accounting.accounts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3314,11 +3238,11 @@ actions: } run(); - - target: $["paths"]["/ats/offices"]["get"] + - target: $["paths"]["/ecommerce/orders"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffice + label: listEcommerceOrders source: |- import { Panora } from "@panora/sdk"; @@ -3327,7 +3251,7 @@ actions: }); async function run() { - const result = await panora.ats.offices.list({ + const result = await panora.ecommerce.orders.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3340,116 +3264,22 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["post"] - update: - x-codeSamples: - - lang: typescript - label: createAccountingJournalEntry - source: |- - import { Panora } from "@panora/sdk"; - import { UnifiedAccountingJournalentryInputCurrency } from "@panora/sdk/models/components"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.accounting.journalentries.create({ - xConnectionToken: "", - remoteData: false, - unifiedAccountingJournalentryInput: { - transactionDate: new Date("2024-06-15T12:00:00Z"), - payments: [ - "payment1", - "payment2", - ], - appliedPayments: [ - "appliedPayment1", - "appliedPayment2", - ], - memo: "Monthly expense journal entry", - currency: UnifiedAccountingJournalentryInputCurrency.Usd, - exchangeRate: "1.2", - idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - journalNumber: "JE-001", - trackingCategories: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - postingStatus: "Posted", - lineItems: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "report_item_1234", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, - }, - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/crm/companies"]["post"] + - target: $["paths"]["/ecommerce/fulfillments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmCompany + label: retrieveEcommerceFulfillment 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({ - 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: "Street 2", - city: "New York", - state: "NY", - postalCode: "10001", - country: "USA", - addressType: AddressType.Work, - ownerType: "", - }, - ], - phoneNumbers: [ - { - phoneNumber: "+33660606067", - phoneType: PhoneType.Work, - }, - ], - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ecommerce.fulfillments.retrieve({ + xConnectionToken: "", + id: "", }); // Handle the result @@ -3457,11 +3287,11 @@ actions: } run(); - - target: $["paths"]["/hris/bankinfos/{id}"]["get"] + - target: $["paths"]["/hris/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBankInfo + label: retrieveHrisCompany source: |- import { Panora } from "@panora/sdk"; @@ -3470,7 +3300,7 @@ actions: }); async function run() { - const result = await panora.hris.bankinfos.retrieve({ + const result = await panora.hris.companies.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3481,11 +3311,11 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["get"] + - target: $["paths"]["/hris/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsInterview + label: listHrisGroups source: |- import { Panora } from "@panora/sdk"; @@ -3494,7 +3324,7 @@ actions: }); async function run() { - const result = await panora.ats.interviews.list({ + const result = await panora.hris.groups.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3507,17 +3337,11 @@ actions: } run(); - - target: $["paths"]["/field_mappings/values"]["get"] - update: - x-codeSamples: - - lang: typescript - label: getFieldMappingValues - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappingValues();\n\n \n}\n\nrun();" - - target: $["paths"]["/hris/bankinfos"]["get"] + - target: $["paths"]["/marketingautomation/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisBankInfo + label: listMarketingAutomationContacts source: |- import { Panora } from "@panora/sdk"; @@ -3526,7 +3350,7 @@ actions: }); async function run() { - const result = await panora.hris.bankinfos.list({ + const result = await panora.marketingautomation.contacts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3539,11 +3363,11 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses/{id}"]["get"] + - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingExpense + label: retrieveAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; @@ -3552,7 +3376,7 @@ actions: }); async function run() { - const result = await panora.accounting.expenses.retrieve({ + const result = await panora.accounting.cashflowstatements.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3563,54 +3387,34 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["post"] + - target: $["paths"]["/filestorage/files"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingPurchaseOrder + label: createFilestorageFile source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingPurchaseorderInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.purchaseorders.create({ + const result = await panora.filestorage.files.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingPurchaseorderInput: { - status: "Pending", - issueDate: new Date("2024-06-15T12:00:00Z"), - purchaseOrderNumber: "PO-001", - deliveryDate: new Date("2024-07-15T12:00:00Z"), - deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - memo: "Purchase order for Q3 inventory", - companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - totalAmount: 100000, - currency: UnifiedAccountingPurchaseorderInputCurrency.Usd, - exchangeRate: "1.2", - trackingCategories: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - lineItems: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "report_item_1234", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, + 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", + }, }, }); @@ -3619,40 +3423,45 @@ actions: } run(); - - target: $["paths"]["/ecommerce/products"]["post"] + - target: $["paths"]["/webhooks/{id}"]["put"] update: x-codeSamples: - lang: typescript - label: createEcommerceProduct + label: updateStatus source: |- import { Panora } from "@panora/sdk"; - import { UnifiedEcommerceProductInputProductStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ecommerce.products.create({ + const result = await panora.webhooks.updateStatus({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/ticketing/users/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveTicketingUser + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ticketing.users.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedEcommerceProductInput: { - productUrl: "https://product_url/tee", - productType: "teeshirt", - productStatus: UnifiedEcommerceProductInputProductStatus.Active, - imagesUrls: [ - "https://myproduct/image", - ], - description: "best tee ever", - vendor: "vendor_extern", - variants: [ - {}, - ], - tags: [ - "tag_1", - ], - fieldMappings: {}, - }, }); // Handle the result @@ -3660,11 +3469,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["post"] + - target: $["paths"]["/crm/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAutomation + label: retrieveCrmContact source: |- import { Panora } from "@panora/sdk"; @@ -3673,10 +3482,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.create({ + const result = await panora.crm.contacts.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedMarketingautomationAutomationInput: {}, }); // Handle the result @@ -3684,11 +3493,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/products"]["get"] + - target: $["paths"]["/ats/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listEcommerceProducts + label: retrieveAtsAttachment source: |- import { Panora } from "@panora/sdk"; @@ -3697,7 +3506,31 @@ actions: }); async function run() { - const result = await panora.ecommerce.products.list({ + const result = await panora.ats.attachments.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/accounting/invoices"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listAccountingInvoice + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.accounting.invoices.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3710,11 +3543,11 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] + - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployeePayrollRun + label: retrieveHrisTimeoffbalance source: |- import { Panora } from "@panora/sdk"; @@ -3723,7 +3556,7 @@ actions: }); async function run() { - const result = await panora.hris.employeepayrollruns.retrieve({ + const result = await panora.hris.timeoffbalances.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3734,11 +3567,90 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries/{id}"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["post"] + update: + x-codeSamples: + - lang: typescript + label: createMarketingautomationTemplate + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.marketingautomation.templates.create({ + xConnectionToken: "", + unifiedMarketingautomationTemplateInput: {}, + }); + + // 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"; + import { UnifiedAccountingPurchaseorderInputCurrency } from "@panora/sdk/models/components"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.accounting.purchaseorders.create({ + xConnectionToken: "", + remoteData: false, + unifiedAccountingPurchaseorderInput: { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderInputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/crm/engagements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingJournalEntry + label: retrieveCrmEngagement source: |- import { Panora } from "@panora/sdk"; @@ -3747,7 +3659,7 @@ actions: }); async function run() { - const result = await panora.accounting.journalentries.retrieve({ + const result = await panora.crm.engagements.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3758,11 +3670,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["get"] + - target: $["paths"]["/hris/companies"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFolder + label: listHrisCompanies source: |- import { Panora } from "@panora/sdk"; @@ -3771,7 +3683,7 @@ actions: }); async function run() { - const result = await panora.filestorage.folders.list({ + const result = await panora.hris.companies.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3784,35 +3696,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/tags/{id}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: retrieveTicketingTag - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.ticketing.tags.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/accounting/phonenumbers"]["get"] + - target: $["paths"]["/accounting/expenses"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPhonenumber + label: listAccountingExpense source: |- import { Panora } from "@panora/sdk"; @@ -3821,7 +3709,7 @@ actions: }); async function run() { - const result = await panora.accounting.phonenumbers.list({ + const result = await panora.accounting.expenses.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -3834,11 +3722,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] + - target: $["paths"]["/accounting/taxrates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationMessage + label: retrieveAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; @@ -3847,7 +3735,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.messages.retrieve({ + const result = await panora.accounting.taxrates.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3858,11 +3746,11 @@ actions: } run(); - - target: $["paths"]["/ats/candidates/{id}"]["get"] + - target: $["paths"]["/ticketing/tags"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsCandidate + label: listTicketingTags source: |- import { Panora } from "@panora/sdk"; @@ -3871,22 +3759,24 @@ actions: }); async function run() { - const result = await panora.ats.candidates.retrieve({ + const result = await panora.ticketing.tags.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"]["/webhooks/verifyEvent"]["post"] + - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: verifyEvent + label: retrieveMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; @@ -3895,12 +3785,10 @@ actions: }); async function run() { - const result = await panora.webhooks.verifyEvent({ - payload: { - "key": "", - }, - signature: "", - secret: "", + const result = await panora.marketingautomation.campaigns.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3908,23 +3796,67 @@ actions: } run(); - - target: $["paths"]["/ticketing/teams/{id}"]["get"] + - target: $["paths"]["/ats/candidates"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTeam + 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.ticketing.teams.retrieve({ + const result = await panora.ats.candidates.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", 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", + }, + }, }); // Handle the result @@ -3932,11 +3864,11 @@ actions: } run(); - - target: $["paths"]["/ats/offers/{id}"]["get"] + - target: $["paths"]["/ats/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffer + label: retrieveAtsUser source: |- import { Panora } from "@panora/sdk"; @@ -3945,7 +3877,7 @@ actions: }); async function run() { - const result = await panora.ats.offers.retrieve({ + const result = await panora.ats.users.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -3956,37 +3888,11 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts"]["get"] - update: - x-codeSamples: - - lang: typescript - label: listAccountingContacts - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.accounting.contacts.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); - - for await (const page of result) { - // handle page - } - } - - run(); - - target: $["paths"]["/filestorage/groups"]["get"] + - target: $["paths"]["/ats/eeocs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageGroup + label: retrieveAtsEeocs source: |- import { Panora } from "@panora/sdk"; @@ -3995,24 +3901,21 @@ actions: }); async function run() { - const result = await panora.filestorage.groups.list({ + const result = await panora.ats.eeocs.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "", }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/marketingautomation/contacts"]["post"] + - target: $["paths"]["/connections"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingAutomationContact + label: getConnections source: |- import { Panora } from "@panora/sdk"; @@ -4021,22 +3924,18 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.create({ - xConnectionToken: "", - remoteData: false, - unifiedMarketingautomationContactInput: {}, - }); + const result = await panora.connections.getConnections(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ats/users/{id}"]["get"] + - target: $["paths"]["/ecommerce/customers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsUser + label: retrieveEcommerceCustomer source: |- import { Panora } from "@panora/sdk"; @@ -4045,10 +3944,9 @@ actions: }); async function run() { - const result = await panora.ats.users.retrieve({ + const result = await panora.ecommerce.customers.retrieve({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + id: "", }); // Handle the result @@ -4056,11 +3954,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/groups/{id}"]["get"] + - target: $["paths"]["/health"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageGroup + label: health source: |- import { Panora } from "@panora/sdk"; @@ -4069,22 +3967,18 @@ actions: }); async function run() { - const result = await panora.filestorage.groups.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); + const result = await panora.health(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/paygroups"]["get"] + - target: $["paths"]["/ticketing/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisPaygroups + label: listTicketingContacts source: |- import { Panora } from "@panora/sdk"; @@ -4093,7 +3987,7 @@ actions: }); async function run() { - const result = await panora.hris.paygroups.list({ + const result = await panora.ticketing.contacts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4106,11 +4000,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["get"] + - target: $["paths"]["/hris/locations"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFile + label: listHrisLocations source: |- import { Panora } from "@panora/sdk"; @@ -4119,7 +4013,7 @@ actions: }); async function run() { - const result = await panora.filestorage.files.list({ + const result = await panora.hris.locations.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4132,40 +4026,23 @@ actions: } run(); - - target: $["paths"]["/crm/engagements"]["post"] + - target: $["paths"]["/hris/payrollruns/{id}"]["get"] update: - x-codeSamples: - - lang: typescript - label: createCrmEngagement - 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({ - 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", - }, - }, + x-codeSamples: + - lang: typescript + label: retrieveHrisPayrollRun + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.hris.payrollruns.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4173,11 +4050,11 @@ actions: } run(); - - target: $["paths"]["/crm/notes"]["get"] + - target: $["paths"]["/accounting/expenses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmNote + label: retrieveAccountingExpense source: |- import { Panora } from "@panora/sdk"; @@ -4186,24 +4063,22 @@ actions: }); async function run() { - const result = await panora.crm.notes.list({ + const result = await panora.accounting.expenses.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] + - target: $["paths"]["/crm/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEmail + label: retrieveCrmUser source: |- import { Panora } from "@panora/sdk"; @@ -4212,10 +4087,10 @@ actions: }); async function run() { - const result = await panora.marketingautomation.emails.retrieve({ + const result = await panora.crm.users.retrieve({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, }); // Handle the result @@ -4223,11 +4098,11 @@ actions: } run(); - - target: $["paths"]["/ats/departments"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsDepartments + label: listMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -4236,7 +4111,7 @@ actions: }); async function run() { - const result = await panora.ats.departments.list({ + const result = await panora.marketingautomation.actions.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4249,11 +4124,11 @@ actions: } run(); - - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] + - target: $["paths"]["/accounting/addresses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJobInterviewStage + label: retrieveAccountingAddress source: |- import { Panora } from "@panora/sdk"; @@ -4262,7 +4137,7 @@ actions: }); async function run() { - const result = await panora.ats.jobinterviewstages.retrieve({ + const result = await panora.accounting.addresses.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4273,33 +4148,50 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts"]["post"] + - target: $["paths"]["/accounting/expenses"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingContact + label: createAccountingExpense source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingContactInputCurrency } from "@panora/sdk/models/components"; + import { UnifiedAccountingExpenseInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.contacts.create({ + const result = await panora.accounting.expenses.create({ xConnectionToken: "", remoteData: false, - unifiedAccountingContactInput: { - name: "John Doe", - isSupplier: true, - isCustomer: false, - emailAddress: "john.doe@example.com", - taxNumber: "123456789", - status: "Active", - currency: UnifiedAccountingContactInputCurrency.Usd, - remoteUpdatedAt: "2024-06-15T12:00:00Z", + unifiedAccountingExpenseInput: { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseInputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], fieldMappings: {}, }, }); @@ -4309,11 +4201,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs/{id}"]["get"] + - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoff + label: retrieveAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; @@ -4322,7 +4214,7 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.retrieve({ + const result = await panora.accounting.purchaseorders.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4333,11 +4225,11 @@ actions: } run(); - - target: $["paths"]["/hris/timesheetentries"]["get"] + - target: $["paths"]["/ticketing/collections/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimesheetentries + label: retrieveCollection source: |- import { Panora } from "@panora/sdk"; @@ -4346,24 +4238,22 @@ actions: }); async function run() { - const result = await panora.hris.timesheetentries.list({ + const result = await panora.ticketing.collections.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/accounting/invoices"]["get"] + - target: $["paths"]["/linked_users"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingInvoice + label: createLinkedUser source: |- import { Panora } from "@panora/sdk"; @@ -4372,7 +4262,30 @@ actions: }); async function run() { - const result = await panora.accounting.invoices.list({ + const result = await panora.linkedUsers.create({ + linkedUserOriginId: "id_1", + alias: "acme", + }); + + // Handle the result + console.log(result) + } + + 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: "", remoteData: true, limit: 10, @@ -4385,11 +4298,11 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions"]["get"] + - target: $["paths"]["/filestorage/users"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTransaction + label: listFilestorageUsers source: |- import { Panora } from "@panora/sdk"; @@ -4398,7 +4311,7 @@ actions: }); async function run() { - const result = await panora.accounting.transactions.list({ + const result = await panora.filestorage.users.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4411,11 +4324,11 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards/{id}"]["get"] + - target: $["paths"]["/ats/candidates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsScorecard + label: retrieveAtsCandidate source: |- import { Panora } from "@panora/sdk"; @@ -4424,7 +4337,7 @@ actions: }); async function run() { - const result = await panora.ats.scorecards.retrieve({ + const result = await panora.ats.candidates.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4435,11 +4348,11 @@ actions: } run(); - - target: $["paths"]["/accounting/items"]["get"] + - target: $["paths"]["/accounting/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingItem + label: createAccountingAttachment source: |- import { Panora } from "@panora/sdk"; @@ -4448,24 +4361,27 @@ actions: }); async function run() { - const result = await panora.accounting.items.list({ + const result = await panora.accounting.attachments.create({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + remoteData: false, + unifiedAccountingAttachmentInput: { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/accounting/payments"]["get"] + - target: $["paths"]["/webhooks"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPayment + label: listWebhooks source: |- import { Panora } from "@panora/sdk"; @@ -4474,24 +4390,18 @@ actions: }); async function run() { - const result = await panora.accounting.payments.list({ - xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", - }); + const result = await panora.webhooks.list(); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/crm/notes"]["post"] + - target: $["paths"]["/ticketing/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmNote + label: retrieveTicketingAccount source: |- import { Panora } from "@panora/sdk"; @@ -4500,20 +4410,9 @@ actions: }); async function run() { - const result = await panora.crm.notes.create({ + const result = await panora.ticketing.accounts.retrieve({ 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", - }, - }, + id: "", }); // Handle the result @@ -4521,11 +4420,17 @@ actions: } run(); - - target: $["paths"]["/linked_users/batch"]["post"] + - target: $["paths"]["/sync/status/{vertical}"]["get"] update: x-codeSamples: - lang: typescript - label: importBatch + 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"]["/events"]["get"] + update: + x-codeSamples: + - lang: typescript + label: getPanoraCoreEvents source: |- import { Panora } from "@panora/sdk"; @@ -4534,49 +4439,44 @@ actions: }); async function run() { - const result = await panora.linkedUsers.importBatch({ - linkedUserOriginIds: [ - "id_1", - ], - alias: "acme", - }); + const result = await panora.events.getPanoraCoreEvents({}); // Handle the result console.log(result) } run(); - - target: $["paths"]["/field_mappings/define"]["post"] + - target: $["paths"]["/marketingautomation/messages"]["get"] update: x-codeSamples: - lang: typescript - label: definitions + label: listMarketingautomationMessages 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.definitions({ - objectTypeOwner: ObjectTypeOwner.Company, - name: "fav_dish", - description: "My favorite dish", - dataType: DataType.String, + const result = await panora.marketingautomation.messages.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(); - - target: $["paths"]["/field_mappings/map"]["post"] + - target: $["paths"]["/hris/employments"]["get"] update: x-codeSamples: - lang: typescript - label: map + label: listHrisEmployments source: |- import { Panora } from "@panora/sdk"; @@ -4585,15 +4485,16 @@ actions: }); 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", + const result = await panora.hris.employments.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(); @@ -4623,11 +4524,11 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions/{id}"]["get"] + - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTransaction + label: retrieveAccountingBalanceSheet source: |- import { Panora } from "@panora/sdk"; @@ -4636,7 +4537,7 @@ actions: }); async function run() { - const result = await panora.accounting.transactions.retrieve({ + const result = await panora.accounting.balancesheets.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4647,11 +4548,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users"]["get"] + - target: $["paths"]["/ats/candidates"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationUsers + label: listAtsCandidate source: |- import { Panora } from "@panora/sdk"; @@ -4660,7 +4561,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.users.list({ + const result = await panora.ats.candidates.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4673,75 +4574,52 @@ actions: } run(); - - target: $["paths"]["/ats/departments/{id}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: retrieveAtsDepartment - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.ats.departments.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/crm/contacts"]["post"] + - target: $["paths"]["/crm/companies"]["post"] update: x-codeSamples: - lang: typescript - label: createCrmContact + label: createCrmCompany source: |- import { Panora } from "@panora/sdk"; - import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; + import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.crm.contacts.create({ + const result = await panora.crm.companies.create({ xConnectionToken: "", remoteData: false, - unifiedCrmContactInput: { - firstName: "John", - lastName: "Doe", + unifiedCrmCompanyInput: { + name: "Acme", + industry: UnifiedCrmCompanyInputIndustry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", emailAddresses: [ { - emailAddress: "Jena.Nienow28@yahoo.com", - emailAddressType: EmailAddressType.Personal, - }, - ], - phoneNumbers: [ - { - phoneNumber: "", - phoneType: PhoneType.Work, + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, }, ], addresses: [ { street1: "5th Avenue", street2: "Street 2", - city: "Anytown", - state: "CA", + city: "New York", + state: "NY", postalCode: "10001", country: "USA", - addressType: AddressType.Personal, + addressType: AddressType.Work, ownerType: "", }, ], - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], fieldMappings: { "fav_dish": "broccoli", "fav_color": "red", @@ -4754,11 +4632,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["get"] + - target: $["paths"]["/crm/deals"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationLists + label: listCrmDeals source: |- import { Panora } from "@panora/sdk"; @@ -4767,7 +4645,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.lists.list({ + const result = await panora.crm.deals.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4780,11 +4658,11 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["post"] + - target: $["paths"]["/linked_users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createFilestorageFolder + label: retrieveLinkedUser source: |- import { Panora } from "@panora/sdk"; @@ -4793,23 +4671,8 @@ actions: }); async function run() { - const result = await panora.filestorage.folders.create({ - 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", - }, - }, + const result = await panora.linkedUsers.retrieve({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -4817,11 +4680,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments"]["get"] + - target: $["paths"]["/ats/offices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingComments + label: retrieveAtsOffice source: |- import { Panora } from "@panora/sdk"; @@ -4830,24 +4693,22 @@ actions: }); async function run() { - const result = await panora.ticketing.comments.list({ + const result = await panora.ats.offices.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ticketing/tags"]["get"] + - target: $["paths"]["/ats/scorecards"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTags + label: listAtsScorecard source: |- import { Panora } from "@panora/sdk"; @@ -4856,7 +4717,7 @@ actions: }); async function run() { - const result = await panora.ticketing.tags.list({ + const result = await panora.ats.scorecards.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -4869,11 +4730,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] + - target: $["paths"]["/crm/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoffbalance + label: retrieveCrmCompany source: |- import { Panora } from "@panora/sdk"; @@ -4882,7 +4743,7 @@ actions: }); async function run() { - const result = await panora.hris.timeoffbalances.retrieve({ + const result = await panora.crm.companies.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4893,11 +4754,11 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments/{id}"]["get"] + - target: $["paths"]["/crm/stages"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAttachment + label: listCrmStages source: |- import { Panora } from "@panora/sdk"; @@ -4906,22 +4767,24 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.retrieve({ + const result = await panora.crm.stages.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/companyinfos/{id}"]["get"] + - target: $["paths"]["/ats/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCompanyInfo + label: listAtsAttachment source: |- import { Panora } from "@panora/sdk"; @@ -4930,7 +4793,33 @@ actions: }); async function run() { - const result = await panora.accounting.companyinfos.retrieve({ + const result = await panora.ats.attachments.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); + + for await (const page of result) { + // handle page + } + } + + run(); + - target: $["paths"]["/ats/tags/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveAtsTag + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ats.tags.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4941,11 +4830,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] + - target: $["paths"]["/crm/notes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationContact + label: retrieveCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -4954,7 +4843,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.contacts.retrieve({ + const result = await panora.crm.notes.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -4965,11 +4854,11 @@ actions: } run(); - - target: $["paths"]["/accounting/balancesheets"]["get"] + - target: $["paths"]["/hris/timesheetentries"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingBalanceSheets + label: createHrisTimesheetentry source: |- import { Panora } from "@panora/sdk"; @@ -4978,24 +4867,28 @@ actions: }); async function run() { - const result = await panora.accounting.balancesheets.list({ + const result = await panora.hris.timesheetentries.create({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + unifiedHrisTimesheetEntryInput: { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, + }, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ecommerce/products/{id}"]["get"] + - target: $["paths"]["/marketingautomation/events/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveEcommerceProduct + label: retrieveMarketingautomationEvent source: |- import { Panora } from "@panora/sdk"; @@ -5004,9 +4897,10 @@ actions: }); async function run() { - const result = await panora.ecommerce.products.retrieve({ + const result = await panora.marketingautomation.events.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5014,11 +4908,11 @@ actions: } run(); - - target: $["paths"]["/accounting/addresses/{id}"]["get"] + - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAddress + label: retrieveHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; @@ -5027,7 +4921,7 @@ actions: }); async function run() { - const result = await panora.accounting.addresses.retrieve({ + const result = await panora.hris.employeepayrollruns.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -5038,11 +4932,11 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["get"] + - target: $["paths"]["/hris/employees/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPurchaseOrder + label: retrieveHrisEmployee source: |- import { Panora } from "@panora/sdk"; @@ -5051,24 +4945,22 @@ actions: }); async function run() { - const result = await panora.accounting.purchaseorders.list({ + const result = await panora.hris.employees.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/linked_users/{id}"]["get"] + - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveLinkedUser + label: retrieveHrisEmployerBenefit source: |- import { Panora } from "@panora/sdk"; @@ -5077,8 +4969,10 @@ actions: }); async function run() { - const result = await panora.linkedUsers.retrieve({ + const result = await panora.hris.employerbenefits.retrieve({ + xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5086,17 +4980,11 @@ actions: } run(); - - target: $["paths"]["/field_mappings/entities"]["get"] - update: - x-codeSamples: - - lang: typescript - label: getFieldMappingsEntities - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.fieldMappings.getFieldMappingsEntities();\n\n \n}\n\nrun();" - - target: $["paths"]["/accounting/attachments"]["post"] + - target: $["paths"]["/marketingautomation/lists"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingAttachment + label: createMarketingautomationList source: |- import { Panora } from "@panora/sdk"; @@ -5105,15 +4993,9 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.create({ + const result = await panora.marketingautomation.lists.create({ xConnectionToken: "", - remoteData: false, - unifiedAccountingAttachmentInput: { - fileName: "invoice.pdf", - fileUrl: "https://example.com/files/invoice.pdf", - accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - fieldMappings: {}, - }, + unifiedMarketingautomationListInput: {}, }); // Handle the result @@ -5121,11 +5003,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/users"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingUsers + label: listMarketingautomationTemplates source: |- import { Panora } from "@panora/sdk"; @@ -5134,7 +5016,7 @@ actions: }); async function run() { - const result = await panora.ticketing.users.list({ + const result = await panora.marketingautomation.templates.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5147,11 +5029,11 @@ actions: } run(); - - target: $["paths"]["/crm/deals/{id}"]["get"] + - target: $["paths"]["/accounting/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmDeal + label: retrieveAccountingContact source: |- import { Panora } from "@panora/sdk"; @@ -5160,7 +5042,7 @@ actions: }); async function run() { - const result = await panora.crm.deals.retrieve({ + const result = await panora.accounting.contacts.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -5171,52 +5053,23 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses"]["post"] + - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingExpense + label: retrieveAccountingPhonenumber source: |- import { Panora } from "@panora/sdk"; - import { UnifiedAccountingExpenseInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.accounting.expenses.create({ + const result = await panora.accounting.phonenumbers.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedAccountingExpenseInput: { - transactionDate: new Date("2024-06-15T12:00:00Z"), - totalAmount: 10000, - subTotal: 9000, - totalTaxAmount: 1000, - currency: UnifiedAccountingExpenseInputCurrency.Usd, - exchangeRate: "1.2", - memo: "Business lunch with client", - accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - trackingCategories: [ - "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - ], - lineItems: [ - { - name: "Net Income", - value: 100000, - type: "Operating Activities", - parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteId: "report_item_1234", - remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), - companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - createdAt: new Date("2024-06-15T12:00:00Z"), - modifiedAt: new Date("2024-06-15T12:00:00Z"), - }, - ], - fieldMappings: {}, - }, }); // Handle the result @@ -5224,11 +5077,11 @@ actions: } run(); - - target: $["paths"]["/hris/employees"]["get"] + - target: $["paths"]["/crm/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployees + label: listCrmContacts source: |- import { Panora } from "@panora/sdk"; @@ -5237,7 +5090,7 @@ actions: }); async function run() { - const result = await panora.hris.employees.list({ + const result = await panora.crm.contacts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5250,11 +5103,11 @@ actions: } run(); - - target: $["paths"]["/hris/payrollruns"]["get"] + - target: $["paths"]["/hris/timeoffbalances"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisPayrollRuns + label: listHrisTimeoffbalances source: |- import { Panora } from "@panora/sdk"; @@ -5263,7 +5116,7 @@ actions: }); async function run() { - const result = await panora.hris.payrollruns.list({ + const result = await panora.hris.timeoffbalances.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5276,28 +5129,34 @@ actions: } run(); - - target: $["paths"]["/hris/timesheetentries"]["post"] + - target: $["paths"]["/ats/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: createHrisTimesheetentry + 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.hris.timesheetentries.create({ + const result = await panora.ats.attachments.create({ xConnectionToken: "", - unifiedHrisTimesheetEntryInput: { - hoursWorked: 40, - startTime: new Date("2024-10-01T08:00:00Z"), - endTime: new Date("2024-10-01T16:00:00Z"), - employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteWasDeleted: false, - fieldMappings: {}, + 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", + }, }, }); @@ -5306,11 +5165,11 @@ actions: } run(); - - target: $["paths"]["/accounting/addresses"]["get"] + - target: $["paths"]["/accounting/transactions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAddress + label: retrieveAccountingTransaction source: |- import { Panora } from "@panora/sdk"; @@ -5319,24 +5178,22 @@ actions: }); async function run() { - const result = await panora.accounting.addresses.list({ + const result = await panora.accounting.transactions.retrieve({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/ticketing/accounts/{id}"]["get"] + - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAccount + label: retrieveMarketingautomationMessage source: |- import { Panora } from "@panora/sdk"; @@ -5345,9 +5202,10 @@ actions: }); async function run() { - const result = await panora.ticketing.accounts.retrieve({ + const result = await panora.marketingautomation.messages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5355,11 +5213,11 @@ actions: } run(); - - target: $["paths"]["/crm/users"]["get"] + - target: $["paths"]["/accounting/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmUsers + label: listAccountingAttachments source: |- import { Panora } from "@panora/sdk"; @@ -5368,7 +5226,7 @@ actions: }); async function run() { - const result = await panora.crm.users.list({ + const result = await panora.accounting.attachments.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5381,11 +5239,11 @@ actions: } run(); - - target: $["paths"]["/projects"]["post"] + - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createProject + label: retrieveAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; @@ -5394,10 +5252,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.accounting.incomestatements.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5405,11 +5263,11 @@ actions: } run(); - - target: $["paths"]["/hris/dependents/{id}"]["get"] + - target: $["paths"]["/webhooks/verifyEvent"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisDependent + label: verifyEvent source: |- import { Panora } from "@panora/sdk"; @@ -5418,10 +5276,12 @@ actions: }); async function run() { - const result = await panora.hris.dependents.retrieve({ - xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + const result = await panora.webhooks.verifyEvent({ + payload: { + "key": "", + }, + signature: "", + secret: "", }); // Handle the result @@ -5429,11 +5289,11 @@ actions: } run(); - - target: $["paths"]["/hris/locations/{id}"]["get"] + - target: $["paths"]["/ticketing/teams"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisLocation + label: listTicketingTeams source: |- import { Panora } from "@panora/sdk"; @@ -5442,92 +5302,70 @@ actions: }); async function run() { - const result = await panora.hris.locations.retrieve({ + const result = await panora.ticketing.teams.list({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", }); + for await (const page of result) { + // handle page + } + } + + run(); + - target: $["paths"]["/linked_users"]["get"] + update: + x-codeSamples: + - lang: typescript + label: listLinkedUsers + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.linkedUsers.list(); + // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/tickets"]["post"] + - target: $["paths"]["/ats/eeocs"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingTicket + label: listAtsEeocs 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.ticketing.tickets.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", - ], - fieldMappings: { - "fav_dish": "broccoli", - "fav_color": "red", - }, - }, + const result = await panora.ats.eeocs.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(); - - target: $["paths"]["/events"]["get"] + - target: $["paths"]["/ecommerce/fulfillments"]["get"] update: x-codeSamples: - lang: typescript - label: getPanoraCoreEvents + label: listEcommerceFulfillments source: |- import { Panora } from "@panora/sdk"; @@ -5536,18 +5374,24 @@ actions: }); async function run() { - const result = await panora.events.getPanoraCoreEvents({}); + const result = await panora.ecommerce.fulfillments.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(); - - target: $["paths"]["/ats/rejectreasons"]["get"] + - target: $["paths"]["/accounting/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsRejectReasons + label: listAccountingContacts source: |- import { Panora } from "@panora/sdk"; @@ -5556,7 +5400,7 @@ actions: }); async function run() { - const result = await panora.ats.rejectreasons.list({ + const result = await panora.accounting.contacts.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5569,11 +5413,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/customers"]["get"] + - target: $["paths"]["/ticketing/users"]["get"] update: x-codeSamples: - lang: typescript - label: listEcommerceCustomers + label: listTicketingUsers source: |- import { Panora } from "@panora/sdk"; @@ -5582,7 +5426,7 @@ actions: }); async function run() { - const result = await panora.ecommerce.customers.list({ + const result = await panora.ticketing.users.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5595,22 +5439,36 @@ actions: } run(); - - target: $["paths"]["/ticketing/contacts/{id}"]["get"] + - target: $["paths"]["/accounting/accounts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingContact + label: createAccountingAccount source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAccountingAccountInputCurrency } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.ticketing.contacts.retrieve({ + const result = await panora.accounting.accounts.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedAccountingAccountInput: { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: UnifiedAccountingAccountInputCurrency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, }); // Handle the result @@ -5618,11 +5476,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/collections"]["get"] + - target: $["paths"]["/accounting/journalentries"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingCollections + label: listAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; @@ -5631,7 +5489,7 @@ actions: }); async function run() { - const result = await panora.ticketing.collections.list({ + const result = await panora.accounting.journalentries.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5644,11 +5502,11 @@ actions: } run(); - - target: $["paths"]["/crm/stages"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["post"] update: x-codeSamples: - lang: typescript - label: listCrmStages + label: createMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; @@ -5657,24 +5515,22 @@ actions: }); async function run() { - const result = await panora.crm.stages.list({ + const result = await panora.marketingautomation.actions.create({ xConnectionToken: "", - remoteData: true, - limit: 10, - cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + remoteData: false, + unifiedMarketingautomationActionInput: {}, }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); - - target: $["paths"]["/crm/users/{id}"]["get"] + - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmUser + label: retrieveAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; @@ -5683,10 +5539,10 @@ actions: }); async function run() { - const result = await panora.crm.users.retrieve({ + const result = await panora.accounting.creditnotes.retrieve({ xConnectionToken: "", - id: "b008e199-eda9-4629-bd41-a01b6195864a", - remoteData: true, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5694,11 +5550,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/events/{id}"]["get"] + - target: $["paths"]["/filestorage/folders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEvent + label: retrieveFilestorageFolder source: |- import { Panora } from "@panora/sdk"; @@ -5707,7 +5563,7 @@ actions: }); async function run() { - const result = await panora.marketingautomation.events.retrieve({ + const result = await panora.filestorage.folders.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -5718,11 +5574,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/customers/{id}"]["get"] + - target: $["paths"]["/hris/payrollruns"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveEcommerceCustomer + label: listHrisPayrollRuns source: |- import { Panora } from "@panora/sdk"; @@ -5731,9 +5587,54 @@ actions: }); async function run() { - const result = await panora.ecommerce.customers.retrieve({ + const result = await panora.hris.payrollruns.list({ xConnectionToken: "", - id: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); + + for await (const page of result) { + // handle page + } + } + + run(); + - target: $["paths"]["/ats/interviews"]["post"] + update: + x-codeSamples: + - lang: typescript + 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.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 @@ -5741,11 +5642,11 @@ actions: } run(); - - target: $["paths"]["/projects"]["get"] + - target: $["paths"]["/accounting/items/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: getProjects + label: retrieveAccountingItem source: |- import { Panora } from "@panora/sdk"; @@ -5754,18 +5655,22 @@ actions: }); async function run() { - const result = await panora.projects.getProjects(); + const result = await panora.accounting.items.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/accounting/attachments"]["get"] + - target: $["paths"]["/filestorage/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAttachments + label: listFilestorageGroup source: |- import { Panora } from "@panora/sdk"; @@ -5774,7 +5679,7 @@ actions: }); async function run() { - const result = await panora.accounting.attachments.list({ + const result = await panora.filestorage.groups.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5787,11 +5692,11 @@ actions: } run(); - - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] + - target: $["paths"]["/ecommerce/customers"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingBalanceSheet + label: listEcommerceCustomers source: |- import { Panora } from "@panora/sdk"; @@ -5800,22 +5705,24 @@ actions: }); async function run() { - const result = await panora.accounting.balancesheets.retrieve({ + const result = await panora.ecommerce.customers.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"]["/webhooks/{id}"]["delete"] + - target: $["paths"]["/accounting/incomestatements"]["get"] update: x-codeSamples: - lang: typescript - label: delete + label: listAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; @@ -5824,20 +5731,24 @@ actions: }); async function run() { - const result = await panora.webhooks.delete({ - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + const result = await panora.accounting.incomestatements.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(); - - target: $["paths"]["/crm/tasks/{id}"]["get"] + - target: $["paths"]["/filestorage/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmTask + label: retrieveFilestorageGroup source: |- import { Panora } from "@panora/sdk"; @@ -5846,7 +5757,7 @@ actions: }); async function run() { - const result = await panora.crm.tasks.retrieve({ + const result = await panora.filestorage.groups.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -5857,23 +5768,40 @@ actions: } run(); - - target: $["paths"]["/hris/companies/{id}"]["get"] + - target: $["paths"]["/ecommerce/products"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisCompany + label: createEcommerceProduct source: |- import { Panora } from "@panora/sdk"; + import { UnifiedEcommerceProductInputProductStatus } from "@panora/sdk/models/components"; const panora = new Panora({ apiKey: "", }); async function run() { - const result = await panora.hris.companies.retrieve({ + const result = await panora.ecommerce.products.create({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, + unifiedEcommerceProductInput: { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: UnifiedEcommerceProductInputProductStatus.Active, + imagesUrls: [ + "https://myproduct/image", + ], + description: "best tee ever", + vendor: "vendor_extern", + variants: [ + {}, + ], + tags: [ + "tag_1", + ], + fieldMappings: {}, + }, }); // Handle the result @@ -5881,11 +5809,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances"]["get"] + - target: $["paths"]["/ticketing/tickets"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffbalances + label: listTicketingTicket source: |- import { Panora } from "@panora/sdk"; @@ -5894,7 +5822,7 @@ actions: }); async function run() { - const result = await panora.hris.timeoffbalances.list({ + const result = await panora.ticketing.tickets.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -5907,11 +5835,35 @@ actions: } run(); - - target: $["paths"]["/crm/deals"]["post"] + - target: $["paths"]["/ticketing/tickets/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveTicketingTicket + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.ticketing.tickets.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/crm/notes"]["post"] update: x-codeSamples: - lang: typescript - label: createCrmDeal + label: createCrmNote source: |- import { Panora } from "@panora/sdk"; @@ -5920,15 +5872,15 @@ actions: }); async function run() { - const result = await panora.crm.deals.create({ + const result = await panora.crm.notes.create({ xConnectionToken: "", - unifiedCrmDealInput: { - name: "Huge Contract with Acme", - description: "Contract with Sales Operations Team", - amount: 1000, + remoteData: false, + unifiedCrmNoteInput: { + content: "My notes taken during the meeting", userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - stageId: "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", @@ -5941,47 +5893,37 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["post"] + - target: $["paths"]["/marketingautomation/automations"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsAttachment + label: listMarketingautomationAutomations 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.marketingautomation.automations.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 - console.log(result) + for await (const page of result) { + // handle page + } } run(); - - target: $["paths"]["/ats/jobinterviewstages"]["get"] + - target: $["paths"]["/ats/applications"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsJobInterviewStage + label: listAtsApplication source: |- import { Panora } from "@panora/sdk"; @@ -5990,7 +5932,7 @@ actions: }); async function run() { - const result = await panora.ats.jobinterviewstages.list({ + const result = await panora.ats.applications.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -6003,11 +5945,11 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] + - target: $["paths"]["/crm/deals"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAutomation + label: createCrmDeal source: |- import { Panora } from "@panora/sdk"; @@ -6016,10 +5958,20 @@ actions: }); async function run() { - const result = await panora.marketingautomation.automations.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 @@ -6027,23 +5979,26 @@ actions: } run(); - - target: $["paths"]["/filestorage/drives/{id}"]["get"] + - target: $["paths"]["/passthrough"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageDrive + 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.filestorage.drives.retrieve({ + const result = await panora.passthrough.request({ xConnectionToken: "", - id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - remoteData: false, + passThroughRequestDto: { + method: PassThroughRequestDtoMethod.Get, + path: "/dev", + }, }); // Handle the result @@ -6051,11 +6006,11 @@ actions: } run(); - - target: $["paths"]["/ticketing/users/{id}"]["get"] + - target: $["paths"]["/ats/jobs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingUser + label: retrieveAtsJob source: |- import { Panora } from "@panora/sdk"; @@ -6064,7 +6019,7 @@ actions: }); async function run() { - const result = await panora.ticketing.users.retrieve({ + const result = await panora.ats.jobs.retrieve({ xConnectionToken: "", id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, @@ -6075,33 +6030,51 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments"]["post"] + - target: $["paths"]["/accounting/payments"]["post"] update: x-codeSamples: - lang: typescript - label: createTicketingComment + label: createAccountingPayment source: |- import { Panora } from "@panora/sdk"; - import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; + import { UnifiedAccountingPaymentInputCurrency } 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.create({ xConnectionToken: "", - unifiedTicketingCommentInput: { - body: "Assigned to Eric !", - htmlBody: "

Assigned to Eric !

", - isPrivate: false, - creatorType: UnifiedTicketingCommentInputCreatorType.User, - ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + unifiedAccountingPaymentInput: { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", - attachments: [ + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentInputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ "801f9ede-c698-4e66-a7fc-48d19eebaa4f", ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, }, }); @@ -6110,23 +6083,69 @@ actions: } run(); - - target: $["paths"]["/crm/stages/{id}"]["get"] + - target: $["paths"]["/ticketing/tickets"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmStage + 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.crm.stages.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 @@ -6134,11 +6153,11 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns"]["get"] + - target: $["paths"]["/marketingautomation/events"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployeePayrollRun + label: listMarketingAutomationEvents source: |- import { Panora } from "@panora/sdk"; @@ -6147,7 +6166,7 @@ actions: }); async function run() { - const result = await panora.hris.employeepayrollruns.list({ + const result = await panora.marketingautomation.events.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -6160,11 +6179,11 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["get"] + - target: $["paths"]["/marketingautomation/users"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffs + label: listMarketingAutomationUsers source: |- import { Panora } from "@panora/sdk"; @@ -6173,7 +6192,7 @@ actions: }); async function run() { - const result = await panora.hris.timeoffs.list({ + const result = await panora.marketingautomation.users.list({ xConnectionToken: "", remoteData: true, limit: 10, @@ -6186,34 +6205,11 @@ actions: } run(); - - target: $["paths"]["/ecommerce/orders/{id}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: retrieveEcommerceOrder - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: "", - }); - - async function run() { - const result = await panora.ecommerce.orders.retrieve({ - xConnectionToken: "", - id: "", - }); - - // Handle the result - console.log(result) - } - - run(); - - target: $["paths"]["/marketingautomation/actions"]["post"] + - target: $["paths"]["/ats/offices"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAction + label: listAtsOffice source: |- import { Panora } from "@panora/sdk"; @@ -6222,22 +6218,24 @@ actions: }); async function run() { - const result = await panora.marketingautomation.actions.create({ + const result = await panora.ats.offices.list({ xConnectionToken: "", - remoteData: false, - unifiedMarketingautomationActionInput: {}, + 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/items/{id}"]["get"] + - target: $["paths"]["/ats/rejectreasons"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingItem + label: listAtsRejectReasons source: |- import { Panora } from "@panora/sdk"; @@ -6246,14 +6244,16 @@ actions: }); async function run() { - const result = await panora.accounting.items.retrieve({ + const result = await panora.ats.rejectreasons.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(); diff --git a/docs/models/components/accessrole.md b/docs/models/components/accessrole.md index 7bedfc35..5fae5a8b 100644 --- a/docs/models/components/accessrole.md +++ b/docs/models/components/accessrole.md @@ -2,6 +2,13 @@ The access role of the user +## Example Usage + +```typescript +import { AccessRole } from "@panora/sdk/models/components"; + +let value: AccessRole = AccessRole.Admin; +``` ## Values diff --git a/docs/models/components/accounttype.md b/docs/models/components/accounttype.md index 5c003d16..1d2da232 100644 --- a/docs/models/components/accounttype.md +++ b/docs/models/components/accounttype.md @@ -2,6 +2,13 @@ The type of the bank account +## Example Usage + +```typescript +import { AccountType } from "@panora/sdk/models/components"; + +let value: AccountType = AccountType.Checking; +``` ## Values diff --git a/docs/models/components/activitytype.md b/docs/models/components/activitytype.md index e08657fc..a7b7e332 100644 --- a/docs/models/components/activitytype.md +++ b/docs/models/components/activitytype.md @@ -2,6 +2,13 @@ The type of activity +## Example Usage + +```typescript +import { ActivityType } from "@panora/sdk/models/components"; + +let value: ActivityType = ActivityType.Note; +``` ## Values diff --git a/docs/models/components/address.md b/docs/models/components/address.md index 6add4593..f9b3f141 100644 --- a/docs/models/components/address.md +++ b/docs/models/components/address.md @@ -1,5 +1,21 @@ # Address +## Example Usage + +```typescript +import { Address, AddressType } from "@panora/sdk/models/components"; + +let value: Address = { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "New York", + postalCode: "10001", + country: "United States of America", + addressType: AddressType.Personal, + ownerType: "", +}; +``` ## Fields diff --git a/docs/models/components/addresstype.md b/docs/models/components/addresstype.md index 45079983..ff32ce4c 100644 --- a/docs/models/components/addresstype.md +++ b/docs/models/components/addresstype.md @@ -2,6 +2,13 @@ The address type. Authorized values are either PERSONAL or WORK. +## Example Usage + +```typescript +import { AddressType } from "@panora/sdk/models/components"; + +let value: AddressType = AddressType.Personal; +``` ## Values diff --git a/docs/models/components/applications.md b/docs/models/components/applications.md index 93451f64..df0d1644 100644 --- a/docs/models/components/applications.md +++ b/docs/models/components/applications.md @@ -1,5 +1,34 @@ # Applications +## Example Usage + +```typescript +import { Applications } from "@panora/sdk/models/components"; + +let value: Applications = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/attachments.md b/docs/models/components/attachments.md index c27b0ad1..05be327b 100644 --- a/docs/models/components/attachments.md +++ b/docs/models/components/attachments.md @@ -1,5 +1,22 @@ # Attachments +## Example Usage + +```typescript +import { Attachments } from "@panora/sdk/models/components"; + +let value: Attachments = { + 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", + }, +}; +``` ## Supported Types diff --git a/docs/models/components/attachmenttype.md b/docs/models/components/attachmenttype.md index 9f3e64a2..09d9225c 100644 --- a/docs/models/components/attachmenttype.md +++ b/docs/models/components/attachmenttype.md @@ -2,6 +2,13 @@ The type of the file +## Example Usage + +```typescript +import { AttachmentType } from "@panora/sdk/models/components"; + +let value: AttachmentType = AttachmentType.Resume; +``` ## Values diff --git a/docs/models/components/benefitplantype.md b/docs/models/components/benefitplantype.md index ffe9bdf5..30ae43f3 100644 --- a/docs/models/components/benefitplantype.md +++ b/docs/models/components/benefitplantype.md @@ -2,6 +2,13 @@ The type of the benefit plan +## Example Usage + +```typescript +import { BenefitPlanType } from "@panora/sdk/models/components"; + +let value: BenefitPlanType = BenefitPlanType.Retirement; +``` ## Values diff --git a/docs/models/components/collections.md b/docs/models/components/collections.md index 706683a0..8c92c7ab 100644 --- a/docs/models/components/collections.md +++ b/docs/models/components/collections.md @@ -1,5 +1,24 @@ # Collections +## Example Usage + +```typescript +import { Collections, CollectionType } from "@panora/sdk/models/components"; + +let value: Collections = { + name: "My Personal Collection", + description: "Collect issues", + collectionType: CollectionType.Project, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/collectiontype.md b/docs/models/components/collectiontype.md index 252021b5..97f39625 100644 --- a/docs/models/components/collectiontype.md +++ b/docs/models/components/collectiontype.md @@ -2,6 +2,13 @@ The type of the collection. Authorized values are either PROJECT or LIST +## Example Usage + +```typescript +import { CollectionType } from "@panora/sdk/models/components"; + +let value: CollectionType = CollectionType.Project; +``` ## Values diff --git a/docs/models/components/comment.md b/docs/models/components/comment.md index cf034187..7f563540 100644 --- a/docs/models/components/comment.md +++ b/docs/models/components/comment.md @@ -2,6 +2,22 @@ The comment of the ticket +## Example Usage + +```typescript +import { Comment, UnifiedTicketingTicketOutputCreatorType } from "@panora/sdk/models/components"; + +let value: Comment = { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketOutputCreatorType.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"], +}; +``` ## Fields diff --git a/docs/models/components/connection.md b/docs/models/components/connection.md index 56ff0ff5..1cf43519 100644 --- a/docs/models/components/connection.md +++ b/docs/models/components/connection.md @@ -1,5 +1,26 @@ # Connection +## Example Usage + +```typescript +import { Connection, TokenType } from "@panora/sdk/models/components"; + +let value: Connection = { + idConnection: "123e4567-e89b-12d3-a456-426614174000", + status: "active", + providerSlug: "hubspot", + vertical: "crm", + accountUrl: "https://example.com/account", + tokenType: TokenType.Oauth2, + accessToken: "access_token_example", + refreshToken: "refresh_token_example", + expirationTimestamp: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + connectionToken: "123e4567-e89b-12d3-a456-426614174000", + idProject: "123e4567-e89b-12d3-a456-426614174001", + idLinkedUser: "123e4567-e89b-12d3-a456-426614174002", +}; +``` ## Fields diff --git a/docs/models/components/createbatchlinkeduserdto.md b/docs/models/components/createbatchlinkeduserdto.md index 8473e593..eb0f2e57 100644 --- a/docs/models/components/createbatchlinkeduserdto.md +++ b/docs/models/components/createbatchlinkeduserdto.md @@ -1,5 +1,15 @@ # CreateBatchLinkedUserDto +## Example Usage + +```typescript +import { CreateBatchLinkedUserDto } from "@panora/sdk/models/components"; + +let value: CreateBatchLinkedUserDto = { + linkedUserOriginIds: ["id_1"], + alias: "acme", +}; +``` ## Fields diff --git a/docs/models/components/createdat.md b/docs/models/components/createdat.md index 273feb58..be982828 100644 --- a/docs/models/components/createdat.md +++ b/docs/models/components/createdat.md @@ -2,6 +2,13 @@ The created date of the object +## Example Usage + +```typescript +import { CreatedAt } from "@panora/sdk/models/components"; + +let value: CreatedAt = {}; +``` ## Fields diff --git a/docs/models/components/createlinkeduserdto.md b/docs/models/components/createlinkeduserdto.md index 3d964298..18067ea5 100644 --- a/docs/models/components/createlinkeduserdto.md +++ b/docs/models/components/createlinkeduserdto.md @@ -1,5 +1,15 @@ # CreateLinkedUserDto +## Example Usage + +```typescript +import { CreateLinkedUserDto } from "@panora/sdk/models/components"; + +let value: CreateLinkedUserDto = { + linkedUserOriginId: "id_1", + alias: "acme", +}; +``` ## Fields diff --git a/docs/models/components/createprojectdto.md b/docs/models/components/createprojectdto.md index 8eed06e0..161a157e 100644 --- a/docs/models/components/createprojectdto.md +++ b/docs/models/components/createprojectdto.md @@ -1,5 +1,16 @@ # CreateProjectDto +## Example Usage + +```typescript +import { CreateProjectDto } from "@panora/sdk/models/components"; + +let value: CreateProjectDto = { + name: "Project Name", + idOrganization: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + idUser: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/components/creatortype.md b/docs/models/components/creatortype.md index 902451e1..486a1e88 100644 --- a/docs/models/components/creatortype.md +++ b/docs/models/components/creatortype.md @@ -2,6 +2,13 @@ The creator type of the comment. Authorized values are either USER or CONTACT +## Example Usage + +```typescript +import { CreatorType } from "@panora/sdk/models/components"; + +let value: CreatorType = CreatorType.User; +``` ## Values diff --git a/docs/models/components/currency.md b/docs/models/components/currency.md index 249da7d5..db3abb01 100644 --- a/docs/models/components/currency.md +++ b/docs/models/components/currency.md @@ -2,6 +2,13 @@ The currency of the account +## Example Usage + +```typescript +import { Currency } from "@panora/sdk/models/components"; + +let value: Currency = Currency.Usd; +``` ## Values diff --git a/docs/models/components/customfieldcreatedto.md b/docs/models/components/customfieldcreatedto.md index 3b9de0ee..227df1b9 100644 --- a/docs/models/components/customfieldcreatedto.md +++ b/docs/models/components/customfieldcreatedto.md @@ -1,5 +1,24 @@ # CustomFieldCreateDto +## Example Usage + +```typescript +import { + CustomFieldCreateDto, + CustomFieldCreateDtoDataType, + CustomFieldCreateDtoObjectTypeOwner, +} from "@panora/sdk/models/components"; + +let value: CustomFieldCreateDto = { + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, + name: "my_favorite_dish", + description: "Favorite Dish", + dataType: CustomFieldCreateDtoDataType.String, + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/components/customfieldcreatedtodatatype.md b/docs/models/components/customfieldcreatedtodatatype.md index add79a6b..3ae6b238 100644 --- a/docs/models/components/customfieldcreatedtodatatype.md +++ b/docs/models/components/customfieldcreatedtodatatype.md @@ -2,6 +2,13 @@ The data type of the custom field +## Example Usage + +```typescript +import { CustomFieldCreateDtoDataType } from "@panora/sdk/models/components"; + +let value: CustomFieldCreateDtoDataType = CustomFieldCreateDtoDataType.String; +``` ## Values diff --git a/docs/models/components/customfieldcreatedtoobjecttypeowner.md b/docs/models/components/customfieldcreatedtoobjecttypeowner.md index f363a1a1..d4f30295 100644 --- a/docs/models/components/customfieldcreatedtoobjecttypeowner.md +++ b/docs/models/components/customfieldcreatedtoobjecttypeowner.md @@ -1,5 +1,12 @@ # CustomFieldCreateDtoObjectTypeOwner +## Example Usage + +```typescript +import { CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; + +let value: CustomFieldCreateDtoObjectTypeOwner = CustomFieldCreateDtoObjectTypeOwner.Company; +``` ## Values diff --git a/docs/models/components/customfieldresponse.md b/docs/models/components/customfieldresponse.md index 5a449d51..6abe73d7 100644 --- a/docs/models/components/customfieldresponse.md +++ b/docs/models/components/customfieldresponse.md @@ -1,5 +1,27 @@ # CustomFieldResponse +## Example Usage + +```typescript +import { CustomFieldResponse, CustomFieldResponseDataType } from "@panora/sdk/models/components"; + +let value: CustomFieldResponse = { + idAttribute: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: "", + ressourceOwnerType: "", + slug: "fav_dish", + description: "My favorite dish", + dataType: CustomFieldResponseDataType.String, + remoteId: "id_1", + source: "hubspot", + idEntity: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + idProject: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + scope: "", + idConsumer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/customfieldresponsedatatype.md b/docs/models/components/customfieldresponsedatatype.md index 6d7bbe5a..7aafc07f 100644 --- a/docs/models/components/customfieldresponsedatatype.md +++ b/docs/models/components/customfieldresponsedatatype.md @@ -2,6 +2,13 @@ Attribute Data Type +## Example Usage + +```typescript +import { CustomFieldResponseDataType } from "@panora/sdk/models/components"; + +let value: CustomFieldResponseDataType = CustomFieldResponseDataType.String; +``` ## Values diff --git a/docs/models/components/data.md b/docs/models/components/data.md index 5f132f03..bc196003 100644 --- a/docs/models/components/data.md +++ b/docs/models/components/data.md @@ -1,5 +1,12 @@ # Data +## Example Usage + +```typescript +import { Data } from "@panora/sdk/models/components"; + +let value: Data = {}; +``` ## Fields diff --git a/docs/models/components/datatype.md b/docs/models/components/datatype.md index b7c7b888..2a3afe78 100644 --- a/docs/models/components/datatype.md +++ b/docs/models/components/datatype.md @@ -2,6 +2,13 @@ The data type of the target field +## Example Usage + +```typescript +import { DataType } from "@panora/sdk/models/components"; + +let value: DataType = DataType.String; +``` ## Values diff --git a/docs/models/components/deductionitem.md b/docs/models/components/deductionitem.md index 2e946598..8895f3c5 100644 --- a/docs/models/components/deductionitem.md +++ b/docs/models/components/deductionitem.md @@ -1,5 +1,16 @@ # DeductionItem +## Example Usage + +```typescript +import { DeductionItem } from "@panora/sdk/models/components"; + +let value: DeductionItem = { + name: "Health Insurance", + employeeDeduction: 100, + companyDeduction: 200, +}; +``` ## Fields diff --git a/docs/models/components/definetargetfielddto.md b/docs/models/components/definetargetfielddto.md index ec3aeaed..1b51d60f 100644 --- a/docs/models/components/definetargetfielddto.md +++ b/docs/models/components/definetargetfielddto.md @@ -1,5 +1,17 @@ # DefineTargetFieldDto +## Example Usage + +```typescript +import { DataType, DefineTargetFieldDto, ObjectTypeOwner } from "@panora/sdk/models/components"; + +let value: DefineTargetFieldDto = { + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, +}; +``` ## Fields diff --git a/docs/models/components/direction.md b/docs/models/components/direction.md index 10d598e6..839e30fd 100644 --- a/docs/models/components/direction.md +++ b/docs/models/components/direction.md @@ -2,6 +2,13 @@ The direction of the engagement. Authorized values are INBOUND or OUTBOUND +## Example Usage + +```typescript +import { Direction } from "@panora/sdk/models/components"; + +let value: Direction = Direction.Inbound; +``` ## Values diff --git a/docs/models/components/disabilitystatus.md b/docs/models/components/disabilitystatus.md index dd2746f6..377b9bfe 100644 --- a/docs/models/components/disabilitystatus.md +++ b/docs/models/components/disabilitystatus.md @@ -2,6 +2,13 @@ The disability status of the candidate +## Example Usage + +```typescript +import { DisabilityStatus } from "@panora/sdk/models/components"; + +let value: DisabilityStatus = DisabilityStatus.YesIHaveADisabilityOrPreviouslyHadADisability; +``` ## Values diff --git a/docs/models/components/earningitem.md b/docs/models/components/earningitem.md index a36d1bb6..16aa62c0 100644 --- a/docs/models/components/earningitem.md +++ b/docs/models/components/earningitem.md @@ -1,5 +1,15 @@ # EarningItem +## Example Usage + +```typescript +import { EarningItem } from "@panora/sdk/models/components"; + +let value: EarningItem = { + amount: 1000, + type: "Salary", +}; +``` ## Fields diff --git a/docs/models/components/email.md b/docs/models/components/email.md index 351f3e5d..7d860961 100644 --- a/docs/models/components/email.md +++ b/docs/models/components/email.md @@ -1,5 +1,15 @@ # Email +## Example Usage + +```typescript +import { Email, EmailAddressType } from "@panora/sdk/models/components"; + +let value: Email = { + emailAddress: "Randy_Lehner@hotmail.com", + emailAddressType: EmailAddressType.Personal, +}; +``` ## Fields diff --git a/docs/models/components/emailaddresstype.md b/docs/models/components/emailaddresstype.md index 174bcaf3..ca4bb429 100644 --- a/docs/models/components/emailaddresstype.md +++ b/docs/models/components/emailaddresstype.md @@ -2,6 +2,13 @@ The email address type. Authorized values are either PERSONAL or WORK. +## Example Usage + +```typescript +import { EmailAddressType } from "@panora/sdk/models/components"; + +let value: EmailAddressType = EmailAddressType.Personal; +``` ## Values diff --git a/docs/models/components/employmentstatus.md b/docs/models/components/employmentstatus.md index 2d79a7d5..f2c5cb27 100644 --- a/docs/models/components/employmentstatus.md +++ b/docs/models/components/employmentstatus.md @@ -2,6 +2,13 @@ The employment status of the employee +## Example Usage + +```typescript +import { EmploymentStatus } from "@panora/sdk/models/components"; + +let value: EmploymentStatus = EmploymentStatus.Active; +``` ## Values diff --git a/docs/models/components/employmenttype.md b/docs/models/components/employmenttype.md index 160faf7c..8f45ba59 100644 --- a/docs/models/components/employmenttype.md +++ b/docs/models/components/employmenttype.md @@ -2,6 +2,13 @@ The type of employment +## Example Usage + +```typescript +import { EmploymentType } from "@panora/sdk/models/components"; + +let value: EmploymentType = EmploymentType.FullTime; +``` ## Values diff --git a/docs/models/components/ethnicity.md b/docs/models/components/ethnicity.md index 63677207..b579a05f 100644 --- a/docs/models/components/ethnicity.md +++ b/docs/models/components/ethnicity.md @@ -2,6 +2,13 @@ The ethnicity of the employee +## Example Usage + +```typescript +import { Ethnicity } from "@panora/sdk/models/components"; + +let value: Ethnicity = Ethnicity.AmericanIndianOrAlaskaNative; +``` ## Values diff --git a/docs/models/components/eventresponse.md b/docs/models/components/eventresponse.md index 43cf35d2..388441b0 100644 --- a/docs/models/components/eventresponse.md +++ b/docs/models/components/eventresponse.md @@ -1,5 +1,24 @@ # EventResponse +## Example Usage + +```typescript +import { EventResponse, EventResponseStatus, EventResponseType, Method } from "@panora/sdk/models/components"; + +let value: EventResponse = { + idEvent: "123e4567-e89b-12d3-a456-426614174000", + idConnection: "123e4567-e89b-12d3-a456-426614174001", + idProject: "123e4567-e89b-12d3-a456-426614174002", + type: EventResponseType.ConnectionCreated, + status: EventResponseStatus.Success, + direction: "0", + method: Method.Post, + url: "/crm/companies", + provider: "hubspot", + timestamp: new Date("2024-10-01T12:00:00Z"), + idLinkedUser: "123e4567-e89b-12d3-a456-426614174003", +}; +``` ## Fields diff --git a/docs/models/components/eventresponsestatus.md b/docs/models/components/eventresponsestatus.md index 7a30c543..33ebf3f3 100644 --- a/docs/models/components/eventresponsestatus.md +++ b/docs/models/components/eventresponsestatus.md @@ -2,6 +2,13 @@ Status of the event +## Example Usage + +```typescript +import { EventResponseStatus } from "@panora/sdk/models/components"; + +let value: EventResponseStatus = EventResponseStatus.Success; +``` ## Values diff --git a/docs/models/components/eventresponsetype.md b/docs/models/components/eventresponsetype.md index 2c6e11b0..ff3f5eda 100644 --- a/docs/models/components/eventresponsetype.md +++ b/docs/models/components/eventresponsetype.md @@ -2,6 +2,13 @@ Scope of the event +## Example Usage + +```typescript +import { EventResponseType } from "@panora/sdk/models/components"; + +let value: EventResponseType = EventResponseType.ConnectionCreated; +``` ## Values diff --git a/docs/models/components/fieldmappings.md b/docs/models/components/fieldmappings.md index b1106316..437db5a9 100644 --- a/docs/models/components/fieldmappings.md +++ b/docs/models/components/fieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { FieldMappings } from "@panora/sdk/models/components"; + +let value: FieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/flsastatus.md b/docs/models/components/flsastatus.md index 01d45d6a..7ed644b9 100644 --- a/docs/models/components/flsastatus.md +++ b/docs/models/components/flsastatus.md @@ -2,6 +2,13 @@ The FLSA status of the employment +## Example Usage + +```typescript +import { FlsaStatus } from "@panora/sdk/models/components"; + +let value: FlsaStatus = FlsaStatus.Exempt; +``` ## Values diff --git a/docs/models/components/fulfillmentstatus.md b/docs/models/components/fulfillmentstatus.md index 288eca74..ced3f672 100644 --- a/docs/models/components/fulfillmentstatus.md +++ b/docs/models/components/fulfillmentstatus.md @@ -2,6 +2,13 @@ The fulfillment status of the order +## Example Usage + +```typescript +import { FulfillmentStatus } from "@panora/sdk/models/components"; + +let value: FulfillmentStatus = FulfillmentStatus.Pending; +``` ## Values diff --git a/docs/models/components/gender.md b/docs/models/components/gender.md index 935f5e12..f36e5bf1 100644 --- a/docs/models/components/gender.md +++ b/docs/models/components/gender.md @@ -2,6 +2,13 @@ The gender of the dependent +## Example Usage + +```typescript +import { Gender } from "@panora/sdk/models/components"; + +let value: Gender = Gender.Male; +``` ## Values diff --git a/docs/models/components/headers.md b/docs/models/components/headers.md index a95ff212..16a7e5fe 100644 --- a/docs/models/components/headers.md +++ b/docs/models/components/headers.md @@ -1,5 +1,12 @@ # Headers +## Example Usage + +```typescript +import { Headers } from "@panora/sdk/models/components"; + +let value: Headers = {}; +``` ## Fields diff --git a/docs/models/components/industry.md b/docs/models/components/industry.md index 245f4509..1efb7439 100644 --- a/docs/models/components/industry.md +++ b/docs/models/components/industry.md @@ -2,6 +2,13 @@ The industry of the company. Authorized values can be found in the Industry enum. +## Example Usage + +```typescript +import { Industry } from "@panora/sdk/models/components"; + +let value: Industry = Industry.Accounting; +``` ## Values diff --git a/docs/models/components/items.md b/docs/models/components/items.md index e465d183..a01745ff 100644 --- a/docs/models/components/items.md +++ b/docs/models/components/items.md @@ -2,6 +2,13 @@ The items in the fulfilment +## Example Usage + +```typescript +import { Items } from "@panora/sdk/models/components"; + +let value: Items = {}; +``` ## Fields diff --git a/docs/models/components/lineitem.md b/docs/models/components/lineitem.md index a3e4f0da..5bfb2a3b 100644 --- a/docs/models/components/lineitem.md +++ b/docs/models/components/lineitem.md @@ -1,5 +1,22 @@ # LineItem +## Example Usage + +```typescript +import { LineItem } from "@panora/sdk/models/components"; + +let value: LineItem = { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/linkeduserresponse.md b/docs/models/components/linkeduserresponse.md index aba0fa87..6cd1b499 100644 --- a/docs/models/components/linkeduserresponse.md +++ b/docs/models/components/linkeduserresponse.md @@ -1,5 +1,17 @@ # LinkedUserResponse +## Example Usage + +```typescript +import { LinkedUserResponse } from "@panora/sdk/models/components"; + +let value: LinkedUserResponse = { + idLinkedUser: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + linkedUserOriginId: "id_1", + alias: "acme", + idProject: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/components/locationtype.md b/docs/models/components/locationtype.md index ce0b5b0a..6f821c06 100644 --- a/docs/models/components/locationtype.md +++ b/docs/models/components/locationtype.md @@ -2,6 +2,13 @@ The type of the location +## Example Usage + +```typescript +import { LocationType } from "@panora/sdk/models/components"; + +let value: LocationType = LocationType.Work; +``` ## Values diff --git a/docs/models/components/logindto.md b/docs/models/components/logindto.md index 5faf5c63..ee67bb2a 100644 --- a/docs/models/components/logindto.md +++ b/docs/models/components/logindto.md @@ -1,5 +1,15 @@ # LoginDto +## Example Usage + +```typescript +import { LoginDto } from "@panora/sdk/models/components"; + +let value: LoginDto = { + email: "Larue_Rau85@yahoo.com", + passwordHash: "", +}; +``` ## Fields diff --git a/docs/models/components/mapfieldtoproviderdto.md b/docs/models/components/mapfieldtoproviderdto.md index 3d7a6929..7553577e 100644 --- a/docs/models/components/mapfieldtoproviderdto.md +++ b/docs/models/components/mapfieldtoproviderdto.md @@ -1,5 +1,17 @@ # MapFieldToProviderDto +## Example Usage + +```typescript +import { MapFieldToProviderDto } from "@panora/sdk/models/components"; + +let value: MapFieldToProviderDto = { + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/components/maritalstatus.md b/docs/models/components/maritalstatus.md index e0510b4e..f2a51991 100644 --- a/docs/models/components/maritalstatus.md +++ b/docs/models/components/maritalstatus.md @@ -2,6 +2,13 @@ The marital status of the employee +## Example Usage + +```typescript +import { MaritalStatus } from "@panora/sdk/models/components"; + +let value: MaritalStatus = MaritalStatus.MarriedFilingSeparately; +``` ## Values diff --git a/docs/models/components/method.md b/docs/models/components/method.md index 564eb685..9e9fe7ac 100644 --- a/docs/models/components/method.md +++ b/docs/models/components/method.md @@ -2,6 +2,13 @@ HTTP method used for the event +## Example Usage + +```typescript +import { Method } from "@panora/sdk/models/components"; + +let value: Method = Method.Post; +``` ## Values diff --git a/docs/models/components/modifiedat.md b/docs/models/components/modifiedat.md index 34c9db08..e114977d 100644 --- a/docs/models/components/modifiedat.md +++ b/docs/models/components/modifiedat.md @@ -2,6 +2,13 @@ The modified date of the object +## Example Usage + +```typescript +import { ModifiedAt } from "@panora/sdk/models/components"; + +let value: ModifiedAt = {}; +``` ## Fields diff --git a/docs/models/components/objecttypeowner.md b/docs/models/components/objecttypeowner.md index ea826951..ff94d538 100644 --- a/docs/models/components/objecttypeowner.md +++ b/docs/models/components/objecttypeowner.md @@ -1,5 +1,12 @@ # ObjectTypeOwner +## Example Usage + +```typescript +import { ObjectTypeOwner } from "@panora/sdk/models/components"; + +let value: ObjectTypeOwner = ObjectTypeOwner.Company; +``` ## Values diff --git a/docs/models/components/orderstatus.md b/docs/models/components/orderstatus.md index cf03d34b..993ceb1b 100644 --- a/docs/models/components/orderstatus.md +++ b/docs/models/components/orderstatus.md @@ -2,6 +2,13 @@ The status of the order +## Example Usage + +```typescript +import { OrderStatus } from "@panora/sdk/models/components"; + +let value: OrderStatus = OrderStatus.Unshipped; +``` ## Values diff --git a/docs/models/components/overallrecommendation.md b/docs/models/components/overallrecommendation.md index 1935fe82..44d4c5a4 100644 --- a/docs/models/components/overallrecommendation.md +++ b/docs/models/components/overallrecommendation.md @@ -2,6 +2,13 @@ The overall recommendation +## Example Usage + +```typescript +import { OverallRecommendation } from "@panora/sdk/models/components"; + +let value: OverallRecommendation = OverallRecommendation.Yes; +``` ## Values diff --git a/docs/models/components/ownertype.md b/docs/models/components/ownertype.md index b01441e5..46927de7 100644 --- a/docs/models/components/ownertype.md +++ b/docs/models/components/ownertype.md @@ -2,6 +2,13 @@ The owner type of an email +## Example Usage + +```typescript +import { OwnerType } from "@panora/sdk/models/components"; + +let value: OwnerType = OwnerType.Company; +``` ## Values diff --git a/docs/models/components/passthroughrequestdto.md b/docs/models/components/passthroughrequestdto.md index 5c5936a1..eb533096 100644 --- a/docs/models/components/passthroughrequestdto.md +++ b/docs/models/components/passthroughrequestdto.md @@ -1,5 +1,15 @@ # PassThroughRequestDto +## Example Usage + +```typescript +import { PassThroughRequestDto, PassThroughRequestDtoMethod } from "@panora/sdk/models/components"; + +let value: PassThroughRequestDto = { + method: PassThroughRequestDtoMethod.Post, + path: "/private", +}; +``` ## Fields diff --git a/docs/models/components/passthroughrequestdtomethod.md b/docs/models/components/passthroughrequestdtomethod.md index ea2978b7..98648202 100644 --- a/docs/models/components/passthroughrequestdtomethod.md +++ b/docs/models/components/passthroughrequestdtomethod.md @@ -1,5 +1,12 @@ # PassThroughRequestDtoMethod +## Example Usage + +```typescript +import { PassThroughRequestDtoMethod } from "@panora/sdk/models/components"; + +let value: PassThroughRequestDtoMethod = PassThroughRequestDtoMethod.Get; +``` ## Values diff --git a/docs/models/components/paycurrency.md b/docs/models/components/paycurrency.md index 7ec802fa..c5620a9c 100644 --- a/docs/models/components/paycurrency.md +++ b/docs/models/components/paycurrency.md @@ -2,6 +2,13 @@ The currency of the pay +## Example Usage + +```typescript +import { PayCurrency } from "@panora/sdk/models/components"; + +let value: PayCurrency = PayCurrency.Usd; +``` ## Values diff --git a/docs/models/components/payfrequency.md b/docs/models/components/payfrequency.md index fc048de7..7f60e79e 100644 --- a/docs/models/components/payfrequency.md +++ b/docs/models/components/payfrequency.md @@ -2,6 +2,13 @@ The pay frequency of the employment +## Example Usage + +```typescript +import { PayFrequency } from "@panora/sdk/models/components"; + +let value: PayFrequency = PayFrequency.Weekly; +``` ## Values diff --git a/docs/models/components/paymentstatus.md b/docs/models/components/paymentstatus.md index 92941bea..6981c26b 100644 --- a/docs/models/components/paymentstatus.md +++ b/docs/models/components/paymentstatus.md @@ -2,6 +2,13 @@ The payment status of the order +## Example Usage + +```typescript +import { PaymentStatus } from "@panora/sdk/models/components"; + +let value: PaymentStatus = PaymentStatus.Success; +``` ## Values diff --git a/docs/models/components/payperiod.md b/docs/models/components/payperiod.md index da1c1b7a..9abc92ca 100644 --- a/docs/models/components/payperiod.md +++ b/docs/models/components/payperiod.md @@ -2,6 +2,13 @@ The pay period of the employment +## Example Usage + +```typescript +import { PayPeriod } from "@panora/sdk/models/components"; + +let value: PayPeriod = PayPeriod.Month; +``` ## Values diff --git a/docs/models/components/phone.md b/docs/models/components/phone.md index 8f82e919..5097b77f 100644 --- a/docs/models/components/phone.md +++ b/docs/models/components/phone.md @@ -1,5 +1,15 @@ # Phone +## Example Usage + +```typescript +import { Phone, PhoneType } from "@panora/sdk/models/components"; + +let value: Phone = { + phoneNumber: "", + phoneType: PhoneType.Mobile, +}; +``` ## Fields diff --git a/docs/models/components/phonetype.md b/docs/models/components/phonetype.md index 060d8e34..fb47547a 100644 --- a/docs/models/components/phonetype.md +++ b/docs/models/components/phonetype.md @@ -2,6 +2,13 @@ The phone type. Authorized values are either MOBILE or WORK +## Example Usage + +```typescript +import { PhoneType } from "@panora/sdk/models/components"; + +let value: PhoneType = PhoneType.Work; +``` ## Values diff --git a/docs/models/components/policytype.md b/docs/models/components/policytype.md index 309cc4fa..671f3015 100644 --- a/docs/models/components/policytype.md +++ b/docs/models/components/policytype.md @@ -2,6 +2,13 @@ The type of time off policy +## Example Usage + +```typescript +import { PolicyType } from "@panora/sdk/models/components"; + +let value: PolicyType = PolicyType.Vacation; +``` ## Values diff --git a/docs/models/components/priority.md b/docs/models/components/priority.md index b36a54cc..3ecc0814 100644 --- a/docs/models/components/priority.md +++ b/docs/models/components/priority.md @@ -2,6 +2,13 @@ The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. +## Example Usage + +```typescript +import { Priority } from "@panora/sdk/models/components"; + +let value: Priority = Priority.High; +``` ## Values diff --git a/docs/models/components/productstatus.md b/docs/models/components/productstatus.md index 2b200a95..fed6c788 100644 --- a/docs/models/components/productstatus.md +++ b/docs/models/components/productstatus.md @@ -2,6 +2,13 @@ The status of the product. Either ACTIVE, DRAFT OR ARCHIVED. +## Example Usage + +```typescript +import { ProductStatus } from "@panora/sdk/models/components"; + +let value: ProductStatus = ProductStatus.Active; +``` ## Values diff --git a/docs/models/components/projectresponse.md b/docs/models/components/projectresponse.md index 7704e215..dbab505a 100644 --- a/docs/models/components/projectresponse.md +++ b/docs/models/components/projectresponse.md @@ -1,5 +1,20 @@ # ProjectResponse +## Example Usage + +```typescript +import { ProjectResponse } from "@panora/sdk/models/components"; + +let value: ProjectResponse = { + idProject: "123e4567-e89b-12d3-a456-426614174000", + name: "My Project", + syncMode: "automatic", + pullFrequency: 3600, + redirectUrl: "https://example.com/redirect", + idUser: "123e4567-e89b-12d3-a456-426614174001", + idConnectorSet: "123e4567-e89b-12d3-a456-426614174002", +}; +``` ## Fields diff --git a/docs/models/components/race.md b/docs/models/components/race.md index 8ab22f8d..5802fe8b 100644 --- a/docs/models/components/race.md +++ b/docs/models/components/race.md @@ -2,6 +2,13 @@ The race of the candidate +## Example Usage + +```typescript +import { Race } from "@panora/sdk/models/components"; + +let value: Race = Race.AmericanIndianOrAlaskanNative; +``` ## Values diff --git a/docs/models/components/relationship.md b/docs/models/components/relationship.md index 6fd74054..c4857862 100644 --- a/docs/models/components/relationship.md +++ b/docs/models/components/relationship.md @@ -2,6 +2,13 @@ The relationship of the dependent to the employee +## Example Usage + +```typescript +import { Relationship } from "@panora/sdk/models/components"; + +let value: Relationship = Relationship.Child; +``` ## Values diff --git a/docs/models/components/remotedata.md b/docs/models/components/remotedata.md index 7eccb0d4..701c1894 100644 --- a/docs/models/components/remotedata.md +++ b/docs/models/components/remotedata.md @@ -2,6 +2,13 @@ The remote data of the bank info in the context of the 3rd Party +## Example Usage + +```typescript +import { RemoteData } from "@panora/sdk/models/components"; + +let value: RemoteData = {}; +``` ## Fields diff --git a/docs/models/components/requestformat.md b/docs/models/components/requestformat.md index 5b1bd81b..040d4452 100644 --- a/docs/models/components/requestformat.md +++ b/docs/models/components/requestformat.md @@ -1,5 +1,16 @@ # RequestFormat +## Example Usage + +```typescript +import { RequestFormat } from "@panora/sdk/models/components"; + +let value: RequestFormat = [ + { + key: "", + }, +]; +``` ## Supported Types diff --git a/docs/models/components/requesttype.md b/docs/models/components/requesttype.md index e453346a..7fb4110f 100644 --- a/docs/models/components/requesttype.md +++ b/docs/models/components/requesttype.md @@ -2,6 +2,13 @@ The type of time off request +## Example Usage + +```typescript +import { RequestType } from "@panora/sdk/models/components"; + +let value: RequestType = RequestType.Vacation; +``` ## Values diff --git a/docs/models/components/resyncstatusdto.md b/docs/models/components/resyncstatusdto.md index e1e173d2..db2a500a 100644 --- a/docs/models/components/resyncstatusdto.md +++ b/docs/models/components/resyncstatusdto.md @@ -1,5 +1,17 @@ # ResyncStatusDto +## Example Usage + +```typescript +import { ResyncStatusDto, ResyncStatusDtoStatus, Vertical } from "@panora/sdk/models/components"; + +let value: ResyncStatusDto = { + timestamp: new Date(""), + vertical: Vertical.Ticketing, + provider: "gitlab", + status: ResyncStatusDtoStatus.Success, +}; +``` ## Fields diff --git a/docs/models/components/resyncstatusdtostatus.md b/docs/models/components/resyncstatusdtostatus.md index 195a733c..1555fc9f 100644 --- a/docs/models/components/resyncstatusdtostatus.md +++ b/docs/models/components/resyncstatusdtostatus.md @@ -1,5 +1,12 @@ # ResyncStatusDtoStatus +## Example Usage + +```typescript +import { ResyncStatusDtoStatus } from "@panora/sdk/models/components"; + +let value: ResyncStatusDtoStatus = ResyncStatusDtoStatus.Success; +``` ## Values diff --git a/docs/models/components/runstate.md b/docs/models/components/runstate.md index 591ad4ac..5c0dcd28 100644 --- a/docs/models/components/runstate.md +++ b/docs/models/components/runstate.md @@ -2,6 +2,13 @@ The state of the payroll run +## Example Usage + +```typescript +import { RunState } from "@panora/sdk/models/components"; + +let value: RunState = RunState.Paid; +``` ## Values diff --git a/docs/models/components/runtype.md b/docs/models/components/runtype.md index f0692f50..798260a5 100644 --- a/docs/models/components/runtype.md +++ b/docs/models/components/runtype.md @@ -2,6 +2,13 @@ The type of the payroll run +## Example Usage + +```typescript +import { RunType } from "@panora/sdk/models/components"; + +let value: RunType = RunType.Regular; +``` ## Values diff --git a/docs/models/components/security.md b/docs/models/components/security.md index e4a21bee..f38942e0 100644 --- a/docs/models/components/security.md +++ b/docs/models/components/security.md @@ -1,5 +1,14 @@ # Security +## Example Usage + +```typescript +import { Security } from "@panora/sdk/models/components"; + +let value: Security = { + apiKey: "", +}; +``` ## Fields diff --git a/docs/models/components/signatureverificationdto.md b/docs/models/components/signatureverificationdto.md index f011747d..0763c3a3 100644 --- a/docs/models/components/signatureverificationdto.md +++ b/docs/models/components/signatureverificationdto.md @@ -1,5 +1,18 @@ # SignatureVerificationDto +## Example Usage + +```typescript +import { SignatureVerificationDto } from "@panora/sdk/models/components"; + +let value: SignatureVerificationDto = { + payload: { + key: "", + }, + signature: "", + secret: "", +}; +``` ## Fields diff --git a/docs/models/components/status.md b/docs/models/components/status.md index a5007aca..32342679 100644 --- a/docs/models/components/status.md +++ b/docs/models/components/status.md @@ -2,6 +2,13 @@ The status of the ticket. Authorized values are OPEN or CLOSED. +## Example Usage + +```typescript +import { Status } from "@panora/sdk/models/components"; + +let value: Status = Status.Open; +``` ## Values diff --git a/docs/models/components/tags.md b/docs/models/components/tags.md index cb8a26ce..fd955307 100644 --- a/docs/models/components/tags.md +++ b/docs/models/components/tags.md @@ -1,5 +1,26 @@ # Tags +## Example Usage + +```typescript +import { Tags } from "@panora/sdk/models/components"; + +let value: Tags = { + name: "urgent_tag", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/taxitem.md b/docs/models/components/taxitem.md index b5a3e966..1336953f 100644 --- a/docs/models/components/taxitem.md +++ b/docs/models/components/taxitem.md @@ -1,5 +1,16 @@ # TaxItem +## Example Usage + +```typescript +import { TaxItem } from "@panora/sdk/models/components"; + +let value: TaxItem = { + name: "Federal Income Tax", + amount: 250, + employerTax: true, +}; +``` ## Fields diff --git a/docs/models/components/tokentype.md b/docs/models/components/tokentype.md index 5bfded68..308e9c5b 100644 --- a/docs/models/components/tokentype.md +++ b/docs/models/components/tokentype.md @@ -2,6 +2,13 @@ Strategy type +## Example Usage + +```typescript +import { TokenType } from "@panora/sdk/models/components"; + +let value: TokenType = TokenType.Oauth2; +``` ## Values diff --git a/docs/models/components/type.md b/docs/models/components/type.md index 8827a9eb..042642b4 100644 --- a/docs/models/components/type.md +++ b/docs/models/components/type.md @@ -2,6 +2,13 @@ The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK +## Example Usage + +```typescript +import { Type } from "@panora/sdk/models/components"; + +let value: Type = Type.Bug; +``` ## Values diff --git a/docs/models/components/unifiedaccountingaccountinput.md b/docs/models/components/unifiedaccountingaccountinput.md index 36a78c81..9c728f38 100644 --- a/docs/models/components/unifiedaccountingaccountinput.md +++ b/docs/models/components/unifiedaccountingaccountinput.md @@ -1,5 +1,24 @@ # UnifiedAccountingAccountInput +## Example Usage + +```typescript +import { UnifiedAccountingAccountInput, UnifiedAccountingAccountInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountInput = { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: UnifiedAccountingAccountInputCurrency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaccountinputcurrency.md b/docs/models/components/unifiedaccountingaccountinputcurrency.md index 6f013447..4335c259 100644 --- a/docs/models/components/unifiedaccountingaccountinputcurrency.md +++ b/docs/models/components/unifiedaccountingaccountinputcurrency.md @@ -2,6 +2,13 @@ The currency of the account +## Example Usage + +```typescript +import { UnifiedAccountingAccountInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountInputCurrency = UnifiedAccountingAccountInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingaccountinputfieldmappings.md b/docs/models/components/unifiedaccountingaccountinputfieldmappings.md index 3d47f0e0..2f1e10a4 100644 --- a/docs/models/components/unifiedaccountingaccountinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingaccountinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingAccountInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaccountoutput.md b/docs/models/components/unifiedaccountingaccountoutput.md index 319ebb54..ee09bf3d 100644 --- a/docs/models/components/unifiedaccountingaccountoutput.md +++ b/docs/models/components/unifiedaccountingaccountoutput.md @@ -1,5 +1,29 @@ # UnifiedAccountingAccountOutput +## Example Usage + +```typescript +import { Currency, UnifiedAccountingAccountOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountOutput = { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: Currency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "account_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaccountoutputfieldmappings.md b/docs/models/components/unifiedaccountingaccountoutputfieldmappings.md index 332aedc6..7530b45a 100644 --- a/docs/models/components/unifiedaccountingaccountoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingaccountoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingAccountOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaccountoutputremotedata.md b/docs/models/components/unifiedaccountingaccountoutputremotedata.md index e4ce7f28..274aa0e3 100644 --- a/docs/models/components/unifiedaccountingaccountoutputremotedata.md +++ b/docs/models/components/unifiedaccountingaccountoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the account in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingAccountOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAccountOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaddressoutput.md b/docs/models/components/unifiedaccountingaddressoutput.md index c4f7a92e..ed92c971 100644 --- a/docs/models/components/unifiedaccountingaddressoutput.md +++ b/docs/models/components/unifiedaccountingaddressoutput.md @@ -1,5 +1,29 @@ # UnifiedAccountingAddressOutput +## Example Usage + +```typescript +import { UnifiedAccountingAddressOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAddressOutput = { + type: "Billing", + street1: "123 Main St", + street2: "Apt 4B", + city: "New York", + state: "NY", + countrySubdivision: "New York", + country: "USA", + zip: "10001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "address_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaddressoutputfieldmappings.md b/docs/models/components/unifiedaccountingaddressoutputfieldmappings.md index e760a5ea..d5449782 100644 --- a/docs/models/components/unifiedaccountingaddressoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingaddressoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingAddressOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAddressOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingaddressoutputremotedata.md b/docs/models/components/unifiedaccountingaddressoutputremotedata.md index 9d4c2b7d..d67b3c29 100644 --- a/docs/models/components/unifiedaccountingaddressoutputremotedata.md +++ b/docs/models/components/unifiedaccountingaddressoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the address in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingAddressOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAddressOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingattachmentinput.md b/docs/models/components/unifiedaccountingattachmentinput.md index f1d50359..37b92e13 100644 --- a/docs/models/components/unifiedaccountingattachmentinput.md +++ b/docs/models/components/unifiedaccountingattachmentinput.md @@ -1,5 +1,17 @@ # UnifiedAccountingAttachmentInput +## Example Usage + +```typescript +import { UnifiedAccountingAttachmentInput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAttachmentInput = { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingattachmentinputfieldmappings.md b/docs/models/components/unifiedaccountingattachmentinputfieldmappings.md index 0024e831..d89d89e9 100644 --- a/docs/models/components/unifiedaccountingattachmentinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingattachmentinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingAttachmentInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAttachmentInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingattachmentoutput.md b/docs/models/components/unifiedaccountingattachmentoutput.md index ca606127..54609de5 100644 --- a/docs/models/components/unifiedaccountingattachmentoutput.md +++ b/docs/models/components/unifiedaccountingattachmentoutput.md @@ -1,5 +1,22 @@ # UnifiedAccountingAttachmentOutput +## Example Usage + +```typescript +import { UnifiedAccountingAttachmentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAttachmentOutput = { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "attachment_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingattachmentoutputfieldmappings.md b/docs/models/components/unifiedaccountingattachmentoutputfieldmappings.md index ef0bb039..a79b486b 100644 --- a/docs/models/components/unifiedaccountingattachmentoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingattachmentoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingAttachmentOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAttachmentOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingattachmentoutputremotedata.md b/docs/models/components/unifiedaccountingattachmentoutputremotedata.md index 949f6a0b..f18bfd57 100644 --- a/docs/models/components/unifiedaccountingattachmentoutputremotedata.md +++ b/docs/models/components/unifiedaccountingattachmentoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the attachment in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingAttachmentOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingAttachmentOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingbalancesheetoutput.md b/docs/models/components/unifiedaccountingbalancesheetoutput.md index 75434d29..c2e86755 100644 --- a/docs/models/components/unifiedaccountingbalancesheetoutput.md +++ b/docs/models/components/unifiedaccountingbalancesheetoutput.md @@ -1,5 +1,41 @@ # UnifiedAccountingBalancesheetOutput +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutput, UnifiedAccountingBalancesheetOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingBalancesheetOutput = { + name: "Q2 2024 Balance Sheet", + currency: UnifiedAccountingBalancesheetOutputCurrency.Usd, + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + date: new Date("2024-06-30T23:59:59Z"), + netAssets: 1000000, + assets: ["Cash", "Accounts Receivable", "Inventory"], + liabilities: ["Accounts Payable", "Long-term Debt"], + equity: ["Common Stock", "Retained Earnings"], + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "balancesheet_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingbalancesheetoutputcurrency.md b/docs/models/components/unifiedaccountingbalancesheetoutputcurrency.md index 77c884c9..7a6b0c77 100644 --- a/docs/models/components/unifiedaccountingbalancesheetoutputcurrency.md +++ b/docs/models/components/unifiedaccountingbalancesheetoutputcurrency.md @@ -2,6 +2,14 @@ The currency used in the balance sheet +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingBalancesheetOutputCurrency = + UnifiedAccountingBalancesheetOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingbalancesheetoutputfieldmappings.md b/docs/models/components/unifiedaccountingbalancesheetoutputfieldmappings.md index b027e05b..d4c57b18 100644 --- a/docs/models/components/unifiedaccountingbalancesheetoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingbalancesheetoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingBalancesheetOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingbalancesheetoutputremotedata.md b/docs/models/components/unifiedaccountingbalancesheetoutputremotedata.md index da3acd28..29cc5dd4 100644 --- a/docs/models/components/unifiedaccountingbalancesheetoutputremotedata.md +++ b/docs/models/components/unifiedaccountingbalancesheetoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the balance sheet in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingBalancesheetOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcashflowstatementoutput.md b/docs/models/components/unifiedaccountingcashflowstatementoutput.md index e9a43aa1..a880debf 100644 --- a/docs/models/components/unifiedaccountingcashflowstatementoutput.md +++ b/docs/models/components/unifiedaccountingcashflowstatementoutput.md @@ -1,5 +1,43 @@ # UnifiedAccountingCashflowstatementOutput +## Example Usage + +```typescript +import { + UnifiedAccountingCashflowstatementOutput, + UnifiedAccountingCashflowstatementOutputCurrency, +} from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCashflowstatementOutput = { + name: "Q2 2024 Cash Flow Statement", + currency: UnifiedAccountingCashflowstatementOutputCurrency.Usd, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + cashAtBeginningOfPeriod: 1000000, + cashAtEndOfPeriod: 1200000, + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "cashflowstatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcashflowstatementoutputcurrency.md b/docs/models/components/unifiedaccountingcashflowstatementoutputcurrency.md index 6cfab72a..83e27180 100644 --- a/docs/models/components/unifiedaccountingcashflowstatementoutputcurrency.md +++ b/docs/models/components/unifiedaccountingcashflowstatementoutputcurrency.md @@ -2,6 +2,14 @@ The currency used in the cash flow statement +## Example Usage + +```typescript +import { UnifiedAccountingCashflowstatementOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCashflowstatementOutputCurrency = + UnifiedAccountingCashflowstatementOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingcashflowstatementoutputfieldmappings.md b/docs/models/components/unifiedaccountingcashflowstatementoutputfieldmappings.md index c614af1e..85afc4c1 100644 --- a/docs/models/components/unifiedaccountingcashflowstatementoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingcashflowstatementoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingCashflowstatementOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCashflowstatementOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcashflowstatementoutputremotedata.md b/docs/models/components/unifiedaccountingcashflowstatementoutputremotedata.md index afd5722e..2c6e91b2 100644 --- a/docs/models/components/unifiedaccountingcashflowstatementoutputremotedata.md +++ b/docs/models/components/unifiedaccountingcashflowstatementoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the cash flow statement in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingCashflowstatementOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCashflowstatementOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcompanyinfooutput.md b/docs/models/components/unifiedaccountingcompanyinfooutput.md index d81d22fc..8d53e002 100644 --- a/docs/models/components/unifiedaccountingcompanyinfooutput.md +++ b/docs/models/components/unifiedaccountingcompanyinfooutput.md @@ -1,5 +1,31 @@ # UnifiedAccountingCompanyinfoOutput +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutput, UnifiedAccountingCompanyinfoOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCompanyinfoOutput = { + name: "Acme Corporation", + legalName: "Acme Corporation LLC", + taxNumber: "123456789", + fiscalYearEndMonth: 12, + fiscalYearEndDay: 31, + currency: UnifiedAccountingCompanyinfoOutputCurrency.Usd, + urls: ["https://www.acmecorp.com", "https://store.acmecorp.com"], + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcompanyinfooutputcurrency.md b/docs/models/components/unifiedaccountingcompanyinfooutputcurrency.md index b5fa1514..6bb13776 100644 --- a/docs/models/components/unifiedaccountingcompanyinfooutputcurrency.md +++ b/docs/models/components/unifiedaccountingcompanyinfooutputcurrency.md @@ -2,6 +2,14 @@ The currency used by the company +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCompanyinfoOutputCurrency = + UnifiedAccountingCompanyinfoOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingcompanyinfooutputfieldmappings.md b/docs/models/components/unifiedaccountingcompanyinfooutputfieldmappings.md index 75227c22..dccf7b01 100644 --- a/docs/models/components/unifiedaccountingcompanyinfooutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingcompanyinfooutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCompanyinfoOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcompanyinfooutputremotedata.md b/docs/models/components/unifiedaccountingcompanyinfooutputremotedata.md index fda8a76a..e28dfbe4 100644 --- a/docs/models/components/unifiedaccountingcompanyinfooutputremotedata.md +++ b/docs/models/components/unifiedaccountingcompanyinfooutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the company info in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCompanyinfoOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcontactinput.md b/docs/models/components/unifiedaccountingcontactinput.md index 91a377fd..55278d05 100644 --- a/docs/models/components/unifiedaccountingcontactinput.md +++ b/docs/models/components/unifiedaccountingcontactinput.md @@ -1,5 +1,23 @@ # UnifiedAccountingContactInput +## Example Usage + +```typescript +import { UnifiedAccountingContactInput, UnifiedAccountingContactInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactInput = { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactInputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcontactinputcurrency.md b/docs/models/components/unifiedaccountingcontactinputcurrency.md index e7846909..a5ff6263 100644 --- a/docs/models/components/unifiedaccountingcontactinputcurrency.md +++ b/docs/models/components/unifiedaccountingcontactinputcurrency.md @@ -2,6 +2,13 @@ The currency associated with the contact +## Example Usage + +```typescript +import { UnifiedAccountingContactInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactInputCurrency = UnifiedAccountingContactInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingcontactinputfieldmappings.md b/docs/models/components/unifiedaccountingcontactinputfieldmappings.md index 7310a031..08f15700 100644 --- a/docs/models/components/unifiedaccountingcontactinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingcontactinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingContactInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcontactoutput.md b/docs/models/components/unifiedaccountingcontactoutput.md index 89f69d32..68194c35 100644 --- a/docs/models/components/unifiedaccountingcontactoutput.md +++ b/docs/models/components/unifiedaccountingcontactoutput.md @@ -1,5 +1,28 @@ # UnifiedAccountingContactOutput +## Example Usage + +```typescript +import { UnifiedAccountingContactOutput, UnifiedAccountingContactOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactOutput = { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactOutputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "contact_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcontactoutputcurrency.md b/docs/models/components/unifiedaccountingcontactoutputcurrency.md index e6c8588a..ded2bd6f 100644 --- a/docs/models/components/unifiedaccountingcontactoutputcurrency.md +++ b/docs/models/components/unifiedaccountingcontactoutputcurrency.md @@ -2,6 +2,13 @@ The currency associated with the contact +## Example Usage + +```typescript +import { UnifiedAccountingContactOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactOutputCurrency = UnifiedAccountingContactOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingcontactoutputfieldmappings.md b/docs/models/components/unifiedaccountingcontactoutputfieldmappings.md index a8e995e8..455e4ace 100644 --- a/docs/models/components/unifiedaccountingcontactoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingcontactoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingContactOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcontactoutputremotedata.md b/docs/models/components/unifiedaccountingcontactoutputremotedata.md index 8594d083..f3e2089e 100644 --- a/docs/models/components/unifiedaccountingcontactoutputremotedata.md +++ b/docs/models/components/unifiedaccountingcontactoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the contact in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingContactOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingContactOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcreditnoteoutput.md b/docs/models/components/unifiedaccountingcreditnoteoutput.md index 26644181..bed5332c 100644 --- a/docs/models/components/unifiedaccountingcreditnoteoutput.md +++ b/docs/models/components/unifiedaccountingcreditnoteoutput.md @@ -1,5 +1,34 @@ # UnifiedAccountingCreditnoteOutput +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutput, UnifiedAccountingCreditnoteOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCreditnoteOutput = { + transactionDate: new Date("2024-06-15T12:00:00Z"), + status: "Issued", + number: "CN-001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + exchangeRate: "1.2", + totalAmount: 10000, + remainingCredit: 5000, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + currency: UnifiedAccountingCreditnoteOutputCurrency.Usd, + payments: ["PAYMENT-001", "PAYMENT-002"], + appliedPayments: ["APPLIED-001", "APPLIED-002"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "creditnote_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcreditnoteoutputcurrency.md b/docs/models/components/unifiedaccountingcreditnoteoutputcurrency.md index dbd49ca7..d2453a18 100644 --- a/docs/models/components/unifiedaccountingcreditnoteoutputcurrency.md +++ b/docs/models/components/unifiedaccountingcreditnoteoutputcurrency.md @@ -2,6 +2,14 @@ The currency of the credit note +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCreditnoteOutputCurrency = + UnifiedAccountingCreditnoteOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingcreditnoteoutputfieldmappings.md b/docs/models/components/unifiedaccountingcreditnoteoutputfieldmappings.md index 7ef32458..9c43c259 100644 --- a/docs/models/components/unifiedaccountingcreditnoteoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingcreditnoteoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCreditnoteOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingcreditnoteoutputremotedata.md b/docs/models/components/unifiedaccountingcreditnoteoutputremotedata.md index 96e2baed..a9d8a0ef 100644 --- a/docs/models/components/unifiedaccountingcreditnoteoutputremotedata.md +++ b/docs/models/components/unifiedaccountingcreditnoteoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the credit note in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingCreditnoteOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingexpenseinput.md b/docs/models/components/unifiedaccountingexpenseinput.md index f8ac1d63..08c00fbe 100644 --- a/docs/models/components/unifiedaccountingexpenseinput.md +++ b/docs/models/components/unifiedaccountingexpenseinput.md @@ -1,5 +1,38 @@ # UnifiedAccountingExpenseInput +## Example Usage + +```typescript +import { UnifiedAccountingExpenseInput, UnifiedAccountingExpenseInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseInput = { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseInputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingexpenseinputcurrency.md b/docs/models/components/unifiedaccountingexpenseinputcurrency.md index 3de9b5f0..1c1a3775 100644 --- a/docs/models/components/unifiedaccountingexpenseinputcurrency.md +++ b/docs/models/components/unifiedaccountingexpenseinputcurrency.md @@ -2,6 +2,13 @@ The currency of the expense +## Example Usage + +```typescript +import { UnifiedAccountingExpenseInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseInputCurrency = UnifiedAccountingExpenseInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingexpenseinputfieldmappings.md b/docs/models/components/unifiedaccountingexpenseinputfieldmappings.md index 34e60262..fbb97c5b 100644 --- a/docs/models/components/unifiedaccountingexpenseinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingexpenseinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingExpenseInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingexpenseoutput.md b/docs/models/components/unifiedaccountingexpenseoutput.md index 3249753f..13ede575 100644 --- a/docs/models/components/unifiedaccountingexpenseoutput.md +++ b/docs/models/components/unifiedaccountingexpenseoutput.md @@ -1,5 +1,44 @@ # UnifiedAccountingExpenseOutput +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutput, UnifiedAccountingExpenseOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseOutput = { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseOutputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "expense_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingexpenseoutputcurrency.md b/docs/models/components/unifiedaccountingexpenseoutputcurrency.md index ffbfcfa4..6728b5e8 100644 --- a/docs/models/components/unifiedaccountingexpenseoutputcurrency.md +++ b/docs/models/components/unifiedaccountingexpenseoutputcurrency.md @@ -2,6 +2,13 @@ The currency of the expense +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseOutputCurrency = UnifiedAccountingExpenseOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingexpenseoutputfieldmappings.md b/docs/models/components/unifiedaccountingexpenseoutputfieldmappings.md index 1f3dd380..329f2a23 100644 --- a/docs/models/components/unifiedaccountingexpenseoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingexpenseoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingexpenseoutputremotedata.md b/docs/models/components/unifiedaccountingexpenseoutputremotedata.md index 89f072ad..668f1634 100644 --- a/docs/models/components/unifiedaccountingexpenseoutputremotedata.md +++ b/docs/models/components/unifiedaccountingexpenseoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the expense in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingExpenseOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingincomestatementoutput.md b/docs/models/components/unifiedaccountingincomestatementoutput.md index 1472a5dc..7a48f96f 100644 --- a/docs/models/components/unifiedaccountingincomestatementoutput.md +++ b/docs/models/components/unifiedaccountingincomestatementoutput.md @@ -1,5 +1,29 @@ # UnifiedAccountingIncomestatementOutput +## Example Usage + +```typescript +import { + UnifiedAccountingIncomestatementOutput, + UnifiedAccountingIncomestatementOutputCurrency, +} from "@panora/sdk/models/components"; + +let value: UnifiedAccountingIncomestatementOutput = { + name: "Q2 2024 Income Statement", + currency: UnifiedAccountingIncomestatementOutputCurrency.Usd, + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + grossProfit: 1000000, + netOperatingIncome: 800000, + netIncome: 750000, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "incomestatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingincomestatementoutputcurrency.md b/docs/models/components/unifiedaccountingincomestatementoutputcurrency.md index 6c1450cf..9daa5fa7 100644 --- a/docs/models/components/unifiedaccountingincomestatementoutputcurrency.md +++ b/docs/models/components/unifiedaccountingincomestatementoutputcurrency.md @@ -2,6 +2,14 @@ The currency used in the income statement +## Example Usage + +```typescript +import { UnifiedAccountingIncomestatementOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingIncomestatementOutputCurrency = + UnifiedAccountingIncomestatementOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingincomestatementoutputfieldmappings.md b/docs/models/components/unifiedaccountingincomestatementoutputfieldmappings.md index 4e7c4557..264d554e 100644 --- a/docs/models/components/unifiedaccountingincomestatementoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingincomestatementoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingIncomestatementOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingIncomestatementOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingincomestatementoutputremotedata.md b/docs/models/components/unifiedaccountingincomestatementoutputremotedata.md index 3f86df67..dd459956 100644 --- a/docs/models/components/unifiedaccountingincomestatementoutputremotedata.md +++ b/docs/models/components/unifiedaccountingincomestatementoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the income statement in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingIncomestatementOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingIncomestatementOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountinginvoiceinput.md b/docs/models/components/unifiedaccountinginvoiceinput.md index 626b1263..640099c1 100644 --- a/docs/models/components/unifiedaccountinginvoiceinput.md +++ b/docs/models/components/unifiedaccountinginvoiceinput.md @@ -1,5 +1,47 @@ # UnifiedAccountingInvoiceInput +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceInput, UnifiedAccountingInvoiceInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceInput = { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceInputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountinginvoiceinputcurrency.md b/docs/models/components/unifiedaccountinginvoiceinputcurrency.md index 8e3ee1fe..0566164b 100644 --- a/docs/models/components/unifiedaccountinginvoiceinputcurrency.md +++ b/docs/models/components/unifiedaccountinginvoiceinputcurrency.md @@ -2,6 +2,13 @@ The currency of the invoice +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceInputCurrency = UnifiedAccountingInvoiceInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountinginvoiceinputfieldmappings.md b/docs/models/components/unifiedaccountinginvoiceinputfieldmappings.md index c44b2cc3..ea882aef 100644 --- a/docs/models/components/unifiedaccountinginvoiceinputfieldmappings.md +++ b/docs/models/components/unifiedaccountinginvoiceinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountinginvoiceoutput.md b/docs/models/components/unifiedaccountinginvoiceoutput.md index 283672b9..a244ca81 100644 --- a/docs/models/components/unifiedaccountinginvoiceoutput.md +++ b/docs/models/components/unifiedaccountinginvoiceoutput.md @@ -1,5 +1,53 @@ # UnifiedAccountingInvoiceOutput +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutput, UnifiedAccountingInvoiceOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceOutput = { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceOutputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "invoice_1234", + remoteData: {}, + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountinginvoiceoutputcurrency.md b/docs/models/components/unifiedaccountinginvoiceoutputcurrency.md index f8d8de38..f80a07d9 100644 --- a/docs/models/components/unifiedaccountinginvoiceoutputcurrency.md +++ b/docs/models/components/unifiedaccountinginvoiceoutputcurrency.md @@ -2,6 +2,13 @@ The currency of the invoice +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceOutputCurrency = UnifiedAccountingInvoiceOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountinginvoiceoutputfieldmappings.md b/docs/models/components/unifiedaccountinginvoiceoutputfieldmappings.md index a7873a8b..258067b1 100644 --- a/docs/models/components/unifiedaccountinginvoiceoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountinginvoiceoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountinginvoiceoutputremotedata.md b/docs/models/components/unifiedaccountinginvoiceoutputremotedata.md index b6653500..8189a0b3 100644 --- a/docs/models/components/unifiedaccountinginvoiceoutputremotedata.md +++ b/docs/models/components/unifiedaccountinginvoiceoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the invoice in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingInvoiceOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingitemoutput.md b/docs/models/components/unifiedaccountingitemoutput.md index bc0786c6..e34731fd 100644 --- a/docs/models/components/unifiedaccountingitemoutput.md +++ b/docs/models/components/unifiedaccountingitemoutput.md @@ -1,5 +1,27 @@ # UnifiedAccountingItemOutput +## Example Usage + +```typescript +import { UnifiedAccountingItemOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingItemOutput = { + name: "Product A", + status: "Active", + unitPrice: 1000, + purchasePrice: 800, + salesAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + purchaseAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "item_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingitemoutputfieldmappings.md b/docs/models/components/unifiedaccountingitemoutputfieldmappings.md index 571f7577..cf31037d 100644 --- a/docs/models/components/unifiedaccountingitemoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingitemoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingItemOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingItemOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingitemoutputremotedata.md b/docs/models/components/unifiedaccountingitemoutputremotedata.md index f047e210..76546551 100644 --- a/docs/models/components/unifiedaccountingitemoutputremotedata.md +++ b/docs/models/components/unifiedaccountingitemoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the item in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingItemOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingItemOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingjournalentryinput.md b/docs/models/components/unifiedaccountingjournalentryinput.md index 7c0a36f8..211348c3 100644 --- a/docs/models/components/unifiedaccountingjournalentryinput.md +++ b/docs/models/components/unifiedaccountingjournalentryinput.md @@ -1,5 +1,38 @@ # UnifiedAccountingJournalentryInput +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryInput, UnifiedAccountingJournalentryInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryInput = { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: ["payment1", "payment2"], + appliedPayments: ["appliedPayment1", "appliedPayment2"], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryInputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingjournalentryinputcurrency.md b/docs/models/components/unifiedaccountingjournalentryinputcurrency.md index 527fec25..7dcfd74c 100644 --- a/docs/models/components/unifiedaccountingjournalentryinputcurrency.md +++ b/docs/models/components/unifiedaccountingjournalentryinputcurrency.md @@ -2,6 +2,14 @@ The currency of the journal entry +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryInputCurrency = + UnifiedAccountingJournalentryInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingjournalentryinputfieldmappings.md b/docs/models/components/unifiedaccountingjournalentryinputfieldmappings.md index f1956b47..004f8844 100644 --- a/docs/models/components/unifiedaccountingjournalentryinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingjournalentryinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingjournalentryoutput.md b/docs/models/components/unifiedaccountingjournalentryoutput.md index a9db49bf..ede74051 100644 --- a/docs/models/components/unifiedaccountingjournalentryoutput.md +++ b/docs/models/components/unifiedaccountingjournalentryoutput.md @@ -1,5 +1,45 @@ # UnifiedAccountingJournalentryOutput +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutput, UnifiedAccountingJournalentryOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryOutput = { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: ["payment1", "payment2"], + appliedPayments: ["appliedPayment1", "appliedPayment2"], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryOutputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "journal_entry_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteModiifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingjournalentryoutputcurrency.md b/docs/models/components/unifiedaccountingjournalentryoutputcurrency.md index 8bba8c75..9fd61df8 100644 --- a/docs/models/components/unifiedaccountingjournalentryoutputcurrency.md +++ b/docs/models/components/unifiedaccountingjournalentryoutputcurrency.md @@ -2,6 +2,14 @@ The currency of the journal entry +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryOutputCurrency = + UnifiedAccountingJournalentryOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingjournalentryoutputfieldmappings.md b/docs/models/components/unifiedaccountingjournalentryoutputfieldmappings.md index e75cb5c3..18ff57fd 100644 --- a/docs/models/components/unifiedaccountingjournalentryoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingjournalentryoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingjournalentryoutputremotedata.md b/docs/models/components/unifiedaccountingjournalentryoutputremotedata.md index 11eb0d19..a817c193 100644 --- a/docs/models/components/unifiedaccountingjournalentryoutputremotedata.md +++ b/docs/models/components/unifiedaccountingjournalentryoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the journal entry in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingJournalentryOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpaymentinput.md b/docs/models/components/unifiedaccountingpaymentinput.md index a5927d7f..2879d7ed 100644 --- a/docs/models/components/unifiedaccountingpaymentinput.md +++ b/docs/models/components/unifiedaccountingpaymentinput.md @@ -1,5 +1,38 @@ # UnifiedAccountingPaymentInput +## Example Usage + +```typescript +import { UnifiedAccountingPaymentInput, UnifiedAccountingPaymentInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentInput = { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentInputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpaymentinputcurrency.md b/docs/models/components/unifiedaccountingpaymentinputcurrency.md index 20cda911..5ceefb81 100644 --- a/docs/models/components/unifiedaccountingpaymentinputcurrency.md +++ b/docs/models/components/unifiedaccountingpaymentinputcurrency.md @@ -2,6 +2,13 @@ The currency of the payment +## Example Usage + +```typescript +import { UnifiedAccountingPaymentInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentInputCurrency = UnifiedAccountingPaymentInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingpaymentinputfieldmappings.md b/docs/models/components/unifiedaccountingpaymentinputfieldmappings.md index 08b9634b..8d11b5ff 100644 --- a/docs/models/components/unifiedaccountingpaymentinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingpaymentinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingPaymentInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpaymentoutput.md b/docs/models/components/unifiedaccountingpaymentoutput.md index dd5b7351..e3afddb1 100644 --- a/docs/models/components/unifiedaccountingpaymentoutput.md +++ b/docs/models/components/unifiedaccountingpaymentoutput.md @@ -1,5 +1,44 @@ # UnifiedAccountingPaymentOutput +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutput, UnifiedAccountingPaymentOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentOutput = { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentOutputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payment_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpaymentoutputcurrency.md b/docs/models/components/unifiedaccountingpaymentoutputcurrency.md index 6a216a2f..fbb6c16c 100644 --- a/docs/models/components/unifiedaccountingpaymentoutputcurrency.md +++ b/docs/models/components/unifiedaccountingpaymentoutputcurrency.md @@ -2,6 +2,13 @@ The currency of the payment +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentOutputCurrency = UnifiedAccountingPaymentOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingpaymentoutputfieldmappings.md b/docs/models/components/unifiedaccountingpaymentoutputfieldmappings.md index 1ca72bd6..281f328f 100644 --- a/docs/models/components/unifiedaccountingpaymentoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingpaymentoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpaymentoutputremotedata.md b/docs/models/components/unifiedaccountingpaymentoutputremotedata.md index a6c9f405..199fe601 100644 --- a/docs/models/components/unifiedaccountingpaymentoutputremotedata.md +++ b/docs/models/components/unifiedaccountingpaymentoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the payment in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPaymentOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingphonenumberoutput.md b/docs/models/components/unifiedaccountingphonenumberoutput.md index 3019317d..b61e7822 100644 --- a/docs/models/components/unifiedaccountingphonenumberoutput.md +++ b/docs/models/components/unifiedaccountingphonenumberoutput.md @@ -1,5 +1,23 @@ # UnifiedAccountingPhonenumberOutput +## Example Usage + +```typescript +import { UnifiedAccountingPhonenumberOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPhonenumberOutput = { + number: "+1234567890", + type: "Mobile", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "phone_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingphonenumberoutputfieldmappings.md b/docs/models/components/unifiedaccountingphonenumberoutputfieldmappings.md index c42fb673..749cfc7b 100644 --- a/docs/models/components/unifiedaccountingphonenumberoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingphonenumberoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingPhonenumberOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPhonenumberOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingphonenumberoutputremotedata.md b/docs/models/components/unifiedaccountingphonenumberoutputremotedata.md index 9a612518..84a56c35 100644 --- a/docs/models/components/unifiedaccountingphonenumberoutputremotedata.md +++ b/docs/models/components/unifiedaccountingphonenumberoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the phone number in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingPhonenumberOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPhonenumberOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpurchaseorderinput.md b/docs/models/components/unifiedaccountingpurchaseorderinput.md index 6219cc8f..593131be 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderinput.md +++ b/docs/models/components/unifiedaccountingpurchaseorderinput.md @@ -1,5 +1,41 @@ # UnifiedAccountingPurchaseorderInput +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderInput, UnifiedAccountingPurchaseorderInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderInput = { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderInputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpurchaseorderinputcurrency.md b/docs/models/components/unifiedaccountingpurchaseorderinputcurrency.md index 33a2e1cd..81115c33 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderinputcurrency.md +++ b/docs/models/components/unifiedaccountingpurchaseorderinputcurrency.md @@ -2,6 +2,14 @@ The currency of the purchase order +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderInputCurrency = + UnifiedAccountingPurchaseorderInputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingpurchaseorderinputfieldmappings.md b/docs/models/components/unifiedaccountingpurchaseorderinputfieldmappings.md index 6fbc99b2..8abe1174 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderinputfieldmappings.md +++ b/docs/models/components/unifiedaccountingpurchaseorderinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpurchaseorderoutput.md b/docs/models/components/unifiedaccountingpurchaseorderoutput.md index 6d3124d1..6e22fd35 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderoutput.md +++ b/docs/models/components/unifiedaccountingpurchaseorderoutput.md @@ -1,5 +1,51 @@ # UnifiedAccountingPurchaseorderOutput +## Example Usage + +```typescript +import { + UnifiedAccountingPurchaseorderOutput, + UnifiedAccountingPurchaseorderOutputCurrency, +} from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderOutput = { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderOutputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "po_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpurchaseorderoutputcurrency.md b/docs/models/components/unifiedaccountingpurchaseorderoutputcurrency.md index 9702c08b..31e04ea5 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderoutputcurrency.md +++ b/docs/models/components/unifiedaccountingpurchaseorderoutputcurrency.md @@ -2,6 +2,14 @@ The currency of the purchase order +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderOutputCurrency = + UnifiedAccountingPurchaseorderOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingpurchaseorderoutputfieldmappings.md b/docs/models/components/unifiedaccountingpurchaseorderoutputfieldmappings.md index be56d797..c196fd5f 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingpurchaseorderoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingpurchaseorderoutputremotedata.md b/docs/models/components/unifiedaccountingpurchaseorderoutputremotedata.md index 22ae8ce2..a180cebc 100644 --- a/docs/models/components/unifiedaccountingpurchaseorderoutputremotedata.md +++ b/docs/models/components/unifiedaccountingpurchaseorderoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the purchase order in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingPurchaseorderOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtaxrateoutput.md b/docs/models/components/unifiedaccountingtaxrateoutput.md index 2dc0138b..fd646924 100644 --- a/docs/models/components/unifiedaccountingtaxrateoutput.md +++ b/docs/models/components/unifiedaccountingtaxrateoutput.md @@ -1,5 +1,23 @@ # UnifiedAccountingTaxrateOutput +## Example Usage + +```typescript +import { UnifiedAccountingTaxrateOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTaxrateOutput = { + description: "VAT 20%", + totalTaxRatge: 2000, + effectiveTaxRate: 1900, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tax_rate_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtaxrateoutputfieldmappings.md b/docs/models/components/unifiedaccountingtaxrateoutputfieldmappings.md index d7fa5415..cf4f8fae 100644 --- a/docs/models/components/unifiedaccountingtaxrateoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingtaxrateoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingTaxrateOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTaxrateOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtaxrateoutputremotedata.md b/docs/models/components/unifiedaccountingtaxrateoutputremotedata.md index bfc2c48a..f33cbef7 100644 --- a/docs/models/components/unifiedaccountingtaxrateoutputremotedata.md +++ b/docs/models/components/unifiedaccountingtaxrateoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the tax rate in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingTaxrateOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTaxrateOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtrackingcategoryoutput.md b/docs/models/components/unifiedaccountingtrackingcategoryoutput.md index 916202b2..e83a2da7 100644 --- a/docs/models/components/unifiedaccountingtrackingcategoryoutput.md +++ b/docs/models/components/unifiedaccountingtrackingcategoryoutput.md @@ -1,5 +1,23 @@ # UnifiedAccountingTrackingcategoryOutput +## Example Usage + +```typescript +import { UnifiedAccountingTrackingcategoryOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTrackingcategoryOutput = { + name: "Department", + status: "Active", + categoryType: "Expense", + parentCategory: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tracking_category_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtrackingcategoryoutputfieldmappings.md b/docs/models/components/unifiedaccountingtrackingcategoryoutputfieldmappings.md index aaf1bc78..32af1ad1 100644 --- a/docs/models/components/unifiedaccountingtrackingcategoryoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingtrackingcategoryoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingTrackingcategoryOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTrackingcategoryOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtrackingcategoryoutputremotedata.md b/docs/models/components/unifiedaccountingtrackingcategoryoutputremotedata.md index 3f8a2029..f622f940 100644 --- a/docs/models/components/unifiedaccountingtrackingcategoryoutputremotedata.md +++ b/docs/models/components/unifiedaccountingtrackingcategoryoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the tracking category in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingTrackingcategoryOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTrackingcategoryOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtransactionoutput.md b/docs/models/components/unifiedaccountingtransactionoutput.md index 2ecad437..d009f837 100644 --- a/docs/models/components/unifiedaccountingtransactionoutput.md +++ b/docs/models/components/unifiedaccountingtransactionoutput.md @@ -1,5 +1,44 @@ # UnifiedAccountingTransactionOutput +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutput, UnifiedAccountingTransactionOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTransactionOutput = { + transactionType: "Sale", + number: "1001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: "1000", + exchangeRate: "1.2", + currency: UnifiedAccountingTransactionOutputCurrency.Usd, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtransactionoutputcurrency.md b/docs/models/components/unifiedaccountingtransactionoutputcurrency.md index 2ac41128..1fc8bcd6 100644 --- a/docs/models/components/unifiedaccountingtransactionoutputcurrency.md +++ b/docs/models/components/unifiedaccountingtransactionoutputcurrency.md @@ -2,6 +2,14 @@ The currency of the transaction +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTransactionOutputCurrency = + UnifiedAccountingTransactionOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingtransactionoutputfieldmappings.md b/docs/models/components/unifiedaccountingtransactionoutputfieldmappings.md index 8fb2eb4f..622691e2 100644 --- a/docs/models/components/unifiedaccountingtransactionoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingtransactionoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTransactionOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingtransactionoutputremotedata.md b/docs/models/components/unifiedaccountingtransactionoutputremotedata.md index faba4503..c6f875d9 100644 --- a/docs/models/components/unifiedaccountingtransactionoutputremotedata.md +++ b/docs/models/components/unifiedaccountingtransactionoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the tracking category in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingTransactionOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingvendorcreditoutput.md b/docs/models/components/unifiedaccountingvendorcreditoutput.md index 4d967c9d..c41e43ee 100644 --- a/docs/models/components/unifiedaccountingvendorcreditoutput.md +++ b/docs/models/components/unifiedaccountingvendorcreditoutput.md @@ -1,5 +1,42 @@ # UnifiedAccountingVendorcreditOutput +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutput, UnifiedAccountingVendorcreditOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingVendorcreditOutput = { + number: "VC-001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: "1000", + currency: UnifiedAccountingVendorcreditOutputCurrency.Usd, + exchangeRate: "1.2", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingvendorcreditoutputcurrency.md b/docs/models/components/unifiedaccountingvendorcreditoutputcurrency.md index 51fa5036..71ec4bed 100644 --- a/docs/models/components/unifiedaccountingvendorcreditoutputcurrency.md +++ b/docs/models/components/unifiedaccountingvendorcreditoutputcurrency.md @@ -2,6 +2,14 @@ The currency of the vendor credit +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingVendorcreditOutputCurrency = + UnifiedAccountingVendorcreditOutputCurrency.Usd; +``` ## Values diff --git a/docs/models/components/unifiedaccountingvendorcreditoutputfieldmappings.md b/docs/models/components/unifiedaccountingvendorcreditoutputfieldmappings.md index cad807fa..f47d4b02 100644 --- a/docs/models/components/unifiedaccountingvendorcreditoutputfieldmappings.md +++ b/docs/models/components/unifiedaccountingvendorcreditoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingVendorcreditOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedaccountingvendorcreditoutputremotedata.md b/docs/models/components/unifiedaccountingvendorcreditoutputremotedata.md index 74db2d86..dca70640 100644 --- a/docs/models/components/unifiedaccountingvendorcreditoutputremotedata.md +++ b/docs/models/components/unifiedaccountingvendorcreditoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the vendor credit in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedAccountingVendorcreditOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedatsactivityinput.md b/docs/models/components/unifiedatsactivityinput.md index fbe1535c..fe6f160f 100644 --- a/docs/models/components/unifiedatsactivityinput.md +++ b/docs/models/components/unifiedatsactivityinput.md @@ -1,5 +1,27 @@ # UnifiedAtsActivityInput +## Example Usage + +```typescript +import { + UnifiedAtsActivityInput, + UnifiedAtsActivityInputActivityType, + UnifiedAtsActivityInputVisibility, +} from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsactivityinputactivitytype.md b/docs/models/components/unifiedatsactivityinputactivitytype.md index 1f69dff4..6f1f7d04 100644 --- a/docs/models/components/unifiedatsactivityinputactivitytype.md +++ b/docs/models/components/unifiedatsactivityinputactivitytype.md @@ -2,6 +2,13 @@ The type of activity +## Example Usage + +```typescript +import { UnifiedAtsActivityInputActivityType } from "@panora/sdk/models/components"; + +let value: UnifiedAtsActivityInputActivityType = UnifiedAtsActivityInputActivityType.Note; +``` ## Values diff --git a/docs/models/components/unifiedatsactivityinputvisibility.md b/docs/models/components/unifiedatsactivityinputvisibility.md index 6d8157b3..4aef6952 100644 --- a/docs/models/components/unifiedatsactivityinputvisibility.md +++ b/docs/models/components/unifiedatsactivityinputvisibility.md @@ -2,6 +2,13 @@ The visibility of the activity +## Example Usage + +```typescript +import { UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; + +let value: UnifiedAtsActivityInputVisibility = UnifiedAtsActivityInputVisibility.Public; +``` ## Values diff --git a/docs/models/components/unifiedatsactivityoutput.md b/docs/models/components/unifiedatsactivityoutput.md index 97f26f95..bebccd4f 100644 --- a/docs/models/components/unifiedatsactivityoutput.md +++ b/docs/models/components/unifiedatsactivityoutput.md @@ -1,5 +1,31 @@ # UnifiedAtsActivityOutput +## Example Usage + +```typescript +import { ActivityType, UnifiedAtsActivityOutput, Visibility } from "@panora/sdk/models/components"; + +let value: UnifiedAtsActivityOutput = { + activityType: ActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: Visibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsapplicationinput.md b/docs/models/components/unifiedatsapplicationinput.md index 1afbd076..cd73e0ca 100644 --- a/docs/models/components/unifiedatsapplicationinput.md +++ b/docs/models/components/unifiedatsapplicationinput.md @@ -1,5 +1,26 @@ # UnifiedAtsApplicationInput +## Example Usage + +```typescript +import { UnifiedAtsApplicationInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsapplicationoutput.md b/docs/models/components/unifiedatsapplicationoutput.md index f6105a42..3e48bcf9 100644 --- a/docs/models/components/unifiedatsapplicationoutput.md +++ b/docs/models/components/unifiedatsapplicationoutput.md @@ -1,5 +1,34 @@ # UnifiedAtsApplicationOutput +## Example Usage + +```typescript +import { UnifiedAtsApplicationOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsApplicationOutput = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsattachmentinput.md b/docs/models/components/unifiedatsattachmentinput.md index 41d26721..f84f4f72 100644 --- a/docs/models/components/unifiedatsattachmentinput.md +++ b/docs/models/components/unifiedatsattachmentinput.md @@ -1,5 +1,23 @@ # UnifiedAtsAttachmentInput +## Example Usage + +```typescript +import { UnifiedAtsAttachmentInput, UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsattachmentinputattachmenttype.md b/docs/models/components/unifiedatsattachmentinputattachmenttype.md index 4de1cd4e..b84166fa 100644 --- a/docs/models/components/unifiedatsattachmentinputattachmenttype.md +++ b/docs/models/components/unifiedatsattachmentinputattachmenttype.md @@ -2,6 +2,13 @@ The type of the file +## Example Usage + +```typescript +import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; + +let value: UnifiedAtsAttachmentInputAttachmentType = UnifiedAtsAttachmentInputAttachmentType.Resume; +``` ## Values diff --git a/docs/models/components/unifiedatsattachmentoutput.md b/docs/models/components/unifiedatsattachmentoutput.md index 0fbe7397..e8d15e61 100644 --- a/docs/models/components/unifiedatsattachmentoutput.md +++ b/docs/models/components/unifiedatsattachmentoutput.md @@ -1,5 +1,31 @@ # UnifiedAtsAttachmentOutput +## Example Usage + +```typescript +import { AttachmentType, UnifiedAtsAttachmentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsAttachmentOutput = { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: AttachmentType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatscandidateinput.md b/docs/models/components/unifiedatscandidateinput.md index c0f5154c..bb4bcc44 100644 --- a/docs/models/components/unifiedatscandidateinput.md +++ b/docs/models/components/unifiedatscandidateinput.md @@ -1,5 +1,48 @@ # UnifiedAtsCandidateInput +## Example Usage + +```typescript +import { EmailAddressType, PhoneType, UnifiedAtsCandidateInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatscandidateinputapplications.md b/docs/models/components/unifiedatscandidateinputapplications.md index 6020078f..f8ae5d53 100644 --- a/docs/models/components/unifiedatscandidateinputapplications.md +++ b/docs/models/components/unifiedatscandidateinputapplications.md @@ -1,5 +1,12 @@ # UnifiedAtsCandidateInputApplications +## Example Usage + +```typescript +import { UnifiedAtsCandidateInputApplications } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateInputApplications = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedatscandidateinputattachments.md b/docs/models/components/unifiedatscandidateinputattachments.md index c82210f0..45d96752 100644 --- a/docs/models/components/unifiedatscandidateinputattachments.md +++ b/docs/models/components/unifiedatscandidateinputattachments.md @@ -1,5 +1,12 @@ # UnifiedAtsCandidateInputAttachments +## Example Usage + +```typescript +import { UnifiedAtsCandidateInputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateInputAttachments = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedatscandidateinputtags.md b/docs/models/components/unifiedatscandidateinputtags.md index fbd92bc1..e400c3ad 100644 --- a/docs/models/components/unifiedatscandidateinputtags.md +++ b/docs/models/components/unifiedatscandidateinputtags.md @@ -1,5 +1,27 @@ # UnifiedAtsCandidateInputTags +## Example Usage + +```typescript +import { UnifiedAtsCandidateInputTags } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateInputTags = { + name: "Important", + idAtsCandidate: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/unifiedatscandidateoutput.md b/docs/models/components/unifiedatscandidateoutput.md index 6bd2cc42..f3f95a0c 100644 --- a/docs/models/components/unifiedatscandidateoutput.md +++ b/docs/models/components/unifiedatscandidateoutput.md @@ -1,5 +1,56 @@ # UnifiedAtsCandidateOutput +## Example Usage + +```typescript +import { EmailAddressType, PhoneType, UnifiedAtsCandidateOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateOutput = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatscandidateoutputattachments.md b/docs/models/components/unifiedatscandidateoutputattachments.md index e5b5ed04..9a08e00e 100644 --- a/docs/models/components/unifiedatscandidateoutputattachments.md +++ b/docs/models/components/unifiedatscandidateoutputattachments.md @@ -1,5 +1,31 @@ # UnifiedAtsCandidateOutputAttachments +## Example Usage + +```typescript +import { AttachmentType, UnifiedAtsCandidateOutputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateOutputAttachments = { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: AttachmentType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/unifiedatscandidateoutputtags.md b/docs/models/components/unifiedatscandidateoutputtags.md index 06b2e62f..d3001030 100644 --- a/docs/models/components/unifiedatscandidateoutputtags.md +++ b/docs/models/components/unifiedatscandidateoutputtags.md @@ -1,5 +1,27 @@ # UnifiedAtsCandidateOutputTags +## Example Usage + +```typescript +import { UnifiedAtsCandidateOutputTags } from "@panora/sdk/models/components"; + +let value: UnifiedAtsCandidateOutputTags = { + name: "Important", + idAtsCandidate: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/unifiedatsdepartmentoutput.md b/docs/models/components/unifiedatsdepartmentoutput.md index bbb03a8a..b78ae5cc 100644 --- a/docs/models/components/unifiedatsdepartmentoutput.md +++ b/docs/models/components/unifiedatsdepartmentoutput.md @@ -1,5 +1,27 @@ # UnifiedAtsDepartmentOutput +## Example Usage + +```typescript +import { UnifiedAtsDepartmentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsDepartmentOutput = { + name: "Sales", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatseeocsoutput.md b/docs/models/components/unifiedatseeocsoutput.md index a811c131..b5391d3c 100644 --- a/docs/models/components/unifiedatseeocsoutput.md +++ b/docs/models/components/unifiedatseeocsoutput.md @@ -1,5 +1,37 @@ # UnifiedAtsEeocsOutput +## Example Usage + +```typescript +import { + DisabilityStatus, + Race, + UnifiedAtsEeocsOutput, + UnifiedAtsEeocsOutputGender, + VeteranStatus, +} from "@panora/sdk/models/components"; + +let value: UnifiedAtsEeocsOutput = { + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + submittedAt: new Date("2024-10-01T12:00:00Z"), + race: Race.AmericanIndianOrAlaskanNative, + gender: UnifiedAtsEeocsOutputGender.Male, + veteranStatus: VeteranStatus.IAmNotAProtectedVeteran, + disabilityStatus: DisabilityStatus.YesIHaveADisabilityOrPreviouslyHadADisability, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatseeocsoutputgender.md b/docs/models/components/unifiedatseeocsoutputgender.md index 2240ebd1..7e74d438 100644 --- a/docs/models/components/unifiedatseeocsoutputgender.md +++ b/docs/models/components/unifiedatseeocsoutputgender.md @@ -2,6 +2,13 @@ The gender of the candidate +## Example Usage + +```typescript +import { UnifiedAtsEeocsOutputGender } from "@panora/sdk/models/components"; + +let value: UnifiedAtsEeocsOutputGender = UnifiedAtsEeocsOutputGender.Male; +``` ## Values diff --git a/docs/models/components/unifiedatsinterviewinput.md b/docs/models/components/unifiedatsinterviewinput.md index 8766a1ac..943dfa47 100644 --- a/docs/models/components/unifiedatsinterviewinput.md +++ b/docs/models/components/unifiedatsinterviewinput.md @@ -1,5 +1,27 @@ # UnifiedAtsInterviewInput +## Example Usage + +```typescript +import { UnifiedAtsInterviewInput, UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsinterviewinputstatus.md b/docs/models/components/unifiedatsinterviewinputstatus.md index 886b8476..d0e4a9ba 100644 --- a/docs/models/components/unifiedatsinterviewinputstatus.md +++ b/docs/models/components/unifiedatsinterviewinputstatus.md @@ -2,6 +2,13 @@ The status of the interview +## Example Usage + +```typescript +import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsInterviewInputStatus = UnifiedAtsInterviewInputStatus.Scheduled; +``` ## Values diff --git a/docs/models/components/unifiedatsinterviewoutput.md b/docs/models/components/unifiedatsinterviewoutput.md index d889f441..de60cf44 100644 --- a/docs/models/components/unifiedatsinterviewoutput.md +++ b/docs/models/components/unifiedatsinterviewoutput.md @@ -1,5 +1,35 @@ # UnifiedAtsInterviewOutput +## Example Usage + +```typescript +import { UnifiedAtsInterviewOutput, UnifiedAtsInterviewOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsInterviewOutput = { + status: UnifiedAtsInterviewOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsinterviewoutputstatus.md b/docs/models/components/unifiedatsinterviewoutputstatus.md index e9a21b12..b79f3e25 100644 --- a/docs/models/components/unifiedatsinterviewoutputstatus.md +++ b/docs/models/components/unifiedatsinterviewoutputstatus.md @@ -2,6 +2,13 @@ The status of the interview +## Example Usage + +```typescript +import { UnifiedAtsInterviewOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsInterviewOutputStatus = UnifiedAtsInterviewOutputStatus.Scheduled; +``` ## Values diff --git a/docs/models/components/unifiedatsjobinterviewstageoutput.md b/docs/models/components/unifiedatsjobinterviewstageoutput.md index 1e3e117e..342dbdbb 100644 --- a/docs/models/components/unifiedatsjobinterviewstageoutput.md +++ b/docs/models/components/unifiedatsjobinterviewstageoutput.md @@ -1,5 +1,28 @@ # UnifiedAtsJobinterviewstageOutput +## Example Usage + +```typescript +import { UnifiedAtsJobinterviewstageOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsJobinterviewstageOutput = { + name: "Second Call", + stageOrder: 1, + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsjoboutput.md b/docs/models/components/unifiedatsjoboutput.md index 69ee1627..92d91ba9 100644 --- a/docs/models/components/unifiedatsjoboutput.md +++ b/docs/models/components/unifiedatsjoboutput.md @@ -1,5 +1,38 @@ # UnifiedAtsJobOutput +## Example Usage + +```typescript +import { UnifiedAtsJobOutput, UnifiedAtsJobOutputStatus, UnifiedAtsJobOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedAtsJobOutput = { + name: "Financial Analyst", + description: "Extract financial data and write detailed investment thesis", + code: "JOB123", + status: UnifiedAtsJobOutputStatus.Open, + type: UnifiedAtsJobOutputType.Posting, + confidential: true, + departments: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + offices: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + managers: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + recruiters: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsjoboutputstatus.md b/docs/models/components/unifiedatsjoboutputstatus.md index 9ce4ca53..e8898543 100644 --- a/docs/models/components/unifiedatsjoboutputstatus.md +++ b/docs/models/components/unifiedatsjoboutputstatus.md @@ -2,6 +2,13 @@ The status of the job +## Example Usage + +```typescript +import { UnifiedAtsJobOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsJobOutputStatus = UnifiedAtsJobOutputStatus.Open; +``` ## Values diff --git a/docs/models/components/unifiedatsjoboutputtype.md b/docs/models/components/unifiedatsjoboutputtype.md index c2c768d5..eccc2b1d 100644 --- a/docs/models/components/unifiedatsjoboutputtype.md +++ b/docs/models/components/unifiedatsjoboutputtype.md @@ -2,6 +2,13 @@ The type of the job +## Example Usage + +```typescript +import { UnifiedAtsJobOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedAtsJobOutputType = UnifiedAtsJobOutputType.Posting; +``` ## Values diff --git a/docs/models/components/unifiedatsofferoutput.md b/docs/models/components/unifiedatsofferoutput.md index 84d707a5..c7f9d816 100644 --- a/docs/models/components/unifiedatsofferoutput.md +++ b/docs/models/components/unifiedatsofferoutput.md @@ -1,5 +1,32 @@ # UnifiedAtsOfferOutput +## Example Usage + +```typescript +import { UnifiedAtsOfferOutput, UnifiedAtsOfferOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsOfferOutput = { + createdBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + closedAt: new Date("2024-10-01T12:00:00Z"), + sentAt: new Date("2024-10-01T12:00:00Z"), + startDate: new Date("2024-10-01T12:00:00Z"), + status: UnifiedAtsOfferOutputStatus.Draft, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsofferoutputcreatedat.md b/docs/models/components/unifiedatsofferoutputcreatedat.md index edd5213b..1111b5c0 100644 --- a/docs/models/components/unifiedatsofferoutputcreatedat.md +++ b/docs/models/components/unifiedatsofferoutputcreatedat.md @@ -2,6 +2,13 @@ The created date of the object +## Example Usage + +```typescript +import { UnifiedAtsOfferOutputCreatedAt } from "@panora/sdk/models/components"; + +let value: UnifiedAtsOfferOutputCreatedAt = {}; +``` ## Fields diff --git a/docs/models/components/unifiedatsofferoutputmodifiedat.md b/docs/models/components/unifiedatsofferoutputmodifiedat.md index 409dffa2..6e3a53ea 100644 --- a/docs/models/components/unifiedatsofferoutputmodifiedat.md +++ b/docs/models/components/unifiedatsofferoutputmodifiedat.md @@ -2,6 +2,13 @@ The modified date of the object +## Example Usage + +```typescript +import { UnifiedAtsOfferOutputModifiedAt } from "@panora/sdk/models/components"; + +let value: UnifiedAtsOfferOutputModifiedAt = {}; +``` ## Fields diff --git a/docs/models/components/unifiedatsofferoutputstatus.md b/docs/models/components/unifiedatsofferoutputstatus.md index 58e8fa9e..428763c0 100644 --- a/docs/models/components/unifiedatsofferoutputstatus.md +++ b/docs/models/components/unifiedatsofferoutputstatus.md @@ -2,6 +2,13 @@ The status of the offer +## Example Usage + +```typescript +import { UnifiedAtsOfferOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedAtsOfferOutputStatus = UnifiedAtsOfferOutputStatus.Draft; +``` ## Values diff --git a/docs/models/components/unifiedatsofficeoutput.md b/docs/models/components/unifiedatsofficeoutput.md index 355b65d1..7218a3bc 100644 --- a/docs/models/components/unifiedatsofficeoutput.md +++ b/docs/models/components/unifiedatsofficeoutput.md @@ -1,5 +1,27 @@ # UnifiedAtsOfficeOutput +## Example Usage + +```typescript +import { UnifiedAtsOfficeOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsOfficeOutput = { + name: "Condo Office 5th", + location: "New York", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsrejectreasonoutput.md b/docs/models/components/unifiedatsrejectreasonoutput.md index a18f0d13..b3bb9305 100644 --- a/docs/models/components/unifiedatsrejectreasonoutput.md +++ b/docs/models/components/unifiedatsrejectreasonoutput.md @@ -1,5 +1,26 @@ # UnifiedAtsRejectreasonOutput +## Example Usage + +```typescript +import { UnifiedAtsRejectreasonOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsRejectreasonOutput = { + name: "Candidate inexperienced", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsscorecardoutput.md b/docs/models/components/unifiedatsscorecardoutput.md index 35edcd16..115dc3b9 100644 --- a/docs/models/components/unifiedatsscorecardoutput.md +++ b/docs/models/components/unifiedatsscorecardoutput.md @@ -1,5 +1,30 @@ # UnifiedAtsScorecardOutput +## Example Usage + +```typescript +import { OverallRecommendation, UnifiedAtsScorecardOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsScorecardOutput = { + overallRecommendation: OverallRecommendation.Yes, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + submittedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatstagoutput.md b/docs/models/components/unifiedatstagoutput.md index 47e74e92..e4bb1679 100644 --- a/docs/models/components/unifiedatstagoutput.md +++ b/docs/models/components/unifiedatstagoutput.md @@ -1,5 +1,27 @@ # UnifiedAtsTagOutput +## Example Usage + +```typescript +import { UnifiedAtsTagOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsTagOutput = { + name: "Important", + idAtsCandidate: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedatsuseroutput.md b/docs/models/components/unifiedatsuseroutput.md index 5ff8e9c0..b3f93bf0 100644 --- a/docs/models/components/unifiedatsuseroutput.md +++ b/docs/models/components/unifiedatsuseroutput.md @@ -1,5 +1,32 @@ # UnifiedAtsUserOutput +## Example Usage + +```typescript +import { AccessRole, UnifiedAtsUserOutput } from "@panora/sdk/models/components"; + +let value: UnifiedAtsUserOutput = { + firstName: "John", + lastName: "Doe", + email: "john.doe@example.com", + disabled: false, + accessRole: AccessRole.Admin, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmcompanyinput.md b/docs/models/components/unifiedcrmcompanyinput.md index 0abae6cf..fb872397 100644 --- a/docs/models/components/unifiedcrmcompanyinput.md +++ b/docs/models/components/unifiedcrmcompanyinput.md @@ -1,5 +1,51 @@ # UnifiedCrmCompanyInput +## Example Usage + +```typescript +import { + AddressType, + EmailAddressType, + PhoneType, + UnifiedCrmCompanyInput, + UnifiedCrmCompanyInputIndustry, +} from "@panora/sdk/models/components"; + +let value: 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: "Street 2", + city: "New York", + state: "NY", + postalCode: "10001", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmcompanyinputindustry.md b/docs/models/components/unifiedcrmcompanyinputindustry.md index 5eb3e9bd..034264a1 100644 --- a/docs/models/components/unifiedcrmcompanyinputindustry.md +++ b/docs/models/components/unifiedcrmcompanyinputindustry.md @@ -2,6 +2,13 @@ The industry of the company. Authorized values can be found in the Industry enum. +## Example Usage + +```typescript +import { UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; + +let value: UnifiedCrmCompanyInputIndustry = UnifiedCrmCompanyInputIndustry.Accounting; +``` ## Values diff --git a/docs/models/components/unifiedcrmcompanyoutput.md b/docs/models/components/unifiedcrmcompanyoutput.md index 7e9eecb0..2bbb289a 100644 --- a/docs/models/components/unifiedcrmcompanyoutput.md +++ b/docs/models/components/unifiedcrmcompanyoutput.md @@ -1,5 +1,53 @@ # UnifiedCrmCompanyOutput +## Example Usage + +```typescript +import { AddressType, EmailAddressType, Industry, PhoneType, UnifiedCrmCompanyOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmCompanyOutput = { + name: "Acme", + industry: Industry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "NY", + postalCode: "10001", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmcontactinput.md b/docs/models/components/unifiedcrmcontactinput.md index d3e2dee5..1c9f4a6c 100644 --- a/docs/models/components/unifiedcrmcontactinput.md +++ b/docs/models/components/unifiedcrmcontactinput.md @@ -1,5 +1,44 @@ # UnifiedCrmContactInput +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType, UnifiedCrmContactInput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmContactInput = { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Rita.Will87@yahoo.com", + emailAddressType: EmailAddressType.Work, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmcontactoutput.md b/docs/models/components/unifiedcrmcontactoutput.md index 3276763e..1f5cab84 100644 --- a/docs/models/components/unifiedcrmcontactoutput.md +++ b/docs/models/components/unifiedcrmcontactoutput.md @@ -1,5 +1,52 @@ # UnifiedCrmContactOutput +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType, UnifiedCrmContactOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmContactOutput = { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Rocky.Bernier@hotmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Mobile, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmdealinput.md b/docs/models/components/unifiedcrmdealinput.md index f5bdc027..7135fdba 100644 --- a/docs/models/components/unifiedcrmdealinput.md +++ b/docs/models/components/unifiedcrmdealinput.md @@ -1,5 +1,23 @@ # UnifiedCrmDealInput +## Example Usage + +```typescript +import { UnifiedCrmDealInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmdealoutput.md b/docs/models/components/unifiedcrmdealoutput.md index 2908b1b8..8104d66c 100644 --- a/docs/models/components/unifiedcrmdealoutput.md +++ b/docs/models/components/unifiedcrmdealoutput.md @@ -1,5 +1,31 @@ # UnifiedCrmDealOutput +## Example Usage + +```typescript +import { UnifiedCrmDealOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmDealOutput = { + 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", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmengagementinput.md b/docs/models/components/unifiedcrmengagementinput.md index a5077630..cb96e3d2 100644 --- a/docs/models/components/unifiedcrmengagementinput.md +++ b/docs/models/components/unifiedcrmengagementinput.md @@ -1,5 +1,30 @@ # UnifiedCrmEngagementInput +## Example Usage + +```typescript +import { + UnifiedCrmEngagementInput, + UnifiedCrmEngagementInputDirection, + UnifiedCrmEngagementInputType, +} from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmengagementinputdirection.md b/docs/models/components/unifiedcrmengagementinputdirection.md index f3d45f10..6d6be472 100644 --- a/docs/models/components/unifiedcrmengagementinputdirection.md +++ b/docs/models/components/unifiedcrmengagementinputdirection.md @@ -2,6 +2,13 @@ The direction of the engagement. Authorized values are INBOUND or OUTBOUND +## Example Usage + +```typescript +import { UnifiedCrmEngagementInputDirection } from "@panora/sdk/models/components"; + +let value: UnifiedCrmEngagementInputDirection = UnifiedCrmEngagementInputDirection.Inbound; +``` ## Values diff --git a/docs/models/components/unifiedcrmengagementinputtype.md b/docs/models/components/unifiedcrmengagementinputtype.md index ed4569cc..4da7e57a 100644 --- a/docs/models/components/unifiedcrmengagementinputtype.md +++ b/docs/models/components/unifiedcrmengagementinputtype.md @@ -2,6 +2,13 @@ The type of the engagement. Authorized values are EMAIL, CALL or MEETING +## Example Usage + +```typescript +import { UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; + +let value: UnifiedCrmEngagementInputType = UnifiedCrmEngagementInputType.Meeting; +``` ## Values diff --git a/docs/models/components/unifiedcrmengagementoutput.md b/docs/models/components/unifiedcrmengagementoutput.md index 8d5a279d..9b653198 100644 --- a/docs/models/components/unifiedcrmengagementoutput.md +++ b/docs/models/components/unifiedcrmengagementoutput.md @@ -1,5 +1,34 @@ # UnifiedCrmEngagementOutput +## Example Usage + +```typescript +import { Direction, UnifiedCrmEngagementOutput, UnifiedCrmEngagementOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedCrmEngagementOutput = { + content: "Meeting call with CTO", + direction: Direction.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementOutputType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmengagementoutputtype.md b/docs/models/components/unifiedcrmengagementoutputtype.md index 8280419f..8456fa3f 100644 --- a/docs/models/components/unifiedcrmengagementoutputtype.md +++ b/docs/models/components/unifiedcrmengagementoutputtype.md @@ -2,6 +2,13 @@ The type of the engagement. Authorized values are EMAIL, CALL or MEETING +## Example Usage + +```typescript +import { UnifiedCrmEngagementOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedCrmEngagementOutputType = UnifiedCrmEngagementOutputType.Meeting; +``` ## Values diff --git a/docs/models/components/unifiedcrmnoteinput.md b/docs/models/components/unifiedcrmnoteinput.md index 87cbaee3..bea7032b 100644 --- a/docs/models/components/unifiedcrmnoteinput.md +++ b/docs/models/components/unifiedcrmnoteinput.md @@ -1,5 +1,22 @@ # UnifiedCrmNoteInput +## Example Usage + +```typescript +import { UnifiedCrmNoteInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmnoteoutput.md b/docs/models/components/unifiedcrmnoteoutput.md index 22d537e0..8e283507 100644 --- a/docs/models/components/unifiedcrmnoteoutput.md +++ b/docs/models/components/unifiedcrmnoteoutput.md @@ -1,5 +1,30 @@ # UnifiedCrmNoteOutput +## Example Usage + +```typescript +import { UnifiedCrmNoteOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmNoteOutput = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmstageoutput.md b/docs/models/components/unifiedcrmstageoutput.md index c707e12d..a9e08070 100644 --- a/docs/models/components/unifiedcrmstageoutput.md +++ b/docs/models/components/unifiedcrmstageoutput.md @@ -1,5 +1,26 @@ # UnifiedCrmStageOutput +## Example Usage + +```typescript +import { UnifiedCrmStageOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmStageOutput = { + stageName: "Qualified", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmstageoutputcreatedat.md b/docs/models/components/unifiedcrmstageoutputcreatedat.md index 73e3ef5e..8268b96f 100644 --- a/docs/models/components/unifiedcrmstageoutputcreatedat.md +++ b/docs/models/components/unifiedcrmstageoutputcreatedat.md @@ -2,6 +2,13 @@ The created date of the object +## Example Usage + +```typescript +import { UnifiedCrmStageOutputCreatedAt } from "@panora/sdk/models/components"; + +let value: UnifiedCrmStageOutputCreatedAt = {}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmstageoutputmodifiedat.md b/docs/models/components/unifiedcrmstageoutputmodifiedat.md index 2111f08d..ee20df76 100644 --- a/docs/models/components/unifiedcrmstageoutputmodifiedat.md +++ b/docs/models/components/unifiedcrmstageoutputmodifiedat.md @@ -2,6 +2,13 @@ The modified date of the object +## Example Usage + +```typescript +import { UnifiedCrmStageOutputModifiedAt } from "@panora/sdk/models/components"; + +let value: UnifiedCrmStageOutputModifiedAt = {}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmtaskinput.md b/docs/models/components/unifiedcrmtaskinput.md index 142256e0..ca7f2cc9 100644 --- a/docs/models/components/unifiedcrmtaskinput.md +++ b/docs/models/components/unifiedcrmtaskinput.md @@ -1,5 +1,25 @@ # UnifiedCrmTaskInput +## Example Usage + +```typescript +import { UnifiedCrmTaskInput, UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmtaskinputstatus.md b/docs/models/components/unifiedcrmtaskinputstatus.md index 55238e06..17b95cd3 100644 --- a/docs/models/components/unifiedcrmtaskinputstatus.md +++ b/docs/models/components/unifiedcrmtaskinputstatus.md @@ -2,6 +2,13 @@ The status of the task. Authorized values are PENDING, COMPLETED. +## Example Usage + +```typescript +import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedCrmTaskInputStatus = UnifiedCrmTaskInputStatus.Pending; +``` ## Values diff --git a/docs/models/components/unifiedcrmtaskoutput.md b/docs/models/components/unifiedcrmtaskoutput.md index 44fa2131..dbacf1d1 100644 --- a/docs/models/components/unifiedcrmtaskoutput.md +++ b/docs/models/components/unifiedcrmtaskoutput.md @@ -1,5 +1,34 @@ # UnifiedCrmTaskOutput +## Example Usage + +```typescript +import { UnifiedCrmTaskOutput, UnifiedCrmTaskOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedCrmTaskOutput = { + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedcrmtaskoutputstatus.md b/docs/models/components/unifiedcrmtaskoutputstatus.md index f636356e..eb9ddd7b 100644 --- a/docs/models/components/unifiedcrmtaskoutputstatus.md +++ b/docs/models/components/unifiedcrmtaskoutputstatus.md @@ -2,6 +2,13 @@ The status of the task. Authorized values are PENDING, COMPLETED. +## Example Usage + +```typescript +import { UnifiedCrmTaskOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedCrmTaskOutputStatus = UnifiedCrmTaskOutputStatus.Pending; +``` ## Values diff --git a/docs/models/components/unifiedcrmuseroutput.md b/docs/models/components/unifiedcrmuseroutput.md index 02b10598..9e2caab9 100644 --- a/docs/models/components/unifiedcrmuseroutput.md +++ b/docs/models/components/unifiedcrmuseroutput.md @@ -1,5 +1,27 @@ # UnifiedCrmUserOutput +## Example Usage + +```typescript +import { UnifiedCrmUserOutput } from "@panora/sdk/models/components"; + +let value: UnifiedCrmUserOutput = { + name: "Jane Doe", + email: "jane.doe@example.com", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercecustomeroutput.md b/docs/models/components/unifiedecommercecustomeroutput.md index 21c03d36..33718095 100644 --- a/docs/models/components/unifiedecommercecustomeroutput.md +++ b/docs/models/components/unifiedecommercecustomeroutput.md @@ -1,5 +1,35 @@ # UnifiedEcommerceCustomerOutput +## Example Usage + +```typescript +import { AddressType, UnifiedEcommerceCustomerOutput } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceCustomerOutput = { + email: "joedoe@gmail.com", + firstName: "Joe", + lastName: "Doe", + phoneNumber: "+336666666", + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "New York", + postalCode: "10001", + country: "United States of America", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercecustomeroutputfieldmappings.md b/docs/models/components/unifiedecommercecustomeroutputfieldmappings.md index e1cbddec..5dccedb5 100644 --- a/docs/models/components/unifiedecommercecustomeroutputfieldmappings.md +++ b/docs/models/components/unifiedecommercecustomeroutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceCustomerOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceCustomerOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercecustomeroutputremotedata.md b/docs/models/components/unifiedecommercecustomeroutputremotedata.md index 738b6a99..fe9ff620 100644 --- a/docs/models/components/unifiedecommercecustomeroutputremotedata.md +++ b/docs/models/components/unifiedecommercecustomeroutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the customer in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedEcommerceCustomerOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceCustomerOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercefulfillmentoutput.md b/docs/models/components/unifiedecommercefulfillmentoutput.md index f53e50ad..cfe86a89 100644 --- a/docs/models/components/unifiedecommercefulfillmentoutput.md +++ b/docs/models/components/unifiedecommercefulfillmentoutput.md @@ -1,5 +1,24 @@ # UnifiedEcommerceFulfillmentOutput +## Example Usage + +```typescript +import { UnifiedEcommerceFulfillmentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceFulfillmentOutput = { + carrier: "DHL", + trackingUrls: ["https://tracing-url.sf.com"], + trackingNumbers: ["track_1029_191919"], + items: {}, + orderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercefulfillmentoutputfieldmappings.md b/docs/models/components/unifiedecommercefulfillmentoutputfieldmappings.md index 903e386e..0bd65f6c 100644 --- a/docs/models/components/unifiedecommercefulfillmentoutputfieldmappings.md +++ b/docs/models/components/unifiedecommercefulfillmentoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceFulfillmentOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceFulfillmentOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommercefulfillmentoutputremotedata.md b/docs/models/components/unifiedecommercefulfillmentoutputremotedata.md index f9a92ca3..f66bebe8 100644 --- a/docs/models/components/unifiedecommercefulfillmentoutputremotedata.md +++ b/docs/models/components/unifiedecommercefulfillmentoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the customer in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedEcommerceFulfillmentOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceFulfillmentOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceorderinput.md b/docs/models/components/unifiedecommerceorderinput.md index 0d33b27b..2abb9b18 100644 --- a/docs/models/components/unifiedecommerceorderinput.md +++ b/docs/models/components/unifiedecommerceorderinput.md @@ -1,5 +1,43 @@ # UnifiedEcommerceOrderInput +## Example Usage + +```typescript +import { + UnifiedEcommerceOrderInput, + UnifiedEcommerceOrderInputCurrency, + UnifiedEcommerceOrderInputFulfillmentStatus, + UnifiedEcommerceOrderInputOrderStatus, + UnifiedEcommerceOrderInputPaymentStatus, +} from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInput = { + orderStatus: UnifiedEcommerceOrderInputOrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: UnifiedEcommerceOrderInputPaymentStatus.Success, + currency: UnifiedEcommerceOrderInputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: UnifiedEcommerceOrderInputFulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceorderinputcurrency.md b/docs/models/components/unifiedecommerceorderinputcurrency.md index 1a72b08f..50350b61 100644 --- a/docs/models/components/unifiedecommerceorderinputcurrency.md +++ b/docs/models/components/unifiedecommerceorderinputcurrency.md @@ -2,6 +2,13 @@ The currency of the order. Authorized value must be of type CurrencyCode (ISO 4217) +## Example Usage + +```typescript +import { UnifiedEcommerceOrderInputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInputCurrency = UnifiedEcommerceOrderInputCurrency.Aud; +``` ## Values diff --git a/docs/models/components/unifiedecommerceorderinputfieldmappings.md b/docs/models/components/unifiedecommerceorderinputfieldmappings.md index 0e1ddbcd..b38d6f41 100644 --- a/docs/models/components/unifiedecommerceorderinputfieldmappings.md +++ b/docs/models/components/unifiedecommerceorderinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceOrderInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceorderinputfulfillmentstatus.md b/docs/models/components/unifiedecommerceorderinputfulfillmentstatus.md index d5543f61..b0f86de6 100644 --- a/docs/models/components/unifiedecommerceorderinputfulfillmentstatus.md +++ b/docs/models/components/unifiedecommerceorderinputfulfillmentstatus.md @@ -2,6 +2,14 @@ The fulfillment status of the order +## Example Usage + +```typescript +import { UnifiedEcommerceOrderInputFulfillmentStatus } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInputFulfillmentStatus = + UnifiedEcommerceOrderInputFulfillmentStatus.Pending; +``` ## Values diff --git a/docs/models/components/unifiedecommerceorderinputorderstatus.md b/docs/models/components/unifiedecommerceorderinputorderstatus.md index 212687d5..d4a418cd 100644 --- a/docs/models/components/unifiedecommerceorderinputorderstatus.md +++ b/docs/models/components/unifiedecommerceorderinputorderstatus.md @@ -2,6 +2,13 @@ The status of the order +## Example Usage + +```typescript +import { UnifiedEcommerceOrderInputOrderStatus } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInputOrderStatus = UnifiedEcommerceOrderInputOrderStatus.Unshipped; +``` ## Values diff --git a/docs/models/components/unifiedecommerceorderinputpaymentstatus.md b/docs/models/components/unifiedecommerceorderinputpaymentstatus.md index 59aaa928..5e28ecdc 100644 --- a/docs/models/components/unifiedecommerceorderinputpaymentstatus.md +++ b/docs/models/components/unifiedecommerceorderinputpaymentstatus.md @@ -2,6 +2,14 @@ The payment status of the order +## Example Usage + +```typescript +import { UnifiedEcommerceOrderInputPaymentStatus } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderInputPaymentStatus = + UnifiedEcommerceOrderInputPaymentStatus.Success; +``` ## Values diff --git a/docs/models/components/unifiedecommerceorderoutput.md b/docs/models/components/unifiedecommerceorderoutput.md index b27aca83..6da5e0aa 100644 --- a/docs/models/components/unifiedecommerceorderoutput.md +++ b/docs/models/components/unifiedecommerceorderoutput.md @@ -1,5 +1,48 @@ # UnifiedEcommerceOrderOutput +## Example Usage + +```typescript +import { + FulfillmentStatus, + OrderStatus, + PaymentStatus, + UnifiedEcommerceOrderOutput, + UnifiedEcommerceOrderOutputCurrency, +} from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderOutput = { + orderStatus: OrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: PaymentStatus.Success, + currency: UnifiedEcommerceOrderOutputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: FulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceorderoutputcurrency.md b/docs/models/components/unifiedecommerceorderoutputcurrency.md index bc0b3ba6..fed8eca9 100644 --- a/docs/models/components/unifiedecommerceorderoutputcurrency.md +++ b/docs/models/components/unifiedecommerceorderoutputcurrency.md @@ -2,6 +2,13 @@ The currency of the order. Authorized value must be of type CurrencyCode (ISO 4217) +## Example Usage + +```typescript +import { UnifiedEcommerceOrderOutputCurrency } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderOutputCurrency = UnifiedEcommerceOrderOutputCurrency.Aud; +``` ## Values diff --git a/docs/models/components/unifiedecommerceorderoutputfieldmappings.md b/docs/models/components/unifiedecommerceorderoutputfieldmappings.md index a7bca7f6..19128179 100644 --- a/docs/models/components/unifiedecommerceorderoutputfieldmappings.md +++ b/docs/models/components/unifiedecommerceorderoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceOrderOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceorderoutputremotedata.md b/docs/models/components/unifiedecommerceorderoutputremotedata.md index 5b6ef077..0e69634c 100644 --- a/docs/models/components/unifiedecommerceorderoutputremotedata.md +++ b/docs/models/components/unifiedecommerceorderoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the customer in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedEcommerceOrderOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceOrderOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceproductinput.md b/docs/models/components/unifiedecommerceproductinput.md index ab4316ee..8313f37f 100644 --- a/docs/models/components/unifiedecommerceproductinput.md +++ b/docs/models/components/unifiedecommerceproductinput.md @@ -1,5 +1,22 @@ # UnifiedEcommerceProductInput +## Example Usage + +```typescript +import { UnifiedEcommerceProductInput, UnifiedEcommerceProductInputProductStatus } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductInput = { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: UnifiedEcommerceProductInputProductStatus.Active, + imagesUrls: ["https://myproduct/image"], + description: "best tee ever", + vendor: "vendor_extern", + variants: [{}], + tags: ["tag_1"], + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceproductinputfieldmappings.md b/docs/models/components/unifiedecommerceproductinputfieldmappings.md index c99d1be5..39d7a7ca 100644 --- a/docs/models/components/unifiedecommerceproductinputfieldmappings.md +++ b/docs/models/components/unifiedecommerceproductinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceProductInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceproductinputproductstatus.md b/docs/models/components/unifiedecommerceproductinputproductstatus.md index 42fa9def..46df232c 100644 --- a/docs/models/components/unifiedecommerceproductinputproductstatus.md +++ b/docs/models/components/unifiedecommerceproductinputproductstatus.md @@ -2,6 +2,14 @@ The status of the product. Either ACTIVE, DRAFT OR ARCHIVED. +## Example Usage + +```typescript +import { UnifiedEcommerceProductInputProductStatus } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductInputProductStatus = + UnifiedEcommerceProductInputProductStatus.Active; +``` ## Values diff --git a/docs/models/components/unifiedecommerceproductoutput.md b/docs/models/components/unifiedecommerceproductoutput.md index d9db830c..190a346a 100644 --- a/docs/models/components/unifiedecommerceproductoutput.md +++ b/docs/models/components/unifiedecommerceproductoutput.md @@ -1,5 +1,27 @@ # UnifiedEcommerceProductOutput +## Example Usage + +```typescript +import { ProductStatus, UnifiedEcommerceProductOutput } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductOutput = { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: ProductStatus.Active, + imagesUrls: ["https://myproduct/image"], + description: "best tee ever", + vendor: "vendor_extern", + variants: [{}], + tags: ["tag_1"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", +}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceproductoutputfieldmappings.md b/docs/models/components/unifiedecommerceproductoutputfieldmappings.md index ce1af403..8d3f58a8 100644 --- a/docs/models/components/unifiedecommerceproductoutputfieldmappings.md +++ b/docs/models/components/unifiedecommerceproductoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedEcommerceProductOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedecommerceproductoutputremotedata.md b/docs/models/components/unifiedecommerceproductoutputremotedata.md index 86fd0ee6..b01dee9d 100644 --- a/docs/models/components/unifiedecommerceproductoutputremotedata.md +++ b/docs/models/components/unifiedecommerceproductoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the customer in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedEcommerceProductOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedEcommerceProductOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragedriveoutput.md b/docs/models/components/unifiedfilestoragedriveoutput.md index ffc53470..e14a1800 100644 --- a/docs/models/components/unifiedfilestoragedriveoutput.md +++ b/docs/models/components/unifiedfilestoragedriveoutput.md @@ -1,5 +1,28 @@ # UnifiedFilestorageDriveOutput +## Example Usage + +```typescript +import { UnifiedFilestorageDriveOutput } from "@panora/sdk/models/components"; + +let value: UnifiedFilestorageDriveOutput = { + name: "school", + remoteCreatedAt: "2024-10-01T12:00:00Z", + driveUrl: "https://example.com/school", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragefileinput.md b/docs/models/components/unifiedfilestoragefileinput.md index 49f8a3ed..7ca9a21d 100644 --- a/docs/models/components/unifiedfilestoragefileinput.md +++ b/docs/models/components/unifiedfilestoragefileinput.md @@ -1,5 +1,24 @@ # UnifiedFilestorageFileInput +## Example Usage + +```typescript +import { UnifiedFilestorageFileInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragefileoutput.md b/docs/models/components/unifiedfilestoragefileoutput.md index 380bb00a..1f95c398 100644 --- a/docs/models/components/unifiedfilestoragefileoutput.md +++ b/docs/models/components/unifiedfilestoragefileoutput.md @@ -1,5 +1,32 @@ # UnifiedFilestorageFileOutput +## Example Usage + +```typescript +import { UnifiedFilestorageFileOutput } from "@panora/sdk/models/components"; + +let value: UnifiedFilestorageFileOutput = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragefolderinput.md b/docs/models/components/unifiedfilestoragefolderinput.md index 15c33187..687b6538 100644 --- a/docs/models/components/unifiedfilestoragefolderinput.md +++ b/docs/models/components/unifiedfilestoragefolderinput.md @@ -1,5 +1,25 @@ # UnifiedFilestorageFolderInput +## Example Usage + +```typescript +import { UnifiedFilestorageFolderInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragefolderoutput.md b/docs/models/components/unifiedfilestoragefolderoutput.md index 97d3b6af..ee35b544 100644 --- a/docs/models/components/unifiedfilestoragefolderoutput.md +++ b/docs/models/components/unifiedfilestoragefolderoutput.md @@ -1,5 +1,33 @@ # UnifiedFilestorageFolderOutput +## Example Usage + +```typescript +import { UnifiedFilestorageFolderOutput } from "@panora/sdk/models/components"; + +let value: UnifiedFilestorageFolderOutput = { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestoragegroupoutput.md b/docs/models/components/unifiedfilestoragegroupoutput.md index 13222865..64b14e7a 100644 --- a/docs/models/components/unifiedfilestoragegroupoutput.md +++ b/docs/models/components/unifiedfilestoragegroupoutput.md @@ -1,5 +1,28 @@ # UnifiedFilestorageGroupOutput +## Example Usage + +```typescript +import { UnifiedFilestorageGroupOutput } from "@panora/sdk/models/components"; + +let value: UnifiedFilestorageGroupOutput = { + name: "My group", + users: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteWasDeleted: false, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedfilestorageuseroutput.md b/docs/models/components/unifiedfilestorageuseroutput.md index f2a88c93..9cfb214b 100644 --- a/docs/models/components/unifiedfilestorageuseroutput.md +++ b/docs/models/components/unifiedfilestorageuseroutput.md @@ -1,5 +1,28 @@ # UnifiedFilestorageUserOutput +## Example Usage + +```typescript +import { UnifiedFilestorageUserOutput } from "@panora/sdk/models/components"; + +let value: UnifiedFilestorageUserOutput = { + name: "Joe Doe", + email: "joe.doe@gmail.com", + isMe: true, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisbankinfooutput.md b/docs/models/components/unifiedhrisbankinfooutput.md index f2b33336..c1adef17 100644 --- a/docs/models/components/unifiedhrisbankinfooutput.md +++ b/docs/models/components/unifiedhrisbankinfooutput.md @@ -1,5 +1,26 @@ # UnifiedHrisBankinfoOutput +## Example Usage + +```typescript +import { AccountType, UnifiedHrisBankinfoOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisBankinfoOutput = { + accountType: AccountType.Checking, + bankName: "Bank of America", + accountNumber: "1234567890", + routingNumber: "021000021", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisbenefitoutput.md b/docs/models/components/unifiedhrisbenefitoutput.md index c919eaf3..633ef075 100644 --- a/docs/models/components/unifiedhrisbenefitoutput.md +++ b/docs/models/components/unifiedhrisbenefitoutput.md @@ -1,5 +1,28 @@ # UnifiedHrisBenefitOutput +## Example Usage + +```typescript +import { UnifiedHrisBenefitOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisBenefitOutput = { + providerName: "Health Insurance Provider", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeContribution: 100, + companyContribution: 200, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-12-31T23:59:59Z"), + employerBenefitId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisbenefitoutputfieldmappings.md b/docs/models/components/unifiedhrisbenefitoutputfieldmappings.md index bfa0ba77..0ead0f0e 100644 --- a/docs/models/components/unifiedhrisbenefitoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisbenefitoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisBenefitOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisBenefitOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisbenefitoutputremotedata.md b/docs/models/components/unifiedhrisbenefitoutputremotedata.md index 70d1765f..444382e7 100644 --- a/docs/models/components/unifiedhrisbenefitoutputremotedata.md +++ b/docs/models/components/unifiedhrisbenefitoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the benefit in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisBenefitOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisBenefitOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhriscompanyoutput.md b/docs/models/components/unifiedhriscompanyoutput.md index 5bdc661c..a2951e4b 100644 --- a/docs/models/components/unifiedhriscompanyoutput.md +++ b/docs/models/components/unifiedhriscompanyoutput.md @@ -1,5 +1,25 @@ # UnifiedHrisCompanyOutput +## Example Usage + +```typescript +import { UnifiedHrisCompanyOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisCompanyOutput = { + legalName: "Acme Corporation", + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + displayName: "Acme Corp", + eins: ["12-3456789", "98-7654321"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhriscompanyoutputfieldmappings.md b/docs/models/components/unifiedhriscompanyoutputfieldmappings.md index 19f6bef3..47930175 100644 --- a/docs/models/components/unifiedhriscompanyoutputfieldmappings.md +++ b/docs/models/components/unifiedhriscompanyoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisCompanyOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisCompanyOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhriscompanyoutputremotedata.md b/docs/models/components/unifiedhriscompanyoutputremotedata.md index 79cf9165..cbdedeac 100644 --- a/docs/models/components/unifiedhriscompanyoutputremotedata.md +++ b/docs/models/components/unifiedhriscompanyoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the company in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisCompanyOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisCompanyOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisdependentoutput.md b/docs/models/components/unifiedhrisdependentoutput.md index 3c60c63f..33349519 100644 --- a/docs/models/components/unifiedhrisdependentoutput.md +++ b/docs/models/components/unifiedhrisdependentoutput.md @@ -1,5 +1,32 @@ # UnifiedHrisDependentOutput +## Example Usage + +```typescript +import { Gender, Relationship, UnifiedHrisDependentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisDependentOutput = { + firstName: "John", + lastName: "Doe", + middleName: "Michael", + relationship: Relationship.Child, + dateOfBirth: new Date("2020-01-01"), + gender: Gender.Male, + phoneNumber: "+1234567890", + homeLocation: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + isStudent: true, + ssn: "123-45-6789", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "dependent_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisdependentoutputfieldmappings.md b/docs/models/components/unifiedhrisdependentoutputfieldmappings.md index b8b3944b..c5397c75 100644 --- a/docs/models/components/unifiedhrisdependentoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisdependentoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisDependentOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisDependentOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisdependentoutputremotedata.md b/docs/models/components/unifiedhrisdependentoutputremotedata.md index df04b7a4..c05cd26d 100644 --- a/docs/models/components/unifiedhrisdependentoutputremotedata.md +++ b/docs/models/components/unifiedhrisdependentoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the dependent in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisDependentOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisDependentOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeeinput.md b/docs/models/components/unifiedhrisemployeeinput.md index 1f45ec73..6a04c1f8 100644 --- a/docs/models/components/unifiedhrisemployeeinput.md +++ b/docs/models/components/unifiedhrisemployeeinput.md @@ -1,5 +1,43 @@ # UnifiedHrisEmployeeInput +## Example Usage + +```typescript +import { + UnifiedHrisEmployeeInput, + UnifiedHrisEmployeeInputEmploymentStatus, + UnifiedHrisEmployeeInputEthnicity, + UnifiedHrisEmployeeInputGender, + UnifiedHrisEmployeeInputMaritalStatus, +} from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInput = { + groups: ["Group1", "Group2"], + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + employeeNumber: "EMP001", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f", "801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeInputGender.Male, + ethnicity: UnifiedHrisEmployeeInputEthnicity.AmericanIndianOrAlaskaNative, + maritalStatus: UnifiedHrisEmployeeInputMaritalStatus.Single, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: UnifiedHrisEmployeeInputEmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeeinputemploymentstatus.md b/docs/models/components/unifiedhrisemployeeinputemploymentstatus.md index 7e0eb77d..fe5f5889 100644 --- a/docs/models/components/unifiedhrisemployeeinputemploymentstatus.md +++ b/docs/models/components/unifiedhrisemployeeinputemploymentstatus.md @@ -2,6 +2,14 @@ The employment status of the employee +## Example Usage + +```typescript +import { UnifiedHrisEmployeeInputEmploymentStatus } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInputEmploymentStatus = + UnifiedHrisEmployeeInputEmploymentStatus.Active; +``` ## Values diff --git a/docs/models/components/unifiedhrisemployeeinputethnicity.md b/docs/models/components/unifiedhrisemployeeinputethnicity.md index 58147e42..00f5ae5d 100644 --- a/docs/models/components/unifiedhrisemployeeinputethnicity.md +++ b/docs/models/components/unifiedhrisemployeeinputethnicity.md @@ -2,6 +2,14 @@ The ethnicity of the employee +## Example Usage + +```typescript +import { UnifiedHrisEmployeeInputEthnicity } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInputEthnicity = + UnifiedHrisEmployeeInputEthnicity.AmericanIndianOrAlaskaNative; +``` ## Values diff --git a/docs/models/components/unifiedhrisemployeeinputfieldmappings.md b/docs/models/components/unifiedhrisemployeeinputfieldmappings.md index c4e395d0..b861f559 100644 --- a/docs/models/components/unifiedhrisemployeeinputfieldmappings.md +++ b/docs/models/components/unifiedhrisemployeeinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisEmployeeInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeeinputgender.md b/docs/models/components/unifiedhrisemployeeinputgender.md index 8aa58f64..2ae4885d 100644 --- a/docs/models/components/unifiedhrisemployeeinputgender.md +++ b/docs/models/components/unifiedhrisemployeeinputgender.md @@ -2,6 +2,13 @@ The gender of the employee +## Example Usage + +```typescript +import { UnifiedHrisEmployeeInputGender } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInputGender = UnifiedHrisEmployeeInputGender.Male; +``` ## Values diff --git a/docs/models/components/unifiedhrisemployeeinputmaritalstatus.md b/docs/models/components/unifiedhrisemployeeinputmaritalstatus.md index e1b11469..c20dba5b 100644 --- a/docs/models/components/unifiedhrisemployeeinputmaritalstatus.md +++ b/docs/models/components/unifiedhrisemployeeinputmaritalstatus.md @@ -2,6 +2,14 @@ The marital status of the employee +## Example Usage + +```typescript +import { UnifiedHrisEmployeeInputMaritalStatus } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeInputMaritalStatus = + UnifiedHrisEmployeeInputMaritalStatus.HeadOfHousehold; +``` ## Values diff --git a/docs/models/components/unifiedhrisemployeeoutput.md b/docs/models/components/unifiedhrisemployeeoutput.md index 8a9a108c..ef68019e 100644 --- a/docs/models/components/unifiedhrisemployeeoutput.md +++ b/docs/models/components/unifiedhrisemployeeoutput.md @@ -1,5 +1,50 @@ # UnifiedHrisEmployeeOutput +## Example Usage + +```typescript +import { + EmploymentStatus, + Ethnicity, + MaritalStatus, + UnifiedHrisEmployeeOutput, + UnifiedHrisEmployeeOutputGender, +} from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeOutput = { + groups: ["Group1", "Group2"], + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + employeeNumber: "EMP001", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f", "801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeOutputGender.Male, + ethnicity: Ethnicity.AmericanIndianOrAlaskaNative, + maritalStatus: MaritalStatus.HeadOfHousehold, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: EmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employee_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeeoutputfieldmappings.md b/docs/models/components/unifiedhrisemployeeoutputfieldmappings.md index b4fe006f..39bdda1b 100644 --- a/docs/models/components/unifiedhrisemployeeoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisemployeeoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisEmployeeOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeeoutputgender.md b/docs/models/components/unifiedhrisemployeeoutputgender.md index ab74dd01..8440e6ab 100644 --- a/docs/models/components/unifiedhrisemployeeoutputgender.md +++ b/docs/models/components/unifiedhrisemployeeoutputgender.md @@ -2,6 +2,13 @@ The gender of the employee +## Example Usage + +```typescript +import { UnifiedHrisEmployeeOutputGender } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeOutputGender = UnifiedHrisEmployeeOutputGender.Male; +``` ## Values diff --git a/docs/models/components/unifiedhrisemployeeoutputremotedata.md b/docs/models/components/unifiedhrisemployeeoutputremotedata.md index 54221223..eeab45dd 100644 --- a/docs/models/components/unifiedhrisemployeeoutputremotedata.md +++ b/docs/models/components/unifiedhrisemployeeoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the employee in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisEmployeeOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeeOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeepayrollrunoutput.md b/docs/models/components/unifiedhrisemployeepayrollrunoutput.md index 3e0efaaa..338d026f 100644 --- a/docs/models/components/unifiedhrisemployeepayrollrunoutput.md +++ b/docs/models/components/unifiedhrisemployeepayrollrunoutput.md @@ -1,5 +1,48 @@ # UnifiedHrisEmployeepayrollrunOutput +## Example Usage + +```typescript +import { UnifiedHrisEmployeepayrollrunOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeepayrollrunOutput = { + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + payrollRunId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + grossPay: 5000, + netPay: 4000, + startDate: new Date("2023-01-01T00:00:00Z"), + endDate: new Date("2023-01-15T23:59:59Z"), + checkDate: new Date("2023-01-20T00:00:00Z"), + deductions: [ + { + name: "Health Insurance", + employeeDeduction: 100, + companyDeduction: 200, + }, + ], + earnings: [ + { + amount: 1000, + type: "Salary", + }, + ], + taxes: [ + { + name: "Federal Income Tax", + amount: 250, + employerTax: true, + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeepayrollrunoutputfieldmappings.md b/docs/models/components/unifiedhrisemployeepayrollrunoutputfieldmappings.md index 526ad8bb..317dcefb 100644 --- a/docs/models/components/unifiedhrisemployeepayrollrunoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisemployeepayrollrunoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisEmployeepayrollrunOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeepayrollrunOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployeepayrollrunoutputremotedata.md b/docs/models/components/unifiedhrisemployeepayrollrunoutputremotedata.md index ff5782b4..ade2187b 100644 --- a/docs/models/components/unifiedhrisemployeepayrollrunoutputremotedata.md +++ b/docs/models/components/unifiedhrisemployeepayrollrunoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the employee payroll run in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisEmployeepayrollrunOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployeepayrollrunOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployerbenefitoutput.md b/docs/models/components/unifiedhrisemployerbenefitoutput.md index 48500248..32b2aa3c 100644 --- a/docs/models/components/unifiedhrisemployerbenefitoutput.md +++ b/docs/models/components/unifiedhrisemployerbenefitoutput.md @@ -1,5 +1,25 @@ # UnifiedHrisEmployerbenefitOutput +## Example Usage + +```typescript +import { BenefitPlanType, UnifiedHrisEmployerbenefitOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployerbenefitOutput = { + benefitPlanType: BenefitPlanType.Retirement, + name: "Company Health Plan", + description: "Comprehensive health insurance coverage for employees", + deductionCode: "HEALTH-001", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployerbenefitoutputfieldmappings.md b/docs/models/components/unifiedhrisemployerbenefitoutputfieldmappings.md index f6c59187..2384f968 100644 --- a/docs/models/components/unifiedhrisemployerbenefitoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisemployerbenefitoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisEmployerbenefitOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployerbenefitOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemployerbenefitoutputremotedata.md b/docs/models/components/unifiedhrisemployerbenefitoutputremotedata.md index 3f00e36b..3e2d73c7 100644 --- a/docs/models/components/unifiedhrisemployerbenefitoutputremotedata.md +++ b/docs/models/components/unifiedhrisemployerbenefitoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the employer benefit in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisEmployerbenefitOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmployerbenefitOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemploymentoutput.md b/docs/models/components/unifiedhrisemploymentoutput.md index c5b9ce76..3c9775d3 100644 --- a/docs/models/components/unifiedhrisemploymentoutput.md +++ b/docs/models/components/unifiedhrisemploymentoutput.md @@ -1,5 +1,38 @@ # UnifiedHrisEmploymentOutput +## Example Usage + +```typescript +import { + EmploymentType, + FlsaStatus, + PayCurrency, + PayFrequency, + PayPeriod, + UnifiedHrisEmploymentOutput, +} from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmploymentOutput = { + jobTitle: "Software Engineer", + payRate: 100000, + payPeriod: PayPeriod.Day, + payFrequency: PayFrequency.Weekly, + payCurrency: PayCurrency.Usd, + flsaStatus: FlsaStatus.Exempt, + effectiveDate: new Date("2023-01-01"), + employmentType: EmploymentType.FullTime, + payGroupId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employment_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemploymentoutputfieldmappings.md b/docs/models/components/unifiedhrisemploymentoutputfieldmappings.md index 603772ee..996e323e 100644 --- a/docs/models/components/unifiedhrisemploymentoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisemploymentoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisEmploymentOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmploymentOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisemploymentoutputremotedata.md b/docs/models/components/unifiedhrisemploymentoutputremotedata.md index 3e7ef1fe..144323b9 100644 --- a/docs/models/components/unifiedhrisemploymentoutputremotedata.md +++ b/docs/models/components/unifiedhrisemploymentoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the employment in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisEmploymentOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisEmploymentOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisgroupoutput.md b/docs/models/components/unifiedhrisgroupoutput.md index a0ce6f09..42c628e4 100644 --- a/docs/models/components/unifiedhrisgroupoutput.md +++ b/docs/models/components/unifiedhrisgroupoutput.md @@ -1,5 +1,24 @@ # UnifiedHrisGroupOutput +## Example Usage + +```typescript +import { UnifiedHrisGroupOutput, UnifiedHrisGroupOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedHrisGroupOutput = { + parentGroup: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + name: "Engineering Team", + type: UnifiedHrisGroupOutputType.Department, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "group_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisgroupoutputfieldmappings.md b/docs/models/components/unifiedhrisgroupoutputfieldmappings.md index 566f956f..88a9326f 100644 --- a/docs/models/components/unifiedhrisgroupoutputfieldmappings.md +++ b/docs/models/components/unifiedhrisgroupoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisGroupOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisGroupOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisgroupoutputremotedata.md b/docs/models/components/unifiedhrisgroupoutputremotedata.md index 50db238b..ae60dbc9 100644 --- a/docs/models/components/unifiedhrisgroupoutputremotedata.md +++ b/docs/models/components/unifiedhrisgroupoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the group in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisGroupOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisGroupOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrisgroupoutputtype.md b/docs/models/components/unifiedhrisgroupoutputtype.md index 8cfdd144..85b17cec 100644 --- a/docs/models/components/unifiedhrisgroupoutputtype.md +++ b/docs/models/components/unifiedhrisgroupoutputtype.md @@ -2,6 +2,13 @@ The type of the group +## Example Usage + +```typescript +import { UnifiedHrisGroupOutputType } from "@panora/sdk/models/components"; + +let value: UnifiedHrisGroupOutputType = UnifiedHrisGroupOutputType.Department; +``` ## Values diff --git a/docs/models/components/unifiedhrislocationoutput.md b/docs/models/components/unifiedhrislocationoutput.md index e3c291b4..7dbf080b 100644 --- a/docs/models/components/unifiedhrislocationoutput.md +++ b/docs/models/components/unifiedhrislocationoutput.md @@ -1,5 +1,32 @@ # UnifiedHrisLocationOutput +## Example Usage + +```typescript +import { LocationType, UnifiedHrisLocationOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisLocationOutput = { + name: "Headquarters", + phoneNumber: "+1234567890", + street1: "123 Main St", + street2: "Suite 456", + city: "San Francisco", + state: "CA", + zipCode: "94105", + country: "USA", + locationType: LocationType.Work, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "location_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrislocationoutputfieldmappings.md b/docs/models/components/unifiedhrislocationoutputfieldmappings.md index bb6939ff..3493c7fe 100644 --- a/docs/models/components/unifiedhrislocationoutputfieldmappings.md +++ b/docs/models/components/unifiedhrislocationoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisLocationOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisLocationOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrislocationoutputremotedata.md b/docs/models/components/unifiedhrislocationoutputremotedata.md index f3164dae..8eac5feb 100644 --- a/docs/models/components/unifiedhrislocationoutputremotedata.md +++ b/docs/models/components/unifiedhrislocationoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the location in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisLocationOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisLocationOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispaygroupoutput.md b/docs/models/components/unifiedhrispaygroupoutput.md index 9d9c7981..011c0392 100644 --- a/docs/models/components/unifiedhrispaygroupoutput.md +++ b/docs/models/components/unifiedhrispaygroupoutput.md @@ -1,5 +1,22 @@ # UnifiedHrisPaygroupOutput +## Example Usage + +```typescript +import { UnifiedHrisPaygroupOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPaygroupOutput = { + payGroupName: "Monthly Salaried", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "paygroup_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispaygroupoutputfieldmappings.md b/docs/models/components/unifiedhrispaygroupoutputfieldmappings.md index e4988d20..20736715 100644 --- a/docs/models/components/unifiedhrispaygroupoutputfieldmappings.md +++ b/docs/models/components/unifiedhrispaygroupoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisPaygroupOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPaygroupOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispaygroupoutputremotedata.md b/docs/models/components/unifiedhrispaygroupoutputremotedata.md index a1c4f5a9..f33c2186 100644 --- a/docs/models/components/unifiedhrispaygroupoutputremotedata.md +++ b/docs/models/components/unifiedhrispaygroupoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the pay group in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisPaygroupOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPaygroupOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispayrollrunoutput.md b/docs/models/components/unifiedhrispayrollrunoutput.md index 8d3bd546..d2ba364a 100644 --- a/docs/models/components/unifiedhrispayrollrunoutput.md +++ b/docs/models/components/unifiedhrispayrollrunoutput.md @@ -1,5 +1,27 @@ # UnifiedHrisPayrollrunOutput +## Example Usage + +```typescript +import { RunState, RunType, UnifiedHrisPayrollrunOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPayrollrunOutput = { + runState: RunState.Paid, + runType: RunType.Regular, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-01-15T23:59:59Z"), + checkDate: new Date("2024-01-20T00:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + employeePayrollRuns: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], +}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispayrollrunoutputfieldmappings.md b/docs/models/components/unifiedhrispayrollrunoutputfieldmappings.md index 49551f60..22f44465 100644 --- a/docs/models/components/unifiedhrispayrollrunoutputfieldmappings.md +++ b/docs/models/components/unifiedhrispayrollrunoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisPayrollrunOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPayrollrunOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhrispayrollrunoutputremotedata.md b/docs/models/components/unifiedhrispayrollrunoutputremotedata.md index 6879d893..babd97b8 100644 --- a/docs/models/components/unifiedhrispayrollrunoutputremotedata.md +++ b/docs/models/components/unifiedhrispayrollrunoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the payroll run in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisPayrollrunOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisPayrollrunOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffbalanceoutput.md b/docs/models/components/unifiedhristimeoffbalanceoutput.md index 50e796dd..a181c8ad 100644 --- a/docs/models/components/unifiedhristimeoffbalanceoutput.md +++ b/docs/models/components/unifiedhristimeoffbalanceoutput.md @@ -1,5 +1,25 @@ # UnifiedHrisTimeoffbalanceOutput +## Example Usage + +```typescript +import { PolicyType, UnifiedHrisTimeoffbalanceOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffbalanceOutput = { + balance: 80, + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + used: 40, + policyType: PolicyType.Vacation, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_balance_1234", + remoteData: {}, + remoteCreatedAt: "2024-06-15T12:00:00Z", + createdAt: "2024-06-15T12:00:00Z", + modifiedAt: "2024-06-15T12:00:00Z", + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffbalanceoutputfieldmappings.md b/docs/models/components/unifiedhristimeoffbalanceoutputfieldmappings.md index beb0dbd3..0f1e9612 100644 --- a/docs/models/components/unifiedhristimeoffbalanceoutputfieldmappings.md +++ b/docs/models/components/unifiedhristimeoffbalanceoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisTimeoffbalanceOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffbalanceOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffbalanceoutputremotedata.md b/docs/models/components/unifiedhristimeoffbalanceoutputremotedata.md index 19d3b146..1acba284 100644 --- a/docs/models/components/unifiedhristimeoffbalanceoutputremotedata.md +++ b/docs/models/components/unifiedhristimeoffbalanceoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the time off balance in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisTimeoffbalanceOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffbalanceOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffinput.md b/docs/models/components/unifiedhristimeoffinput.md index 2e7fdff4..637aa908 100644 --- a/docs/models/components/unifiedhristimeoffinput.md +++ b/docs/models/components/unifiedhristimeoffinput.md @@ -1,5 +1,28 @@ # UnifiedHrisTimeoffInput +## Example Usage + +```typescript +import { + UnifiedHrisTimeoffInput, + UnifiedHrisTimeoffInputRequestType, + UnifiedHrisTimeoffInputStatus, + UnifiedHrisTimeoffInputUnits, +} from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffInput = { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffInputStatus.Requested, + employeeNote: "Annual vacation", + units: UnifiedHrisTimeoffInputUnits.Days, + amount: 5, + requestType: UnifiedHrisTimeoffInputRequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffinputfieldmappings.md b/docs/models/components/unifiedhristimeoffinputfieldmappings.md index 05eb4979..d64e72cf 100644 --- a/docs/models/components/unifiedhristimeoffinputfieldmappings.md +++ b/docs/models/components/unifiedhristimeoffinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisTimeoffInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffinputrequesttype.md b/docs/models/components/unifiedhristimeoffinputrequesttype.md index d024fe2c..d73c1d5c 100644 --- a/docs/models/components/unifiedhristimeoffinputrequesttype.md +++ b/docs/models/components/unifiedhristimeoffinputrequesttype.md @@ -2,6 +2,13 @@ The type of time off request +## Example Usage + +```typescript +import { UnifiedHrisTimeoffInputRequestType } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffInputRequestType = UnifiedHrisTimeoffInputRequestType.Vacation; +``` ## Values diff --git a/docs/models/components/unifiedhristimeoffinputstatus.md b/docs/models/components/unifiedhristimeoffinputstatus.md index 92c6ddcf..8f737824 100644 --- a/docs/models/components/unifiedhristimeoffinputstatus.md +++ b/docs/models/components/unifiedhristimeoffinputstatus.md @@ -2,6 +2,13 @@ The status of the time off request +## Example Usage + +```typescript +import { UnifiedHrisTimeoffInputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffInputStatus = UnifiedHrisTimeoffInputStatus.Requested; +``` ## Values diff --git a/docs/models/components/unifiedhristimeoffinputunits.md b/docs/models/components/unifiedhristimeoffinputunits.md index f5ca3863..c3f7b295 100644 --- a/docs/models/components/unifiedhristimeoffinputunits.md +++ b/docs/models/components/unifiedhristimeoffinputunits.md @@ -2,6 +2,13 @@ The units used for the time off (e.g., Days, Hours) +## Example Usage + +```typescript +import { UnifiedHrisTimeoffInputUnits } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffInputUnits = UnifiedHrisTimeoffInputUnits.Days; +``` ## Values diff --git a/docs/models/components/unifiedhristimeoffoutput.md b/docs/models/components/unifiedhristimeoffoutput.md index 28b0a191..d57a21f0 100644 --- a/docs/models/components/unifiedhristimeoffoutput.md +++ b/docs/models/components/unifiedhristimeoffoutput.md @@ -1,5 +1,30 @@ # UnifiedHrisTimeoffOutput +## Example Usage + +```typescript +import { RequestType, UnifiedHrisTimeoffOutput, UnifiedHrisTimeoffOutputStatus, Units } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffOutput = { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffOutputStatus.Requested, + employeeNote: "Annual vacation", + units: Units.Days, + amount: 5, + requestType: RequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteWasDeleted: false, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffoutputfieldmappings.md b/docs/models/components/unifiedhristimeoffoutputfieldmappings.md index bfb804bc..7b0bef42 100644 --- a/docs/models/components/unifiedhristimeoffoutputfieldmappings.md +++ b/docs/models/components/unifiedhristimeoffoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisTimeoffOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffoutputremotedata.md b/docs/models/components/unifiedhristimeoffoutputremotedata.md index da0221e9..b5c2faf1 100644 --- a/docs/models/components/unifiedhristimeoffoutputremotedata.md +++ b/docs/models/components/unifiedhristimeoffoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the time off in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisTimeoffOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimeoffoutputstatus.md b/docs/models/components/unifiedhristimeoffoutputstatus.md index 8ef849ec..1dff07c2 100644 --- a/docs/models/components/unifiedhristimeoffoutputstatus.md +++ b/docs/models/components/unifiedhristimeoffoutputstatus.md @@ -2,6 +2,13 @@ The status of the time off request +## Example Usage + +```typescript +import { UnifiedHrisTimeoffOutputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimeoffOutputStatus = UnifiedHrisTimeoffOutputStatus.Requested; +``` ## Values diff --git a/docs/models/components/unifiedhristimesheetentryinput.md b/docs/models/components/unifiedhristimesheetentryinput.md index e7f96928..de7698f2 100644 --- a/docs/models/components/unifiedhristimesheetentryinput.md +++ b/docs/models/components/unifiedhristimesheetentryinput.md @@ -1,5 +1,19 @@ # UnifiedHrisTimesheetEntryInput +## Example Usage + +```typescript +import { UnifiedHrisTimesheetEntryInput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimesheetEntryInput = { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimesheetentryinputfieldmappings.md b/docs/models/components/unifiedhristimesheetentryinputfieldmappings.md index ed122ca4..40e98127 100644 --- a/docs/models/components/unifiedhristimesheetentryinputfieldmappings.md +++ b/docs/models/components/unifiedhristimesheetentryinputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisTimesheetEntryInputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimesheetEntryInputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimesheetentryoutput.md b/docs/models/components/unifiedhristimesheetentryoutput.md index 4015a63b..5fcbe449 100644 --- a/docs/models/components/unifiedhristimesheetentryoutput.md +++ b/docs/models/components/unifiedhristimesheetentryoutput.md @@ -1,5 +1,25 @@ # UnifiedHrisTimesheetEntryOutput +## Example Usage + +```typescript +import { UnifiedHrisTimesheetEntryOutput } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimesheetEntryOutput = { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteData: {}, +}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimesheetentryoutputfieldmappings.md b/docs/models/components/unifiedhristimesheetentryoutputfieldmappings.md index f7121781..2b695c95 100644 --- a/docs/models/components/unifiedhristimesheetentryoutputfieldmappings.md +++ b/docs/models/components/unifiedhristimesheetentryoutputfieldmappings.md @@ -2,6 +2,13 @@ The custom field mappings of the object between the remote 3rd party & Panora +## Example Usage + +```typescript +import { UnifiedHrisTimesheetEntryOutputFieldMappings } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimesheetEntryOutputFieldMappings = {}; +``` ## Fields diff --git a/docs/models/components/unifiedhristimesheetentryoutputremotedata.md b/docs/models/components/unifiedhristimesheetentryoutputremotedata.md index 99e84552..d4aecbeb 100644 --- a/docs/models/components/unifiedhristimesheetentryoutputremotedata.md +++ b/docs/models/components/unifiedhristimesheetentryoutputremotedata.md @@ -2,6 +2,13 @@ The remote data of the timesheet entry in the context of the 3rd Party +## Example Usage + +```typescript +import { UnifiedHrisTimesheetEntryOutputRemoteData } from "@panora/sdk/models/components"; + +let value: UnifiedHrisTimesheetEntryOutputRemoteData = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationactioninput.md b/docs/models/components/unifiedmarketingautomationactioninput.md index 23619943..86a3a14a 100644 --- a/docs/models/components/unifiedmarketingautomationactioninput.md +++ b/docs/models/components/unifiedmarketingautomationactioninput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationActionInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationActionInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationActionInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationactionoutput.md b/docs/models/components/unifiedmarketingautomationactionoutput.md index 5c0c190c..cc57c981 100644 --- a/docs/models/components/unifiedmarketingautomationactionoutput.md +++ b/docs/models/components/unifiedmarketingautomationactionoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationActionOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationActionOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationActionOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationautomationinput.md b/docs/models/components/unifiedmarketingautomationautomationinput.md index d3000e69..f3584966 100644 --- a/docs/models/components/unifiedmarketingautomationautomationinput.md +++ b/docs/models/components/unifiedmarketingautomationautomationinput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationAutomationInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationAutomationInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationAutomationInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationautomationoutput.md b/docs/models/components/unifiedmarketingautomationautomationoutput.md index 5bd93616..0a4ac0d3 100644 --- a/docs/models/components/unifiedmarketingautomationautomationoutput.md +++ b/docs/models/components/unifiedmarketingautomationautomationoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationAutomationOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationAutomationOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationAutomationOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationcampaigninput.md b/docs/models/components/unifiedmarketingautomationcampaigninput.md index e1572de4..900c9bbf 100644 --- a/docs/models/components/unifiedmarketingautomationcampaigninput.md +++ b/docs/models/components/unifiedmarketingautomationcampaigninput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationCampaignInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationCampaignInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationCampaignInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationcampaignoutput.md b/docs/models/components/unifiedmarketingautomationcampaignoutput.md index 52cbbc17..8f79e5bb 100644 --- a/docs/models/components/unifiedmarketingautomationcampaignoutput.md +++ b/docs/models/components/unifiedmarketingautomationcampaignoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationCampaignOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationCampaignOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationCampaignOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationcontactinput.md b/docs/models/components/unifiedmarketingautomationcontactinput.md index ef2aaeba..975c12e3 100644 --- a/docs/models/components/unifiedmarketingautomationcontactinput.md +++ b/docs/models/components/unifiedmarketingautomationcontactinput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationContactInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationContactInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationContactInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationcontactoutput.md b/docs/models/components/unifiedmarketingautomationcontactoutput.md index d25315d3..e4851b4d 100644 --- a/docs/models/components/unifiedmarketingautomationcontactoutput.md +++ b/docs/models/components/unifiedmarketingautomationcontactoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationContactOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationContactOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationContactOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationemailoutput.md b/docs/models/components/unifiedmarketingautomationemailoutput.md index 5af42875..0eb36b8b 100644 --- a/docs/models/components/unifiedmarketingautomationemailoutput.md +++ b/docs/models/components/unifiedmarketingautomationemailoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationEmailOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationEmailOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationEmailOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationeventoutput.md b/docs/models/components/unifiedmarketingautomationeventoutput.md index 952e6731..1650318b 100644 --- a/docs/models/components/unifiedmarketingautomationeventoutput.md +++ b/docs/models/components/unifiedmarketingautomationeventoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationEventOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationEventOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationEventOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationlistinput.md b/docs/models/components/unifiedmarketingautomationlistinput.md index 9856297c..68ef9a47 100644 --- a/docs/models/components/unifiedmarketingautomationlistinput.md +++ b/docs/models/components/unifiedmarketingautomationlistinput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationListInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationListInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationListInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationlistoutput.md b/docs/models/components/unifiedmarketingautomationlistoutput.md index 56ba8502..896610c3 100644 --- a/docs/models/components/unifiedmarketingautomationlistoutput.md +++ b/docs/models/components/unifiedmarketingautomationlistoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationListOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationListOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationListOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationmessageoutput.md b/docs/models/components/unifiedmarketingautomationmessageoutput.md index 31222a55..f555fada 100644 --- a/docs/models/components/unifiedmarketingautomationmessageoutput.md +++ b/docs/models/components/unifiedmarketingautomationmessageoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationMessageOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationMessageOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationMessageOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationtemplateinput.md b/docs/models/components/unifiedmarketingautomationtemplateinput.md index 91d16fc8..2b674b88 100644 --- a/docs/models/components/unifiedmarketingautomationtemplateinput.md +++ b/docs/models/components/unifiedmarketingautomationtemplateinput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationTemplateInput +## Example Usage + +```typescript +import { UnifiedMarketingautomationTemplateInput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationTemplateInput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationtemplateoutput.md b/docs/models/components/unifiedmarketingautomationtemplateoutput.md index fad2df5c..3cdc7d1b 100644 --- a/docs/models/components/unifiedmarketingautomationtemplateoutput.md +++ b/docs/models/components/unifiedmarketingautomationtemplateoutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationTemplateOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationTemplateOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationTemplateOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedmarketingautomationuseroutput.md b/docs/models/components/unifiedmarketingautomationuseroutput.md index 0d754b14..5d9ae36f 100644 --- a/docs/models/components/unifiedmarketingautomationuseroutput.md +++ b/docs/models/components/unifiedmarketingautomationuseroutput.md @@ -1,5 +1,12 @@ # UnifiedMarketingautomationUserOutput +## Example Usage + +```typescript +import { UnifiedMarketingautomationUserOutput } from "@panora/sdk/models/components"; + +let value: UnifiedMarketingautomationUserOutput = {}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingaccountoutput.md b/docs/models/components/unifiedticketingaccountoutput.md index 4f8f6d06..6f982add 100644 --- a/docs/models/components/unifiedticketingaccountoutput.md +++ b/docs/models/components/unifiedticketingaccountoutput.md @@ -1,5 +1,27 @@ # UnifiedTicketingAccountOutput +## Example Usage + +```typescript +import { UnifiedTicketingAccountOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingAccountOutput = { + name: "My Personal Account", + domains: ["acme.com", "acme-test.com"], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingattachmentinput.md b/docs/models/components/unifiedticketingattachmentinput.md index 24dc4756..65e843b3 100644 --- a/docs/models/components/unifiedticketingattachmentinput.md +++ b/docs/models/components/unifiedticketingattachmentinput.md @@ -1,5 +1,22 @@ # UnifiedTicketingAttachmentInput +## Example Usage + +```typescript +import { UnifiedTicketingAttachmentInput } from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingattachmentoutput.md b/docs/models/components/unifiedticketingattachmentoutput.md index abe03b41..52f17b31 100644 --- a/docs/models/components/unifiedticketingattachmentoutput.md +++ b/docs/models/components/unifiedticketingattachmentoutput.md @@ -1,5 +1,30 @@ # UnifiedTicketingAttachmentOutput +## Example Usage + +```typescript +import { UnifiedTicketingAttachmentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingAttachmentOutput = { + 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: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingcollectionoutput.md b/docs/models/components/unifiedticketingcollectionoutput.md index 9ccb4886..94f2da8f 100644 --- a/docs/models/components/unifiedticketingcollectionoutput.md +++ b/docs/models/components/unifiedticketingcollectionoutput.md @@ -1,5 +1,24 @@ # UnifiedTicketingCollectionOutput +## Example Usage + +```typescript +import { CollectionType, UnifiedTicketingCollectionOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingCollectionOutput = { + name: "My Personal Collection", + description: "Collect issues", + collectionType: CollectionType.Project, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingcommentinput.md b/docs/models/components/unifiedticketingcommentinput.md index 1d7f99fa..a95e88fc 100644 --- a/docs/models/components/unifiedticketingcommentinput.md +++ b/docs/models/components/unifiedticketingcommentinput.md @@ -1,5 +1,21 @@ # UnifiedTicketingCommentInput +## Example Usage + +```typescript +import { UnifiedTicketingCommentInput, UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; + +let value: 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"], +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingcommentinputattachments.md b/docs/models/components/unifiedticketingcommentinputattachments.md index ce451896..7f1ef8ee 100644 --- a/docs/models/components/unifiedticketingcommentinputattachments.md +++ b/docs/models/components/unifiedticketingcommentinputattachments.md @@ -1,5 +1,12 @@ # UnifiedTicketingCommentInputAttachments +## Example Usage + +```typescript +import { UnifiedTicketingCommentInputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingCommentInputAttachments = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingcommentinputcreatortype.md b/docs/models/components/unifiedticketingcommentinputcreatortype.md index 96a5498b..f55dcbde 100644 --- a/docs/models/components/unifiedticketingcommentinputcreatortype.md +++ b/docs/models/components/unifiedticketingcommentinputcreatortype.md @@ -2,6 +2,13 @@ The creator type of the comment. Authorized values are either USER or CONTACT +## Example Usage + +```typescript +import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingCommentInputCreatorType = UnifiedTicketingCommentInputCreatorType.User; +``` ## Values diff --git a/docs/models/components/unifiedticketingcommentoutput.md b/docs/models/components/unifiedticketingcommentoutput.md index 92921194..43f04fcb 100644 --- a/docs/models/components/unifiedticketingcommentoutput.md +++ b/docs/models/components/unifiedticketingcommentoutput.md @@ -1,5 +1,29 @@ # UnifiedTicketingCommentOutput +## Example Usage + +```typescript +import { CreatorType, UnifiedTicketingCommentOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingCommentOutput = { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: CreatorType.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"], + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingcommentoutputattachments.md b/docs/models/components/unifiedticketingcommentoutputattachments.md index 122e0289..851d87a0 100644 --- a/docs/models/components/unifiedticketingcommentoutputattachments.md +++ b/docs/models/components/unifiedticketingcommentoutputattachments.md @@ -1,5 +1,30 @@ # UnifiedTicketingCommentOutputAttachments +## Example Usage + +```typescript +import { UnifiedTicketingCommentOutputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingCommentOutputAttachments = { + 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: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingcontactoutput.md b/docs/models/components/unifiedticketingcontactoutput.md index 1405df29..f8fbcabe 100644 --- a/docs/models/components/unifiedticketingcontactoutput.md +++ b/docs/models/components/unifiedticketingcontactoutput.md @@ -1,5 +1,29 @@ # UnifiedTicketingContactOutput +## Example Usage + +```typescript +import { UnifiedTicketingContactOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingContactOutput = { + name: "Joe", + emailAddress: "joedoe@acme.org", + phoneNumber: "+33 6 50 11 11 10", + details: "Contact Details", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingtagoutput.md b/docs/models/components/unifiedticketingtagoutput.md index f57b280c..bef6743a 100644 --- a/docs/models/components/unifiedticketingtagoutput.md +++ b/docs/models/components/unifiedticketingtagoutput.md @@ -1,5 +1,26 @@ # UnifiedTicketingTagOutput +## Example Usage + +```typescript +import { UnifiedTicketingTagOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTagOutput = { + name: "urgent_tag", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingteamoutput.md b/docs/models/components/unifiedticketingteamoutput.md index 6f4a473e..164a3de8 100644 --- a/docs/models/components/unifiedticketingteamoutput.md +++ b/docs/models/components/unifiedticketingteamoutput.md @@ -1,5 +1,27 @@ # UnifiedTicketingTeamOutput +## Example Usage + +```typescript +import { UnifiedTicketingTeamOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTeamOutput = { + name: "My team", + description: "Internal members", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingticketinput.md b/docs/models/components/unifiedticketingticketinput.md index c3de31c8..d00e5530 100644 --- a/docs/models/components/unifiedticketingticketinput.md +++ b/docs/models/components/unifiedticketingticketinput.md @@ -1,5 +1,47 @@ # UnifiedTicketingTicketInput +## Example Usage + +```typescript +import { + UnifiedTicketingTicketInput, + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, +} from "@panora/sdk/models/components"; + +let value: 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", + }, +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingticketinputattachments.md b/docs/models/components/unifiedticketingticketinputattachments.md index cceb343a..bbdf7677 100644 --- a/docs/models/components/unifiedticketingticketinputattachments.md +++ b/docs/models/components/unifiedticketingticketinputattachments.md @@ -1,5 +1,12 @@ # UnifiedTicketingTicketInputAttachments +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputAttachments = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingticketinputcollections.md b/docs/models/components/unifiedticketingticketinputcollections.md index 6ca3ab56..8404344c 100644 --- a/docs/models/components/unifiedticketingticketinputcollections.md +++ b/docs/models/components/unifiedticketingticketinputcollections.md @@ -1,5 +1,24 @@ # UnifiedTicketingTicketInputCollections +## Example Usage + +```typescript +import { CollectionType, UnifiedTicketingTicketInputCollections } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputCollections = { + name: "My Personal Collection", + description: "Collect issues", + collectionType: CollectionType.Project, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingticketinputcomment.md b/docs/models/components/unifiedticketingticketinputcomment.md index 5de397b6..9ba960b9 100644 --- a/docs/models/components/unifiedticketingticketinputcomment.md +++ b/docs/models/components/unifiedticketingticketinputcomment.md @@ -2,6 +2,22 @@ The comment of the ticket +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputComment, UnifiedTicketingTicketInputCreatorType } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputComment = { + 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"], +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingticketinputcommentattachments.md b/docs/models/components/unifiedticketingticketinputcommentattachments.md index 24626047..03203312 100644 --- a/docs/models/components/unifiedticketingticketinputcommentattachments.md +++ b/docs/models/components/unifiedticketingticketinputcommentattachments.md @@ -1,5 +1,12 @@ # UnifiedTicketingTicketInputCommentAttachments +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputCommentAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputCommentAttachments = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingticketinputcreatortype.md b/docs/models/components/unifiedticketingticketinputcreatortype.md index 75f1e221..cee00b12 100644 --- a/docs/models/components/unifiedticketingticketinputcreatortype.md +++ b/docs/models/components/unifiedticketingticketinputcreatortype.md @@ -2,6 +2,13 @@ The creator type of the comment. Authorized values are either USER or CONTACT +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputCreatorType } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputCreatorType = UnifiedTicketingTicketInputCreatorType.User; +``` ## Values diff --git a/docs/models/components/unifiedticketingticketinputpriority.md b/docs/models/components/unifiedticketingticketinputpriority.md index 54608ce4..5bb39c55 100644 --- a/docs/models/components/unifiedticketingticketinputpriority.md +++ b/docs/models/components/unifiedticketingticketinputpriority.md @@ -2,6 +2,13 @@ The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputPriority } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputPriority = UnifiedTicketingTicketInputPriority.High; +``` ## Values diff --git a/docs/models/components/unifiedticketingticketinputstatus.md b/docs/models/components/unifiedticketingticketinputstatus.md index 32dbbd34..d75b95b1 100644 --- a/docs/models/components/unifiedticketingticketinputstatus.md +++ b/docs/models/components/unifiedticketingticketinputstatus.md @@ -2,6 +2,13 @@ The status of the ticket. Authorized values are OPEN or CLOSED. +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputStatus } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputStatus = UnifiedTicketingTicketInputStatus.Open; +``` ## Values diff --git a/docs/models/components/unifiedticketingticketinputtags.md b/docs/models/components/unifiedticketingticketinputtags.md index 19a77c93..4dd76186 100644 --- a/docs/models/components/unifiedticketingticketinputtags.md +++ b/docs/models/components/unifiedticketingticketinputtags.md @@ -1,5 +1,12 @@ # UnifiedTicketingTicketInputTags +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputTags } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputTags = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingticketinputtype.md b/docs/models/components/unifiedticketingticketinputtype.md index a522a7f4..52069751 100644 --- a/docs/models/components/unifiedticketingticketinputtype.md +++ b/docs/models/components/unifiedticketingticketinputtype.md @@ -2,6 +2,13 @@ The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK +## Example Usage + +```typescript +import { UnifiedTicketingTicketInputType } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketInputType = UnifiedTicketingTicketInputType.Bug; +``` ## Values diff --git a/docs/models/components/unifiedticketingticketoutput.md b/docs/models/components/unifiedticketingticketoutput.md index febea2a4..b286b632 100644 --- a/docs/models/components/unifiedticketingticketoutput.md +++ b/docs/models/components/unifiedticketingticketoutput.md @@ -1,5 +1,56 @@ # UnifiedTicketingTicketOutput +## Example Usage + +```typescript +import { + Priority, + Status, + Type, + UnifiedTicketingTicketOutput, + UnifiedTicketingTicketOutputCreatorType, +} from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketOutput = { + name: "Customer Service Inquiry", + status: Status.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: Type.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: Priority.High, + assignedTo: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketOutputCreatorType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/unifiedticketingticketoutputattachments.md b/docs/models/components/unifiedticketingticketoutputattachments.md index 10c68979..8f9b0ba8 100644 --- a/docs/models/components/unifiedticketingticketoutputattachments.md +++ b/docs/models/components/unifiedticketingticketoutputattachments.md @@ -1,5 +1,12 @@ # UnifiedTicketingTicketOutputAttachments +## Example Usage + +```typescript +import { UnifiedTicketingTicketOutputAttachments } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketOutputAttachments = ""; +``` ## Supported Types diff --git a/docs/models/components/unifiedticketingticketoutputcreatortype.md b/docs/models/components/unifiedticketingticketoutputcreatortype.md index ff74d8f1..4bb1f935 100644 --- a/docs/models/components/unifiedticketingticketoutputcreatortype.md +++ b/docs/models/components/unifiedticketingticketoutputcreatortype.md @@ -2,6 +2,13 @@ The creator type of the comment. Authorized values are either USER or CONTACT +## Example Usage + +```typescript +import { UnifiedTicketingTicketOutputCreatorType } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingTicketOutputCreatorType = UnifiedTicketingTicketOutputCreatorType.User; +``` ## Values diff --git a/docs/models/components/unifiedticketinguseroutput.md b/docs/models/components/unifiedticketinguseroutput.md index 881c295a..ce0fd3db 100644 --- a/docs/models/components/unifiedticketinguseroutput.md +++ b/docs/models/components/unifiedticketinguseroutput.md @@ -1,5 +1,30 @@ # UnifiedTicketingUserOutput +## Example Usage + +```typescript +import { UnifiedTicketingUserOutput } from "@panora/sdk/models/components"; + +let value: UnifiedTicketingUserOutput = { + name: "John Doe", + emailAddress: "john.doe@example.com", + teams: ["team1", "team2"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/components/units.md b/docs/models/components/units.md index 74f2f2c4..f06e19f7 100644 --- a/docs/models/components/units.md +++ b/docs/models/components/units.md @@ -2,6 +2,13 @@ The units used for the time off (e.g., Days, Hours) +## Example Usage + +```typescript +import { Units } from "@panora/sdk/models/components"; + +let value: Units = Units.Days; +``` ## Values diff --git a/docs/models/components/url.md b/docs/models/components/url.md index 438816b8..e34d8af7 100644 --- a/docs/models/components/url.md +++ b/docs/models/components/url.md @@ -1,5 +1,15 @@ # Url +## Example Usage + +```typescript +import { Url } from "@panora/sdk/models/components"; + +let value: Url = { + url: "https://canine-harmonise.info", + urlType: "", +}; +``` ## Fields diff --git a/docs/models/components/users.md b/docs/models/components/users.md index 61e566b9..36cc6d5c 100644 --- a/docs/models/components/users.md +++ b/docs/models/components/users.md @@ -1,5 +1,28 @@ # Users +## Example Usage + +```typescript +import { Users } from "@panora/sdk/models/components"; + +let value: Users = { + name: "Joe Doe", + email: "joe.doe@gmail.com", + isMe: true, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Supported Types diff --git a/docs/models/components/variant.md b/docs/models/components/variant.md index 80a7e867..e41f9292 100644 --- a/docs/models/components/variant.md +++ b/docs/models/components/variant.md @@ -1,5 +1,12 @@ # Variant +## Example Usage + +```typescript +import { Variant } from "@panora/sdk/models/components"; + +let value: Variant = {}; +``` ## Fields diff --git a/docs/models/components/vertical.md b/docs/models/components/vertical.md index 760dab3d..8223b640 100644 --- a/docs/models/components/vertical.md +++ b/docs/models/components/vertical.md @@ -1,5 +1,12 @@ # Vertical +## Example Usage + +```typescript +import { Vertical } from "@panora/sdk/models/components"; + +let value: Vertical = Vertical.Ticketing; +``` ## Values diff --git a/docs/models/components/veteranstatus.md b/docs/models/components/veteranstatus.md index ab4af2b6..331a0294 100644 --- a/docs/models/components/veteranstatus.md +++ b/docs/models/components/veteranstatus.md @@ -2,6 +2,13 @@ The veteran status of the candidate +## Example Usage + +```typescript +import { VeteranStatus } from "@panora/sdk/models/components"; + +let value: VeteranStatus = VeteranStatus.IAmNotAProtectedVeteran; +``` ## Values diff --git a/docs/models/components/visibility.md b/docs/models/components/visibility.md index b7255d1a..af83b324 100644 --- a/docs/models/components/visibility.md +++ b/docs/models/components/visibility.md @@ -2,6 +2,13 @@ The visibility of the activity +## Example Usage + +```typescript +import { Visibility } from "@panora/sdk/models/components"; + +let value: Visibility = Visibility.Public; +``` ## Values diff --git a/docs/models/components/webhookdto.md b/docs/models/components/webhookdto.md index 3f6fe9bb..d67e986c 100644 --- a/docs/models/components/webhookdto.md +++ b/docs/models/components/webhookdto.md @@ -1,5 +1,16 @@ # WebhookDto +## Example Usage + +```typescript +import { WebhookDto } from "@panora/sdk/models/components"; + +let value: WebhookDto = { + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", + scope: ["connection.created"], +}; +``` ## Fields diff --git a/docs/models/components/webhookresponse.md b/docs/models/components/webhookresponse.md index 4f2f0460..576af512 100644 --- a/docs/models/components/webhookresponse.md +++ b/docs/models/components/webhookresponse.md @@ -1,5 +1,22 @@ # WebhookResponse +## Example Usage + +```typescript +import { WebhookResponse } from "@panora/sdk/models/components"; + +let value: WebhookResponse = { + idWebhookEndpoint: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + endpointDescription: "Webhook to receive connection events", + url: "https://acme.com/webhook_receiver", + secret: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + active: true, + createdAt: new Date("2024-10-01T12:00:00Z"), + scope: ["connection.created"], + idProject: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lastUpdate: new Date("2024-10-01T12:00:00Z"), +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingaccountrequest.md b/docs/models/operations/createaccountingaccountrequest.md index 564c544d..f40fb216 100644 --- a/docs/models/operations/createaccountingaccountrequest.md +++ b/docs/models/operations/createaccountingaccountrequest.md @@ -1,5 +1,29 @@ # CreateAccountingAccountRequest +## Example Usage + +```typescript +import { UnifiedAccountingAccountInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingAccountRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingAccountRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingAccountInput: { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: UnifiedAccountingAccountInputCurrency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingattachmentrequest.md b/docs/models/operations/createaccountingattachmentrequest.md index 80e7e40a..fbc48ea5 100644 --- a/docs/models/operations/createaccountingattachmentrequest.md +++ b/docs/models/operations/createaccountingattachmentrequest.md @@ -1,5 +1,21 @@ # CreateAccountingAttachmentRequest +## Example Usage + +```typescript +import { CreateAccountingAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingAttachmentRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingAttachmentInput: { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingcontactrequest.md b/docs/models/operations/createaccountingcontactrequest.md index 91d2c899..1129ae07 100644 --- a/docs/models/operations/createaccountingcontactrequest.md +++ b/docs/models/operations/createaccountingcontactrequest.md @@ -1,5 +1,28 @@ # CreateAccountingContactRequest +## Example Usage + +```typescript +import { UnifiedAccountingContactInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingContactRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingContactRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingContactInput: { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactInputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingexpenserequest.md b/docs/models/operations/createaccountingexpenserequest.md index 78d484c4..ea130f0f 100644 --- a/docs/models/operations/createaccountingexpenserequest.md +++ b/docs/models/operations/createaccountingexpenserequest.md @@ -1,5 +1,43 @@ # CreateAccountingExpenseRequest +## Example Usage + +```typescript +import { UnifiedAccountingExpenseInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingExpenseRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingExpenseRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingExpenseInput: { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseInputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountinginvoicerequest.md b/docs/models/operations/createaccountinginvoicerequest.md index bf0c0a2a..be01bf79 100644 --- a/docs/models/operations/createaccountinginvoicerequest.md +++ b/docs/models/operations/createaccountinginvoicerequest.md @@ -1,5 +1,52 @@ # CreateAccountingInvoiceRequest +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingInvoiceRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingInvoiceRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingInvoiceInput: { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceInputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingjournalentryrequest.md b/docs/models/operations/createaccountingjournalentryrequest.md index ff7a25b0..7b0859e7 100644 --- a/docs/models/operations/createaccountingjournalentryrequest.md +++ b/docs/models/operations/createaccountingjournalentryrequest.md @@ -1,5 +1,43 @@ # CreateAccountingJournalEntryRequest +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingJournalEntryRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingJournalEntryRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingJournalentryInput: { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: ["payment1", "payment2"], + appliedPayments: ["appliedPayment1", "appliedPayment2"], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryInputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingpaymentrequest.md b/docs/models/operations/createaccountingpaymentrequest.md index 2b7faa03..11466012 100644 --- a/docs/models/operations/createaccountingpaymentrequest.md +++ b/docs/models/operations/createaccountingpaymentrequest.md @@ -1,5 +1,43 @@ # CreateAccountingPaymentRequest +## Example Usage + +```typescript +import { UnifiedAccountingPaymentInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingPaymentRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingPaymentRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingPaymentInput: { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentInputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createaccountingpurchaseorderrequest.md b/docs/models/operations/createaccountingpurchaseorderrequest.md index 5fcf82d3..4ccdd6c8 100644 --- a/docs/models/operations/createaccountingpurchaseorderrequest.md +++ b/docs/models/operations/createaccountingpurchaseorderrequest.md @@ -1,5 +1,46 @@ # CreateAccountingPurchaseOrderRequest +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderInputCurrency } from "@panora/sdk/models/components"; +import { CreateAccountingPurchaseOrderRequest } from "@panora/sdk/models/operations"; + +let value: CreateAccountingPurchaseOrderRequest = { + xConnectionToken: "", + remoteData: false, + unifiedAccountingPurchaseorderInput: { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderInputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createatsactivityrequest.md b/docs/models/operations/createatsactivityrequest.md index 9a012af7..95edc913 100644 --- a/docs/models/operations/createatsactivityrequest.md +++ b/docs/models/operations/createatsactivityrequest.md @@ -1,5 +1,28 @@ # CreateAtsActivityRequest +## Example Usage + +```typescript +import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; +import { CreateAtsActivityRequest } from "@panora/sdk/models/operations"; + +let value: CreateAtsActivityRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createatsapplicationrequest.md b/docs/models/operations/createatsapplicationrequest.md index bffa02a1..82974326 100644 --- a/docs/models/operations/createatsapplicationrequest.md +++ b/docs/models/operations/createatsapplicationrequest.md @@ -1,5 +1,30 @@ # CreateAtsApplicationRequest +## Example Usage + +```typescript +import { CreateAtsApplicationRequest } from "@panora/sdk/models/operations"; + +let value: CreateAtsApplicationRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createatsattachmentrequest.md b/docs/models/operations/createatsattachmentrequest.md index 3ecd54b9..f6fa8568 100644 --- a/docs/models/operations/createatsattachmentrequest.md +++ b/docs/models/operations/createatsattachmentrequest.md @@ -1,5 +1,28 @@ # CreateAtsAttachmentRequest +## Example Usage + +```typescript +import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; +import { CreateAtsAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: CreateAtsAttachmentRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createatscandidaterequest.md b/docs/models/operations/createatscandidaterequest.md index d4837446..a13691d5 100644 --- a/docs/models/operations/createatscandidaterequest.md +++ b/docs/models/operations/createatscandidaterequest.md @@ -1,5 +1,53 @@ # CreateAtsCandidateRequest +## Example Usage + +```typescript +import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { CreateAtsCandidateRequest } from "@panora/sdk/models/operations"; + +let value: CreateAtsCandidateRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createatsinterviewrequest.md b/docs/models/operations/createatsinterviewrequest.md index 8b8b421d..79f667c4 100644 --- a/docs/models/operations/createatsinterviewrequest.md +++ b/docs/models/operations/createatsinterviewrequest.md @@ -1,5 +1,32 @@ # CreateAtsInterviewRequest +## Example Usage + +```typescript +import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; +import { CreateAtsInterviewRequest } from "@panora/sdk/models/operations"; + +let value: CreateAtsInterviewRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmcompanyrequest.md b/docs/models/operations/createcrmcompanyrequest.md index 2bef8407..40add019 100644 --- a/docs/models/operations/createcrmcompanyrequest.md +++ b/docs/models/operations/createcrmcompanyrequest.md @@ -1,5 +1,50 @@ # CreateCrmCompanyRequest +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; +import { CreateCrmCompanyRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmCompanyRequest = { + 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: "Street 2", + city: "New York", + state: "NY", + postalCode: "10001", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmcontactrequest.md b/docs/models/operations/createcrmcontactrequest.md index b5e450c3..e9b0b8e2 100644 --- a/docs/models/operations/createcrmcontactrequest.md +++ b/docs/models/operations/createcrmcontactrequest.md @@ -1,5 +1,49 @@ # CreateCrmContactRequest +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { CreateCrmContactRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmContactRequest = { + xConnectionToken: "", + remoteData: false, + unifiedCrmContactInput: { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Issac.Hessel@hotmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmdealrequest.md b/docs/models/operations/createcrmdealrequest.md index 799034fc..de33a22e 100644 --- a/docs/models/operations/createcrmdealrequest.md +++ b/docs/models/operations/createcrmdealrequest.md @@ -1,5 +1,26 @@ # CreateCrmDealRequest +## Example Usage + +```typescript +import { CreateCrmDealRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmDealRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmengagementrequest.md b/docs/models/operations/createcrmengagementrequest.md index bf887802..147a93e5 100644 --- a/docs/models/operations/createcrmengagementrequest.md +++ b/docs/models/operations/createcrmengagementrequest.md @@ -1,5 +1,31 @@ # CreateCrmEngagementRequest +## Example Usage + +```typescript +import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; +import { CreateCrmEngagementRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmEngagementRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmnoterequest.md b/docs/models/operations/createcrmnoterequest.md index 0f0d83d3..d085e888 100644 --- a/docs/models/operations/createcrmnoterequest.md +++ b/docs/models/operations/createcrmnoterequest.md @@ -1,5 +1,26 @@ # CreateCrmNoteRequest +## Example Usage + +```typescript +import { CreateCrmNoteRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmNoteRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createcrmtaskrequest.md b/docs/models/operations/createcrmtaskrequest.md index 4a122a2d..7535ad0e 100644 --- a/docs/models/operations/createcrmtaskrequest.md +++ b/docs/models/operations/createcrmtaskrequest.md @@ -1,5 +1,29 @@ # CreateCrmTaskRequest +## Example Usage + +```typescript +import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; +import { CreateCrmTaskRequest } from "@panora/sdk/models/operations"; + +let value: CreateCrmTaskRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createecommerceorderrequest.md b/docs/models/operations/createecommerceorderrequest.md index 4d626cf7..65349a43 100644 --- a/docs/models/operations/createecommerceorderrequest.md +++ b/docs/models/operations/createecommerceorderrequest.md @@ -1,5 +1,47 @@ # CreateEcommerceOrderRequest +## Example Usage + +```typescript +import { + UnifiedEcommerceOrderInputCurrency, + UnifiedEcommerceOrderInputFulfillmentStatus, + UnifiedEcommerceOrderInputOrderStatus, + UnifiedEcommerceOrderInputPaymentStatus, +} from "@panora/sdk/models/components"; +import { CreateEcommerceOrderRequest } from "@panora/sdk/models/operations"; + +let value: CreateEcommerceOrderRequest = { + xConnectionToken: "", + remoteData: false, + unifiedEcommerceOrderInput: { + orderStatus: UnifiedEcommerceOrderInputOrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: UnifiedEcommerceOrderInputPaymentStatus.Success, + currency: UnifiedEcommerceOrderInputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: UnifiedEcommerceOrderInputFulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createecommerceproductrequest.md b/docs/models/operations/createecommerceproductrequest.md index afeec8a8..c66286e2 100644 --- a/docs/models/operations/createecommerceproductrequest.md +++ b/docs/models/operations/createecommerceproductrequest.md @@ -1,5 +1,27 @@ # CreateEcommerceProductRequest +## Example Usage + +```typescript +import { UnifiedEcommerceProductInputProductStatus } from "@panora/sdk/models/components"; +import { CreateEcommerceProductRequest } from "@panora/sdk/models/operations"; + +let value: CreateEcommerceProductRequest = { + xConnectionToken: "", + remoteData: false, + unifiedEcommerceProductInput: { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: UnifiedEcommerceProductInputProductStatus.Active, + imagesUrls: ["https://myproduct/image"], + description: "best tee ever", + vendor: "vendor_extern", + variants: [{}], + tags: ["tag_1"], + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createfilestoragefilerequest.md b/docs/models/operations/createfilestoragefilerequest.md index 017e231a..962ee706 100644 --- a/docs/models/operations/createfilestoragefilerequest.md +++ b/docs/models/operations/createfilestoragefilerequest.md @@ -1,5 +1,28 @@ # CreateFilestorageFileRequest +## Example Usage + +```typescript +import { CreateFilestorageFileRequest } from "@panora/sdk/models/operations"; + +let value: CreateFilestorageFileRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createfilestoragefolderrequest.md b/docs/models/operations/createfilestoragefolderrequest.md index 9686a99b..3cac56f2 100644 --- a/docs/models/operations/createfilestoragefolderrequest.md +++ b/docs/models/operations/createfilestoragefolderrequest.md @@ -1,5 +1,29 @@ # CreateFilestorageFolderRequest +## Example Usage + +```typescript +import { CreateFilestorageFolderRequest } from "@panora/sdk/models/operations"; + +let value: CreateFilestorageFolderRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createhrisemployeerequest.md b/docs/models/operations/createhrisemployeerequest.md index 33de6477..83ead700 100644 --- a/docs/models/operations/createhrisemployeerequest.md +++ b/docs/models/operations/createhrisemployeerequest.md @@ -1,5 +1,49 @@ # CreateHrisEmployeeRequest +## Example Usage + +```typescript +import { + UnifiedHrisEmployeeInputEmploymentStatus, + UnifiedHrisEmployeeInputEthnicity, + UnifiedHrisEmployeeInputGender, + UnifiedHrisEmployeeInputMaritalStatus, +} from "@panora/sdk/models/components"; +import { CreateHrisEmployeeRequest } from "@panora/sdk/models/operations"; + +let value: CreateHrisEmployeeRequest = { + xConnectionToken: "", + unifiedHrisEmployeeInput: { + groups: ["Group1", "Group2"], + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + employeeNumber: "EMP001", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeInputGender.Male, + ethnicity: UnifiedHrisEmployeeInputEthnicity.AmericanIndianOrAlaskaNative, + maritalStatus: UnifiedHrisEmployeeInputMaritalStatus.HeadOfHousehold, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: UnifiedHrisEmployeeInputEmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createhristimeoffrequest.md b/docs/models/operations/createhristimeoffrequest.md index cf13812a..d77e866a 100644 --- a/docs/models/operations/createhristimeoffrequest.md +++ b/docs/models/operations/createhristimeoffrequest.md @@ -1,5 +1,31 @@ # CreateHrisTimeoffRequest +## Example Usage + +```typescript +import { + UnifiedHrisTimeoffInputRequestType, + UnifiedHrisTimeoffInputStatus, + UnifiedHrisTimeoffInputUnits, +} from "@panora/sdk/models/components"; +import { CreateHrisTimeoffRequest } from "@panora/sdk/models/operations"; + +let value: CreateHrisTimeoffRequest = { + xConnectionToken: "", + unifiedHrisTimeoffInput: { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffInputStatus.Requested, + employeeNote: "Annual vacation", + units: UnifiedHrisTimeoffInputUnits.Days, + amount: 5, + requestType: UnifiedHrisTimeoffInputRequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createhristimesheetentryrequest.md b/docs/models/operations/createhristimesheetentryrequest.md index 3278b7f5..5f348227 100644 --- a/docs/models/operations/createhristimesheetentryrequest.md +++ b/docs/models/operations/createhristimesheetentryrequest.md @@ -1,5 +1,22 @@ # CreateHrisTimesheetentryRequest +## Example Usage + +```typescript +import { CreateHrisTimesheetentryRequest } from "@panora/sdk/models/operations"; + +let value: CreateHrisTimesheetentryRequest = { + xConnectionToken: "", + unifiedHrisTimesheetEntryInput: { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationactionrequest.md b/docs/models/operations/createmarketingautomationactionrequest.md index 32b34c36..10a70799 100644 --- a/docs/models/operations/createmarketingautomationactionrequest.md +++ b/docs/models/operations/createmarketingautomationactionrequest.md @@ -1,5 +1,16 @@ # CreateMarketingautomationActionRequest +## Example Usage + +```typescript +import { CreateMarketingautomationActionRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingautomationActionRequest = { + xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationActionInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationautomationrequest.md b/docs/models/operations/createmarketingautomationautomationrequest.md index 29884b12..dd166258 100644 --- a/docs/models/operations/createmarketingautomationautomationrequest.md +++ b/docs/models/operations/createmarketingautomationautomationrequest.md @@ -1,5 +1,16 @@ # CreateMarketingautomationAutomationRequest +## Example Usage + +```typescript +import { CreateMarketingautomationAutomationRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingautomationAutomationRequest = { + xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationAutomationInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationcampaignrequest.md b/docs/models/operations/createmarketingautomationcampaignrequest.md index 4ba87edc..f4c3693e 100644 --- a/docs/models/operations/createmarketingautomationcampaignrequest.md +++ b/docs/models/operations/createmarketingautomationcampaignrequest.md @@ -1,5 +1,16 @@ # CreateMarketingautomationCampaignRequest +## Example Usage + +```typescript +import { CreateMarketingautomationCampaignRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingautomationCampaignRequest = { + xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationCampaignInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationcontactrequest.md b/docs/models/operations/createmarketingautomationcontactrequest.md index 2d5ccef6..1c67bd1a 100644 --- a/docs/models/operations/createmarketingautomationcontactrequest.md +++ b/docs/models/operations/createmarketingautomationcontactrequest.md @@ -1,5 +1,16 @@ # CreateMarketingAutomationContactRequest +## Example Usage + +```typescript +import { CreateMarketingAutomationContactRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingAutomationContactRequest = { + xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationContactInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationlistrequest.md b/docs/models/operations/createmarketingautomationlistrequest.md index 2b3d0993..2ee42a58 100644 --- a/docs/models/operations/createmarketingautomationlistrequest.md +++ b/docs/models/operations/createmarketingautomationlistrequest.md @@ -1,5 +1,15 @@ # CreateMarketingautomationListRequest +## Example Usage + +```typescript +import { CreateMarketingautomationListRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingautomationListRequest = { + xConnectionToken: "", + unifiedMarketingautomationListInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createmarketingautomationtemplaterequest.md b/docs/models/operations/createmarketingautomationtemplaterequest.md index 7190d503..2c774525 100644 --- a/docs/models/operations/createmarketingautomationtemplaterequest.md +++ b/docs/models/operations/createmarketingautomationtemplaterequest.md @@ -1,5 +1,15 @@ # CreateMarketingautomationTemplateRequest +## Example Usage + +```typescript +import { CreateMarketingautomationTemplateRequest } from "@panora/sdk/models/operations"; + +let value: CreateMarketingautomationTemplateRequest = { + xConnectionToken: "", + unifiedMarketingautomationTemplateInput: {}, +}; +``` ## Fields diff --git a/docs/models/operations/createticketingattachmentrequest.md b/docs/models/operations/createticketingattachmentrequest.md index cb682e4d..dd44e99a 100644 --- a/docs/models/operations/createticketingattachmentrequest.md +++ b/docs/models/operations/createticketingattachmentrequest.md @@ -1,5 +1,25 @@ # CreateTicketingAttachmentRequest +## Example Usage + +```typescript +import { CreateTicketingAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: CreateTicketingAttachmentRequest = { + 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", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/createticketingcommentrequest.md b/docs/models/operations/createticketingcommentrequest.md index 5fac1990..b3e9f6c7 100644 --- a/docs/models/operations/createticketingcommentrequest.md +++ b/docs/models/operations/createticketingcommentrequest.md @@ -1,5 +1,25 @@ # CreateTicketingCommentRequest +## Example Usage + +```typescript +import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; +import { CreateTicketingCommentRequest } from "@panora/sdk/models/operations"; + +let value: CreateTicketingCommentRequest = { + 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"], + }, +}; +``` ## Fields diff --git a/docs/models/operations/createticketingticketrequest.md b/docs/models/operations/createticketingticketrequest.md index b4c7ee77..5a661fce 100644 --- a/docs/models/operations/createticketingticketrequest.md +++ b/docs/models/operations/createticketingticketrequest.md @@ -1,5 +1,51 @@ # CreateTicketingTicketRequest +## Example Usage + +```typescript +import { + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, +} from "@panora/sdk/models/components"; +import { CreateTicketingTicketRequest } from "@panora/sdk/models/operations"; + +let value: CreateTicketingTicketRequest = { + 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"], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + }, +}; +``` ## Fields diff --git a/docs/models/operations/deleterequest.md b/docs/models/operations/deleterequest.md index 0fdb034b..0492ed1a 100644 --- a/docs/models/operations/deleterequest.md +++ b/docs/models/operations/deleterequest.md @@ -1,5 +1,14 @@ # DeleteRequest +## Example Usage + +```typescript +import { DeleteRequest } from "@panora/sdk/models/operations"; + +let value: DeleteRequest = { + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/operations/getpanoracoreeventsrequest.md b/docs/models/operations/getpanoracoreeventsrequest.md index eee21068..39c2c9de 100644 --- a/docs/models/operations/getpanoracoreeventsrequest.md +++ b/docs/models/operations/getpanoracoreeventsrequest.md @@ -1,5 +1,12 @@ # GetPanoraCoreEventsRequest +## Example Usage + +```typescript +import { GetPanoraCoreEventsRequest } from "@panora/sdk/models/operations"; + +let value: GetPanoraCoreEventsRequest = {}; +``` ## Fields diff --git a/docs/models/operations/getretriedrequestresponserequest.md b/docs/models/operations/getretriedrequestresponserequest.md index 8d37d17e..92d238d3 100644 --- a/docs/models/operations/getretriedrequestresponserequest.md +++ b/docs/models/operations/getretriedrequestresponserequest.md @@ -1,5 +1,14 @@ # GetRetriedRequestResponseRequest +## Example Usage + +```typescript +import { GetRetriedRequestResponseRequest } from "@panora/sdk/models/operations"; + +let value: GetRetriedRequestResponseRequest = { + retryId: "", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaccountsrequest.md b/docs/models/operations/listaccountingaccountsrequest.md index 11788a35..b16810f2 100644 --- a/docs/models/operations/listaccountingaccountsrequest.md +++ b/docs/models/operations/listaccountingaccountsrequest.md @@ -1,5 +1,17 @@ # ListAccountingAccountsRequest +## Example Usage + +```typescript +import { ListAccountingAccountsRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingAccountsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaccountsresponse.md b/docs/models/operations/listaccountingaccountsresponse.md index 12c6fdf8..c3c0ce97 100644 --- a/docs/models/operations/listaccountingaccountsresponse.md +++ b/docs/models/operations/listaccountingaccountsresponse.md @@ -1,5 +1,38 @@ # ListAccountingAccountsResponse +## Example Usage + +```typescript +import { Currency } from "@panora/sdk/models/components"; +import { ListAccountingAccountsResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingAccountsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: Currency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "account_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaccountsresponsebody.md b/docs/models/operations/listaccountingaccountsresponsebody.md index b4d4a83b..d39d6110 100644 --- a/docs/models/operations/listaccountingaccountsresponsebody.md +++ b/docs/models/operations/listaccountingaccountsresponsebody.md @@ -1,5 +1,36 @@ # ListAccountingAccountsResponseBody +## Example Usage + +```typescript +import { Currency } from "@panora/sdk/models/components"; +import { ListAccountingAccountsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingAccountsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Cash", + description: "Main cash account for daily operations", + classification: "Asset", + type: "Current Asset", + status: "Active", + currentBalance: 10000, + currency: Currency.Usd, + accountNumber: "1000", + parentAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "account_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaddressrequest.md b/docs/models/operations/listaccountingaddressrequest.md index c2b4c068..50fcc277 100644 --- a/docs/models/operations/listaccountingaddressrequest.md +++ b/docs/models/operations/listaccountingaddressrequest.md @@ -1,5 +1,17 @@ # ListAccountingAddressRequest +## Example Usage + +```typescript +import { ListAccountingAddressRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingAddressRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaddressresponse.md b/docs/models/operations/listaccountingaddressresponse.md index 8ade2e47..3bada1da 100644 --- a/docs/models/operations/listaccountingaddressresponse.md +++ b/docs/models/operations/listaccountingaddressresponse.md @@ -1,5 +1,37 @@ # ListAccountingAddressResponse +## Example Usage + +```typescript +import { ListAccountingAddressResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingAddressResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + type: "Billing", + street1: "123 Main St", + street2: "Apt 4B", + city: "New York", + state: "NY", + countrySubdivision: "New York", + country: "USA", + zip: "10001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "address_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingaddressresponsebody.md b/docs/models/operations/listaccountingaddressresponsebody.md index 555e9530..30a1c89d 100644 --- a/docs/models/operations/listaccountingaddressresponsebody.md +++ b/docs/models/operations/listaccountingaddressresponsebody.md @@ -1,5 +1,35 @@ # ListAccountingAddressResponseBody +## Example Usage + +```typescript +import { ListAccountingAddressResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingAddressResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + type: "Billing", + street1: "123 Main St", + street2: "Apt 4B", + city: "New York", + state: "NY", + countrySubdivision: "New York", + country: "USA", + zip: "10001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "address_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingattachmentsrequest.md b/docs/models/operations/listaccountingattachmentsrequest.md index c998ce60..4bd95098 100644 --- a/docs/models/operations/listaccountingattachmentsrequest.md +++ b/docs/models/operations/listaccountingattachmentsrequest.md @@ -1,5 +1,17 @@ # ListAccountingAttachmentsRequest +## Example Usage + +```typescript +import { ListAccountingAttachmentsRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingAttachmentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingattachmentsresponse.md b/docs/models/operations/listaccountingattachmentsresponse.md index d7737d77..438c7d6f 100644 --- a/docs/models/operations/listaccountingattachmentsresponse.md +++ b/docs/models/operations/listaccountingattachmentsresponse.md @@ -1,5 +1,30 @@ # ListAccountingAttachmentsResponse +## Example Usage + +```typescript +import { ListAccountingAttachmentsResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingAttachmentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "attachment_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingattachmentsresponsebody.md b/docs/models/operations/listaccountingattachmentsresponsebody.md index b3dc7af5..cc00a75a 100644 --- a/docs/models/operations/listaccountingattachmentsresponsebody.md +++ b/docs/models/operations/listaccountingattachmentsresponsebody.md @@ -1,5 +1,28 @@ # ListAccountingAttachmentsResponseBody +## Example Usage + +```typescript +import { ListAccountingAttachmentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingAttachmentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + fileName: "invoice.pdf", + fileUrl: "https://example.com/files/invoice.pdf", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "attachment_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingbalancesheetsrequest.md b/docs/models/operations/listaccountingbalancesheetsrequest.md index 6195dc70..c54b0aa6 100644 --- a/docs/models/operations/listaccountingbalancesheetsrequest.md +++ b/docs/models/operations/listaccountingbalancesheetsrequest.md @@ -1,5 +1,17 @@ # ListAccountingBalanceSheetsRequest +## Example Usage + +```typescript +import { ListAccountingBalanceSheetsRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingBalanceSheetsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingbalancesheetsresponse.md b/docs/models/operations/listaccountingbalancesheetsresponse.md index d6cafdf1..5fd7badc 100644 --- a/docs/models/operations/listaccountingbalancesheetsresponse.md +++ b/docs/models/operations/listaccountingbalancesheetsresponse.md @@ -1,5 +1,50 @@ # ListAccountingBalanceSheetsResponse +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingBalanceSheetsResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingBalanceSheetsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Balance Sheet", + currency: UnifiedAccountingBalancesheetOutputCurrency.Usd, + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + date: new Date("2024-06-30T23:59:59Z"), + netAssets: 1000000, + assets: ["Cash", "Accounts Receivable", "Inventory"], + liabilities: ["Accounts Payable", "Long-term Debt"], + equity: ["Common Stock", "Retained Earnings"], + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "balancesheet_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingbalancesheetsresponsebody.md b/docs/models/operations/listaccountingbalancesheetsresponsebody.md index 906aa55a..93b410c5 100644 --- a/docs/models/operations/listaccountingbalancesheetsresponsebody.md +++ b/docs/models/operations/listaccountingbalancesheetsresponsebody.md @@ -1,5 +1,48 @@ # ListAccountingBalanceSheetsResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingBalancesheetOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingBalanceSheetsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingBalanceSheetsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Balance Sheet", + currency: UnifiedAccountingBalancesheetOutputCurrency.Usd, + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + date: new Date("2024-06-30T23:59:59Z"), + netAssets: 1000000, + assets: ["Cash", "Accounts Receivable", "Inventory"], + liabilities: ["Accounts Payable", "Long-term Debt"], + equity: ["Common Stock", "Retained Earnings"], + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "balancesheet_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcashflowstatementrequest.md b/docs/models/operations/listaccountingcashflowstatementrequest.md index e7d4230e..e1914f8d 100644 --- a/docs/models/operations/listaccountingcashflowstatementrequest.md +++ b/docs/models/operations/listaccountingcashflowstatementrequest.md @@ -1,5 +1,17 @@ # ListAccountingCashflowStatementRequest +## Example Usage + +```typescript +import { ListAccountingCashflowStatementRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingCashflowStatementRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcashflowstatementresponse.md b/docs/models/operations/listaccountingcashflowstatementresponse.md index fb0d7dfb..3779c542 100644 --- a/docs/models/operations/listaccountingcashflowstatementresponse.md +++ b/docs/models/operations/listaccountingcashflowstatementresponse.md @@ -1,5 +1,49 @@ # ListAccountingCashflowStatementResponse +## Example Usage + +```typescript +import { UnifiedAccountingCashflowstatementOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCashflowStatementResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingCashflowStatementResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Cash Flow Statement", + currency: UnifiedAccountingCashflowstatementOutputCurrency.Usd, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + cashAtBeginningOfPeriod: 1000000, + cashAtEndOfPeriod: 1200000, + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "cashflowstatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcashflowstatementresponsebody.md b/docs/models/operations/listaccountingcashflowstatementresponsebody.md index 9ee7f785..a63bc595 100644 --- a/docs/models/operations/listaccountingcashflowstatementresponsebody.md +++ b/docs/models/operations/listaccountingcashflowstatementresponsebody.md @@ -1,5 +1,47 @@ # ListAccountingCashflowStatementResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingCashflowstatementOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCashflowStatementResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingCashflowStatementResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Cash Flow Statement", + currency: UnifiedAccountingCashflowstatementOutputCurrency.Usd, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + cashAtBeginningOfPeriod: 1000000, + cashAtEndOfPeriod: 1200000, + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "cashflowstatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcompanyinfosrequest.md b/docs/models/operations/listaccountingcompanyinfosrequest.md index 039d1d9f..9c36b2a6 100644 --- a/docs/models/operations/listaccountingcompanyinfosrequest.md +++ b/docs/models/operations/listaccountingcompanyinfosrequest.md @@ -1,5 +1,17 @@ # ListAccountingCompanyInfosRequest +## Example Usage + +```typescript +import { ListAccountingCompanyInfosRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingCompanyInfosRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcompanyinfosresponse.md b/docs/models/operations/listaccountingcompanyinfosresponse.md index 450e49a0..94b81a98 100644 --- a/docs/models/operations/listaccountingcompanyinfosresponse.md +++ b/docs/models/operations/listaccountingcompanyinfosresponse.md @@ -1,5 +1,40 @@ # ListAccountingCompanyInfosResponse +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCompanyInfosResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingCompanyInfosResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Acme Corporation", + legalName: "Acme Corporation LLC", + taxNumber: "123456789", + fiscalYearEndMonth: 12, + fiscalYearEndDay: 31, + currency: UnifiedAccountingCompanyinfoOutputCurrency.Usd, + urls: ["https://www.acmecorp.com", "https://store.acmecorp.com"], + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcompanyinfosresponsebody.md b/docs/models/operations/listaccountingcompanyinfosresponsebody.md index d9acaf31..5f88b597 100644 --- a/docs/models/operations/listaccountingcompanyinfosresponsebody.md +++ b/docs/models/operations/listaccountingcompanyinfosresponsebody.md @@ -1,5 +1,38 @@ # ListAccountingCompanyInfosResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingCompanyinfoOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCompanyInfosResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingCompanyInfosResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Acme Corporation", + legalName: "Acme Corporation LLC", + taxNumber: "123456789", + fiscalYearEndMonth: 12, + fiscalYearEndDay: 31, + currency: UnifiedAccountingCompanyinfoOutputCurrency.Usd, + urls: ["https://www.acmecorp.com", "https://store.acmecorp.com"], + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcontactsrequest.md b/docs/models/operations/listaccountingcontactsrequest.md index 38add106..194f6a51 100644 --- a/docs/models/operations/listaccountingcontactsrequest.md +++ b/docs/models/operations/listaccountingcontactsrequest.md @@ -1,5 +1,17 @@ # ListAccountingContactsRequest +## Example Usage + +```typescript +import { ListAccountingContactsRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingContactsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcontactsresponse.md b/docs/models/operations/listaccountingcontactsresponse.md index a369c458..b960293a 100644 --- a/docs/models/operations/listaccountingcontactsresponse.md +++ b/docs/models/operations/listaccountingcontactsresponse.md @@ -1,5 +1,37 @@ # ListAccountingContactsResponse +## Example Usage + +```typescript +import { UnifiedAccountingContactOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingContactsResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingContactsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactOutputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "contact_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcontactsresponsebody.md b/docs/models/operations/listaccountingcontactsresponsebody.md index 380ea4f4..2365bed0 100644 --- a/docs/models/operations/listaccountingcontactsresponsebody.md +++ b/docs/models/operations/listaccountingcontactsresponsebody.md @@ -1,5 +1,35 @@ # ListAccountingContactsResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingContactOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingContactsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingContactsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "John Doe", + isSupplier: true, + isCustomer: false, + emailAddress: "john.doe@example.com", + taxNumber: "123456789", + status: "Active", + currency: UnifiedAccountingContactOutputCurrency.Usd, + remoteUpdatedAt: "2024-06-15T12:00:00Z", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "contact_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcreditnoterequest.md b/docs/models/operations/listaccountingcreditnoterequest.md index 72d5adbd..976ce70d 100644 --- a/docs/models/operations/listaccountingcreditnoterequest.md +++ b/docs/models/operations/listaccountingcreditnoterequest.md @@ -1,5 +1,17 @@ # ListAccountingCreditNoteRequest +## Example Usage + +```typescript +import { ListAccountingCreditNoteRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingCreditNoteRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcreditnoteresponse.md b/docs/models/operations/listaccountingcreditnoteresponse.md index e726b51b..bc7a4bbc 100644 --- a/docs/models/operations/listaccountingcreditnoteresponse.md +++ b/docs/models/operations/listaccountingcreditnoteresponse.md @@ -1,5 +1,43 @@ # ListAccountingCreditNoteResponse +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCreditNoteResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingCreditNoteResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + status: "Issued", + number: "CN-001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + exchangeRate: "1.2", + totalAmount: 10000, + remainingCredit: 5000, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + currency: UnifiedAccountingCreditnoteOutputCurrency.Usd, + payments: ["PAYMENT-001", "PAYMENT-002"], + appliedPayments: ["APPLIED-001", "APPLIED-002"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "creditnote_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingcreditnoteresponsebody.md b/docs/models/operations/listaccountingcreditnoteresponsebody.md index 7cf94cce..a6bb43e4 100644 --- a/docs/models/operations/listaccountingcreditnoteresponsebody.md +++ b/docs/models/operations/listaccountingcreditnoteresponsebody.md @@ -1,5 +1,41 @@ # ListAccountingCreditNoteResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingCreditnoteOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingCreditNoteResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingCreditNoteResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + status: "Issued", + number: "CN-001", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + exchangeRate: "1.2", + totalAmount: 10000, + remainingCredit: 5000, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + currency: UnifiedAccountingCreditnoteOutputCurrency.Usd, + payments: ["PAYMENT-001", "PAYMENT-002"], + appliedPayments: ["APPLIED-001", "APPLIED-002"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "creditnote_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingexpenserequest.md b/docs/models/operations/listaccountingexpenserequest.md index 5315e010..e9c1bda5 100644 --- a/docs/models/operations/listaccountingexpenserequest.md +++ b/docs/models/operations/listaccountingexpenserequest.md @@ -1,5 +1,17 @@ # ListAccountingExpenseRequest +## Example Usage + +```typescript +import { ListAccountingExpenseRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingExpenseRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingexpenseresponse.md b/docs/models/operations/listaccountingexpenseresponse.md index 882ef760..7ac7a727 100644 --- a/docs/models/operations/listaccountingexpenseresponse.md +++ b/docs/models/operations/listaccountingexpenseresponse.md @@ -1,5 +1,53 @@ # ListAccountingExpenseResponse +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingExpenseResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingExpenseResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseOutputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "expense_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingexpenseresponsebody.md b/docs/models/operations/listaccountingexpenseresponsebody.md index 83850db8..281c0ec9 100644 --- a/docs/models/operations/listaccountingexpenseresponsebody.md +++ b/docs/models/operations/listaccountingexpenseresponsebody.md @@ -1,5 +1,51 @@ # ListAccountingExpenseResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingExpenseOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingExpenseResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingExpenseResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: 10000, + subTotal: 9000, + totalTaxAmount: 1000, + currency: UnifiedAccountingExpenseOutputCurrency.Usd, + exchangeRate: "1.2", + memo: "Business lunch with client", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "expense_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingincomestatementrequest.md b/docs/models/operations/listaccountingincomestatementrequest.md index e02a5962..c7552c01 100644 --- a/docs/models/operations/listaccountingincomestatementrequest.md +++ b/docs/models/operations/listaccountingincomestatementrequest.md @@ -1,5 +1,17 @@ # ListAccountingIncomeStatementRequest +## Example Usage + +```typescript +import { ListAccountingIncomeStatementRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingIncomeStatementRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingincomestatementresponse.md b/docs/models/operations/listaccountingincomestatementresponse.md index 14713ed1..e070a317 100644 --- a/docs/models/operations/listaccountingincomestatementresponse.md +++ b/docs/models/operations/listaccountingincomestatementresponse.md @@ -1,5 +1,35 @@ # ListAccountingIncomeStatementResponse +## Example Usage + +```typescript +import { UnifiedAccountingIncomestatementOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingIncomeStatementResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingIncomeStatementResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Income Statement", + currency: UnifiedAccountingIncomestatementOutputCurrency.Usd, + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + grossProfit: 1000000, + netOperatingIncome: 800000, + netIncome: 750000, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "incomestatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingincomestatementresponsebody.md b/docs/models/operations/listaccountingincomestatementresponsebody.md index 5271d6ad..0d19005f 100644 --- a/docs/models/operations/listaccountingincomestatementresponsebody.md +++ b/docs/models/operations/listaccountingincomestatementresponsebody.md @@ -1,5 +1,33 @@ # ListAccountingIncomeStatementResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingIncomestatementOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingIncomeStatementResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingIncomeStatementResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Q2 2024 Income Statement", + currency: UnifiedAccountingIncomestatementOutputCurrency.Usd, + startPeriod: new Date("2024-04-01T00:00:00Z"), + endPeriod: new Date("2024-06-30T23:59:59Z"), + grossProfit: 1000000, + netOperatingIncome: 800000, + netIncome: 750000, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "incomestatement_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountinginvoicerequest.md b/docs/models/operations/listaccountinginvoicerequest.md index 0dcea424..4b32ed26 100644 --- a/docs/models/operations/listaccountinginvoicerequest.md +++ b/docs/models/operations/listaccountinginvoicerequest.md @@ -1,5 +1,17 @@ # ListAccountingInvoiceRequest +## Example Usage + +```typescript +import { ListAccountingInvoiceRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingInvoiceRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountinginvoiceresponse.md b/docs/models/operations/listaccountinginvoiceresponse.md index 9f389b71..7c4e6e7a 100644 --- a/docs/models/operations/listaccountinginvoiceresponse.md +++ b/docs/models/operations/listaccountinginvoiceresponse.md @@ -1,5 +1,62 @@ # ListAccountingInvoiceResponse +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingInvoiceResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingInvoiceResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceOutputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "invoice_1234", + remoteData: {}, + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountinginvoiceresponsebody.md b/docs/models/operations/listaccountinginvoiceresponsebody.md index e65eea0c..82172aa4 100644 --- a/docs/models/operations/listaccountinginvoiceresponsebody.md +++ b/docs/models/operations/listaccountinginvoiceresponsebody.md @@ -1,5 +1,60 @@ # ListAccountingInvoiceResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingInvoiceOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingInvoiceResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingInvoiceResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + type: "Sales", + number: "INV-001", + issueDate: new Date("2024-06-15T12:00:00Z"), + dueDate: new Date("2024-07-15T12:00:00Z"), + paidOnDate: new Date("2024-07-10T12:00:00Z"), + memo: "Payment for services rendered", + currency: UnifiedAccountingInvoiceOutputCurrency.Usd, + exchangeRate: "1.2", + totalDiscount: 1000, + subTotal: 10000, + status: "Paid", + totalTaxAmount: 1000, + totalAmount: 11000, + balance: 0, + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "invoice_1234", + remoteData: {}, + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingitemrequest.md b/docs/models/operations/listaccountingitemrequest.md index e781ecb2..7296d799 100644 --- a/docs/models/operations/listaccountingitemrequest.md +++ b/docs/models/operations/listaccountingitemrequest.md @@ -1,5 +1,17 @@ # ListAccountingItemRequest +## Example Usage + +```typescript +import { ListAccountingItemRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingItemRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingitemresponse.md b/docs/models/operations/listaccountingitemresponse.md index 08eaba6e..26321cde 100644 --- a/docs/models/operations/listaccountingitemresponse.md +++ b/docs/models/operations/listaccountingitemresponse.md @@ -1,5 +1,35 @@ # ListAccountingItemResponse +## Example Usage + +```typescript +import { ListAccountingItemResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingItemResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Product A", + status: "Active", + unitPrice: 1000, + purchasePrice: 800, + salesAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + purchaseAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "item_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingitemresponsebody.md b/docs/models/operations/listaccountingitemresponsebody.md index fa88faaa..50e40931 100644 --- a/docs/models/operations/listaccountingitemresponsebody.md +++ b/docs/models/operations/listaccountingitemresponsebody.md @@ -1,5 +1,33 @@ # ListAccountingItemResponseBody +## Example Usage + +```typescript +import { ListAccountingItemResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingItemResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Product A", + status: "Active", + unitPrice: 1000, + purchasePrice: 800, + salesAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + purchaseAccount: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "item_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingjournalentryrequest.md b/docs/models/operations/listaccountingjournalentryrequest.md index add07064..a9acdd50 100644 --- a/docs/models/operations/listaccountingjournalentryrequest.md +++ b/docs/models/operations/listaccountingjournalentryrequest.md @@ -1,5 +1,17 @@ # ListAccountingJournalEntryRequest +## Example Usage + +```typescript +import { ListAccountingJournalEntryRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingJournalEntryRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingjournalentryresponse.md b/docs/models/operations/listaccountingjournalentryresponse.md index 6e6a4c67..fcc28322 100644 --- a/docs/models/operations/listaccountingjournalentryresponse.md +++ b/docs/models/operations/listaccountingjournalentryresponse.md @@ -1,5 +1,54 @@ # ListAccountingJournalEntryResponse +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingJournalEntryResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingJournalEntryResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: ["payment1", "payment2"], + appliedPayments: ["appliedPayment1", "appliedPayment2"], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryOutputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "journal_entry_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteModiifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingjournalentryresponsebody.md b/docs/models/operations/listaccountingjournalentryresponsebody.md index b1f4c6ad..6916612c 100644 --- a/docs/models/operations/listaccountingjournalentryresponsebody.md +++ b/docs/models/operations/listaccountingjournalentryresponsebody.md @@ -1,5 +1,52 @@ # ListAccountingJournalEntryResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingJournalentryOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingJournalEntryResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingJournalEntryResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionDate: new Date("2024-06-15T12:00:00Z"), + payments: ["payment1", "payment2"], + appliedPayments: ["appliedPayment1", "appliedPayment2"], + memo: "Monthly expense journal entry", + currency: UnifiedAccountingJournalentryOutputCurrency.Usd, + exchangeRate: "1.2", + idAccCompanyInfo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + journalNumber: "JE-001", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + idAccAccountingPeriod: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + postingStatus: "Posted", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "journal_entry_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteModiifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpaymentrequest.md b/docs/models/operations/listaccountingpaymentrequest.md index 71f5c37a..79e5abb4 100644 --- a/docs/models/operations/listaccountingpaymentrequest.md +++ b/docs/models/operations/listaccountingpaymentrequest.md @@ -1,5 +1,17 @@ # ListAccountingPaymentRequest +## Example Usage + +```typescript +import { ListAccountingPaymentRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingPaymentRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpaymentresponse.md b/docs/models/operations/listaccountingpaymentresponse.md index ec2037aa..210b51bb 100644 --- a/docs/models/operations/listaccountingpaymentresponse.md +++ b/docs/models/operations/listaccountingpaymentresponse.md @@ -1,5 +1,53 @@ # ListAccountingPaymentResponse +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingPaymentResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingPaymentResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentOutputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payment_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpaymentresponsebody.md b/docs/models/operations/listaccountingpaymentresponsebody.md index 5276a6d4..02d0d52c 100644 --- a/docs/models/operations/listaccountingpaymentresponsebody.md +++ b/docs/models/operations/listaccountingpaymentresponsebody.md @@ -1,5 +1,51 @@ # ListAccountingPaymentResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingPaymentOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingPaymentResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingPaymentResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + invoiceId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + transactionDate: new Date("2024-06-15T12:00:00Z"), + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currency: UnifiedAccountingPaymentOutputCurrency.Usd, + exchangeRate: "1.2", + totalAmount: 10000, + type: "Credit Card", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payment_1234", + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingphonenumberrequest.md b/docs/models/operations/listaccountingphonenumberrequest.md index 24bda25c..d38df3d5 100644 --- a/docs/models/operations/listaccountingphonenumberrequest.md +++ b/docs/models/operations/listaccountingphonenumberrequest.md @@ -1,5 +1,17 @@ # ListAccountingPhonenumberRequest +## Example Usage + +```typescript +import { ListAccountingPhonenumberRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingPhonenumberRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingphonenumberresponse.md b/docs/models/operations/listaccountingphonenumberresponse.md index 10e65e1f..1784bee3 100644 --- a/docs/models/operations/listaccountingphonenumberresponse.md +++ b/docs/models/operations/listaccountingphonenumberresponse.md @@ -1,5 +1,31 @@ # ListAccountingPhonenumberResponse +## Example Usage + +```typescript +import { ListAccountingPhonenumberResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingPhonenumberResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + number: "+1234567890", + type: "Mobile", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "phone_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingphonenumberresponsebody.md b/docs/models/operations/listaccountingphonenumberresponsebody.md index 78265815..a83dfa29 100644 --- a/docs/models/operations/listaccountingphonenumberresponsebody.md +++ b/docs/models/operations/listaccountingphonenumberresponsebody.md @@ -1,5 +1,29 @@ # ListAccountingPhonenumberResponseBody +## Example Usage + +```typescript +import { ListAccountingPhonenumberResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingPhonenumberResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + number: "+1234567890", + type: "Mobile", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "phone_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpurchaseorderrequest.md b/docs/models/operations/listaccountingpurchaseorderrequest.md index 73b9b575..0a96352e 100644 --- a/docs/models/operations/listaccountingpurchaseorderrequest.md +++ b/docs/models/operations/listaccountingpurchaseorderrequest.md @@ -1,5 +1,17 @@ # ListAccountingPurchaseOrderRequest +## Example Usage + +```typescript +import { ListAccountingPurchaseOrderRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingPurchaseOrderRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpurchaseorderresponse.md b/docs/models/operations/listaccountingpurchaseorderresponse.md index 6c8a0d3d..3dbb6da4 100644 --- a/docs/models/operations/listaccountingpurchaseorderresponse.md +++ b/docs/models/operations/listaccountingpurchaseorderresponse.md @@ -1,5 +1,57 @@ # ListAccountingPurchaseOrderResponse +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingPurchaseOrderResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingPurchaseOrderResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderOutputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "po_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingpurchaseorderresponsebody.md b/docs/models/operations/listaccountingpurchaseorderresponsebody.md index 722d6839..5970acdb 100644 --- a/docs/models/operations/listaccountingpurchaseorderresponsebody.md +++ b/docs/models/operations/listaccountingpurchaseorderresponsebody.md @@ -1,5 +1,55 @@ # ListAccountingPurchaseOrderResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingPurchaseorderOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingPurchaseOrderResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingPurchaseOrderResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + status: "Pending", + issueDate: new Date("2024-06-15T12:00:00Z"), + purchaseOrderNumber: "PO-001", + deliveryDate: new Date("2024-07-15T12:00:00Z"), + deliveryAddress: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + customer: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + memo: "Purchase order for Q3 inventory", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: 100000, + currency: UnifiedAccountingPurchaseorderOutputCurrency.Usd, + exchangeRate: "1.2", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "po_1234", + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtaxraterequest.md b/docs/models/operations/listaccountingtaxraterequest.md index 8b894dee..1fd0d13e 100644 --- a/docs/models/operations/listaccountingtaxraterequest.md +++ b/docs/models/operations/listaccountingtaxraterequest.md @@ -1,5 +1,17 @@ # ListAccountingTaxRateRequest +## Example Usage + +```typescript +import { ListAccountingTaxRateRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingTaxRateRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtaxrateresponse.md b/docs/models/operations/listaccountingtaxrateresponse.md index 5a8dec5a..079f246a 100644 --- a/docs/models/operations/listaccountingtaxrateresponse.md +++ b/docs/models/operations/listaccountingtaxrateresponse.md @@ -1,5 +1,31 @@ # ListAccountingTaxRateResponse +## Example Usage + +```typescript +import { ListAccountingTaxRateResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingTaxRateResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + description: "VAT 20%", + totalTaxRatge: 2000, + effectiveTaxRate: 1900, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tax_rate_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtaxrateresponsebody.md b/docs/models/operations/listaccountingtaxrateresponsebody.md index 67027705..9e86df30 100644 --- a/docs/models/operations/listaccountingtaxrateresponsebody.md +++ b/docs/models/operations/listaccountingtaxrateresponsebody.md @@ -1,5 +1,29 @@ # ListAccountingTaxRateResponseBody +## Example Usage + +```typescript +import { ListAccountingTaxRateResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingTaxRateResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + description: "VAT 20%", + totalTaxRatge: 2000, + effectiveTaxRate: 1900, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tax_rate_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtrackingcategorysrequest.md b/docs/models/operations/listaccountingtrackingcategorysrequest.md index d2707284..a1a256db 100644 --- a/docs/models/operations/listaccountingtrackingcategorysrequest.md +++ b/docs/models/operations/listaccountingtrackingcategorysrequest.md @@ -1,5 +1,17 @@ # ListAccountingTrackingCategorysRequest +## Example Usage + +```typescript +import { ListAccountingTrackingCategorysRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingTrackingCategorysRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtrackingcategorysresponse.md b/docs/models/operations/listaccountingtrackingcategorysresponse.md index 0e0eb9f8..f7a319b8 100644 --- a/docs/models/operations/listaccountingtrackingcategorysresponse.md +++ b/docs/models/operations/listaccountingtrackingcategorysresponse.md @@ -1,5 +1,31 @@ # ListAccountingTrackingCategorysResponse +## Example Usage + +```typescript +import { ListAccountingTrackingCategorysResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingTrackingCategorysResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Department", + status: "Active", + categoryType: "Expense", + parentCategory: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tracking_category_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtrackingcategorysresponsebody.md b/docs/models/operations/listaccountingtrackingcategorysresponsebody.md index 64e89b65..7e908266 100644 --- a/docs/models/operations/listaccountingtrackingcategorysresponsebody.md +++ b/docs/models/operations/listaccountingtrackingcategorysresponsebody.md @@ -1,5 +1,29 @@ # ListAccountingTrackingCategorysResponseBody +## Example Usage + +```typescript +import { ListAccountingTrackingCategorysResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingTrackingCategorysResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Department", + status: "Active", + categoryType: "Expense", + parentCategory: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "tracking_category_1234", + remoteData: {}, + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtransactionrequest.md b/docs/models/operations/listaccountingtransactionrequest.md index 24af1a73..247ba910 100644 --- a/docs/models/operations/listaccountingtransactionrequest.md +++ b/docs/models/operations/listaccountingtransactionrequest.md @@ -1,5 +1,17 @@ # ListAccountingTransactionRequest +## Example Usage + +```typescript +import { ListAccountingTransactionRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingTransactionRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtransactionresponse.md b/docs/models/operations/listaccountingtransactionresponse.md index 541b5db6..78207ff4 100644 --- a/docs/models/operations/listaccountingtransactionresponse.md +++ b/docs/models/operations/listaccountingtransactionresponse.md @@ -1,5 +1,53 @@ # ListAccountingTransactionResponse +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingTransactionResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingTransactionResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionType: "Sale", + number: "1001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: "1000", + exchangeRate: "1.2", + currency: UnifiedAccountingTransactionOutputCurrency.Usd, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingtransactionresponsebody.md b/docs/models/operations/listaccountingtransactionresponsebody.md index 4e266b5b..e2a1e6ee 100644 --- a/docs/models/operations/listaccountingtransactionresponsebody.md +++ b/docs/models/operations/listaccountingtransactionresponsebody.md @@ -1,5 +1,51 @@ # ListAccountingTransactionResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingTransactionOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingTransactionResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingTransactionResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + transactionType: "Sale", + number: "1001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + totalAmount: "1000", + exchangeRate: "1.2", + currency: UnifiedAccountingTransactionOutputCurrency.Usd, + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingvendorcreditrequest.md b/docs/models/operations/listaccountingvendorcreditrequest.md index aab74be3..049fd4bd 100644 --- a/docs/models/operations/listaccountingvendorcreditrequest.md +++ b/docs/models/operations/listaccountingvendorcreditrequest.md @@ -1,5 +1,17 @@ # ListAccountingVendorCreditRequest +## Example Usage + +```typescript +import { ListAccountingVendorCreditRequest } from "@panora/sdk/models/operations"; + +let value: ListAccountingVendorCreditRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingvendorcreditresponse.md b/docs/models/operations/listaccountingvendorcreditresponse.md index 3f22abfc..31c17eb2 100644 --- a/docs/models/operations/listaccountingvendorcreditresponse.md +++ b/docs/models/operations/listaccountingvendorcreditresponse.md @@ -1,5 +1,51 @@ # ListAccountingVendorCreditResponse +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingVendorCreditResponse } from "@panora/sdk/models/operations"; + +let value: ListAccountingVendorCreditResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + number: "VC-001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: "1000", + currency: UnifiedAccountingVendorcreditOutputCurrency.Usd, + exchangeRate: "1.2", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listaccountingvendorcreditresponsebody.md b/docs/models/operations/listaccountingvendorcreditresponsebody.md index e3c93454..9159c329 100644 --- a/docs/models/operations/listaccountingvendorcreditresponsebody.md +++ b/docs/models/operations/listaccountingvendorcreditresponsebody.md @@ -1,5 +1,49 @@ # ListAccountingVendorCreditResponseBody +## Example Usage + +```typescript +import { UnifiedAccountingVendorcreditOutputCurrency } from "@panora/sdk/models/components"; +import { ListAccountingVendorCreditResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAccountingVendorCreditResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + number: "VC-001", + transactionDate: new Date("2024-06-15T12:00:00Z"), + vendor: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + totalAmount: "1000", + currency: UnifiedAccountingVendorcreditOutputCurrency.Usd, + exchangeRate: "1.2", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + trackingCategories: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + lineItems: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "report_item_1234", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "remote_id_1234", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteUpdatedAt: new Date("2024-06-15T12:00:00Z"), + remoteData: {}, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsactivityrequest.md b/docs/models/operations/listatsactivityrequest.md index 7138f955..f21a1e84 100644 --- a/docs/models/operations/listatsactivityrequest.md +++ b/docs/models/operations/listatsactivityrequest.md @@ -1,5 +1,17 @@ # ListAtsActivityRequest +## Example Usage + +```typescript +import { ListAtsActivityRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsActivityRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsactivityresponse.md b/docs/models/operations/listatsactivityresponse.md index 1a724274..0ab91cff 100644 --- a/docs/models/operations/listatsactivityresponse.md +++ b/docs/models/operations/listatsactivityresponse.md @@ -1,5 +1,40 @@ # ListAtsActivityResponse +## Example Usage + +```typescript +import { ActivityType, Visibility } from "@panora/sdk/models/components"; +import { ListAtsActivityResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsActivityResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + activityType: ActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: Visibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsactivityresponsebody.md b/docs/models/operations/listatsactivityresponsebody.md index 06db5789..fb4a66f1 100644 --- a/docs/models/operations/listatsactivityresponsebody.md +++ b/docs/models/operations/listatsactivityresponsebody.md @@ -1,5 +1,38 @@ # ListAtsActivityResponseBody +## Example Usage + +```typescript +import { ActivityType, Visibility } from "@panora/sdk/models/components"; +import { ListAtsActivityResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsActivityResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + activityType: ActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: Visibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsapplicationrequest.md b/docs/models/operations/listatsapplicationrequest.md index d3a5bd08..34fb2b0a 100644 --- a/docs/models/operations/listatsapplicationrequest.md +++ b/docs/models/operations/listatsapplicationrequest.md @@ -1,5 +1,17 @@ # ListAtsApplicationRequest +## Example Usage + +```typescript +import { ListAtsApplicationRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsApplicationRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsapplicationresponse.md b/docs/models/operations/listatsapplicationresponse.md index 590d035b..395e5def 100644 --- a/docs/models/operations/listatsapplicationresponse.md +++ b/docs/models/operations/listatsapplicationresponse.md @@ -1,5 +1,45 @@ # ListAtsApplicationResponse +## Example Usage + +```typescript +import { ListAtsApplicationResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsApplicationResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsapplicationresponsebody.md b/docs/models/operations/listatsapplicationresponsebody.md index edbf2634..7fa073ac 100644 --- a/docs/models/operations/listatsapplicationresponsebody.md +++ b/docs/models/operations/listatsapplicationresponsebody.md @@ -1,5 +1,43 @@ # ListAtsApplicationResponseBody +## Example Usage + +```typescript +import { ListAtsApplicationResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsApplicationResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsattachmentrequest.md b/docs/models/operations/listatsattachmentrequest.md index b5004057..f8ddebd8 100644 --- a/docs/models/operations/listatsattachmentrequest.md +++ b/docs/models/operations/listatsattachmentrequest.md @@ -1,5 +1,17 @@ # ListAtsAttachmentRequest +## Example Usage + +```typescript +import { ListAtsAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsAttachmentRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsattachmentresponse.md b/docs/models/operations/listatsattachmentresponse.md index 447948d3..94851d62 100644 --- a/docs/models/operations/listatsattachmentresponse.md +++ b/docs/models/operations/listatsattachmentresponse.md @@ -1,5 +1,40 @@ # ListAtsAttachmentResponse +## Example Usage + +```typescript +import { AttachmentType } from "@panora/sdk/models/components"; +import { ListAtsAttachmentResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsAttachmentResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: AttachmentType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsattachmentresponsebody.md b/docs/models/operations/listatsattachmentresponsebody.md index 69c95b95..465b057e 100644 --- a/docs/models/operations/listatsattachmentresponsebody.md +++ b/docs/models/operations/listatsattachmentresponsebody.md @@ -1,5 +1,38 @@ # ListAtsAttachmentResponseBody +## Example Usage + +```typescript +import { AttachmentType } from "@panora/sdk/models/components"; +import { ListAtsAttachmentResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsAttachmentResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: AttachmentType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatscandidaterequest.md b/docs/models/operations/listatscandidaterequest.md index ad75c442..5952ed07 100644 --- a/docs/models/operations/listatscandidaterequest.md +++ b/docs/models/operations/listatscandidaterequest.md @@ -1,5 +1,17 @@ # ListAtsCandidateRequest +## Example Usage + +```typescript +import { ListAtsCandidateRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsCandidateRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatscandidateresponse.md b/docs/models/operations/listatscandidateresponse.md index 34912d4a..16df8589 100644 --- a/docs/models/operations/listatscandidateresponse.md +++ b/docs/models/operations/listatscandidateresponse.md @@ -1,5 +1,65 @@ # ListAtsCandidateResponse +## Example Usage + +```typescript +import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { ListAtsCandidateResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsCandidateResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatscandidateresponsebody.md b/docs/models/operations/listatscandidateresponsebody.md index 8c3c942b..c4282f9b 100644 --- a/docs/models/operations/listatscandidateresponsebody.md +++ b/docs/models/operations/listatscandidateresponsebody.md @@ -1,5 +1,63 @@ # ListAtsCandidateResponseBody +## Example Usage + +```typescript +import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { ListAtsCandidateResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsCandidateResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsdepartmentsrequest.md b/docs/models/operations/listatsdepartmentsrequest.md index ddbdc512..7d9f68be 100644 --- a/docs/models/operations/listatsdepartmentsrequest.md +++ b/docs/models/operations/listatsdepartmentsrequest.md @@ -1,5 +1,17 @@ # ListAtsDepartmentsRequest +## Example Usage + +```typescript +import { ListAtsDepartmentsRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsDepartmentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsdepartmentsresponse.md b/docs/models/operations/listatsdepartmentsresponse.md index 1d4fb04b..a49584f3 100644 --- a/docs/models/operations/listatsdepartmentsresponse.md +++ b/docs/models/operations/listatsdepartmentsresponse.md @@ -1,5 +1,35 @@ # ListAtsDepartmentsResponse +## Example Usage + +```typescript +import { ListAtsDepartmentsResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsDepartmentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Sales", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsdepartmentsresponsebody.md b/docs/models/operations/listatsdepartmentsresponsebody.md index 72c1917e..9b4adce6 100644 --- a/docs/models/operations/listatsdepartmentsresponsebody.md +++ b/docs/models/operations/listatsdepartmentsresponsebody.md @@ -1,5 +1,33 @@ # ListAtsDepartmentsResponseBody +## Example Usage + +```typescript +import { ListAtsDepartmentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsDepartmentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Sales", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatseeocsrequest.md b/docs/models/operations/listatseeocsrequest.md index 18bd8873..7bf43f2f 100644 --- a/docs/models/operations/listatseeocsrequest.md +++ b/docs/models/operations/listatseeocsrequest.md @@ -1,5 +1,17 @@ # ListAtsEeocsRequest +## Example Usage + +```typescript +import { ListAtsEeocsRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsEeocsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatseeocsresponse.md b/docs/models/operations/listatseeocsresponse.md index 5fdd297d..e3b011a5 100644 --- a/docs/models/operations/listatseeocsresponse.md +++ b/docs/models/operations/listatseeocsresponse.md @@ -1,5 +1,40 @@ # ListAtsEeocsResponse +## Example Usage + +```typescript +import { DisabilityStatus, Race, UnifiedAtsEeocsOutputGender, VeteranStatus } from "@panora/sdk/models/components"; +import { ListAtsEeocsResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsEeocsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + submittedAt: new Date("2024-10-01T12:00:00Z"), + race: Race.AmericanIndianOrAlaskanNative, + gender: UnifiedAtsEeocsOutputGender.Male, + veteranStatus: VeteranStatus.IAmNotAProtectedVeteran, + disabilityStatus: DisabilityStatus.YesIHaveADisabilityOrPreviouslyHadADisability, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatseeocsresponsebody.md b/docs/models/operations/listatseeocsresponsebody.md index 5acab42a..cf9021eb 100644 --- a/docs/models/operations/listatseeocsresponsebody.md +++ b/docs/models/operations/listatseeocsresponsebody.md @@ -1,5 +1,38 @@ # ListAtsEeocsResponseBody +## Example Usage + +```typescript +import { DisabilityStatus, Race, UnifiedAtsEeocsOutputGender, VeteranStatus } from "@panora/sdk/models/components"; +import { ListAtsEeocsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsEeocsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + submittedAt: new Date("2024-10-01T12:00:00Z"), + race: Race.AmericanIndianOrAlaskanNative, + gender: UnifiedAtsEeocsOutputGender.Male, + veteranStatus: VeteranStatus.IAmNotAProtectedVeteran, + disabilityStatus: DisabilityStatus.YesIHaveADisabilityOrPreviouslyHadADisability, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsinterviewrequest.md b/docs/models/operations/listatsinterviewrequest.md index 9ef41211..dad246f2 100644 --- a/docs/models/operations/listatsinterviewrequest.md +++ b/docs/models/operations/listatsinterviewrequest.md @@ -1,5 +1,17 @@ # ListAtsInterviewRequest +## Example Usage + +```typescript +import { ListAtsInterviewRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsInterviewRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsinterviewresponse.md b/docs/models/operations/listatsinterviewresponse.md index 53496254..0323cdc6 100644 --- a/docs/models/operations/listatsinterviewresponse.md +++ b/docs/models/operations/listatsinterviewresponse.md @@ -1,5 +1,44 @@ # ListAtsInterviewResponse +## Example Usage + +```typescript +import { UnifiedAtsInterviewOutputStatus } from "@panora/sdk/models/components"; +import { ListAtsInterviewResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsInterviewResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + status: UnifiedAtsInterviewOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsinterviewresponsebody.md b/docs/models/operations/listatsinterviewresponsebody.md index 9a1e9106..137167a5 100644 --- a/docs/models/operations/listatsinterviewresponsebody.md +++ b/docs/models/operations/listatsinterviewresponsebody.md @@ -1,5 +1,42 @@ # ListAtsInterviewResponseBody +## Example Usage + +```typescript +import { UnifiedAtsInterviewOutputStatus } from "@panora/sdk/models/components"; +import { ListAtsInterviewResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsInterviewResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + status: UnifiedAtsInterviewOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobinterviewstagerequest.md b/docs/models/operations/listatsjobinterviewstagerequest.md index ad89705e..aea4b8aa 100644 --- a/docs/models/operations/listatsjobinterviewstagerequest.md +++ b/docs/models/operations/listatsjobinterviewstagerequest.md @@ -1,5 +1,17 @@ # ListAtsJobInterviewStageRequest +## Example Usage + +```typescript +import { ListAtsJobInterviewStageRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsJobInterviewStageRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobinterviewstageresponse.md b/docs/models/operations/listatsjobinterviewstageresponse.md index c863d0e0..4d8fc1c8 100644 --- a/docs/models/operations/listatsjobinterviewstageresponse.md +++ b/docs/models/operations/listatsjobinterviewstageresponse.md @@ -1,5 +1,36 @@ # ListAtsJobInterviewStageResponse +## Example Usage + +```typescript +import { ListAtsJobInterviewStageResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsJobInterviewStageResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Second Call", + stageOrder: 1, + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobinterviewstageresponsebody.md b/docs/models/operations/listatsjobinterviewstageresponsebody.md index df90dc1b..7d2ae612 100644 --- a/docs/models/operations/listatsjobinterviewstageresponsebody.md +++ b/docs/models/operations/listatsjobinterviewstageresponsebody.md @@ -1,5 +1,34 @@ # ListAtsJobInterviewStageResponseBody +## Example Usage + +```typescript +import { ListAtsJobInterviewStageResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsJobInterviewStageResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Second Call", + stageOrder: 1, + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobrequest.md b/docs/models/operations/listatsjobrequest.md index 602c620b..ed132bfd 100644 --- a/docs/models/operations/listatsjobrequest.md +++ b/docs/models/operations/listatsjobrequest.md @@ -1,5 +1,17 @@ # ListAtsJobRequest +## Example Usage + +```typescript +import { ListAtsJobRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsJobRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobresponse.md b/docs/models/operations/listatsjobresponse.md index 504d9a74..9fe86f9f 100644 --- a/docs/models/operations/listatsjobresponse.md +++ b/docs/models/operations/listatsjobresponse.md @@ -1,5 +1,47 @@ # ListAtsJobResponse +## Example Usage + +```typescript +import { UnifiedAtsJobOutputStatus, UnifiedAtsJobOutputType } from "@panora/sdk/models/components"; +import { ListAtsJobResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsJobResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Financial Analyst", + description: "Extract financial data and write detailed investment thesis", + code: "JOB123", + status: UnifiedAtsJobOutputStatus.Open, + type: UnifiedAtsJobOutputType.Posting, + confidential: true, + departments: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + offices: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + managers: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + recruiters: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsjobresponsebody.md b/docs/models/operations/listatsjobresponsebody.md index 41d59273..76cb8722 100644 --- a/docs/models/operations/listatsjobresponsebody.md +++ b/docs/models/operations/listatsjobresponsebody.md @@ -1,5 +1,45 @@ # ListAtsJobResponseBody +## Example Usage + +```typescript +import { UnifiedAtsJobOutputStatus, UnifiedAtsJobOutputType } from "@panora/sdk/models/components"; +import { ListAtsJobResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsJobResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Financial Analyst", + description: "Extract financial data and write detailed investment thesis", + code: "JOB123", + status: UnifiedAtsJobOutputStatus.Open, + type: UnifiedAtsJobOutputType.Posting, + confidential: true, + departments: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + offices: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + managers: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + recruiters: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsofferrequest.md b/docs/models/operations/listatsofferrequest.md index 3cc15f4e..3b04c6ac 100644 --- a/docs/models/operations/listatsofferrequest.md +++ b/docs/models/operations/listatsofferrequest.md @@ -1,5 +1,17 @@ # ListAtsOfferRequest +## Example Usage + +```typescript +import { ListAtsOfferRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsOfferRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsofferresponse.md b/docs/models/operations/listatsofferresponse.md index 4e24efaa..5b324de0 100644 --- a/docs/models/operations/listatsofferresponse.md +++ b/docs/models/operations/listatsofferresponse.md @@ -1,5 +1,41 @@ # ListAtsOfferResponse +## Example Usage + +```typescript +import { UnifiedAtsOfferOutputStatus } from "@panora/sdk/models/components"; +import { ListAtsOfferResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsOfferResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + createdBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + closedAt: new Date("2024-10-01T12:00:00Z"), + sentAt: new Date("2024-10-01T12:00:00Z"), + startDate: new Date("2024-10-01T12:00:00Z"), + status: UnifiedAtsOfferOutputStatus.Draft, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsofferresponsebody.md b/docs/models/operations/listatsofferresponsebody.md index fc87399e..405fd38e 100644 --- a/docs/models/operations/listatsofferresponsebody.md +++ b/docs/models/operations/listatsofferresponsebody.md @@ -1,5 +1,39 @@ # ListAtsOfferResponseBody +## Example Usage + +```typescript +import { UnifiedAtsOfferOutputStatus } from "@panora/sdk/models/components"; +import { ListAtsOfferResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsOfferResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + createdBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + closedAt: new Date("2024-10-01T12:00:00Z"), + sentAt: new Date("2024-10-01T12:00:00Z"), + startDate: new Date("2024-10-01T12:00:00Z"), + status: UnifiedAtsOfferOutputStatus.Draft, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsofficerequest.md b/docs/models/operations/listatsofficerequest.md index 01988628..84e8f2b9 100644 --- a/docs/models/operations/listatsofficerequest.md +++ b/docs/models/operations/listatsofficerequest.md @@ -1,5 +1,17 @@ # ListAtsOfficeRequest +## Example Usage + +```typescript +import { ListAtsOfficeRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsOfficeRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsofficeresponse.md b/docs/models/operations/listatsofficeresponse.md index 36cbceea..ee510bc1 100644 --- a/docs/models/operations/listatsofficeresponse.md +++ b/docs/models/operations/listatsofficeresponse.md @@ -1,5 +1,35 @@ # ListAtsOfficeResponse +## Example Usage + +```typescript +import { ListAtsOfficeResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsOfficeResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Condo Office 5th", + location: "New York", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsofficeresponsebody.md b/docs/models/operations/listatsofficeresponsebody.md index 4031419b..66921f44 100644 --- a/docs/models/operations/listatsofficeresponsebody.md +++ b/docs/models/operations/listatsofficeresponsebody.md @@ -1,5 +1,33 @@ # ListAtsOfficeResponseBody +## Example Usage + +```typescript +import { ListAtsOfficeResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsOfficeResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Condo Office 5th", + location: "New York", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsrejectreasonsrequest.md b/docs/models/operations/listatsrejectreasonsrequest.md index a686bcba..21487c69 100644 --- a/docs/models/operations/listatsrejectreasonsrequest.md +++ b/docs/models/operations/listatsrejectreasonsrequest.md @@ -1,5 +1,17 @@ # ListAtsRejectReasonsRequest +## Example Usage + +```typescript +import { ListAtsRejectReasonsRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsRejectReasonsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsrejectreasonsresponse.md b/docs/models/operations/listatsrejectreasonsresponse.md index 54be5b31..eee45961 100644 --- a/docs/models/operations/listatsrejectreasonsresponse.md +++ b/docs/models/operations/listatsrejectreasonsresponse.md @@ -1,5 +1,34 @@ # ListAtsRejectReasonsResponse +## Example Usage + +```typescript +import { ListAtsRejectReasonsResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsRejectReasonsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Candidate inexperienced", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsrejectreasonsresponsebody.md b/docs/models/operations/listatsrejectreasonsresponsebody.md index 09d9d06f..d58a12f6 100644 --- a/docs/models/operations/listatsrejectreasonsresponsebody.md +++ b/docs/models/operations/listatsrejectreasonsresponsebody.md @@ -1,5 +1,32 @@ # ListAtsRejectReasonsResponseBody +## Example Usage + +```typescript +import { ListAtsRejectReasonsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsRejectReasonsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Candidate inexperienced", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsscorecardrequest.md b/docs/models/operations/listatsscorecardrequest.md index eaba5954..52a053c1 100644 --- a/docs/models/operations/listatsscorecardrequest.md +++ b/docs/models/operations/listatsscorecardrequest.md @@ -1,5 +1,17 @@ # ListAtsScorecardRequest +## Example Usage + +```typescript +import { ListAtsScorecardRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsScorecardRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsscorecardresponse.md b/docs/models/operations/listatsscorecardresponse.md index ee60321c..142859bd 100644 --- a/docs/models/operations/listatsscorecardresponse.md +++ b/docs/models/operations/listatsscorecardresponse.md @@ -1,5 +1,39 @@ # ListAtsScorecardResponse +## Example Usage + +```typescript +import { OverallRecommendation } from "@panora/sdk/models/components"; +import { ListAtsScorecardResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsScorecardResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + overallRecommendation: OverallRecommendation.Yes, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + submittedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsscorecardresponsebody.md b/docs/models/operations/listatsscorecardresponsebody.md index 151c65e1..11a01a95 100644 --- a/docs/models/operations/listatsscorecardresponsebody.md +++ b/docs/models/operations/listatsscorecardresponsebody.md @@ -1,5 +1,37 @@ # ListAtsScorecardResponseBody +## Example Usage + +```typescript +import { OverallRecommendation } from "@panora/sdk/models/components"; +import { ListAtsScorecardResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsScorecardResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + overallRecommendation: OverallRecommendation.Yes, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + submittedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatstagsrequest.md b/docs/models/operations/listatstagsrequest.md index 88b85270..948e177a 100644 --- a/docs/models/operations/listatstagsrequest.md +++ b/docs/models/operations/listatstagsrequest.md @@ -1,5 +1,17 @@ # ListAtsTagsRequest +## Example Usage + +```typescript +import { ListAtsTagsRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsTagsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatstagsresponse.md b/docs/models/operations/listatstagsresponse.md index 340ecc95..b5609645 100644 --- a/docs/models/operations/listatstagsresponse.md +++ b/docs/models/operations/listatstagsresponse.md @@ -1,5 +1,35 @@ # ListAtsTagsResponse +## Example Usage + +```typescript +import { ListAtsTagsResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsTagsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Important", + idAtsCandidate: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatstagsresponsebody.md b/docs/models/operations/listatstagsresponsebody.md index f0de5ed9..6879a27b 100644 --- a/docs/models/operations/listatstagsresponsebody.md +++ b/docs/models/operations/listatstagsresponsebody.md @@ -1,5 +1,33 @@ # ListAtsTagsResponseBody +## Example Usage + +```typescript +import { ListAtsTagsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsTagsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Important", + idAtsCandidate: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listatsusersrequest.md b/docs/models/operations/listatsusersrequest.md index 08dfdb12..4125f24b 100644 --- a/docs/models/operations/listatsusersrequest.md +++ b/docs/models/operations/listatsusersrequest.md @@ -1,5 +1,17 @@ # ListAtsUsersRequest +## Example Usage + +```typescript +import { ListAtsUsersRequest } from "@panora/sdk/models/operations"; + +let value: ListAtsUsersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listatsusersresponse.md b/docs/models/operations/listatsusersresponse.md index 14fdb1fd..995606d2 100644 --- a/docs/models/operations/listatsusersresponse.md +++ b/docs/models/operations/listatsusersresponse.md @@ -1,5 +1,41 @@ # ListAtsUsersResponse +## Example Usage + +```typescript +import { AccessRole } from "@panora/sdk/models/components"; +import { ListAtsUsersResponse } from "@panora/sdk/models/operations"; + +let value: ListAtsUsersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + email: "john.doe@example.com", + disabled: false, + accessRole: AccessRole.Admin, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listatsusersresponsebody.md b/docs/models/operations/listatsusersresponsebody.md index a1f68e27..1eeea5b9 100644 --- a/docs/models/operations/listatsusersresponsebody.md +++ b/docs/models/operations/listatsusersresponsebody.md @@ -1,5 +1,39 @@ # ListAtsUsersResponseBody +## Example Usage + +```typescript +import { AccessRole } from "@panora/sdk/models/components"; +import { ListAtsUsersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListAtsUsersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + email: "john.doe@example.com", + disabled: false, + accessRole: AccessRole.Admin, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcompanyrequest.md b/docs/models/operations/listcrmcompanyrequest.md index 13075e01..6a20f936 100644 --- a/docs/models/operations/listcrmcompanyrequest.md +++ b/docs/models/operations/listcrmcompanyrequest.md @@ -1,5 +1,17 @@ # ListCrmCompanyRequest +## Example Usage + +```typescript +import { ListCrmCompanyRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmCompanyRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcompanyresponse.md b/docs/models/operations/listcrmcompanyresponse.md index 2c298c17..6cd9f495 100644 --- a/docs/models/operations/listcrmcompanyresponse.md +++ b/docs/models/operations/listcrmcompanyresponse.md @@ -1,5 +1,62 @@ # ListCrmCompanyResponse +## Example Usage + +```typescript +import { AddressType, EmailAddressType, Industry, PhoneType } from "@panora/sdk/models/components"; +import { ListCrmCompanyResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmCompanyResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Acme", + industry: Industry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "NY", + postalCode: "10001", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcompanyresponsebody.md b/docs/models/operations/listcrmcompanyresponsebody.md index 5d20415c..d65faa1c 100644 --- a/docs/models/operations/listcrmcompanyresponsebody.md +++ b/docs/models/operations/listcrmcompanyresponsebody.md @@ -1,5 +1,60 @@ # ListCrmCompanyResponseBody +## Example Usage + +```typescript +import { AddressType, EmailAddressType, Industry, PhoneType } from "@panora/sdk/models/components"; +import { ListCrmCompanyResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmCompanyResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Acme", + industry: Industry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "NY", + postalCode: "10001", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcontactsrequest.md b/docs/models/operations/listcrmcontactsrequest.md index 24076e06..d72fd044 100644 --- a/docs/models/operations/listcrmcontactsrequest.md +++ b/docs/models/operations/listcrmcontactsrequest.md @@ -1,5 +1,17 @@ # ListCrmContactsRequest +## Example Usage + +```typescript +import { ListCrmContactsRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmContactsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcontactsresponse.md b/docs/models/operations/listcrmcontactsresponse.md index 66de18ea..4b490d7d 100644 --- a/docs/models/operations/listcrmcontactsresponse.md +++ b/docs/models/operations/listcrmcontactsresponse.md @@ -1,5 +1,61 @@ # ListCrmContactsResponse +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { ListCrmContactsResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmContactsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Leora.Fadel@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmcontactsresponsebody.md b/docs/models/operations/listcrmcontactsresponsebody.md index 80235938..c6680c91 100644 --- a/docs/models/operations/listcrmcontactsresponsebody.md +++ b/docs/models/operations/listcrmcontactsresponsebody.md @@ -1,5 +1,59 @@ # ListCrmContactsResponseBody +## Example Usage + +```typescript +import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; +import { ListCrmContactsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmContactsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Cullen1@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "Anytown", + state: "CA", + postalCode: "10001", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmdealsrequest.md b/docs/models/operations/listcrmdealsrequest.md index e6ce9aed..c9767521 100644 --- a/docs/models/operations/listcrmdealsrequest.md +++ b/docs/models/operations/listcrmdealsrequest.md @@ -1,5 +1,17 @@ # ListCrmDealsRequest +## Example Usage + +```typescript +import { ListCrmDealsRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmDealsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmdealsresponse.md b/docs/models/operations/listcrmdealsresponse.md index 84153a87..706279b1 100644 --- a/docs/models/operations/listcrmdealsresponse.md +++ b/docs/models/operations/listcrmdealsresponse.md @@ -1,5 +1,39 @@ # ListCrmDealsResponse +## Example Usage + +```typescript +import { ListCrmDealsResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmDealsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmdealsresponsebody.md b/docs/models/operations/listcrmdealsresponsebody.md index 8160407c..4744201b 100644 --- a/docs/models/operations/listcrmdealsresponsebody.md +++ b/docs/models/operations/listcrmdealsresponsebody.md @@ -1,5 +1,37 @@ # ListCrmDealsResponseBody +## Example Usage + +```typescript +import { ListCrmDealsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmDealsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmengagementsrequest.md b/docs/models/operations/listcrmengagementsrequest.md index a3d1d9fe..3c384f4b 100644 --- a/docs/models/operations/listcrmengagementsrequest.md +++ b/docs/models/operations/listcrmengagementsrequest.md @@ -1,5 +1,17 @@ # ListCrmEngagementsRequest +## Example Usage + +```typescript +import { ListCrmEngagementsRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmEngagementsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmengagementsresponse.md b/docs/models/operations/listcrmengagementsresponse.md index 1d69fa21..96b30313 100644 --- a/docs/models/operations/listcrmengagementsresponse.md +++ b/docs/models/operations/listcrmengagementsresponse.md @@ -1,5 +1,43 @@ # ListCrmEngagementsResponse +## Example Usage + +```typescript +import { Direction, UnifiedCrmEngagementOutputType } from "@panora/sdk/models/components"; +import { ListCrmEngagementsResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmEngagementsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + content: "Meeting call with CTO", + direction: Direction.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementOutputType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmengagementsresponsebody.md b/docs/models/operations/listcrmengagementsresponsebody.md index 8dc17e3f..522e9b8f 100644 --- a/docs/models/operations/listcrmengagementsresponsebody.md +++ b/docs/models/operations/listcrmengagementsresponsebody.md @@ -1,5 +1,41 @@ # ListCrmEngagementsResponseBody +## Example Usage + +```typescript +import { Direction, UnifiedCrmEngagementOutputType } from "@panora/sdk/models/components"; +import { ListCrmEngagementsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmEngagementsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + content: "Meeting call with CTO", + direction: Direction.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementOutputType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmnoterequest.md b/docs/models/operations/listcrmnoterequest.md index bc565d03..6702c3d1 100644 --- a/docs/models/operations/listcrmnoterequest.md +++ b/docs/models/operations/listcrmnoterequest.md @@ -1,5 +1,17 @@ # ListCrmNoteRequest +## Example Usage + +```typescript +import { ListCrmNoteRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmNoteRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmnoteresponse.md b/docs/models/operations/listcrmnoteresponse.md index aff68e46..8124892b 100644 --- a/docs/models/operations/listcrmnoteresponse.md +++ b/docs/models/operations/listcrmnoteresponse.md @@ -1,5 +1,38 @@ # ListCrmNoteResponse +## Example Usage + +```typescript +import { ListCrmNoteResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmNoteResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmnoteresponsebody.md b/docs/models/operations/listcrmnoteresponsebody.md index 9ed131f9..9e5eab21 100644 --- a/docs/models/operations/listcrmnoteresponsebody.md +++ b/docs/models/operations/listcrmnoteresponsebody.md @@ -1,5 +1,36 @@ # ListCrmNoteResponseBody +## Example Usage + +```typescript +import { ListCrmNoteResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmNoteResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmstagesrequest.md b/docs/models/operations/listcrmstagesrequest.md index 1d25fb79..a94a6b96 100644 --- a/docs/models/operations/listcrmstagesrequest.md +++ b/docs/models/operations/listcrmstagesrequest.md @@ -1,5 +1,17 @@ # ListCrmStagesRequest +## Example Usage + +```typescript +import { ListCrmStagesRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmStagesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmstagesresponse.md b/docs/models/operations/listcrmstagesresponse.md index 52af288a..ae65fb74 100644 --- a/docs/models/operations/listcrmstagesresponse.md +++ b/docs/models/operations/listcrmstagesresponse.md @@ -1,5 +1,34 @@ # ListCrmStagesResponse +## Example Usage + +```typescript +import { ListCrmStagesResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmStagesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + stageName: "Qualified", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmstagesresponsebody.md b/docs/models/operations/listcrmstagesresponsebody.md index 7f1d61a8..8e007c8a 100644 --- a/docs/models/operations/listcrmstagesresponsebody.md +++ b/docs/models/operations/listcrmstagesresponsebody.md @@ -1,5 +1,32 @@ # ListCrmStagesResponseBody +## Example Usage + +```typescript +import { ListCrmStagesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmStagesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + stageName: "Qualified", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: {}, + modifiedAt: {}, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmtaskrequest.md b/docs/models/operations/listcrmtaskrequest.md index e7140214..2c523f88 100644 --- a/docs/models/operations/listcrmtaskrequest.md +++ b/docs/models/operations/listcrmtaskrequest.md @@ -1,5 +1,17 @@ # ListCrmTaskRequest +## Example Usage + +```typescript +import { ListCrmTaskRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmTaskRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmtaskresponse.md b/docs/models/operations/listcrmtaskresponse.md index a615ab2d..ab7e563b 100644 --- a/docs/models/operations/listcrmtaskresponse.md +++ b/docs/models/operations/listcrmtaskresponse.md @@ -1,5 +1,43 @@ # ListCrmTaskResponse +## Example Usage + +```typescript +import { UnifiedCrmTaskOutputStatus } from "@panora/sdk/models/components"; +import { ListCrmTaskResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmTaskResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmtaskresponsebody.md b/docs/models/operations/listcrmtaskresponsebody.md index 58c60513..95e2a162 100644 --- a/docs/models/operations/listcrmtaskresponsebody.md +++ b/docs/models/operations/listcrmtaskresponsebody.md @@ -1,5 +1,41 @@ # ListCrmTaskResponseBody +## Example Usage + +```typescript +import { UnifiedCrmTaskOutputStatus } from "@panora/sdk/models/components"; +import { ListCrmTaskResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmTaskResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskOutputStatus.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listcrmusersrequest.md b/docs/models/operations/listcrmusersrequest.md index daeb1748..f8caf420 100644 --- a/docs/models/operations/listcrmusersrequest.md +++ b/docs/models/operations/listcrmusersrequest.md @@ -1,5 +1,17 @@ # ListCrmUsersRequest +## Example Usage + +```typescript +import { ListCrmUsersRequest } from "@panora/sdk/models/operations"; + +let value: ListCrmUsersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listcrmusersresponse.md b/docs/models/operations/listcrmusersresponse.md index 4ea48cea..9bdfc80f 100644 --- a/docs/models/operations/listcrmusersresponse.md +++ b/docs/models/operations/listcrmusersresponse.md @@ -1,5 +1,35 @@ # ListCrmUsersResponse +## Example Usage + +```typescript +import { ListCrmUsersResponse } from "@panora/sdk/models/operations"; + +let value: ListCrmUsersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Jane Doe", + email: "jane.doe@example.com", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listcrmusersresponsebody.md b/docs/models/operations/listcrmusersresponsebody.md index 832b5c78..464bb07a 100644 --- a/docs/models/operations/listcrmusersresponsebody.md +++ b/docs/models/operations/listcrmusersresponsebody.md @@ -1,5 +1,33 @@ # ListCrmUsersResponseBody +## Example Usage + +```typescript +import { ListCrmUsersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListCrmUsersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Jane Doe", + email: "jane.doe@example.com", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listecommercecustomersrequest.md b/docs/models/operations/listecommercecustomersrequest.md index 924d32cb..782218cd 100644 --- a/docs/models/operations/listecommercecustomersrequest.md +++ b/docs/models/operations/listecommercecustomersrequest.md @@ -1,5 +1,17 @@ # ListEcommerceCustomersRequest +## Example Usage + +```typescript +import { ListEcommerceCustomersRequest } from "@panora/sdk/models/operations"; + +let value: ListEcommerceCustomersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listecommercecustomersresponse.md b/docs/models/operations/listecommercecustomersresponse.md index 3ecab149..829e64ea 100644 --- a/docs/models/operations/listecommercecustomersresponse.md +++ b/docs/models/operations/listecommercecustomersresponse.md @@ -1,5 +1,44 @@ # ListEcommerceCustomersResponse +## Example Usage + +```typescript +import { AddressType } from "@panora/sdk/models/components"; +import { ListEcommerceCustomersResponse } from "@panora/sdk/models/operations"; + +let value: ListEcommerceCustomersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + email: "joedoe@gmail.com", + firstName: "Joe", + lastName: "Doe", + phoneNumber: "+336666666", + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "New York", + postalCode: "10001", + country: "United States of America", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listecommercecustomersresponsebody.md b/docs/models/operations/listecommercecustomersresponsebody.md index 48a5fbf5..b9fed5e5 100644 --- a/docs/models/operations/listecommercecustomersresponsebody.md +++ b/docs/models/operations/listecommercecustomersresponsebody.md @@ -1,5 +1,42 @@ # ListEcommerceCustomersResponseBody +## Example Usage + +```typescript +import { AddressType } from "@panora/sdk/models/components"; +import { ListEcommerceCustomersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListEcommerceCustomersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + email: "joedoe@gmail.com", + firstName: "Joe", + lastName: "Doe", + phoneNumber: "+336666666", + addresses: [ + { + street1: "5th Avenue", + street2: "Street 2", + city: "New York", + state: "New York", + postalCode: "10001", + country: "United States of America", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listecommercefulfillmentsrequest.md b/docs/models/operations/listecommercefulfillmentsrequest.md index 28afc819..7e16f438 100644 --- a/docs/models/operations/listecommercefulfillmentsrequest.md +++ b/docs/models/operations/listecommercefulfillmentsrequest.md @@ -1,5 +1,17 @@ # ListEcommerceFulfillmentsRequest +## Example Usage + +```typescript +import { ListEcommerceFulfillmentsRequest } from "@panora/sdk/models/operations"; + +let value: ListEcommerceFulfillmentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listecommercefulfillmentsresponse.md b/docs/models/operations/listecommercefulfillmentsresponse.md index 6eef4e94..b341b034 100644 --- a/docs/models/operations/listecommercefulfillmentsresponse.md +++ b/docs/models/operations/listecommercefulfillmentsresponse.md @@ -1,5 +1,32 @@ # ListEcommerceFulfillmentsResponse +## Example Usage + +```typescript +import { ListEcommerceFulfillmentsResponse } from "@panora/sdk/models/operations"; + +let value: ListEcommerceFulfillmentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + carrier: "DHL", + trackingUrls: ["https://tracing-url.sf.com"], + trackingNumbers: ["track_1029_191919"], + items: {}, + orderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listecommercefulfillmentsresponsebody.md b/docs/models/operations/listecommercefulfillmentsresponsebody.md index 15e5c1b8..ce225bcd 100644 --- a/docs/models/operations/listecommercefulfillmentsresponsebody.md +++ b/docs/models/operations/listecommercefulfillmentsresponsebody.md @@ -1,5 +1,30 @@ # ListEcommerceFulfillmentsResponseBody +## Example Usage + +```typescript +import { ListEcommerceFulfillmentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListEcommerceFulfillmentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + carrier: "DHL", + trackingUrls: ["https://tracing-url.sf.com"], + trackingNumbers: ["track_1029_191919"], + items: {}, + orderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceordersrequest.md b/docs/models/operations/listecommerceordersrequest.md index 9fd46e8d..48311e28 100644 --- a/docs/models/operations/listecommerceordersrequest.md +++ b/docs/models/operations/listecommerceordersrequest.md @@ -1,5 +1,17 @@ # ListEcommerceOrdersRequest +## Example Usage + +```typescript +import { ListEcommerceOrdersRequest } from "@panora/sdk/models/operations"; + +let value: ListEcommerceOrdersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceordersresponse.md b/docs/models/operations/listecommerceordersresponse.md index 91829ef1..d5785f62 100644 --- a/docs/models/operations/listecommerceordersresponse.md +++ b/docs/models/operations/listecommerceordersresponse.md @@ -1,5 +1,56 @@ # ListEcommerceOrdersResponse +## Example Usage + +```typescript +import { + FulfillmentStatus, + OrderStatus, + PaymentStatus, + UnifiedEcommerceOrderOutputCurrency, +} from "@panora/sdk/models/components"; +import { ListEcommerceOrdersResponse } from "@panora/sdk/models/operations"; + +let value: ListEcommerceOrdersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + orderStatus: OrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: PaymentStatus.Success, + currency: UnifiedEcommerceOrderOutputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: FulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceordersresponsebody.md b/docs/models/operations/listecommerceordersresponsebody.md index 7ed56c2c..bb8b584a 100644 --- a/docs/models/operations/listecommerceordersresponsebody.md +++ b/docs/models/operations/listecommerceordersresponsebody.md @@ -1,5 +1,54 @@ # ListEcommerceOrdersResponseBody +## Example Usage + +```typescript +import { + FulfillmentStatus, + OrderStatus, + PaymentStatus, + UnifiedEcommerceOrderOutputCurrency, +} from "@panora/sdk/models/components"; +import { ListEcommerceOrdersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListEcommerceOrdersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + orderStatus: OrderStatus.Unshipped, + orderNumber: "19823838833", + paymentStatus: PaymentStatus.Success, + currency: UnifiedEcommerceOrderOutputCurrency.Aud, + totalPrice: 300, + totalDiscount: 10, + totalShipping: 120, + totalTax: 120, + fulfillmentStatus: FulfillmentStatus.Pending, + customerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + items: [ + { + name: "Net Income", + value: 100000, + type: "Operating Activities", + parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "12345", + remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"), + companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceproductsrequest.md b/docs/models/operations/listecommerceproductsrequest.md index 01b6aaf6..15f2d97a 100644 --- a/docs/models/operations/listecommerceproductsrequest.md +++ b/docs/models/operations/listecommerceproductsrequest.md @@ -1,5 +1,17 @@ # ListEcommerceProductsRequest +## Example Usage + +```typescript +import { ListEcommerceProductsRequest } from "@panora/sdk/models/operations"; + +let value: ListEcommerceProductsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceproductsresponse.md b/docs/models/operations/listecommerceproductsresponse.md index 9712852f..a9b5d025 100644 --- a/docs/models/operations/listecommerceproductsresponse.md +++ b/docs/models/operations/listecommerceproductsresponse.md @@ -1,5 +1,36 @@ # ListEcommerceProductsResponse +## Example Usage + +```typescript +import { ProductStatus } from "@panora/sdk/models/components"; +import { ListEcommerceProductsResponse } from "@panora/sdk/models/operations"; + +let value: ListEcommerceProductsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: ProductStatus.Active, + imagesUrls: ["https://myproduct/image"], + description: "best tee ever", + vendor: "vendor_extern", + variants: [{}], + tags: ["tag_1"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listecommerceproductsresponsebody.md b/docs/models/operations/listecommerceproductsresponsebody.md index 173a0de5..23110546 100644 --- a/docs/models/operations/listecommerceproductsresponsebody.md +++ b/docs/models/operations/listecommerceproductsresponsebody.md @@ -1,5 +1,34 @@ # ListEcommerceProductsResponseBody +## Example Usage + +```typescript +import { ProductStatus } from "@panora/sdk/models/components"; +import { ListEcommerceProductsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListEcommerceProductsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + productUrl: "https://product_url/tee", + productType: "teeshirt", + productStatus: ProductStatus.Active, + imagesUrls: ["https://myproduct/image"], + description: "best tee ever", + vendor: "vendor_extern", + variants: [{}], + tags: ["tag_1"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + createdAt: "2024-10-01T12:00:00Z", + modifiedAt: "2024-10-01T12:00:00Z", + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragedrivesrequest.md b/docs/models/operations/listfilestoragedrivesrequest.md index 91272ccd..55bd8fe7 100644 --- a/docs/models/operations/listfilestoragedrivesrequest.md +++ b/docs/models/operations/listfilestoragedrivesrequest.md @@ -1,5 +1,17 @@ # ListFilestorageDrivesRequest +## Example Usage + +```typescript +import { ListFilestorageDrivesRequest } from "@panora/sdk/models/operations"; + +let value: ListFilestorageDrivesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragedrivesresponse.md b/docs/models/operations/listfilestoragedrivesresponse.md index d8d15350..33e7d55f 100644 --- a/docs/models/operations/listfilestoragedrivesresponse.md +++ b/docs/models/operations/listfilestoragedrivesresponse.md @@ -1,5 +1,36 @@ # ListFilestorageDrivesResponse +## Example Usage + +```typescript +import { ListFilestorageDrivesResponse } from "@panora/sdk/models/operations"; + +let value: ListFilestorageDrivesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "school", + remoteCreatedAt: "2024-10-01T12:00:00Z", + driveUrl: "https://example.com/school", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragedrivesresponsebody.md b/docs/models/operations/listfilestoragedrivesresponsebody.md index 10bb0a89..8aad1dae 100644 --- a/docs/models/operations/listfilestoragedrivesresponsebody.md +++ b/docs/models/operations/listfilestoragedrivesresponsebody.md @@ -1,5 +1,34 @@ # ListFilestorageDrivesResponseBody +## Example Usage + +```typescript +import { ListFilestorageDrivesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListFilestorageDrivesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "school", + remoteCreatedAt: "2024-10-01T12:00:00Z", + driveUrl: "https://example.com/school", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefilerequest.md b/docs/models/operations/listfilestoragefilerequest.md index c9b98c9c..943fa2a3 100644 --- a/docs/models/operations/listfilestoragefilerequest.md +++ b/docs/models/operations/listfilestoragefilerequest.md @@ -1,5 +1,17 @@ # ListFilestorageFileRequest +## Example Usage + +```typescript +import { ListFilestorageFileRequest } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFileRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefileresponse.md b/docs/models/operations/listfilestoragefileresponse.md index 354db74f..72cbe473 100644 --- a/docs/models/operations/listfilestoragefileresponse.md +++ b/docs/models/operations/listfilestoragefileresponse.md @@ -1,5 +1,40 @@ # ListFilestorageFileResponse +## Example Usage + +```typescript +import { ListFilestorageFileResponse } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFileResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefileresponsebody.md b/docs/models/operations/listfilestoragefileresponsebody.md index d856485f..63afe825 100644 --- a/docs/models/operations/listfilestoragefileresponsebody.md +++ b/docs/models/operations/listfilestoragefileresponsebody.md @@ -1,5 +1,38 @@ # ListFilestorageFileResponseBody +## Example Usage + +```typescript +import { ListFilestorageFileResponseBody } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFileResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefolderrequest.md b/docs/models/operations/listfilestoragefolderrequest.md index 8c061bbc..1e329962 100644 --- a/docs/models/operations/listfilestoragefolderrequest.md +++ b/docs/models/operations/listfilestoragefolderrequest.md @@ -1,5 +1,17 @@ # ListFilestorageFolderRequest +## Example Usage + +```typescript +import { ListFilestorageFolderRequest } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFolderRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefolderresponse.md b/docs/models/operations/listfilestoragefolderresponse.md index f1a3e8a7..3dff0046 100644 --- a/docs/models/operations/listfilestoragefolderresponse.md +++ b/docs/models/operations/listfilestoragefolderresponse.md @@ -1,5 +1,41 @@ # ListFilestorageFolderResponse +## Example Usage + +```typescript +import { ListFilestorageFolderResponse } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFolderResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragefolderresponsebody.md b/docs/models/operations/listfilestoragefolderresponsebody.md index 9078170d..d1b7530d 100644 --- a/docs/models/operations/listfilestoragefolderresponsebody.md +++ b/docs/models/operations/listfilestoragefolderresponsebody.md @@ -1,5 +1,39 @@ # ListFilestorageFolderResponseBody +## Example Usage + +```typescript +import { ListFilestorageFolderResponseBody } from "@panora/sdk/models/operations"; + +let value: ListFilestorageFolderResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragegrouprequest.md b/docs/models/operations/listfilestoragegrouprequest.md index fc1617a5..d3545e55 100644 --- a/docs/models/operations/listfilestoragegrouprequest.md +++ b/docs/models/operations/listfilestoragegrouprequest.md @@ -1,5 +1,17 @@ # ListFilestorageGroupRequest +## Example Usage + +```typescript +import { ListFilestorageGroupRequest } from "@panora/sdk/models/operations"; + +let value: ListFilestorageGroupRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragegroupresponse.md b/docs/models/operations/listfilestoragegroupresponse.md index 33c6b981..041d2e12 100644 --- a/docs/models/operations/listfilestoragegroupresponse.md +++ b/docs/models/operations/listfilestoragegroupresponse.md @@ -1,5 +1,36 @@ # ListFilestorageGroupResponse +## Example Usage + +```typescript +import { ListFilestorageGroupResponse } from "@panora/sdk/models/operations"; + +let value: ListFilestorageGroupResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My group", + users: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteWasDeleted: false, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listfilestoragegroupresponsebody.md b/docs/models/operations/listfilestoragegroupresponsebody.md index 27e56106..ef0743bc 100644 --- a/docs/models/operations/listfilestoragegroupresponsebody.md +++ b/docs/models/operations/listfilestoragegroupresponsebody.md @@ -1,5 +1,34 @@ # ListFilestorageGroupResponseBody +## Example Usage + +```typescript +import { ListFilestorageGroupResponseBody } from "@panora/sdk/models/operations"; + +let value: ListFilestorageGroupResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My group", + users: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + remoteWasDeleted: false, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listfilestorageusersrequest.md b/docs/models/operations/listfilestorageusersrequest.md index f485475c..6f6cc173 100644 --- a/docs/models/operations/listfilestorageusersrequest.md +++ b/docs/models/operations/listfilestorageusersrequest.md @@ -1,5 +1,17 @@ # ListFilestorageUsersRequest +## Example Usage + +```typescript +import { ListFilestorageUsersRequest } from "@panora/sdk/models/operations"; + +let value: ListFilestorageUsersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listfilestorageusersresponse.md b/docs/models/operations/listfilestorageusersresponse.md index 1c27cc0a..75031e89 100644 --- a/docs/models/operations/listfilestorageusersresponse.md +++ b/docs/models/operations/listfilestorageusersresponse.md @@ -1,5 +1,36 @@ # ListFilestorageUsersResponse +## Example Usage + +```typescript +import { ListFilestorageUsersResponse } from "@panora/sdk/models/operations"; + +let value: ListFilestorageUsersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Joe Doe", + email: "joe.doe@gmail.com", + isMe: true, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listfilestorageusersresponsebody.md b/docs/models/operations/listfilestorageusersresponsebody.md index 9e052021..0ddaeecf 100644 --- a/docs/models/operations/listfilestorageusersresponsebody.md +++ b/docs/models/operations/listfilestorageusersresponsebody.md @@ -1,5 +1,34 @@ # ListFilestorageUsersResponseBody +## Example Usage + +```typescript +import { ListFilestorageUsersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListFilestorageUsersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Joe Doe", + email: "joe.doe@gmail.com", + isMe: true, + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbankinforequest.md b/docs/models/operations/listhrisbankinforequest.md index 334d4329..56e34e1b 100644 --- a/docs/models/operations/listhrisbankinforequest.md +++ b/docs/models/operations/listhrisbankinforequest.md @@ -1,5 +1,17 @@ # ListHrisBankInfoRequest +## Example Usage + +```typescript +import { ListHrisBankInfoRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisBankInfoRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbankinforesponse.md b/docs/models/operations/listhrisbankinforesponse.md index d497712c..9cdfa62b 100644 --- a/docs/models/operations/listhrisbankinforesponse.md +++ b/docs/models/operations/listhrisbankinforesponse.md @@ -1,5 +1,35 @@ # ListHrisBankInfoResponse +## Example Usage + +```typescript +import { AccountType } from "@panora/sdk/models/components"; +import { ListHrisBankInfoResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisBankInfoResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + accountType: AccountType.Checking, + bankName: "Bank of America", + accountNumber: "1234567890", + routingNumber: "021000021", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbankinforesponsebody.md b/docs/models/operations/listhrisbankinforesponsebody.md index e5b49734..8386676c 100644 --- a/docs/models/operations/listhrisbankinforesponsebody.md +++ b/docs/models/operations/listhrisbankinforesponsebody.md @@ -1,5 +1,33 @@ # ListHrisBankInfoResponseBody +## Example Usage + +```typescript +import { AccountType } from "@panora/sdk/models/components"; +import { ListHrisBankInfoResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisBankInfoResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + accountType: AccountType.Checking, + bankName: "Bank of America", + accountNumber: "1234567890", + routingNumber: "021000021", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbenefitsrequest.md b/docs/models/operations/listhrisbenefitsrequest.md index 5961d2b3..c718acc7 100644 --- a/docs/models/operations/listhrisbenefitsrequest.md +++ b/docs/models/operations/listhrisbenefitsrequest.md @@ -1,5 +1,17 @@ # ListHrisBenefitsRequest +## Example Usage + +```typescript +import { ListHrisBenefitsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisBenefitsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbenefitsresponse.md b/docs/models/operations/listhrisbenefitsresponse.md index 56578655..a0022f5a 100644 --- a/docs/models/operations/listhrisbenefitsresponse.md +++ b/docs/models/operations/listhrisbenefitsresponse.md @@ -1,5 +1,36 @@ # ListHrisBenefitsResponse +## Example Usage + +```typescript +import { ListHrisBenefitsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisBenefitsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + providerName: "Health Insurance Provider", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeContribution: 100, + companyContribution: 200, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-12-31T23:59:59Z"), + employerBenefitId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisbenefitsresponsebody.md b/docs/models/operations/listhrisbenefitsresponsebody.md index 0b575b6d..85715bfb 100644 --- a/docs/models/operations/listhrisbenefitsresponsebody.md +++ b/docs/models/operations/listhrisbenefitsresponsebody.md @@ -1,5 +1,34 @@ # ListHrisBenefitsResponseBody +## Example Usage + +```typescript +import { ListHrisBenefitsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisBenefitsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + providerName: "Health Insurance Provider", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeContribution: 100, + companyContribution: 200, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-12-31T23:59:59Z"), + employerBenefitId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhriscompaniesrequest.md b/docs/models/operations/listhriscompaniesrequest.md index 51660c13..7e9a21ff 100644 --- a/docs/models/operations/listhriscompaniesrequest.md +++ b/docs/models/operations/listhriscompaniesrequest.md @@ -1,5 +1,17 @@ # ListHrisCompaniesRequest +## Example Usage + +```typescript +import { ListHrisCompaniesRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisCompaniesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhriscompaniesresponse.md b/docs/models/operations/listhriscompaniesresponse.md index 0edf5488..3299e628 100644 --- a/docs/models/operations/listhriscompaniesresponse.md +++ b/docs/models/operations/listhriscompaniesresponse.md @@ -1,5 +1,33 @@ # ListHrisCompaniesResponse +## Example Usage + +```typescript +import { ListHrisCompaniesResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisCompaniesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + legalName: "Acme Corporation", + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + displayName: "Acme Corp", + eins: ["12-3456789", "98-7654321"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhriscompaniesresponsebody.md b/docs/models/operations/listhriscompaniesresponsebody.md index 04a6b763..58a9e1fa 100644 --- a/docs/models/operations/listhriscompaniesresponsebody.md +++ b/docs/models/operations/listhriscompaniesresponsebody.md @@ -1,5 +1,31 @@ # ListHrisCompaniesResponseBody +## Example Usage + +```typescript +import { ListHrisCompaniesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisCompaniesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + legalName: "Acme Corporation", + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + displayName: "Acme Corp", + eins: ["12-3456789", "98-7654321"], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "company_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisdependentsrequest.md b/docs/models/operations/listhrisdependentsrequest.md index 5342fe72..a6cda22a 100644 --- a/docs/models/operations/listhrisdependentsrequest.md +++ b/docs/models/operations/listhrisdependentsrequest.md @@ -1,5 +1,17 @@ # ListHrisDependentsRequest +## Example Usage + +```typescript +import { ListHrisDependentsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisDependentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisdependentsresponse.md b/docs/models/operations/listhrisdependentsresponse.md index a1d3affe..97459781 100644 --- a/docs/models/operations/listhrisdependentsresponse.md +++ b/docs/models/operations/listhrisdependentsresponse.md @@ -1,5 +1,41 @@ # ListHrisDependentsResponse +## Example Usage + +```typescript +import { Gender, Relationship } from "@panora/sdk/models/components"; +import { ListHrisDependentsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisDependentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + middleName: "Michael", + relationship: Relationship.Child, + dateOfBirth: new Date("2020-01-01"), + gender: Gender.Male, + phoneNumber: "+1234567890", + homeLocation: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + isStudent: true, + ssn: "123-45-6789", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "dependent_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisdependentsresponsebody.md b/docs/models/operations/listhrisdependentsresponsebody.md index c6ab605d..f417d0ae 100644 --- a/docs/models/operations/listhrisdependentsresponsebody.md +++ b/docs/models/operations/listhrisdependentsresponsebody.md @@ -1,5 +1,39 @@ # ListHrisDependentsResponseBody +## Example Usage + +```typescript +import { Gender, Relationship } from "@panora/sdk/models/components"; +import { ListHrisDependentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisDependentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + firstName: "John", + lastName: "Doe", + middleName: "Michael", + relationship: Relationship.Child, + dateOfBirth: new Date("2020-01-01"), + gender: Gender.Male, + phoneNumber: "+1234567890", + homeLocation: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + isStudent: true, + ssn: "123-45-6789", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "dependent_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeepayrollrunrequest.md b/docs/models/operations/listhrisemployeepayrollrunrequest.md index 56ba7de1..2c970f7d 100644 --- a/docs/models/operations/listhrisemployeepayrollrunrequest.md +++ b/docs/models/operations/listhrisemployeepayrollrunrequest.md @@ -1,5 +1,17 @@ # ListHrisEmployeePayrollRunRequest +## Example Usage + +```typescript +import { ListHrisEmployeePayrollRunRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeePayrollRunRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeepayrollrunresponse.md b/docs/models/operations/listhrisemployeepayrollrunresponse.md index 65ab25a3..07adb2bd 100644 --- a/docs/models/operations/listhrisemployeepayrollrunresponse.md +++ b/docs/models/operations/listhrisemployeepayrollrunresponse.md @@ -1,5 +1,56 @@ # ListHrisEmployeePayrollRunResponse +## Example Usage + +```typescript +import { ListHrisEmployeePayrollRunResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeePayrollRunResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + payrollRunId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + grossPay: 5000, + netPay: 4000, + startDate: new Date("2023-01-01T00:00:00Z"), + endDate: new Date("2023-01-15T23:59:59Z"), + checkDate: new Date("2023-01-20T00:00:00Z"), + deductions: [ + { + name: "Health Insurance", + employeeDeduction: 100, + companyDeduction: 200, + }, + ], + earnings: [ + { + amount: 1000, + type: "Salary", + }, + ], + taxes: [ + { + name: "Federal Income Tax", + amount: 250, + employerTax: true, + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeepayrollrunresponsebody.md b/docs/models/operations/listhrisemployeepayrollrunresponsebody.md index 4bb37822..3d6bb6f0 100644 --- a/docs/models/operations/listhrisemployeepayrollrunresponsebody.md +++ b/docs/models/operations/listhrisemployeepayrollrunresponsebody.md @@ -1,5 +1,54 @@ # ListHrisEmployeePayrollRunResponseBody +## Example Usage + +```typescript +import { ListHrisEmployeePayrollRunResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeePayrollRunResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + payrollRunId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + grossPay: 5000, + netPay: 4000, + startDate: new Date("2023-01-01T00:00:00Z"), + endDate: new Date("2023-01-15T23:59:59Z"), + checkDate: new Date("2023-01-20T00:00:00Z"), + deductions: [ + { + name: "Health Insurance", + employeeDeduction: 100, + companyDeduction: 200, + }, + ], + earnings: [ + { + amount: 1000, + type: "Salary", + }, + ], + taxes: [ + { + name: "Federal Income Tax", + amount: 250, + employerTax: true, + }, + ], + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeesrequest.md b/docs/models/operations/listhrisemployeesrequest.md index 4b3e5175..24b82551 100644 --- a/docs/models/operations/listhrisemployeesrequest.md +++ b/docs/models/operations/listhrisemployeesrequest.md @@ -1,5 +1,17 @@ # ListHrisEmployeesRequest +## Example Usage + +```typescript +import { ListHrisEmployeesRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeesresponse.md b/docs/models/operations/listhrisemployeesresponse.md index 96ec79c1..abda6195 100644 --- a/docs/models/operations/listhrisemployeesresponse.md +++ b/docs/models/operations/listhrisemployeesresponse.md @@ -1,5 +1,56 @@ # ListHrisEmployeesResponse +## Example Usage + +```typescript +import { EmploymentStatus, Ethnicity, MaritalStatus, UnifiedHrisEmployeeOutputGender } from "@panora/sdk/models/components"; +import { ListHrisEmployeesResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + groups: ["Group1", "Group2"], + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + employeeNumber: "EMP001", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeOutputGender.Male, + ethnicity: Ethnicity.AmericanIndianOrAlaskaNative, + maritalStatus: MaritalStatus.HeadOfHousehold, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: EmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employee_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployeesresponsebody.md b/docs/models/operations/listhrisemployeesresponsebody.md index 88019bd7..f137a526 100644 --- a/docs/models/operations/listhrisemployeesresponsebody.md +++ b/docs/models/operations/listhrisemployeesresponsebody.md @@ -1,5 +1,54 @@ # ListHrisEmployeesResponseBody +## Example Usage + +```typescript +import { EmploymentStatus, Ethnicity, MaritalStatus, UnifiedHrisEmployeeOutputGender } from "@panora/sdk/models/components"; +import { ListHrisEmployeesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployeesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + groups: ["Group1", "Group2"], + locations: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + employeeNumber: "EMP001", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + firstName: "John", + lastName: "Doe", + preferredName: "Johnny", + displayFullName: "John Doe", + username: "johndoe", + workEmail: "john.doe@company.com", + personalEmail: "john.doe@personal.com", + mobilePhoneNumber: "+1234567890", + employments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + ssn: "123-45-6789", + gender: UnifiedHrisEmployeeOutputGender.Male, + ethnicity: Ethnicity.AmericanIndianOrAlaskaNative, + maritalStatus: MaritalStatus.HeadOfHousehold, + dateOfBirth: new Date("1990-01-01"), + startDate: new Date("2020-01-01"), + employmentStatus: EmploymentStatus.Active, + terminationDate: new Date("2025-01-01"), + avatarUrl: "https://example.com/avatar.jpg", + managerId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employee_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployerbenefitsrequest.md b/docs/models/operations/listhrisemployerbenefitsrequest.md index 4e275c4a..b2209057 100644 --- a/docs/models/operations/listhrisemployerbenefitsrequest.md +++ b/docs/models/operations/listhrisemployerbenefitsrequest.md @@ -1,5 +1,17 @@ # ListHrisEmployerBenefitsRequest +## Example Usage + +```typescript +import { ListHrisEmployerBenefitsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployerBenefitsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployerbenefitsresponse.md b/docs/models/operations/listhrisemployerbenefitsresponse.md index 62230e03..96dcf560 100644 --- a/docs/models/operations/listhrisemployerbenefitsresponse.md +++ b/docs/models/operations/listhrisemployerbenefitsresponse.md @@ -1,5 +1,34 @@ # ListHrisEmployerBenefitsResponse +## Example Usage + +```typescript +import { BenefitPlanType } from "@panora/sdk/models/components"; +import { ListHrisEmployerBenefitsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployerBenefitsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + benefitPlanType: BenefitPlanType.HealthSavings, + name: "Company Health Plan", + description: "Comprehensive health insurance coverage for employees", + deductionCode: "HEALTH-001", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemployerbenefitsresponsebody.md b/docs/models/operations/listhrisemployerbenefitsresponsebody.md index e7364ead..c7328b69 100644 --- a/docs/models/operations/listhrisemployerbenefitsresponsebody.md +++ b/docs/models/operations/listhrisemployerbenefitsresponsebody.md @@ -1,5 +1,32 @@ # ListHrisEmployerBenefitsResponseBody +## Example Usage + +```typescript +import { BenefitPlanType } from "@panora/sdk/models/components"; +import { ListHrisEmployerBenefitsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisEmployerBenefitsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + benefitPlanType: BenefitPlanType.Medical, + name: "Company Health Plan", + description: "Comprehensive health insurance coverage for employees", + deductionCode: "HEALTH-001", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "benefit_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemploymentsrequest.md b/docs/models/operations/listhrisemploymentsrequest.md index 9b88c627..a6bcc747 100644 --- a/docs/models/operations/listhrisemploymentsrequest.md +++ b/docs/models/operations/listhrisemploymentsrequest.md @@ -1,5 +1,17 @@ # ListHrisEmploymentsRequest +## Example Usage + +```typescript +import { ListHrisEmploymentsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisEmploymentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemploymentsresponse.md b/docs/models/operations/listhrisemploymentsresponse.md index 84666f28..85715ce8 100644 --- a/docs/models/operations/listhrisemploymentsresponse.md +++ b/docs/models/operations/listhrisemploymentsresponse.md @@ -1,5 +1,40 @@ # ListHrisEmploymentsResponse +## Example Usage + +```typescript +import { EmploymentType, FlsaStatus, PayCurrency, PayFrequency, PayPeriod } from "@panora/sdk/models/components"; +import { ListHrisEmploymentsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisEmploymentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + jobTitle: "Software Engineer", + payRate: 100000, + payPeriod: PayPeriod.Day, + payFrequency: PayFrequency.Weekly, + payCurrency: PayCurrency.Usd, + flsaStatus: FlsaStatus.Exempt, + effectiveDate: new Date("2023-01-01"), + employmentType: EmploymentType.FullTime, + payGroupId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employment_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisemploymentsresponsebody.md b/docs/models/operations/listhrisemploymentsresponsebody.md index 49bd3356..ab71b5eb 100644 --- a/docs/models/operations/listhrisemploymentsresponsebody.md +++ b/docs/models/operations/listhrisemploymentsresponsebody.md @@ -1,5 +1,38 @@ # ListHrisEmploymentsResponseBody +## Example Usage + +```typescript +import { EmploymentType, FlsaStatus, PayCurrency, PayFrequency, PayPeriod } from "@panora/sdk/models/components"; +import { ListHrisEmploymentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisEmploymentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + jobTitle: "Software Engineer", + payRate: 100000, + payPeriod: PayPeriod.EveryTwoWeeks, + payFrequency: PayFrequency.Weekly, + payCurrency: PayCurrency.Usd, + flsaStatus: FlsaStatus.Exempt, + effectiveDate: new Date("2023-01-01"), + employmentType: EmploymentType.FullTime, + payGroupId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "employment_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrisgroupsrequest.md b/docs/models/operations/listhrisgroupsrequest.md index bed31294..587a95f4 100644 --- a/docs/models/operations/listhrisgroupsrequest.md +++ b/docs/models/operations/listhrisgroupsrequest.md @@ -1,5 +1,17 @@ # ListHrisGroupsRequest +## Example Usage + +```typescript +import { ListHrisGroupsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisGroupsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrisgroupsresponse.md b/docs/models/operations/listhrisgroupsresponse.md index 91708eff..fc1b3fa1 100644 --- a/docs/models/operations/listhrisgroupsresponse.md +++ b/docs/models/operations/listhrisgroupsresponse.md @@ -1,5 +1,33 @@ # ListHrisGroupsResponse +## Example Usage + +```typescript +import { UnifiedHrisGroupOutputType } from "@panora/sdk/models/components"; +import { ListHrisGroupsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisGroupsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + parentGroup: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + name: "Engineering Team", + type: UnifiedHrisGroupOutputType.Department, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "group_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrisgroupsresponsebody.md b/docs/models/operations/listhrisgroupsresponsebody.md index 720cb854..d0b6a63d 100644 --- a/docs/models/operations/listhrisgroupsresponsebody.md +++ b/docs/models/operations/listhrisgroupsresponsebody.md @@ -1,5 +1,31 @@ # ListHrisGroupsResponseBody +## Example Usage + +```typescript +import { UnifiedHrisGroupOutputType } from "@panora/sdk/models/components"; +import { ListHrisGroupsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisGroupsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + parentGroup: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + name: "Engineering Team", + type: UnifiedHrisGroupOutputType.Department, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "group_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrislocationsrequest.md b/docs/models/operations/listhrislocationsrequest.md index 564f9901..a5567f82 100644 --- a/docs/models/operations/listhrislocationsrequest.md +++ b/docs/models/operations/listhrislocationsrequest.md @@ -1,5 +1,17 @@ # ListHrisLocationsRequest +## Example Usage + +```typescript +import { ListHrisLocationsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisLocationsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrislocationsresponse.md b/docs/models/operations/listhrislocationsresponse.md index 5c4f5a50..bfd2c36a 100644 --- a/docs/models/operations/listhrislocationsresponse.md +++ b/docs/models/operations/listhrislocationsresponse.md @@ -1,5 +1,41 @@ # ListHrisLocationsResponse +## Example Usage + +```typescript +import { LocationType } from "@panora/sdk/models/components"; +import { ListHrisLocationsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisLocationsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Headquarters", + phoneNumber: "+1234567890", + street1: "123 Main St", + street2: "Suite 456", + city: "San Francisco", + state: "CA", + zipCode: "94105", + country: "USA", + locationType: LocationType.Work, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "location_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrislocationsresponsebody.md b/docs/models/operations/listhrislocationsresponsebody.md index 3148a1ee..42d3e91d 100644 --- a/docs/models/operations/listhrislocationsresponsebody.md +++ b/docs/models/operations/listhrislocationsresponsebody.md @@ -1,5 +1,39 @@ # ListHrisLocationsResponseBody +## Example Usage + +```typescript +import { LocationType } from "@panora/sdk/models/components"; +import { ListHrisLocationsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisLocationsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Headquarters", + phoneNumber: "+1234567890", + street1: "123 Main St", + street2: "Suite 456", + city: "San Francisco", + state: "CA", + zipCode: "94105", + country: "USA", + locationType: LocationType.Work, + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "location_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrispaygroupsrequest.md b/docs/models/operations/listhrispaygroupsrequest.md index a5835110..d06f33b7 100644 --- a/docs/models/operations/listhrispaygroupsrequest.md +++ b/docs/models/operations/listhrispaygroupsrequest.md @@ -1,5 +1,17 @@ # ListHrisPaygroupsRequest +## Example Usage + +```typescript +import { ListHrisPaygroupsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisPaygroupsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrispaygroupsresponse.md b/docs/models/operations/listhrispaygroupsresponse.md index f7b857d2..3c426af2 100644 --- a/docs/models/operations/listhrispaygroupsresponse.md +++ b/docs/models/operations/listhrispaygroupsresponse.md @@ -1,5 +1,30 @@ # ListHrisPaygroupsResponse +## Example Usage + +```typescript +import { ListHrisPaygroupsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisPaygroupsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + payGroupName: "Monthly Salaried", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "paygroup_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrispaygroupsresponsebody.md b/docs/models/operations/listhrispaygroupsresponsebody.md index 05ce41f1..f4ae0507 100644 --- a/docs/models/operations/listhrispaygroupsresponsebody.md +++ b/docs/models/operations/listhrispaygroupsresponsebody.md @@ -1,5 +1,28 @@ # ListHrisPaygroupsResponseBody +## Example Usage + +```typescript +import { ListHrisPaygroupsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisPaygroupsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + payGroupName: "Monthly Salaried", + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "paygroup_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhrispayrollrunsrequest.md b/docs/models/operations/listhrispayrollrunsrequest.md index d49f84c5..0089c247 100644 --- a/docs/models/operations/listhrispayrollrunsrequest.md +++ b/docs/models/operations/listhrispayrollrunsrequest.md @@ -1,5 +1,17 @@ # ListHrisPayrollRunsRequest +## Example Usage + +```typescript +import { ListHrisPayrollRunsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisPayrollRunsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhrispayrollrunsresponse.md b/docs/models/operations/listhrispayrollrunsresponse.md index 76768885..977bcf1c 100644 --- a/docs/models/operations/listhrispayrollrunsresponse.md +++ b/docs/models/operations/listhrispayrollrunsresponse.md @@ -1,5 +1,36 @@ # ListHrisPayrollRunsResponse +## Example Usage + +```typescript +import { RunState, RunType } from "@panora/sdk/models/components"; +import { ListHrisPayrollRunsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisPayrollRunsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + runState: RunState.Paid, + runType: RunType.Regular, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-01-15T23:59:59Z"), + checkDate: new Date("2024-01-20T00:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + employeePayrollRuns: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhrispayrollrunsresponsebody.md b/docs/models/operations/listhrispayrollrunsresponsebody.md index cdba1eb4..5532a665 100644 --- a/docs/models/operations/listhrispayrollrunsresponsebody.md +++ b/docs/models/operations/listhrispayrollrunsresponsebody.md @@ -1,5 +1,34 @@ # ListHrisPayrollRunsResponseBody +## Example Usage + +```typescript +import { RunState, RunType } from "@panora/sdk/models/components"; +import { ListHrisPayrollRunsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisPayrollRunsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + runState: RunState.Paid, + runType: RunType.Regular, + startDate: new Date("2024-01-01T00:00:00Z"), + endDate: new Date("2024-01-15T23:59:59Z"), + checkDate: new Date("2024-01-20T00:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "payroll_run_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteWasDeleted: false, + employeePayrollRuns: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffbalancesrequest.md b/docs/models/operations/listhristimeoffbalancesrequest.md index c6e4d5c1..6c7431cc 100644 --- a/docs/models/operations/listhristimeoffbalancesrequest.md +++ b/docs/models/operations/listhristimeoffbalancesrequest.md @@ -1,5 +1,17 @@ # ListHrisTimeoffbalancesRequest +## Example Usage + +```typescript +import { ListHrisTimeoffbalancesRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffbalancesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffbalancesresponse.md b/docs/models/operations/listhristimeoffbalancesresponse.md index ba9399d1..34d8f5dc 100644 --- a/docs/models/operations/listhristimeoffbalancesresponse.md +++ b/docs/models/operations/listhristimeoffbalancesresponse.md @@ -1,5 +1,34 @@ # ListHrisTimeoffbalancesResponse +## Example Usage + +```typescript +import { PolicyType } from "@panora/sdk/models/components"; +import { ListHrisTimeoffbalancesResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffbalancesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + balance: 80, + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + used: 40, + policyType: PolicyType.Vacation, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_balance_1234", + remoteData: {}, + remoteCreatedAt: "2024-06-15T12:00:00Z", + createdAt: "2024-06-15T12:00:00Z", + modifiedAt: "2024-06-15T12:00:00Z", + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffbalancesresponsebody.md b/docs/models/operations/listhristimeoffbalancesresponsebody.md index 0bec6229..47a992a5 100644 --- a/docs/models/operations/listhristimeoffbalancesresponsebody.md +++ b/docs/models/operations/listhristimeoffbalancesresponsebody.md @@ -1,5 +1,32 @@ # ListHrisTimeoffbalancesResponseBody +## Example Usage + +```typescript +import { PolicyType } from "@panora/sdk/models/components"; +import { ListHrisTimeoffbalancesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffbalancesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + balance: 80, + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + used: 40, + policyType: PolicyType.Vacation, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_balance_1234", + remoteData: {}, + remoteCreatedAt: "2024-06-15T12:00:00Z", + createdAt: "2024-06-15T12:00:00Z", + modifiedAt: "2024-06-15T12:00:00Z", + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffsrequest.md b/docs/models/operations/listhristimeoffsrequest.md index 9dac1681..13a51abb 100644 --- a/docs/models/operations/listhristimeoffsrequest.md +++ b/docs/models/operations/listhristimeoffsrequest.md @@ -1,5 +1,17 @@ # ListHrisTimeoffsRequest +## Example Usage + +```typescript +import { ListHrisTimeoffsRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffsresponse.md b/docs/models/operations/listhristimeoffsresponse.md index d06f9927..7f3bf164 100644 --- a/docs/models/operations/listhristimeoffsresponse.md +++ b/docs/models/operations/listhristimeoffsresponse.md @@ -1,5 +1,39 @@ # ListHrisTimeoffsResponse +## Example Usage + +```typescript +import { RequestType, UnifiedHrisTimeoffOutputStatus, Units } from "@panora/sdk/models/components"; +import { ListHrisTimeoffsResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffOutputStatus.Requested, + employeeNote: "Annual vacation", + units: Units.Days, + amount: 5, + requestType: RequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteWasDeleted: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhristimeoffsresponsebody.md b/docs/models/operations/listhristimeoffsresponsebody.md index b6b8a393..a18c766a 100644 --- a/docs/models/operations/listhristimeoffsresponsebody.md +++ b/docs/models/operations/listhristimeoffsresponsebody.md @@ -1,5 +1,37 @@ # ListHrisTimeoffsResponseBody +## Example Usage + +```typescript +import { RequestType, UnifiedHrisTimeoffOutputStatus, Units } from "@panora/sdk/models/components"; +import { ListHrisTimeoffsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisTimeoffsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + employee: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + approver: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + status: UnifiedHrisTimeoffOutputStatus.Requested, + employeeNote: "Annual vacation", + units: Units.Days, + amount: 5, + requestType: RequestType.Vacation, + startTime: new Date("2024-07-01T09:00:00Z"), + endTime: new Date("2024-07-05T17:00:00Z"), + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "timeoff_1234", + remoteData: {}, + remoteCreatedAt: new Date("2024-06-15T12:00:00Z"), + createdAt: new Date("2024-06-15T12:00:00Z"), + modifiedAt: new Date("2024-06-15T12:00:00Z"), + remoteWasDeleted: false, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listhristimesheetentriesrequest.md b/docs/models/operations/listhristimesheetentriesrequest.md index 22073030..31383e7f 100644 --- a/docs/models/operations/listhristimesheetentriesrequest.md +++ b/docs/models/operations/listhristimesheetentriesrequest.md @@ -1,5 +1,17 @@ # ListHrisTimesheetentriesRequest +## Example Usage + +```typescript +import { ListHrisTimesheetentriesRequest } from "@panora/sdk/models/operations"; + +let value: ListHrisTimesheetentriesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listhristimesheetentriesresponse.md b/docs/models/operations/listhristimesheetentriesresponse.md index 9e2f5fb2..afbb5fe7 100644 --- a/docs/models/operations/listhristimesheetentriesresponse.md +++ b/docs/models/operations/listhristimesheetentriesresponse.md @@ -1,5 +1,33 @@ # ListHrisTimesheetentriesResponse +## Example Usage + +```typescript +import { ListHrisTimesheetentriesResponse } from "@panora/sdk/models/operations"; + +let value: ListHrisTimesheetentriesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteData: {}, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listhristimesheetentriesresponsebody.md b/docs/models/operations/listhristimesheetentriesresponsebody.md index 4d1016e3..975ba87c 100644 --- a/docs/models/operations/listhristimesheetentriesresponsebody.md +++ b/docs/models/operations/listhristimesheetentriesresponsebody.md @@ -1,5 +1,31 @@ # ListHrisTimesheetentriesResponseBody +## Example Usage + +```typescript +import { ListHrisTimesheetentriesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListHrisTimesheetentriesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + hoursWorked: 40, + startTime: new Date("2024-10-01T08:00:00Z"), + endTime: new Date("2024-10-01T16:00:00Z"), + employeeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteWasDeleted: false, + fieldMappings: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + remoteData: {}, + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationactionrequest.md b/docs/models/operations/listmarketingautomationactionrequest.md index 54275650..139815a2 100644 --- a/docs/models/operations/listmarketingautomationactionrequest.md +++ b/docs/models/operations/listmarketingautomationactionrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationActionRequest +## Example Usage + +```typescript +import { ListMarketingautomationActionRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationActionRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationactionresponse.md b/docs/models/operations/listmarketingautomationactionresponse.md index d510551e..95545ccf 100644 --- a/docs/models/operations/listmarketingautomationactionresponse.md +++ b/docs/models/operations/listmarketingautomationactionresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationActionResponse +## Example Usage + +```typescript +import { ListMarketingautomationActionResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationActionResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationactionresponsebody.md b/docs/models/operations/listmarketingautomationactionresponsebody.md index 8d1e9905..61e58842 100644 --- a/docs/models/operations/listmarketingautomationactionresponsebody.md +++ b/docs/models/operations/listmarketingautomationactionresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationActionResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationActionResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationActionResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationautomationsrequest.md b/docs/models/operations/listmarketingautomationautomationsrequest.md index 8a8d263e..70764538 100644 --- a/docs/models/operations/listmarketingautomationautomationsrequest.md +++ b/docs/models/operations/listmarketingautomationautomationsrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationAutomationsRequest +## Example Usage + +```typescript +import { ListMarketingautomationAutomationsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationAutomationsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationautomationsresponse.md b/docs/models/operations/listmarketingautomationautomationsresponse.md index 44157ba0..09c72523 100644 --- a/docs/models/operations/listmarketingautomationautomationsresponse.md +++ b/docs/models/operations/listmarketingautomationautomationsresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationAutomationsResponse +## Example Usage + +```typescript +import { ListMarketingautomationAutomationsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationAutomationsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationautomationsresponsebody.md b/docs/models/operations/listmarketingautomationautomationsresponsebody.md index a53fc465..7f5de2e9 100644 --- a/docs/models/operations/listmarketingautomationautomationsresponsebody.md +++ b/docs/models/operations/listmarketingautomationautomationsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationAutomationsResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationAutomationsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationAutomationsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcampaignsrequest.md b/docs/models/operations/listmarketingautomationcampaignsrequest.md index a4a77b0d..10bd2ef0 100644 --- a/docs/models/operations/listmarketingautomationcampaignsrequest.md +++ b/docs/models/operations/listmarketingautomationcampaignsrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationCampaignsRequest +## Example Usage + +```typescript +import { ListMarketingautomationCampaignsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationCampaignsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcampaignsresponse.md b/docs/models/operations/listmarketingautomationcampaignsresponse.md index a24206ba..6600bdfc 100644 --- a/docs/models/operations/listmarketingautomationcampaignsresponse.md +++ b/docs/models/operations/listmarketingautomationcampaignsresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationCampaignsResponse +## Example Usage + +```typescript +import { ListMarketingautomationCampaignsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationCampaignsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcampaignsresponsebody.md b/docs/models/operations/listmarketingautomationcampaignsresponsebody.md index 75d0d7c7..155b46a7 100644 --- a/docs/models/operations/listmarketingautomationcampaignsresponsebody.md +++ b/docs/models/operations/listmarketingautomationcampaignsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationCampaignsResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationCampaignsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationCampaignsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcontactsrequest.md b/docs/models/operations/listmarketingautomationcontactsrequest.md index 91541447..40b28a87 100644 --- a/docs/models/operations/listmarketingautomationcontactsrequest.md +++ b/docs/models/operations/listmarketingautomationcontactsrequest.md @@ -1,5 +1,17 @@ # ListMarketingAutomationContactsRequest +## Example Usage + +```typescript +import { ListMarketingAutomationContactsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationContactsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcontactsresponse.md b/docs/models/operations/listmarketingautomationcontactsresponse.md index e9752662..c338c9e1 100644 --- a/docs/models/operations/listmarketingautomationcontactsresponse.md +++ b/docs/models/operations/listmarketingautomationcontactsresponse.md @@ -1,5 +1,18 @@ # ListMarketingAutomationContactsResponse +## Example Usage + +```typescript +import { ListMarketingAutomationContactsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationContactsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationcontactsresponsebody.md b/docs/models/operations/listmarketingautomationcontactsresponsebody.md index c144d9b0..d9746b6d 100644 --- a/docs/models/operations/listmarketingautomationcontactsresponsebody.md +++ b/docs/models/operations/listmarketingautomationcontactsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingAutomationContactsResponseBody +## Example Usage + +```typescript +import { ListMarketingAutomationContactsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationContactsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationemailsrequest.md b/docs/models/operations/listmarketingautomationemailsrequest.md index 2728a987..294d3eab 100644 --- a/docs/models/operations/listmarketingautomationemailsrequest.md +++ b/docs/models/operations/listmarketingautomationemailsrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationEmailsRequest +## Example Usage + +```typescript +import { ListMarketingautomationEmailsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationEmailsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationemailsresponse.md b/docs/models/operations/listmarketingautomationemailsresponse.md index 2794bcb6..1b7ef4b0 100644 --- a/docs/models/operations/listmarketingautomationemailsresponse.md +++ b/docs/models/operations/listmarketingautomationemailsresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationEmailsResponse +## Example Usage + +```typescript +import { ListMarketingautomationEmailsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationEmailsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationemailsresponsebody.md b/docs/models/operations/listmarketingautomationemailsresponsebody.md index f4d147b3..7b6d38ea 100644 --- a/docs/models/operations/listmarketingautomationemailsresponsebody.md +++ b/docs/models/operations/listmarketingautomationemailsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationEmailsResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationEmailsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationEmailsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationeventsrequest.md b/docs/models/operations/listmarketingautomationeventsrequest.md index 134a4cb0..000c0833 100644 --- a/docs/models/operations/listmarketingautomationeventsrequest.md +++ b/docs/models/operations/listmarketingautomationeventsrequest.md @@ -1,5 +1,17 @@ # ListMarketingAutomationEventsRequest +## Example Usage + +```typescript +import { ListMarketingAutomationEventsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationEventsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationeventsresponse.md b/docs/models/operations/listmarketingautomationeventsresponse.md index c16d2fcd..d1893616 100644 --- a/docs/models/operations/listmarketingautomationeventsresponse.md +++ b/docs/models/operations/listmarketingautomationeventsresponse.md @@ -1,5 +1,18 @@ # ListMarketingAutomationEventsResponse +## Example Usage + +```typescript +import { ListMarketingAutomationEventsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationEventsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationeventsresponsebody.md b/docs/models/operations/listmarketingautomationeventsresponsebody.md index 2cce89e0..0731255a 100644 --- a/docs/models/operations/listmarketingautomationeventsresponsebody.md +++ b/docs/models/operations/listmarketingautomationeventsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingAutomationEventsResponseBody +## Example Usage + +```typescript +import { ListMarketingAutomationEventsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationEventsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationlistsrequest.md b/docs/models/operations/listmarketingautomationlistsrequest.md index f3420c8e..0eb4e7b7 100644 --- a/docs/models/operations/listmarketingautomationlistsrequest.md +++ b/docs/models/operations/listmarketingautomationlistsrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationListsRequest +## Example Usage + +```typescript +import { ListMarketingautomationListsRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationListsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationlistsresponse.md b/docs/models/operations/listmarketingautomationlistsresponse.md index b8b55fe5..d8d424d9 100644 --- a/docs/models/operations/listmarketingautomationlistsresponse.md +++ b/docs/models/operations/listmarketingautomationlistsresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationListsResponse +## Example Usage + +```typescript +import { ListMarketingautomationListsResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationListsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationlistsresponsebody.md b/docs/models/operations/listmarketingautomationlistsresponsebody.md index 28d02d64..1b50f571 100644 --- a/docs/models/operations/listmarketingautomationlistsresponsebody.md +++ b/docs/models/operations/listmarketingautomationlistsresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationListsResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationListsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationListsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationmessagesrequest.md b/docs/models/operations/listmarketingautomationmessagesrequest.md index e873ecec..ad1d2ce1 100644 --- a/docs/models/operations/listmarketingautomationmessagesrequest.md +++ b/docs/models/operations/listmarketingautomationmessagesrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationMessagesRequest +## Example Usage + +```typescript +import { ListMarketingautomationMessagesRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationMessagesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationmessagesresponse.md b/docs/models/operations/listmarketingautomationmessagesresponse.md index 4aefd054..bfb24680 100644 --- a/docs/models/operations/listmarketingautomationmessagesresponse.md +++ b/docs/models/operations/listmarketingautomationmessagesresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationMessagesResponse +## Example Usage + +```typescript +import { ListMarketingautomationMessagesResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationMessagesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationmessagesresponsebody.md b/docs/models/operations/listmarketingautomationmessagesresponsebody.md index 8cd4d901..b4c5d08a 100644 --- a/docs/models/operations/listmarketingautomationmessagesresponsebody.md +++ b/docs/models/operations/listmarketingautomationmessagesresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationMessagesResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationMessagesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationMessagesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationtemplatesrequest.md b/docs/models/operations/listmarketingautomationtemplatesrequest.md index b51b2cbc..1ef1c090 100644 --- a/docs/models/operations/listmarketingautomationtemplatesrequest.md +++ b/docs/models/operations/listmarketingautomationtemplatesrequest.md @@ -1,5 +1,17 @@ # ListMarketingautomationTemplatesRequest +## Example Usage + +```typescript +import { ListMarketingautomationTemplatesRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationTemplatesRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationtemplatesresponse.md b/docs/models/operations/listmarketingautomationtemplatesresponse.md index 6d044f26..1e5dbb80 100644 --- a/docs/models/operations/listmarketingautomationtemplatesresponse.md +++ b/docs/models/operations/listmarketingautomationtemplatesresponse.md @@ -1,5 +1,18 @@ # ListMarketingautomationTemplatesResponse +## Example Usage + +```typescript +import { ListMarketingautomationTemplatesResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationTemplatesResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationtemplatesresponsebody.md b/docs/models/operations/listmarketingautomationtemplatesresponsebody.md index f09b4d8e..d5c5b82d 100644 --- a/docs/models/operations/listmarketingautomationtemplatesresponsebody.md +++ b/docs/models/operations/listmarketingautomationtemplatesresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingautomationTemplatesResponseBody +## Example Usage + +```typescript +import { ListMarketingautomationTemplatesResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingautomationTemplatesResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationusersrequest.md b/docs/models/operations/listmarketingautomationusersrequest.md index 3deccd22..b5f7b201 100644 --- a/docs/models/operations/listmarketingautomationusersrequest.md +++ b/docs/models/operations/listmarketingautomationusersrequest.md @@ -1,5 +1,17 @@ # ListMarketingAutomationUsersRequest +## Example Usage + +```typescript +import { ListMarketingAutomationUsersRequest } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationUsersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationusersresponse.md b/docs/models/operations/listmarketingautomationusersresponse.md index c5b5db33..8f1e9c74 100644 --- a/docs/models/operations/listmarketingautomationusersresponse.md +++ b/docs/models/operations/listmarketingautomationusersresponse.md @@ -1,5 +1,18 @@ # ListMarketingAutomationUsersResponse +## Example Usage + +```typescript +import { ListMarketingAutomationUsersResponse } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationUsersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [{}], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listmarketingautomationusersresponsebody.md b/docs/models/operations/listmarketingautomationusersresponsebody.md index a8918c88..e1aa8bb0 100644 --- a/docs/models/operations/listmarketingautomationusersresponsebody.md +++ b/docs/models/operations/listmarketingautomationusersresponsebody.md @@ -1,5 +1,16 @@ # ListMarketingAutomationUsersResponseBody +## Example Usage + +```typescript +import { ListMarketingAutomationUsersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListMarketingAutomationUsersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [{}], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingaccountrequest.md b/docs/models/operations/listticketingaccountrequest.md index 13f8c382..02daa385 100644 --- a/docs/models/operations/listticketingaccountrequest.md +++ b/docs/models/operations/listticketingaccountrequest.md @@ -1,5 +1,17 @@ # ListTicketingAccountRequest +## Example Usage + +```typescript +import { ListTicketingAccountRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingAccountRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingaccountresponse.md b/docs/models/operations/listticketingaccountresponse.md index 0c4ca5f1..19b40fbc 100644 --- a/docs/models/operations/listticketingaccountresponse.md +++ b/docs/models/operations/listticketingaccountresponse.md @@ -1,5 +1,35 @@ # ListTicketingAccountResponse +## Example Usage + +```typescript +import { ListTicketingAccountResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingAccountResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My Personal Account", + domains: ["acme.com", "acme-test.com"], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingaccountresponsebody.md b/docs/models/operations/listticketingaccountresponsebody.md index 45235ffe..14297942 100644 --- a/docs/models/operations/listticketingaccountresponsebody.md +++ b/docs/models/operations/listticketingaccountresponsebody.md @@ -1,5 +1,33 @@ # ListTicketingAccountResponseBody +## Example Usage + +```typescript +import { ListTicketingAccountResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingAccountResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My Personal Account", + domains: ["acme.com", "acme-test.com"], + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingattachmentsrequest.md b/docs/models/operations/listticketingattachmentsrequest.md index 3735805c..edd0318b 100644 --- a/docs/models/operations/listticketingattachmentsrequest.md +++ b/docs/models/operations/listticketingattachmentsrequest.md @@ -1,5 +1,17 @@ # ListTicketingAttachmentsRequest +## Example Usage + +```typescript +import { ListTicketingAttachmentsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingAttachmentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingattachmentsresponse.md b/docs/models/operations/listticketingattachmentsresponse.md index 95134a4e..84e06c57 100644 --- a/docs/models/operations/listticketingattachmentsresponse.md +++ b/docs/models/operations/listticketingattachmentsresponse.md @@ -1,5 +1,38 @@ # ListTicketingAttachmentsResponse +## Example Usage + +```typescript +import { ListTicketingAttachmentsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingAttachmentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + 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: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingattachmentsresponsebody.md b/docs/models/operations/listticketingattachmentsresponsebody.md index e849952c..c69e8ea4 100644 --- a/docs/models/operations/listticketingattachmentsresponsebody.md +++ b/docs/models/operations/listticketingattachmentsresponsebody.md @@ -1,5 +1,36 @@ # ListTicketingAttachmentsResponseBody +## Example Usage + +```typescript +import { ListTicketingAttachmentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingAttachmentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + 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: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcollectionsrequest.md b/docs/models/operations/listticketingcollectionsrequest.md index 1d8ec268..c6ae7aa3 100644 --- a/docs/models/operations/listticketingcollectionsrequest.md +++ b/docs/models/operations/listticketingcollectionsrequest.md @@ -1,5 +1,17 @@ # ListTicketingCollectionsRequest +## Example Usage + +```typescript +import { ListTicketingCollectionsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingCollectionsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcollectionsresponse.md b/docs/models/operations/listticketingcollectionsresponse.md index 609d69ea..dac09ee5 100644 --- a/docs/models/operations/listticketingcollectionsresponse.md +++ b/docs/models/operations/listticketingcollectionsresponse.md @@ -1,5 +1,33 @@ # ListTicketingCollectionsResponse +## Example Usage + +```typescript +import { CollectionType } from "@panora/sdk/models/components"; +import { ListTicketingCollectionsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingCollectionsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My Personal Collection", + description: "Collect issues", + collectionType: CollectionType.Project, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcollectionsresponsebody.md b/docs/models/operations/listticketingcollectionsresponsebody.md index f0e17af7..b3b146a3 100644 --- a/docs/models/operations/listticketingcollectionsresponsebody.md +++ b/docs/models/operations/listticketingcollectionsresponsebody.md @@ -1,5 +1,31 @@ # ListTicketingCollectionsResponseBody +## Example Usage + +```typescript +import { CollectionType } from "@panora/sdk/models/components"; +import { ListTicketingCollectionsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingCollectionsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My Personal Collection", + description: "Collect issues", + collectionType: CollectionType.Project, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcommentsrequest.md b/docs/models/operations/listticketingcommentsrequest.md index 1439a392..5f7edced 100644 --- a/docs/models/operations/listticketingcommentsrequest.md +++ b/docs/models/operations/listticketingcommentsrequest.md @@ -1,5 +1,17 @@ # ListTicketingCommentsRequest +## Example Usage + +```typescript +import { ListTicketingCommentsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingCommentsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcommentsresponse.md b/docs/models/operations/listticketingcommentsresponse.md index dac3a082..ef209dd9 100644 --- a/docs/models/operations/listticketingcommentsresponse.md +++ b/docs/models/operations/listticketingcommentsresponse.md @@ -1,5 +1,38 @@ # ListTicketingCommentsResponse +## Example Usage + +```typescript +import { CreatorType } from "@panora/sdk/models/components"; +import { ListTicketingCommentsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingCommentsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: CreatorType.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"], + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcommentsresponsebody.md b/docs/models/operations/listticketingcommentsresponsebody.md index 7254989b..a4f36945 100644 --- a/docs/models/operations/listticketingcommentsresponsebody.md +++ b/docs/models/operations/listticketingcommentsresponsebody.md @@ -1,5 +1,36 @@ # ListTicketingCommentsResponseBody +## Example Usage + +```typescript +import { CreatorType } from "@panora/sdk/models/components"; +import { ListTicketingCommentsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingCommentsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: CreatorType.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"], + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcontactsrequest.md b/docs/models/operations/listticketingcontactsrequest.md index c0ab8ba3..bd14af05 100644 --- a/docs/models/operations/listticketingcontactsrequest.md +++ b/docs/models/operations/listticketingcontactsrequest.md @@ -1,5 +1,17 @@ # ListTicketingContactsRequest +## Example Usage + +```typescript +import { ListTicketingContactsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingContactsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcontactsresponse.md b/docs/models/operations/listticketingcontactsresponse.md index b90a9568..7206d49f 100644 --- a/docs/models/operations/listticketingcontactsresponse.md +++ b/docs/models/operations/listticketingcontactsresponse.md @@ -1,5 +1,37 @@ # ListTicketingContactsResponse +## Example Usage + +```typescript +import { ListTicketingContactsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingContactsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Joe", + emailAddress: "joedoe@acme.org", + phoneNumber: "+33 6 50 11 11 10", + details: "Contact Details", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingcontactsresponsebody.md b/docs/models/operations/listticketingcontactsresponsebody.md index d46af9d2..ff49a2aa 100644 --- a/docs/models/operations/listticketingcontactsresponsebody.md +++ b/docs/models/operations/listticketingcontactsresponsebody.md @@ -1,5 +1,35 @@ # ListTicketingContactsResponseBody +## Example Usage + +```typescript +import { ListTicketingContactsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingContactsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Joe", + emailAddress: "joedoe@acme.org", + phoneNumber: "+33 6 50 11 11 10", + details: "Contact Details", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingtagsrequest.md b/docs/models/operations/listticketingtagsrequest.md index 60f6ed66..f66af72b 100644 --- a/docs/models/operations/listticketingtagsrequest.md +++ b/docs/models/operations/listticketingtagsrequest.md @@ -1,5 +1,17 @@ # ListTicketingTagsRequest +## Example Usage + +```typescript +import { ListTicketingTagsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingTagsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingtagsresponse.md b/docs/models/operations/listticketingtagsresponse.md index 4ac739db..15afbc98 100644 --- a/docs/models/operations/listticketingtagsresponse.md +++ b/docs/models/operations/listticketingtagsresponse.md @@ -1,5 +1,34 @@ # ListTicketingTagsResponse +## Example Usage + +```typescript +import { ListTicketingTagsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingTagsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "urgent_tag", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingtagsresponsebody.md b/docs/models/operations/listticketingtagsresponsebody.md index 60e8a309..7a43a5d0 100644 --- a/docs/models/operations/listticketingtagsresponsebody.md +++ b/docs/models/operations/listticketingtagsresponsebody.md @@ -1,5 +1,32 @@ # ListTicketingTagsResponseBody +## Example Usage + +```typescript +import { ListTicketingTagsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingTagsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "urgent_tag", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingteamsrequest.md b/docs/models/operations/listticketingteamsrequest.md index 09c1451f..b44622e7 100644 --- a/docs/models/operations/listticketingteamsrequest.md +++ b/docs/models/operations/listticketingteamsrequest.md @@ -1,5 +1,17 @@ # ListTicketingTeamsRequest +## Example Usage + +```typescript +import { ListTicketingTeamsRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingTeamsRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingteamsresponse.md b/docs/models/operations/listticketingteamsresponse.md index 8ffb8b3e..fdf5ead1 100644 --- a/docs/models/operations/listticketingteamsresponse.md +++ b/docs/models/operations/listticketingteamsresponse.md @@ -1,5 +1,35 @@ # ListTicketingTeamsResponse +## Example Usage + +```typescript +import { ListTicketingTeamsResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingTeamsResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My team", + description: "Internal members", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingteamsresponsebody.md b/docs/models/operations/listticketingteamsresponsebody.md index a6d7add5..22a154a6 100644 --- a/docs/models/operations/listticketingteamsresponsebody.md +++ b/docs/models/operations/listticketingteamsresponsebody.md @@ -1,5 +1,33 @@ # ListTicketingTeamsResponseBody +## Example Usage + +```typescript +import { ListTicketingTeamsResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingTeamsResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "My team", + description: "Internal members", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingticketrequest.md b/docs/models/operations/listticketingticketrequest.md index e7fea042..b89bfcdd 100644 --- a/docs/models/operations/listticketingticketrequest.md +++ b/docs/models/operations/listticketingticketrequest.md @@ -1,5 +1,17 @@ # ListTicketingTicketRequest +## Example Usage + +```typescript +import { ListTicketingTicketRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingTicketRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingticketresponse.md b/docs/models/operations/listticketingticketresponse.md index 22b14035..068e56b6 100644 --- a/docs/models/operations/listticketingticketresponse.md +++ b/docs/models/operations/listticketingticketresponse.md @@ -1,5 +1,59 @@ # ListTicketingTicketResponse +## Example Usage + +```typescript +import { Priority, Status, Type, UnifiedTicketingTicketOutputCreatorType } from "@panora/sdk/models/components"; +import { ListTicketingTicketResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingTicketResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Customer Service Inquiry", + status: Status.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: Type.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: Priority.High, + assignedTo: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketOutputCreatorType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingticketresponsebody.md b/docs/models/operations/listticketingticketresponsebody.md index af0aed31..5f7c60c1 100644 --- a/docs/models/operations/listticketingticketresponsebody.md +++ b/docs/models/operations/listticketingticketresponsebody.md @@ -1,5 +1,57 @@ # ListTicketingTicketResponseBody +## Example Usage + +```typescript +import { Priority, Status, Type, UnifiedTicketingTicketOutputCreatorType } from "@panora/sdk/models/components"; +import { ListTicketingTicketResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingTicketResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Customer Service Inquiry", + status: Status.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: Type.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: Priority.High, + assignedTo: ["801f9ede-c698-4e66-a7fc-48d19eebaa4f"], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketOutputCreatorType.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", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/listticketingusersrequest.md b/docs/models/operations/listticketingusersrequest.md index c92c4670..041e5f84 100644 --- a/docs/models/operations/listticketingusersrequest.md +++ b/docs/models/operations/listticketingusersrequest.md @@ -1,5 +1,17 @@ # ListTicketingUsersRequest +## Example Usage + +```typescript +import { ListTicketingUsersRequest } from "@panora/sdk/models/operations"; + +let value: ListTicketingUsersRequest = { + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", +}; +``` ## Fields diff --git a/docs/models/operations/listticketingusersresponse.md b/docs/models/operations/listticketingusersresponse.md index a47148da..f1829889 100644 --- a/docs/models/operations/listticketingusersresponse.md +++ b/docs/models/operations/listticketingusersresponse.md @@ -1,5 +1,38 @@ # ListTicketingUsersResponse +## Example Usage + +```typescript +import { ListTicketingUsersResponse } from "@panora/sdk/models/operations"; + +let value: ListTicketingUsersResponse = { + result: { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "John Doe", + emailAddress: "john.doe@example.com", + teams: ["team1", "team2"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], + }, +}; +``` ## Fields diff --git a/docs/models/operations/listticketingusersresponsebody.md b/docs/models/operations/listticketingusersresponsebody.md index 098b995a..2c5d5a4e 100644 --- a/docs/models/operations/listticketingusersresponsebody.md +++ b/docs/models/operations/listticketingusersresponsebody.md @@ -1,5 +1,36 @@ # ListTicketingUsersResponseBody +## Example Usage + +```typescript +import { ListTicketingUsersResponseBody } from "@panora/sdk/models/operations"; + +let value: ListTicketingUsersResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "John Doe", + emailAddress: "john.doe@example.com", + teams: ["team1", "team2"], + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + key1: "value1", + key2: 42, + key3: true, + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2023-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/remoteidrequest.md b/docs/models/operations/remoteidrequest.md index bf31a87b..2c76dda9 100644 --- a/docs/models/operations/remoteidrequest.md +++ b/docs/models/operations/remoteidrequest.md @@ -1,5 +1,14 @@ # RemoteIdRequest +## Example Usage + +```typescript +import { RemoteIdRequest } from "@panora/sdk/models/operations"; + +let value: RemoteIdRequest = { + remoteId: "id_1", +}; +``` ## Fields diff --git a/docs/models/operations/requestpassthroughresponsebody.md b/docs/models/operations/requestpassthroughresponsebody.md new file mode 100644 index 00000000..9de16f50 --- /dev/null +++ b/docs/models/operations/requestpassthroughresponsebody.md @@ -0,0 +1,14 @@ +# RequestPassthroughResponseBody + +## Example Usage + +```typescript +import { RequestPassthroughResponseBody } from "@panora/sdk/models/operations"; + +let value: RequestPassthroughResponseBody = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/requestrequest.md b/docs/models/operations/requestrequest.md index c7b732f3..24c8be04 100644 --- a/docs/models/operations/requestrequest.md +++ b/docs/models/operations/requestrequest.md @@ -1,5 +1,19 @@ # RequestRequest +## Example Usage + +```typescript +import { PassThroughRequestDtoMethod } from "@panora/sdk/models/components"; +import { RequestRequest } from "@panora/sdk/models/operations"; + +let value: RequestRequest = { + xConnectionToken: "", + passThroughRequestDto: { + method: PassThroughRequestDtoMethod.Get, + path: "/boot/defaults", + }, +}; +``` ## Fields diff --git a/docs/models/operations/requestresponse.md b/docs/models/operations/requestresponse.md new file mode 100644 index 00000000..342c217a --- /dev/null +++ b/docs/models/operations/requestresponse.md @@ -0,0 +1,24 @@ +# RequestResponse + +## Example Usage + +```typescript +import { RequestResponse } from "@panora/sdk/models/operations"; + +let value: RequestResponse = {}; +``` + +## Supported Types + +### `operations.RequestResponseBody` + +```typescript +const value: operations.RequestResponseBody = /* values here */ +``` + +### `operations.RequestPassthroughResponseBody` + +```typescript +const value: operations.RequestPassthroughResponseBody = /* values here */ +``` + diff --git a/docs/models/operations/requestresponsebody.md b/docs/models/operations/requestresponsebody.md index ae89bacf..072342ae 100644 --- a/docs/models/operations/requestresponsebody.md +++ b/docs/models/operations/requestresponsebody.md @@ -1,5 +1,12 @@ # RequestResponseBody +## Example Usage + +```typescript +import { RequestResponseBody } from "@panora/sdk/models/operations"; + +let value: RequestResponseBody = {}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingaccountrequest.md b/docs/models/operations/retrieveaccountingaccountrequest.md index 0bc867e3..38841e52 100644 --- a/docs/models/operations/retrieveaccountingaccountrequest.md +++ b/docs/models/operations/retrieveaccountingaccountrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingAccountRequest +## Example Usage + +```typescript +import { RetrieveAccountingAccountRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingAccountRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingaddressrequest.md b/docs/models/operations/retrieveaccountingaddressrequest.md index 99ecde01..bcb02cbd 100644 --- a/docs/models/operations/retrieveaccountingaddressrequest.md +++ b/docs/models/operations/retrieveaccountingaddressrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingAddressRequest +## Example Usage + +```typescript +import { RetrieveAccountingAddressRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingAddressRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingattachmentrequest.md b/docs/models/operations/retrieveaccountingattachmentrequest.md index fdbc7e2b..e0198f32 100644 --- a/docs/models/operations/retrieveaccountingattachmentrequest.md +++ b/docs/models/operations/retrieveaccountingattachmentrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingAttachmentRequest +## Example Usage + +```typescript +import { RetrieveAccountingAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingAttachmentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingbalancesheetrequest.md b/docs/models/operations/retrieveaccountingbalancesheetrequest.md index e856aedc..6e918fc0 100644 --- a/docs/models/operations/retrieveaccountingbalancesheetrequest.md +++ b/docs/models/operations/retrieveaccountingbalancesheetrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingBalanceSheetRequest +## Example Usage + +```typescript +import { RetrieveAccountingBalanceSheetRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingBalanceSheetRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingcashflowstatementrequest.md b/docs/models/operations/retrieveaccountingcashflowstatementrequest.md index 31b99b62..80e81f82 100644 --- a/docs/models/operations/retrieveaccountingcashflowstatementrequest.md +++ b/docs/models/operations/retrieveaccountingcashflowstatementrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingCashflowStatementRequest +## Example Usage + +```typescript +import { RetrieveAccountingCashflowStatementRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingCashflowStatementRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingcompanyinforequest.md b/docs/models/operations/retrieveaccountingcompanyinforequest.md index c9290119..e71c65ed 100644 --- a/docs/models/operations/retrieveaccountingcompanyinforequest.md +++ b/docs/models/operations/retrieveaccountingcompanyinforequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingCompanyInfoRequest +## Example Usage + +```typescript +import { RetrieveAccountingCompanyInfoRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingCompanyInfoRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingcontactrequest.md b/docs/models/operations/retrieveaccountingcontactrequest.md index ed5566bc..46fa172a 100644 --- a/docs/models/operations/retrieveaccountingcontactrequest.md +++ b/docs/models/operations/retrieveaccountingcontactrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingContactRequest +## Example Usage + +```typescript +import { RetrieveAccountingContactRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingContactRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingcreditnoterequest.md b/docs/models/operations/retrieveaccountingcreditnoterequest.md index 3bfeb9cc..b062b87b 100644 --- a/docs/models/operations/retrieveaccountingcreditnoterequest.md +++ b/docs/models/operations/retrieveaccountingcreditnoterequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingCreditNoteRequest +## Example Usage + +```typescript +import { RetrieveAccountingCreditNoteRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingCreditNoteRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingexpenserequest.md b/docs/models/operations/retrieveaccountingexpenserequest.md index c512b100..9b50d047 100644 --- a/docs/models/operations/retrieveaccountingexpenserequest.md +++ b/docs/models/operations/retrieveaccountingexpenserequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingExpenseRequest +## Example Usage + +```typescript +import { RetrieveAccountingExpenseRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingExpenseRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingincomestatementrequest.md b/docs/models/operations/retrieveaccountingincomestatementrequest.md index 66c20735..d956d21c 100644 --- a/docs/models/operations/retrieveaccountingincomestatementrequest.md +++ b/docs/models/operations/retrieveaccountingincomestatementrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingIncomeStatementRequest +## Example Usage + +```typescript +import { RetrieveAccountingIncomeStatementRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingIncomeStatementRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountinginvoicerequest.md b/docs/models/operations/retrieveaccountinginvoicerequest.md index 2d47cf38..6f70f969 100644 --- a/docs/models/operations/retrieveaccountinginvoicerequest.md +++ b/docs/models/operations/retrieveaccountinginvoicerequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingInvoiceRequest +## Example Usage + +```typescript +import { RetrieveAccountingInvoiceRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingInvoiceRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingitemrequest.md b/docs/models/operations/retrieveaccountingitemrequest.md index c85c55e0..ca30ee17 100644 --- a/docs/models/operations/retrieveaccountingitemrequest.md +++ b/docs/models/operations/retrieveaccountingitemrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingItemRequest +## Example Usage + +```typescript +import { RetrieveAccountingItemRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingItemRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingjournalentryrequest.md b/docs/models/operations/retrieveaccountingjournalentryrequest.md index f15b4824..dfe95cdf 100644 --- a/docs/models/operations/retrieveaccountingjournalentryrequest.md +++ b/docs/models/operations/retrieveaccountingjournalentryrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingJournalEntryRequest +## Example Usage + +```typescript +import { RetrieveAccountingJournalEntryRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingJournalEntryRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingpaymentrequest.md b/docs/models/operations/retrieveaccountingpaymentrequest.md index 5dd821ec..7d7ce807 100644 --- a/docs/models/operations/retrieveaccountingpaymentrequest.md +++ b/docs/models/operations/retrieveaccountingpaymentrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingPaymentRequest +## Example Usage + +```typescript +import { RetrieveAccountingPaymentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingPaymentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingphonenumberrequest.md b/docs/models/operations/retrieveaccountingphonenumberrequest.md index 02121ffe..2011f305 100644 --- a/docs/models/operations/retrieveaccountingphonenumberrequest.md +++ b/docs/models/operations/retrieveaccountingphonenumberrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingPhonenumberRequest +## Example Usage + +```typescript +import { RetrieveAccountingPhonenumberRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingPhonenumberRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingpurchaseorderrequest.md b/docs/models/operations/retrieveaccountingpurchaseorderrequest.md index d459a637..de421f47 100644 --- a/docs/models/operations/retrieveaccountingpurchaseorderrequest.md +++ b/docs/models/operations/retrieveaccountingpurchaseorderrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingPurchaseOrderRequest +## Example Usage + +```typescript +import { RetrieveAccountingPurchaseOrderRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingPurchaseOrderRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingtaxraterequest.md b/docs/models/operations/retrieveaccountingtaxraterequest.md index ab2da52b..bfc0e95d 100644 --- a/docs/models/operations/retrieveaccountingtaxraterequest.md +++ b/docs/models/operations/retrieveaccountingtaxraterequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingTaxRateRequest +## Example Usage + +```typescript +import { RetrieveAccountingTaxRateRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingTaxRateRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md b/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md index 8dee02c4..936a2339 100644 --- a/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md +++ b/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingTrackingCategoryRequest +## Example Usage + +```typescript +import { RetrieveAccountingTrackingCategoryRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingTrackingCategoryRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingtransactionrequest.md b/docs/models/operations/retrieveaccountingtransactionrequest.md index 4a482b8b..fc23791d 100644 --- a/docs/models/operations/retrieveaccountingtransactionrequest.md +++ b/docs/models/operations/retrieveaccountingtransactionrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingTransactionRequest +## Example Usage + +```typescript +import { RetrieveAccountingTransactionRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingTransactionRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveaccountingvendorcreditrequest.md b/docs/models/operations/retrieveaccountingvendorcreditrequest.md index bfea768c..f13fc93f 100644 --- a/docs/models/operations/retrieveaccountingvendorcreditrequest.md +++ b/docs/models/operations/retrieveaccountingvendorcreditrequest.md @@ -1,5 +1,16 @@ # RetrieveAccountingVendorCreditRequest +## Example Usage + +```typescript +import { RetrieveAccountingVendorCreditRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAccountingVendorCreditRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsactivityrequest.md b/docs/models/operations/retrieveatsactivityrequest.md index fc68522c..9a170097 100644 --- a/docs/models/operations/retrieveatsactivityrequest.md +++ b/docs/models/operations/retrieveatsactivityrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsActivityRequest +## Example Usage + +```typescript +import { RetrieveAtsActivityRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsActivityRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsapplicationrequest.md b/docs/models/operations/retrieveatsapplicationrequest.md index e9074fc3..11fcc28e 100644 --- a/docs/models/operations/retrieveatsapplicationrequest.md +++ b/docs/models/operations/retrieveatsapplicationrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsApplicationRequest +## Example Usage + +```typescript +import { RetrieveAtsApplicationRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsApplicationRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsattachmentrequest.md b/docs/models/operations/retrieveatsattachmentrequest.md index dfcf17ae..9242273d 100644 --- a/docs/models/operations/retrieveatsattachmentrequest.md +++ b/docs/models/operations/retrieveatsattachmentrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsAttachmentRequest +## Example Usage + +```typescript +import { RetrieveAtsAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsAttachmentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatscandidaterequest.md b/docs/models/operations/retrieveatscandidaterequest.md index e31b0e34..045e7cd9 100644 --- a/docs/models/operations/retrieveatscandidaterequest.md +++ b/docs/models/operations/retrieveatscandidaterequest.md @@ -1,5 +1,16 @@ # RetrieveAtsCandidateRequest +## Example Usage + +```typescript +import { RetrieveAtsCandidateRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsCandidateRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsdepartmentrequest.md b/docs/models/operations/retrieveatsdepartmentrequest.md index 8b4c0ae0..f098fbc0 100644 --- a/docs/models/operations/retrieveatsdepartmentrequest.md +++ b/docs/models/operations/retrieveatsdepartmentrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsDepartmentRequest +## Example Usage + +```typescript +import { RetrieveAtsDepartmentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsDepartmentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatseeocsrequest.md b/docs/models/operations/retrieveatseeocsrequest.md index 87cf3e7a..4a788e6e 100644 --- a/docs/models/operations/retrieveatseeocsrequest.md +++ b/docs/models/operations/retrieveatseeocsrequest.md @@ -1,5 +1,15 @@ # RetrieveAtsEeocsRequest +## Example Usage + +```typescript +import { RetrieveAtsEeocsRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsEeocsRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsinterviewrequest.md b/docs/models/operations/retrieveatsinterviewrequest.md index 85a4d0af..8b602381 100644 --- a/docs/models/operations/retrieveatsinterviewrequest.md +++ b/docs/models/operations/retrieveatsinterviewrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsInterviewRequest +## Example Usage + +```typescript +import { RetrieveAtsInterviewRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsInterviewRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsjobinterviewstagerequest.md b/docs/models/operations/retrieveatsjobinterviewstagerequest.md index 16f57e6f..212729cb 100644 --- a/docs/models/operations/retrieveatsjobinterviewstagerequest.md +++ b/docs/models/operations/retrieveatsjobinterviewstagerequest.md @@ -1,5 +1,16 @@ # RetrieveAtsJobInterviewStageRequest +## Example Usage + +```typescript +import { RetrieveAtsJobInterviewStageRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsJobInterviewStageRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsjobrequest.md b/docs/models/operations/retrieveatsjobrequest.md index ccee4112..675e0f38 100644 --- a/docs/models/operations/retrieveatsjobrequest.md +++ b/docs/models/operations/retrieveatsjobrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsJobRequest +## Example Usage + +```typescript +import { RetrieveAtsJobRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsJobRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsofferrequest.md b/docs/models/operations/retrieveatsofferrequest.md index 96ab5b76..a3adaf88 100644 --- a/docs/models/operations/retrieveatsofferrequest.md +++ b/docs/models/operations/retrieveatsofferrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsOfferRequest +## Example Usage + +```typescript +import { RetrieveAtsOfferRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsOfferRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsofficerequest.md b/docs/models/operations/retrieveatsofficerequest.md index 697c6672..532d1519 100644 --- a/docs/models/operations/retrieveatsofficerequest.md +++ b/docs/models/operations/retrieveatsofficerequest.md @@ -1,5 +1,16 @@ # RetrieveAtsOfficeRequest +## Example Usage + +```typescript +import { RetrieveAtsOfficeRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsOfficeRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsrejectreasonrequest.md b/docs/models/operations/retrieveatsrejectreasonrequest.md index 0e545e7a..2415439a 100644 --- a/docs/models/operations/retrieveatsrejectreasonrequest.md +++ b/docs/models/operations/retrieveatsrejectreasonrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsRejectReasonRequest +## Example Usage + +```typescript +import { RetrieveAtsRejectReasonRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsRejectReasonRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsscorecardrequest.md b/docs/models/operations/retrieveatsscorecardrequest.md index e7bcf177..a84e1ac9 100644 --- a/docs/models/operations/retrieveatsscorecardrequest.md +++ b/docs/models/operations/retrieveatsscorecardrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsScorecardRequest +## Example Usage + +```typescript +import { RetrieveAtsScorecardRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsScorecardRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatstagrequest.md b/docs/models/operations/retrieveatstagrequest.md index a2d6019b..11649042 100644 --- a/docs/models/operations/retrieveatstagrequest.md +++ b/docs/models/operations/retrieveatstagrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsTagRequest +## Example Usage + +```typescript +import { RetrieveAtsTagRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsTagRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveatsuserrequest.md b/docs/models/operations/retrieveatsuserrequest.md index dc9752b6..56e6071b 100644 --- a/docs/models/operations/retrieveatsuserrequest.md +++ b/docs/models/operations/retrieveatsuserrequest.md @@ -1,5 +1,16 @@ # RetrieveAtsUserRequest +## Example Usage + +```typescript +import { RetrieveAtsUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveAtsUserRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecollectionrequest.md b/docs/models/operations/retrievecollectionrequest.md index a2f1b32f..cf9bd101 100644 --- a/docs/models/operations/retrievecollectionrequest.md +++ b/docs/models/operations/retrievecollectionrequest.md @@ -1,5 +1,16 @@ # RetrieveCollectionRequest +## Example Usage + +```typescript +import { RetrieveCollectionRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCollectionRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmcompanyrequest.md b/docs/models/operations/retrievecrmcompanyrequest.md index 58d6dfda..9fb84cc8 100644 --- a/docs/models/operations/retrievecrmcompanyrequest.md +++ b/docs/models/operations/retrievecrmcompanyrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmCompanyRequest +## Example Usage + +```typescript +import { RetrieveCrmCompanyRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmCompanyRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmcontactrequest.md b/docs/models/operations/retrievecrmcontactrequest.md index fe8262ee..e0acbbe1 100644 --- a/docs/models/operations/retrievecrmcontactrequest.md +++ b/docs/models/operations/retrievecrmcontactrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmContactRequest +## Example Usage + +```typescript +import { RetrieveCrmContactRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmContactRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmdealrequest.md b/docs/models/operations/retrievecrmdealrequest.md index 837dc783..c10febf3 100644 --- a/docs/models/operations/retrievecrmdealrequest.md +++ b/docs/models/operations/retrievecrmdealrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmDealRequest +## Example Usage + +```typescript +import { RetrieveCrmDealRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmDealRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmengagementrequest.md b/docs/models/operations/retrievecrmengagementrequest.md index 8d79f5a5..3886932e 100644 --- a/docs/models/operations/retrievecrmengagementrequest.md +++ b/docs/models/operations/retrievecrmengagementrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmEngagementRequest +## Example Usage + +```typescript +import { RetrieveCrmEngagementRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmEngagementRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmnoterequest.md b/docs/models/operations/retrievecrmnoterequest.md index f43ac42a..45bed3b4 100644 --- a/docs/models/operations/retrievecrmnoterequest.md +++ b/docs/models/operations/retrievecrmnoterequest.md @@ -1,5 +1,16 @@ # RetrieveCrmNoteRequest +## Example Usage + +```typescript +import { RetrieveCrmNoteRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmNoteRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmstagerequest.md b/docs/models/operations/retrievecrmstagerequest.md index ef175ec5..3c8203b0 100644 --- a/docs/models/operations/retrievecrmstagerequest.md +++ b/docs/models/operations/retrievecrmstagerequest.md @@ -1,5 +1,16 @@ # RetrieveCrmStageRequest +## Example Usage + +```typescript +import { RetrieveCrmStageRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmStageRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmtaskrequest.md b/docs/models/operations/retrievecrmtaskrequest.md index 2e926915..ba10e88e 100644 --- a/docs/models/operations/retrievecrmtaskrequest.md +++ b/docs/models/operations/retrievecrmtaskrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmTaskRequest +## Example Usage + +```typescript +import { RetrieveCrmTaskRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmTaskRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievecrmuserrequest.md b/docs/models/operations/retrievecrmuserrequest.md index 00ff029b..ceab12cf 100644 --- a/docs/models/operations/retrievecrmuserrequest.md +++ b/docs/models/operations/retrievecrmuserrequest.md @@ -1,5 +1,16 @@ # RetrieveCrmUserRequest +## Example Usage + +```typescript +import { RetrieveCrmUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveCrmUserRequest = { + xConnectionToken: "", + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveecommercecustomerrequest.md b/docs/models/operations/retrieveecommercecustomerrequest.md index 33b567e3..ca69af64 100644 --- a/docs/models/operations/retrieveecommercecustomerrequest.md +++ b/docs/models/operations/retrieveecommercecustomerrequest.md @@ -1,5 +1,15 @@ # RetrieveEcommerceCustomerRequest +## Example Usage + +```typescript +import { RetrieveEcommerceCustomerRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveEcommerceCustomerRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveecommercefulfillmentrequest.md b/docs/models/operations/retrieveecommercefulfillmentrequest.md index fecb552a..f227f29b 100644 --- a/docs/models/operations/retrieveecommercefulfillmentrequest.md +++ b/docs/models/operations/retrieveecommercefulfillmentrequest.md @@ -1,5 +1,15 @@ # RetrieveEcommerceFulfillmentRequest +## Example Usage + +```typescript +import { RetrieveEcommerceFulfillmentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveEcommerceFulfillmentRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveecommerceorderrequest.md b/docs/models/operations/retrieveecommerceorderrequest.md index db34fd04..53013108 100644 --- a/docs/models/operations/retrieveecommerceorderrequest.md +++ b/docs/models/operations/retrieveecommerceorderrequest.md @@ -1,5 +1,15 @@ # RetrieveEcommerceOrderRequest +## Example Usage + +```typescript +import { RetrieveEcommerceOrderRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveEcommerceOrderRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveecommerceproductrequest.md b/docs/models/operations/retrieveecommerceproductrequest.md index 5edd7e69..8608514b 100644 --- a/docs/models/operations/retrieveecommerceproductrequest.md +++ b/docs/models/operations/retrieveecommerceproductrequest.md @@ -1,5 +1,15 @@ # RetrieveEcommerceProductRequest +## Example Usage + +```typescript +import { RetrieveEcommerceProductRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveEcommerceProductRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrievefilestoragedriverequest.md b/docs/models/operations/retrievefilestoragedriverequest.md index 771ded60..3228cffa 100644 --- a/docs/models/operations/retrievefilestoragedriverequest.md +++ b/docs/models/operations/retrievefilestoragedriverequest.md @@ -1,5 +1,16 @@ # RetrieveFilestorageDriveRequest +## Example Usage + +```typescript +import { RetrieveFilestorageDriveRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveFilestorageDriveRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievefilestoragefilerequest.md b/docs/models/operations/retrievefilestoragefilerequest.md index df2fab89..b645db59 100644 --- a/docs/models/operations/retrievefilestoragefilerequest.md +++ b/docs/models/operations/retrievefilestoragefilerequest.md @@ -1,5 +1,16 @@ # RetrieveFilestorageFileRequest +## Example Usage + +```typescript +import { RetrieveFilestorageFileRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveFilestorageFileRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievefilestoragefolderrequest.md b/docs/models/operations/retrievefilestoragefolderrequest.md index f154e0e9..0b73b31b 100644 --- a/docs/models/operations/retrievefilestoragefolderrequest.md +++ b/docs/models/operations/retrievefilestoragefolderrequest.md @@ -1,5 +1,16 @@ # RetrieveFilestorageFolderRequest +## Example Usage + +```typescript +import { RetrieveFilestorageFolderRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveFilestorageFolderRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievefilestoragegrouprequest.md b/docs/models/operations/retrievefilestoragegrouprequest.md index a8db0db2..2f27a2f1 100644 --- a/docs/models/operations/retrievefilestoragegrouprequest.md +++ b/docs/models/operations/retrievefilestoragegrouprequest.md @@ -1,5 +1,16 @@ # RetrieveFilestorageGroupRequest +## Example Usage + +```typescript +import { RetrieveFilestorageGroupRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveFilestorageGroupRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievefilestorageuserrequest.md b/docs/models/operations/retrievefilestorageuserrequest.md index 01858e17..dd4be317 100644 --- a/docs/models/operations/retrievefilestorageuserrequest.md +++ b/docs/models/operations/retrievefilestorageuserrequest.md @@ -1,5 +1,16 @@ # RetrieveFilestorageUserRequest +## Example Usage + +```typescript +import { RetrieveFilestorageUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveFilestorageUserRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisbankinforequest.md b/docs/models/operations/retrievehrisbankinforequest.md index fdf84610..8f6e3c74 100644 --- a/docs/models/operations/retrievehrisbankinforequest.md +++ b/docs/models/operations/retrievehrisbankinforequest.md @@ -1,5 +1,16 @@ # RetrieveHrisBankInfoRequest +## Example Usage + +```typescript +import { RetrieveHrisBankInfoRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisBankInfoRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisbenefitrequest.md b/docs/models/operations/retrievehrisbenefitrequest.md index be66ace6..328c4d28 100644 --- a/docs/models/operations/retrievehrisbenefitrequest.md +++ b/docs/models/operations/retrievehrisbenefitrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisBenefitRequest +## Example Usage + +```typescript +import { RetrieveHrisBenefitRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisBenefitRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehriscompanyrequest.md b/docs/models/operations/retrievehriscompanyrequest.md index 74b18e40..9d7a0040 100644 --- a/docs/models/operations/retrievehriscompanyrequest.md +++ b/docs/models/operations/retrievehriscompanyrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisCompanyRequest +## Example Usage + +```typescript +import { RetrieveHrisCompanyRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisCompanyRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisdependentrequest.md b/docs/models/operations/retrievehrisdependentrequest.md index 47254fcc..9d22594a 100644 --- a/docs/models/operations/retrievehrisdependentrequest.md +++ b/docs/models/operations/retrievehrisdependentrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisDependentRequest +## Example Usage + +```typescript +import { RetrieveHrisDependentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisDependentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisemployeepayrollrunrequest.md b/docs/models/operations/retrievehrisemployeepayrollrunrequest.md index b26d12e6..94b1208f 100644 --- a/docs/models/operations/retrievehrisemployeepayrollrunrequest.md +++ b/docs/models/operations/retrievehrisemployeepayrollrunrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisEmployeePayrollRunRequest +## Example Usage + +```typescript +import { RetrieveHrisEmployeePayrollRunRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisEmployeePayrollRunRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisemployeerequest.md b/docs/models/operations/retrievehrisemployeerequest.md index 7d85a27b..5c046492 100644 --- a/docs/models/operations/retrievehrisemployeerequest.md +++ b/docs/models/operations/retrievehrisemployeerequest.md @@ -1,5 +1,16 @@ # RetrieveHrisEmployeeRequest +## Example Usage + +```typescript +import { RetrieveHrisEmployeeRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisEmployeeRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisemployerbenefitrequest.md b/docs/models/operations/retrievehrisemployerbenefitrequest.md index 248699cd..1a5576fd 100644 --- a/docs/models/operations/retrievehrisemployerbenefitrequest.md +++ b/docs/models/operations/retrievehrisemployerbenefitrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisEmployerBenefitRequest +## Example Usage + +```typescript +import { RetrieveHrisEmployerBenefitRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisEmployerBenefitRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisemploymentrequest.md b/docs/models/operations/retrievehrisemploymentrequest.md index 0ae6b6f4..3b49ba16 100644 --- a/docs/models/operations/retrievehrisemploymentrequest.md +++ b/docs/models/operations/retrievehrisemploymentrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisEmploymentRequest +## Example Usage + +```typescript +import { RetrieveHrisEmploymentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisEmploymentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrisgrouprequest.md b/docs/models/operations/retrievehrisgrouprequest.md index 49c0973b..dee92611 100644 --- a/docs/models/operations/retrievehrisgrouprequest.md +++ b/docs/models/operations/retrievehrisgrouprequest.md @@ -1,5 +1,16 @@ # RetrieveHrisGroupRequest +## Example Usage + +```typescript +import { RetrieveHrisGroupRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisGroupRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrislocationrequest.md b/docs/models/operations/retrievehrislocationrequest.md index 29f7e819..25d38526 100644 --- a/docs/models/operations/retrievehrislocationrequest.md +++ b/docs/models/operations/retrievehrislocationrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisLocationRequest +## Example Usage + +```typescript +import { RetrieveHrisLocationRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisLocationRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrispaygrouprequest.md b/docs/models/operations/retrievehrispaygrouprequest.md index 716cf68c..5c050364 100644 --- a/docs/models/operations/retrievehrispaygrouprequest.md +++ b/docs/models/operations/retrievehrispaygrouprequest.md @@ -1,5 +1,16 @@ # RetrieveHrisPaygroupRequest +## Example Usage + +```typescript +import { RetrieveHrisPaygroupRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisPaygroupRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehrispayrollrunrequest.md b/docs/models/operations/retrievehrispayrollrunrequest.md index c378b6e3..5fb557c7 100644 --- a/docs/models/operations/retrievehrispayrollrunrequest.md +++ b/docs/models/operations/retrievehrispayrollrunrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisPayrollRunRequest +## Example Usage + +```typescript +import { RetrieveHrisPayrollRunRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisPayrollRunRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehristimeoffbalancerequest.md b/docs/models/operations/retrievehristimeoffbalancerequest.md index afd3359b..79052ba0 100644 --- a/docs/models/operations/retrievehristimeoffbalancerequest.md +++ b/docs/models/operations/retrievehristimeoffbalancerequest.md @@ -1,5 +1,16 @@ # RetrieveHrisTimeoffbalanceRequest +## Example Usage + +```typescript +import { RetrieveHrisTimeoffbalanceRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisTimeoffbalanceRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehristimeoffrequest.md b/docs/models/operations/retrievehristimeoffrequest.md index 73c4d233..34334461 100644 --- a/docs/models/operations/retrievehristimeoffrequest.md +++ b/docs/models/operations/retrievehristimeoffrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisTimeoffRequest +## Example Usage + +```typescript +import { RetrieveHrisTimeoffRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisTimeoffRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievehristimesheetentryrequest.md b/docs/models/operations/retrievehristimesheetentryrequest.md index 4ef83839..34024a5a 100644 --- a/docs/models/operations/retrievehristimesheetentryrequest.md +++ b/docs/models/operations/retrievehristimesheetentryrequest.md @@ -1,5 +1,16 @@ # RetrieveHrisTimesheetentryRequest +## Example Usage + +```typescript +import { RetrieveHrisTimesheetentryRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveHrisTimesheetentryRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievelinkeduserrequest.md b/docs/models/operations/retrievelinkeduserrequest.md index 654944a8..80668cdf 100644 --- a/docs/models/operations/retrievelinkeduserrequest.md +++ b/docs/models/operations/retrievelinkeduserrequest.md @@ -1,5 +1,14 @@ # RetrieveLinkedUserRequest +## Example Usage + +```typescript +import { RetrieveLinkedUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveLinkedUserRequest = { + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationactionrequest.md b/docs/models/operations/retrievemarketingautomationactionrequest.md index 70190b80..1d3c559a 100644 --- a/docs/models/operations/retrievemarketingautomationactionrequest.md +++ b/docs/models/operations/retrievemarketingautomationactionrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationActionRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationActionRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationActionRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationautomationrequest.md b/docs/models/operations/retrievemarketingautomationautomationrequest.md index 32f1b2d1..2235ab8e 100644 --- a/docs/models/operations/retrievemarketingautomationautomationrequest.md +++ b/docs/models/operations/retrievemarketingautomationautomationrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationAutomationRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationAutomationRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationAutomationRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationcampaignrequest.md b/docs/models/operations/retrievemarketingautomationcampaignrequest.md index 75a02eaa..9737bcda 100644 --- a/docs/models/operations/retrievemarketingautomationcampaignrequest.md +++ b/docs/models/operations/retrievemarketingautomationcampaignrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationCampaignRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationCampaignRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationCampaignRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationcontactrequest.md b/docs/models/operations/retrievemarketingautomationcontactrequest.md index a9c974d0..b793d684 100644 --- a/docs/models/operations/retrievemarketingautomationcontactrequest.md +++ b/docs/models/operations/retrievemarketingautomationcontactrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingAutomationContactRequest +## Example Usage + +```typescript +import { RetrieveMarketingAutomationContactRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingAutomationContactRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationemailrequest.md b/docs/models/operations/retrievemarketingautomationemailrequest.md index 447687e1..e91f344f 100644 --- a/docs/models/operations/retrievemarketingautomationemailrequest.md +++ b/docs/models/operations/retrievemarketingautomationemailrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationEmailRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationEmailRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationEmailRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationeventrequest.md b/docs/models/operations/retrievemarketingautomationeventrequest.md index f2db14e4..151130ba 100644 --- a/docs/models/operations/retrievemarketingautomationeventrequest.md +++ b/docs/models/operations/retrievemarketingautomationeventrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationEventRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationEventRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationEventRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationlistrequest.md b/docs/models/operations/retrievemarketingautomationlistrequest.md index 341fbc8f..2b27575c 100644 --- a/docs/models/operations/retrievemarketingautomationlistrequest.md +++ b/docs/models/operations/retrievemarketingautomationlistrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationListRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationListRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationListRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationmessagerequest.md b/docs/models/operations/retrievemarketingautomationmessagerequest.md index 61157b20..cf8d1a47 100644 --- a/docs/models/operations/retrievemarketingautomationmessagerequest.md +++ b/docs/models/operations/retrievemarketingautomationmessagerequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationMessageRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationMessageRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationMessageRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationtemplaterequest.md b/docs/models/operations/retrievemarketingautomationtemplaterequest.md index 92043607..673280be 100644 --- a/docs/models/operations/retrievemarketingautomationtemplaterequest.md +++ b/docs/models/operations/retrievemarketingautomationtemplaterequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingautomationTemplateRequest +## Example Usage + +```typescript +import { RetrieveMarketingautomationTemplateRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingautomationTemplateRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrievemarketingautomationuserrequest.md b/docs/models/operations/retrievemarketingautomationuserrequest.md index a525eedf..3e8faccf 100644 --- a/docs/models/operations/retrievemarketingautomationuserrequest.md +++ b/docs/models/operations/retrievemarketingautomationuserrequest.md @@ -1,5 +1,16 @@ # RetrieveMarketingAutomationUserRequest +## Example Usage + +```typescript +import { RetrieveMarketingAutomationUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveMarketingAutomationUserRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingaccountrequest.md b/docs/models/operations/retrieveticketingaccountrequest.md index ced620b9..2324f700 100644 --- a/docs/models/operations/retrieveticketingaccountrequest.md +++ b/docs/models/operations/retrieveticketingaccountrequest.md @@ -1,5 +1,15 @@ # RetrieveTicketingAccountRequest +## Example Usage + +```typescript +import { RetrieveTicketingAccountRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingAccountRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingattachmentrequest.md b/docs/models/operations/retrieveticketingattachmentrequest.md index 9fd307c2..94bd1ce5 100644 --- a/docs/models/operations/retrieveticketingattachmentrequest.md +++ b/docs/models/operations/retrieveticketingattachmentrequest.md @@ -1,5 +1,16 @@ # RetrieveTicketingAttachmentRequest +## Example Usage + +```typescript +import { RetrieveTicketingAttachmentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingAttachmentRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingcommentrequest.md b/docs/models/operations/retrieveticketingcommentrequest.md index e0d00824..17ae8bb2 100644 --- a/docs/models/operations/retrieveticketingcommentrequest.md +++ b/docs/models/operations/retrieveticketingcommentrequest.md @@ -1,5 +1,15 @@ # RetrieveTicketingCommentRequest +## Example Usage + +```typescript +import { RetrieveTicketingCommentRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingCommentRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingcommentresponsebody.md b/docs/models/operations/retrieveticketingcommentresponsebody.md index a290dd9d..cc3035e3 100644 --- a/docs/models/operations/retrieveticketingcommentresponsebody.md +++ b/docs/models/operations/retrieveticketingcommentresponsebody.md @@ -1,5 +1,36 @@ # RetrieveTicketingCommentResponseBody +## Example Usage + +```typescript +import { CreatorType } from "@panora/sdk/models/components"; +import { RetrieveTicketingCommentResponseBody } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingCommentResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: CreatorType.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"], + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingcontactrequest.md b/docs/models/operations/retrieveticketingcontactrequest.md index 855bdf43..e6a317b9 100644 --- a/docs/models/operations/retrieveticketingcontactrequest.md +++ b/docs/models/operations/retrieveticketingcontactrequest.md @@ -1,5 +1,15 @@ # RetrieveTicketingContactRequest +## Example Usage + +```typescript +import { RetrieveTicketingContactRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingContactRequest = { + xConnectionToken: "", + id: "", +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingcontactresponsebody.md b/docs/models/operations/retrieveticketingcontactresponsebody.md index a6194cd7..3b191f41 100644 --- a/docs/models/operations/retrieveticketingcontactresponsebody.md +++ b/docs/models/operations/retrieveticketingcontactresponsebody.md @@ -1,5 +1,35 @@ # RetrieveTicketingContactResponseBody +## Example Usage + +```typescript +import { RetrieveTicketingContactResponseBody } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingContactResponseBody = { + prevCursor: "", + nextCursor: "", + data: [ + { + name: "Joe", + emailAddress: "joedoe@acme.org", + phoneNumber: "+33 6 50 11 11 10", + details: "Contact Details", + fieldMappings: { + fav_dish: "broccoli", + fav_color: "red", + }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteId: "id_1", + remoteData: { + fav_dish: "broccoli", + fav_color: "red", + }, + createdAt: new Date("2024-10-01T12:00:00Z"), + modifiedAt: new Date("2024-10-01T12:00:00Z"), + }, + ], +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingtagrequest.md b/docs/models/operations/retrieveticketingtagrequest.md index 8492a5ae..4008ae5d 100644 --- a/docs/models/operations/retrieveticketingtagrequest.md +++ b/docs/models/operations/retrieveticketingtagrequest.md @@ -1,5 +1,16 @@ # RetrieveTicketingTagRequest +## Example Usage + +```typescript +import { RetrieveTicketingTagRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingTagRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingteamrequest.md b/docs/models/operations/retrieveticketingteamrequest.md index 9d23750e..c234e111 100644 --- a/docs/models/operations/retrieveticketingteamrequest.md +++ b/docs/models/operations/retrieveticketingteamrequest.md @@ -1,5 +1,16 @@ # RetrieveTicketingTeamRequest +## Example Usage + +```typescript +import { RetrieveTicketingTeamRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingTeamRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketingticketrequest.md b/docs/models/operations/retrieveticketingticketrequest.md index 46d89e50..4c05833e 100644 --- a/docs/models/operations/retrieveticketingticketrequest.md +++ b/docs/models/operations/retrieveticketingticketrequest.md @@ -1,5 +1,16 @@ # RetrieveTicketingTicketRequest +## Example Usage + +```typescript +import { RetrieveTicketingTicketRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingTicketRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/retrieveticketinguserrequest.md b/docs/models/operations/retrieveticketinguserrequest.md index 8c0ecd8e..728edc70 100644 --- a/docs/models/operations/retrieveticketinguserrequest.md +++ b/docs/models/operations/retrieveticketinguserrequest.md @@ -1,5 +1,16 @@ # RetrieveTicketingUserRequest +## Example Usage + +```typescript +import { RetrieveTicketingUserRequest } from "@panora/sdk/models/operations"; + +let value: RetrieveTicketingUserRequest = { + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, +}; +``` ## Fields diff --git a/docs/models/operations/statusrequest.md b/docs/models/operations/statusrequest.md index 13cc5aca..cd76eff9 100644 --- a/docs/models/operations/statusrequest.md +++ b/docs/models/operations/statusrequest.md @@ -1,5 +1,14 @@ # StatusRequest +## Example Usage + +```typescript +import { StatusRequest, Vertical } from "@panora/sdk/models/operations"; + +let value: StatusRequest = { + vertical: Vertical.Ticketing, +}; +``` ## Fields diff --git a/docs/models/operations/updatestatusrequest.md b/docs/models/operations/updatestatusrequest.md index 77bdf64e..9fa0d817 100644 --- a/docs/models/operations/updatestatusrequest.md +++ b/docs/models/operations/updatestatusrequest.md @@ -1,5 +1,14 @@ # UpdateStatusRequest +## Example Usage + +```typescript +import { UpdateStatusRequest } from "@panora/sdk/models/operations"; + +let value: UpdateStatusRequest = { + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", +}; +``` ## Fields diff --git a/docs/models/operations/verifyeventresponsebody.md b/docs/models/operations/verifyeventresponsebody.md index 81abadea..719f834f 100644 --- a/docs/models/operations/verifyeventresponsebody.md +++ b/docs/models/operations/verifyeventresponsebody.md @@ -1,5 +1,12 @@ # VerifyEventResponseBody +## Example Usage + +```typescript +import { VerifyEventResponseBody } from "@panora/sdk/models/operations"; + +let value: VerifyEventResponseBody = {}; +``` ## Fields diff --git a/docs/models/operations/vertical.md b/docs/models/operations/vertical.md index 68e4c741..1590c9a3 100644 --- a/docs/models/operations/vertical.md +++ b/docs/models/operations/vertical.md @@ -1,5 +1,12 @@ # Vertical +## Example Usage + +```typescript +import { Vertical } from "@panora/sdk/models/operations"; + +let value: Vertical = Vertical.Ticketing; +``` ## Values diff --git a/docs/sdks/accounting/README.md b/docs/sdks/accounting/README.md index 9eca3e15..f2803c29 100644 --- a/docs/sdks/accounting/README.md +++ b/docs/sdks/accounting/README.md @@ -1,5 +1,2 @@ # Accounting -(*accounting*) - -### Available Operations - +(*accounting*) \ No newline at end of file diff --git a/docs/sdks/accounts/README.md b/docs/sdks/accounts/README.md index d1ed4957..2380b26a 100644 --- a/docs/sdks/accounts/README.md +++ b/docs/sdks/accounts/README.md @@ -1,6 +1,8 @@ # Accounts (*ticketing.accounts*) +## Overview + ### Available Operations * [list](#list) - List Accounts @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingAccountResponse](../../models/operations/listticketingaccountresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Accounts from any connected Ticketing software @@ -117,7 +119,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -160,10 +161,10 @@ run(); | `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.UnifiedTicketingAccountOutput](../../models/components/unifiedticketingaccountoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/actions/README.md b/docs/sdks/actions/README.md index d13ea359..ba65c1af 100644 --- a/docs/sdks/actions/README.md +++ b/docs/sdks/actions/README.md @@ -1,6 +1,8 @@ # Actions (*marketingautomation.actions*) +## Overview + ### Available Operations * [list](#list) - List Actions @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingautomationActionResponse](../../models/operations/listmarketingautomationactionresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a action in any supported Marketingautomation software @@ -119,7 +121,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -163,16 +164,17 @@ run(); | `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.UnifiedMarketingautomationActionOutput](../../models/components/unifiedmarketingautomationactionoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Actions from any connected Marketingautomation software @@ -200,7 +202,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -244,10 +245,10 @@ run(); | `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.UnifiedMarketingautomationActionOutput](../../models/components/unifiedmarketingautomationactionoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 3968c5d6..1ee556cd 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -1,6 +1,8 @@ # Activities (*ats.activities*) +## Overview + ### Available Operations * [list](#list) - List Activities @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAtsActivityResponse](../../models/operations/listatsactivityresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Activities in any supported Ats software @@ -131,7 +133,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -187,16 +188,17 @@ run(); | `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.UnifiedAtsActivityOutput](../../models/components/unifiedatsactivityoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Activities from any connected Ats software @@ -224,7 +226,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -268,10 +269,10 @@ run(); | `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.UnifiedAtsActivityOutput](../../models/components/unifiedatsactivityoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/addresses/README.md b/docs/sdks/addresses/README.md index 0f22bf04..2e9d96fb 100644 --- a/docs/sdks/addresses/README.md +++ b/docs/sdks/addresses/README.md @@ -1,6 +1,8 @@ # Addresses (*accounting.addresses*) +## Overview + ### Available Operations * [list](#list) - List Addresss @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingAddressResponse](../../models/operations/listaccountingaddressresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Addresses from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingAddressOutput](../../models/components/unifiedaccountingaddressoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md index d4fbfb50..8dcda575 100644 --- a/docs/sdks/applications/README.md +++ b/docs/sdks/applications/README.md @@ -1,6 +1,8 @@ # Applications (*ats.applications*) +## Overview + ### Available Operations * [list](#list) - List Applications @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAtsApplicationResponse](../../models/operations/listatsapplicationresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Applications in any supported Ats software @@ -136,7 +138,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -197,16 +198,17 @@ run(); | `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.UnifiedAtsApplicationOutput](../../models/components/unifiedatsapplicationoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Applications from any connected Ats software @@ -234,7 +236,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -278,10 +279,10 @@ run(); | `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.UnifiedAtsApplicationOutput](../../models/components/unifiedatsapplicationoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 9a7b5bdf..0fb4c255 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -1,5 +1,2 @@ # Ats -(*ats*) - -### Available Operations - +(*ats*) \ No newline at end of file diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md index 8f46200e..55563e5e 100644 --- a/docs/sdks/attachments/README.md +++ b/docs/sdks/attachments/README.md @@ -1,6 +1,8 @@ # Attachments (*ats.attachments*) +## Overview + ### Available Operations * [list](#list) - List Attachments @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAtsAttachmentResponse](../../models/operations/listatsattachmentresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Attachments in any supported ATS software @@ -131,7 +133,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -187,16 +188,17 @@ run(); | `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.UnifiedAtsAttachmentOutput](../../models/components/unifiedatsattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Attachments from any connected Ats software @@ -224,7 +226,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -268,10 +269,10 @@ run(); | `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.UnifiedAtsAttachmentOutput](../../models/components/unifiedatsattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/auth/README.md b/docs/sdks/auth/README.md index 890e03ba..cbf19bfe 100644 --- a/docs/sdks/auth/README.md +++ b/docs/sdks/auth/README.md @@ -1,5 +1,2 @@ # Auth -(*auth*) - -### Available Operations - +(*auth*) \ No newline at end of file diff --git a/docs/sdks/automations/README.md b/docs/sdks/automations/README.md index fc9ebca1..ab4657ed 100644 --- a/docs/sdks/automations/README.md +++ b/docs/sdks/automations/README.md @@ -1,6 +1,8 @@ # Automations (*marketingautomation.automations*) +## Overview + ### Available Operations * [list](#list) - List Automations @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingautomationAutomationsResponse](../../models/operations/listmarketingautomationautomationsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a automation in any supported Marketingautomation software @@ -119,7 +121,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -163,16 +164,17 @@ run(); | `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.UnifiedMarketingautomationAutomationOutput](../../models/components/unifiedmarketingautomationautomationoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Automation from any connected Marketingautomation software @@ -200,7 +202,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -244,10 +245,10 @@ run(); | `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.UnifiedMarketingautomationAutomationOutput](../../models/components/unifiedmarketingautomationautomationoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/balancesheets/README.md b/docs/sdks/balancesheets/README.md index ce145508..d3561fa8 100644 --- a/docs/sdks/balancesheets/README.md +++ b/docs/sdks/balancesheets/README.md @@ -1,6 +1,8 @@ # Balancesheets (*accounting.balancesheets*) +## Overview + ### Available Operations * [list](#list) - List BalanceSheets @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingBalanceSheetsResponse](../../models/operations/listaccountingbalancesheetsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve BalanceSheets from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingBalancesheetOutput](../../models/components/unifiedaccountingbalancesheetoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/bankinfos/README.md b/docs/sdks/bankinfos/README.md index cbb66721..8bb2ef89 100644 --- a/docs/sdks/bankinfos/README.md +++ b/docs/sdks/bankinfos/README.md @@ -1,6 +1,8 @@ # Bankinfos (*hris.bankinfos*) +## Overview + ### Available Operations * [list](#list) - List Bank Info @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisBankInfoResponse](../../models/operations/listhrisbankinforesponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Bank Info from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisBankinfoOutput](../../models/components/unifiedhrisbankinfooutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/benefits/README.md b/docs/sdks/benefits/README.md index eb7d27d6..9659d660 100644 --- a/docs/sdks/benefits/README.md +++ b/docs/sdks/benefits/README.md @@ -1,6 +1,8 @@ # Benefits (*hris.benefits*) +## Overview + ### Available Operations * [list](#list) - List Benefits @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisBenefitsResponse](../../models/operations/listhrisbenefitsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Benefit from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisBenefitOutput](../../models/components/unifiedhrisbenefitoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/campaigns/README.md b/docs/sdks/campaigns/README.md index e2f1714a..48d3a2e5 100644 --- a/docs/sdks/campaigns/README.md +++ b/docs/sdks/campaigns/README.md @@ -1,6 +1,8 @@ # Campaigns (*marketingautomation.campaigns*) +## Overview + ### Available Operations * [list](#list) - List Campaigns @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingautomationCampaignsResponse](../../models/operations/listmarketingautomationcampaignsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a campaign in any supported Marketingautomation software @@ -119,7 +121,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -163,16 +164,17 @@ run(); | `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.UnifiedMarketingautomationCampaignOutput](../../models/components/unifiedmarketingautomationcampaignoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Campaign from any connected Marketingautomation software @@ -200,7 +202,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -244,10 +245,10 @@ run(); | `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.UnifiedMarketingautomationCampaignOutput](../../models/components/unifiedmarketingautomationcampaignoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/candidates/README.md b/docs/sdks/candidates/README.md index f4ab70d7..f4c9df93 100644 --- a/docs/sdks/candidates/README.md +++ b/docs/sdks/candidates/README.md @@ -1,6 +1,8 @@ # Candidates (*ats.candidates*) +## Overview + ### Available Operations * [list](#list) - List Candidates @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAtsCandidateResponse](../../models/operations/listatscandidateresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Candidates in any supported Ats software @@ -163,7 +165,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -251,16 +252,17 @@ run(); | `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.UnifiedAtsCandidateOutput](../../models/components/unifiedatscandidateoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Candidates from any connected Ats software @@ -288,7 +290,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -332,10 +333,10 @@ run(); | `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.UnifiedAtsCandidateOutput](../../models/components/unifiedatscandidateoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/cashflowstatements/README.md b/docs/sdks/cashflowstatements/README.md index 97bd57cb..e02a25d1 100644 --- a/docs/sdks/cashflowstatements/README.md +++ b/docs/sdks/cashflowstatements/README.md @@ -1,6 +1,8 @@ # Cashflowstatements (*accounting.cashflowstatements*) +## Overview + ### Available Operations * [list](#list) - List CashflowStatements @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingCashflowStatementResponse](../../models/operations/listaccountingcashflowstatementresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Cashflow Statements from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingCashflowstatementOutput](../../models/components/unifiedaccountingcashflowstatementoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md index 7b123849..1174c741 100644 --- a/docs/sdks/collections/README.md +++ b/docs/sdks/collections/README.md @@ -1,6 +1,8 @@ # Collections (*ticketing.collections*) +## Overview + ### Available Operations * [list](#list) - List Collections @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingCollectionsResponse](../../models/operations/listticketingcollectionsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Collections from any connected Ticketing software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedTicketingCollectionOutput](../../models/components/unifiedticketingcollectionoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/comments/README.md b/docs/sdks/comments/README.md index b721a1ab..b07f55c4 100644 --- a/docs/sdks/comments/README.md +++ b/docs/sdks/comments/README.md @@ -1,6 +1,8 @@ # Comments (*ticketing.comments*) +## Overview + ### Available Operations * [list](#list) - List Comments @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListTicketingCommentsResponse](../../models/operations/listticketingcommentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Comments in any supported Ticketing software @@ -130,7 +132,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -185,16 +186,17 @@ run(); | `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.UnifiedTicketingCommentOutput](../../models/components/unifiedticketingcommentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Comment from any connected Ticketing software @@ -221,7 +223,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -264,10 +265,10 @@ run(); | `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\<[operations.RetrieveTicketingCommentResponseBody](../../models/operations/retrieveticketingcommentresponsebody.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index ca064bcb..f32f7276 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -1,6 +1,8 @@ # Companies (*crm.companies*) +## Overview + ### Available Operations * [list](#list) - List Companies @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmCompanyResponse](../../models/operations/listcrmcompanyresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Companies in any supported CRM software @@ -153,7 +155,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -231,16 +232,17 @@ run(); | `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.UnifiedCrmCompanyOutput](../../models/components/unifiedcrmcompanyoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Companies from any connected Crm software @@ -268,7 +270,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -312,10 +313,10 @@ run(); | `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.UnifiedCrmCompanyOutput](../../models/components/unifiedcrmcompanyoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/companyinfos/README.md b/docs/sdks/companyinfos/README.md index 49732a45..9aa3831f 100644 --- a/docs/sdks/companyinfos/README.md +++ b/docs/sdks/companyinfos/README.md @@ -1,6 +1,8 @@ # Companyinfos (*accounting.companyinfos*) +## Overview + ### Available Operations * [list](#list) - List CompanyInfos @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingCompanyInfosResponse](../../models/operations/listaccountingcompanyinfosresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Company Infos from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingCompanyinfoOutput](../../models/components/unifiedaccountingcompanyinfooutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index e626e2c9..1643cc35 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -1,6 +1,8 @@ # Connections (*connections*) +## Overview + ### Available Operations * [getConnections](#getconnections) - List Connections @@ -28,7 +30,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -67,10 +68,10 @@ run(); | `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.Connection[]](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index d02f0cf8..39281b5e 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -1,6 +1,8 @@ # Contacts (*ticketing.contacts*) +## Overview + ### Available Operations * [list](#list) - List Contacts @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingContactsResponse](../../models/operations/listticketingcontactsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Contact from any connected Ticketing software @@ -117,7 +119,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -160,10 +161,10 @@ run(); | `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\<[operations.RetrieveTicketingContactResponseBody](../../models/operations/retrieveticketingcontactresponsebody.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index ac70f4a3..2bed5969 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -1,6 +1,8 @@ # Creditnotes (*accounting.creditnotes*) +## Overview + ### Available Operations * [list](#list) - List CreditNotes @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingCreditNoteResponse](../../models/operations/listaccountingcreditnoteresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Credit Notes from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingCreditnoteOutput](../../models/components/unifiedaccountingcreditnoteoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/crm/README.md b/docs/sdks/crm/README.md index ca731a02..7b629fcb 100644 --- a/docs/sdks/crm/README.md +++ b/docs/sdks/crm/README.md @@ -1,5 +1,2 @@ # Crm -(*crm*) - -### Available Operations - +(*crm*) \ No newline at end of file diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index 0d08f4a6..5940cde5 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -1,6 +1,8 @@ # Customers (*ecommerce.customers*) +## Overview + ### Available Operations * [list](#list) - List Customers @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListEcommerceCustomersResponse](../../models/operations/listecommercecustomersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve customers from any connected Ats software @@ -117,7 +119,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -160,10 +161,10 @@ run(); | `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.UnifiedEcommerceCustomerOutput](../../models/components/unifiedecommercecustomeroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/deals/README.md b/docs/sdks/deals/README.md index 47fd5658..23f92819 100644 --- a/docs/sdks/deals/README.md +++ b/docs/sdks/deals/README.md @@ -1,6 +1,8 @@ # Deals (*crm.deals*) +## Overview + ### Available Operations * [list](#list) - List Deals @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmDealsResponse](../../models/operations/listcrmdealsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Deals in any supported Crm software @@ -129,7 +131,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -183,16 +184,17 @@ run(); | `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.UnifiedCrmDealOutput](../../models/components/unifiedcrmdealoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Deals from any connected Crm software @@ -220,7 +222,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -264,10 +265,10 @@ run(); | `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.UnifiedCrmDealOutput](../../models/components/unifiedcrmdealoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md index 79185887..11cce7b4 100644 --- a/docs/sdks/departments/README.md +++ b/docs/sdks/departments/README.md @@ -1,6 +1,8 @@ # Departments (*ats.departments*) +## Overview + ### Available Operations * [list](#list) - List Departments @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsDepartmentsResponse](../../models/operations/listatsdepartmentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Departments from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsDepartmentOutput](../../models/components/unifiedatsdepartmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/dependents/README.md b/docs/sdks/dependents/README.md index 3abcd3f9..2891c2a9 100644 --- a/docs/sdks/dependents/README.md +++ b/docs/sdks/dependents/README.md @@ -1,6 +1,8 @@ # Dependents (*hris.dependents*) +## Overview + ### Available Operations * [list](#list) - List Dependents @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisDependentsResponse](../../models/operations/listhrisdependentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Dependent from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisDependentOutput](../../models/components/unifiedhrisdependentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md index 83fd19e1..ab32426a 100644 --- a/docs/sdks/drives/README.md +++ b/docs/sdks/drives/README.md @@ -1,6 +1,8 @@ # Drives (*filestorage.drives*) +## Overview + ### Available Operations * [list](#list) - List Drives @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListFilestorageDrivesResponse](../../models/operations/listfilestoragedrivesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Drive from any connected file storage service @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedFilestorageDriveOutput](../../models/components/unifiedfilestoragedriveoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/ecommerce/README.md b/docs/sdks/ecommerce/README.md index 37e84ba7..61f539bf 100644 --- a/docs/sdks/ecommerce/README.md +++ b/docs/sdks/ecommerce/README.md @@ -1,5 +1,2 @@ # Ecommerce -(*ecommerce*) - -### Available Operations - +(*ecommerce*) \ No newline at end of file diff --git a/docs/sdks/eeocs/README.md b/docs/sdks/eeocs/README.md index 7557dd52..f8d3c330 100644 --- a/docs/sdks/eeocs/README.md +++ b/docs/sdks/eeocs/README.md @@ -1,6 +1,8 @@ # Eeocs (*ats.eeocs*) +## Overview + ### Available Operations * [list](#list) - List Eeocss @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsEeocsResponse](../../models/operations/listatseeocsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a eeocs from any connected Ats software @@ -117,7 +119,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -160,10 +161,10 @@ run(); | `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.UnifiedAtsEeocsOutput](../../models/components/unifiedatseeocsoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/emails/README.md b/docs/sdks/emails/README.md index ab745973..3d694605 100644 --- a/docs/sdks/emails/README.md +++ b/docs/sdks/emails/README.md @@ -1,6 +1,8 @@ # Emails (*marketingautomation.emails*) +## Overview + ### Available Operations * [list](#list) - List Emails @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListMarketingautomationEmailsResponse](../../models/operations/listmarketingautomationemailsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Email from any connected Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedMarketingautomationEmailOutput](../../models/components/unifiedmarketingautomationemailoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/employeepayrollruns/README.md b/docs/sdks/employeepayrollruns/README.md index 6095720b..d4c3d0c0 100644 --- a/docs/sdks/employeepayrollruns/README.md +++ b/docs/sdks/employeepayrollruns/README.md @@ -1,6 +1,8 @@ # Employeepayrollruns (*hris.employeepayrollruns*) +## Overview + ### Available Operations * [list](#list) - List Employee Payroll Runs @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisEmployeePayrollRunResponse](../../models/operations/listhrisemployeepayrollrunresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Employee Payroll Run from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisEmployeepayrollrunOutput](../../models/components/unifiedhrisemployeepayrollrunoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index a7c76d17..d4841e23 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -1,6 +1,8 @@ # Employees (*hris.employees*) +## Overview + ### Available Operations * [list](#list) - List Employees @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListHrisEmployeesResponse](../../models/operations/listhrisemployeesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Employees in any supported Hris software @@ -157,7 +159,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -239,16 +240,17 @@ run(); | `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.UnifiedHrisEmployeeOutput](../../models/components/unifiedhrisemployeeoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Employee from any connected Hris software @@ -276,7 +278,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -320,10 +321,10 @@ run(); | `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.UnifiedHrisEmployeeOutput](../../models/components/unifiedhrisemployeeoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/employerbenefits/README.md b/docs/sdks/employerbenefits/README.md index 15ac134a..aff79bda 100644 --- a/docs/sdks/employerbenefits/README.md +++ b/docs/sdks/employerbenefits/README.md @@ -1,6 +1,8 @@ # Employerbenefits (*hris.employerbenefits*) +## Overview + ### Available Operations * [list](#list) - List Employer Benefits @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisEmployerBenefitsResponse](../../models/operations/listhrisemployerbenefitsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Employer Benefit from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisEmployerbenefitOutput](../../models/components/unifiedhrisemployerbenefitoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/employments/README.md b/docs/sdks/employments/README.md index e4c3d91a..6c4c6925 100644 --- a/docs/sdks/employments/README.md +++ b/docs/sdks/employments/README.md @@ -1,6 +1,8 @@ # Employments (*hris.employments*) +## Overview + ### Available Operations * [list](#list) - List Employments @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisEmploymentsResponse](../../models/operations/listhrisemploymentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Employment from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisEmploymentOutput](../../models/components/unifiedhrisemploymentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/engagements/README.md b/docs/sdks/engagements/README.md index 6c0d6de3..0c5f4b88 100644 --- a/docs/sdks/engagements/README.md +++ b/docs/sdks/engagements/README.md @@ -1,6 +1,8 @@ # Engagements (*crm.engagements*) +## Overview + ### Available Operations * [list](#list) - List Engagements @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmEngagementsResponse](../../models/operations/listcrmengagementsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Engagements in any supported Crm software @@ -136,7 +138,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -197,16 +198,17 @@ run(); | `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.UnifiedCrmEngagementOutput](../../models/components/unifiedcrmengagementoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Engagements from any connected Crm software @@ -234,7 +236,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -278,10 +279,10 @@ run(); | `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.UnifiedCrmEngagementOutput](../../models/components/unifiedcrmengagementoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/events/README.md b/docs/sdks/events/README.md index b3bdfd04..522a195f 100644 --- a/docs/sdks/events/README.md +++ b/docs/sdks/events/README.md @@ -1,6 +1,8 @@ # Events (*events*) +## Overview + ### Available Operations * [getPanoraCoreEvents](#getpanoracoreevents) - List Events @@ -28,7 +30,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -68,10 +69,10 @@ run(); | `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.EventResponse[]](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index 077f283e..e11a421e 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -1,6 +1,8 @@ # Expenses (*accounting.expenses*) +## Overview + ### Available Operations * [list](#list) - List Expenses @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingExpenseResponse](../../models/operations/listaccountingexpenseresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Expenses in any supported Accounting software @@ -148,7 +150,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -221,16 +222,17 @@ run(); | `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.UnifiedAccountingExpenseOutput](../../models/components/unifiedaccountingexpenseoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Expenses from any connected Accounting software @@ -258,7 +260,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -302,10 +303,10 @@ run(); | `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.UnifiedAccountingExpenseOutput](../../models/components/unifiedaccountingexpenseoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/fieldmappings/README.md b/docs/sdks/fieldmappings/README.md index bd57b0b6..09288697 100644 --- a/docs/sdks/fieldmappings/README.md +++ b/docs/sdks/fieldmappings/README.md @@ -1,6 +1,8 @@ # FieldMappings (*fieldMappings*) +## Overview + ### Available Operations * [getFieldMappingValues](#getfieldmappingvalues) - Retrieve field mappings values @@ -32,7 +34,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -70,16 +71,17 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## getFieldMappingsEntities Retrieve field mapping entities @@ -102,7 +104,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -140,16 +141,17 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## getFieldMappings Retrieve field mappings @@ -172,7 +174,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -210,16 +211,17 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## definitions Define target Field @@ -249,7 +251,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -295,16 +296,17 @@ run(); | `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 Create Custom Field @@ -337,7 +339,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -386,16 +387,17 @@ run(); | `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 | */* | + ## map Map Custom Field @@ -424,7 +426,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -469,10 +470,10 @@ run(); | `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 | diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md index 4aa0201c..286ef8d7 100644 --- a/docs/sdks/files/README.md +++ b/docs/sdks/files/README.md @@ -1,6 +1,8 @@ # Files (*filestorage.files*) +## Overview + ### Available Operations * [list](#list) - List Files @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListFilestorageFileResponse](../../models/operations/listfilestoragefileresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Files in any supported Filestorage software @@ -131,7 +133,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -187,16 +188,17 @@ run(); | `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.UnifiedFilestorageFileOutput](../../models/components/unifiedfilestoragefileoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Files from any connected Filestorage software @@ -224,7 +226,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -268,10 +269,10 @@ run(); | `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.UnifiedFilestorageFileOutput](../../models/components/unifiedfilestoragefileoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/filestorage/README.md b/docs/sdks/filestorage/README.md index 897b31d3..c56de610 100644 --- a/docs/sdks/filestorage/README.md +++ b/docs/sdks/filestorage/README.md @@ -1,5 +1,2 @@ # Filestorage -(*filestorage*) - -### Available Operations - +(*filestorage*) \ No newline at end of file diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md index cbab1a9c..117fb12a 100644 --- a/docs/sdks/folders/README.md +++ b/docs/sdks/folders/README.md @@ -1,6 +1,8 @@ # Folders (*filestorage.folders*) +## Overview + ### Available Operations * [list](#list) - List Folders @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListFilestorageFolderResponse](../../models/operations/listfilestoragefolderresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Folders in any supported Filestorage software @@ -132,7 +134,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -189,16 +190,17 @@ run(); | `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.UnifiedFilestorageFolderOutput](../../models/components/unifiedfilestoragefolderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Folders from any connected Filestorage software @@ -226,7 +228,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -270,10 +271,10 @@ run(); | `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.UnifiedFilestorageFolderOutput](../../models/components/unifiedfilestoragefolderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/fulfillments/README.md b/docs/sdks/fulfillments/README.md index f6833254..36b8a936 100644 --- a/docs/sdks/fulfillments/README.md +++ b/docs/sdks/fulfillments/README.md @@ -1,6 +1,8 @@ # Fulfillments (*ecommerce.fulfillments*) +## Overview + ### Available Operations * [list](#list) - List Fulfillments @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListEcommerceFulfillmentsResponse](../../models/operations/listecommercefulfillmentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve fulfillments from any connected Ats software @@ -117,7 +119,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -160,10 +161,10 @@ run(); | `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.UnifiedEcommerceFulfillmentOutput](../../models/components/unifiedecommercefulfillmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/groups/README.md b/docs/sdks/groups/README.md index fb61b514..5b8d0af7 100644 --- a/docs/sdks/groups/README.md +++ b/docs/sdks/groups/README.md @@ -1,6 +1,8 @@ # Groups (*hris.groups*) +## Overview + ### Available Operations * [list](#list) - List Groups @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisGroupsResponse](../../models/operations/listhrisgroupsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Group from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisGroupOutput](../../models/components/unifiedhrisgroupoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/hris/README.md b/docs/sdks/hris/README.md index 24d2539a..e556f5f6 100644 --- a/docs/sdks/hris/README.md +++ b/docs/sdks/hris/README.md @@ -1,5 +1,2 @@ # Hris -(*hris*) - -### Available Operations - +(*hris*) \ No newline at end of file diff --git a/docs/sdks/incomestatements/README.md b/docs/sdks/incomestatements/README.md index 3fb50f63..23c9870e 100644 --- a/docs/sdks/incomestatements/README.md +++ b/docs/sdks/incomestatements/README.md @@ -1,6 +1,8 @@ # Incomestatements (*accounting.incomestatements*) +## Overview + ### Available Operations * [list](#list) - List IncomeStatements @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingIncomeStatementResponse](../../models/operations/listaccountingincomestatementresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Income Statements from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingIncomestatementOutput](../../models/components/unifiedaccountingincomestatementoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/interviews/README.md b/docs/sdks/interviews/README.md index b3979e4c..4fdcd304 100644 --- a/docs/sdks/interviews/README.md +++ b/docs/sdks/interviews/README.md @@ -1,6 +1,8 @@ # Interviews (*ats.interviews*) +## Overview + ### Available Operations * [list](#list) - List Interviews @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAtsInterviewResponse](../../models/operations/listatsinterviewresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Interviews in any supported Ats software @@ -137,7 +139,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -199,16 +200,17 @@ run(); | `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.UnifiedAtsInterviewOutput](../../models/components/unifiedatsinterviewoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Interviews from any connected Ats software @@ -236,7 +238,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -280,10 +281,10 @@ run(); | `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.UnifiedAtsInterviewOutput](../../models/components/unifiedatsinterviewoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index 63b60d27..f79d4a4e 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -1,6 +1,8 @@ # Invoices (*accounting.invoices*) +## Overview + ### Available Operations * [list](#list) - List Invoices @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingInvoiceResponse](../../models/operations/listaccountinginvoiceresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create invoices in any supported Accounting software @@ -155,7 +157,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -235,16 +236,17 @@ run(); | `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.UnifiedAccountingInvoiceOutput](../../models/components/unifiedaccountinginvoiceoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Invoices from any connected Accounting software @@ -272,7 +274,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -316,10 +317,10 @@ run(); | `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.UnifiedAccountingInvoiceOutput](../../models/components/unifiedaccountinginvoiceoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/items/README.md b/docs/sdks/items/README.md index 0a399f72..7dcda920 100644 --- a/docs/sdks/items/README.md +++ b/docs/sdks/items/README.md @@ -1,6 +1,8 @@ # Items (*accounting.items*) +## Overview + ### Available Operations * [list](#list) - List Items @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingItemResponse](../../models/operations/listaccountingitemresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Items from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingItemOutput](../../models/components/unifiedaccountingitemoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/jobinterviewstages/README.md b/docs/sdks/jobinterviewstages/README.md index 216b63c1..d90f69ca 100644 --- a/docs/sdks/jobinterviewstages/README.md +++ b/docs/sdks/jobinterviewstages/README.md @@ -1,6 +1,8 @@ # Jobinterviewstages (*ats.jobinterviewstages*) +## Overview + ### Available Operations * [list](#list) - List JobInterviewStages @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsJobInterviewStageResponse](../../models/operations/listatsjobinterviewstageresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Job Interview Stages from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsJobinterviewstageOutput](../../models/components/unifiedatsjobinterviewstageoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index 0ccab082..4095c3d7 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -1,6 +1,8 @@ # Jobs (*ats.jobs*) +## Overview + ### Available Operations * [list](#list) - List Jobs @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsJobResponse](../../models/operations/listatsjobresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Jobs from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsJobOutput](../../models/components/unifiedatsjoboutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index b9c9a89a..2ed66371 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -1,6 +1,8 @@ # Journalentries (*accounting.journalentries*) +## Overview + ### Available Operations * [list](#list) - List JournalEntrys @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingJournalEntryResponse](../../models/operations/listaccountingjournalentryresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Journal Entries in any supported Accounting software @@ -154,7 +156,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -233,16 +234,17 @@ run(); | `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.UnifiedAccountingJournalentryOutput](../../models/components/unifiedaccountingjournalentryoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Journal Entries from any connected Accounting software @@ -270,7 +272,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -314,10 +315,10 @@ run(); | `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.UnifiedAccountingJournalentryOutput](../../models/components/unifiedaccountingjournalentryoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/linkedusers/README.md b/docs/sdks/linkedusers/README.md index 9af107de..6cd6f3f4 100644 --- a/docs/sdks/linkedusers/README.md +++ b/docs/sdks/linkedusers/README.md @@ -1,6 +1,8 @@ # LinkedUsers (*linkedUsers*) +## Overview + ### Available Operations * [create](#create) - Create Linked Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -78,16 +79,17 @@ run(); | `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 | */* | + ## list List Linked Users @@ -111,7 +113,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -150,16 +151,17 @@ run(); | `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 | */* | + ## importBatch Add Batch Linked Users @@ -188,7 +190,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -233,16 +234,17 @@ run(); | `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 @@ -268,7 +270,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -310,16 +311,17 @@ run(); | `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 @@ -345,7 +347,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -387,10 +388,10 @@ run(); | `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 | diff --git a/docs/sdks/lists/README.md b/docs/sdks/lists/README.md index cdfbf058..de0b6e6b 100644 --- a/docs/sdks/lists/README.md +++ b/docs/sdks/lists/README.md @@ -1,6 +1,8 @@ # Lists (*marketingautomation.lists*) +## Overview + ### Available Operations * [list](#list) - List Lists @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingautomationListsResponse](../../models/operations/listmarketingautomationlistsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Lists in any supported Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -161,16 +162,17 @@ run(); | `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.UnifiedMarketingautomationListOutput](../../models/components/unifiedmarketingautomationlistoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a List from any connected Marketingautomation software @@ -198,7 +200,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -242,10 +243,10 @@ run(); | `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.UnifiedMarketingautomationListOutput](../../models/components/unifiedmarketingautomationlistoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/locations/README.md b/docs/sdks/locations/README.md index 3e0dfc42..381e58b8 100644 --- a/docs/sdks/locations/README.md +++ b/docs/sdks/locations/README.md @@ -1,6 +1,8 @@ # Locations (*hris.locations*) +## Overview + ### Available Operations * [list](#list) - List Locations @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisLocationsResponse](../../models/operations/listhrislocationsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Location from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisLocationOutput](../../models/components/unifiedhrislocationoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/login/README.md b/docs/sdks/login/README.md index 56b7fd60..96f26f2f 100644 --- a/docs/sdks/login/README.md +++ b/docs/sdks/login/README.md @@ -1,6 +1,8 @@ # Login (*auth.login*) +## Overview + ### Available Operations * [signIn](#signin) - Log In @@ -30,7 +32,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -72,10 +73,10 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/marketingautomation/README.md b/docs/sdks/marketingautomation/README.md index 7b6229fc..ee289d06 100644 --- a/docs/sdks/marketingautomation/README.md +++ b/docs/sdks/marketingautomation/README.md @@ -1,5 +1,2 @@ # Marketingautomation -(*marketingautomation*) - -### Available Operations - +(*marketingautomation*) \ No newline at end of file diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index eae840f0..912a1135 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -1,6 +1,8 @@ # Messages (*marketingautomation.messages*) +## Overview + ### Available Operations * [list](#list) - List Messages @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListMarketingautomationMessagesResponse](../../models/operations/listmarketingautomationmessagesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Messages from any connected Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedMarketingautomationMessageOutput](../../models/components/unifiedmarketingautomationmessageoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/notes/README.md b/docs/sdks/notes/README.md index 53f9a3a6..6d969202 100644 --- a/docs/sdks/notes/README.md +++ b/docs/sdks/notes/README.md @@ -1,6 +1,8 @@ # Notes (*crm.notes*) +## Overview + ### Available Operations * [list](#list) - List Notes @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmNoteResponse](../../models/operations/listcrmnoteresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Notes in any supported Crm software @@ -129,7 +131,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -183,16 +184,17 @@ run(); | `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.UnifiedCrmNoteOutput](../../models/components/unifiedcrmnoteoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Notes from any connected Crm software @@ -220,7 +222,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -264,10 +265,10 @@ run(); | `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.UnifiedCrmNoteOutput](../../models/components/unifiedcrmnoteoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/offers/README.md b/docs/sdks/offers/README.md index 52d7404c..eb65c817 100644 --- a/docs/sdks/offers/README.md +++ b/docs/sdks/offers/README.md @@ -1,6 +1,8 @@ # Offers (*ats.offers*) +## Overview + ### Available Operations * [list](#list) - List Offers @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsOfferResponse](../../models/operations/listatsofferresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Offers from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsOfferOutput](../../models/components/unifiedatsofferoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/offices/README.md b/docs/sdks/offices/README.md index 32e30f01..3fc4cdc3 100644 --- a/docs/sdks/offices/README.md +++ b/docs/sdks/offices/README.md @@ -1,6 +1,8 @@ # Offices (*ats.offices*) +## Overview + ### Available Operations * [list](#list) - List Offices @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsOfficeResponse](../../models/operations/listatsofficeresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Offices from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsOfficeOutput](../../models/components/unifiedatsofficeoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index b03fd539..9b3bfecc 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -1,6 +1,8 @@ # Orders (*ecommerce.orders*) +## Overview + ### Available Operations * [list](#list) - List Orders @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListEcommerceOrdersResponse](../../models/operations/listecommerceordersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Orders in any supported Ecommerce software @@ -150,7 +152,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -225,16 +226,17 @@ run(); | `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.UnifiedEcommerceOrderOutput](../../models/components/unifiedecommerceorderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve orders from any connected Ats software @@ -261,7 +263,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -304,10 +305,10 @@ run(); | `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.UnifiedEcommerceOrderOutput](../../models/components/unifiedecommerceorderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panora/README.md b/docs/sdks/panora/README.md index 259ce377..1ae98ca8 100644 --- a/docs/sdks/panora/README.md +++ b/docs/sdks/panora/README.md @@ -1,6 +1,5 @@ # Panora SDK - ## Overview Panora API: A unified API to ship integrations @@ -31,7 +30,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -70,16 +68,17 @@ run(); | `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\<[string](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## health ### Example Usage @@ -101,7 +100,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -140,10 +138,10 @@ run(); | `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\<[number](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraaccountingcontacts/README.md b/docs/sdks/panoraaccountingcontacts/README.md index 62b9073a..6846ca00 100644 --- a/docs/sdks/panoraaccountingcontacts/README.md +++ b/docs/sdks/panoraaccountingcontacts/README.md @@ -1,6 +1,8 @@ # PanoraAccountingContacts (*accounting.contacts*) +## Overview + ### Available Operations * [list](#list) - List Contacts @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingContactsResponse](../../models/operations/listaccountingcontactsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create contacts in any supported Accounting software @@ -131,7 +133,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -187,16 +188,17 @@ run(); | `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.UnifiedAccountingContactOutput](../../models/components/unifiedaccountingcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Contacts from any connected Accounting software @@ -224,7 +226,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -268,10 +269,10 @@ run(); | `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.UnifiedAccountingContactOutput](../../models/components/unifiedaccountingcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraaccounts/README.md b/docs/sdks/panoraaccounts/README.md index 6377a6c9..8b7c1654 100644 --- a/docs/sdks/panoraaccounts/README.md +++ b/docs/sdks/panoraaccounts/README.md @@ -1,6 +1,8 @@ # PanoraAccounts (*accounting.accounts*) +## Overview + ### Available Operations * [list](#list) - List Accounts @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingAccountsResponse](../../models/operations/listaccountingaccountsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create accounts in any supported Accounting software @@ -132,7 +134,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -189,16 +190,17 @@ run(); | `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.UnifiedAccountingAccountOutput](../../models/components/unifiedaccountingaccountoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Accounts from any connected Accounting software @@ -226,7 +228,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -270,10 +271,10 @@ run(); | `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.UnifiedAccountingAccountOutput](../../models/components/unifiedaccountingaccountoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraatsusers/README.md b/docs/sdks/panoraatsusers/README.md index ab30a13a..ca17cd95 100644 --- a/docs/sdks/panoraatsusers/README.md +++ b/docs/sdks/panoraatsusers/README.md @@ -1,6 +1,8 @@ # PanoraAtsUsers (*ats.users*) +## Overview + ### Available Operations * [list](#list) - List Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsUsersResponse](../../models/operations/listatsusersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Users from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsUserOutput](../../models/components/unifiedatsuseroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraattachments/README.md b/docs/sdks/panoraattachments/README.md index 8eacaeaf..6a7ba4c4 100644 --- a/docs/sdks/panoraattachments/README.md +++ b/docs/sdks/panoraattachments/README.md @@ -1,6 +1,8 @@ # PanoraAttachments (*accounting.attachments*) +## Overview + ### Available Operations * [list](#list) - List Attachments @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingAttachmentsResponse](../../models/operations/listaccountingattachmentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create attachments in any supported Accounting software @@ -124,7 +126,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -173,16 +174,17 @@ run(); | `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.UnifiedAccountingAttachmentOutput](../../models/components/unifiedaccountingattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve attachments from any connected Accounting software @@ -210,7 +212,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -254,10 +255,10 @@ run(); | `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.UnifiedAccountingAttachmentOutput](../../models/components/unifiedaccountingattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoracompanies/README.md b/docs/sdks/panoracompanies/README.md index 8ab5976a..015c8d3f 100644 --- a/docs/sdks/panoracompanies/README.md +++ b/docs/sdks/panoracompanies/README.md @@ -1,6 +1,8 @@ # PanoraCompanies (*hris.companies*) +## Overview + ### Available Operations * [list](#list) - List Companies @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisCompaniesResponse](../../models/operations/listhriscompaniesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Company from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisCompanyOutput](../../models/components/unifiedhriscompanyoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoracontacts/README.md b/docs/sdks/panoracontacts/README.md index d1233176..6b1d29cb 100644 --- a/docs/sdks/panoracontacts/README.md +++ b/docs/sdks/panoracontacts/README.md @@ -1,6 +1,8 @@ # PanoraContacts (*crm.contacts*) +## Overview + ### Available Operations * [list](#list) - List CRM Contacts @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmContactsResponse](../../models/operations/listcrmcontactsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Contacts in any supported CRM @@ -152,7 +154,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -229,16 +230,17 @@ run(); | `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.UnifiedCrmContactOutput](../../models/components/unifiedcrmcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Contacts from any connected CRM @@ -266,7 +268,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -310,10 +311,10 @@ run(); | `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.UnifiedCrmContactOutput](../../models/components/unifiedcrmcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraevents/README.md b/docs/sdks/panoraevents/README.md index 7de34543..58b2fe06 100644 --- a/docs/sdks/panoraevents/README.md +++ b/docs/sdks/panoraevents/README.md @@ -1,6 +1,8 @@ # PanoraEvents (*marketingautomation.events*) +## Overview + ### Available Operations * [list](#list) - List Events @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListMarketingAutomationEventsResponse](../../models/operations/listmarketingautomationeventsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Event from any connected Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedMarketingautomationEventOutput](../../models/components/unifiedmarketingautomationeventoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panorafilestorageusers/README.md b/docs/sdks/panorafilestorageusers/README.md index 0ae4fbb8..17382a39 100644 --- a/docs/sdks/panorafilestorageusers/README.md +++ b/docs/sdks/panorafilestorageusers/README.md @@ -1,6 +1,8 @@ # PanoraFilestorageUsers (*filestorage.users*) +## Overview + ### Available Operations * [list](#list) - List Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListFilestorageUsersResponse](../../models/operations/listfilestorageusersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Users from any connected Filestorage software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedFilestorageUserOutput](../../models/components/unifiedfilestorageuseroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoragroups/README.md b/docs/sdks/panoragroups/README.md index 888ae660..4f510ddb 100644 --- a/docs/sdks/panoragroups/README.md +++ b/docs/sdks/panoragroups/README.md @@ -1,6 +1,8 @@ # PanoraGroups (*filestorage.groups*) +## Overview + ### Available Operations * [list](#list) - List Groups @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListFilestorageGroupResponse](../../models/operations/listfilestoragegroupresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Groups from any connected Filestorage software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedFilestorageGroupOutput](../../models/components/unifiedfilestoragegroupoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoramarketingautomationcontacts/README.md b/docs/sdks/panoramarketingautomationcontacts/README.md index d6420340..19e6064a 100644 --- a/docs/sdks/panoramarketingautomationcontacts/README.md +++ b/docs/sdks/panoramarketingautomationcontacts/README.md @@ -1,6 +1,8 @@ # PanoraMarketingautomationContacts (*marketingautomation.contacts*) +## Overview + ### Available Operations * [list](#list) - List Contacts @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingAutomationContactsResponse](../../models/operations/listmarketingautomationcontactsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a contact in any supported Marketingautomation software @@ -119,7 +121,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -163,16 +164,17 @@ run(); | `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.UnifiedMarketingautomationContactOutput](../../models/components/unifiedmarketingautomationcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Contacts from any connected Marketingautomation software @@ -200,7 +202,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -244,10 +245,10 @@ run(); | `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.UnifiedMarketingautomationContactOutput](../../models/components/unifiedmarketingautomationcontactoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoramarketingautomationusers/README.md b/docs/sdks/panoramarketingautomationusers/README.md index d696612e..452cafc7 100644 --- a/docs/sdks/panoramarketingautomationusers/README.md +++ b/docs/sdks/panoramarketingautomationusers/README.md @@ -1,6 +1,8 @@ # PanoraMarketingautomationUsers (*marketingautomation.users*) +## Overview + ### Available Operations * [list](#list) - List Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListMarketingAutomationUsersResponse](../../models/operations/listmarketingautomationusersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Users from any connected Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedMarketingautomationUserOutput](../../models/components/unifiedmarketingautomationuseroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoratags/README.md b/docs/sdks/panoratags/README.md index 19f3bed8..4b2640b4 100644 --- a/docs/sdks/panoratags/README.md +++ b/docs/sdks/panoratags/README.md @@ -1,6 +1,8 @@ # PanoraTags (*ats.tags*) +## Overview + ### Available Operations * [list](#list) - List Tags @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsTagsResponse](../../models/operations/listatstagsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Tags from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsTagOutput](../../models/components/unifiedatstagoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoraticketingattachments/README.md b/docs/sdks/panoraticketingattachments/README.md index abe492ff..b4938146 100644 --- a/docs/sdks/panoraticketingattachments/README.md +++ b/docs/sdks/panoraticketingattachments/README.md @@ -1,6 +1,8 @@ # PanoraTicketingAttachments (*ticketing.attachments*) +## Overview + ### Available Operations * [list](#list) - List Attachments @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListTicketingAttachmentsResponse](../../models/operations/listticketingattachmentsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Attachments in any supported Ticketing software @@ -128,7 +130,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -181,16 +182,17 @@ run(); | `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.UnifiedTicketingAttachmentOutput](../../models/components/unifiedticketingattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Attachments from any connected Ticketing software @@ -218,7 +220,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -262,10 +263,10 @@ run(); | `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.UnifiedTicketingAttachmentOutput](../../models/components/unifiedticketingattachmentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panorausers/README.md b/docs/sdks/panorausers/README.md index 5d7d1f4c..a9280a17 100644 --- a/docs/sdks/panorausers/README.md +++ b/docs/sdks/panorausers/README.md @@ -1,6 +1,8 @@ # PanoraUsers (*crm.users*) +## Overview + ### Available Operations * [list](#list) - List Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListCrmUsersResponse](../../models/operations/listcrmusersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Users from any connected Crm software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedCrmUserOutput](../../models/components/unifiedcrmuseroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/passthrough/README.md b/docs/sdks/passthrough/README.md index 5e13b245..1803a061 100644 --- a/docs/sdks/passthrough/README.md +++ b/docs/sdks/passthrough/README.md @@ -1,6 +1,8 @@ # Passthrough (*passthrough*) +## Overview + ### Available Operations * [request](#request) - Make a passthrough request @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,10 +83,10 @@ run(); | `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\<[operations.RequestResponseBody](../../models/operations/requestresponsebody.md)\>** +**Promise\<[operations.RequestResponse](../../models/operations/requestresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/paygroups/README.md b/docs/sdks/paygroups/README.md index 6073341c..526c1418 100644 --- a/docs/sdks/paygroups/README.md +++ b/docs/sdks/paygroups/README.md @@ -1,6 +1,8 @@ # Paygroups (*hris.paygroups*) +## Overview + ### Available Operations * [list](#list) - List Pay Groups @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisPaygroupsResponse](../../models/operations/listhrispaygroupsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Pay Group from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisPaygroupOutput](../../models/components/unifiedhrispaygroupoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index 49811f34..97114ee7 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -1,6 +1,8 @@ # Payments (*accounting.payments*) +## Overview + ### Available Operations * [list](#list) - List Payments @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingPaymentResponse](../../models/operations/listaccountingpaymentresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Payments in any supported Accounting software @@ -148,7 +150,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -221,16 +222,17 @@ run(); | `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.UnifiedAccountingPaymentOutput](../../models/components/unifiedaccountingpaymentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Payments from any connected Accounting software @@ -258,7 +260,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -302,10 +303,10 @@ run(); | `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.UnifiedAccountingPaymentOutput](../../models/components/unifiedaccountingpaymentoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/payrollruns/README.md b/docs/sdks/payrollruns/README.md index 6aaf396c..3fe55a79 100644 --- a/docs/sdks/payrollruns/README.md +++ b/docs/sdks/payrollruns/README.md @@ -1,6 +1,8 @@ # Payrollruns (*hris.payrollruns*) +## Overview + ### Available Operations * [list](#list) - List Payroll Runs @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisPayrollRunsResponse](../../models/operations/listhrispayrollrunsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Payroll Run from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisPayrollrunOutput](../../models/components/unifiedhrispayrollrunoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/phonenumbers/README.md b/docs/sdks/phonenumbers/README.md index 3d8f2ce0..3826277d 100644 --- a/docs/sdks/phonenumbers/README.md +++ b/docs/sdks/phonenumbers/README.md @@ -1,6 +1,8 @@ # Phonenumbers (*accounting.phonenumbers*) +## Overview + ### Available Operations * [list](#list) - List PhoneNumbers @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingPhonenumberResponse](../../models/operations/listaccountingphonenumberresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Phone Numbers from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingPhonenumberOutput](../../models/components/unifiedaccountingphonenumberoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/products/README.md b/docs/sdks/products/README.md index ff782f98..3a55ac4e 100644 --- a/docs/sdks/products/README.md +++ b/docs/sdks/products/README.md @@ -1,6 +1,8 @@ # Products (*ecommerce.products*) +## Overview + ### Available Operations * [list](#list) - List Products @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListEcommerceProductsResponse](../../models/operations/listecommerceproductsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Products in any supported Ecommerce software @@ -136,7 +138,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -197,16 +198,17 @@ run(); | `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.UnifiedEcommerceProductOutput](../../models/components/unifiedecommerceproductoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve products from any connected Ats software @@ -233,7 +235,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -276,10 +277,10 @@ run(); | `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.UnifiedEcommerceProductOutput](../../models/components/unifiedecommerceproductoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/projects/README.md b/docs/sdks/projects/README.md index 099b4a52..f849d3ec 100644 --- a/docs/sdks/projects/README.md +++ b/docs/sdks/projects/README.md @@ -1,6 +1,8 @@ # Projects (*projects*) +## Overview + ### Available Operations * [getProjects](#getprojects) - Retrieve projects @@ -29,7 +31,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -68,16 +69,17 @@ run(); | `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.ProjectResponse[]](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a project @@ -105,7 +107,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -149,10 +150,10 @@ run(); | `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.ProjectResponse](../../models/components/projectresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index ad2ad6d0..fc40e84f 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -1,6 +1,8 @@ # Purchaseorders (*accounting.purchaseorders*) +## Overview + ### Available Operations * [list](#list) - List PurchaseOrders @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListAccountingPurchaseOrderResponse](../../models/operations/listaccountingpurchaseorderresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Purchase Orders in any supported Accounting software @@ -151,7 +153,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -227,16 +228,17 @@ run(); | `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.UnifiedAccountingPurchaseorderOutput](../../models/components/unifiedaccountingpurchaseorderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Purchase Orders from any connected Accounting software @@ -264,7 +266,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -308,10 +309,10 @@ run(); | `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.UnifiedAccountingPurchaseorderOutput](../../models/components/unifiedaccountingpurchaseorderoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/rejectreasons/README.md b/docs/sdks/rejectreasons/README.md index 9f89d256..6dbba3d7 100644 --- a/docs/sdks/rejectreasons/README.md +++ b/docs/sdks/rejectreasons/README.md @@ -1,6 +1,8 @@ # Rejectreasons (*ats.rejectreasons*) +## Overview + ### Available Operations * [list](#list) - List RejectReasons @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsRejectReasonsResponse](../../models/operations/listatsrejectreasonsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Reject Reasons from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsRejectreasonOutput](../../models/components/unifiedatsrejectreasonoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/retryid/README.md b/docs/sdks/retryid/README.md index affb24f7..28e32832 100644 --- a/docs/sdks/retryid/README.md +++ b/docs/sdks/retryid/README.md @@ -1,6 +1,8 @@ # Retryid (*passthrough.retryid*) +## Overview + ### Available Operations * [getRetriedRequestResponse](#getretriedrequestresponse) - Retrieve response of a failed passthrough request due to rate limits @@ -29,7 +31,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -70,10 +71,10 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/scorecards/README.md b/docs/sdks/scorecards/README.md index abcffd65..66932da9 100644 --- a/docs/sdks/scorecards/README.md +++ b/docs/sdks/scorecards/README.md @@ -1,6 +1,8 @@ # Scorecards (*ats.scorecards*) +## Overview + ### Available Operations * [list](#list) - List ScoreCards @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAtsScorecardResponse](../../models/operations/listatsscorecardresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Score Cards from any connected Ats software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAtsScorecardOutput](../../models/components/unifiedatsscorecardoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/stages/README.md b/docs/sdks/stages/README.md index 100f0076..400a5843 100644 --- a/docs/sdks/stages/README.md +++ b/docs/sdks/stages/README.md @@ -1,6 +1,8 @@ # Stages (*crm.stages*) +## Overview + ### Available Operations * [list](#list) - List Stages @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListCrmStagesResponse](../../models/operations/listcrmstagesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Stages from any connected Crm software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedCrmStageOutput](../../models/components/unifiedcrmstageoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/sync/README.md b/docs/sdks/sync/README.md index 645761a3..60526112 100644 --- a/docs/sdks/sync/README.md +++ b/docs/sdks/sync/README.md @@ -1,6 +1,8 @@ # Sync (*sync*) +## Overview + ### Available Operations * [status](#status) - Retrieve sync status of a certain vertical @@ -31,7 +33,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -73,16 +74,17 @@ run(); | `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\** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## resync Resync common objects across a vertical @@ -106,7 +108,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -145,10 +146,10 @@ run(); | `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.ResyncStatusDto](../../models/components/resyncstatusdto.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/tags/README.md b/docs/sdks/tags/README.md index 767f8742..cb29fd38 100644 --- a/docs/sdks/tags/README.md +++ b/docs/sdks/tags/README.md @@ -1,6 +1,8 @@ # Tags (*ticketing.tags*) +## Overview + ### Available Operations * [list](#list) - List Tags @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingTagsResponse](../../models/operations/listticketingtagsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Tag from any connected Ticketing software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedTicketingTagOutput](../../models/components/unifiedticketingtagoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/tasks/README.md b/docs/sdks/tasks/README.md index 124c1ec6..6070cfce 100644 --- a/docs/sdks/tasks/README.md +++ b/docs/sdks/tasks/README.md @@ -1,6 +1,8 @@ # Tasks (*crm.tasks*) +## Overview + ### Available Operations * [list](#list) - List Tasks @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListCrmTaskResponse](../../models/operations/listcrmtaskresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Tasks in any supported Crm software @@ -132,7 +134,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -189,16 +190,17 @@ run(); | `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.UnifiedCrmTaskOutput](../../models/components/unifiedcrmtaskoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Tasks from any connected Crm software @@ -226,7 +228,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -270,10 +271,10 @@ run(); | `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.UnifiedCrmTaskOutput](../../models/components/unifiedcrmtaskoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/taxrates/README.md b/docs/sdks/taxrates/README.md index e53af382..ea081f7f 100644 --- a/docs/sdks/taxrates/README.md +++ b/docs/sdks/taxrates/README.md @@ -1,6 +1,8 @@ # Taxrates (*accounting.taxrates*) +## Overview + ### Available Operations * [list](#list) - List TaxRates @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingTaxRateResponse](../../models/operations/listaccountingtaxrateresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Tax Rates from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingTaxrateOutput](../../models/components/unifiedaccountingtaxrateoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/teams/README.md b/docs/sdks/teams/README.md index 5456da2e..00da59ac 100644 --- a/docs/sdks/teams/README.md +++ b/docs/sdks/teams/README.md @@ -1,6 +1,8 @@ # Teams (*ticketing.teams*) +## Overview + ### Available Operations * [list](#list) - List Teams @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingTeamsResponse](../../models/operations/listticketingteamsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Teams from any connected Ticketing software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedTicketingTeamOutput](../../models/components/unifiedticketingteamoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/templates/README.md b/docs/sdks/templates/README.md index 60fa4492..f218565c 100644 --- a/docs/sdks/templates/README.md +++ b/docs/sdks/templates/README.md @@ -1,6 +1,8 @@ # Templates (*marketingautomation.templates*) +## Overview + ### Available Operations * [list](#list) - List Templates @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListMarketingautomationTemplatesResponse](../../models/operations/listmarketingautomationtemplatesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create a template in any supported Marketingautomation software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -161,16 +162,17 @@ run(); | `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.UnifiedMarketingautomationTemplateOutput](../../models/components/unifiedmarketingautomationtemplateoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Template from any connected Marketingautomation software @@ -198,7 +200,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -242,10 +243,10 @@ run(); | `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.UnifiedMarketingautomationTemplateOutput](../../models/components/unifiedmarketingautomationtemplateoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/ticketing/README.md b/docs/sdks/ticketing/README.md index 3d162c27..37b71032 100644 --- a/docs/sdks/ticketing/README.md +++ b/docs/sdks/ticketing/README.md @@ -1,5 +1,2 @@ # Ticketing -(*ticketing*) - -### Available Operations - +(*ticketing*) \ No newline at end of file diff --git a/docs/sdks/tickets/README.md b/docs/sdks/tickets/README.md index 3b2c0c08..dc572339 100644 --- a/docs/sdks/tickets/README.md +++ b/docs/sdks/tickets/README.md @@ -1,6 +1,8 @@ # Tickets (*ticketing.tickets*) +## Overview + ### Available Operations * [list](#list) - List Tickets @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListTicketingTicketResponse](../../models/operations/listticketingticketresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Tickets in any supported Ticketing software @@ -165,7 +167,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -255,16 +256,17 @@ run(); | `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.UnifiedTicketingTicketOutput](../../models/components/unifiedticketingticketoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Tickets from any connected Ticketing software @@ -292,7 +294,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -336,10 +337,10 @@ run(); | `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.UnifiedTicketingTicketOutput](../../models/components/unifiedticketingticketoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/timeoffbalances/README.md b/docs/sdks/timeoffbalances/README.md index f185f358..0820fb06 100644 --- a/docs/sdks/timeoffbalances/README.md +++ b/docs/sdks/timeoffbalances/README.md @@ -1,6 +1,8 @@ # Timeoffbalances (*hris.timeoffbalances*) +## Overview + ### Available Operations * [list](#list) - List TimeoffBalances @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListHrisTimeoffbalancesResponse](../../models/operations/listhristimeoffbalancesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Time off Balances from any connected Hris software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedHrisTimeoffbalanceOutput](../../models/components/unifiedhristimeoffbalanceoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/timeoffs/README.md b/docs/sdks/timeoffs/README.md index 569a8208..04521f47 100644 --- a/docs/sdks/timeoffs/README.md +++ b/docs/sdks/timeoffs/README.md @@ -1,6 +1,8 @@ # Timeoffs (*hris.timeoffs*) +## Overview + ### Available Operations * [list](#list) - List Time Offs @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListHrisTimeoffsResponse](../../models/operations/listhristimeoffsresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Timeoffs in any supported Hris software @@ -134,7 +136,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -193,16 +194,17 @@ run(); | `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.UnifiedHrisTimeoffOutput](../../models/components/unifiedhristimeoffoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a Time Off from any connected Hris software @@ -230,7 +232,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -274,10 +275,10 @@ run(); | `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.UnifiedHrisTimeoffOutput](../../models/components/unifiedhristimeoffoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/timesheetentries/README.md b/docs/sdks/timesheetentries/README.md index 9644c2e7..4e547a48 100644 --- a/docs/sdks/timesheetentries/README.md +++ b/docs/sdks/timesheetentries/README.md @@ -1,6 +1,8 @@ # Timesheetentries (*hris.timesheetentries*) +## Overview + ### Available Operations * [list](#list) - List Timesheetentries @@ -36,7 +38,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -82,16 +83,17 @@ run(); | `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\<[operations.ListHrisTimesheetentriesResponse](../../models/operations/listhristimesheetentriesresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create Timesheetentrys in any supported Hris software @@ -125,7 +127,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -175,16 +176,17 @@ run(); | `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.UnifiedHrisTimesheetEntryOutput](../../models/components/unifiedhristimesheetentryoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve an Timesheetentry from any connected Hris software @@ -212,7 +214,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -256,10 +257,10 @@ run(); | `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.UnifiedHrisTimesheetEntryOutput](../../models/components/unifiedhristimesheetentryoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/trackingcategories/README.md b/docs/sdks/trackingcategories/README.md index 0500f231..ede8d2a3 100644 --- a/docs/sdks/trackingcategories/README.md +++ b/docs/sdks/trackingcategories/README.md @@ -1,6 +1,8 @@ # Trackingcategories (*accounting.trackingcategories*) +## Overview + ### Available Operations * [list](#list) - List TrackingCategorys @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingTrackingCategorysResponse](../../models/operations/listaccountingtrackingcategorysresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Tracking Categories from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingTrackingcategoryOutput](../../models/components/unifiedaccountingtrackingcategoryoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md index 364f16b5..5d732e82 100644 --- a/docs/sdks/transactions/README.md +++ b/docs/sdks/transactions/README.md @@ -1,6 +1,8 @@ # Transactions (*accounting.transactions*) +## Overview + ### Available Operations * [list](#list) - List Transactions @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingTransactionResponse](../../models/operations/listaccountingtransactionresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Transactions from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingTransactionOutput](../../models/components/unifiedaccountingtransactionoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index 02f62917..e4a5415a 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -1,6 +1,8 @@ # Users (*ticketing.users*) +## Overview + ### Available Operations * [list](#list) - List Users @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListTicketingUsersResponse](../../models/operations/listticketingusersresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve a User from any connected Ticketing software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedTicketingUserOutput](../../models/components/unifiedticketinguseroutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/vendorcredits/README.md b/docs/sdks/vendorcredits/README.md index ae3d85c0..38468b12 100644 --- a/docs/sdks/vendorcredits/README.md +++ b/docs/sdks/vendorcredits/README.md @@ -1,6 +1,8 @@ # Vendorcredits (*accounting.vendorcredits*) +## Overview + ### Available Operations * [list](#list) - List VendorCredits @@ -35,7 +37,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -81,16 +82,17 @@ run(); | `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\<[operations.ListAccountingVendorCreditResponse](../../models/operations/listaccountingvendorcreditresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## retrieve Retrieve Vendor Credits from any connected Accounting software @@ -118,7 +120,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -162,10 +163,10 @@ run(); | `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.UnifiedAccountingVendorcreditOutput](../../models/components/unifiedaccountingvendorcreditoutput.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/webhooks/README.md b/docs/sdks/webhooks/README.md index dee3d8f3..da01a1fa 100644 --- a/docs/sdks/webhooks/README.md +++ b/docs/sdks/webhooks/README.md @@ -1,6 +1,8 @@ # Webhooks (*webhooks*) +## Overview + ### Available Operations * [list](#list) - List webhooks @@ -32,7 +34,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -71,16 +72,17 @@ run(); | `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.WebhookResponse[]](../../models/.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## create Create webhook @@ -110,7 +112,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -156,16 +157,17 @@ run(); | `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.WebhookResponse](../../models/components/webhookresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## delete Delete Webhook @@ -191,7 +193,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -233,16 +234,17 @@ run(); | `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.WebhookResponse](../../models/components/webhookresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## updateStatus Update webhook status @@ -268,7 +270,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -310,16 +311,17 @@ run(); | `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.WebhookResponse](../../models/components/webhookresponse.md)\>** + ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + ## verifyEvent Verify payload signature of the webhook @@ -349,7 +351,6 @@ async function run() { run(); ``` - ### Standalone function The standalone function version of this method: @@ -395,10 +396,10 @@ run(); | `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\<[operations.VerifyEventResponseBody](../../models/operations/verifyeventresponsebody.md)\>** + ### Errors | Error Object | Status Code | Content Type | diff --git a/jsr.json b/jsr.json index db8e6acc..3c1d42f4 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@panora/sdk", - "version": "0.11.0", + "version": "0.12.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 00528d95..948d1617 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@panora/sdk", - "version": "0.11.0", + "version": "0.12.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@panora/sdk", - "version": "0.11.0", + "version": "0.12.0", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index 6eab5b0d..4726923a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@panora/sdk", - "version": "0.11.0", + "version": "0.12.0", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/passthroughRequest.ts b/src/funcs/passthroughRequest.ts index e497c03f..d8f72b14 100644 --- a/src/funcs/passthroughRequest.ts +++ b/src/funcs/passthroughRequest.ts @@ -30,7 +30,7 @@ export async function passthroughRequest( options?: RequestOptions ): Promise< Result< - operations.RequestResponseBody, + operations.RequestResponse, | SDKError | SDKValidationError | UnexpectedClientError @@ -102,7 +102,7 @@ export async function passthroughRequest( const response = doResult.value; const [result$] = await m$.match< - operations.RequestResponseBody, + operations.RequestResponse, | SDKError | SDKValidationError | UnexpectedClientError @@ -111,7 +111,8 @@ export async function passthroughRequest( | RequestTimeoutError | ConnectionError >( - m$.json(200, operations.RequestResponseBody$inboundSchema), + m$.json(200, operations.RequestResponse$inboundSchema), + m$.json(201, operations.RequestResponse$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); if (!result$.ok) { diff --git a/src/funcs/webhooksDelete.ts b/src/funcs/webhooksDelete.ts index af68d71e..55eb19fc 100644 --- a/src/funcs/webhooksDelete.ts +++ b/src/funcs/webhooksDelete.ts @@ -31,7 +31,7 @@ export async function webhooksDelete( options?: RequestOptions ): Promise< Result< - components.WebhookResponse, + components.WebhookResponse | undefined, | SDKError | SDKValidationError | UnexpectedClientError @@ -102,7 +102,7 @@ export async function webhooksDelete( const response = doResult.value; const [result$] = await m$.match< - components.WebhookResponse, + components.WebhookResponse | undefined, | SDKError | SDKValidationError | UnexpectedClientError @@ -111,7 +111,8 @@ export async function webhooksDelete( | RequestTimeoutError | ConnectionError >( - m$.json(201, components.WebhookResponse$inboundSchema), + m$.nil(200, components.WebhookResponse$inboundSchema.optional()), + m$.json(201, components.WebhookResponse$inboundSchema.optional()), m$.fail(["4XX", "5XX"]) )(response); if (!result$.ok) { diff --git a/src/funcs/webhooksUpdateStatus.ts b/src/funcs/webhooksUpdateStatus.ts index ea6a237f..35e4cc61 100644 --- a/src/funcs/webhooksUpdateStatus.ts +++ b/src/funcs/webhooksUpdateStatus.ts @@ -31,7 +31,7 @@ export async function webhooksUpdateStatus( options?: RequestOptions ): Promise< Result< - components.WebhookResponse, + components.WebhookResponse | undefined, | SDKError | SDKValidationError | UnexpectedClientError @@ -102,7 +102,7 @@ export async function webhooksUpdateStatus( const response = doResult.value; const [result$] = await m$.match< - components.WebhookResponse, + components.WebhookResponse | undefined, | SDKError | SDKValidationError | UnexpectedClientError @@ -111,7 +111,8 @@ export async function webhooksUpdateStatus( | RequestTimeoutError | ConnectionError >( - m$.json(201, components.WebhookResponse$inboundSchema), + m$.nil(200, components.WebhookResponse$inboundSchema.optional()), + m$.json(201, components.WebhookResponse$inboundSchema.optional()), m$.fail(["4XX", "5XX"]) )(response); if (!result$.ok) { diff --git a/src/funcs/webhooksVerifyEvent.ts b/src/funcs/webhooksVerifyEvent.ts index ee43f0a7..a6247845 100644 --- a/src/funcs/webhooksVerifyEvent.ts +++ b/src/funcs/webhooksVerifyEvent.ts @@ -108,7 +108,7 @@ export async function webhooksVerifyEvent( | RequestTimeoutError | ConnectionError >( - m$.json(200, operations.VerifyEventResponseBody$inboundSchema), + m$.json(201, operations.VerifyEventResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); if (!result$.ok) { diff --git a/src/lib/config.ts b/src/lib/config.ts index ad15ed96..95802582 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0", - sdkVersion: "0.11.0", - genVersion: "2.396.0", - userAgent: "speakeasy-sdk/typescript 0.11.0 2.396.0 1.0 @panora/sdk", + sdkVersion: "0.12.0", + genVersion: "2.404.3", + userAgent: "speakeasy-sdk/typescript 0.12.0 2.404.3 1.0 @panora/sdk", } as const; diff --git a/src/models/operations/request.ts b/src/models/operations/request.ts index 811b02cc..afcc44d2 100644 --- a/src/models/operations/request.ts +++ b/src/models/operations/request.ts @@ -11,8 +11,12 @@ export type RequestRequest = { passThroughRequestDto: components.PassThroughRequestDto; }; +export type RequestPassthroughResponseBody = {}; + export type RequestResponseBody = {}; +export type RequestResponse = RequestResponseBody | RequestPassthroughResponseBody; + /** @internal */ export const RequestRequest$inboundSchema: z.ZodType = z .object({ @@ -62,6 +66,36 @@ export namespace RequestRequest$ { export type Outbound = RequestRequest$Outbound; } +/** @internal */ +export const RequestPassthroughResponseBody$inboundSchema: z.ZodType< + RequestPassthroughResponseBody, + z.ZodTypeDef, + unknown +> = z.object({}); + +/** @internal */ +export type RequestPassthroughResponseBody$Outbound = {}; + +/** @internal */ +export const RequestPassthroughResponseBody$outboundSchema: z.ZodType< + RequestPassthroughResponseBody$Outbound, + z.ZodTypeDef, + RequestPassthroughResponseBody +> = z.object({}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace RequestPassthroughResponseBody$ { + /** @deprecated use `RequestPassthroughResponseBody$inboundSchema` instead. */ + export const inboundSchema = RequestPassthroughResponseBody$inboundSchema; + /** @deprecated use `RequestPassthroughResponseBody$outboundSchema` instead. */ + export const outboundSchema = RequestPassthroughResponseBody$outboundSchema; + /** @deprecated use `RequestPassthroughResponseBody$Outbound` instead. */ + export type Outbound = RequestPassthroughResponseBody$Outbound; +} + /** @internal */ export const RequestResponseBody$inboundSchema: z.ZodType< RequestResponseBody, @@ -91,3 +125,38 @@ export namespace RequestResponseBody$ { /** @deprecated use `RequestResponseBody$Outbound` instead. */ export type Outbound = RequestResponseBody$Outbound; } + +/** @internal */ +export const RequestResponse$inboundSchema: z.ZodType = + z.union([ + z.lazy(() => RequestResponseBody$inboundSchema), + z.lazy(() => RequestPassthroughResponseBody$inboundSchema), + ]); + +/** @internal */ +export type RequestResponse$Outbound = + | RequestResponseBody$Outbound + | RequestPassthroughResponseBody$Outbound; + +/** @internal */ +export const RequestResponse$outboundSchema: z.ZodType< + RequestResponse$Outbound, + z.ZodTypeDef, + RequestResponse +> = z.union([ + z.lazy(() => RequestResponseBody$outboundSchema), + z.lazy(() => RequestPassthroughResponseBody$outboundSchema), +]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace RequestResponse$ { + /** @deprecated use `RequestResponse$inboundSchema` instead. */ + export const inboundSchema = RequestResponse$inboundSchema; + /** @deprecated use `RequestResponse$outboundSchema` instead. */ + export const outboundSchema = RequestResponse$outboundSchema; + /** @deprecated use `RequestResponse$Outbound` instead. */ + export type Outbound = RequestResponse$Outbound; +} diff --git a/src/sdk/passthrough.ts b/src/sdk/passthrough.ts index f877f6f2..fefda54b 100644 --- a/src/sdk/passthrough.ts +++ b/src/sdk/passthrough.ts @@ -20,7 +20,7 @@ export class Passthrough extends ClientSDK { async request( request: operations.RequestRequest, options?: RequestOptions - ): Promise { + ): Promise { return unwrapAsync(passthroughRequest(this, request, options)); } } diff --git a/src/sdk/webhooks.ts b/src/sdk/webhooks.ts index 4ebaa4f5..5e311ab4 100644 --- a/src/sdk/webhooks.ts +++ b/src/sdk/webhooks.ts @@ -36,7 +36,7 @@ export class Webhooks extends ClientSDK { async delete( request: operations.DeleteRequest, options?: RequestOptions - ): Promise { + ): Promise { return unwrapAsync(webhooksDelete(this, request, options)); } @@ -46,7 +46,7 @@ export class Webhooks extends ClientSDK { async updateStatus( request: operations.UpdateStatusRequest, options?: RequestOptions - ): Promise { + ): Promise { return unwrapAsync(webhooksUpdateStatus(this, request, options)); }