diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 1173822d6..eac3d2422 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.352.1 +speakeasyVersion: 1.352.2 sources: merge-code-samples-into-spec: sourceNamespace: merge-code-samples-into-spec - sourceRevisionDigest: sha256:b5f8555fef788924b25df976ff97ec1aa496eb78c692f0a492c8e9bd8dd65476 - sourceBlobDigest: sha256:38fb5b85581de4dfe07fb4c98d63c3a97c14f558ac6565128c2ad9bacd955057 + sourceRevisionDigest: sha256:db736113333a8a50c1a5da0ad94204af6d4a900bafaf6a7e5056730047491b2c + sourceBlobDigest: sha256:a9a29203bb0cd45ae62a861549c49b1b73fd4fdc7300d1e9869e8e481eaaee9a tags: - latest - main diff --git a/packages/api/swagger/openapi-with-code-samples.yaml b/packages/api/swagger/openapi-with-code-samples.yaml index 8622e7f52..1d2e87b2f 100644 --- a/packages/api/swagger/openapi-with-code-samples.yaml +++ b/packages/api/swagger/openapi-with-code-samples.yaml @@ -19,7 +19,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -95,7 +95,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -175,7 +175,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -257,14 +257,15 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.create({ - url: "http://limp-pastry.org", + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", scope: [ - "", + "connection.created", ], }); @@ -337,11 +338,11 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: id of the webhook to delete. schema: type: string responses: - '200': - description: '' '201': description: '' content: @@ -357,12 +358,12 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.delete({ - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -422,11 +423,11 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: id of the webhook to update. schema: type: string responses: - '200': - description: '' '201': description: '' content: @@ -442,12 +443,12 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.updateStatus({ - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -522,8 +523,6 @@ paths: type: object additionalProperties: true description: Dynamic event payload - '201': - description: '' tags: *ref_0 x-speakeasy-group: webhooks x-codeSamples: @@ -533,7 +532,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -630,7 +629,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -661,7 +659,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -734,6 +732,7 @@ paths: required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean requestBody: @@ -756,17 +755,59 @@ paths: label: createTicketingTicket source: |- import { Panora } from "@panora/sdk"; + import { + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, + } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tickets.create({ xConnectionToken: "", + remoteData: false, unifiedTicketingTicketInput: { - name: "", - description: "Multi-tiered human-resource model", + 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", + }, }, }); @@ -845,12 +886,14 @@ paths: required: true in: path description: id of the `ticket` you want to retrive. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -869,13 +912,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tickets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -933,7 +977,7 @@ paths: /ticketing/users: get: operationId: listTicketingUsers - summary: List Users + summary: List Users parameters: - name: x-connection-token required: true @@ -952,7 +996,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -983,7 +1026,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1044,8 +1087,8 @@ paths: /ticketing/users/{id}: get: operationId: retrieveTicketingUser - summary: Retrieve Users - description: Retrieve Users from any connected Ticketing software + summary: Retrieve User + description: Retrieve a User from any connected Ticketing software parameters: - name: x-connection-token required: true @@ -1057,12 +1100,14 @@ paths: required: true in: path description: id of the user you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -1081,13 +1126,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1164,7 +1210,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -1195,7 +1240,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1293,7 +1338,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1357,7 +1402,7 @@ paths: /ticketing/contacts: get: operationId: listTicketingContacts - summary: List all Contacts + summary: List Contacts parameters: - name: x-connection-token required: true @@ -1376,7 +1421,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -1407,7 +1451,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1468,8 +1512,8 @@ paths: /ticketing/contacts/{id}: get: operationId: retrieveTicketingContact - summary: Retrieve Contacts - description: Retrieve Contacts from any connected Ticketing software + summary: Retrieve Contact + description: Retrieve a Contact from any connected Ticketing software parameters: - name: x-connection-token required: true @@ -1511,7 +1555,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1580,7 +1624,17 @@ paths: - name: vertical required: true in: path - schema: + example: ticketing + schema: + enum: + - ticketing + - marketingautomation + - crm + - filestorage + - ats + - hris + - accounting + - ecommerce type: string responses: '200': @@ -1591,7 +1645,7 @@ paths: x-codeSamples: - lang: typescript label: status - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: process.env.API_KEY,\n});\n\nasync function run() {\n await panora.sync.status({\n vertical: \"\",\n });\n\n \n}\n\nrun();" + 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();" - lang: python label: status source: |- @@ -1656,7 +1710,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1734,7 +1788,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -1765,7 +1818,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -1838,6 +1891,7 @@ paths: required: false in: query description: Set to true to include data from the original CRM software. + example: false schema: type: boolean requestBody: @@ -1860,16 +1914,49 @@ paths: label: createCrmCompany source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.companies.create({ xConnectionToken: "", + remoteData: false, unifiedCrmCompanyInput: { - name: "", + name: "Acme", + industry: UnifiedCrmCompanyInputIndustry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "", + city: "New York", + state: "NY", + postalCode: "46842", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -1946,12 +2033,14 @@ paths: required: true in: path description: id of the company you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -1970,13 +2059,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.companies.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2053,7 +2143,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -2084,7 +2173,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -2157,6 +2246,7 @@ paths: required: false in: query description: Set to true to include data from the original CRM software. + example: false schema: type: boolean requestBody: @@ -2179,17 +2269,48 @@ paths: label: createCrmContact source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedCrmContactInput: { - firstName: "Jed", - lastName: "Kuhn", + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Jena.Nienow28@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "", + street2: "", + city: "Anytown", + state: "CA", + postalCode: "97398", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -2268,12 +2389,14 @@ paths: required: true in: path description: id of the `contact` you want to retrive. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original CRM software. + example: false schema: type: boolean responses: @@ -2292,13 +2415,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2356,7 +2480,7 @@ paths: /crm/deals: get: operationId: listCrmDeals - summary: List Deals + summary: List Deals parameters: - name: x-connection-token required: true @@ -2375,7 +2499,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -2406,7 +2529,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -2503,16 +2626,23 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.deals.create({ xConnectionToken: "", unifiedCrmDealInput: { - name: "", - description: "Multi-tiered human-resource model", - amount: 8592.13, + 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", + }, }, }); @@ -2593,12 +2723,14 @@ paths: required: true in: path description: id of the deal you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -2617,13 +2749,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.deals.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2681,7 +2814,7 @@ paths: /crm/engagements: get: operationId: listCrmEngagements - summary: List Engagements + summary: List Engagements parameters: - name: x-connection-token required: true @@ -2700,7 +2833,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -2731,7 +2863,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -2804,6 +2936,7 @@ paths: required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean requestBody: @@ -2826,16 +2959,32 @@ paths: label: createCrmEngagement source: |- import { Panora } from "@panora/sdk"; + import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.engagements.create({ xConnectionToken: "", + remoteData: false, unifiedCrmEngagementInput: { - type: "", + 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", + }, }, }); @@ -2912,12 +3061,14 @@ paths: required: true in: path description: id of the engagement you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -2936,13 +3087,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.engagements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3000,7 +3152,7 @@ paths: /crm/notes: get: operationId: listCrmNote - summary: List Notes + summary: List Notes parameters: - name: x-connection-token required: true @@ -3019,7 +3171,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -3050,7 +3201,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -3123,6 +3274,7 @@ paths: required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean requestBody: @@ -3147,14 +3299,23 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.notes.create({ xConnectionToken: "", + remoteData: false, unifiedCrmNoteInput: { - content: "", + 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", + }, }, }); @@ -3231,12 +3392,14 @@ paths: required: true in: path description: id of the note you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -3255,13 +3418,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.notes.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3338,7 +3502,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -3369,7 +3532,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -3443,12 +3606,14 @@ paths: required: true in: path description: id of the stage you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -3467,13 +3632,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.stages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3531,7 +3697,7 @@ paths: /crm/tasks: get: operationId: listCrmTask - summary: List Tasks + summary: List Tasks parameters: - name: x-connection-token required: true @@ -3550,7 +3716,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -3581,7 +3746,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -3676,18 +3841,28 @@ paths: label: createCrmTask source: |- import { Panora } from "@panora/sdk"; + import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.tasks.create({ xConnectionToken: "", unifiedCrmTaskInput: { - subject: "", - content: "", - status: "", + 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", + }, }, }); @@ -3768,12 +3943,14 @@ paths: required: true in: path description: id of the task you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Crm software. + example: false schema: type: boolean responses: @@ -3792,13 +3969,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.tasks.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3875,7 +4053,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -3906,7 +4083,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -3979,12 +4156,14 @@ paths: - name: id required: true in: path + example: b008e199-eda9-4629-bd41-a01b6195864a description: id of the user you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: true description: Set to true to include data from the original Crm software. schema: type: boolean @@ -4004,13 +4183,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.users.retrieve({ xConnectionToken: "", - id: "", + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, }); // Handle the result @@ -4068,7 +4248,7 @@ paths: /ticketing/collections: get: operationId: listTicketingCollections - summary: List Collections + summary: List Collections parameters: - name: x-connection-token required: true @@ -4087,7 +4267,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -4119,7 +4298,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -4193,12 +4372,14 @@ paths: required: true in: path description: id of the collection you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -4217,13 +4398,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.collections.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4281,7 +4463,7 @@ paths: /ticketing/comments: get: operationId: listTicketingComments - summary: List Comments + summary: List Comments parameters: - name: x-connection-token required: true @@ -4300,7 +4482,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -4331,7 +4512,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -4426,16 +4607,26 @@ paths: label: createTicketingComment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.comments.create({ xConnectionToken: "", unifiedTicketingCommentInput: { - body: "", + 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", + ], }, }); @@ -4499,8 +4690,8 @@ paths: /ticketing/comments/{id}: get: operationId: retrieveTicketingComment - summary: Retrieve Comments - description: Retrieve Comments from any connected Ticketing software + summary: Retrieve Comment + description: Retrieve a Comment from any connected Ticketing software parameters: - name: x-connection-token required: true @@ -4542,7 +4733,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -4606,7 +4797,7 @@ paths: /ticketing/tags: get: operationId: listTicketingTags - summary: List Tags + summary: List Tags parameters: - name: x-connection-token required: true @@ -4625,7 +4816,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -4656,7 +4846,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -4717,8 +4907,8 @@ paths: /ticketing/tags/{id}: get: operationId: retrieveTicketingTag - summary: Retrieve Tags - description: Retrieve Tags from any connected Ticketing software + summary: Retrieve Tag + description: Retrieve a Tag from any connected Ticketing software parameters: - name: x-connection-token required: true @@ -4730,12 +4920,14 @@ paths: required: true in: path description: id of the tag you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -4754,13 +4946,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tags.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4837,7 +5030,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -4868,7 +5060,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -4942,12 +5134,14 @@ paths: required: true in: path description: id of the team you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -4966,13 +5160,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.teams.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -5054,13 +5249,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.create({ - linkedUserOriginId: "", - alias: "", + linkedUserOriginId: "id_1", + alias: "acme", }); // Handle the result @@ -5141,7 +5336,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -5226,15 +5421,15 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.batch.importBatch({ linkedUserOriginIds: [ - "", + "id_1", ], - alias: "", + alias: "acme", }); // Handle the result @@ -5298,90 +5493,26 @@ paths: - lang: ruby label: importBatch source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n\nreq = ::OpenApiSDK::Shared::CreateBatchLinkedUserDto.new(\n linked_user_origin_ids: [\n \"\",\n ],\n alias_: \"\",\n)\n \nres = s.linked_users_batch.import_batch(req)\n\nif ! res.linked_user_responses.nil?\n # handle response\nend" - /linked_users/single: + /linked_users/{id}: get: operationId: retrieveLinkedUser summary: Retrieve Linked Users parameters: - name: id required: true - in: query + in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string responses: '200': description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/LinkedUserResponse' tags: *ref_18 - x-speakeasy-group: linked_users.single + x-speakeasy-group: linked_users.{id} x-codeSamples: - lang: typescript label: retrieveLinkedUser - source: |- - import { Panora } from "@panora/sdk"; - - const panora = new Panora({ - apiKey: process.env.API_KEY, - }); - - async function run() { - const result = await panora.linkedUsers.single.retrieve({ - id: "", - }); - - // Handle the result - console.log(result) - } - - run(); - - lang: python - label: retrieveLinkedUser - source: |- - import os - from panora_sdk import Panora - - s = Panora( - api_key=os.getenv("API_KEY", ""), - ) - - - res = s.linked_users.single.retrieve(id="") - - if res is not None: - # handle response - pass - - lang: go - label: retrieveLinkedUser - source: |- - package main - - import( - "os" - gosdk "github.com/panoratech/go-sdk" - "context" - "log" - ) - - func main() { - s := gosdk.New( - gosdk.WithSecurity(os.Getenv("API_KEY")), - ) - var id string = "" - ctx := context.Background() - res, err := s.LinkedUsers.Single.Retrieve(ctx, id) - if err != nil { - log.Fatal(err) - } - if res.LinkedUserResponse != nil { - // handle response - } - } - - lang: ruby - label: retrieveLinkedUser - source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.linked_users_single.retrieve(id=\"\")\n\nif ! res.linked_user_response.nil?\n # handle response\nend" + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.linkedUsers.id.retrieve({\n id: \"801f9ede-c698-4e66-a7fc-48d19eebaa4f\",\n });\n\n \n}\n\nrun();" /linked_users/fromRemoteId: get: operationId: remoteId @@ -5390,6 +5521,7 @@ paths: - name: remoteId required: true in: query + example: id_1 schema: type: string responses: @@ -5408,12 +5540,12 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.fromremoteid.remoteId({ - remoteId: "", + remoteId: "id_1", }); // Handle the result @@ -5492,17 +5624,18 @@ paths: label: definitions source: |- import { Panora } from "@panora/sdk"; + import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.define.definitions({ - objectTypeOwner: "", - name: "", - description: "Universal heuristic matrices", - dataType: "decimal", + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, }); // Handle the result @@ -5590,20 +5723,21 @@ paths: label: defineCustomField source: |- import { Panora } from "@panora/sdk"; + import { CustomFieldCreateDtoDataType, CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.defineCustomField({ - objectTypeOwner: "", - name: "", - description: "Balanced multimedia policy", - dataType: "point", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, + name: "my_favorite_dish", + description: "Favorite Dish", + dataType: CustomFieldCreateDtoDataType.String, + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -5700,15 +5834,15 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.map.map({ - attributeId: "", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -5815,7 +5949,7 @@ paths: import { Method } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -5826,6 +5960,12 @@ paths: passThroughRequestDto: { method: Method.Get, path: "/dev", + data: { + "key": "", + }, + headers: { + "key": "", + }, }, }); @@ -5895,8 +6035,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.passthrough.request(integration_id=\"\", linked_user_id=\"\", vertical=\"\", pass_through_request_dto=::OpenApiSDK::Shared::PassThroughRequestDto.new(\n method: ::OpenApiSDK::Shared::Method::GET,\n path: \"/dev\",\n ))\n\nif ! res.pass_through_response.nil?\n # handle response\nend" /hris/bankinfos: get: - operationId: listHrisBankinfo - summary: List Bankinfos + operationId: listHrisBankInfo + summary: List Bank Info parameters: - name: x-connection-token required: true @@ -5915,7 +6055,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -5941,12 +6080,12 @@ paths: x-speakeasy-group: hris.bankinfos x-codeSamples: - lang: typescript - label: listHrisBankinfo + label: listHrisBankInfo source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6006,9 +6145,9 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_bankinfos.list(x_connection_token=\"\", remote_data=false, limit=7685.78, cursor=\"\")\n\nif ! res.object.nil?\n # handle response\nend" /hris/bankinfos/{id}: get: - operationId: retrieveHrisBankinfo - summary: Retrieve Bank Infos - description: Retrieve Bank Infos from any connected Hris software + operationId: retrieveHrisBankInfo + summary: Retrieve Bank Info + description: Retrieve Bank Info from any connected Hris software parameters: - name: x-connection-token required: true @@ -6019,13 +6158,15 @@ paths: - name: id required: true in: path - description: id of the bankinfo you want to retrieve. + description: id of the bank info you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -6039,18 +6180,19 @@ paths: x-speakeasy-group: hris.bankinfos x-codeSamples: - lang: typescript - label: retrieveHrisBankinfo + label: retrieveHrisBankInfo source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.bankinfos.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -6107,8 +6249,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_bankinfos.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_bankinfo_output.nil?\n # handle response\nend" /hris/benefits: get: - operationId: listHrisBenefit - summary: List Benefits + operationId: listHrisBenefits + summary: List Benefits parameters: - name: x-connection-token required: true @@ -6127,7 +6269,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -6153,12 +6294,12 @@ paths: x-speakeasy-group: hris.benefits x-codeSamples: - lang: typescript - label: listHrisBenefit + label: listHrisBenefits source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6219,8 +6360,8 @@ paths: /hris/benefits/{id}: get: operationId: retrieveHrisBenefit - summary: Retrieve Benefits - description: Retrieve Benefits from any connected Hris software + summary: Retrieve Benefit + description: Retrieve a Benefit from any connected Hris software parameters: - name: x-connection-token required: true @@ -6232,12 +6373,14 @@ paths: required: true in: path description: id of the benefit you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -6256,13 +6399,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.benefits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -6319,8 +6463,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_benefits.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_benefit_output.nil?\n # handle response\nend" /hris/companies: get: - operationId: listHrisCompanys - summary: List Companys + operationId: listHrisCompanies + summary: List Companies parameters: - name: x-connection-token required: true @@ -6339,7 +6483,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -6360,17 +6503,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisCompanyOutput' - tags: + tags: &ref_22 - hris/companies x-speakeasy-group: hris.companies x-codeSamples: - lang: typescript - label: listHrisCompanys + label: listHrisCompanies source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6428,10 +6571,67 @@ paths: - lang: ruby label: listHrisCompanys source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_companies.list(x_connection_token=\"\", remote_data=false, limit=7685.78, cursor=\"\")\n\nif ! res.object.nil?\n # handle response\nend" + /hris/companies/{id}: + get: + operationId: retrieveHrisCompany + summary: Retrieve Company + description: Retrieve a Company from any connected Hris software + parameters: + - name: x-connection-token + required: true + in: header + description: The connection token + schema: + type: string + - name: id + required: true + in: path + description: id of the company you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + example: false + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedHrisCompanyOutput' + tags: *ref_22 + x-speakeasy-group: hris.companies + x-codeSamples: + - lang: typescript + label: retrieveHrisCompany + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.hris.companies.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) + } + + run(); /hris/dependents: get: operationId: listHrisDependents - summary: List Dependents + summary: List Dependents parameters: - name: x-connection-token required: true @@ -6450,7 +6650,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -6471,7 +6670,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisDependentOutput' - tags: &ref_22 + tags: &ref_23 - hris/dependents x-speakeasy-group: hris.dependents x-codeSamples: @@ -6481,7 +6680,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6542,8 +6741,8 @@ paths: /hris/dependents/{id}: get: operationId: retrieveHrisDependent - summary: Retrieve Dependents - description: Retrieve Dependents from any connected Hris software + summary: Retrieve Dependent + description: Retrieve a Dependent from any connected Hris software parameters: - name: x-connection-token required: true @@ -6555,12 +6754,14 @@ paths: required: true in: path description: id of the dependent you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -6570,7 +6771,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisDependentOutput' - tags: *ref_22 + tags: *ref_23 x-speakeasy-group: hris.dependents x-codeSamples: - lang: typescript @@ -6579,13 +6780,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.dependents.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -6643,7 +6845,7 @@ paths: /hris/employeepayrollruns: get: operationId: listHrisEmployeePayrollRun - summary: List EmployeePayrollRuns + summary: List Employee Payroll Runs parameters: - name: x-connection-token required: true @@ -6662,7 +6864,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -6684,7 +6885,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedHrisEmployeepayrollrunOutput - tags: &ref_23 + tags: &ref_24 - hris/employeepayrollruns x-speakeasy-group: hris.employeepayrollruns x-codeSamples: @@ -6694,7 +6895,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6755,8 +6956,8 @@ paths: /hris/employeepayrollruns/{id}: get: operationId: retrieveHrisEmployeePayrollRun - summary: Retrieve Employee Payroll Runs - description: Retrieve Employee Payroll Runs from any connected Hris software + summary: Retrieve Employee Payroll Run + description: Retrieve Employee Payroll Run from any connected Hris software parameters: - name: x-connection-token required: true @@ -6768,12 +6969,14 @@ paths: required: true in: path description: id of the employeepayrollrun you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -6783,7 +6986,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisEmployeepayrollrunOutput' - tags: *ref_23 + tags: *ref_24 x-speakeasy-group: hris.employeepayrollruns x-codeSamples: - lang: typescript @@ -6792,13 +6995,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employeepayrollruns.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -6855,8 +7059,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_employeepayrollruns.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_employeepayrollrun_output.nil?\n # handle response\nend" /hris/employees: get: - operationId: listHrisEmployee - summary: List Employees + operationId: listHrisEmployees + summary: List Employees parameters: - name: x-connection-token required: true @@ -6875,7 +7079,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -6896,17 +7099,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisEmployeeOutput' - tags: &ref_24 + tags: &ref_25 - hris/employees x-speakeasy-group: hris.employees x-codeSamples: - lang: typescript - label: listHrisEmployee + label: listHrisEmployees source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -6994,7 +7197,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisEmployeeOutput' - tags: *ref_24 + tags: *ref_25 x-speakeasy-group: hris.employees x-codeSamples: - lang: typescript @@ -7003,7 +7206,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -7068,8 +7271,8 @@ paths: /hris/employees/{id}: get: operationId: retrieveHrisEmployee - summary: Retrieven Employees - description: Retrieven Employees from any connected Hris software + summary: Retrieve Employee + description: Retrieve an Employee from any connected Hris software parameters: - name: x-connection-token required: true @@ -7081,12 +7284,14 @@ paths: required: true in: path description: id of the employee you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -7096,7 +7301,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisEmployeeOutput' - tags: *ref_24 + tags: *ref_25 x-speakeasy-group: hris.employees x-codeSamples: - lang: typescript @@ -7105,13 +7310,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employees.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -7168,8 +7374,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_employees.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_employee_output.nil?\n # handle response\nend" /hris/employerbenefits: get: - operationId: listHrisEmployerBenefit - summary: List EmployerBenefits + operationId: listHrisEmployerBenefits + summary: List Employer Benefits parameters: - name: x-connection-token required: true @@ -7188,7 +7394,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -7210,17 +7415,17 @@ paths: items: $ref: >- #/components/schemas/UnifiedHrisEmployerbenefitOutput - tags: &ref_25 + tags: &ref_26 - hris/employerbenefits x-speakeasy-group: hris.employerbenefits x-codeSamples: - lang: typescript - label: listHrisEmployerBenefit + label: listHrisEmployerBenefits source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -7281,8 +7486,8 @@ paths: /hris/employerbenefits/{id}: get: operationId: retrieveHrisEmployerBenefit - summary: Retrieve Employer Benefits - description: Retrieve Employer Benefits from any connected Hris software + summary: Retrieve Employer Benefit + description: Retrieve an Employer Benefit from any connected Hris software parameters: - name: x-connection-token required: true @@ -7293,13 +7498,15 @@ paths: - name: id required: true in: path - description: id of the employerbenefit you want to retrieve. + description: id of the employer benefit you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -7309,7 +7516,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisEmployerbenefitOutput' - tags: *ref_25 + tags: *ref_26 x-speakeasy-group: hris.employerbenefits x-codeSamples: - lang: typescript @@ -7318,13 +7525,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employerbenefits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -7381,8 +7589,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_employerbenefits.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_employerbenefit_output.nil?\n # handle response\nend" /hris/employments: get: - operationId: listHrisEmployment - summary: List Employments + operationId: listHrisEmployments + summary: List Employments parameters: - name: x-connection-token required: true @@ -7401,7 +7609,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -7422,17 +7629,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisEmploymentOutput' - tags: &ref_26 + tags: &ref_27 - hris/employments x-speakeasy-group: hris.employments x-codeSamples: - lang: typescript - label: listHrisEmployment + label: listHrisEmployments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -7493,8 +7700,8 @@ paths: /hris/employments/{id}: get: operationId: retrieveHrisEmployment - summary: Retrieve Employments - description: Retrieve Employments from any connected Hris software + summary: Retrieve Employment + description: Retrieve an Employment from any connected Hris software parameters: - name: x-connection-token required: true @@ -7506,12 +7713,14 @@ paths: required: true in: path description: id of the employment you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -7521,7 +7730,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisEmploymentOutput' - tags: *ref_26 + tags: *ref_27 x-speakeasy-group: hris.employments x-codeSamples: - lang: typescript @@ -7530,13 +7739,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -7593,8 +7803,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_employments.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_employment_output.nil?\n # handle response\nend" /hris/groups: get: - operationId: listHrisGroup - summary: List Groups + operationId: listHrisGroups + summary: List Groups parameters: - name: x-connection-token required: true @@ -7613,7 +7823,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -7634,17 +7843,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisGroupOutput' - tags: &ref_27 + tags: &ref_28 - hris/groups x-speakeasy-group: hris.groups x-codeSamples: - lang: typescript - label: listHrisGroup + label: listHrisGroups source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -7705,8 +7914,8 @@ paths: /hris/groups/{id}: get: operationId: retrieveHrisGroup - summary: Retrieve Groups - description: Retrieve Groups from any connected Hris software + summary: Retrieve Group + description: Retrieve a Group from any connected Hris software parameters: - name: x-connection-token required: true @@ -7718,12 +7927,14 @@ paths: required: true in: path description: id of the group you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -7733,7 +7944,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisGroupOutput' - tags: *ref_27 + tags: *ref_28 x-speakeasy-group: hris.groups x-codeSamples: - lang: typescript @@ -7742,13 +7953,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.groups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -7805,8 +8017,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_groups.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_group_output.nil?\n # handle response\nend" /hris/locations: get: - operationId: listHrisLocation - summary: List Locations + operationId: listHrisLocations + summary: List Locations parameters: - name: x-connection-token required: true @@ -7825,7 +8037,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -7846,17 +8057,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisLocationOutput' - tags: &ref_28 + tags: &ref_29 - hris/locations x-speakeasy-group: hris.locations x-codeSamples: - lang: typescript - label: listHrisLocation + label: listHrisLocations source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -7917,8 +8128,8 @@ paths: /hris/locations/{id}: get: operationId: retrieveHrisLocation - summary: Retrieve Locations - description: Retrieve Locations from any connected Hris software + summary: Retrieve Location + description: Retrieve a Location from any connected Hris software parameters: - name: x-connection-token required: true @@ -7930,12 +8141,14 @@ paths: required: true in: path description: id of the location you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -7945,7 +8158,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisLocationOutput' - tags: *ref_28 + tags: *ref_29 x-speakeasy-group: hris.locations x-codeSamples: - lang: typescript @@ -7954,13 +8167,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.locations.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -8017,8 +8231,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_locations.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_location_output.nil?\n # handle response\nend" /hris/paygroups: get: - operationId: listHrisPaygroup - summary: List PayGroups + operationId: listHrisPaygroups + summary: List Pay Groups parameters: - name: x-connection-token required: true @@ -8037,7 +8251,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -8058,17 +8271,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisPaygroupOutput' - tags: &ref_29 + tags: &ref_30 - hris/paygroups x-speakeasy-group: hris.paygroups x-codeSamples: - lang: typescript - label: listHrisPaygroup + label: listHrisPaygroups source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8129,8 +8342,8 @@ paths: /hris/paygroups/{id}: get: operationId: retrieveHrisPaygroup - summary: Retrieve Pay Groups - description: Retrieve Pay Groups from any connected Hris software + summary: Retrieve Pay Group + description: Retrieve a Pay Group from any connected Hris software parameters: - name: x-connection-token required: true @@ -8142,12 +8355,14 @@ paths: required: true in: path description: id of the paygroup you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -8157,7 +8372,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisPaygroupOutput' - tags: *ref_29 + tags: *ref_30 x-speakeasy-group: hris.paygroups x-codeSamples: - lang: typescript @@ -8166,13 +8381,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.paygroups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -8230,7 +8446,7 @@ paths: /hris/payrollruns: get: operationId: listHrisPayrollRuns - summary: List PayrollRuns + summary: List Payroll Runs parameters: - name: x-connection-token required: true @@ -8249,7 +8465,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -8270,7 +8485,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisPayrollrunOutput' - tags: + tags: &ref_31 - hris/payrollruns x-speakeasy-group: hris.payrollruns x-codeSamples: @@ -8280,7 +8495,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8338,10 +8553,11 @@ paths: - lang: ruby label: listHrisPayrollRuns source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_payrollruns.list(x_connection_token=\"\", remote_data=false, limit=7685.78, cursor=\"\")\n\nif ! res.object.nil?\n # handle response\nend" - /hris/timeoffs: + /hris/payrollruns/{id}: get: - operationId: listHrisTimeoffs - summary: List Timeoffs + operationId: retrieveHrisPayrollRun + summary: Retrieve Payroll Run + description: Retrieve a Payroll Run from any connected Hris software parameters: - name: x-connection-token required: true @@ -8349,10 +8565,66 @@ paths: description: The connection token schema: type: string - - name: remote_data - required: false - in: query - description: Set to true to include data from the original software. + - name: id + required: true + in: path + description: id of the payroll run you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + example: false + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedHrisPayrollrunOutput' + tags: *ref_31 + x-speakeasy-group: hris.payrollruns + 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 + console.log(result) + } + + run(); + /hris/timeoffs: + get: + operationId: listHrisTimeoffs + summary: List Time Offs + parameters: + - name: x-connection-token + required: true + in: header + description: The connection token + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original software. schema: type: boolean - name: limit @@ -8360,7 +8632,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -8381,7 +8652,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisTimeoffOutput' - tags: &ref_30 + tags: &ref_32 - hris/timeoffs x-speakeasy-group: hris.timeoffs x-codeSamples: @@ -8391,7 +8662,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8479,7 +8750,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisTimeoffOutput' - tags: *ref_30 + tags: *ref_32 x-speakeasy-group: hris.timeoffs x-codeSamples: - lang: typescript @@ -8488,7 +8759,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8553,8 +8824,8 @@ paths: /hris/timeoffs/{id}: get: operationId: retrieveHrisTimeoff - summary: Retrieve Timeoffs - description: Retrieve Timeoffs from any connected Hris software + summary: Retrieve Time Off + description: Retrieve a Time Off from any connected Hris software parameters: - name: x-connection-token required: true @@ -8565,13 +8836,15 @@ paths: - name: id required: true in: path - description: id of the timeoff you want to retrieve. + description: id of the time off you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -8581,7 +8854,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisTimeoffOutput' - tags: *ref_30 + tags: *ref_32 x-speakeasy-group: hris.timeoffs x-codeSamples: - lang: typescript @@ -8590,13 +8863,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.timeoffs.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -8653,7 +8927,7 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.hris_timeoffs.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_hris_timeoff_output.nil?\n # handle response\nend" /hris/timeoffbalances: get: - operationId: listHrisTimeoffbalance + operationId: listHrisTimeoffbalances summary: List TimeoffBalances parameters: - name: x-connection-token @@ -8673,7 +8947,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -8694,17 +8967,17 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedHrisTimeoffbalanceOutput' - tags: &ref_31 + tags: &ref_33 - hris/timeoffbalances x-speakeasy-group: hris.timeoffbalances x-codeSamples: - lang: typescript - label: listHrisTimeoffbalance + label: listHrisTimeoffbalances source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8778,12 +9051,14 @@ paths: required: true in: path description: id of the timeoffbalance you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Hris software. + example: false schema: type: boolean responses: @@ -8793,7 +9068,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedHrisTimeoffbalanceOutput' - tags: *ref_31 + tags: *ref_33 x-speakeasy-group: hris.timeoffbalances x-codeSamples: - lang: typescript @@ -8802,13 +9077,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.timeoffbalances.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -8866,7 +9142,7 @@ paths: /marketingautomation/actions: get: operationId: listMarketingautomationAction - summary: List Actions + summary: List Actions parameters: - name: x-connection-token required: true @@ -8885,7 +9161,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -8907,7 +9182,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationActionOutput - tags: &ref_32 + tags: &ref_34 - marketingautomation/actions x-speakeasy-group: marketingautomation.actions x-codeSamples: @@ -8917,7 +9192,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -8991,6 +9266,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean requestBody: @@ -9006,7 +9282,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationActionOutput' - tags: *ref_32 + tags: *ref_34 x-speakeasy-group: marketingautomation.actions x-codeSamples: - lang: typescript @@ -9015,12 +9291,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.actions.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationActionInput: {}, }); @@ -9093,6 +9370,7 @@ paths: required: true in: path description: id of the action you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -9100,6 +9378,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -9109,7 +9388,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationActionOutput' - tags: *ref_32 + tags: *ref_34 x-speakeasy-group: marketingautomation.actions x-codeSamples: - lang: typescript @@ -9118,13 +9397,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.actions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -9181,8 +9461,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.marketingautomation_actions.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_marketingautomation_action_output.nil?\n # handle response\nend" /marketingautomation/automations: get: - operationId: listMarketingautomationAutomation - summary: List Automations + operationId: listMarketingautomationAutomations + summary: List Automations parameters: - name: x-connection-token required: true @@ -9201,7 +9481,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -9223,17 +9502,17 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationAutomationOutput - tags: &ref_33 + tags: &ref_35 - marketingautomation/automations x-speakeasy-group: marketingautomation.automations x-codeSamples: - lang: typescript - label: listMarketingautomationAutomation + label: listMarketingautomationAutomations source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -9307,6 +9586,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean requestBody: @@ -9323,7 +9603,7 @@ paths: schema: $ref: >- #/components/schemas/UnifiedMarketingautomationAutomationOutput - tags: *ref_33 + tags: *ref_35 x-speakeasy-group: marketingautomation.automations x-codeSamples: - lang: typescript @@ -9332,12 +9612,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.automations.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationAutomationInput: {}, }); @@ -9397,8 +9678,8 @@ paths: /marketingautomation/automations/{id}: get: operationId: retrieveMarketingautomationAutomation - summary: Retrieve Automations - description: Retrieve Automations from any connected Marketingautomation software + summary: Retrieve Automation + description: Retrieve an Automation from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -9410,6 +9691,7 @@ paths: required: true in: path description: id of the automation you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -9417,6 +9699,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -9427,7 +9710,7 @@ paths: schema: $ref: >- #/components/schemas/UnifiedMarketingautomationAutomationOutput - tags: *ref_33 + tags: *ref_35 x-speakeasy-group: marketingautomation.automations x-codeSamples: - lang: typescript @@ -9436,13 +9719,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.automations.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -9499,8 +9783,8 @@ paths: source: "require 'panora'\n\n\ns = ::OpenApiSDK::Panora.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n api_key: \"\",\n )\n)\n\n \nres = s.marketingautomation_automations.retrieve(x_connection_token=\"\", id=\"\", remote_data=false)\n\nif ! res.unified_marketingautomation_automation_output.nil?\n # handle response\nend" /marketingautomation/campaigns: get: - operationId: listMarketingautomationCampaign - summary: List Campaigns + operationId: listMarketingautomationCampaigns + summary: List Campaigns parameters: - name: x-connection-token required: true @@ -9519,7 +9803,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -9539,18 +9822,19 @@ paths: data: type: array items: - $ref: '#/components/schemas/UnifiedCampaignOutput' - tags: &ref_34 + $ref: >- + #/components/schemas/UnifiedMarketingautomationCampaignOutput + tags: &ref_36 - marketingautomation/campaigns x-speakeasy-group: marketingautomation.campaigns x-codeSamples: - lang: typescript - label: listMarketingautomationCampaign + label: listMarketingautomationCampaigns source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -9624,6 +9908,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean requestBody: @@ -9638,8 +9923,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnifiedCampaignOutput' - tags: *ref_34 + $ref: '#/components/schemas/UnifiedMarketingautomationCampaignOutput' + tags: *ref_36 x-speakeasy-group: marketingautomation.campaigns x-codeSamples: - lang: typescript @@ -9648,12 +9933,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.campaigns.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationCampaignInput: {}, }); @@ -9703,7 +9989,7 @@ paths: if err != nil { log.Fatal(err) } - if res.UnifiedMarketingautomationCampaignOutput != nil { + if res.UnifiedCampaignOutput != nil { // handle response } } @@ -9713,8 +9999,8 @@ paths: /marketingautomation/campaigns/{id}: get: operationId: retrieveMarketingautomationCampaign - summary: Retrieve Campaigns - description: Retrieve Campaigns from any connected Marketingautomation software + summary: Retrieve Campaign + description: Retrieve a Campaign from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -9726,6 +10012,7 @@ paths: required: true in: path description: id of the campaign you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -9733,6 +10020,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -9741,8 +10029,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnifiedCampaignOutput' - tags: *ref_34 + $ref: '#/components/schemas/UnifiedMarketingautomationCampaignOutput' + tags: *ref_36 x-speakeasy-group: marketingautomation.campaigns x-codeSamples: - lang: typescript @@ -9751,13 +10039,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.campaigns.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -9805,7 +10094,7 @@ paths: if err != nil { log.Fatal(err) } - if res.UnifiedMarketingautomationCampaignOutput != nil { + if res.UnifiedCampaignOutput != nil { // handle response } } @@ -9834,7 +10123,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -9856,7 +10144,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationContactOutput - tags: &ref_35 + tags: &ref_37 - marketingautomation/contacts x-speakeasy-group: marketingautomation.contacts x-codeSamples: @@ -9866,7 +10154,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -9940,6 +10228,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean requestBody: @@ -9955,7 +10244,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationContactOutput' - tags: *ref_35 + tags: *ref_37 x-speakeasy-group: marketingautomation.contacts x-codeSamples: - lang: typescript @@ -9964,12 +10253,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationContactInput: {}, }); @@ -10042,6 +10332,7 @@ paths: required: true in: path description: id of the contact you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -10049,6 +10340,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -10058,7 +10350,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationContactOutput' - tags: *ref_35 + tags: *ref_37 x-speakeasy-group: marketingautomation.contacts x-codeSamples: - lang: typescript @@ -10067,13 +10359,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -10131,7 +10424,7 @@ paths: /marketingautomation/emails: get: operationId: listMarketingautomationEmails - summary: List Emails + summary: List Emails parameters: - name: x-connection-token required: true @@ -10150,7 +10443,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -10172,7 +10464,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationEmailOutput - tags: &ref_36 + tags: &ref_38 - marketingautomation/emails x-speakeasy-group: marketingautomation.emails x-codeSamples: @@ -10182,7 +10474,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -10243,8 +10535,8 @@ paths: /marketingautomation/emails/{id}: get: operationId: retrieveMarketingautomationEmail - summary: Retrieve Emails - description: Retrieve Emails from any connected Marketingautomation software + summary: Retrieve Email + description: Retrieve an Email from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -10256,6 +10548,7 @@ paths: required: true in: path description: id of the email you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -10263,6 +10556,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -10272,7 +10566,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationEmailOutput' - tags: *ref_36 + tags: *ref_38 x-speakeasy-group: marketingautomation.emails x-codeSamples: - lang: typescript @@ -10281,13 +10575,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.emails.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -10345,7 +10640,7 @@ paths: /marketingautomation/events: get: operationId: listMarketingAutomationEvents - summary: List Events + summary: List Events parameters: - name: x-connection-token required: true @@ -10364,7 +10659,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -10386,7 +10680,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationEventOutput - tags: &ref_37 + tags: &ref_39 - marketingautomation/events x-speakeasy-group: marketingautomation.events x-codeSamples: @@ -10396,7 +10690,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -10457,8 +10751,8 @@ paths: /marketingautomation/events/{id}: get: operationId: retrieveMarketingautomationEvent - summary: Retrieve Events - description: Retrieve Events from any connected Marketingautomation software + summary: Retrieve Event + description: Retrieve an Event from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -10470,6 +10764,7 @@ paths: required: true in: path description: id of the event you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -10477,6 +10772,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -10486,7 +10782,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationEventOutput' - tags: *ref_37 + tags: *ref_39 x-speakeasy-group: marketingautomation.events x-codeSamples: - lang: typescript @@ -10495,13 +10791,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.events.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -10559,7 +10856,7 @@ paths: /marketingautomation/lists: get: operationId: listMarketingautomationLists - summary: List Lists + summary: List Lists parameters: - name: x-connection-token required: true @@ -10578,7 +10875,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -10600,7 +10896,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationListOutput - tags: &ref_38 + tags: &ref_40 - marketingautomation/lists x-speakeasy-group: marketingautomation.lists x-codeSamples: @@ -10610,7 +10906,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -10699,7 +10995,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationListOutput' - tags: *ref_38 + tags: *ref_40 x-speakeasy-group: marketingautomation.lists x-codeSamples: - lang: typescript @@ -10708,7 +11004,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -10773,8 +11069,8 @@ paths: /marketingautomation/lists/{id}: get: operationId: retrieveMarketingautomationList - summary: Retrieve Lists - description: Retrieve Lists from any connected Marketingautomation software + summary: Retrieve List + description: Retrieve a List from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -10786,6 +11082,7 @@ paths: required: true in: path description: id of the list you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -10793,6 +11090,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -10802,7 +11100,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationListOutput' - tags: *ref_38 + tags: *ref_40 x-speakeasy-group: marketingautomation.lists x-codeSamples: - lang: typescript @@ -10811,13 +11109,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.lists.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -10875,7 +11174,7 @@ paths: /marketingautomation/messages: get: operationId: listMarketingautomationMessages - summary: List Messages + summary: List Messages parameters: - name: x-connection-token required: true @@ -10894,7 +11193,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -10916,7 +11214,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationMessageOutput - tags: &ref_39 + tags: &ref_41 - marketingautomation/messages x-speakeasy-group: marketingautomation.messages x-codeSamples: @@ -10926,7 +11224,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -11000,6 +11298,7 @@ paths: required: true in: path description: id of the message you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -11007,6 +11306,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -11016,7 +11316,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationMessageOutput' - tags: *ref_39 + tags: *ref_41 x-speakeasy-group: marketingautomation.messages x-codeSamples: - lang: typescript @@ -11025,13 +11325,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.messages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -11089,7 +11390,7 @@ paths: /marketingautomation/templates: get: operationId: listMarketingautomationTemplates - summary: List Templates + summary: List Templates parameters: - name: x-connection-token required: true @@ -11108,7 +11409,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -11130,7 +11430,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationTemplateOutput - tags: &ref_40 + tags: &ref_42 - marketingautomation/templates x-speakeasy-group: marketingautomation.templates x-codeSamples: @@ -11140,7 +11440,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -11229,7 +11529,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationTemplateOutput' - tags: *ref_40 + tags: *ref_42 x-speakeasy-group: marketingautomation.templates x-codeSamples: - lang: typescript @@ -11238,7 +11538,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -11303,8 +11603,8 @@ paths: /marketingautomation/templates/{id}: get: operationId: retrieveMarketingautomationTemplate - summary: Retrieve Templates - description: Retrieve Templates from any connected Marketingautomation software + summary: Retrieve Template + description: Retrieve a Template from any connected Marketingautomation software parameters: - name: x-connection-token required: true @@ -11316,6 +11616,7 @@ paths: required: true in: path description: id of the template you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -11323,6 +11624,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -11332,7 +11634,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationTemplateOutput' - tags: *ref_40 + tags: *ref_42 x-speakeasy-group: marketingautomation.templates x-codeSamples: - lang: typescript @@ -11341,13 +11643,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.templates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -11424,7 +11727,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -11446,7 +11748,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedMarketingautomationUserOutput - tags: &ref_41 + tags: &ref_43 - marketingautomation/users x-speakeasy-group: marketingautomation.users x-codeSamples: @@ -11456,7 +11758,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -11530,6 +11832,7 @@ paths: required: true in: path description: id of the user you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data @@ -11537,6 +11840,7 @@ paths: in: query description: >- Set to true to include data from the original Marketingautomation software. + example: false schema: type: boolean responses: @@ -11546,7 +11850,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedMarketingautomationUserOutput' - tags: *ref_41 + tags: *ref_43 x-speakeasy-group: marketingautomation.users x-codeSamples: - lang: typescript @@ -11555,13 +11859,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -11638,7 +11943,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -11659,7 +11963,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsActivityOutput' - tags: &ref_42 + tags: &ref_44 - ats/activities x-speakeasy-group: ats.activities x-codeSamples: @@ -11669,7 +11973,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -11742,6 +12046,7 @@ paths: required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean requestBody: @@ -11757,22 +12062,35 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsActivityOutput' - tags: *ref_42 + tags: *ref_44 x-speakeasy-group: ats.activities x-codeSamples: - lang: typescript label: createAtsActivity source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.activities.create({ xConnectionToken: "", - unifiedAtsActivityInput: {}, + 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 @@ -11844,12 +12162,14 @@ paths: required: true in: path description: id of the activity you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -11859,7 +12179,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsActivityOutput' - tags: *ref_42 + tags: *ref_44 x-speakeasy-group: ats.activities x-codeSamples: - lang: typescript @@ -11868,13 +12188,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.activities.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -11951,7 +12272,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -11972,7 +12292,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsApplicationOutput' - tags: &ref_43 + tags: &ref_45 - ats/applications x-speakeasy-group: ats.applications x-codeSamples: @@ -11982,7 +12302,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -12055,6 +12375,7 @@ paths: required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean requestBody: @@ -12070,7 +12391,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsApplicationOutput' - tags: *ref_43 + tags: *ref_45 x-speakeasy-group: ats.applications x-codeSamples: - lang: typescript @@ -12079,13 +12400,31 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.applications.create({ xConnectionToken: "", - unifiedAtsApplicationInput: {}, + remoteData: false, + unifiedAtsApplicationInput: { + appliedAt: new Date("2024-10-01T12:00:00Z"), + rejectedAt: new Date("2024-10-01T12:00:00Z"), + offers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "12345678-1234-1234-1234-123456789012", + ], + source: "Source Name", + creditedTo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currentStage: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + rejectReason: "Candidate not experienced enough", + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -12157,12 +12496,14 @@ paths: required: true in: path description: id of the application you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -12172,7 +12513,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsApplicationOutput' - tags: *ref_43 + tags: *ref_45 x-speakeasy-group: ats.applications x-codeSamples: - lang: typescript @@ -12181,13 +12522,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.applications.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -12264,7 +12606,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -12285,7 +12626,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsAttachmentOutput' - tags: &ref_44 + tags: &ref_46 - ats/attachments x-speakeasy-group: ats.attachments x-codeSamples: @@ -12295,7 +12636,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -12368,6 +12709,7 @@ paths: required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean requestBody: @@ -12383,22 +12725,35 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsAttachmentOutput' - tags: *ref_44 + tags: *ref_46 x-speakeasy-group: ats.attachments x-codeSamples: - lang: typescript label: createAtsAttachment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.attachments.create({ xConnectionToken: "", - unifiedAtsAttachmentInput: {}, + remoteData: false, + unifiedAtsAttachmentInput: { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: UnifiedAtsAttachmentInputAttachmentType.Resume, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -12470,12 +12825,14 @@ paths: required: true in: path description: id of the attachment you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -12485,7 +12842,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsAttachmentOutput' - tags: *ref_44 + tags: *ref_46 x-speakeasy-group: ats.attachments x-codeSamples: - lang: typescript @@ -12494,13 +12851,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -12577,7 +12935,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -12598,7 +12955,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsCandidateOutput' - tags: &ref_45 + tags: &ref_47 - ats/candidates x-speakeasy-group: ats.candidates x-codeSamples: @@ -12608,7 +12965,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -12681,6 +13038,7 @@ paths: required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean requestBody: @@ -12696,22 +13054,67 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsCandidateOutput' - tags: *ref_45 + tags: *ref_47 x-speakeasy-group: ats.candidates x-codeSamples: - lang: typescript label: createAtsCandidate source: |- import { Panora } from "@panora/sdk"; + import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.candidates.create({ xConnectionToken: "", - unifiedAtsCandidateInput: {}, + 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 @@ -12783,12 +13186,14 @@ paths: required: true in: path description: id of the candidate you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -12798,7 +13203,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsCandidateOutput' - tags: *ref_45 + tags: *ref_47 x-speakeasy-group: ats.candidates x-codeSamples: - lang: typescript @@ -12807,13 +13212,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.candidates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -12890,7 +13296,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -12911,7 +13316,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsDepartmentOutput' - tags: &ref_46 + tags: &ref_48 - ats/departments x-speakeasy-group: ats.departments x-codeSamples: @@ -12921,7 +13326,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -12995,12 +13400,14 @@ paths: required: true in: path description: id of the department you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -13010,7 +13417,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsDepartmentOutput' - tags: *ref_46 + tags: *ref_48 x-speakeasy-group: ats.departments x-codeSamples: - lang: typescript @@ -13019,13 +13426,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.departments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -13102,7 +13510,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -13123,7 +13530,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsInterviewOutput' - tags: &ref_47 + tags: &ref_49 - ats/interviews x-speakeasy-group: ats.interviews x-codeSamples: @@ -13133,7 +13540,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -13206,6 +13613,7 @@ paths: required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean requestBody: @@ -13221,22 +13629,41 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsInterviewOutput' - tags: *ref_47 + tags: *ref_49 x-speakeasy-group: ats.interviews x-codeSamples: - lang: typescript label: createAtsInterview source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.interviews.create({ xConnectionToken: "", - unifiedAtsInterviewInput: {}, + 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 @@ -13308,12 +13735,14 @@ paths: required: true in: path description: id of the interview you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -13323,7 +13752,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsInterviewOutput' - tags: *ref_47 + tags: *ref_49 x-speakeasy-group: ats.interviews x-codeSamples: - lang: typescript @@ -13332,13 +13761,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.interviews.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -13415,7 +13845,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -13437,7 +13866,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAtsJobinterviewstageOutput - tags: &ref_48 + tags: &ref_50 - ats/jobinterviewstages x-speakeasy-group: ats.jobinterviewstages x-codeSamples: @@ -13447,7 +13876,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -13521,12 +13950,14 @@ paths: required: true in: path description: id of the jobinterviewstage you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -13536,7 +13967,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsJobinterviewstageOutput' - tags: *ref_48 + tags: *ref_50 x-speakeasy-group: ats.jobinterviewstages x-codeSamples: - lang: typescript @@ -13545,13 +13976,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.jobinterviewstages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -13628,7 +14060,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -13649,7 +14080,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsJobOutput' - tags: &ref_49 + tags: &ref_51 - ats/jobs x-speakeasy-group: ats.jobs x-codeSamples: @@ -13659,7 +14090,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -13733,12 +14164,14 @@ paths: required: true in: path description: id of the job you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -13748,7 +14181,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsJobOutput' - tags: *ref_49 + tags: *ref_51 x-speakeasy-group: ats.jobs x-codeSamples: - lang: typescript @@ -13757,13 +14190,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.jobs.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -13840,7 +14274,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -13861,7 +14294,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsOfferOutput' - tags: &ref_50 + tags: &ref_52 - ats/offers x-speakeasy-group: ats.offers x-codeSamples: @@ -13871,7 +14304,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -13945,12 +14378,14 @@ paths: required: true in: path description: id of the offer you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -13960,7 +14395,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsOfferOutput' - tags: *ref_50 + tags: *ref_52 x-speakeasy-group: ats.offers x-codeSamples: - lang: typescript @@ -13969,13 +14404,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.offers.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -14052,7 +14488,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -14073,7 +14508,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsOfficeOutput' - tags: &ref_51 + tags: &ref_53 - ats/offices x-speakeasy-group: ats.offices x-codeSamples: @@ -14083,7 +14518,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -14157,12 +14592,14 @@ paths: required: true in: path description: id of the office you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -14172,7 +14609,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsOfficeOutput' - tags: *ref_51 + tags: *ref_53 x-speakeasy-group: ats.offices x-codeSamples: - lang: typescript @@ -14181,13 +14618,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.offices.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -14264,7 +14702,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -14285,7 +14722,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsRejectreasonOutput' - tags: &ref_52 + tags: &ref_54 - ats/rejectreasons x-speakeasy-group: ats.rejectreasons x-codeSamples: @@ -14295,7 +14732,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -14369,12 +14806,14 @@ paths: required: true in: path description: id of the rejectreason you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -14384,7 +14823,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsRejectreasonOutput' - tags: *ref_52 + tags: *ref_54 x-speakeasy-group: ats.rejectreasons x-codeSamples: - lang: typescript @@ -14393,13 +14832,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.rejectreasons.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -14476,7 +14916,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -14497,7 +14936,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsScorecardOutput' - tags: &ref_53 + tags: &ref_55 - ats/scorecards x-speakeasy-group: ats.scorecards x-codeSamples: @@ -14507,7 +14946,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -14581,12 +15020,14 @@ paths: required: true in: path description: id of the scorecard you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -14596,7 +15037,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsScorecardOutput' - tags: *ref_53 + tags: *ref_55 x-speakeasy-group: ats.scorecards x-codeSamples: - lang: typescript @@ -14605,13 +15046,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.scorecards.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -14688,7 +15130,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -14709,7 +15150,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsTagOutput' - tags: &ref_54 + tags: &ref_56 - ats/tags x-speakeasy-group: ats.tags x-codeSamples: @@ -14719,7 +15160,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -14793,12 +15234,14 @@ paths: required: true in: path description: id of the tag you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -14808,7 +15251,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsTagOutput' - tags: *ref_54 + tags: *ref_56 x-speakeasy-group: ats.tags x-codeSamples: - lang: typescript @@ -14817,13 +15260,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.tags.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -14900,7 +15344,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -14921,7 +15364,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsUserOutput' - tags: &ref_55 + tags: &ref_57 - ats/users x-speakeasy-group: ats.users x-codeSamples: @@ -14931,7 +15374,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15005,12 +15448,14 @@ paths: required: true in: path description: id of the user you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ats software. + example: false schema: type: boolean responses: @@ -15020,7 +15465,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsUserOutput' - tags: *ref_55 + tags: *ref_57 x-speakeasy-group: ats.users x-codeSamples: - lang: typescript @@ -15029,13 +15474,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -15112,7 +15558,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -15133,7 +15578,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAtsEeocsOutput' - tags: &ref_56 + tags: &ref_58 - ats/eeocs x-speakeasy-group: ats.eeocs x-codeSamples: @@ -15143,7 +15588,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15232,7 +15677,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAtsEeocsOutput' - tags: *ref_56 + tags: *ref_58 x-speakeasy-group: ats.eeocs x-codeSamples: - lang: typescript @@ -15241,7 +15686,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15324,7 +15769,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -15345,7 +15789,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingAccountOutput' - tags: &ref_57 + tags: &ref_59 - accounting/accounts x-speakeasy-group: accounting.accounts x-codeSamples: @@ -15355,7 +15799,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15427,6 +15871,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -15443,7 +15888,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingAccountOutput' - tags: *ref_57 + tags: *ref_59 x-speakeasy-group: accounting.accounts x-codeSamples: - lang: typescript @@ -15452,12 +15897,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.accounts.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingAccountInput: {}, }); @@ -15529,12 +15975,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the account you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -15545,7 +15993,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingAccountOutput' - tags: *ref_57 + tags: *ref_59 x-speakeasy-group: accounting.accounts x-codeSamples: - lang: typescript @@ -15554,13 +16002,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.accounts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -15637,7 +16086,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -15658,7 +16106,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingAddressOutput' - tags: &ref_58 + tags: &ref_60 - accounting/addresses x-speakeasy-group: accounting.addresses x-codeSamples: @@ -15668,7 +16116,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15741,12 +16189,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the address you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -15757,7 +16207,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingAddressOutput' - tags: *ref_58 + tags: *ref_60 x-speakeasy-group: accounting.addresses x-codeSamples: - lang: typescript @@ -15766,13 +16216,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.addresses.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -15849,7 +16300,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -15871,7 +16321,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingAttachmentOutput - tags: &ref_59 + tags: &ref_61 - accounting/attachments x-speakeasy-group: accounting.attachments x-codeSamples: @@ -15881,7 +16331,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -15953,6 +16403,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -15969,7 +16420,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingAttachmentOutput' - tags: *ref_59 + tags: *ref_61 x-speakeasy-group: accounting.attachments x-codeSamples: - lang: typescript @@ -15978,12 +16429,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.attachments.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingAttachmentInput: {}, }); @@ -16055,12 +16507,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the attachment you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -16071,7 +16525,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingAttachmentOutput' - tags: *ref_59 + tags: *ref_61 x-speakeasy-group: accounting.attachments x-codeSamples: - lang: typescript @@ -16080,13 +16534,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -16163,7 +16618,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -16185,7 +16639,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingBalancesheetOutput - tags: &ref_60 + tags: &ref_62 - accounting/balancesheets x-speakeasy-group: accounting.balancesheets x-codeSamples: @@ -16195,7 +16649,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -16268,12 +16722,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the balancesheet you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -16284,7 +16740,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingBalancesheetOutput' - tags: *ref_60 + tags: *ref_62 x-speakeasy-group: accounting.balancesheets x-codeSamples: - lang: typescript @@ -16293,13 +16749,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.balancesheets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -16376,7 +16833,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -16398,7 +16854,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingCashflowstatementOutput - tags: &ref_61 + tags: &ref_63 - accounting/cashflowstatements x-speakeasy-group: accounting.cashflowstatements x-codeSamples: @@ -16408,7 +16864,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -16481,12 +16937,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the cashflowstatement you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -16497,7 +16955,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingCashflowstatementOutput' - tags: *ref_61 + tags: *ref_63 x-speakeasy-group: accounting.cashflowstatements x-codeSamples: - lang: typescript @@ -16506,13 +16964,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.cashflowstatements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -16589,7 +17048,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -16611,7 +17069,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingCompanyinfoOutput - tags: &ref_62 + tags: &ref_64 - accounting/companyinfos x-speakeasy-group: accounting.companyinfos x-codeSamples: @@ -16621,7 +17079,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -16694,12 +17152,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the companyinfo you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -16710,7 +17170,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingCompanyinfoOutput' - tags: *ref_62 + tags: *ref_64 x-speakeasy-group: accounting.companyinfos x-codeSamples: - lang: typescript @@ -16719,13 +17179,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.companyinfos.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -16802,7 +17263,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -16823,7 +17283,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingContactOutput' - tags: &ref_63 + tags: &ref_65 - accounting/contacts x-speakeasy-group: accounting.contacts x-codeSamples: @@ -16833,7 +17293,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -16905,6 +17365,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -16921,7 +17382,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingContactOutput' - tags: *ref_63 + tags: *ref_65 x-speakeasy-group: accounting.contacts x-codeSamples: - lang: typescript @@ -16930,12 +17391,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingContactInput: {}, }); @@ -17007,12 +17469,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the contact you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17023,7 +17487,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingContactOutput' - tags: *ref_63 + tags: *ref_65 x-speakeasy-group: accounting.contacts x-codeSamples: - lang: typescript @@ -17032,13 +17496,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -17115,7 +17580,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -17137,7 +17601,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingCreditnoteOutput - tags: &ref_64 + tags: &ref_66 - accounting/creditnotes x-speakeasy-group: accounting.creditnotes x-codeSamples: @@ -17147,7 +17611,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -17220,12 +17684,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the creditnote you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17236,7 +17702,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingCreditnoteOutput' - tags: *ref_64 + tags: *ref_66 x-speakeasy-group: accounting.creditnotes x-codeSamples: - lang: typescript @@ -17245,13 +17711,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.creditnotes.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -17328,7 +17795,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -17349,7 +17815,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingExpenseOutput' - tags: &ref_65 + tags: &ref_67 - accounting/expenses x-speakeasy-group: accounting.expenses x-codeSamples: @@ -17359,7 +17825,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -17431,6 +17897,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17447,7 +17914,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingExpenseOutput' - tags: *ref_65 + tags: *ref_67 x-speakeasy-group: accounting.expenses x-codeSamples: - lang: typescript @@ -17456,12 +17923,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.expenses.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingExpenseInput: {}, }); @@ -17533,12 +18001,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the expense you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17549,7 +18019,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingExpenseOutput' - tags: *ref_65 + tags: *ref_67 x-speakeasy-group: accounting.expenses x-codeSamples: - lang: typescript @@ -17558,13 +18028,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.expenses.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -17641,7 +18112,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -17663,7 +18133,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingIncomestatementOutput - tags: &ref_66 + tags: &ref_68 - accounting/incomestatements x-speakeasy-group: accounting.incomestatements x-codeSamples: @@ -17673,7 +18143,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -17746,12 +18216,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the incomestatement you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17762,7 +18234,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingIncomestatementOutput' - tags: *ref_66 + tags: *ref_68 x-speakeasy-group: accounting.incomestatements x-codeSamples: - lang: typescript @@ -17771,13 +18243,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.incomestatements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -17854,7 +18327,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -17875,7 +18347,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingInvoiceOutput' - tags: &ref_67 + tags: &ref_69 - accounting/invoices x-speakeasy-group: accounting.invoices x-codeSamples: @@ -17885,7 +18357,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -17957,6 +18429,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -17973,7 +18446,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingInvoiceOutput' - tags: *ref_67 + tags: *ref_69 x-speakeasy-group: accounting.invoices x-codeSamples: - lang: typescript @@ -17982,12 +18455,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.invoices.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingInvoiceInput: {}, }); @@ -18059,12 +18533,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the invoice you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18075,7 +18551,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingInvoiceOutput' - tags: *ref_67 + tags: *ref_69 x-speakeasy-group: accounting.invoices x-codeSamples: - lang: typescript @@ -18084,13 +18560,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.invoices.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -18167,7 +18644,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -18188,7 +18664,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingItemOutput' - tags: &ref_68 + tags: &ref_70 - accounting/items x-speakeasy-group: accounting.items x-codeSamples: @@ -18198,7 +18674,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -18271,12 +18747,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the item you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18287,7 +18765,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingItemOutput' - tags: *ref_68 + tags: *ref_70 x-speakeasy-group: accounting.items x-codeSamples: - lang: typescript @@ -18296,13 +18774,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.items.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -18379,7 +18858,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -18401,7 +18879,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingJournalentryOutput - tags: &ref_69 + tags: &ref_71 - accounting/journalentries x-speakeasy-group: accounting.journalentries x-codeSamples: @@ -18411,7 +18889,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -18483,6 +18961,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18499,7 +18978,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingJournalentryOutput' - tags: *ref_69 + tags: *ref_71 x-speakeasy-group: accounting.journalentries x-codeSamples: - lang: typescript @@ -18508,12 +18987,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.journalentries.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingJournalentryInput: {}, }); @@ -18585,12 +19065,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the journalentry you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18601,7 +19083,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingJournalentryOutput' - tags: *ref_69 + tags: *ref_71 x-speakeasy-group: accounting.journalentries x-codeSamples: - lang: typescript @@ -18610,13 +19092,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.journalentries.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -18693,7 +19176,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -18714,7 +19196,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingPaymentOutput' - tags: &ref_70 + tags: &ref_72 - accounting/payments x-speakeasy-group: accounting.payments x-codeSamples: @@ -18724,7 +19206,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -18796,6 +19278,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18812,7 +19295,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingPaymentOutput' - tags: *ref_70 + tags: *ref_72 x-speakeasy-group: accounting.payments x-codeSamples: - lang: typescript @@ -18821,12 +19304,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.payments.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingPaymentInput: {}, }); @@ -18898,12 +19382,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the payment you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -18914,7 +19400,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingPaymentOutput' - tags: *ref_70 + tags: *ref_72 x-speakeasy-group: accounting.payments x-codeSamples: - lang: typescript @@ -18923,13 +19409,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.payments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -19006,7 +19493,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -19028,7 +19514,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingPhonenumberOutput - tags: &ref_71 + tags: &ref_73 - accounting/phonenumbers x-speakeasy-group: accounting.phonenumbers x-codeSamples: @@ -19038,7 +19524,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -19111,12 +19597,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the phonenumber you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -19127,7 +19615,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingPhonenumberOutput' - tags: *ref_71 + tags: *ref_73 x-speakeasy-group: accounting.phonenumbers x-codeSamples: - lang: typescript @@ -19136,13 +19624,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.phonenumbers.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -19219,7 +19708,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -19241,7 +19729,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingPurchaseorderOutput - tags: &ref_72 + tags: &ref_74 - accounting/purchaseorders x-speakeasy-group: accounting.purchaseorders x-codeSamples: @@ -19251,7 +19739,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -19323,6 +19811,7 @@ paths: - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -19339,7 +19828,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingPurchaseorderOutput' - tags: *ref_72 + tags: *ref_74 x-speakeasy-group: accounting.purchaseorders x-codeSamples: - lang: typescript @@ -19348,12 +19837,13 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.purchaseorders.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingPurchaseorderInput: {}, }); @@ -19425,12 +19915,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the purchaseorder you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -19441,7 +19933,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingPurchaseorderOutput' - tags: *ref_72 + tags: *ref_74 x-speakeasy-group: accounting.purchaseorders x-codeSamples: - lang: typescript @@ -19450,13 +19942,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.purchaseorders.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -19533,7 +20026,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -19554,7 +20046,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedAccountingTaxrateOutput' - tags: &ref_73 + tags: &ref_75 - accounting/taxrates x-speakeasy-group: accounting.taxrates x-codeSamples: @@ -19564,7 +20056,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -19637,12 +20129,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the taxrate you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -19653,7 +20147,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingTaxrateOutput' - tags: *ref_73 + tags: *ref_75 x-speakeasy-group: accounting.taxrates x-codeSamples: - lang: typescript @@ -19662,13 +20156,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.taxrates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -19745,7 +20240,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -19767,7 +20261,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingTrackingcategoryOutput - tags: &ref_74 + tags: &ref_76 - accounting/trackingcategories x-speakeasy-group: accounting.trackingcategories x-codeSamples: @@ -19777,7 +20271,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -19850,12 +20344,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the trackingcategory you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -19866,7 +20362,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingTrackingcategoryOutput' - tags: *ref_74 + tags: *ref_76 x-speakeasy-group: accounting.trackingcategories x-codeSamples: - lang: typescript @@ -19875,13 +20371,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.trackingcategories.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -19958,7 +20455,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -19980,7 +20476,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingTransactionOutput - tags: &ref_75 + tags: &ref_77 - accounting/transactions x-speakeasy-group: accounting.transactions x-codeSamples: @@ -19990,7 +20486,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -20063,12 +20559,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the transaction you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -20079,7 +20577,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingTransactionOutput' - tags: *ref_75 + tags: *ref_77 x-speakeasy-group: accounting.transactions x-codeSamples: - lang: typescript @@ -20088,13 +20586,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.transactions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -20171,7 +20670,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -20193,7 +20691,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedAccountingVendorcreditOutput - tags: &ref_76 + tags: &ref_78 - accounting/vendorcredits x-speakeasy-group: accounting.vendorcredits x-codeSamples: @@ -20203,7 +20701,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -20276,12 +20774,14 @@ paths: - name: id required: true in: path + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: id of the vendorcredit you want to retrieve. schema: type: string - name: remote_data required: false in: query + example: false description: Set to true to include data from the original Accounting software. schema: type: boolean @@ -20292,7 +20792,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedAccountingVendorcreditOutput' - tags: *ref_76 + tags: *ref_78 x-speakeasy-group: accounting.vendorcredits x-codeSamples: - lang: typescript @@ -20301,13 +20801,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.vendorcredits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -20365,7 +20866,7 @@ paths: /filestorage/drives: get: operationId: listFilestorageDrives - summary: List Drives + summary: List Drives parameters: - name: x-connection-token required: true @@ -20384,7 +20885,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -20405,7 +20905,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedFilestorageDriveOutput' - tags: &ref_77 + tags: &ref_79 - filestorage/drives x-speakeasy-group: filestorage.drives x-codeSamples: @@ -20415,7 +20915,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -20476,8 +20976,8 @@ paths: /filestorage/drives/{id}: get: operationId: retrieveFilestorageDrive - summary: Retrieve Drives - description: Retrieve Drives from any connected Filestorage software + summary: Retrieve Drive + description: Retrieve a Drive from any connected file storage service parameters: - name: x-connection-token required: true @@ -20489,12 +20989,14 @@ paths: required: true in: path description: id of the drive you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query - description: Set to true to include data from the original File Storage software. + description: Set to true to include data from the original file storage service. + example: false schema: type: boolean responses: @@ -20504,7 +21006,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageDriveOutput' - tags: *ref_77 + tags: *ref_79 x-speakeasy-group: filestorage.drives x-codeSamples: - lang: typescript @@ -20513,13 +21015,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.drives.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -20596,7 +21099,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -20617,7 +21119,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedFilestorageFileOutput' - tags: &ref_78 + tags: &ref_80 - filestorage/files x-speakeasy-group: filestorage.files x-codeSamples: @@ -20627,7 +21129,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -20714,7 +21216,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageFileOutput' - tags: *ref_78 + tags: *ref_80 x-speakeasy-group: filestorage.files x-codeSamples: - lang: typescript @@ -20723,7 +21225,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -20731,13 +21233,17 @@ paths: xConnectionToken: "", remoteData: false, unifiedFilestorageFileInput: { - name: "", - fileUrl: "", - mimeType: "", - size: "", - folderId: "", - permission: "", - sharedLink: "", + 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", + }, }, }); @@ -20828,12 +21334,14 @@ paths: required: true in: path description: id of the file you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original File Storage software. + example: false schema: type: boolean responses: @@ -20843,7 +21351,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageFileOutput' - tags: *ref_78 + tags: *ref_80 x-speakeasy-group: filestorage.files x-codeSamples: - lang: typescript @@ -20852,13 +21360,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.files.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -20935,7 +21444,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -20956,7 +21464,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedFilestorageFolderOutput' - tags: &ref_79 + tags: &ref_81 - filestorage/folders x-speakeasy-group: filestorage.folders x-codeSamples: @@ -20966,7 +21474,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -21053,7 +21561,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageFolderOutput' - tags: *ref_79 + tags: *ref_81 x-speakeasy-group: filestorage.folders x-codeSamples: - lang: typescript @@ -21062,7 +21570,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -21070,14 +21578,18 @@ paths: xConnectionToken: "", remoteData: false, unifiedFilestorageFolderInput: { - name: "", - size: "", - folderUrl: "", - description: "Multi-tiered human-resource model", - driveId: "", - parentFolderId: "", - sharedLink: "", - permission: "", + 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", + }, }, }); @@ -21170,12 +21682,14 @@ paths: required: true in: path description: id of the folder you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original File Storage software. + example: false schema: type: boolean responses: @@ -21185,7 +21699,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageFolderOutput' - tags: *ref_79 + tags: *ref_81 x-speakeasy-group: filestorage.folders x-codeSamples: - lang: typescript @@ -21194,13 +21708,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.folders.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -21277,7 +21792,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -21298,7 +21812,7 @@ paths: type: array items: $ref: '#/components/schemas/UnifiedFilestorageGroupOutput' - tags: &ref_80 + tags: &ref_82 - filestorage/groups x-speakeasy-group: filestorage.groups x-codeSamples: @@ -21308,7 +21822,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -21382,12 +21896,14 @@ paths: required: true in: path description: id of the permission you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original File Storage software. + example: false schema: type: boolean responses: @@ -21397,7 +21913,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedFilestorageGroupOutput' - tags: *ref_80 + tags: *ref_82 x-speakeasy-group: filestorage.groups x-codeSamples: - lang: typescript @@ -21406,13 +21922,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.groups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -21470,7 +21987,7 @@ paths: /filestorage/users: get: operationId: listFilestorageUsers - summary: List Users + summary: List Users parameters: - name: x-connection-token required: true @@ -21489,7 +22006,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -21509,8 +22025,8 @@ paths: data: type: array items: - $ref: '#/components/schemas/UnifiedUserOutput' - tags: &ref_81 + $ref: '#/components/schemas/UnifiedFilestorageUserOutput' + tags: &ref_83 - filestorage/users x-speakeasy-group: filestorage.users x-codeSamples: @@ -21520,7 +22036,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -21594,12 +22110,14 @@ paths: required: true in: path description: id of the permission you want to retrieve. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original File Storage software. + example: false schema: type: boolean responses: @@ -21608,8 +22126,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnifiedUserOutput' - tags: *ref_81 + $ref: '#/components/schemas/UnifiedFilestorageUserOutput' + tags: *ref_83 x-speakeasy-group: filestorage.users x-codeSamples: - lang: typescript @@ -21618,13 +22136,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -21672,7 +22191,7 @@ paths: if err != nil { log.Fatal(err) } - if res.UnifiedFilestorageUserOutput != nil { + if res.UnifiedUserOutput != nil { // handle response } } @@ -21701,7 +22220,6 @@ paths: in: query description: Set to get the number of records. schema: - default: 50 type: number - name: cursor required: false @@ -21723,7 +22241,7 @@ paths: items: $ref: >- #/components/schemas/UnifiedTicketingAttachmentOutput - tags: &ref_82 + tags: &ref_84 - ticketing/attachments x-speakeasy-group: ticketing.attachments x-codeSamples: @@ -21733,7 +22251,7 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -21821,7 +22339,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedTicketingAttachmentOutput' - tags: *ref_82 + tags: *ref_84 x-speakeasy-group: ticketing.attachments x-codeSamples: - lang: typescript @@ -21830,18 +22348,21 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.attachments.create({ xConnectionToken: "", unifiedTicketingAttachmentInput: { - fileName: "your_file_here", - fileUrl: "", - uploader: "", + 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: { - "key": "", + "fav_dish": "broccoli", + "fav_color": "red", }, }, }); @@ -21929,12 +22450,14 @@ paths: required: true in: path description: id of the attachment you want to retrive. + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f schema: type: string - name: remote_data required: false in: query description: Set to true to include data from the original Ticketing software. + example: false schema: type: boolean responses: @@ -21944,7 +22467,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnifiedTicketingAttachmentOutput' - tags: *ref_82 + tags: *ref_84 x-speakeasy-group: ticketing.attachments x-codeSamples: - lang: typescript @@ -21953,13 +22476,14 @@ paths: import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -22039,30 +22563,36 @@ components: properties: id_webhook_endpoint: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The unique UUID of the webhook. endpoint_description: type: string + example: Webhook to receive connection events nullable: true description: The description of the webhook. url: type: string + example: https://acme.com/webhook_receiver nullable: true description: The endpoint url of the webhook. secret: type: string - nullable: true description: The secret of the webhook. active: type: boolean + example: true nullable: true description: The status of the webhook. created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The created date of the webhook. nullable: true - description: The created date of the webhook. scope: + example: + - connection.created nullable: true description: The events that the webhook listen to. type: array @@ -22070,11 +22600,13 @@ components: type: string id_project: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The project id tied to the webhook. last_update: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The last update date of the webhook. required: @@ -22092,13 +22624,17 @@ components: properties: url: type: string + example: https://acme.com/webhook_receiver nullable: true description: The endpoint url of the webhook. description: type: string + example: Webhook to receive connection events nullable: true description: The description of the webhook. scope: + example: + - connection.created nullable: true description: The events that the webhook listen to. type: array @@ -22106,6 +22642,7 @@ components: type: string required: - url + - description - scope SignatureVerificationDto: type: object @@ -22150,36 +22687,48 @@ components: body: type: string nullable: true + example: Assigned to Eric ! description: The body of the comment html_body: type: string nullable: true + example:

Assigned to Eric !

description: The html body of the comment is_private: type: boolean nullable: true + example: false description: The public status of the comment creator_type: type: string nullable: true + example: USER + enum: &ref_111 + - USER + - CONTACT description: >- The creator type of the comment. Authorized values are either USER or CONTACT ticket_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the ticket the comment is tied to contact_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: >- The UUID of the contact which the comment belongs to (if no user_id specified) user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: >- The UUID of the user which the comment belongs to (if no contact_id specified) attachments: nullable: true + example: &ref_112 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The attachements UUIDs tied to the comment type: array items: @@ -22191,35 +22740,54 @@ components: properties: name: type: string + example: Customer Service Inquiry nullable: true description: The name of the ticket status: type: string + example: OPEN + enum: &ref_85 + - OPEN + - CLOSED nullable: true description: The status of the ticket. Authorized values are OPEN or CLOSED. description: type: string + example: Help customer nullable: true description: The description of the ticket due_date: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The date the ticket is due type: type: string + example: BUG + enum: &ref_86 + - BUG + - SUBTASK + - TASK + - TO-DO nullable: true description: >- The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK parent_ticket: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the parent ticket collections: type: string + example: &ref_87 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The collection UUIDs the ticket belongs to tags: + example: &ref_88 + - my_tag + - urgent_tag nullable: true description: The tags names of the ticket type: array @@ -22228,65 +22796,90 @@ components: completed_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The date the ticket has been completed priority: type: string + example: HIGH + enum: &ref_89 + - HIGH + - MEDIUM + - LOW nullable: true description: >- The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. assigned_to: + example: &ref_90 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The users UUIDs the ticket is assigned to type: array items: type: string comment: + example: &ref_91 + content: Assigned the issue ! nullable: true description: The comment of the ticket allOf: - $ref: '#/components/schemas/UnifiedTicketingCommentInput' account_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the account which the ticket belongs to contact_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the contact which the ticket belongs to attachments: + example: &ref_92 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The attachements UUIDs tied to the ticket nullable: true - description: The attachments UUIDs tied to the ticket type: array items: type: string field_mappings: type: object + example: &ref_93 + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the ticket between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the ticket remote_id: type: string + example: id_1 nullable: true description: The id of the ticket in the context of the 3rd Party remote_data: type: object + example: + key1: value1 + key2: 42 + key3: true nullable: true additionalProperties: true description: The remote data of the ticket in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -22297,35 +22890,45 @@ components: properties: name: type: string + example: Customer Service Inquiry nullable: true description: The name of the ticket status: type: string + example: OPEN + enum: *ref_85 nullable: true description: The status of the ticket. Authorized values are OPEN or CLOSED. description: type: string + example: Help customer nullable: true description: The description of the ticket due_date: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The date the ticket is due type: type: string + example: BUG + enum: *ref_86 nullable: true description: >- The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK parent_ticket: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the parent ticket collections: type: string + example: *ref_87 nullable: true description: The collection UUIDs the ticket belongs to tags: + example: *ref_88 nullable: true description: The tags names of the ticket type: array @@ -22334,40 +22937,49 @@ components: completed_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The date the ticket has been completed priority: type: string + example: HIGH + enum: *ref_89 nullable: true description: >- The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. assigned_to: + example: *ref_90 nullable: true description: The users UUIDs the ticket is assigned to type: array items: type: string comment: + example: *ref_91 nullable: true description: The comment of the ticket allOf: - $ref: '#/components/schemas/UnifiedTicketingCommentInput' account_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the account which the ticket belongs to contact_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the contact which the ticket belongs to attachments: + example: *ref_92 + description: The attachements UUIDs tied to the ticket nullable: true - description: The attachments UUIDs tied to the ticket type: array items: type: string field_mappings: type: object + example: *ref_93 nullable: true description: >- The custom field mappings of the ticket between the remote 3rd party & Panora @@ -22382,13 +22994,18 @@ components: type: string nullable: true description: The name of the user + example: John Doe email_address: type: string nullable: true description: The email address of the user + example: john.doe@example.com teams: nullable: true description: The teams whose the user is part of + example: + - team1 + - team2 type: array items: type: string @@ -22396,47 +23013,62 @@ components: type: string nullable: true description: The account or organization the user is part of + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the user between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the user remote_id: type: string + example: id_1 nullable: true description: The id of the user in the context of the 3rd Party remote_data: type: object + example: + key1: value1 + key2: 42 + key3: true nullable: true additionalProperties: true description: The remote data of the user in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2023-10-01T12:00:00Z' nullable: true description: The modified date of the object required: - name - email_address - - field_mappings UnifiedTicketingAccountOutput: type: object properties: name: type: string + example: My Personal Account nullable: true description: The name of the account domains: + example: + - acme.com + - acme-test.com nullable: true description: The domains of the account type: array @@ -22444,33 +23076,43 @@ components: type: string field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the account between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the account remote_id: type: string + example: id_1 + description: The remote ID of the account in the context of the 3rd Party nullable: true - description: The id of the account in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the account in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The created date of the account nullable: true - description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The modified date of the account nullable: true - description: The modified date of the object required: - name UnifiedTicketingContactOutput: @@ -22478,46 +23120,60 @@ components: properties: name: type: string + example: Joe nullable: true description: The name of the contact email_address: type: string + example: joedoe@acme.org nullable: true description: The email address of the contact phone_number: type: string + example: +33 6 50 11 11 10 nullable: true description: The phone number of the contact details: type: string + example: Contact Details nullable: true description: The details of the contact field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the contact between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the contact remote_id: type: string + example: id_1 + description: The remote ID of the contact in the context of the 3rd Party nullable: true - description: The id of the contact in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the contact in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -22553,11 +23209,17 @@ components: description: The email address email_address_type: type: string + enum: + - PERSONAL + - WORK nullable: true description: >- The email address type. Authorized values are either PERSONAL or WORK. owner_type: type: string + enum: + - COMPANY + - CONTACT nullable: true description: The owner type of an email required: @@ -22592,6 +23254,9 @@ components: description: The country address_type: type: string + enum: + - PERSONAL + - WORK nullable: true description: The address type. Authorized values are either PERSONAL or WORK. owner_type: @@ -22617,6 +23282,9 @@ components: The phone number starting with a plus (+) followed by the country code (e.g +336676778890 for France) phone_type: type: string + enum: + - MOBILE + - WORK nullable: true description: The phone type. Authorized values are either MOBILE or WORK owner_type: @@ -22631,41 +23299,208 @@ components: properties: name: type: string + example: Acme description: The name of the company nullable: true industry: type: string + example: ACCOUNTING + enum: &ref_94 + - ACCOUNTING + - AIRLINES_AVIATION + - ALTERNATIVE_DISPUTE_RESOLUTION + - ALTERNATIVE_MEDICINE + - ANIMATION + - APPAREL_FASHION + - ARCHITECTURE_PLANNING + - ARTS_AND_CRAFTS + - AUTOMOTIVE + - AVIATION_AEROSPACE + - BANKING + - BIOTECHNOLOGY + - BROADCAST_MEDIA + - BUILDING_MATERIALS + - BUSINESS_SUPPLIES_AND_EQUIPMENT + - CAPITAL_MARKETS + - CHEMICALS + - CIVIC_SOCIAL_ORGANIZATION + - CIVIL_ENGINEERING + - COMMERCIAL_REAL_ESTATE + - COMPUTER_NETWORK_SECURITY + - COMPUTER_GAMES + - COMPUTER_HARDWARE + - COMPUTER_NETWORKING + - COMPUTER_SOFTWARE + - INTERNET + - CONSTRUCTION + - CONSUMER_ELECTRONICS + - CONSUMER_GOODS + - CONSUMER_SERVICES + - COSMETICS + - DAIRY + - DEFENSE_SPACE + - DESIGN + - EDUCATION_MANAGEMENT + - E_LEARNING + - ELECTRICAL_ELECTRONIC_MANUFACTURING + - ENTERTAINMENT + - ENVIRONMENTAL_SERVICES + - EVENTS_SERVICES + - EXECUTIVE_OFFICE + - FACILITIES_SERVICES + - FARMING + - FINANCIAL_SERVICES + - FINE_ART + - FISHERY + - FOOD_BEVERAGES + - FOOD_PRODUCTION + - FUND_RAISING + - FURNITURE + - GAMBLING_CASINOS + - GLASS_CERAMICS_CONCRETE + - GOVERNMENT_ADMINISTRATION + - GOVERNMENT_RELATIONS + - GRAPHIC_DESIGN + - HEALTH_WELLNESS_AND_FITNESS + - HIGHER_EDUCATION + - HOSPITAL_HEALTH_CARE + - HOSPITALITY + - HUMAN_RESOURCES + - IMPORT_AND_EXPORT + - INDIVIDUAL_FAMILY_SERVICES + - INDUSTRIAL_AUTOMATION + - INFORMATION_SERVICES + - INFORMATION_TECHNOLOGY_AND_SERVICES + - INSURANCE + - INTERNATIONAL_AFFAIRS + - INTERNATIONAL_TRADE_AND_DEVELOPMENT + - INVESTMENT_BANKING + - INVESTMENT_MANAGEMENT + - JUDICIARY + - LAW_ENFORCEMENT + - LAW_PRACTICE + - LEGAL_SERVICES + - LEGISLATIVE_OFFICE + - LEISURE_TRAVEL_TOURISM + - LIBRARIES + - LOGISTICS_AND_SUPPLY_CHAIN + - LUXURY_GOODS_JEWELRY + - MACHINERY + - MANAGEMENT_CONSULTING + - MARITIME + - MARKET_RESEARCH + - MARKETING_AND_ADVERTISING + - MECHANICAL_OR_INDUSTRIAL_ENGINEERING + - MEDIA_PRODUCTION + - MEDICAL_DEVICES + - MEDICAL_PRACTICE + - MENTAL_HEALTH_CARE + - MILITARY + - MINING_METALS + - MOTION_PICTURES_AND_FILM + - MUSEUMS_AND_INSTITUTIONS + - MUSIC + - NANOTECHNOLOGY + - NEWSPAPERS + - NON_PROFIT_ORGANIZATION_MANAGEMENT + - OIL_ENERGY + - ONLINE_MEDIA + - OUTSOURCING_OFFSHORING + - PACKAGE_FREIGHT_DELIVERY + - PACKAGING_AND_CONTAINERS + - PAPER_FOREST_PRODUCTS + - PERFORMING_ARTS + - PHARMACEUTICALS + - PHILANTHROPY + - PHOTOGRAPHY + - PLASTICS + - POLITICAL_ORGANIZATION + - PRIMARY_SECONDARY_EDUCATION + - PRINTING + - PROFESSIONAL_TRAINING_COACHING + - PROGRAM_DEVELOPMENT + - PUBLIC_POLICY + - PUBLIC_RELATIONS_AND_COMMUNICATIONS + - PUBLIC_SAFETY + - PUBLISHING + - RAILROAD_MANUFACTURE + - RANCHING + - REAL_ESTATE + - RECREATIONAL_FACILITIES_AND_SERVICES + - RELIGIOUS_INSTITUTIONS + - RENEWABLES_ENVIRONMENT + - RESEARCH + - RESTAURANTS + - RETAIL + - SECURITY_AND_INVESTIGATIONS + - SEMICONDUCTORS + - SHIPBUILDING + - SPORTING_GOODS + - SPORTS + - STAFFING_AND_RECRUITING + - SUPERMARKETS + - TELECOMMUNICATIONS + - TEXTILES + - THINK_TANKS + - TOBACCO + - TRANSLATION_AND_LOCALIZATION + - TRANSPORTATION_TRUCKING_RAILROAD + - UTILITIES + - VENTURE_CAPITAL_PRIVATE_EQUITY + - VETERINARY + - WAREHOUSING + - WHOLESALE + - WINE_AND_SPIRITS + - WIRELESS + - WRITING_AND_EDITING description: >- The industry of the company. Authorized values can be found in the Industry enum. nullable: true number_of_employees: type: number + example: 10 description: The number of employees of the company nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user who owns the company nullable: true email_addresses: description: The email addresses of the company + example: &ref_95 + - email_address: acme@gmail.com + email_address_type: WORK nullable: true type: array items: $ref: '#/components/schemas/Email' addresses: description: The addresses of the company + example: &ref_96 + - street_1: 5th Avenue + city: New York + state: NY + country: USA + address_type: WORK nullable: true type: array items: $ref: '#/components/schemas/Address' phone_numbers: description: The phone numbers of the company + example: &ref_97 + - phone_number: '+33660606067' + phone_type: WORK nullable: true type: array items: $ref: '#/components/schemas/Phone' field_mappings: type: object + example: &ref_98 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the company between the remote 3rd party & Panora nullable: true @@ -22673,22 +23508,29 @@ components: id: type: string description: The UUID of the company + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true remote_id: type: string + example: id_1 description: The id of the company in the context of the Crm 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the company in the context of the Crm 3rd Party nullable: true additionalProperties: true created_at: type: object + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: type: object + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true required: @@ -22698,41 +23540,50 @@ components: properties: name: type: string + example: Acme description: The name of the company nullable: true industry: type: string + example: ACCOUNTING + enum: *ref_94 description: >- The industry of the company. Authorized values can be found in the Industry enum. nullable: true number_of_employees: type: number + example: 10 description: The number of employees of the company nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user who owns the company nullable: true email_addresses: description: The email addresses of the company + example: *ref_95 nullable: true type: array items: $ref: '#/components/schemas/Email' addresses: description: The addresses of the company + example: *ref_96 nullable: true type: array items: $ref: '#/components/schemas/Address' phone_numbers: description: The phone numbers of the company + example: *ref_97 nullable: true type: array items: $ref: '#/components/schemas/Phone' field_mappings: type: object + example: *ref_98 description: >- The custom field mappings of the company between the remote 3rd party & Panora nullable: true @@ -22744,27 +23595,42 @@ components: properties: first_name: type: string - nullable: true description: The first name of the contact + example: John + nullable: true last_name: type: string - nullable: true description: The last name of the contact + example: Doe + nullable: true email_addresses: nullable: true description: The email addresses of the contact + example: &ref_99 + - email: john.doe@example.com + type: WORK type: array items: $ref: '#/components/schemas/Email' phone_numbers: nullable: true description: The phone numbers of the contact + example: &ref_100 + - phone: '1234567890' + type: WORK type: array items: $ref: '#/components/schemas/Phone' addresses: nullable: true description: The addresses of the contact + example: &ref_101 + - street: 123 Main St + city: Anytown + state: CA + zip: '12345' + country: USA + type: WORK type: array items: $ref: '#/components/schemas/Address' @@ -22772,33 +23638,44 @@ components: type: string nullable: true description: The UUID of the user who owns the contact + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f field_mappings: type: object + example: &ref_102 + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the contact between the remote 3rd party & Panora additionalProperties: true id: type: string - nullable: true description: The UUID of the contact + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + nullable: true remote_id: type: string + example: id_1 nullable: true description: The id of the contact in the context of the Crm 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the contact in the context of the Crm 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -22809,27 +23686,32 @@ components: properties: first_name: type: string - nullable: true description: The first name of the contact + example: John + nullable: true last_name: type: string - nullable: true description: The last name of the contact + example: Doe + nullable: true email_addresses: nullable: true description: The email addresses of the contact + example: *ref_99 type: array items: $ref: '#/components/schemas/Email' phone_numbers: nullable: true description: The phone numbers of the contact + example: *ref_100 type: array items: $ref: '#/components/schemas/Phone' addresses: nullable: true description: The addresses of the contact + example: *ref_101 type: array items: $ref: '#/components/schemas/Address' @@ -22837,8 +23719,10 @@ components: type: string nullable: true description: The UUID of the user who owns the contact + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f field_mappings: type: object + example: *ref_102 nullable: true description: >- The custom field mappings of the contact between the remote 3rd party & Panora @@ -22851,56 +23735,72 @@ components: properties: name: type: string + example: Huge Contract with Acme description: The name of the deal nullable: true description: type: string + example: Contract with Sales Operations Team description: The description of the deal nullable: true amount: type: number + example: 1000 description: The amount of the deal nullable: true user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user who is on the deal stage_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the stage of the deal company_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the deal field_mappings: type: object nullable: true + example: &ref_103 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the company between the remote 3rd party & Panora additionalProperties: true id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the deal remote_id: type: string nullable: true + example: id_1 description: The id of the deal in the context of the Crm 3rd Party remote_data: type: object nullable: true + example: + fav_dish: broccoli + fav_color: red additionalProperties: true description: The remote data of the deal in the context of the Crm 3rd Party created_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The created date of the object modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modified date of the object required: - name @@ -22911,31 +23811,38 @@ components: properties: name: type: string + example: Huge Contract with Acme description: The name of the deal nullable: true description: type: string + example: Contract with Sales Operations Team description: The description of the deal nullable: true amount: type: number + example: 1000 description: The amount of the deal nullable: true user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user who is on the deal stage_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the stage of the deal company_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the deal field_mappings: type: object nullable: true + example: *ref_103 description: >- The custom field mappings of the company between the remote 3rd party & Panora additionalProperties: true @@ -22949,41 +23856,58 @@ components: content: type: string nullable: true + example: Meeting call with CTO description: The content of the engagement direction: type: string nullable: true + example: INBOUND + enum: &ref_104 + - INBOUND + - OUTBOUND description: >- The direction of the engagement. Authorized values are INBOUND or OUTBOUND subject: type: string + example: Technical features planning nullable: true description: The subject of the engagement start_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The start time of the engagement end_time: format: date-time type: string nullable: true + example: '2024-10-01T22:00:00Z' description: The end time of the engagement type: type: string nullable: true + example: MEETING + enum: &ref_105 + - EMAIL + - CALL + - MEETING description: >- The type of the engagement. Authorized values are EMAIL, CALL or MEETING user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user tied to the engagement company_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the engagement contacts: nullable: true + example: &ref_106 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUIDs of contacts tied to the engagement object type: array items: @@ -22991,19 +23915,27 @@ components: field_mappings: type: object nullable: true + example: &ref_107 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the engagement between the remote 3rd party & Panora additionalProperties: true id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the engagement remote_id: type: string nullable: true + example: id_1 description: The id of the engagement in the context of the Crm 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- @@ -23012,11 +23944,13 @@ components: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The created date of the object modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modified date of the object required: - type @@ -23026,41 +23960,52 @@ components: content: type: string nullable: true + example: Meeting call with CTO description: The content of the engagement direction: type: string nullable: true + example: INBOUND + enum: *ref_104 description: >- The direction of the engagement. Authorized values are INBOUND or OUTBOUND subject: type: string + example: Technical features planning nullable: true description: The subject of the engagement start_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The start time of the engagement end_time: format: date-time type: string nullable: true + example: '2024-10-01T22:00:00Z' description: The end time of the engagement type: type: string nullable: true + example: MEETING + enum: *ref_105 description: >- The type of the engagement. Authorized values are EMAIL, CALL or MEETING user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user tied to the engagement company_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the engagement contacts: nullable: true + example: *ref_106 description: The UUIDs of contacts tied to the engagement object type: array items: @@ -23068,6 +24013,7 @@ components: field_mappings: type: object nullable: true + example: *ref_107 description: >- The custom field mappings of the engagement between the remote 3rd party & Panora additionalProperties: true @@ -23078,51 +24024,66 @@ components: properties: content: type: string + example: My notes taken during the meeting description: The content of the note nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The UUID of the user tied to the note nullable: true - description: The UUID of the user tied the note company_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the company tied to the note contact_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The UUID of the contact tied to the note nullable: true - description: The UUID fo the contact tied to the note deal_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the deal tied to the note field_mappings: type: object + example: &ref_108 + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the note between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the note remote_id: type: string + example: id_1 + description: The ID of the note in the context of the Crm 3rd Party nullable: true - description: The id of the note in the context of the Crm 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the note in the context of the Crm 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -23132,26 +24093,32 @@ components: properties: content: type: string + example: My notes taken during the meeting description: The content of the note nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The UUID of the user tied to the note nullable: true - description: The UUID of the user tied the note company_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the company tied to the note contact_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The UUID of the contact tied to the note nullable: true - description: The UUID fo the contact tied to the note deal_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the deal tied to the note field_mappings: type: object + example: *ref_108 nullable: true description: >- The custom field mappings of the note between the remote 3rd party & Panora @@ -23163,33 +24130,44 @@ components: properties: stage_name: type: string + example: Qualified description: The name of the stage nullable: true field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the stage between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the stage nullable: true remote_id: type: string - description: The id of the stage in the context of the Crm 3rd Party + example: id_1 + description: The ID of the stage in the context of the Crm 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the stage in the context of the Crm 3rd Party nullable: true additionalProperties: true created_at: type: object + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: type: object + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true required: @@ -23199,63 +24177,85 @@ components: properties: subject: type: string + example: Answer customers description: The subject of the task nullable: true content: type: string + example: Prepare email campaign description: The content of the task nullable: true status: type: string + example: PENDING + enum: &ref_109 + - PENDING + - COMPLETED description: The status of the task. Authorized values are PENDING, COMPLETED. nullable: true due_date: - format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The due date of the task nullable: true finished_date: - format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The finished date of the task nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user tied to the task nullable: true company_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the task nullable: true deal_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the deal tied to the task nullable: true field_mappings: type: object + example: &ref_110 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the task between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the task nullable: true remote_id: type: string - description: The id of the task in the context of the Crm 3rd Party + example: id_1 + description: The ID of the task in the context of the Crm 3rd Party nullable: true remote_data: type: object + example: + key1: value1 + key2: 42 + key3: true description: The remote data of the task in the context of the Crm 3rd Party nullable: true additionalProperties: true created_at: - type: object + format: date-time + type: string + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: - type: object + format: date-time + type: string + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true required: @@ -23267,40 +24267,48 @@ components: properties: subject: type: string + example: Answer customers description: The subject of the task nullable: true content: type: string + example: Prepare email campaign description: The content of the task nullable: true status: type: string + example: PENDING + enum: *ref_109 description: The status of the task. Authorized values are PENDING, COMPLETED. nullable: true due_date: - format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The due date of the task nullable: true finished_date: - format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The finished date of the task nullable: true user_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user tied to the task nullable: true company_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the company tied to the task nullable: true deal_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the deal tied to the task nullable: true field_mappings: type: object + example: *ref_110 description: >- The custom field mappings of the task between the remote 3rd party & Panora nullable: true @@ -23314,39 +24322,51 @@ components: properties: name: type: string + example: Jane Doe description: The name of the user nullable: true email: type: string + example: jane.doe@example.com description: The email of the user nullable: true field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the user between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user nullable: true remote_id: type: string + example: id_1 description: The id of the user in the context of the Crm 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the user in the context of the Crm 3rd Party nullable: true additionalProperties: true created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true required: @@ -23357,37 +24377,50 @@ components: properties: name: type: string + example: My Personal Collection nullable: true description: The name of the collection description: type: string + example: Collect issues nullable: true description: The description of the collection collection_type: type: string + example: PROJECT + enum: + - PROJECT + - LIST nullable: true description: "The type of the collection. Authorized values are either PROJECT or LIST " id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the collection remote_id: type: string + example: id_1 nullable: true description: The id of the collection in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the collection in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -23398,36 +24431,45 @@ components: body: type: string nullable: true + example: Assigned to Eric ! description: The body of the comment html_body: type: string nullable: true + example:

Assigned to Eric !

description: The html body of the comment is_private: type: boolean nullable: true + example: false description: The public status of the comment creator_type: type: string nullable: true + example: USER + enum: *ref_111 description: >- The creator type of the comment. Authorized values are either USER or CONTACT ticket_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the ticket the comment is tied to contact_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: >- The UUID of the contact which the comment belongs to (if no user_id specified) user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: >- The UUID of the user which the comment belongs to (if no contact_id specified) attachments: nullable: true + example: *ref_112 description: The attachements UUIDs tied to the comment type: array items: @@ -23435,25 +24477,32 @@ components: id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the comment remote_id: type: string nullable: true + example: id_1 description: The id of the comment in the context of the 3rd Party remote_data: type: object nullable: true + example: + fav_dish: broccoli + fav_color: red additionalProperties: true description: The remote data of the comment in the context of the 3rd Party created_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The created date of the object modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modified date of the object required: - body @@ -23462,37 +24511,48 @@ components: properties: name: type: string + example: urgent_tag nullable: true description: The name of the tag field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the tag between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the tag remote_id: type: string + example: id_1 + description: The remote ID of the tag in the context of the 3rd Party nullable: true - description: The id of the tag in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the tag in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The created date of the tag nullable: true - description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The modified date of the tag nullable: true - description: The modified date of the object required: - name UnifiedTicketingTeamOutput: @@ -23500,39 +24560,51 @@ components: properties: name: type: string + example: My team nullable: true description: The name of the team description: type: string + example: Internal members nullable: true description: The description of the team field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true description: >- The custom field mappings of the team between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the team remote_id: type: string + example: id_1 nullable: true description: The id of the team in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the team in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -23542,15 +24614,19 @@ components: properties: id_linked_user: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true linked_user_origin_id: type: string + example: id_1 nullable: true alias: type: string + example: acme nullable: true id_project: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true required: - id_linked_user @@ -23562,10 +24638,13 @@ components: properties: linked_user_origin_id: type: string - nullable: true + description: The id of the user in the context of your own software + example: id_1 alias: type: string nullable: true + description: Your company alias + example: acme required: - linked_user_origin_id - alias @@ -23574,12 +24653,17 @@ components: properties: linked_user_origin_ids: nullable: true + description: The ids of the users in the context of your own software + example: + - id_1 type: array items: type: string alias: type: string nullable: true + description: Your company alias + example: acme required: - linked_user_origin_ids - alias @@ -23589,60 +24673,77 @@ components: id_attribute: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: Attribute Id status: type: string nullable: true + example: '' description: Attribute Status ressource_owner_type: type: string + example: '' nullable: true description: Attribute Ressource Owner Type slug: type: string nullable: true + example: fav_dish description: Attribute Slug description: type: string nullable: true + example: My favorite dish description: Attribute Description data_type: type: string nullable: true + example: string + enum: + - string + - number description: Attribute Data Type remote_id: type: string nullable: true + example: id_1 description: Attribute Remote Id source: type: string nullable: true + example: hubspot description: Attribute Source id_entity: type: string nullable: true - description: Attribute Id Entity + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: Attribute Entity Id id_project: type: string nullable: true - description: Attribute Id Project + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: Attribute Project Id scope: type: string nullable: true + example: '' description: Attribute Scope id_consumer: type: string nullable: true - description: Attribute Id Consumer + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: Attribute Consumer Id created_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: Attribute Created Date modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: Attribute Modified Date required: - id_attribute @@ -23664,16 +24765,36 @@ components: properties: object_type_owner: type: string + example: company + enum: + - company + - contact + - deal + - lead + - note + - task + - engagement + - stage + - user nullable: true name: type: string nullable: true + example: fav_dish + description: The name of the target field description: type: string nullable: true + example: My favorite dish + description: The description of the target field data_type: type: string nullable: true + example: string + enum: + - string + - number + description: The data type of the target field required: - object_type_owner - name @@ -23684,25 +24805,51 @@ components: properties: object_type_owner: type: string + example: company + enum: + - company + - contact + - deal + - lead + - note + - task + - engagement + - stage + - user nullable: true name: type: string nullable: true + example: my_favorite_dish + description: The name of the custom field description: type: string nullable: true + example: Favorite Dish + description: The description of the custom field data_type: type: string + example: string nullable: true + enum: + - string + - number + description: The data type of the custom field source_custom_field_id: type: string nullable: true + example: id_1 + description: The source custom field ID source_provider: type: string nullable: true + example: hubspot + description: The name of the source software/provider linked_user_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The linked user ID required: - object_type_owner - name @@ -23717,19 +24864,23 @@ components: attributeId: type: string nullable: true - description: Attribute Id + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The attribute ID source_custom_field_id: type: string nullable: true - description: Attribute Id + example: id_1 + description: The source custom field ID source_provider: type: string nullable: true - description: Attribute Id + example: hubspot + description: The source provider linked_user_id: type: string nullable: true - description: Attribute Id + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f + description: The linked user ID required: - attributeId - source_custom_field_id @@ -23755,13 +24906,13 @@ components: type: object properties: method: + type: string enum: - GET - POST - PATCH - DELETE - PUT - type: string path: type: string nullable: true @@ -23781,6 +24932,8 @@ components: required: - method - path + - data + - headers UnifiedHrisBankinfoOutput: type: object properties: {} @@ -23882,56 +25035,80 @@ components: properties: activity_type: type: string + enum: &ref_113 + - NOTE + - EMAIL + - OTHER + example: NOTE nullable: true description: The type of activity subject: type: string + example: Email subject nullable: true description: The subject of the activity body: type: string + example: Dear Diana, I love you nullable: true description: The body of the activity visibility: type: string + enum: &ref_114 + - ADMIN_ONLY + - PUBLIC + - PRIVATE + example: PUBLIC nullable: true description: The visibility of the activity candidate_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate remote_created_at: - format: date-time type: string + format: date-time + example: '2024-10-01T12:00:00Z' nullable: true description: The remote creation date of the activity field_mappings: type: object + example: &ref_115 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the activity remote_id: type: string + example: id_1 nullable: true description: The remote ID of the activity in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the activity in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsActivityInput: @@ -23939,31 +25116,40 @@ components: properties: activity_type: type: string + enum: *ref_113 + example: NOTE nullable: true description: The type of activity subject: type: string + example: Email subject nullable: true description: The subject of the activity body: type: string + example: Dear Diana, I love you nullable: true description: The body of the activity visibility: type: string + enum: *ref_114 + example: PUBLIC nullable: true description: The visibility of the activity candidate_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate remote_created_at: - format: date-time type: string + format: date-time + example: '2024-10-01T12:00:00Z' nullable: true description: The remote creation date of the activity field_mappings: type: object + example: *ref_115 additionalProperties: true nullable: true description: >- @@ -23976,14 +25162,19 @@ components: type: string nullable: true description: The application date + example: '2024-10-01T12:00:00Z' rejected_at: format: date-time type: string nullable: true description: The rejection date + example: '2024-10-01T12:00:00Z' offers: nullable: true description: The offers UUIDs for the application + example: &ref_116 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f + - 12345678-1234-1234-1234-123456789012 type: array items: type: string @@ -23991,27 +25182,36 @@ components: type: string nullable: true description: The source of the application + example: Source Name credited_to: type: string nullable: true description: The UUID of the person credited for the application + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f current_stage: type: string nullable: true description: The UUID of the current stage of the application + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f reject_reason: type: string nullable: true description: The rejection reason for the application + example: Candidate not experienced enough candidate_id: type: string nullable: true description: The UUID of the candidate + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f job_id: type: string description: The UUID of the job + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f field_mappings: type: object + example: &ref_117 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- @@ -24020,23 +25220,30 @@ components: type: string nullable: true description: The UUID of the application + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f remote_id: type: string nullable: true description: The remote ID of the application in the context of the 3rd Party + example: id_1 remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the application in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object remote_created_at: @@ -24057,14 +25264,17 @@ components: type: string nullable: true description: The application date + example: '2024-10-01T12:00:00Z' rejected_at: format: date-time type: string nullable: true description: The rejection date + example: '2024-10-01T12:00:00Z' offers: nullable: true description: The offers UUIDs for the application + example: *ref_116 type: array items: type: string @@ -24072,27 +25282,34 @@ components: type: string nullable: true description: The source of the application + example: Source Name credited_to: type: string nullable: true description: The UUID of the person credited for the application + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f current_stage: type: string nullable: true description: The UUID of the current stage of the application + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f reject_reason: type: string nullable: true description: The rejection reason for the application + example: Candidate not experienced enough candidate_id: type: string nullable: true description: The UUID of the candidate + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f job_id: type: string description: The UUID of the job + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f field_mappings: type: object + example: *ref_117 additionalProperties: true nullable: true description: >- @@ -24102,57 +25319,78 @@ components: properties: file_url: type: string + example: https://example.com/file.pdf nullable: true description: The URL of the file file_name: type: string + example: file.pdf nullable: true description: The name of the file attachment_type: type: string + example: RESUME + enum: &ref_118 + - RESUME + - COVER_LETTER + - OFFER_LETTER + - OTHER nullable: true description: The type of the file remote_created_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote creation date of the attachment remote_modified_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote modification date of the attachment candidate_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate field_mappings: type: object + example: &ref_119 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the attachment remote_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The remote ID of the attachment remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the attachment in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsAttachmentInput: @@ -24160,32 +25398,40 @@ components: properties: file_url: type: string + example: https://example.com/file.pdf nullable: true description: The URL of the file file_name: type: string + example: file.pdf nullable: true description: The name of the file attachment_type: type: string + example: RESUME + enum: *ref_118 nullable: true description: The type of the file remote_created_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote creation date of the attachment remote_modified_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote modification date of the attachment candidate_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate field_mappings: type: object + example: *ref_119 additionalProperties: true nullable: true description: >- @@ -24209,66 +25455,86 @@ components: properties: first_name: type: string + example: Joe nullable: true description: The first name of the candidate last_name: type: string + example: Doe nullable: true description: The last name of the candidate company: type: string + example: Acme nullable: true description: The company of the candidate title: type: string + example: Analyst nullable: true description: The title of the candidate locations: type: string + example: New York nullable: true description: The locations of the candidate is_private: type: boolean + example: false nullable: true description: Whether the candidate is private email_reachable: type: boolean + example: true nullable: true description: Whether the candidate is reachable by email remote_created_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote creation date of the candidate remote_modified_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote modification date of the candidate last_interaction_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The last interaction date with the candidate attachments: + example: &ref_120 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The attachments UUIDs of the candidate type: array items: type: string applications: + example: &ref_121 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The applications UUIDs of the candidate type: array items: type: string tags: + example: &ref_122 + - tag_1 + - tag_2 nullable: true description: The tags of the candidate type: array items: type: string urls: + example: &ref_123 + - url: mywebsite.com + url_type: WEBSITE nullable: true description: >- The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER @@ -24276,12 +25542,18 @@ components: items: $ref: '#/components/schemas/Url' phone_numbers: + example: &ref_124 + - phone_number: '+33660688899' + phone_type: WORK nullable: true description: The phone numbers of the candidate type: array items: $ref: '#/components/schemas/Phone' email_addresses: + example: &ref_125 + - email_address: joedoe@gmail.com + email_address_type: WORK nullable: true description: The email addresses of the candidate type: array @@ -24289,31 +25561,41 @@ components: $ref: '#/components/schemas/Email' field_mappings: type: object + example: &ref_126 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate remote_id: type: string + example: id_1 nullable: true description: The id of the candidate in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the candidate in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsCandidateInput: @@ -24321,66 +25603,80 @@ components: properties: first_name: type: string + example: Joe nullable: true description: The first name of the candidate last_name: type: string + example: Doe nullable: true description: The last name of the candidate company: type: string + example: Acme nullable: true description: The company of the candidate title: type: string + example: Analyst nullable: true description: The title of the candidate locations: type: string + example: New York nullable: true description: The locations of the candidate is_private: type: boolean + example: false nullable: true description: Whether the candidate is private email_reachable: type: boolean + example: true nullable: true description: Whether the candidate is reachable by email remote_created_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote creation date of the candidate remote_modified_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote modification date of the candidate last_interaction_at: - format: date-time type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The last interaction date with the candidate attachments: + example: *ref_120 nullable: true description: The attachments UUIDs of the candidate type: array items: type: string applications: + example: *ref_121 nullable: true description: The applications UUIDs of the candidate type: array items: type: string tags: + example: *ref_122 nullable: true description: The tags of the candidate type: array items: type: string urls: + example: *ref_123 nullable: true description: >- The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER @@ -24388,12 +25684,14 @@ components: items: $ref: '#/components/schemas/Url' phone_numbers: + example: *ref_124 nullable: true description: The phone numbers of the candidate type: array items: $ref: '#/components/schemas/Phone' email_addresses: + example: *ref_125 nullable: true description: The email addresses of the candidate type: array @@ -24401,6 +25699,7 @@ components: $ref: '#/components/schemas/Email' field_mappings: type: object + example: *ref_126 additionalProperties: true nullable: true description: >- @@ -24410,35 +25709,47 @@ components: properties: name: type: string + example: Sales nullable: true description: The name of the department field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the department remote_id: type: string + example: id_1 nullable: true description: The remote ID of the department in the context of the 3rd Party remote_data: type: object + example: + key1: value1 + key2: 42 + key3: true nullable: true additionalProperties: true description: The remote data of the department in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2023-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsInterviewOutput: @@ -24446,21 +25757,31 @@ components: properties: status: type: string + enum: &ref_127 + - SCHEDULED + - AWAITING_FEEDBACK + - COMPLETED + example: SCHEDULED nullable: true description: The status of the interview application_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the application job_interview_stage_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the job interview stage organized_by: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the organizer interviewers: + example: &ref_128 + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUIDs of the interviewers type: array @@ -24468,55 +25789,70 @@ components: type: string location: type: string + example: San Francisco nullable: true description: The location of the interview start_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The start date and time of the interview end_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The end date and time of the interview remote_created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The remote creation date of the interview remote_updated_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The remote modification date of the interview field_mappings: type: object + example: &ref_129 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the interview remote_id: type: string + example: id_1 nullable: true description: The remote ID of the interview in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the interview in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsInterviewInput: @@ -24524,21 +25860,27 @@ components: properties: status: type: string + enum: *ref_127 + example: SCHEDULED nullable: true description: The status of the interview application_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the application job_interview_stage_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the job interview stage organized_by: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the organizer interviewers: + example: *ref_128 nullable: true description: The UUIDs of the interviewers type: array @@ -24546,30 +25888,36 @@ components: type: string location: type: string + example: San Francisco nullable: true description: The location of the interview start_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The start date and time of the interview end_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The end date and time of the interview remote_created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The remote creation date of the interview remote_updated_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The remote modification date of the interview field_mappings: type: object + example: *ref_129 additionalProperties: true nullable: true description: >- @@ -24579,33 +25927,44 @@ components: properties: name: type: string + example: Second Call nullable: true description: The name of the job interview stage stage_order: type: number + example: 1 nullable: true description: The order of the stage job_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the job field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the job interview stage remote_id: type: string + example: id_1 nullable: true description: >- The remote ID of the job interview stage in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: >- @@ -24613,11 +25972,13 @@ components: created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsJobOutput: @@ -24625,47 +25986,71 @@ components: properties: name: type: string + example: Financial Analyst nullable: true description: The name of the job description: type: string + example: Extract financial data and write detailed investment thesis nullable: true description: The description of the job code: type: string + example: JOB123 nullable: true description: The code of the job status: type: string + enum: + - OPEN + - CLOSED + - DRAFT + - ARCHIVED + - PENDING + example: OPEN nullable: true description: The status of the job type: type: string + example: POSTING + enum: + - POSTING + - REQUISITION + - PROFILE nullable: true description: The type of the job confidential: type: boolean + example: true nullable: true description: Whether the job is confidential departments: + example: + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The departments UUIDs associated with the job type: array items: type: string offices: + example: + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The offices UUIDs associated with the job type: array items: type: string managers: + example: + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The managers UUIDs associated with the job type: array items: type: string recruiters: + example: + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The recruiters UUIDs associated with the job type: array @@ -24673,41 +26058,54 @@ components: type: string remote_created_at: type: string + example: '2024-10-01T12:00:00Z' format: date-time nullable: true description: The remote creation date of the job remote_updated_at: type: string + example: '2024-10-01T12:00:00Z' format: date-time nullable: true description: The remote modification date of the job field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the job remote_id: type: string + example: id_1 nullable: true description: The remote ID of the job in the context of the 3rd Party remote_data: type: object + example: + key1: value1 + key2: 42 + key3: true nullable: true additionalProperties: true description: The remote data of the job in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2023-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsOfferOutput: @@ -24715,61 +26113,88 @@ components: properties: created_by: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the creator nullable: true remote_created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The remote creation date of the offer nullable: true closed_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The closing date of the offer nullable: true sent_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The sending date of the offer nullable: true start_date: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The start date of the offer nullable: true status: type: string + example: DRAFT + enum: + - DRAFT + - APPROVAL_SENT + - APPROVED + - SENT + - SENT_MANUALLY + - OPENED + - DENIED + - SIGNED + - DEPRECATED description: The status of the offer nullable: true application_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the application nullable: true field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the object between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the offer nullable: true remote_id: type: string + example: id_1 description: The remote ID of the offer in the context of the 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the offer in the context of the 3rd Party nullable: true additionalProperties: true created_at: type: object + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: type: object + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true UnifiedAtsOfficeOutput: @@ -24777,38 +26202,50 @@ components: properties: name: type: string + example: Condo Office 5th nullable: true description: The name of the office location: type: string + example: New York nullable: true description: The location of the office field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the office remote_id: type: string + example: id_1 nullable: true description: The remote ID of the office in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the office in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsRejectreasonOutput: @@ -24816,10 +26253,14 @@ components: properties: name: type: string + example: Candidate inexperienced nullable: true description: The name of the reject reason field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- @@ -24828,23 +26269,30 @@ components: type: string nullable: true description: The UUID of the reject reason + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f remote_id: type: string nullable: true description: The remote ID of the reject reason in the context of the 3rd Party + example: id_1 remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the reject reason in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsScorecardOutput: @@ -24852,50 +26300,73 @@ components: properties: overall_recommendation: type: string + enum: + - DEFINITELY_NO + - 'NO' + - 'YES' + - STRONG_YES + - NO_DECISION + example: 'YES' nullable: true description: The overall recommendation application_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the application interview_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the interview remote_created_at: type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The remote creation date of the scorecard submitted_at: type: string + example: '2024-10-01T12:00:00Z' + format: date-time nullable: true description: The submission date of the scorecard field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the scorecard remote_id: type: string + example: id_1 nullable: true description: The remote ID of the scorecard in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the scorecard in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAtsTagOutput: @@ -24903,28 +26374,38 @@ components: properties: name: type: string + example: Important nullable: true description: The name of the tag id_ats_candidate: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the tag remote_id: type: string + example: id_1 nullable: true description: The remote ID of the tag in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the tag in the context of the 3rd Party @@ -24932,72 +26413,97 @@ components: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The creation date of the tag modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modification date of the tag UnifiedAtsUserOutput: type: object properties: first_name: type: string + example: John description: The first name of the user nullable: true last_name: type: string + example: Doe description: The last name of the user nullable: true email: type: string + example: john.doe@example.com description: The email of the user nullable: true disabled: type: boolean + example: false description: Whether the user is disabled nullable: true access_role: type: string + example: ADMIN + enum: + - SUPER_ADMIN + - ADMIN + - TEAM_MEMBER + - LIMITED_TEAM_MEMBER + - INTERVIEWER description: The access role of the user nullable: true remote_created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The remote creation date of the user nullable: true remote_modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The remote modification date of the user nullable: true field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the object between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user nullable: true remote_id: type: string + example: id_1 description: The remote ID of the user in the context of the 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the user in the context of the 3rd Party nullable: true additionalProperties: true created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true UnifiedAtsEeocsOutput: @@ -25005,56 +26511,96 @@ components: properties: candidate_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the candidate submitted_at: type: string + example: '2024-10-01T12:00:00Z' format: date-time nullable: true description: The submission date of the EEOC race: type: string + enum: + - AMERICAN_INDIAN_OR_ALASKAN_NATIVE + - ASIAN + - BLACK_OR_AFRICAN_AMERICAN + - HISPANIC_OR_LATINO + - WHITE + - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER + - TWO_OR_MORE_RACES + - DECLINE_TO_SELF_IDENTIFY + example: AMERICAN_INDIAN_OR_ALASKAN_NATIVE nullable: true description: The race of the candidate gender: type: string + example: MALE + enum: + - MALE + - FEMALE + - NON_BINARY + - OTHER + - DECLINE_TO_SELF_IDENTIFY nullable: true description: The gender of the candidate veteran_status: type: string + example: I_AM_NOT_A_PROTECTED_VETERAN + enum: + - I_AM_NOT_A_PROTECTED_VETERAN + - >- + I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN + - I_DONT_WISH_TO_ANSWER nullable: true description: The veteran status of the candidate disability_status: type: string + enum: + - YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY + - NO_I_DONT_HAVE_A_DISABILITY + - I_DONT_WISH_TO_ANSWER + example: YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY nullable: true description: The disability status of the candidate field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the EEOC remote_id: type: string + example: id_1 nullable: true description: The remote ID of the EEOC in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the EEOC in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object UnifiedAccountingAccountOutput: @@ -25147,17 +26693,23 @@ components: name: type: string nullable: true + example: school description: The name of the drive remote_created_at: type: string nullable: true + example: '2024-10-01T12:00:00Z' description: When the third party s drive was created. drive_url: type: string nullable: true + example: https://example.com/school description: The url of the drive field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- @@ -25165,25 +26717,32 @@ components: id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the drive remote_id: type: string nullable: true + example: id_1 description: The id of the drive in the context of the 3rd Party remote_data: type: object nullable: true + example: + fav_dish: broccoli + fav_color: red additionalProperties: true description: The remote data of the drive in the context of the 3rd Party created_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The created date of the object modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modified date of the object required: - name @@ -25194,59 +26753,76 @@ components: properties: name: type: string + example: my_paris_photo.png description: The name of the file nullable: true file_url: type: string + example: https://example.com/my_paris_photo.png description: The url of the file nullable: true mime_type: type: string + example: application/pdf description: The mime type of the file nullable: true size: type: string + example: '1024' description: The size of the file nullable: true folder_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the folder tied to the file nullable: true permission: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the permission tied to the file nullable: true shared_link: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the shared link tied to the file nullable: true field_mappings: type: object + example: &ref_130 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the object between the remote 3rd party & Panora nullable: true additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the file nullable: true remote_id: type: string + example: id_1 description: The id of the file in the context of the 3rd Party nullable: true remote_data: type: object + example: + fav_dish: broccoli + fav_color: red description: The remote data of the file in the context of the 3rd Party nullable: true additionalProperties: true created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The created date of the object nullable: true modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' description: The modified date of the object nullable: true required: @@ -25262,34 +26838,42 @@ components: properties: name: type: string + example: my_paris_photo.png description: The name of the file nullable: true file_url: type: string + example: https://example.com/my_paris_photo.png description: The url of the file nullable: true mime_type: type: string + example: application/pdf description: The mime type of the file nullable: true size: type: string + example: '1024' description: The size of the file nullable: true folder_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the folder tied to the file nullable: true permission: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the permission tied to the file nullable: true shared_link: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the shared link tied to the file nullable: true field_mappings: type: object + example: *ref_130 description: >- The custom field mappings of the object between the remote 3rd party & Panora nullable: true @@ -25307,64 +26891,82 @@ components: properties: name: type: string + example: school nullable: true description: The name of the folder size: type: string + example: '2048' nullable: true description: The size of the folder folder_url: type: string + example: https://example.com/school nullable: true description: The url of the folder description: type: string + example: All things school related description: The description of the folder drive_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the drive tied to the folder parent_folder_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the parent folder shared_link: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the shared link tied to the folder permission: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the permission tied to the folder field_mappings: type: object + example: &ref_131 + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the folder remote_id: type: string + example: id_1 + description: The remote ID of the folder in the context of the 3rd Party nullable: true - description: The id of the folder in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: The remote data of the folder in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The created date of the folder nullable: true - description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' + description: The modified date of the folder nullable: true - description: The modified date of the object required: - name - size @@ -25379,37 +26981,46 @@ components: properties: name: type: string + example: school nullable: true description: The name of the folder size: type: string + example: '2048' nullable: true description: The size of the folder folder_url: type: string + example: https://example.com/school nullable: true description: The url of the folder description: type: string + example: All things school related description: The description of the folder drive_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the drive tied to the folder parent_folder_id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the parent folder shared_link: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the shared link tied to the folder permission: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the permission tied to the folder field_mappings: type: object + example: *ref_131 additionalProperties: true nullable: true description: >- @@ -25428,94 +27039,121 @@ components: properties: name: type: string + example: My group nullable: true description: The name of the group users: + example: + - 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: Uuids of users of the group type: array items: type: string remote_was_deleted: type: boolean + example: false nullable: true description: >- Indicates whether or not this object has been deleted in the third party platform. field_mappings: type: object + example: + fav_dish: broccoli + fav_color: red additionalProperties: true nullable: true description: >- The custom field mappings of the object between the remote 3rd party & Panora id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the group remote_id: type: string + example: id_1 nullable: true description: The id of the group in the context of the 3rd Party remote_data: type: object + example: + fav_dish: broccoli + fav_color: red nullable: true additionalProperties: true description: The remote data of the group in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: - name - users - remote_was_deleted - UnifiedUserOutput: + UnifiedFilestorageUserOutput: type: object properties: name: type: string nullable: true + example: Joe Doe description: The name of the user email: type: string nullable: true + example: joe.doe@gmail.com description: The email of the user is_me: type: boolean nullable: true + example: true description: Whether the user is the one who linked this account. field_mappings: type: object nullable: true + example: + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the object between the remote 3rd party & Panora additionalProperties: true id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the user remote_id: type: string nullable: true + example: id_1 description: The id of the user in the context of the 3rd Party remote_data: type: object nullable: true + example: + fav_dish: broccoli + fav_color: red additionalProperties: true description: The remote data of the user in the context of the 3rd Party created_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The created date of the object modified_at: format: date-time type: string nullable: true + example: '2024-10-01T12:00:00Z' description: The modified date of the object required: - name @@ -25526,51 +27164,66 @@ components: properties: file_name: type: string + example: features_planning.pdf nullable: true description: The file name of the attachment file_url: type: string + example: https://example.com/features_planning.pdf nullable: true description: The file url of the attachment uploader: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The uploader's UUID of the attachment ticket_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the ticket the attachment is tied to comment_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the comment the attachment is tied to field_mappings: type: object nullable: true + example: &ref_132 + fav_dish: broccoli + fav_color: red description: >- The custom field mappings of the attachment between the remote 3rd party & Panora additionalProperties: true id: type: string + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f nullable: true description: The UUID of the attachment remote_id: type: string + example: id_1 nullable: true description: The id of the attachment in the context of the 3rd Party remote_data: type: object additionalProperties: true + example: + fav_dish: broccoli + fav_color: red nullable: true description: The remote data of the attachment in the context of the 3rd Party created_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The created date of the object modified_at: format: date-time type: string + example: '2024-10-01T12:00:00Z' nullable: true description: The modified date of the object required: @@ -25582,27 +27235,33 @@ components: properties: file_name: type: string + example: features_planning.pdf nullable: true description: The file name of the attachment file_url: type: string + example: https://example.com/features_planning.pdf nullable: true description: The file url of the attachment uploader: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The uploader's UUID of the attachment ticket_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the ticket the attachment is tied to comment_id: type: string nullable: true + example: 801f9ede-c698-4e66-a7fc-48d19eebaa4f description: The UUID of the comment the attachment is tied to field_mappings: type: object nullable: true + example: *ref_132 description: >- The custom field mappings of the attachment between the remote 3rd party & Panora additionalProperties: true @@ -25610,7 +27269,6 @@ components: - file_name - file_url - uploader - - field_mappings security: - api_key: [] x-speakeasy-name-override: