From 4a69391c1aaa22fa7663c81407d4331345064160 Mon Sep 17 00:00:00 2001 From: Rachid F Date: Fri, 21 Jun 2024 09:38:34 -0700 Subject: [PATCH 1/2] :art: Improve operationIds for SDK generation --- docker-compose.dev.yml | 96 +- .../api/src/crm/contact/contact.controller.ts | 4 +- packages/api/src/main.ts | 4 +- packages/api/swagger/extended_specs.yaml | 7 + packages/api/swagger/swagger-spec.json | 4 +- packages/api/swagger/swagger-spec.yaml | 14486 ++++++++++++++++ pnpm-lock.yaml | 2 +- 7 files changed, 14549 insertions(+), 54 deletions(-) create mode 100644 packages/api/swagger/extended_specs.yaml create mode 100644 packages/api/swagger/swagger-spec.yaml diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index 506a94ec6..dcedbbf02 100644 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -164,47 +164,47 @@ services: retries: 5 start_period: 10s - webapp-nextjs: - build: - dockerfile: ./apps/client-ts/Dockerfile.dev - context: ./ - args: - VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} - VITE_FRONTEND_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN} - environment: - NEXT_PUBLIC_DISTRIBUTION: ${DISTRIBUTION} - NEXT_PUBLIC_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} - NEXT_PUBLIC_MAGIC_LINK_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN} - NEXT_PUBLIC_WEBAPP_DOMAIN: ${NEXT_PUBLIC_WEBAPP_DOMAIN} - restart: unless-stopped - ports: - - 80:8090 - depends_on: - api: - condition: service_healthy - volumes: - - .:/app - networks: - - backend - - frontend + # webapp-nextjs: + # build: + # dockerfile: ./apps/client-ts/Dockerfile.dev + # context: ./ + # args: + # VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} + # VITE_FRONTEND_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN} + # environment: + # NEXT_PUBLIC_DISTRIBUTION: ${DISTRIBUTION} + # NEXT_PUBLIC_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} + # NEXT_PUBLIC_MAGIC_LINK_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN} + # NEXT_PUBLIC_WEBAPP_DOMAIN: ${NEXT_PUBLIC_WEBAPP_DOMAIN} + # restart: unless-stopped + # ports: + # - 80:8090 + # depends_on: + # api: + # condition: service_healthy + # volumes: + # - .:/app + # networks: + # - backend + # - frontend - magic-link-frontend: - build: - dockerfile: ./apps/magic-link/Dockerfile.dev - context: ./ - args: - VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} - restart: always - ports: - - 81:5173 - depends_on: - api: - condition: service_healthy - networks: - - backend - - frontend - volumes: - - .:/app + # magic-link-frontend: + # build: + # dockerfile: ./apps/magic-link/Dockerfile.dev + # context: ./ + # args: + # VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN} + # restart: always + # ports: + # - 81:5173 + # depends_on: + # api: + # condition: service_healthy + # networks: + # - backend + # - frontend + # volumes: + # - .:/app # ngrok: # image: ngrok/ngrok:latest @@ -223,14 +223,14 @@ services: # condition: service_healthy # network_mode: "host" - docs: - build: - dockerfile: ./Dockerfile.dev - context: ./docs/ - ports: - - 911:3000 - volumes: - - ./docs/:/app + # docs: + # build: + # dockerfile: ./Dockerfile.dev + # context: ./docs/ + # ports: + # - 911:3000 + # volumes: + # - ./docs/:/app networks: frontend: diff --git a/packages/api/src/crm/contact/contact.controller.ts b/packages/api/src/crm/contact/contact.controller.ts index aaf48d0df..ba52cc67c 100644 --- a/packages/api/src/crm/contact/contact.controller.ts +++ b/packages/api/src/crm/contact/contact.controller.ts @@ -44,8 +44,8 @@ export class ContactController { } @ApiOperation({ - operationId: 'getCrmContacts', - summary: 'List a batch of CRM Contacts', + operationId: 'listCrmContacts', + summary: 'List CRM Contacts', }) @ApiHeader({ name: 'x-connection-token', diff --git a/packages/api/src/main.ts b/packages/api/src/main.ts index c0f51a5e2..8f5a83286 100644 --- a/packages/api/src/main.ts +++ b/packages/api/src/main.ts @@ -6,6 +6,8 @@ import * as fs from 'fs'; import * as cookieParser from 'cookie-parser'; import { useContainer } from 'class-validator'; import * as cors from 'cors'; +import * as yaml from 'js-yaml'; + async function bootstrap() { const app = await NestFactory.create(AppModule); @@ -25,7 +27,7 @@ async function bootstrap() { useContainer(app.select(AppModule), { fallbackOnErrors: true }); SwaggerModule.setup('docs', app, document); - //fs.writeFileSync('./swagger/swagger-spec.yaml', yaml.dump(document)); + fs.writeFileSync('./swagger/swagger-spec.yaml', yaml.dump(document)); fs.writeFileSync( './swagger/swagger-spec.json', JSON.stringify(document, null, 2), diff --git a/packages/api/swagger/extended_specs.yaml b/packages/api/swagger/extended_specs.yaml new file mode 100644 index 000000000..44cc0c2c1 --- /dev/null +++ b/packages/api/swagger/extended_specs.yaml @@ -0,0 +1,7 @@ +x-speakeasy-name-override: + - operationId: ^get.* + methodNameOverride: retrieve + - operationId: ^list.* + methodNameOverride: list + - operationId: ^new.* + methodNameOverride: create \ No newline at end of file diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json index d9d20fc5e..6372ebebe 100644 --- a/packages/api/swagger/swagger-spec.json +++ b/packages/api/swagger/swagger-spec.json @@ -1658,8 +1658,8 @@ }, "/crm/contacts": { "get": { - "operationId": "getCrmContacts", - "summary": "List a batch of CRM Contacts", + "operationId": "listCrmContacts", + "summary": "List CRM Contacts", "parameters": [ { "name": "x-connection-token", diff --git a/packages/api/swagger/swagger-spec.yaml b/packages/api/swagger/swagger-spec.yaml new file mode 100644 index 000000000..f6a8072fa --- /dev/null +++ b/packages/api/swagger/swagger-spec.yaml @@ -0,0 +1,14486 @@ +openapi: 3.0.0 +paths: + /: + get: + operationId: getHello + summary: '' + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: string + /health: + get: + operationId: getHealth + summary: '' + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: number + /protected: + get: + operationId: getHelloProtected + summary: '' + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: string + /auth/register: + post: + operationId: signUp + summary: Register + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserDto' + responses: + '201': + description: '' + tags: &ref_0 + - auth + /auth/login: + post: + operationId: signIn + summary: Log In + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LoginDto' + responses: + '201': + description: '' + tags: *ref_0 + /auth/users: + get: + operationId: getPanoraCoreUsers + summary: Get users + parameters: [] + responses: + '200': + description: '' + tags: *ref_0 + /auth/profile: + get: + operationId: AuthController_getProfile + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyUserDto' + '201': + description: '' + tags: *ref_0 + /auth/api-keys: + get: + operationId: getApiKeys + summary: Retrieve API Keys + parameters: [] + responses: + '200': + description: '' + tags: *ref_0 + /auth/api-keys/{id}: + delete: + operationId: deleteApiKey + summary: Delete API Keys + parameters: + - name: id + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + '201': + description: '' + tags: *ref_0 + /auth/generate-apikey: + post: + operationId: generateApiKey + summary: Create API Key + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApiKeyDto' + responses: + '201': + description: '' + tags: *ref_0 + /auth/refresh-token: + post: + operationId: refreshAccessToken + summary: Refresh Access Token + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RefreshDto' + responses: + '201': + description: '' + tags: *ref_0 + /connections/oauth/callback: + get: + operationId: handleOAuthCallback + summary: Capture oAuth callback + parameters: + - name: code + required: true + in: query + schema: + type: string + - name: state + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: &ref_1 + - connections + /connections/gorgias/oauth/install: + get: + operationId: ConnectionsController_handleGorgiasAuthUrl + parameters: + - name: account + required: true + in: query + schema: + type: string + - name: response_type + required: true + in: query + schema: + type: string + - name: nonce + required: true + in: query + schema: + type: string + - name: scope + required: true + in: query + schema: + type: string + - name: client_id + required: true + in: query + schema: + type: string + - name: redirect_uri + required: true + in: query + schema: + type: string + - name: state + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_1 + /connections: + get: + operationId: getConnections + summary: List Connections + parameters: [] + responses: + '200': + description: '' + tags: *ref_1 + /webhook: + get: + operationId: getWebhooksMetadata + summary: 'Retrieve webhooks metadata ' + parameters: [] + responses: + '200': + description: '' + tags: &ref_2 + - webhook + post: + operationId: createWebhookMetadata + summary: Add webhook metadata + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookDto' + responses: + '201': + description: '' + tags: *ref_2 + /webhook/{id}: + delete: + operationId: deleteWebhook + summary: Delete Webhook + parameters: + - name: id + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + '201': + description: '' + tags: *ref_2 + put: + operationId: updateWebhookStatus + summary: Update webhook status + parameters: + - name: id + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + tags: *ref_2 + /webhook/verifyEvent: + post: + operationId: verifyEvent + summary: Verify payload sgnature of the webhook + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureVerificationDto' + responses: + '201': + description: '' + tags: *ref_2 + /managed-webhooks/{id_connection}: + get: + operationId: getManagedWebhooks + summary: Retrieve managed webhooks + parameters: + - name: id_connection + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + tags: &ref_3 + - managed-webhooks + put: + operationId: updateManagedWebhooksStatus + summary: Update managed webhook status + parameters: + - name: id_connection + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + tags: *ref_3 + /managed-webhooks: + post: + operationId: createManagedWebhook + summary: Create managed webhook + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedWebhooksDto' + responses: + '201': + description: '' + tags: *ref_3 + /managed-webhooks/remoteThirdPartyCreation: + post: + operationId: createRemoteThirdPartyWebhook + summary: Create Remote Third Party Webhook + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RemoteThirdPartyCreationDto' + responses: + '201': + description: '' + tags: *ref_3 + /mw/{endpoint_uuid}: + post: + operationId: handleThirdPartyWebhook + summary: Handle Third Party Webhook + parameters: + - name: endpoint_uuid + required: true + in: path + schema: + type: string + responses: + '201': + description: '' + tags: + - mw + /ticketing/tickets: + get: + operationId: getTickets + summary: List a batch of Tickets + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTicketOutput' + tags: &ref_4 + - ticketing/tickets + security: &ref_5 + - JWT: [] + post: + operationId: addTicket + summary: Create a Ticket + description: Create a ticket in any supported Ticketing software + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTicketInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTicketOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTicketOutput' + tags: *ref_4 + security: *ref_5 + patch: + operationId: updateTicket + summary: Update a Ticket + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTicketOutput' + tags: *ref_4 + security: *ref_5 + /ticketing/tickets/{id}: + get: + operationId: getTicket + summary: Retrieve a Ticket + description: Retrieve a ticket from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the `ticket` you want to retrive. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTicketOutput' + tags: *ref_4 + security: *ref_5 + /ticketing/tickets/batch: + post: + operationId: addTickets + summary: Add a batch of Tickets + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTicketInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTicketOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTicketOutput' + tags: *ref_4 + security: *ref_5 + /ticketing/users: + get: + operationId: getTicketingUsers + summary: List a batch of Users + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: &ref_6 + - ticketing/users + security: &ref_7 + - JWT: [] + /ticketing/users/{id}: + get: + operationId: getTicketingUser + summary: Retrieve a User + description: Retrieve a user from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the user you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_6 + security: *ref_7 + /ticketing/accounts: + get: + operationId: getTicketingAccounts + summary: List a batch of Accounts + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: &ref_8 + - ticketing/accounts + security: &ref_9 + - JWT: [] + /ticketing/accounts/{id}: + get: + operationId: getTicketingAccount + summary: Retrieve an Account + description: Retrieve an account from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the account you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: *ref_8 + security: *ref_9 + /ticketing/contacts: + get: + operationId: getTicketingContacts + summary: List all Contacts + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: &ref_10 + - ticketing/contacts + security: &ref_11 + - JWT: [] + /ticketing/contacts/{id}: + get: + operationId: getTicketingContact + summary: Retrieve a Contact + description: Retrieve a contact from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the contact you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_10 + security: *ref_11 + /crm/companies: + get: + operationId: getCompanies + summary: List a batch of Companies + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: &ref_12 + - crm/companies + security: &ref_13 + - JWT: [] + post: + operationId: addCrmCompany + summary: Create a Company + description: Create a company in any supported Crm software + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_12 + security: *ref_13 + patch: + operationId: updateCompany + summary: Update a Company + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_12 + security: *ref_13 + /crm/companies/{id}: + get: + operationId: getCrmCompany + summary: Retrieve a Company + description: Retrieve a company from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the company you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_12 + security: *ref_13 + /crm/companies/batch: + post: + operationId: addCompanies + summary: Add a batch of Companies + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_12 + security: *ref_13 + /crm/contacts: + get: + operationId: listCrmContacts + summary: List CRM Contacts + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: &ref_14 + - crm/contacts + security: &ref_15 + - JWT: [] + post: + operationId: addCrmContact + summary: Create CRM Contact + description: Create a contact in any supported CRM + 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 CRM software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_14 + security: *ref_15 + patch: + operationId: updateContact + summary: Update a CRM Contact + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_14 + security: *ref_15 + /crm/contacts/{id}: + get: + operationId: getCrmContact + summary: Retrieve a CRM Contact + description: Retrieve a contact from any connected CRM + parameters: + - name: id + required: true + in: path + description: id of the `contact` you want to retrive. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original CRM software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_14 + security: *ref_15 + /crm/contacts/batch: + post: + operationId: addCrmContacts + summary: Add a batch of CRM Contacts + 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 CRM software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_14 + security: *ref_15 + /crm/deals: + get: + operationId: getDeals + summary: List a batch of Deals + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDealOutput' + tags: &ref_16 + - crm/deals + security: &ref_17 + - JWT: [] + post: + operationId: addDeal + summary: Create a Deal + description: Create a deal in any supported Crm software + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDealInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDealOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDealOutput' + tags: *ref_16 + security: *ref_17 + /crm/deals/{id}: + get: + operationId: getDeal + summary: Retrieve a Deal + description: Retrieve a deal from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the deal you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDealOutput' + tags: *ref_16 + security: *ref_17 + patch: + operationId: updateDeal + summary: Update a Deal + parameters: + - name: id + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDealOutput' + tags: *ref_16 + security: *ref_17 + /crm/deals/batch: + post: + operationId: addDeals + summary: Add a batch of Deals + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDealInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDealOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDealOutput' + tags: *ref_16 + security: *ref_17 + /crm/engagements: + get: + operationId: getEngagements + summary: List a batch of Engagements + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEngagementOutput' + tags: &ref_18 + - crm/engagements + security: &ref_19 + - JWT: [] + post: + operationId: addEngagement + summary: Create a Engagement + description: Create a engagement in any supported Crm software + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEngagementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEngagementOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEngagementOutput' + tags: *ref_18 + security: *ref_19 + patch: + operationId: updateEngagement + summary: Update a Engagement + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEngagementOutput' + tags: *ref_18 + security: *ref_19 + /crm/engagements/{id}: + get: + operationId: getEngagement + summary: Retrieve a Engagement + description: Retrieve a engagement from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the engagement you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEngagementOutput' + tags: *ref_18 + security: *ref_19 + /crm/engagements/batch: + post: + operationId: addEngagements + summary: Add a batch of Engagements + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEngagementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEngagementOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEngagementOutput' + tags: *ref_18 + security: *ref_19 + /crm/notes: + get: + operationId: getNotes + summary: List a batch of Notes + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedNoteOutput' + tags: &ref_20 + - crm/notes + security: &ref_21 + - JWT: [] + post: + operationId: addNote + summary: Create a Note + description: Create a note in any supported Crm software + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedNoteInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedNoteOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedNoteOutput' + tags: *ref_20 + security: *ref_21 + /crm/notes/{id}: + get: + operationId: getNote + summary: Retrieve a Note + description: Retrieve a note from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the note you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedNoteOutput' + tags: *ref_20 + security: *ref_21 + /crm/notes/batch: + post: + operationId: addNotes + summary: Add a batch of Notes + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedNoteInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedNoteOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedNoteOutput' + tags: *ref_20 + security: *ref_21 + /crm/stages: + get: + operationId: getStages + summary: List a batch of Stages + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedStageOutput' + tags: &ref_22 + - crm/stages + security: &ref_23 + - JWT: [] + /crm/stages/{id}: + get: + operationId: getStage + summary: Retrieve a Stage + description: Retrieve a stage from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the stage you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedStageOutput' + tags: *ref_22 + security: *ref_23 + /crm/tasks: + get: + operationId: getTasks + summary: List a batch of Tasks + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaskOutput' + tags: &ref_24 + - crm/tasks + security: &ref_25 + - JWT: [] + post: + operationId: addTask + summary: Create a Task + description: Create a task in any supported Crm software + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTaskInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaskOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTaskOutput' + tags: *ref_24 + security: *ref_25 + patch: + operationId: updateTask + summary: Update a Task + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaskOutput' + tags: *ref_24 + security: *ref_25 + /crm/tasks/{id}: + get: + operationId: getTask + summary: Retrieve a Task + description: Retrieve a task from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the task you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaskOutput' + tags: *ref_24 + security: *ref_25 + /crm/tasks/batch: + post: + operationId: addTasks + summary: Add a batch of Tasks + 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 Crm software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTaskInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaskOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTaskOutput' + tags: *ref_24 + security: *ref_25 + /crm/users: + get: + operationId: getCrmUsers + summary: List a batch of Users + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: &ref_26 + - crm/users + security: &ref_27 + - JWT: [] + /crm/users/{id}: + get: + operationId: getCrmUser + summary: Retrieve a User + description: Retrieve a user from any connected Crm software + parameters: + - name: id + required: true + in: path + description: id of the user you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Crm software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_26 + security: *ref_27 + /ticketing/collections: + get: + operationId: getCollections + summary: List a batch of Collections + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCollectionOutput' + tags: &ref_28 + - ticketing/collections + security: &ref_29 + - JWT: [] + /ticketing/collections/{id}: + get: + operationId: getCollection + summary: Retrieve a Collection + description: Retrieve a collection from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the collection you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCollectionOutput' + tags: *ref_28 + security: *ref_29 + /ticketing/comments: + get: + operationId: getComments + summary: List a batch of Comments + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCommentOutput' + tags: &ref_30 + - ticketing/comments + security: &ref_31 + - JWT: [] + post: + operationId: addComment + summary: Create a Comment + description: Create a comment in any supported Ticketing software + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCommentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCommentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCommentOutput' + tags: *ref_30 + security: *ref_31 + /ticketing/comments/{id}: + get: + operationId: getComment + summary: Retrieve a Comment + description: Retrieve a comment from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the `comment` you want to retrive. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCommentOutput' + tags: *ref_30 + security: *ref_31 + /ticketing/comments/batch: + post: + operationId: addComments + summary: Add a batch of Comments + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCommentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCommentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCommentOutput' + tags: *ref_30 + security: *ref_31 + /ticketing/tags: + get: + operationId: getTicketingTags + summary: List a batch of Tags + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: &ref_32 + - ticketing/tags + security: &ref_33 + - JWT: [] + /ticketing/tags/{id}: + get: + operationId: getTicketingTag + summary: Retrieve a Tag + description: Retrieve a tag from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the tag you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: *ref_32 + security: *ref_33 + /ticketing/teams: + get: + operationId: getTeams + summary: List a batch of Teams + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTeamOutput' + tags: &ref_34 + - ticketing/teams + security: &ref_35 + - JWT: [] + /ticketing/teams/{id}: + get: + operationId: getTeam + summary: Retrieve a Team + description: Retrieve a team from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the team you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTeamOutput' + tags: *ref_34 + security: *ref_35 + /linked-users: + post: + operationId: addLinkedUser + summary: Add Linked User + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLinkedUserDto' + responses: + '201': + description: '' + tags: &ref_36 + - linked-users + get: + operationId: fetchLinkedUsers + summary: Retrieve Linked Users + parameters: [] + responses: + '200': + description: '' + tags: *ref_36 + /linked-users/batch: + post: + operationId: addBatchLinkedUsers + summary: Add Batch Linked Users + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBatchLinkedUserDto' + responses: + '201': + description: '' + tags: *ref_36 + /linked-users/single: + get: + operationId: getLinkedUser + summary: Retrieve a Linked User + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_36 + /linked-users/fromRemoteId: + get: + operationId: linkedUserFromRemoteId + summary: Retrieve a Linked User From A Remote Id + parameters: + - name: remoteId + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_36 + /organisations: + get: + operationId: getOrganisations + summary: Retrieve Organisations + parameters: [] + responses: + '200': + description: '' + tags: &ref_37 + - organisations + /organisations/create: + post: + operationId: createOrganisation + summary: Create an Organisation + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateOrganizationDto' + responses: + '201': + description: '' + tags: *ref_37 + /projects: + get: + operationId: getProjects + summary: Retrieve projects + parameters: [] + responses: + '200': + description: '' + tags: &ref_38 + - projects + post: + operationId: createProject + summary: Create a project + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateProjectDto' + responses: + '201': + description: '' + tags: *ref_38 + /field-mappings/entities: + get: + operationId: getFieldMappingsEntities + summary: Retrieve field mapping entities + parameters: [] + responses: + '200': + description: '' + tags: &ref_39 + - field-mappings + /field-mappings/attribute: + get: + operationId: getFieldMappings + summary: Retrieve field mappings + parameters: [] + responses: + '200': + description: '' + tags: *ref_39 + /field-mappings/value: + get: + operationId: getFieldMappingValues + summary: Retrieve field mappings values + parameters: [] + responses: + '200': + description: '' + tags: *ref_39 + /field-mappings/define: + post: + operationId: defineTargetField + summary: Define target Field + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DefineTargetFieldDto' + responses: + '201': + description: '' + tags: *ref_39 + /field-mappings: + post: + operationId: createCustomField + summary: Create Custom Field + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldCreateDto' + responses: + '201': + description: '' + tags: *ref_39 + /field-mappings/map: + post: + operationId: mapField + summary: Map Custom Field + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MapFieldToProviderDto' + responses: + '201': + description: '' + tags: *ref_39 + /field-mappings/properties: + get: + operationId: getCustomProviderProperties + summary: Retrieve Custom Properties + parameters: + - name: linkedUserId + required: true + in: query + schema: + type: string + - name: providerId + required: true + in: query + schema: + type: string + - name: vertical + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_39 + /events: + get: + operationId: getPanoraCoreEvents + summary: Retrieve Events + parameters: + - name: page + required: false + in: query + schema: + minimum: 1 + default: 1 + type: number + - name: pageSize + required: false + in: query + schema: + minimum: 1 + default: 10 + type: number + responses: + '200': + description: '' + tags: &ref_40 + - events + /events/count: + get: + operationId: getEventsCount + summary: Retrieve Events Count + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: number + tags: *ref_40 + /magic-links: + post: + operationId: createMagicLink + summary: Create a Magic Link + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMagicLinkDto' + responses: + '201': + description: '' + tags: &ref_41 + - magic-links + get: + operationId: getMagicLinks + summary: Retrieve Magic Links + parameters: [] + responses: + '200': + description: '' + tags: *ref_41 + /magic-links/single: + get: + operationId: getMagicLink + summary: Retrieve a Magic Link + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_41 + /passthrough: + post: + operationId: passthroughRequest + summary: Make a passthrough request + parameters: + - name: integrationId + required: true + in: query + schema: + type: string + - name: linkedUserId + required: true + in: query + schema: + type: string + - name: vertical + required: true + in: query + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PassThroughRequestDto' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/PassThroughResponse' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/PassThroughResponse' + tags: + - passthrough + /connections-strategies/create: + post: + operationId: createConnectionStrategy + summary: Create Connection Strategy + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConnectionStrategyDto' + responses: + '201': + description: '' + tags: &ref_42 + - connections-strategies + /connections-strategies/toggle: + post: + operationId: toggleConnectionStrategy + summary: Activate/Deactivate Connection Strategy + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ToggleStrategyDto' + responses: + '201': + description: '' + tags: *ref_42 + /connections-strategies/delete: + post: + operationId: deleteConnectionStrategy + summary: Delete Connection Strategy + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCSDto' + responses: + '201': + description: '' + tags: *ref_42 + /connections-strategies/update: + post: + operationId: updateConnectionStrategy + summary: Update Connection Strategy + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCSDto' + responses: + '201': + description: '' + tags: *ref_42 + /connections-strategies/credentials: + post: + operationId: getConnectionStrategyCredentials + summary: Get Connection Strategy Credential + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectionStrategyCredentials' + responses: + '201': + description: '' + tags: *ref_42 + /connections-strategies/getCredentials: + get: + operationId: getCredentials + summary: Fetch credentials info needed for connections + parameters: + - name: projectId + required: true + in: query + schema: + type: string + - name: type + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_42 + /connections-strategies/getConnectionStrategiesForProject: + get: + operationId: getConnectionStrategiesForProject + summary: Fetch All Connection Strategies for Project + parameters: [] + responses: + '200': + description: '' + tags: *ref_42 + /syncs/status/{vertical}: + get: + operationId: getSyncStatus + summary: Retrieve sync status of a certain vertical + parameters: + - name: vertical + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + tags: &ref_43 + - syncs + /syncs/resyncs/{vertical}: + get: + operationId: resync + summary: Resync common objects across a vertical + parameters: + - name: vertical + required: true + in: path + schema: + type: string + responses: + '200': + description: '' + tags: *ref_43 + /project-connectors: + post: + operationId: updateConnectorsToProject + summary: Update Connectors for a project + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectConnectorsDto' + responses: + '201': + description: '' + tags: &ref_44 + - project-connectors + get: + operationId: getConnectorsFromProject + summary: Retrieve connectors by Project Id + parameters: + - name: projectId + required: true + in: query + schema: + type: string + - name: getConnectorsFromProject + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + tags: *ref_44 + /hris/bankinfo: + get: + operationId: getBankinfos + summary: List a batch of Bankinfos + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + tags: &ref_45 + - hris/bankinfo + post: + operationId: addBankinfo + summary: Create a Bankinfo + description: Create a bankinfo in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBankInfoInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + tags: *ref_45 + /hris/bankinfo/{id}: + get: + operationId: getBankinfo + summary: Retrieve a Bankinfo + description: Retrieve a bankinfo from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the bankinfo you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + tags: *ref_45 + /hris/bankinfo/batch: + post: + operationId: addBankinfos + summary: Add a batch of Bankinfos + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBankInfoInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBankInfoOutput' + tags: *ref_45 + /hris/benefit: + get: + operationId: getBenefits + summary: List a batch of Benefits + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBenefitOutput' + tags: &ref_46 + - hris/benefit + post: + operationId: addBenefit + summary: Create a Benefit + description: Create a benefit in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBenefitInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBenefitOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBenefitOutput' + tags: *ref_46 + /hris/benefit/{id}: + get: + operationId: getBenefit + summary: Retrieve a Benefit + description: Retrieve a benefit from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the benefit you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBenefitOutput' + tags: *ref_46 + /hris/benefit/batch: + post: + operationId: addBenefits + summary: Add a batch of Benefits + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBenefitInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBenefitOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBenefitOutput' + tags: *ref_46 + /hris/company: + get: + operationId: getCompanys + summary: List a batch of Companys + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: &ref_47 + - hris/company + post: + operationId: addHrisCompany + summary: Create a Company + description: Create a company in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_47 + /hris/company/{id}: + get: + operationId: getHrisCompany + summary: Retrieve a Company + description: Retrieve a company from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the company you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_47 + /hris/company/batch: + post: + operationId: addCompanys + summary: Add a batch of Companys + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyOutput' + tags: *ref_47 + /hris/dependent: + get: + operationId: getDependents + summary: List a batch of Dependents + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDependentOutput' + tags: &ref_48 + - hris/dependent + post: + operationId: addDependent + summary: Create a Dependent + description: Create a dependent in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDependentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDependentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDependentOutput' + tags: *ref_48 + /hris/dependent/{id}: + get: + operationId: getDependent + summary: Retrieve a Dependent + description: Retrieve a dependent from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the dependent you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDependentOutput' + tags: *ref_48 + /hris/dependent/batch: + post: + operationId: addDependents + summary: Add a batch of Dependents + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDependentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDependentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDependentOutput' + tags: *ref_48 + /hris/employeepayrollrun: + get: + operationId: getEmployeePayrollRuns + summary: List a batch of EmployeePayrollRuns + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + tags: &ref_49 + - hris/employeepayrollrun + post: + operationId: addEmployeePayrollRun + summary: Create a EmployeePayrollRun + description: Create a employeepayrollrun in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + tags: *ref_49 + /hris/employeepayrollrun/{id}: + get: + operationId: getEmployeePayrollRun + summary: Retrieve a EmployeePayrollRun + description: Retrieve a employeepayrollrun from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the employeepayrollrun you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + tags: *ref_49 + /hris/employeepayrollrun/batch: + post: + operationId: addEmployeePayrollRuns + summary: Add a batch of EmployeePayrollRuns + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployeePayrollRunOutput' + tags: *ref_49 + /hris/employee: + get: + operationId: getEmployees + summary: List a batch of Employees + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + tags: &ref_50 + - hris/employee + post: + operationId: addEmployee + summary: Create a Employee + description: Create a employee in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployeeInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + tags: *ref_50 + /hris/employee/{id}: + get: + operationId: getEmployee + summary: Retrieve a Employee + description: Retrieve a employee from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the employee you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + tags: *ref_50 + /hris/employee/batch: + post: + operationId: addEmployees + summary: Add a batch of Employees + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployeeInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployeeOutput' + tags: *ref_50 + /hris/employerbenefit: + get: + operationId: getEmployerBenefits + summary: List a batch of EmployerBenefits + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + tags: &ref_51 + - hris/employerbenefit + post: + operationId: addEmployerBenefit + summary: Create a EmployerBenefit + description: Create a employerbenefit in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployerBenefitInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + tags: *ref_51 + /hris/employerbenefit/{id}: + get: + operationId: getEmployerBenefit + summary: Retrieve a EmployerBenefit + description: Retrieve a employerbenefit from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the employerbenefit you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + tags: *ref_51 + /hris/employerbenefit/batch: + post: + operationId: addEmployerBenefits + summary: Add a batch of EmployerBenefits + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployerBenefitInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmployerBenefitOutput' + tags: *ref_51 + /hris/employment: + get: + operationId: getEmployments + summary: List a batch of Employments + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + tags: &ref_52 + - hris/employment + post: + operationId: addEmployment + summary: Create a Employment + description: Create a employment in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmploymentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + tags: *ref_52 + /hris/employment/{id}: + get: + operationId: getEmployment + summary: Retrieve a Employment + description: Retrieve a employment from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the employment you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + tags: *ref_52 + /hris/employment/batch: + post: + operationId: addEmployments + summary: Add a batch of Employments + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmploymentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmploymentOutput' + tags: *ref_52 + /hris/group: + get: + operationId: getGroups + summary: List a batch of Groups + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedGroupOutput' + tags: &ref_53 + - hris/group + post: + operationId: addGroup + summary: Create a Group + description: Create a group in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedGroupInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedGroupOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedGroupOutput' + tags: *ref_53 + /hris/group/{id}: + get: + operationId: getGroup + summary: Retrieve a Group + description: Retrieve a group from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the group you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedGroupOutput' + tags: *ref_53 + /hris/group/batch: + post: + operationId: addGroups + summary: Add a batch of Groups + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedGroupInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedGroupOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedGroupOutput' + tags: *ref_53 + /hris/location: + get: + operationId: getLocations + summary: List a batch of Locations + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedLocationOutput' + tags: &ref_54 + - hris/location + post: + operationId: addLocation + summary: Create a Location + description: Create a location in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedLocationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedLocationOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedLocationOutput' + tags: *ref_54 + /hris/location/{id}: + get: + operationId: getLocation + summary: Retrieve a Location + description: Retrieve a location from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the location you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedLocationOutput' + tags: *ref_54 + /hris/location/batch: + post: + operationId: addLocations + summary: Add a batch of Locations + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedLocationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedLocationOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedLocationOutput' + tags: *ref_54 + /hris/paygroup: + get: + operationId: getPayGroups + summary: List a batch of PayGroups + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + tags: &ref_55 + - hris/paygroup + post: + operationId: addPayGroup + summary: Create a PayGroup + description: Create a paygroup in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPayGroupInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + tags: *ref_55 + /hris/paygroup/{id}: + get: + operationId: getPayGroup + summary: Retrieve a PayGroup + description: Retrieve a paygroup from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the paygroup you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + tags: *ref_55 + /hris/paygroup/batch: + post: + operationId: addPayGroups + summary: Add a batch of PayGroups + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPayGroupInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPayGroupOutput' + tags: *ref_55 + /hris/payrollrun: + get: + operationId: getPayrollRuns + summary: List a batch of PayrollRuns + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + tags: &ref_56 + - hris/payrollrun + post: + operationId: addPayrollRun + summary: Create a PayrollRun + description: Create a payrollrun in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPayrollRunInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + tags: *ref_56 + /hris/payrollrun/{id}: + get: + operationId: getPayrollRun + summary: Retrieve a PayrollRun + description: Retrieve a payrollrun from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the payrollrun you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + tags: *ref_56 + /hris/payrollrun/batch: + post: + operationId: addPayrollRuns + summary: Add a batch of PayrollRuns + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPayrollRunInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPayrollRunOutput' + tags: *ref_56 + /hris/timeoff: + get: + operationId: getTimeoffs + summary: List a batch of Timeoffs + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + tags: &ref_57 + - hris/timeoff + post: + operationId: addTimeoff + summary: Create a Timeoff + description: Create a timeoff in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTimeoffInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + tags: *ref_57 + /hris/timeoff/{id}: + get: + operationId: getTimeoff + summary: Retrieve a Timeoff + description: Retrieve a timeoff from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the timeoff you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + tags: *ref_57 + /hris/timeoff/batch: + post: + operationId: addTimeoffs + summary: Add a batch of Timeoffs + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTimeoffInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTimeoffOutput' + tags: *ref_57 + /hris/timeoffbalance: + get: + operationId: getTimeoffBalances + summary: List a batch of TimeoffBalances + 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 Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + tags: &ref_58 + - hris/timeoffbalance + post: + operationId: addTimeoffBalance + summary: Create a TimeoffBalance + description: Create a timeoffbalance in any supported Hris software + 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 Hris software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTimeoffBalanceInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + tags: *ref_58 + /hris/timeoffbalance/{id}: + get: + operationId: getTimeoffBalance + summary: Retrieve a TimeoffBalance + description: Retrieve a timeoffbalance from any connected Hris software + parameters: + - name: id + required: true + in: path + description: id of the timeoffbalance you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + tags: *ref_58 + /hris/timeoffbalance/batch: + post: + operationId: addTimeoffBalances + summary: Add a batch of TimeoffBalances + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Hris software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTimeoffBalanceInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTimeoffBalanceOutput' + tags: *ref_58 + /marketingautomation/action: + get: + operationId: getActions + summary: List a batch of Actions + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActionOutput' + tags: &ref_59 + - marketingautomation/action + post: + operationId: addAction + summary: Create a Action + description: Create a action in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedActionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActionOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedActionOutput' + tags: *ref_59 + /marketingautomation/action/{id}: + get: + operationId: getAction + summary: Retrieve a Action + description: Retrieve a action from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the action you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActionOutput' + tags: *ref_59 + /marketingautomation/action/batch: + post: + operationId: addActions + summary: Add a batch of Actions + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedActionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActionOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedActionOutput' + tags: *ref_59 + /marketingautomation/automation: + get: + operationId: getAutomations + summary: List a batch of Automations + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAutomationOutput' + tags: &ref_60 + - marketingautomation/automation + post: + operationId: addAutomation + summary: Create a Automation + description: Create a automation in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAutomationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAutomationOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAutomationOutput' + tags: *ref_60 + /marketingautomation/automation/{id}: + get: + operationId: getAutomation + summary: Retrieve a Automation + description: Retrieve a automation from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the automation you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAutomationOutput' + tags: *ref_60 + /marketingautomation/automation/batch: + post: + operationId: addAutomations + summary: Add a batch of Automations + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAutomationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAutomationOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAutomationOutput' + tags: *ref_60 + /marketingautomation/campaign: + get: + operationId: getCampaigns + summary: List a batch of Campaigns + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCampaignOutput' + tags: &ref_61 + - marketingautomation/campaign + post: + operationId: addCampaign + summary: Create a Campaign + description: Create a campaign in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCampaignInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCampaignOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCampaignOutput' + tags: *ref_61 + /marketingautomation/campaign/{id}: + get: + operationId: getCampaign + summary: Retrieve a Campaign + description: Retrieve a campaign from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the campaign you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCampaignOutput' + tags: *ref_61 + /marketingautomation/campaign/batch: + post: + operationId: addCampaigns + summary: Add a batch of Campaigns + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCampaignInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCampaignOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCampaignOutput' + tags: *ref_61 + /marketingautomation/contact: + get: + operationId: getMarketingAutomationContacts + summary: List a batch of Contacts + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: &ref_62 + - marketingautomation/contact + post: + operationId: addMarketingAutomationContact + summary: Create a Contact + description: Create a contact in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_62 + /marketingautomation/contact/{id}: + get: + operationId: getMarketingAutomationContact + summary: Retrieve a Contact + description: Retrieve a contact from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the contact you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_62 + /marketingautomation/contact/batch: + post: + operationId: addMarketingAutomationContacts + summary: Add a batch of Contacts + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_62 + /marketingautomation/email: + get: + operationId: getEmails + summary: List a batch of Emails + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmailOutput' + tags: &ref_63 + - marketingautomation/email + post: + operationId: addEmail + summary: Create a Email + description: Create a email in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmailInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmailOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEmailOutput' + tags: *ref_63 + /marketingautomation/email/{id}: + get: + operationId: getEmail + summary: Retrieve a Email + description: Retrieve a email from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the email you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmailOutput' + tags: *ref_63 + /marketingautomation/email/batch: + post: + operationId: addEmails + summary: Add a batch of Emails + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmailInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEmailOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEmailOutput' + tags: *ref_63 + /marketingautomation/event: + get: + operationId: getMarketingAutomationEvents + summary: List a batch of Events + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEventOutput' + tags: &ref_64 + - marketingautomation/event + post: + operationId: addEvent + summary: Create a Event + description: Create a event in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEventInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEventOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEventOutput' + tags: *ref_64 + /marketingautomation/event/{id}: + get: + operationId: getEvent + summary: Retrieve a Event + description: Retrieve a event from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the event you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEventOutput' + tags: *ref_64 + /marketingautomation/event/batch: + post: + operationId: addEvents + summary: Add a batch of Events + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEventInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEventOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEventOutput' + tags: *ref_64 + /marketingautomation/list: + get: + operationId: getLists + summary: List a batch of Lists + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedListOutput' + tags: &ref_65 + - marketingautomation/list + post: + operationId: addList + summary: Create a List + description: Create a list in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedListInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedListOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedListOutput' + tags: *ref_65 + /marketingautomation/list/{id}: + get: + operationId: getList + summary: Retrieve a List + description: Retrieve a list from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the list you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedListOutput' + tags: *ref_65 + /marketingautomation/list/batch: + post: + operationId: addLists + summary: Add a batch of Lists + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedListInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedListOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedListOutput' + tags: *ref_65 + /marketingautomation/message: + get: + operationId: getMessages + summary: List a batch of Messages + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedMessageOutput' + tags: &ref_66 + - marketingautomation/message + post: + operationId: addMessage + summary: Create a Message + description: Create a message in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedMessageInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedMessageOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedMessageOutput' + tags: *ref_66 + /marketingautomation/message/{id}: + get: + operationId: getMessage + summary: Retrieve a Message + description: Retrieve a message from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the message you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedMessageOutput' + tags: *ref_66 + /marketingautomation/message/batch: + post: + operationId: addMessages + summary: Add a batch of Messages + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedMessageInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedMessageOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedMessageOutput' + tags: *ref_66 + /marketingautomation/template: + get: + operationId: getTemplates + summary: List a batch of Templates + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTemplateOutput' + tags: &ref_67 + - marketingautomation/template + post: + operationId: addTemplate + summary: Create a Template + description: Create a template in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTemplateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTemplateOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTemplateOutput' + tags: *ref_67 + /marketingautomation/template/{id}: + get: + operationId: getTemplate + summary: Retrieve a Template + description: Retrieve a template from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the template you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTemplateOutput' + tags: *ref_67 + /marketingautomation/template/batch: + post: + operationId: addTemplates + summary: Add a batch of Templates + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTemplateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTemplateOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTemplateOutput' + tags: *ref_67 + /marketingautomation/user: + get: + operationId: getMarketingAutomationUsers + summary: List a batch of Users + 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 Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: &ref_68 + - marketingautomation/user + post: + operationId: addMarketingAutomationUser + summary: Create a User + description: Create a user in any supported Marketingautomation software + 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 Marketingautomation + software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedUserInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_68 + /marketingautomation/user/{id}: + get: + operationId: getMarketingAutomationUser + summary: Retrieve a User + description: Retrieve a user from any connected Marketingautomation software + parameters: + - name: id + required: true + in: path + description: id of the user you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_68 + /marketingautomation/user/batch: + post: + operationId: addMarketingAutomationUsers + summary: Add a batch of Users + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: >- + Set to true to include data from the original Marketingautomation + software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedUserInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_68 + /ats/activity: + get: + operationId: getActivitys + summary: List a batch of Activitys + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActivityOutput' + tags: &ref_69 + - ats/activity + post: + operationId: addActivity + summary: Create a Activity + description: Create a activity in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedActivityInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActivityOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedActivityOutput' + tags: *ref_69 + /ats/activity/{id}: + get: + operationId: getActivity + summary: Retrieve a Activity + description: Retrieve a activity from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the activity you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActivityOutput' + tags: *ref_69 + /ats/activity/batch: + post: + operationId: addActivitys + summary: Add a batch of Activitys + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedActivityInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedActivityOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedActivityOutput' + tags: *ref_69 + /ats/application: + get: + operationId: getApplications + summary: List a batch of Applications + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedApplicationOutput' + tags: &ref_70 + - ats/application + post: + operationId: addApplication + summary: Create a Application + description: Create a application in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedApplicationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedApplicationOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedApplicationOutput' + tags: *ref_70 + /ats/application/{id}: + get: + operationId: getApplication + summary: Retrieve a Application + description: Retrieve a application from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the application you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedApplicationOutput' + tags: *ref_70 + /ats/application/batch: + post: + operationId: addApplications + summary: Add a batch of Applications + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedApplicationInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedApplicationOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedApplicationOutput' + tags: *ref_70 + /ats/attachment: + get: + operationId: getAtsAttachments + summary: List a batch of Attachments + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: &ref_71 + - ats/attachment + post: + operationId: addAtsAttachment + summary: Create a Attachment + description: Create a attachment in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_71 + /ats/attachment/{id}: + get: + operationId: getAtsAttachment + summary: Retrieve a Attachment + description: Retrieve a attachment from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the attachment you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_71 + /ats/attachment/batch: + post: + operationId: addAtsAttachments + summary: Add a batch of Attachments + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_71 + /ats/candidate: + get: + operationId: getCandidates + summary: List a batch of Candidates + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCandidateOutput' + tags: &ref_72 + - ats/candidate + post: + operationId: addCandidate + summary: Create a Candidate + description: Create a candidate in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCandidateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCandidateOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCandidateOutput' + tags: *ref_72 + /ats/candidate/{id}: + get: + operationId: getCandidate + summary: Retrieve a Candidate + description: Retrieve a candidate from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the candidate you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCandidateOutput' + tags: *ref_72 + /ats/candidate/batch: + post: + operationId: addCandidates + summary: Add a batch of Candidates + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCandidateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCandidateOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCandidateOutput' + tags: *ref_72 + /ats/department: + get: + operationId: getDepartments + summary: List a batch of Departments + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + tags: &ref_73 + - ats/department + post: + operationId: addDepartment + summary: Create a Department + description: Create a department in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDepartmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + tags: *ref_73 + /ats/department/{id}: + get: + operationId: getDepartment + summary: Retrieve a Department + description: Retrieve a department from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the department you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + tags: *ref_73 + /ats/department/batch: + post: + operationId: addDepartments + summary: Add a batch of Departments + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDepartmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDepartmentOutput' + tags: *ref_73 + /ats/interview: + get: + operationId: getInterviews + summary: List a batch of Interviews + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInterviewOutput' + tags: &ref_74 + - ats/interview + post: + operationId: addInterview + summary: Create a Interview + description: Create a interview in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedInterviewInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInterviewOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedInterviewOutput' + tags: *ref_74 + /ats/interview/{id}: + get: + operationId: getInterview + summary: Retrieve a Interview + description: Retrieve a interview from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the interview you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInterviewOutput' + tags: *ref_74 + /ats/interview/batch: + post: + operationId: addInterviews + summary: Add a batch of Interviews + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedInterviewInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInterviewOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedInterviewOutput' + tags: *ref_74 + /ats/jobinterviewstage: + get: + operationId: getJobInterviewStages + summary: List a batch of JobInterviewStages + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + tags: &ref_75 + - ats/jobinterviewstage + post: + operationId: addJobInterviewStage + summary: Create a JobInterviewStage + description: Create a jobinterviewstage in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJobInterviewStageInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + tags: *ref_75 + /ats/jobinterviewstage/{id}: + get: + operationId: getJobInterviewStage + summary: Retrieve a JobInterviewStage + description: Retrieve a jobinterviewstage from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the jobinterviewstage you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + tags: *ref_75 + /ats/jobinterviewstage/batch: + post: + operationId: addJobInterviewStages + summary: Add a batch of JobInterviewStages + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJobInterviewStageInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJobInterviewStageOutput' + tags: *ref_75 + /ats/job: + get: + operationId: getJobs + summary: List a batch of Jobs + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobOutput' + tags: &ref_76 + - ats/job + post: + operationId: addJob + summary: Create a Job + description: Create a job in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJobInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJobOutput' + tags: *ref_76 + /ats/job/{id}: + get: + operationId: getJob + summary: Retrieve a Job + description: Retrieve a job from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the job you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobOutput' + tags: *ref_76 + /ats/job/batch: + post: + operationId: addJobs + summary: Add a batch of Jobs + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJobInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJobOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJobOutput' + tags: *ref_76 + /ats/offer: + get: + operationId: getOffers + summary: List a batch of Offers + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfferOutput' + tags: &ref_77 + - ats/offer + post: + operationId: addOffer + summary: Create a Offer + description: Create a offer in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedOfferInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfferOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedOfferOutput' + tags: *ref_77 + /ats/offer/{id}: + get: + operationId: getOffer + summary: Retrieve a Offer + description: Retrieve a offer from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the offer you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfferOutput' + tags: *ref_77 + /ats/offer/batch: + post: + operationId: addOffers + summary: Add a batch of Offers + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedOfferInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfferOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedOfferOutput' + tags: *ref_77 + /ats/office: + get: + operationId: getOffices + summary: List a batch of Offices + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfficeOutput' + tags: &ref_78 + - ats/office + post: + operationId: addOffice + summary: Create a Office + description: Create a office in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedOfficeInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfficeOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedOfficeOutput' + tags: *ref_78 + /ats/office/{id}: + get: + operationId: getOffice + summary: Retrieve a Office + description: Retrieve a office from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the office you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfficeOutput' + tags: *ref_78 + /ats/office/batch: + post: + operationId: addOffices + summary: Add a batch of Offices + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedOfficeInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedOfficeOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedOfficeOutput' + tags: *ref_78 + /ats/rejectreason: + get: + operationId: getRejectReasons + summary: List a batch of RejectReasons + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + tags: &ref_79 + - ats/rejectreason + post: + operationId: addRejectReason + summary: Create a RejectReason + description: Create a rejectreason in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedRejectReasonInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + tags: *ref_79 + /ats/rejectreason/{id}: + get: + operationId: getRejectReason + summary: Retrieve a RejectReason + description: Retrieve a rejectreason from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the rejectreason you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + tags: *ref_79 + /ats/rejectreason/batch: + post: + operationId: addRejectReasons + summary: Add a batch of RejectReasons + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedRejectReasonInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedRejectReasonOutput' + tags: *ref_79 + /ats/scorecard: + get: + operationId: getScoreCards + summary: List a batch of ScoreCards + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + tags: &ref_80 + - ats/scorecard + post: + operationId: addScoreCard + summary: Create a ScoreCard + description: Create a scorecard in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedScoreCardInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + tags: *ref_80 + /ats/scorecard/{id}: + get: + operationId: getScoreCard + summary: Retrieve a ScoreCard + description: Retrieve a scorecard from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the scorecard you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + tags: *ref_80 + /ats/scorecard/batch: + post: + operationId: addScoreCards + summary: Add a batch of ScoreCards + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedScoreCardInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedScoreCardOutput' + tags: *ref_80 + /ats/screeningquestion: + get: + operationId: getScreeningQuestions + summary: List a batch of ScreeningQuestions + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + tags: &ref_81 + - ats/screeningquestion + post: + operationId: addScreeningQuestion + summary: Create a ScreeningQuestion + description: Create a screeningquestion in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedScreeningQuestionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + tags: *ref_81 + /ats/screeningquestion/{id}: + get: + operationId: getScreeningQuestion + summary: Retrieve a ScreeningQuestion + description: Retrieve a screeningquestion from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the screeningquestion you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + tags: *ref_81 + /ats/screeningquestion/batch: + post: + operationId: addScreeningQuestions + summary: Add a batch of ScreeningQuestions + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedScreeningQuestionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedScreeningQuestionOutput' + tags: *ref_81 + /ats/tag: + get: + operationId: getAtsTags + summary: List a batch of Tags + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: &ref_82 + - ats/tag + post: + operationId: addTag + summary: Create a Tag + description: Create a tag in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTagInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: *ref_82 + /ats/tag/{id}: + get: + operationId: getAtsTag + summary: Retrieve a Tag + description: Retrieve a tag from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the tag you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: *ref_82 + /ats/tag/batch: + post: + operationId: addTags + summary: Add a batch of Tags + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTagInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTagOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTagOutput' + tags: *ref_82 + /ats/user: + get: + operationId: getAtsUsers + summary: List a batch of Users + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: &ref_83 + - ats/user + post: + operationId: addAtsUser + summary: Create a User + description: Create a user in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedUserInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_83 + /ats/user/{id}: + get: + operationId: getAtsUser + summary: Retrieve a User + description: Retrieve a user from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the user you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_83 + /ats/user/batch: + post: + operationId: addAtsUsers + summary: Add a batch of Users + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedUserInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedUserOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedUserOutput' + tags: *ref_83 + /ats/eeocs: + get: + operationId: getEeocss + summary: List a batch of Eeocss + 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 Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEeocsOutput' + tags: &ref_84 + - ats/eeocs + post: + operationId: addEeocs + summary: Create a Eeocs + description: Create a eeocs in any supported Ats software + 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 Ats software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEeocsInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEeocsOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedEeocsOutput' + tags: *ref_84 + /ats/eeocs/{id}: + get: + operationId: getEeocs + summary: Retrieve a Eeocs + description: Retrieve a eeocs from any connected Ats software + parameters: + - name: id + required: true + in: path + description: id of the eeocs you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEeocsOutput' + tags: *ref_84 + /ats/eeocs/batch: + post: + operationId: addEeocss + summary: Add a batch of Eeocss + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ats software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEeocsInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedEeocsOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedEeocsOutput' + tags: *ref_84 + /accounting/account: + get: + operationId: getAccountingAccounts + summary: List a batch of Accounts + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: &ref_85 + - accounting/account + post: + operationId: addAccount + summary: Create a Account + description: Create a account in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAccountInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: *ref_85 + /accounting/account/{id}: + get: + operationId: getAccountingAccount + summary: Retrieve a Account + description: Retrieve a account from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the account you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: *ref_85 + /accounting/account/batch: + post: + operationId: addAccounts + summary: Add a batch of Accounts + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAccountInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAccountOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAccountOutput' + tags: *ref_85 + /accounting/address: + get: + operationId: getAddresss + summary: List a batch of Addresss + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAddressOutput' + tags: &ref_86 + - accounting/address + post: + operationId: addAddress + summary: Create a Address + description: Create a address in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAddressInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAddressOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAddressOutput' + tags: *ref_86 + /accounting/address/{id}: + get: + operationId: getAddress + summary: Retrieve a Address + description: Retrieve a address from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the address you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAddressOutput' + tags: *ref_86 + /accounting/address/batch: + post: + operationId: addAddresss + summary: Add a batch of Addresss + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAddressInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAddressOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAddressOutput' + tags: *ref_86 + /accounting/attachment: + get: + operationId: getAccountingAttachments + summary: List a batch of Attachments + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: &ref_87 + - accounting/attachment + post: + operationId: addAccountingAttachment + summary: Create a Attachment + description: Create a attachment in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_87 + /accounting/attachment/{id}: + get: + operationId: getAccountingAttachment + summary: Retrieve a Attachment + description: Retrieve a attachment from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the attachment you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_87 + /accounting/attachment/batch: + post: + operationId: addAccountingAttachments + summary: Add a batch of Attachments + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_87 + /accounting/balancesheet: + get: + operationId: getBalanceSheets + summary: List a batch of BalanceSheets + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + tags: &ref_88 + - accounting/balancesheet + post: + operationId: addBalanceSheet + summary: Create a BalanceSheet + description: Create a balancesheet in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBalanceSheetInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + tags: *ref_88 + /accounting/balancesheet/{id}: + get: + operationId: getBalanceSheet + summary: Retrieve a BalanceSheet + description: Retrieve a balancesheet from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the balancesheet you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + tags: *ref_88 + /accounting/balancesheet/batch: + post: + operationId: addBalanceSheets + summary: Add a batch of BalanceSheets + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBalanceSheetInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedBalanceSheetOutput' + tags: *ref_88 + /accounting/cashflowstatement: + get: + operationId: getCashflowStatements + summary: List a batch of CashflowStatements + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + tags: &ref_89 + - accounting/cashflowstatement + post: + operationId: addCashflowStatement + summary: Create a CashflowStatement + description: Create a cashflowstatement in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCashflowStatementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + tags: *ref_89 + /accounting/cashflowstatement/{id}: + get: + operationId: getCashflowStatement + summary: Retrieve a CashflowStatement + description: Retrieve a cashflowstatement from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the cashflowstatement you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + tags: *ref_89 + /accounting/cashflowstatement/batch: + post: + operationId: addCashflowStatements + summary: Add a batch of CashflowStatements + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCashflowStatementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCashflowStatementOutput' + tags: *ref_89 + /accounting/companyinfo: + get: + operationId: getCompanyInfos + summary: List a batch of CompanyInfos + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + tags: &ref_90 + - accounting/companyinfo + post: + operationId: addCompanyInfo + summary: Create a CompanyInfo + description: Create a companyinfo in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyInfoInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + tags: *ref_90 + /accounting/companyinfo/{id}: + get: + operationId: getCompanyInfo + summary: Retrieve a CompanyInfo + description: Retrieve a companyinfo from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the companyinfo you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + tags: *ref_90 + /accounting/companyinfo/batch: + post: + operationId: addCompanyInfos + summary: Add a batch of CompanyInfos + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyInfoInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCompanyInfoOutput' + tags: *ref_90 + /accounting/contact: + get: + operationId: getAccountingContacts + summary: List a batch of Contacts + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: &ref_91 + - accounting/contact + post: + operationId: addAccountingContact + summary: Create a Contact + description: Create a contact in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_91 + /accounting/contact/{id}: + get: + operationId: getAccountingContact + summary: Retrieve a Contact + description: Retrieve a contact from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the contact you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_91 + /accounting/contact/batch: + post: + operationId: addAccountingContacts + summary: Add a batch of Contacts + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedContactOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedContactOutput' + tags: *ref_91 + /accounting/creditnote: + get: + operationId: getCreditNotes + summary: List a batch of CreditNotes + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + tags: &ref_92 + - accounting/creditnote + post: + operationId: addCreditNote + summary: Create a CreditNote + description: Create a creditnote in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCreditNoteInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + tags: *ref_92 + /accounting/creditnote/{id}: + get: + operationId: getCreditNote + summary: Retrieve a CreditNote + description: Retrieve a creditnote from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the creditnote you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + tags: *ref_92 + /accounting/creditnote/batch: + post: + operationId: addCreditNotes + summary: Add a batch of CreditNotes + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCreditNoteInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedCreditNoteOutput' + tags: *ref_92 + /accounting/expense: + get: + operationId: getExpenses + summary: List a batch of Expenses + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedExpenseOutput' + tags: &ref_93 + - accounting/expense + post: + operationId: addExpense + summary: Create a Expense + description: Create a expense in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedExpenseInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedExpenseOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedExpenseOutput' + tags: *ref_93 + /accounting/expense/{id}: + get: + operationId: getExpense + summary: Retrieve a Expense + description: Retrieve a expense from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the expense you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedExpenseOutput' + tags: *ref_93 + /accounting/expense/batch: + post: + operationId: addExpenses + summary: Add a batch of Expenses + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedExpenseInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedExpenseOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedExpenseOutput' + tags: *ref_93 + /accounting/incomestatement: + get: + operationId: getIncomeStatements + summary: List a batch of IncomeStatements + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + tags: &ref_94 + - accounting/incomestatement + post: + operationId: addIncomeStatement + summary: Create a IncomeStatement + description: Create a incomestatement in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedIncomeStatementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + tags: *ref_94 + /accounting/incomestatement/{id}: + get: + operationId: getIncomeStatement + summary: Retrieve a IncomeStatement + description: Retrieve a incomestatement from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the incomestatement you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + tags: *ref_94 + /accounting/incomestatement/batch: + post: + operationId: addIncomeStatements + summary: Add a batch of IncomeStatements + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedIncomeStatementInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedIncomeStatementOutput' + tags: *ref_94 + /accounting/invoice: + get: + operationId: getInvoices + summary: List a batch of Invoices + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + tags: &ref_95 + - accounting/invoice + post: + operationId: addInvoice + summary: Create a Invoice + description: Create a invoice in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedInvoiceInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + tags: *ref_95 + /accounting/invoice/{id}: + get: + operationId: getInvoice + summary: Retrieve a Invoice + description: Retrieve a invoice from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the invoice you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + tags: *ref_95 + /accounting/invoice/batch: + post: + operationId: addInvoices + summary: Add a batch of Invoices + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedInvoiceInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedInvoiceOutput' + tags: *ref_95 + /accounting/item: + get: + operationId: getItems + summary: List a batch of Items + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedItemOutput' + tags: &ref_96 + - accounting/item + post: + operationId: addItem + summary: Create a Item + description: Create a item in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedItemInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedItemOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedItemOutput' + tags: *ref_96 + /accounting/item/{id}: + get: + operationId: getItem + summary: Retrieve a Item + description: Retrieve a item from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the item you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedItemOutput' + tags: *ref_96 + /accounting/item/batch: + post: + operationId: addItems + summary: Add a batch of Items + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedItemInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedItemOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedItemOutput' + tags: *ref_96 + /accounting/journalentry: + get: + operationId: getJournalEntrys + summary: List a batch of JournalEntrys + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + tags: &ref_97 + - accounting/journalentry + post: + operationId: addJournalEntry + summary: Create a JournalEntry + description: Create a journalentry in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJournalEntryInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + tags: *ref_97 + /accounting/journalentry/{id}: + get: + operationId: getJournalEntry + summary: Retrieve a JournalEntry + description: Retrieve a journalentry from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the journalentry you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + tags: *ref_97 + /accounting/journalentry/batch: + post: + operationId: addJournalEntrys + summary: Add a batch of JournalEntrys + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJournalEntryInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedJournalEntryOutput' + tags: *ref_97 + /accounting/payment: + get: + operationId: getPayments + summary: List a batch of Payments + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPaymentOutput' + tags: &ref_98 + - accounting/payment + post: + operationId: addPayment + summary: Create a Payment + description: Create a payment in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPaymentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPaymentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPaymentOutput' + tags: *ref_98 + /accounting/payment/{id}: + get: + operationId: getPayment + summary: Retrieve a Payment + description: Retrieve a payment from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the payment you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPaymentOutput' + tags: *ref_98 + /accounting/payment/batch: + post: + operationId: addPayments + summary: Add a batch of Payments + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPaymentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPaymentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPaymentOutput' + tags: *ref_98 + /accounting/phonenumber: + get: + operationId: getPhoneNumbers + summary: List a batch of PhoneNumbers + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + tags: &ref_99 + - accounting/phonenumber + post: + operationId: addPhoneNumber + summary: Create a PhoneNumber + description: Create a phonenumber in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPhoneNumberInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + tags: *ref_99 + /accounting/phonenumber/{id}: + get: + operationId: getPhoneNumber + summary: Retrieve a PhoneNumber + description: Retrieve a phonenumber from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the phonenumber you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + tags: *ref_99 + /accounting/phonenumber/batch: + post: + operationId: addPhoneNumbers + summary: Add a batch of PhoneNumbers + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPhoneNumberInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPhoneNumberOutput' + tags: *ref_99 + /accounting/purchaseorder: + get: + operationId: getPurchaseOrders + summary: List a batch of PurchaseOrders + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + tags: &ref_100 + - accounting/purchaseorder + post: + operationId: addPurchaseOrder + summary: Create a PurchaseOrder + description: Create a purchaseorder in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPurchaseOrderInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + tags: *ref_100 + /accounting/purchaseorder/{id}: + get: + operationId: getPurchaseOrder + summary: Retrieve a PurchaseOrder + description: Retrieve a purchaseorder from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the purchaseorder you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + tags: *ref_100 + /accounting/purchaseorder/batch: + post: + operationId: addPurchaseOrders + summary: Add a batch of PurchaseOrders + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPurchaseOrderInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPurchaseOrderOutput' + tags: *ref_100 + /accounting/taxrate: + get: + operationId: getTaxRates + summary: List a batch of TaxRates + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + tags: &ref_101 + - accounting/taxrate + post: + operationId: addTaxRate + summary: Create a TaxRate + description: Create a taxrate in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTaxRateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + tags: *ref_101 + /accounting/taxrate/{id}: + get: + operationId: getTaxRate + summary: Retrieve a TaxRate + description: Retrieve a taxrate from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the taxrate you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + tags: *ref_101 + /accounting/taxrate/batch: + post: + operationId: addTaxRates + summary: Add a batch of TaxRates + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTaxRateInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTaxRateOutput' + tags: *ref_101 + /accounting/trackingcategory: + get: + operationId: getTrackingCategorys + summary: List a batch of TrackingCategorys + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + tags: &ref_102 + - accounting/trackingcategory + post: + operationId: addTrackingCategory + summary: Create a TrackingCategory + description: Create a trackingcategory in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTrackingCategoryInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + tags: *ref_102 + /accounting/trackingcategory/{id}: + get: + operationId: getTrackingCategory + summary: Retrieve a TrackingCategory + description: Retrieve a trackingcategory from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the trackingcategory you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + tags: *ref_102 + /accounting/trackingcategory/batch: + post: + operationId: addTrackingCategorys + summary: Add a batch of TrackingCategorys + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTrackingCategoryInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTrackingCategoryOutput' + tags: *ref_102 + /accounting/transaction: + get: + operationId: getTransactions + summary: List a batch of Transactions + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTransactionOutput' + tags: &ref_103 + - accounting/transaction + post: + operationId: addTransaction + summary: Create a Transaction + description: Create a transaction in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTransactionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTransactionOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedTransactionOutput' + tags: *ref_103 + /accounting/transaction/{id}: + get: + operationId: getTransaction + summary: Retrieve a Transaction + description: Retrieve a transaction from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the transaction you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTransactionOutput' + tags: *ref_103 + /accounting/transaction/batch: + post: + operationId: addTransactions + summary: Add a batch of Transactions + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTransactionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedTransactionOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedTransactionOutput' + tags: *ref_103 + /accounting/vendorcredit: + get: + operationId: getVendorCredits + summary: List a batch of VendorCredits + 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 Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + tags: &ref_104 + - accounting/vendorcredit + post: + operationId: addVendorCredit + summary: Create a VendorCredit + description: Create a vendorcredit in any supported Accounting software + 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 Accounting software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedVendorCreditInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + tags: *ref_104 + /accounting/vendorcredit/{id}: + get: + operationId: getVendorCredit + summary: Retrieve a VendorCredit + description: Retrieve a vendorcredit from any connected Accounting software + parameters: + - name: id + required: true + in: path + description: id of the vendorcredit you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + tags: *ref_104 + /accounting/vendorcredit/batch: + post: + operationId: addVendorCredits + summary: Add a batch of VendorCredits + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Accounting software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedVendorCreditInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedVendorCreditOutput' + tags: *ref_104 + /filestorage/drive: + get: + operationId: getDrives + summary: List a batch of Drives + 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 Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDriveOutput' + tags: &ref_105 + - filestorage/drive + post: + operationId: addDrive + summary: Create a Drive + description: Create a drive in any supported Filestorage software + 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 Filestorage software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDriveInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDriveOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedDriveOutput' + tags: *ref_105 + /filestorage/drive/{id}: + get: + operationId: getDrive + summary: Retrieve a Drive + description: Retrieve a drive from any connected Filestorage software + parameters: + - name: id + required: true + in: path + description: id of the drive you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDriveOutput' + tags: *ref_105 + /filestorage/drive/batch: + post: + operationId: addDrives + summary: Add a batch of Drives + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDriveInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedDriveOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedDriveOutput' + tags: *ref_105 + /filestorage/file: + get: + operationId: getFiles + summary: List a batch of Files + 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 Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFileOutput' + tags: &ref_106 + - filestorage/file + post: + operationId: addFile + summary: Create a File + description: Create a file in any supported Filestorage software + 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 Filestorage software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedFileInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFileOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedFileOutput' + tags: *ref_106 + /filestorage/file/{id}: + get: + operationId: getFile + summary: Retrieve a File + description: Retrieve a file from any connected Filestorage software + parameters: + - name: id + required: true + in: path + description: id of the file you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFileOutput' + tags: *ref_106 + /filestorage/file/batch: + post: + operationId: addFiles + summary: Add a batch of Files + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedFileInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFileOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedFileOutput' + tags: *ref_106 + /filestorage/folder: + get: + operationId: getFolders + summary: List a batch of Folders + 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 Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFolderOutput' + tags: &ref_107 + - filestorage/folder + post: + operationId: addFolder + summary: Create a Folder + description: Create a folder in any supported Filestorage software + 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 Filestorage software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedFolderInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFolderOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedFolderOutput' + tags: *ref_107 + /filestorage/folder/{id}: + get: + operationId: getFolder + summary: Retrieve a Folder + description: Retrieve a folder from any connected Filestorage software + parameters: + - name: id + required: true + in: path + description: id of the folder you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFolderOutput' + tags: *ref_107 + /filestorage/folder/batch: + post: + operationId: addFolders + summary: Add a batch of Folders + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedFolderInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedFolderOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedFolderOutput' + tags: *ref_107 + /filestorage/sharedlink: + get: + operationId: getSharedlinks + summary: List a batch of Sharedlinks + 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 Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + tags: &ref_108 + - filestorage/sharedlink + post: + operationId: addSharedlink + summary: Create a Sharedlink + description: Create a sharedlink in any supported Filestorage software + 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 Filestorage software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedSharedLinkInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + tags: *ref_108 + /filestorage/sharedlink/{id}: + get: + operationId: getSharedlink + summary: Retrieve a Sharedlink + description: Retrieve a sharedlink from any connected Filestorage software + parameters: + - name: id + required: true + in: path + description: id of the sharedlink you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + tags: *ref_108 + /filestorage/sharedlink/batch: + post: + operationId: addSharedlinks + summary: Add a batch of Sharedlinks + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedSharedLinkInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedSharedLinkOutput' + tags: *ref_108 + /filestorage/permission: + get: + operationId: getPermissions + summary: List a batch of Permissions + 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 Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPermissionOutput' + tags: &ref_109 + - filestorage/permission + post: + operationId: addPermission + summary: Create a Permission + description: Create a permission in any supported Filestorage software + 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 Filestorage software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPermissionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPermissionOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedPermissionOutput' + tags: *ref_109 + patch: + operationId: updatePermission + summary: Update a Permission + parameters: + - name: id + required: true + in: query + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPermissionOutput' + tags: *ref_109 + /filestorage/permission/{id}: + get: + operationId: getPermission + summary: Retrieve a Permission + description: Retrieve a permission from any connected Filestorage software + parameters: + - name: id + required: true + in: path + description: id of the permission you want to retrieve. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPermissionOutput' + tags: *ref_109 + /filestorage/permission/batch: + post: + operationId: addPermissions + summary: Add a batch of Permissions + parameters: + - name: connection_token + required: true + in: header + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Filestorage software. + schema: + type: boolean + - name: x-connection-token + in: header + description: The connection token + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPermissionInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedPermissionOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedPermissionOutput' + tags: *ref_109 + /ticketing/attachments: + get: + operationId: getTicketingAttachments + summary: List a batch of Attachments + 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: pageSize + required: false + in: query + description: Set to get the number of records. + schema: + default: 50 + type: number + - name: cursor + required: false + in: query + description: Set to get the number of records after this cursor. + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: &ref_110 + - ticketing/attachments + security: &ref_111 + - JWT: [] + post: + operationId: addTicketingAttachment + summary: Create a Attachment + description: Create a attachment in any supported Ticketing software + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_110 + security: *ref_111 + /ticketing/attachments/{id}: + get: + operationId: getTicketingAttachment + summary: Retrieve a Attachment + description: Retrieve a attachment from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the attachment you want to retrive. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_110 + security: *ref_111 + /ticketing/attachments/{id}/download: + get: + operationId: downloadAttachment + summary: Download a Attachment + description: Download a attachment from any connected Ticketing software + parameters: + - name: id + required: true + in: path + description: id of the attachment you want to retrive. + schema: + type: string + - name: remote_data + required: false + in: query + description: Set to true to include data from the original Ticketing software. + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_110 + security: *ref_111 + /ticketing/attachments/batch: + post: + operationId: addTicketingAttachments + summary: Add a batch of Attachments + 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 Ticketing software. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentInput' + responses: + '200': + description: '' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ApiResponse' + - properties: + data: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + '201': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + tags: *ref_110 + security: *ref_111 +info: + title: Unified Panora API + description: The Panora API description + version: '1.0' + contact: {} +tags: [] +x-speakeasy-name-override: + - operationId: ^get.* + methodNameOverride: retrieve + - operationId: ^list.* + methodNameOverride: list + - operationId: ^new.* + methodNameOverride: create +servers: + - url: https://api.panora.dev + description: Production server + - url: https://api-sandbox.panora.dev + description: Sandbox server +components: + securitySchemes: + JWT: + scheme: bearer + bearerFormat: JWT + type: http + schemas: + CreateUserDto: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + strategy: + type: string + password_hash: + type: string + id_organisation: + type: string + required: + - first_name + - last_name + - email + - strategy + LoginDto: + type: object + properties: + id_user: + type: string + email: + type: string + password_hash: + type: string + required: + - email + - password_hash + VerifyUserDto: + type: object + properties: + id_user: + type: string + email: + type: string + first_name: + type: string + last_name: + type: string + required: + - id_user + - email + - first_name + - last_name + ApiKeyDto: + type: object + properties: + projectId: + type: string + userId: + type: string + keyName: + type: string + required: + - projectId + - userId + - keyName + RefreshDto: + type: object + properties: + projectId: + type: string + required: + - projectId + WebhookDto: + type: object + properties: + url: + type: string + description: + type: string + id_project: + type: string + scope: + type: array + items: + type: string + required: + - url + - id_project + - scope + SignatureVerificationDto: + type: object + properties: + signature: + type: string + secret: + type: string + required: + - signature + - secret + ManagedWebhooksDto: + type: object + properties: + id_connection: + type: string + scopes: + type: array + items: + type: string + api_version: + type: string + remote_signature_secret: + type: string + required: + - id_connection + - scopes + RemoteThirdPartyCreationDto: + type: object + properties: + id_connection: + type: string + mw_ids: + type: array + items: + type: string + required: + - id_connection + - mw_ids + ApiResponse: + type: object + properties: + message: + type: string + error: + type: string + statusCode: + type: number + required: + - statusCode + UnifiedCommentInput: + type: object + properties: + body: + type: string + description: The body of the comment + html_body: + type: string + description: The html body of the comment + is_private: + type: boolean + description: The public status of the comment + creator_type: + type: string + description: >- + The creator type of the comment. Authorized values are either USER + or CONTACT + ticket_id: + type: string + description: The uuid of the ticket the comment is tied to + contact_id: + type: string + description: >- + The uuid of the contact which the comment belongs to (if no user_id + specified) + user_id: + type: string + description: >- + The uuid of the user which the comment belongs to (if no contact_id + specified) + attachments: + description: The attachements uuids tied to the comment + type: array + items: + type: string + required: + - body + UnifiedTicketOutput: + type: object + properties: + name: + type: string + description: The name of the ticket + status: + type: string + description: The status of the ticket. Authorized values are OPEN or CLOSED. + description: + type: string + description: The description of the ticket + due_date: + format: date-time + type: string + description: The date the ticket is due + type: + type: string + description: >- + The type of the ticket. Authorized values are PROBLEM, QUESTION, or + TASK + parent_ticket: + type: string + description: The uuid of the parent ticket + project_id: + type: string + description: The uuid of the collection (project) the ticket belongs to + tags: + description: The tags names of the ticket + type: array + items: + type: string + completed_at: + format: date-time + type: string + description: The date the ticket has been completed + priority: + type: string + description: >- + The priority of the ticket. Authorized values are HIGH, MEDIUM or + LOW. + assigned_to: + description: The users uuids the ticket is assigned to + type: array + items: + type: string + comment: + description: The comment of the ticket + allOf: + - $ref: '#/components/schemas/UnifiedCommentInput' + account_id: + type: string + description: The uuid of the account which the ticket belongs to + contact_id: + type: string + description: The uuid of the contact which the ticket belongs to + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the ticket + remote_id: + type: string + description: The id of the ticket in the context of the 3rd Party + remote_data: + type: object + properties: {} + required: + - name + - description + - field_mappings + - remote_data + UnifiedTicketInput: + type: object + properties: + name: + type: string + description: The name of the ticket + status: + type: string + description: The status of the ticket. Authorized values are OPEN or CLOSED. + description: + type: string + description: The description of the ticket + due_date: + format: date-time + type: string + description: The date the ticket is due + type: + type: string + description: >- + The type of the ticket. Authorized values are PROBLEM, QUESTION, or + TASK + parent_ticket: + type: string + description: The uuid of the parent ticket + project_id: + type: string + description: The uuid of the collection (project) the ticket belongs to + tags: + description: The tags names of the ticket + type: array + items: + type: string + completed_at: + format: date-time + type: string + description: The date the ticket has been completed + priority: + type: string + description: >- + The priority of the ticket. Authorized values are HIGH, MEDIUM or + LOW. + assigned_to: + description: The users uuids the ticket is assigned to + type: array + items: + type: string + comment: + description: The comment of the ticket + allOf: + - $ref: '#/components/schemas/UnifiedCommentInput' + account_id: + type: string + description: The uuid of the account which the ticket belongs to + contact_id: + type: string + description: The uuid of the contact which the ticket belongs to + field_mappings: + type: object + properties: {} + required: + - name + - description + - field_mappings + UnifiedUserOutput: + type: object + properties: {} + UnifiedAccountOutput: + type: object + properties: {} + UnifiedContactOutput: + type: object + properties: {} + Email: + type: object + properties: + email_address: + type: string + description: The email address + email_address_type: + type: string + description: >- + The email address type. Authorized values are either PERSONAL or + WORK. + owner_type: + type: string + description: The owner type of an email + required: + - email_address + - email_address_type + Address: + type: object + properties: + street_1: + type: string + description: The street + street_2: + type: string + description: 'More information about the street ' + city: + type: string + description: The city + state: + type: string + description: The state + postal_code: + type: string + description: The postal code + country: + type: string + description: The country + address_type: + type: string + description: The address type. Authorized values are either PERSONAL or WORK. + owner_type: + type: string + description: The owner type of the address + required: + - street_1 + - street_2 + - city + - state + - postal_code + - country + - address_type + - owner_type + Phone: + type: object + properties: + phone_number: + type: string + description: >- + The phone number starting with a plus (+) followed by the country + code (e.g +336676778890 for France) + phone_type: + type: string + description: The phone type. Authorized values are either MOBILE or WORK + owner_type: + type: string + description: The owner type of a phone number + required: + - phone_number + - phone_type + UnifiedCompanyOutput: + type: object + properties: {} + UnifiedCompanyInput: + type: object + properties: {} + UnifiedContactInput: + type: object + properties: {} + UnifiedDealOutput: + type: object + properties: + name: + type: string + description: The name of the deal + description: + type: string + description: The description of the deal + amount: + type: number + description: The amount of the deal + user_id: + type: string + description: The uuid of the user who is on the deal + stage_id: + type: string + description: The uuid of the stage of the deal + company_id: + type: string + description: The uuid of the company tied to the deal + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the deal + remote_id: + type: string + description: The id of the deal in the context of the Crm 3rd Party + remote_data: + type: object + properties: {} + required: + - name + - description + - amount + - field_mappings + - remote_data + UnifiedDealInput: + type: object + properties: + name: + type: string + description: The name of the deal + description: + type: string + description: The description of the deal + amount: + type: number + description: The amount of the deal + user_id: + type: string + description: The uuid of the user who is on the deal + stage_id: + type: string + description: The uuid of the stage of the deal + company_id: + type: string + description: The uuid of the company tied to the deal + field_mappings: + type: object + properties: {} + required: + - name + - description + - amount + - field_mappings + UnifiedEngagementOutput: + type: object + properties: + content: + type: string + description: The content of the engagement + direction: + type: string + description: >- + The direction of the engagement. Authorized values are INBOUND or + OUTBOUND + subject: + type: string + description: The subject of the engagement + start_at: + format: date-time + type: string + description: The start time of the engagement + end_time: + format: date-time + type: string + description: The end time of the engagement + type: + type: string + description: >- + The type of the engagement. Authorized values are EMAIL, CALL or + MEETING + user_id: + type: string + description: The uuid of the user tied to the engagement + company_id: + type: string + description: The uuid of the company tied to the engagement + contacts: + description: The uuids of contacts tied to the engagement object + type: array + items: + type: string + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the engagement + remote_id: + type: string + description: The id of the engagement in the context of the Crm 3rd Party + remote_data: + type: object + properties: {} + required: + - type + - field_mappings + - remote_data + UnifiedEngagementInput: + type: object + properties: + content: + type: string + description: The content of the engagement + direction: + type: string + description: >- + The direction of the engagement. Authorized values are INBOUND or + OUTBOUND + subject: + type: string + description: The subject of the engagement + start_at: + format: date-time + type: string + description: The start time of the engagement + end_time: + format: date-time + type: string + description: The end time of the engagement + type: + type: string + description: >- + The type of the engagement. Authorized values are EMAIL, CALL or + MEETING + user_id: + type: string + description: The uuid of the user tied to the engagement + company_id: + type: string + description: The uuid of the company tied to the engagement + contacts: + description: The uuids of contacts tied to the engagement object + type: array + items: + type: string + field_mappings: + type: object + properties: {} + required: + - type + - field_mappings + UnifiedNoteOutput: + type: object + properties: + content: + type: string + description: The content of the note + user_id: + type: string + description: The uuid of the user tied the note + company_id: + type: string + description: The uuid of the company tied to the note + contact_id: + type: string + description: The uuid fo the contact tied to the note + deal_id: + type: string + description: The uuid of the deal tied to the note + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the note + remote_id: + type: string + description: The id of the note in the context of the Crm 3rd Party + remote_data: + type: object + properties: {} + required: + - content + - field_mappings + - remote_data + UnifiedNoteInput: + type: object + properties: + content: + type: string + description: The content of the note + user_id: + type: string + description: The uuid of the user tied the note + company_id: + type: string + description: The uuid of the company tied to the note + contact_id: + type: string + description: The uuid fo the contact tied to the note + deal_id: + type: string + description: The uuid of the deal tied to the note + field_mappings: + type: object + properties: {} + required: + - content + - field_mappings + UnifiedStageOutput: + type: object + properties: + stage_name: + type: string + description: The name of the stage + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the stage + remote_id: + type: string + description: The id of the stage in the context of the Crm 3rd Party + remote_data: + type: object + properties: {} + required: + - stage_name + - field_mappings + - remote_data + UnifiedTaskOutput: + type: object + properties: + subject: + type: string + description: The subject of the task + content: + type: string + description: The content of the task + status: + type: string + description: The status of the task. Authorized values are PENDING, COMPLETED. + due_date: + format: date-time + type: string + description: The due date of the task + finished_date: + format: date-time + type: string + description: The finished date of the task + user_id: + type: string + description: The uuid of the user tied to the task + company_id: + type: string + description: The uuid fo the company tied to the task + deal_id: + type: string + description: The uuid of the deal tied to the task + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the task + remote_id: + type: string + description: The id of the task in the context of the Crm 3rd Party + remote_data: + type: object + properties: {} + required: + - subject + - content + - status + - field_mappings + - remote_data + UnifiedTaskInput: + type: object + properties: + subject: + type: string + description: The subject of the task + content: + type: string + description: The content of the task + status: + type: string + description: The status of the task. Authorized values are PENDING, COMPLETED. + due_date: + format: date-time + type: string + description: The due date of the task + finished_date: + format: date-time + type: string + description: The finished date of the task + user_id: + type: string + description: The uuid of the user tied to the task + company_id: + type: string + description: The uuid fo the company tied to the task + deal_id: + type: string + description: The uuid of the deal tied to the task + field_mappings: + type: object + properties: {} + required: + - subject + - content + - status + - field_mappings + UnifiedCollectionOutput: + type: object + properties: + name: + type: string + description: The name of the collection + description: + type: string + description: The description of the collection + collection_type: + type: string + description: >- + The type of the collection. Authorized values are either PROJECT or + LIST + id: + type: string + description: The uuid of the collection + remote_id: + type: string + description: The id of the collection in the context of the 3rd Party + remote_data: + type: object + properties: {} + required: + - name + - remote_data + UnifiedAttachmentOutput: + type: object + properties: + file_name: + type: string + description: The file name of the attachment + file_url: + type: string + description: The file url of the attachment + uploader: + type: string + description: The uploader's uuid of the attachment + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the attachment + remote_id: + type: string + description: The id of the attachment in the context of the 3rd Party + remote_data: + type: object + properties: {} + required: + - file_name + - file_url + - uploader + - field_mappings + - remote_data + UnifiedCommentOutput: + type: object + properties: + body: + type: string + description: The body of the comment + html_body: + type: string + description: The html body of the comment + is_private: + type: boolean + description: The public status of the comment + creator_type: + type: string + description: >- + The creator type of the comment. Authorized values are either USER + or CONTACT + ticket_id: + type: string + description: The uuid of the ticket the comment is tied to + contact_id: + type: string + description: >- + The uuid of the contact which the comment belongs to (if no user_id + specified) + user_id: + type: string + description: >- + The uuid of the user which the comment belongs to (if no contact_id + specified) + attachments: + description: The attachemnets tied to the comment + type: array + items: + $ref: '#/components/schemas/UnifiedAttachmentOutput' + id: + type: string + description: The uuid of the comment + remote_id: + type: string + description: The id of the comment in the context of the 3rd Party + remote_data: + type: object + properties: {} + required: + - body + - remote_data + UnifiedTagOutput: + type: object + properties: {} + UnifiedTeamOutput: + type: object + properties: + name: + type: string + description: The name of the team + description: + type: string + description: The description of the team + field_mappings: + type: object + properties: {} + id: + type: string + description: The uuid of the team + remote_id: + type: string + description: The id of the team in the context of the 3rd Party + remote_data: + type: object + properties: {} + required: + - name + - field_mappings + - remote_data + CreateLinkedUserDto: + type: object + properties: + linked_user_origin_id: + type: string + alias: + type: string + id_project: + type: string + required: + - linked_user_origin_id + - alias + - id_project + CreateBatchLinkedUserDto: + type: object + properties: + linked_user_origin_ids: + type: array + items: + type: string + alias: + type: string + id_project: + type: string + required: + - linked_user_origin_ids + - alias + - id_project + CreateOrganizationDto: + type: object + properties: + name: + type: string + stripe_customer_id: + type: string + required: + - name + - stripe_customer_id + CreateProjectDto: + type: object + properties: + name: + type: string + id_organization: + type: string + id_user: + type: string + required: + - name + - id_user + DefineTargetFieldDto: + type: object + properties: + object_type_owner: + type: string + name: + type: string + description: + type: string + data_type: + type: string + required: + - object_type_owner + - name + - description + - data_type + CustomFieldCreateDto: + type: object + properties: + object_type_owner: + type: string + name: + type: string + description: + type: string + data_type: + type: string + source_custom_field_id: + type: string + source_provider: + type: string + linked_user_id: + type: string + required: + - object_type_owner + - name + - description + - data_type + - source_custom_field_id + - source_provider + - linked_user_id + MapFieldToProviderDto: + type: object + properties: + attributeId: + type: string + source_custom_field_id: + type: string + source_provider: + type: string + linked_user_id: + type: string + required: + - attributeId + - source_custom_field_id + - source_provider + - linked_user_id + CreateMagicLinkDto: + type: object + properties: + linked_user_origin_id: + type: string + email: + type: string + alias: + type: string + id_project: + type: string + required: + - linked_user_origin_id + - email + - alias + - id_project + PassThroughRequestDto: + type: object + properties: + method: + enum: + - GET + - POST + - PATCH + - DELETE + - PUT + type: string + path: + type: string + data: + type: object + headers: + type: object + required: + - method + - path + PassThroughResponse: + type: object + properties: + url: + type: string + status: + type: number + data: + type: object + required: + - url + - status + - data + CreateConnectionStrategyDto: + type: object + properties: + type: + type: string + attributes: + type: array + items: + type: string + values: + type: array + items: + type: string + required: + - type + - attributes + - values + ToggleStrategyDto: + type: object + properties: + id_cs: + type: string + required: + - id_cs + DeleteCSDto: + type: object + properties: + id: + type: string + required: + - id + UpdateCSDto: + type: object + properties: + id_cs: + type: string + status: + type: boolean + attributes: + type: array + items: + type: string + values: + type: array + items: + type: string + required: + - id_cs + - status + - attributes + - values + ConnectionStrategyCredentials: + type: object + properties: + type: + type: string + attributes: + type: array + items: + type: string + required: + - type + - attributes + ProjectConnectorsDto: + type: object + properties: + column: + type: string + status: + type: boolean + required: + - column + - status + UnifiedBankInfoOutput: + type: object + properties: {} + UnifiedBankInfoInput: + type: object + properties: {} + UnifiedBenefitOutput: + type: object + properties: {} + UnifiedBenefitInput: + type: object + properties: {} + UnifiedDependentOutput: + type: object + properties: {} + UnifiedDependentInput: + type: object + properties: {} + UnifiedEmployeePayrollRunOutput: + type: object + properties: {} + UnifiedEmployeePayrollRunInput: + type: object + properties: {} + UnifiedEmployeeOutput: + type: object + properties: {} + UnifiedEmployeeInput: + type: object + properties: {} + UnifiedEmployerBenefitOutput: + type: object + properties: {} + UnifiedEmployerBenefitInput: + type: object + properties: {} + UnifiedEmploymentOutput: + type: object + properties: {} + UnifiedEmploymentInput: + type: object + properties: {} + UnifiedGroupOutput: + type: object + properties: {} + UnifiedGroupInput: + type: object + properties: {} + UnifiedLocationOutput: + type: object + properties: {} + UnifiedLocationInput: + type: object + properties: {} + UnifiedPayGroupOutput: + type: object + properties: {} + UnifiedPayGroupInput: + type: object + properties: {} + UnifiedPayrollRunOutput: + type: object + properties: {} + UnifiedPayrollRunInput: + type: object + properties: {} + UnifiedTimeoffOutput: + type: object + properties: {} + UnifiedTimeoffInput: + type: object + properties: {} + UnifiedTimeoffBalanceOutput: + type: object + properties: {} + UnifiedTimeoffBalanceInput: + type: object + properties: {} + UnifiedActionOutput: + type: object + properties: {} + UnifiedActionInput: + type: object + properties: {} + UnifiedAutomationOutput: + type: object + properties: {} + UnifiedAutomationInput: + type: object + properties: {} + UnifiedCampaignOutput: + type: object + properties: {} + UnifiedCampaignInput: + type: object + properties: {} + UnifiedEmailOutput: + type: object + properties: {} + UnifiedEmailInput: + type: object + properties: {} + UnifiedEventOutput: + type: object + properties: {} + UnifiedEventInput: + type: object + properties: {} + UnifiedListOutput: + type: object + properties: {} + UnifiedListInput: + type: object + properties: {} + UnifiedMessageOutput: + type: object + properties: {} + UnifiedMessageInput: + type: object + properties: {} + UnifiedTemplateOutput: + type: object + properties: {} + UnifiedTemplateInput: + type: object + properties: {} + UnifiedUserInput: + type: object + properties: {} + UnifiedActivityOutput: + type: object + properties: {} + UnifiedActivityInput: + type: object + properties: {} + UnifiedApplicationOutput: + type: object + properties: {} + UnifiedApplicationInput: + type: object + properties: {} + UnifiedAttachmentInput: + type: object + properties: + file_name: + type: string + description: The file name of the attachment + file_url: + type: string + description: The file url of the attachment + uploader: + type: string + description: The uploader's uuid of the attachment + field_mappings: + type: object + properties: {} + required: + - file_name + - file_url + - uploader + - field_mappings + UnifiedCandidateOutput: + type: object + properties: {} + UnifiedCandidateInput: + type: object + properties: {} + UnifiedDepartmentOutput: + type: object + properties: {} + UnifiedDepartmentInput: + type: object + properties: {} + UnifiedInterviewOutput: + type: object + properties: {} + UnifiedInterviewInput: + type: object + properties: {} + UnifiedJobInterviewStageOutput: + type: object + properties: {} + UnifiedJobInterviewStageInput: + type: object + properties: {} + UnifiedJobOutput: + type: object + properties: {} + UnifiedJobInput: + type: object + properties: {} + UnifiedOfferOutput: + type: object + properties: {} + UnifiedOfferInput: + type: object + properties: {} + UnifiedOfficeOutput: + type: object + properties: {} + UnifiedOfficeInput: + type: object + properties: {} + UnifiedRejectReasonOutput: + type: object + properties: {} + UnifiedRejectReasonInput: + type: object + properties: {} + UnifiedScoreCardOutput: + type: object + properties: {} + UnifiedScoreCardInput: + type: object + properties: {} + UnifiedScreeningQuestionOutput: + type: object + properties: {} + UnifiedScreeningQuestionInput: + type: object + properties: {} + UnifiedTagInput: + type: object + properties: {} + UnifiedEeocsOutput: + type: object + properties: {} + UnifiedEeocsInput: + type: object + properties: {} + UnifiedAccountInput: + type: object + properties: {} + UnifiedAddressOutput: + type: object + properties: {} + UnifiedAddressInput: + type: object + properties: {} + UnifiedBalanceSheetOutput: + type: object + properties: {} + UnifiedBalanceSheetInput: + type: object + properties: {} + UnifiedCashflowStatementOutput: + type: object + properties: {} + UnifiedCashflowStatementInput: + type: object + properties: {} + UnifiedCompanyInfoOutput: + type: object + properties: {} + UnifiedCompanyInfoInput: + type: object + properties: {} + UnifiedCreditNoteOutput: + type: object + properties: {} + UnifiedCreditNoteInput: + type: object + properties: {} + UnifiedExpenseOutput: + type: object + properties: {} + UnifiedExpenseInput: + type: object + properties: {} + UnifiedIncomeStatementOutput: + type: object + properties: {} + UnifiedIncomeStatementInput: + type: object + properties: {} + UnifiedInvoiceOutput: + type: object + properties: {} + UnifiedInvoiceInput: + type: object + properties: {} + UnifiedItemOutput: + type: object + properties: {} + UnifiedItemInput: + type: object + properties: {} + UnifiedJournalEntryOutput: + type: object + properties: {} + UnifiedJournalEntryInput: + type: object + properties: {} + UnifiedPaymentOutput: + type: object + properties: {} + UnifiedPaymentInput: + type: object + properties: {} + UnifiedPhoneNumberOutput: + type: object + properties: {} + UnifiedPhoneNumberInput: + type: object + properties: {} + UnifiedPurchaseOrderOutput: + type: object + properties: {} + UnifiedPurchaseOrderInput: + type: object + properties: {} + UnifiedTaxRateOutput: + type: object + properties: {} + UnifiedTaxRateInput: + type: object + properties: {} + UnifiedTrackingCategoryOutput: + type: object + properties: {} + UnifiedTrackingCategoryInput: + type: object + properties: {} + UnifiedTransactionOutput: + type: object + properties: {} + UnifiedTransactionInput: + type: object + properties: {} + UnifiedVendorCreditOutput: + type: object + properties: {} + UnifiedVendorCreditInput: + type: object + properties: {} + UnifiedDriveOutput: + type: object + properties: {} + UnifiedDriveInput: + type: object + properties: {} + UnifiedFileOutput: + type: object + properties: {} + UnifiedFileInput: + type: object + properties: {} + UnifiedFolderOutput: + type: object + properties: {} + UnifiedFolderInput: + type: object + properties: {} + UnifiedSharedLinkOutput: + type: object + properties: {} + UnifiedSharedLinkInput: + type: object + properties: {} + UnifiedPermissionOutput: + type: object + properties: {} + UnifiedPermissionInput: + type: object + properties: {} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f6f7e1c35..941fab88c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -10880,7 +10880,7 @@ packages: atomic-sleep: 1.0.0 fast-redact: 3.5.0 on-exit-leak-free: 2.1.2 - pino-abstract-transport: 1.1.0 + pino-abstract-transport: 1.2.0 pino-std-serializers: 6.2.2 process-warning: 3.0.0 quick-format-unescaped: 4.0.4 From 56183916916384af7625a4a70f92987249be2a57 Mon Sep 17 00:00:00 2001 From: Rachid F Date: Fri, 21 Jun 2024 10:05:59 -0700 Subject: [PATCH 2/2] :art: Preparing operationIds for SDK generation --- packages/api/src/app.controller.ts | 1 - packages/api/swagger/swagger-spec.json | 3 +-- packages/api/swagger/swagger-spec.yaml | 3 +-- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/packages/api/src/app.controller.ts b/packages/api/src/app.controller.ts index 2c23905e1..528f1a242 100644 --- a/packages/api/src/app.controller.ts +++ b/packages/api/src/app.controller.ts @@ -13,7 +13,6 @@ export class AppController { this.logger.setContext(AppController.name); } - @ApiOperation({ operationId: 'getHello' }) @Get() hello(): string { return this.appService.getHello(); diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json index 6372ebebe..74cf4ad7d 100644 --- a/packages/api/swagger/swagger-spec.json +++ b/packages/api/swagger/swagger-spec.json @@ -3,8 +3,7 @@ "paths": { "/": { "get": { - "operationId": "getHello", - "summary": "", + "operationId": "AppController_hello", "parameters": [], "responses": { "200": { diff --git a/packages/api/swagger/swagger-spec.yaml b/packages/api/swagger/swagger-spec.yaml index f6a8072fa..5aa0e3f1c 100644 --- a/packages/api/swagger/swagger-spec.yaml +++ b/packages/api/swagger/swagger-spec.yaml @@ -2,8 +2,7 @@ openapi: 3.0.0 paths: /: get: - operationId: getHello - summary: '' + operationId: AppController_hello parameters: [] responses: '200':