diff --git a/.github/workflows/update-sdk.yaml b/.github/workflows/update-sdk.yaml index 25b66b8..0e830b8 100644 --- a/.github/workflows/update-sdk.yaml +++ b/.github/workflows/update-sdk.yaml @@ -8,7 +8,7 @@ on: type: string required: true branch: - description: 'Branch of flackonInc/docupilot-appserver which openapi.yaml should be downloaded' + description: 'Branch of docupilot/docupilot-appserver which openapi.yaml should be downloaded' type: string default: 'main' required: true @@ -50,7 +50,7 @@ jobs: -H "Accept: application/vnd.github.raw" \ -H "Authorization: Bearer ${{ secrets.PRIVATE_DEPENDENCIES_PAT }}" \ -H "X-GitHub-Api-Version: 2022-11-28" \ - https://api.github.com/repos/flackonInc/docupilot-appserver/contents/openapi.yaml?ref=${{ inputs.branch }} \ + https://api.github.com/repos/docupilot/docupilot-appserver/contents/openapi.yaml?ref=${{ inputs.branch }} \ -o openapi.yaml - run: git diff diff --git a/.npmrc b/.npmrc index 79ad95f..d09dfca 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -@flackonInc:registry=https://npm.pkg.github.com +@docupilot:registry=https://npm.pkg.github.com diff --git a/generate.js b/generate.js index 1b91a52..5af962e 100644 --- a/generate.js +++ b/generate.js @@ -2,11 +2,18 @@ 'use strict'; -const { program } = require('commander'); -const pkg = require('./package.json'); -const fs = require('fs'); -const yaml = require('yaml'); -const OpenAPI = require('@flackonInc/openapi-typescript-codegen'); +import pkg from './package.json' assert { type: "json" }; + +import { program } from 'commander'; + +import fs from 'fs'; + +import yaml from 'yaml'; + +import * as OpenAPI from '@hey-api/openapi-ts'; + +import * as path from 'path'; + const params = program .name('openapi') @@ -45,22 +52,30 @@ for (let pathSpec of Object.values(spec.paths)) { } if (OpenAPI) { - OpenAPI.generate({ + OpenAPI.createClient({ input: spec, output: params.output, - httpClient: params.client, - clientName: params.name, + client: params.client, + name: params.name, useOptions: params.useOptions, - useUnionTypes: params.useUnionTypes, exportCore: JSON.parse(params.exportCore) === true, exportServices: JSON.parse(params.exportServices) === true, exportModels: JSON.parse(params.exportModels) === true, exportSchemas: JSON.parse(params.exportSchemas) === true, - indent: params.indent, - postfix: params.postfix, + format: params.indent, + postfixServices: params.postfix, request: params.request, + plugins: [ + { + asClass: true, + name: '@hey-api/sdk', + }, + ], }) - .then(() => { + .then(async() => { + // Path to the TypeScript file + const tsFilePath = path.resolve('.', 'src/api/types.gen.ts'); + await updateRequestbodyWithOmitReadonly(tsFilePath); process.exit(0); }) .catch((error) => { @@ -68,3 +83,43 @@ if (OpenAPI) { process.exit(1); }); } + + + + + +async function updateRequestbodyWithOmitReadonly(filePath) { + try { + // Check if the file exists + if (!fs.existsSync(filePath)) { + throw new Error(`File not found: ${filePath}`); + } + + // Read the TypeScript file + let content = await fs.promises.readFile(filePath, 'utf-8'); + + // Add import at the top if not already present + const importStatement = `import { OmitReadonly } from '../utils/OmitReadonly';`; + if (!content.includes(importStatement)) { + content = `${importStatement}\n${content}`; + } + + // Replace all occurrences of `requestBody: abc`, `requestBody?: abc`, + // `requestBody: Array`, or `requestBody?: Array` + const updatedContent = content.replace( + /requestBody(\??):\s*([A-Za-z0-9_<>]+)/g, + (match, optional, type) => `requestBody${optional}: OmitReadonly<${type}>` + ); + + // Write the updated content back to the file + await fs.promises.writeFile(filePath, updatedContent, 'utf-8'); + console.log('Import added (if not already present) and all occurrences replaced successfully.'); + } catch (error) { + console.error('Error:', error.message); + } +} + + + + + diff --git a/openapi.yaml b/openapi.yaml index 2ddfdd3..adfbf3b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -12,28 +12,28 @@ paths: get: operationId: list_auth_tokens parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string tags: - - auth_tokens + - auth_tokens security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -58,14 +58,14 @@ paths: post: operationId: create_auth_token parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - auth_tokens + - auth_tokens requestBody: content: application/json: @@ -79,7 +79,7 @@ paths: $ref: '#/components/schemas/AuthToken' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -109,20 +109,20 @@ paths: put: operationId: update_auth_token parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this auth token. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this auth token. + required: true tags: - - auth_tokens + - auth_tokens requestBody: content: application/json: @@ -136,7 +136,7 @@ paths: $ref: '#/components/schemas/AuthToken' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -171,22 +171,22 @@ paths: delete: operationId: delete_auth_token parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this auth token. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this auth token. + required: true tags: - - auth_tokens + - auth_tokens security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -214,37 +214,170 @@ paths: schema: $ref: '#/components/schemas/NotFoundError' description: '' + /accounts/v2/demographic/: + post: + operationId: create_demographic + summary: Create Demographic + parameters: + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + tags: + - demographic + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DemoGraphic' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DemoGraphic' + multipart/form-data: + schema: + $ref: '#/components/schemas/DemoGraphic' + security: + - SessionAuthentication: [] + responses: + '204': + description: No response body + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + description: '' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthenticatedError' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenError' + description: '' + /accounts/v2/demographic/show_prompt/: + get: + operationId: show_demographic_prompt_for_workspace_users + summary: Show demographic prompt for workspace users + parameters: + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + tags: + - demographic + security: + - SessionAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ShowDemographicPrompt' + description: '' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthenticatedError' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenError' + description: '' + /accounts/v2/demographic/validate_domain_and_set_demographic/: + post: + operationId: validate_domain_and_set_demographic + summary: Verify domain and set demographic + parameters: + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + tags: + - demographic + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyDomain' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/VerifyDomain' + multipart/form-data: + schema: + $ref: '#/components/schemas/VerifyDomain' + required: true + security: + - SessionAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyDomain' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + description: '' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthenticatedError' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenError' + description: '' /accounts/v2/invitations/: get: operationId: list_invitation summary: Get list of Invitation parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: is_accepted - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: is_accepted + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string tags: - - invitations + - invitations security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -270,14 +403,14 @@ paths: operationId: create_invitation summary: Create Invitation parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - invitations + - invitations requestBody: content: application/json: @@ -291,7 +424,7 @@ paths: $ref: '#/components/schemas/Invitation' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -322,13 +455,13 @@ paths: operationId: retrieve_invitation_by_key summary: Get Invitation parameters: - - in: path - name: invite_key - schema: - type: string - required: true + - in: path + name: invite_key + schema: + type: string + required: true tags: - - invitations + - invitations responses: '200': content: @@ -347,22 +480,22 @@ paths: operationId: delete_invitation summary: Delete Invitation parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - invitations + - invitations security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -395,16 +528,16 @@ paths: operationId: retrieve_invitation_for_accept summary: retrieve invitation for accept parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - invitations + - invitations security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -434,16 +567,16 @@ paths: operationId: accept_invitation summary: Accept invitation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - invitations + - invitations security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -480,22 +613,22 @@ paths: operationId: resend_invitation summary: Resend invitation parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - invitations + - invitations security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -531,16 +664,16 @@ paths: get: operationId: get_subscription_details parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - subscription + - subscription security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -565,16 +698,16 @@ paths: operationId: extend_trial summary: Extend trial parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - subscription + - subscription security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -600,20 +733,20 @@ paths: get: operationId: get_chargebee_hosted_page parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: plan_id - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: plan_id + schema: + type: string tags: - - subscription + - subscription security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -638,16 +771,16 @@ paths: get: operationId: get_chargebee_portal_session parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - subscription + - subscription security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -671,14 +804,14 @@ paths: post: operationId: subscription_renew_request_create parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - subscription + - subscription requestBody: content: application/json: @@ -691,7 +824,7 @@ paths: schema: $ref: '#/components/schemas/RenewSubscription' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -713,20 +846,60 @@ paths: schema: $ref: '#/components/schemas/ForbiddenError' description: '' + /accounts/v2/subscription/resume/: + post: + operationId: resume_subscription + parameters: + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + tags: + - subscription + security: + - SessionAuthentication: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + description: '' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthenticatedError' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenError' + description: '' /accounts/v2/subscription/unpaid_invoices/: get: operationId: get_chargebee_unpaid_invoices parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - subscription + - subscription security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -751,30 +924,34 @@ paths: operationId: list_all_team_members summary: List all team members parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: role + schema: + type: string + enum: + - admin + - billing_manager + - manager + - member + - owner tags: - - team + - team security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -801,27 +978,27 @@ paths: operationId: delete_team_member summary: delete team member parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: string - required: true - - in: query - name: transfer_to - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: string + required: true + - in: query + name: transfer_to + schema: + type: string tags: - - team + - team security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -854,19 +1031,19 @@ paths: operationId: change_role_of_team_member summary: Change role of team member. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: string + required: true tags: - - team + - team requestBody: content: application/json: @@ -880,9 +1057,9 @@ paths: $ref: '#/components/schemas/ChangeRole' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -919,14 +1096,14 @@ paths: operationId: transfer_ownership_to_admin_user summary: Transfer Ownership To Admin User parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - team + - team requestBody: content: application/json: @@ -940,9 +1117,9 @@ paths: $ref: '#/components/schemas/TransferOwnership' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -969,28 +1146,28 @@ paths: operationId: list_gallery_templates summary: Get list of galery templates parameters: - - in: query - name: category - schema: - type: integer - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - in: query + name: category + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string tags: - - Gallery templates + - Gallery templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -1017,18 +1194,18 @@ paths: operationId: get_gallery_template summary: Get one template parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this template gallery. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this template gallery. + required: true tags: - - Gallery templates + - Gallery templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -1059,9 +1236,9 @@ paths: operationId: g2_review summary: Redirect to G2 Review Page tags: - - user_satisfaction_survey + - user_satisfaction_survey security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '302': description: No response body @@ -1082,7 +1259,7 @@ paths: operationId: nps_next_reminder summary: Update the next NPS reminder time tags: - - user_satisfaction_survey + - user_satisfaction_survey requestBody: content: application/json: @@ -1096,7 +1273,7 @@ paths: $ref: '#/components/schemas/NpsNextReminder' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1123,7 +1300,7 @@ paths: operationId: nps_rating summary: Update NPS rating tags: - - user_satisfaction_survey + - user_satisfaction_survey requestBody: content: application/json: @@ -1136,7 +1313,7 @@ paths: schema: $ref: '#/components/schemas/NpsRating' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1163,7 +1340,7 @@ paths: operationId: save_customer_feedback summary: Save customer feedback tags: - - user_satisfaction_survey + - user_satisfaction_survey requestBody: content: application/json: @@ -1177,7 +1354,7 @@ paths: $ref: '#/components/schemas/SaveCustomerFeedback' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1204,16 +1381,16 @@ paths: operationId: show_survey_prompt summary: Show survey prompt parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - user_satisfaction_survey + - user_satisfaction_survey security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1238,9 +1415,9 @@ paths: operationId: update_g2_review_updated_on summary: Update g2_review_updated_on tags: - - user_satisfaction_survey + - user_satisfaction_survey security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1269,7 +1446,7 @@ paths: of logged-in userin order to allow performing high security operations like delete workspace tags: - - users + - users requestBody: content: application/json: @@ -1282,7 +1459,7 @@ paths: schema: $ref: '#/components/schemas/InitiateAuthorizationSequence' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1303,11 +1480,11 @@ paths: operationId: get_me summary: get logged in user details tags: - - users + - users security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -1326,7 +1503,7 @@ paths: operationId: update_user_profile summary: Update User Profile tags: - - users + - users requestBody: content: application/json: @@ -1339,7 +1516,7 @@ paths: schema: $ref: '#/components/schemas/PatchedUpdateUser' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '202': description: No response body @@ -1366,22 +1543,22 @@ paths: operationId: list_workspaces summary: Get list of Workspaces parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string tags: - - workspaces + - workspaces security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1407,7 +1584,7 @@ paths: operationId: create_workspace summary: Create Workspace tags: - - workspaces + - workspaces requestBody: content: application/json: @@ -1421,7 +1598,7 @@ paths: $ref: '#/components/schemas/Workspace' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -1452,16 +1629,16 @@ paths: operationId: get_csm_details description: Returns csm details for given workspace parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1471,10 +1648,10 @@ paths: examples: ResponseExample: value: - - name: test1 - phone_number: '12345678' - - name: test2 - phone_number: '87654321' + - name: test1 + phone_number: '12345678' + - name: test2 + phone_number: '87654321' summary: Response Example description: '' '401': @@ -1494,18 +1671,18 @@ paths: operationId: get_current_workspace summary: get current workspace details parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -1529,14 +1706,14 @@ paths: operationId: update_current_workspace summary: update current workspace details parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces requestBody: content: application/json: @@ -1549,7 +1726,7 @@ paths: schema: $ref: '#/components/schemas/PatchedWorkspace' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1580,14 +1757,14 @@ paths: operationId: delete_current_workspace summary: Delete a workspace and other related data permanently parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces requestBody: content: application/json: @@ -1601,7 +1778,7 @@ paths: $ref: '#/components/schemas/DeleteCurrentWorkspace' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': description: No response body @@ -1628,16 +1805,16 @@ paths: operationId: get_workspace_data_retention_preference summary: get workspace data retention preference parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1661,14 +1838,14 @@ paths: operationId: update_workspace_data_retention_preference summary: update workspace data retention preference parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - workspaces + - workspaces requestBody: content: application/json: @@ -1692,7 +1869,7 @@ paths: schema: $ref: '#/components/schemas/RetentionPreference' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1734,28 +1911,28 @@ paths: operationId: list_all_chat_threads summary: List all chat threads parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string tags: - - ai-chat + - ai-chat security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1781,14 +1958,14 @@ paths: operationId: create_new_customer_thread summary: create new customer thread parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - ai-chat + - ai-chat requestBody: content: application/json: @@ -1802,7 +1979,7 @@ paths: $ref: '#/components/schemas/CreateCustomerThreadInput' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -1832,21 +2009,21 @@ paths: get: operationId: ai_chat_threads_retrieve parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: thread_id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: thread_id + schema: + type: string + required: true tags: - - ai-chat + - ai-chat security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -1876,19 +2053,19 @@ paths: operationId: update_customer_thread summary: update existing customer thread parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: thread_id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: thread_id + schema: + type: string + required: true tags: - - ai-chat + - ai-chat requestBody: content: application/json: @@ -1902,7 +2079,7 @@ paths: $ref: '#/components/schemas/UpdateCustomerThreadInput' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -1937,21 +2114,21 @@ paths: delete: operationId: ai_chat_threads_destroy parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: thread_id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: thread_id + schema: + type: string + required: true tags: - - ai-chat + - ai-chat security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -1984,21 +2161,21 @@ paths: operationId: get_messages_for_thread summary: Get all messages for a thread parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: thread_id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: thread_id + schema: + type: string + required: true tags: - - ai-chat + - ai-chat security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2029,19 +2206,19 @@ paths: operationId: update_customer_thread_name summary: update customer thread name parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: thread_id - schema: - type: string - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: thread_id + schema: + type: string + required: true tags: - - ai-chat + - ai-chat requestBody: content: application/json: @@ -2055,7 +2232,7 @@ paths: $ref: '#/components/schemas/UpdateThreadName' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -2088,14 +2265,14 @@ paths: operationId: create_template_online_builder_ai summary: create template using ai parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - ai + - ai requestBody: content: application/json: @@ -2109,7 +2286,7 @@ paths: $ref: '#/components/schemas/AITemplateCreate' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -2140,14 +2317,14 @@ paths: operationId: edit_template_online_builder_ai summary: edit template using chat completion parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - ai + - ai requestBody: content: application/json: @@ -2161,7 +2338,7 @@ paths: $ref: '#/components/schemas/AITemplateEdit' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2192,14 +2369,14 @@ paths: operationId: prompt_suggestions_online_builder_ai summary: list prompt suggestions based on template name and description parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - ai + - ai requestBody: content: application/json: @@ -2213,7 +2390,7 @@ paths: $ref: '#/components/schemas/PromptSuggestions' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2243,19 +2420,19 @@ paths: post: operationId: append_files parameters: - - in: header - name: X-Client - schema: - type: string - description: Client Origin - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Client + schema: + type: string + description: Client Origin + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - append + - append requestBody: content: application/json: @@ -2266,9 +2443,9 @@ paths: $ref: '#/components/schemas/AppendFiles' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -2317,24 +2494,24 @@ paths: operationId: get_domain summary: Get one domain parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this domain. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this domain. + required: true tags: - - domain + - domain security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -2365,20 +2542,20 @@ paths: operationId: verify_domain summary: verify domain parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this domain. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this domain. + required: true tags: - - domain + - domain requestBody: content: application/json: @@ -2391,9 +2568,9 @@ paths: schema: $ref: '#/components/schemas/PatchedDomain' security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -2430,32 +2607,32 @@ paths: operationId: list_folders summary: Get list of folders parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: permission - schema: - type: string - enum: - - manage - - read - - write + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: permission + schema: + type: string + enum: + - manage + - read + - write tags: - - folders + - folders security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -2481,14 +2658,14 @@ paths: operationId: create_folder summary: Create a folder parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - folders + - folders requestBody: content: application/json: @@ -2502,9 +2679,9 @@ paths: $ref: '#/components/schemas/Folder' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -2535,21 +2712,21 @@ paths: operationId: list_folder_sharing summary: Get all shared permissions for specific folder parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: folder_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: folder_id + schema: + type: integer + required: true tags: - - folders + - folders security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2575,19 +2752,19 @@ paths: operationId: create_folder_sharing_permission summary: Create folder sharing permission parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: folder_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: folder_id + schema: + type: integer + required: true tags: - - folders + - folders requestBody: content: application/json: @@ -2607,7 +2784,7 @@ paths: $ref: '#/components/schemas/FolderSharing' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -2646,27 +2823,27 @@ paths: operationId: get_folder_sharing summary: Get specific permission details for given folder parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: folder_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this folder sharing setting. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: folder_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this folder sharing setting. + required: true tags: - - folders + - folders security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2696,25 +2873,25 @@ paths: operationId: update_folder_sharing_permission_content summary: Update folder content partially parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: folder_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this folder sharing setting. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: folder_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this folder sharing setting. + required: true tags: - - folders + - folders requestBody: content: application/json: @@ -2727,7 +2904,7 @@ paths: schema: $ref: '#/components/schemas/PatchedUpdateFolderSharing' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2763,27 +2940,27 @@ paths: operationId: revoke_folder_sharing_permission summary: Revoke folder sharing permission parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: folder_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this folder sharing setting. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: folder_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this folder sharing setting. + required: true tags: - - folders + - folders security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -2816,20 +2993,20 @@ paths: operationId: update_folder summary: Updates a folder parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this folder. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this folder. + required: true tags: - - folders + - folders requestBody: content: application/json: @@ -2843,9 +3020,9 @@ paths: $ref: '#/components/schemas/Folder' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -2882,24 +3059,24 @@ paths: description: This operation moves all templates under this folder to home directory. summary: Delete a folder. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this folder. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this folder. + required: true tags: - - folders + - folders security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -2932,22 +3109,22 @@ paths: operationId: get_user_created_folder_count summary: Get the count of folders created by the user. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: owner_id - schema: - type: string - description: Owner Id of resource - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: owner_id + schema: + type: string + description: Owner Id of resource + required: true tags: - - folders + - folders security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -2971,16 +3148,16 @@ paths: get: operationId: folders_sharing_status_retrieve parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - folders + - folders security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3005,54 +3182,54 @@ paths: operationId: get_created_documents_history summary: Get created documents history parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: end_date - schema: - type: string - format: date-time - description: 'DateTime in this format: 2019-05-02 16:25:12.353000' - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - in: query - name: start_date - schema: - type: string - format: date-time - description: 'DateTime in this format: 2019-05-02 16:25:12.353000' - - in: query - name: status - schema: - type: string - enum: - - error - - pending - - success - - in: query - name: template - schema: - type: integer + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: end_date + schema: + type: string + format: date-time + description: 'DateTime in this format: 2019-05-02 16:25:12.353000' + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - in: query + name: start_date + schema: + type: string + format: date-time + description: 'DateTime in this format: 2019-05-02 16:25:12.353000' + - in: query + name: status + schema: + type: string + enum: + - error + - pending + - success + - in: query + name: template + schema: + type: integer tags: - - history + - history security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -3077,22 +3254,22 @@ paths: operationId: download_created_document summary: download generated document if available parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this merge history. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this merge history. + required: true tags: - - history + - history security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3144,20 +3321,20 @@ paths: operationId: retry_delivery summary: retry failed documents delivery parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this merge history. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this merge history. + required: true tags: - - history + - history requestBody: content: application/json: @@ -3171,9 +3348,9 @@ paths: $ref: '#/components/schemas/MergeHistory' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -3210,24 +3387,24 @@ paths: operationId: get_created_export_merge_history summary: Get created export history parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string tags: - - history + - history security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -3253,14 +3430,14 @@ paths: operationId: create_export_history_task summary: Create export history task parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - history + - history requestBody: content: application/json: @@ -3274,9 +3451,9 @@ paths: $ref: '#/components/schemas/ExportMergeHistory' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -3307,23 +3484,23 @@ paths: operationId: download_created_export_document summary: download generated export document if available parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this export merge history - task. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export merge history + task. + required: true tags: - - history + - history security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3375,48 +3552,48 @@ paths: operationId: list_delivery_accounts summary: Get list of linked accounts parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - - in: query - name: type - schema: - type: string - enum: - - aws_s3 - - docu_sign - - dropbox - - email - - eversign - - google_drive - - hellosign - - one_drive - - podio - - sftp - - sign_now - - signable - - yousign - - zoho - - zoho_crm - tags: - - linked_accounts - security: - - SessionAuthentication: [] + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: type + schema: + type: string + enum: + - aws_s3 + - docu_sign + - dropbox + - email + - eversign + - google_drive + - hellosign + - one_drive + - podio + - sftp + - sign_now + - signable + - yousign + - zoho + - zoho_crm + tags: + - linked_accounts + security: + - SessionAuthentication: [] responses: '200': content: @@ -3442,14 +3619,14 @@ paths: operationId: add_delivery_account summary: Create linked account parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - linked_accounts + - linked_accounts requestBody: content: application/json: @@ -3463,7 +3640,7 @@ paths: $ref: '#/components/schemas/DeliveryAccount' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -3495,28 +3672,27 @@ paths: description: Redirects to oauth endpoint to add a new linked account of given 'integrator_type' parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: environment - schema: - type: string - description: 'sub-type of integrator. For example: sandbox or production for - docu_sign' - - in: path - name: integrator_type - schema: - type: string - pattern: ^dropbox|google_drive|one_drive|docu_sign|sign_now|podio|eversign|zoho$ - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: environment + schema: + type: string + description: 'sub-type of integrator. For example: sandbox or production for docu_sign' + - in: path + name: integrator_type + schema: + type: string + pattern: ^dropbox|google_drive|one_drive|docu_sign|sign_now|podio|eversign|zoho$ + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '302': description: No response body @@ -3543,20 +3719,20 @@ paths: operationId: update_delivery_account summary: Refresh linked account parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts requestBody: content: application/json: @@ -3570,7 +3746,7 @@ paths: $ref: '#/components/schemas/UpdateDeliveryAccount' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3606,22 +3782,22 @@ paths: operationId: revoke_delivery_account summary: Revoke linked account parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -3654,48 +3830,48 @@ paths: operationId: list_account_deliveries description: List account deliveries parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - in: query - name: type - schema: - type: string - enum: - - aws_s3 - - docu_sign - - dropbox - - email - - eversign - - google_drive - - hellosign - - one_drive - - podio - - sftp - - sign_now - - signable - - yousign - - zoho - - zoho_crm - tags: - - linked_accounts - security: - - SessionAuthentication: [] + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - in: query + name: type + schema: + type: string + enum: + - aws_s3 + - docu_sign + - dropbox + - email + - eversign + - google_drive + - hellosign + - one_drive + - podio + - sftp + - sign_now + - signable + - yousign + - zoho + - zoho_crm + tags: + - linked_accounts + security: + - SessionAuthentication: [] responses: '200': content: @@ -3720,22 +3896,22 @@ paths: operationId: list_delivery_emails_for_email_account description: List delivery emails for email account parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3747,8 +3923,8 @@ paths: examples: ResponseExample: value: - - abc@gmail.com - - abcd@gmail.com + - abc@gmail.com + - abcd@gmail.com summary: Response Example description: An array of emails '401': @@ -3774,22 +3950,22 @@ paths: operationId: get_docusign_folders description: Get docusign folders parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3820,22 +3996,22 @@ paths: operationId: get_google_picker_payload description: Get google picker payload parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -3872,20 +4048,20 @@ paths: operationId: initiate_email_authorization description: Initiate email authorization parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts requestBody: content: application/json: @@ -3899,7 +4075,7 @@ paths: $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -3932,22 +4108,22 @@ paths: operationId: reconnect_account description: Redirects to oauth endpoint for re-connecting an account parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '302': description: No response body @@ -3974,22 +4150,22 @@ paths: operationId: update_delivery_accounts_use_for_images_flag description: Update delivery accounts use for images flag parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -4026,20 +4202,20 @@ paths: operationId: verify_email_otp description: Verify email otp parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery account. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery account. + required: true tags: - - linked_accounts + - linked_accounts requestBody: content: application/json: @@ -4053,7 +4229,7 @@ paths: $ref: '#/components/schemas/VerifyEmailAccountOTP' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -4086,14 +4262,14 @@ paths: operationId: Send test mail description: send_test_mail parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - linked_accounts + - linked_accounts requestBody: content: application/json: @@ -4107,7 +4283,7 @@ paths: $ref: '#/components/schemas/SendTestSmtpMail' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': description: No response body @@ -4129,25 +4305,95 @@ paths: schema: $ref: '#/components/schemas/ForbiddenError' description: '' + /api/v2/merge_history/: + get: + operationId: get_created_documents_merge_history + summary: Get created documents merge history + parameters: + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: end_date + schema: + type: string + format: date-time + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - in: query + name: start_date + schema: + type: string + format: date-time + - in: query + name: status + schema: + type: string + enum: + - error + - pending + - success + - in: query + name: template + schema: + type: integer + tags: + - merge_history + security: + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDocumentMergeHistoryList' + description: '' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthenticatedError' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenError' + description: '' /api/v2/permissions/folder/: get: operationId: get_folder_permissions description: Returns folder permissions parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: ids - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: ids + schema: + type: string tags: - - permissions + - permissions security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -4158,12 +4404,12 @@ paths: ResponseExample: value: '199': - - read - - write + - read + - write '1201': - - read + - read '90': - - write + - write summary: Response Example description: '' '401': @@ -4183,16 +4429,16 @@ paths: operationId: get_global_permissions description: Returns permission for each role parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - permissions + - permissions security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -4217,20 +4463,20 @@ paths: operationId: get_template_permissions description: Returns template permissions parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: ids - schema: - type: string + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: ids + schema: + type: string tags: - - permissions + - permissions security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -4241,12 +4487,12 @@ paths: ResponseExample: value: '101': - - read - - write + - read + - write '121': - - read + - read '12101': - - write + - write summary: Response Example description: '' '401': @@ -4265,16 +4511,16 @@ paths: get: operationId: get_user_personalization parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - personalization + - personalization security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -4299,14 +4545,14 @@ paths: post: operationId: update_user_personalization parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - personalization + - personalization requestBody: content: application/json: @@ -4319,7 +4565,7 @@ paths: schema: $ref: '#/components/schemas/UserPersonalization' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -4345,72 +4591,72 @@ paths: operationId: list_templates summary: Get list of templates parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: folder - schema: - type: integer - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: output_type - schema: - type: string - enum: - - docx - - html - - jpeg - - pdf - - png - - pptx - - xlsx - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: search - required: false - in: query - description: A search term. - schema: - type: string - - in: query - name: status - schema: - type: string - enum: - - active - - test - - in: query - name: type - schema: - type: string - enum: - - docx - - fillable_pdf - - g_document - - g_presentation - - g_spreadsheet - - html - - pptx - - xlsx + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: folder + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: output_type + schema: + type: string + enum: + - docx + - html + - jpeg + - pdf + - png + - pptx + - xlsx + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: search + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - active + - test + - in: query + name: type + schema: + type: string + enum: + - docx + - fillable_pdf + - g_document + - g_presentation + - g_spreadsheet + - html + - pptx + - xlsx tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -4434,14 +4680,14 @@ paths: operationId: create_template summary: Create template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - templates + - templates requestBody: content: multipart/form-data: @@ -4449,9 +4695,9 @@ paths: $ref: '#/components/schemas/NewTemplate' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -4488,24 +4734,24 @@ paths: operationId: get_template summary: Get one template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -4535,20 +4781,20 @@ paths: operationId: update_template summary: Update template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -4562,9 +4808,9 @@ paths: $ref: '#/components/schemas/Template' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -4600,29 +4846,29 @@ paths: operationId: update_template_content summary: Update template content parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateNewTemplate' security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -4664,24 +4910,24 @@ paths: operationId: trash_template summary: Move template to trash parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -4714,20 +4960,20 @@ paths: operationId: copy_template summary: Copy template including preferences, deliveries parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -4741,9 +4987,9 @@ paths: $ref: '#/components/schemas/CopyTemplate' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -4780,48 +5026,28 @@ paths: operationId: download_template_file summary: Download template file parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: - text/html: - schema: - type: string - format: binary - application/pdf: - schema: - type: string - format: binary - image/png: - schema: - type: string - format: binary - application/vnd.openxmlformats-officedocument.wordprocessingml.document: - schema: - type: string - format: binary - application/vnd.openxmlformats-officedocument.presentationml.presentation: - schema: - type: string - format: binary - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: + application/octet-stream: schema: type: string format: binary @@ -4849,44 +5075,44 @@ paths: operationId: generate_document summary: Generate document from template parameters: - - in: header - name: X-Client - schema: - type: string - description: Client Origin - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: download - schema: - type: string - enum: - - 'false' - - file - - 'true' - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true - - in: query - name: output_type - schema: - type: string - enum: - - docx - - html - - pdf - - png - - pptx - - xlsx - tags: - - generate + - in: header + name: X-Client + schema: + type: string + description: Client Origin + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: download + schema: + type: string + enum: + - 'false' + - file + - 'true' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true + - in: query + name: output_type + schema: + type: string + enum: + - docx + - html + - pdf + - png + - pptx + - xlsx + tags: + - generate requestBody: content: application/json: @@ -4894,9 +5120,9 @@ paths: type: object additionalProperties: {} security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -4933,20 +5159,20 @@ paths: operationId: upload_inline_image_of_template summary: Upload inline image of template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates requestBody: content: multipart/form-data: @@ -4954,7 +5180,7 @@ paths: $ref: '#/components/schemas/UploadTemplateImage' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': description: No response body @@ -4993,24 +5219,24 @@ paths: operationId: delete_template_permanently summary: Delete a template permanently from trash parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -5043,20 +5269,20 @@ paths: operationId: restore_template_from_trash summary: Restore a template from trash parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -5070,9 +5296,9 @@ paths: $ref: '#/components/schemas/Template' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5109,24 +5335,24 @@ paths: operationId: get_template_schema summary: Get template schema parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5157,22 +5383,22 @@ paths: operationId: get_detailed_template_schema summary: Get template split schema parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -5203,31 +5429,31 @@ paths: operationId: test_document_generation summary: Test document generation parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true - - in: query - name: output_type - schema: - type: string - enum: - - docx - - html - - pdf - - png - - pptx - - xlsx - tags: - - generate + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true + - in: query + name: output_type + schema: + type: string + enum: + - docx + - html + - pdf + - png + - pptx + - xlsx + tags: + - generate requestBody: content: application/json: @@ -5235,7 +5461,7 @@ paths: type: object additionalProperties: {} security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -5272,24 +5498,24 @@ paths: operationId: get_test_data summary: Get test data used for testing template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this document. - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true tags: - - generate + - generate security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5320,30 +5546,30 @@ paths: operationId: list_template_deliveries summary: Get deliveries configured under this template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5369,20 +5595,20 @@ paths: operationId: create_template_delivery summary: Create delivery parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery requestBody: content: application/json: @@ -5395,9 +5621,9 @@ paths: schema: $ref: '#/components/schemas/PolymorphicDelivery' security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -5434,30 +5660,30 @@ paths: operationId: retrieve_template_delivery summary: Get delivery parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5487,26 +5713,26 @@ paths: operationId: update_template_delivery summary: Update delivery parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery requestBody: content: application/json: @@ -5519,9 +5745,9 @@ paths: schema: $ref: '#/components/schemas/PolymorphicDelivery' security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5557,30 +5783,30 @@ paths: operationId: delete_template_delivery summary: Delete delivery parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -5613,26 +5839,26 @@ paths: operationId: upload_delivery_attachments summary: upload email delivery attachments parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery requestBody: content: multipart/form-data: @@ -5640,9 +5866,9 @@ paths: $ref: '#/components/schemas/EmailDeliveryAttachment' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5685,42 +5911,43 @@ paths: operationId: download_delivery_attachment summary: download delivery attachment parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: attachment_id - schema: - type: string - pattern: ^\d+$ - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: attachment_id + schema: + type: string + pattern: ^\d+$ + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/PolymorphicDelivery' + type: string + format: binary description: '' '401': content: @@ -5744,36 +5971,36 @@ paths: operationId: delete_delivery_attachment summary: delete email delivery attachment parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: attachment_id - schema: - type: string - pattern: ^\d+$ - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: attachment_id + schema: + type: string + pattern: ^\d+$ + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -5806,30 +6033,30 @@ paths: operationId: upgrade_docusign_delivery summary: Upgrade docusign delivery api version parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this delivery. - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this delivery. + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - template_delivery + - template_delivery security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5866,47 +6093,47 @@ paths: operationId: list_bulk_generation_tasks summary: List bulk generation tasks parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - in: query - name: status - schema: - type: integer - enum: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - in: query + name: status + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - generate_bulk + - generate_bulk security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5931,32 +6158,32 @@ paths: operationId: get_bulk_generation_task summary: Get bulk generation task parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - format: int32 - description: Task id - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + format: int32 + description: Task id + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -5987,28 +6214,28 @@ paths: operationId: cancel_bulk_generation_task summary: Cancel a bulk generation task parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - format: int32 - description: Task id - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + format: int32 + description: Task id + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk requestBody: content: application/json: @@ -6021,9 +6248,9 @@ paths: schema: $ref: '#/components/schemas/BulkGen' security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6060,32 +6287,32 @@ paths: operationId: get_bulk_generation_draft summary: Get a task saved as draft parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - format: int32 - description: Task id - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + format: int32 + description: Task id + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6115,28 +6342,28 @@ paths: operationId: save_bulk_generation_draft summary: save a template mapping parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - format: int32 - description: Task id - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + format: int32 + description: Task id + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk requestBody: content: application/json: @@ -6152,9 +6379,9 @@ paths: type: object additionalProperties: {} security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '204': description: No response body @@ -6187,28 +6414,28 @@ paths: operationId: trigger_bulk_generation_draft summary: Trigger a bulk generation task parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - format: int32 - description: Task id - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + format: int32 + description: Task id + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk requestBody: content: application/json: @@ -6224,9 +6451,9 @@ paths: type: object additionalProperties: {} security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6264,21 +6491,21 @@ paths: description: This will create a task in DRAFT mode. summary: Upload a new csv for bulk generate. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - description: Template id - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + description: Template id + required: true tags: - - generate_bulk + - generate_bulk requestBody: content: multipart/form-data: @@ -6286,9 +6513,9 @@ paths: $ref: '#/components/schemas/BulkGenUpload' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '201': content: @@ -6332,24 +6559,24 @@ paths: description: URL to create document will be {host}/{path} summary: Get document create link path parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: template_id - schema: - type: integer - format: int32 - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: template_id + schema: + type: integer + format: int32 + required: true tags: - - generate + - generate security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6376,21 +6603,21 @@ paths: operationId: list_template_sharing summary: Get all shared permissions for specific template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: template_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: template_id + schema: + type: integer + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6416,19 +6643,19 @@ paths: operationId: create_template_sharing_permission summary: Create template sharing permission parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: template_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: template_id + schema: + type: integer + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -6448,7 +6675,7 @@ paths: $ref: '#/components/schemas/TemplateSharing' required: true security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '201': content: @@ -6487,27 +6714,27 @@ paths: operationId: get_template_sharing summary: Get specific permission details for given template parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this template sharing setting. - required: true - - in: path - name: template_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this template sharing setting. + required: true + - in: path + name: template_id + schema: + type: integer + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6537,25 +6764,25 @@ paths: operationId: update_template_sharing_permission_content summary: Update template content partially parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this template sharing setting. - required: true - - in: path - name: template_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this template sharing setting. + required: true + - in: path + name: template_id + schema: + type: integer + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -6568,7 +6795,7 @@ paths: schema: $ref: '#/components/schemas/PatchedUpdateTemplateSharing' security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6604,27 +6831,27 @@ paths: operationId: revoke_template_sharing_permission summary: Revoke template sharing permission parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this template sharing setting. - required: true - - in: path - name: template_id - schema: - type: integer - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this template sharing setting. + required: true + - in: path + name: template_id + schema: + type: integer + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '204': description: No response body @@ -6659,18 +6886,18 @@ paths: in trashed summary: List all templates parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6697,22 +6924,22 @@ paths: operationId: get_user_created_templates_count summary: Get the count of templates created by the user. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true - - in: query - name: owner_id - schema: - type: string - description: Owner Id of resource - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true + - in: query + name: owner_id + schema: + type: string + description: Owner Id of resource + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6737,14 +6964,14 @@ paths: operationId: move_templates_to_another_folder description: Move templates to another folder parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - templates + - templates requestBody: content: application/json: @@ -6758,9 +6985,9 @@ paths: $ref: '#/components/schemas/MoveTemplate' required: true security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6790,16 +7017,16 @@ paths: get: operationId: templates_sharing_status_retrieve parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - templates + - templates security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6824,18 +7051,18 @@ paths: operationId: list_trashed_templates summary: List all templates in trash. parameters: - - in: header - name: X-Workspace - schema: - type: string - description: Organization unique_key - required: true + - in: header + name: X-Workspace + schema: + type: string + description: Workspace unique_key + required: true tags: - - templates + - templates security: - - OAuthAuthentication: [] - - SessionAuthentication: [] - - tokenAuth: [] + - OAuthAuthentication: [] + - SessionAuthentication: [] + - tokenAuth: [] responses: '200': content: @@ -6859,15 +7086,17 @@ paths: get: operationId: list_banner_notifications tags: - - general + - general security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BannerNotification' + type: array + items: + $ref: '#/components/schemas/BannerNotification' description: '' '401': content: @@ -6885,9 +7114,9 @@ paths: get: operationId: get_app_meta tags: - - general + - general security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6911,9 +7140,9 @@ paths: get: operationId: list_subscription_plans tags: - - general + - general security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6939,9 +7168,9 @@ paths: get: operationId: list_timezones tags: - - general + - general security: - - SessionAuthentication: [] + - SessionAuthentication: [] responses: '200': content: @@ -6981,8 +7210,8 @@ components: type: integer nullable: true required: - - ai_prompt - - title + - ai_prompt + - title description: '' AITemplateEdit: type: object @@ -6997,9 +7226,9 @@ components: type: string readOnly: true required: - - ai_prompt - - ai_response - - selected_content + - ai_prompt + - ai_response + - selected_content description: '' AcceptInvite: type: object @@ -7007,7 +7236,7 @@ components: workspace_unique_key: type: string required: - - workspace_unique_key + - workspace_unique_key description: '' AccountDelivery: type: object @@ -7025,9 +7254,9 @@ components: template_info: $ref: '#/components/schemas/TemplateInfo' required: - - id - - name - - template_info + - id + - name + - template_info description: '' AppendFiles: type: object @@ -7040,7 +7269,7 @@ components: output_file_name: type: string required: - - files + - files description: '' AttachmentsConfig: type: object @@ -7052,9 +7281,9 @@ components: max_total_size: type: integer required: - - allowed_types - - max_files - - max_total_size + - allowed_types + - max_files + - max_total_size description: '' AuthToken: type: object @@ -7072,6 +7301,7 @@ components: type: string format: date-time readOnly: true + nullable: true last_used_time: type: string format: date-time @@ -7081,25 +7311,28 @@ components: type: boolean default: true required: - - created_time - - id - - last_used_time - - name - - token + - created_time + - id + - last_used_time + - name + - token description: '' BannerNotification: type: object properties: id: type: string - content: + name: + type: string + description: type: string action: $ref: '#/components/schemas/BannerNotificationAction' required: - - action - - content - - id + - action + - description + - id + - name description: '' BannerNotificationAction: type: object @@ -7110,8 +7343,8 @@ components: type: object additionalProperties: {} required: - - attributes - - text + - attributes + - text description: '' BulkGen: type: object @@ -7130,12 +7363,12 @@ components: readOnly: true status: enum: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 type: integer minimum: 0 maximum: 32767 @@ -7161,6 +7394,7 @@ components: type: string format: date-time readOnly: true + nullable: true created_by: type: integer readOnly: true @@ -7169,12 +7403,12 @@ components: readOnly: true nullable: true required: - - created_by - - errors - - file_name - - id - - updated_by - - updated_time + - created_by + - errors + - file_name + - id + - updated_by + - updated_time BulkGenData: type: object properties: @@ -7189,10 +7423,10 @@ components: type: object additionalProperties: {} required: - - data - - id - - row_count - - suggested_mapping + - data + - id + - row_count + - suggested_mapping description: '' BulkGenTask: type: object @@ -7209,7 +7443,7 @@ components: type: string format: binary required: - - file + - file description: '' BulkGenerateMeta: type: object @@ -7217,7 +7451,7 @@ components: max_test_rows: type: integer required: - - max_test_rows + - max_test_rows description: '' CSMDetails: type: object @@ -7229,22 +7463,22 @@ components: type: string maxLength: 20 required: - - name - - phone_number + - name + - phone_number description: '' ChangeRole: type: object properties: role: enum: - - owner - - admin - - manager - - member - - billing_manager + - owner + - admin + - manager + - member + - billing_manager type: string required: - - role + - role description: '' ChargebeeSubscription: type: object @@ -7255,11 +7489,11 @@ components: maxLength: 255 status: enum: - - a - - t - - e - - c - - p + - a + - t + - e + - c + - p type: string trial_end: type: string @@ -7301,11 +7535,11 @@ components: type: string readOnly: true required: - - can_extend_trial - - current_term_end - - current_term_start - - overage_enabled - - subscribed_on + - can_extend_trial + - current_term_end + - current_term_start + - overage_enabled + - subscribed_on description: '' ChatThreads: type: object @@ -7328,9 +7562,36 @@ components: type: string maxLength: 200 required: - - id - - model_name - - thread_id + - id + - model_name + - thread_id + description: '' + ChildDocumentMergeHistory: + type: object + properties: + id: + type: integer + readOnly: true + delivery_type: + type: string + maxLength: 255 + status: + enum: + - pending + - success + - error + type: string + message: + type: object + additionalProperties: {} + nullable: true + delivery: + type: integer + nullable: true + required: + - delivery_type + - id + - status description: '' ChildTemplate: type: object @@ -7347,14 +7608,14 @@ components: maxLength: 255 type: enum: - - docx - - html - - fillable_pdf - - pptx - - xlsx - - g_document - - g_presentation - - g_spreadsheet + - docx + - html + - fillable_pdf + - pptx + - xlsx + - g_document + - g_presentation + - g_spreadsheet type: string created_time: type: string @@ -7364,10 +7625,11 @@ components: type: string format: date-time readOnly: true + nullable: true document_status: enum: - - active - - test + - active + - test type: string deleted_time: type: string @@ -7384,12 +7646,12 @@ components: type: integer nullable: true required: - - created_by - - created_time - - id - - title - - updated_by - - updated_time + - created_by + - created_time + - id + - title + - updated_by + - updated_time description: '' CopyTemplate: type: object @@ -7398,7 +7660,7 @@ components: type: string maxLength: 120 required: - - title + - title description: '' CreateCustomerThreadInput: type: object @@ -7407,7 +7669,7 @@ components: type: string writeOnly: true required: - - message + - message description: '' CreateCustomerThreadOutput: type: object @@ -7419,9 +7681,9 @@ components: thread_display_name: type: string required: - - output_message - - thread_display_name - - thread_id + - output_message + - thread_display_name + - thread_id description: '' DeleteCurrentWorkspace: type: object @@ -7430,7 +7692,7 @@ components: type: string writeOnly: true required: - - otp + - otp description: '' DeliveryAccount: type: object @@ -7441,12 +7703,12 @@ components: readOnly: true type: enum: - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string sub_type: type: string @@ -7469,17 +7731,30 @@ components: type: string format: date-time readOnly: true + nullable: true use_for_images: type: boolean required: - - credentials - - id - - is_expired - - name - - sub_type - - type - - updated_at - - used_by + - credentials + - id + - is_expired + - name + - sub_type + - type + - updated_at + - used_by + DemoGraphic: + type: object + properties: + user_demographic: + allOf: + - $ref: '#/components/schemas/UserDemographic' + nullable: true + workspace_demographic: + allOf: + - $ref: '#/components/schemas/WorkspaceDemographic' + nullable: true + description: '' DocuSignDelivery: type: object description: '' @@ -7513,10 +7788,10 @@ components: recipient_type: type: string enum: - - signer - - agent - - cc - - editor + - signer + - agent + - cc + - editor name: type: string minLength: 1 @@ -7533,10 +7808,10 @@ components: phone_number: type: string required: - - recipient_type - - name - - is_email_delivery - - is_sms_delivery + - recipient_type + - name + - is_email_delivery + - is_sms_delivery reminder_settings: type: object nullable: true @@ -7546,8 +7821,8 @@ components: reminder_frequency: type: number required: - - reminder_delay - - reminder_frequency + - reminder_delay + - reminder_frequency overwrite_account_defaults: type: boolean default: false @@ -7556,21 +7831,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -7607,8 +7882,8 @@ components: type: boolean api_version: enum: - - '2.0' - - '2.1' + - '2.0' + - '2.1' type: string readOnly: true folder_id: @@ -7621,11 +7896,47 @@ components: allow_reassign: type: boolean required: - - account - - api_version - - id - - name - - signers + - account + - api_version + - id + - name + - signers + DocumentMergeHistory: + type: object + properties: + id: + type: integer + readOnly: true + data: + type: object + additionalProperties: {} + nullable: true + template: + allOf: + - $ref: '#/components/schemas/ChildTemplate' + readOnly: true + nullable: true + executed_deliveries: + type: array + items: + $ref: '#/components/schemas/ChildDocumentMergeHistory' + is_data_expired: + type: boolean + readOnly: true + is_document_expired: + type: boolean + readOnly: true + created_file_name: + type: string + nullable: true + maxLength: 255 + required: + - executed_deliveries + - id + - is_data_expired + - is_document_expired + - template + description: '' DocumentMergeLink: type: object properties: @@ -7633,7 +7944,7 @@ components: type: string readOnly: true required: - - path + - path description: '' Domain: type: object @@ -7655,10 +7966,10 @@ components: type: string readOnly: true required: - - domain_name - - id - - spf_record - - txt_record + - domain_name + - id + - spf_record + - txt_record description: '' DomainFailure: type: object @@ -7668,8 +7979,8 @@ components: txt_record: type: string required: - - spf_record - - txt_record + - spf_record + - txt_record description: '' DomainVerify: type: object @@ -7678,14 +7989,14 @@ components: type: array items: enum: - - txt_record - - spf_record + - txt_record + - spf_record type: string failures: $ref: '#/components/schemas/DomainFailure' required: - - failures - - success + - failures + - success description: '' DropboxDelivery: type: object @@ -7705,21 +8016,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -7741,14 +8052,14 @@ components: type: string mode: enum: - - add_as_new - - conflict - - overwrite + - add_as_new + - conflict + - overwrite type: string required: - - account - - id - - name + - account + - id + - name DynamicImage: type: object properties: @@ -7771,11 +8082,11 @@ components: type: number format: double required: - - height - - left - - token - - top - - width + - height + - left + - token + - top + - width description: '' EmailDelivery: type: object @@ -7801,21 +8112,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -7864,11 +8175,11 @@ components: enable_optional_recipients: type: boolean required: - - account - - attachments - - id - - name - - to_email + - account + - attachments + - id + - name + - to_email EmailDeliveryAttachment: type: object properties: @@ -7878,7 +8189,7 @@ components: type: string format: binary required: - - attachments + - attachments description: '' EversignDelivery: type: object @@ -7910,8 +8221,8 @@ components: order: type: string required: - - name - - email + - name + - email recipients: type: array minItems: 0 @@ -7925,29 +8236,29 @@ components: type: string format: email required: - - name - - email + - name + - email nullable: true name: type: string maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -7985,10 +8296,10 @@ components: enable_optional_signers: type: boolean required: - - account - - id - - name - - signers + - account + - id + - name + - signers ExportMergeHistory: type: object description: '' @@ -8007,15 +8318,15 @@ components: format: date status: enum: - - pending - - success - - error + - pending + - success + - error type: string required: - - from_date - - id - - name - - to_date + - from_date + - id + - name + - to_date File: type: object description: '' @@ -8038,18 +8349,18 @@ components: type: integer readOnly: true required: - - id - - name - - path - - size - - tag + - id + - name + - path + - size + - tag FileUploadMeta: type: object properties: email_attachments: $ref: '#/components/schemas/AttachmentsConfig' required: - - email_attachments + - email_attachments description: '' FillablePdfSettings: type: object @@ -8070,9 +8381,9 @@ components: writeOnly: true nullable: true required: - - height - - no_of_pages - - width + - height + - no_of_pages + - width description: '' Folder: type: object @@ -8088,10 +8399,12 @@ components: type: string format: date-time readOnly: true + nullable: true updated_time: type: string format: date-time readOnly: true + nullable: true created_by: type: integer readOnly: true @@ -8100,19 +8413,19 @@ components: readOnly: true nullable: true required: - - created_by - - created_time - - id - - name - - updated_by - - updated_time + - created_by + - created_time + - id + - name + - updated_by + - updated_time FolderCount: type: object properties: folders_count: type: integer required: - - folders_count + - folders_count description: '' FolderSharing: type: object @@ -8123,22 +8436,22 @@ components: readOnly: true permission: enum: - - read - - write - - manage + - read + - write + - manage type: string user: type: integer required: - - id - - user + - id + - user ForbiddenError: type: object properties: detail: type: string required: - - detail + - detail description: '' GalleryCategory: type: object @@ -8150,8 +8463,8 @@ components: type: string maxLength: 100 required: - - id - - name + - id + - name description: '' GlobalPermission: type: object @@ -8177,16 +8490,16 @@ components: api_settings: type: boolean required: - - api_settings - - billing - - folders - - integrations - - reports - - team:manage - - templates - - workspace - - workspace:delete - - workspace:update + - api_settings + - billing + - folders + - integrations + - reports + - team:manage + - templates + - workspace + - workspace:delete + - workspace:update description: '' GoogleDriveDelivery: type: object @@ -8206,21 +8519,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -8252,16 +8565,16 @@ components: description: Dynamic folder path maxLength: 255 required: - - account - - id - - name + - account + - id + - name GoogleDrivePickerPayload: type: object properties: payload: type: string required: - - payload + - payload description: '' HelloSignDelivery: type: object @@ -8289,28 +8602,28 @@ components: type: string format: email required: - - name - - email_address + - name + - email_address name: type: string maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -8351,10 +8664,10 @@ components: enable_optional_signers: type: boolean required: - - account - - id - - name - - signers + - account + - id + - name + - signers HostedPage: type: object properties: @@ -8362,15 +8675,15 @@ components: type: string format: uri required: - - url + - url description: '' InitiateAuthorizationSequence: type: object properties: action_name: enum: - - delete workspace - - transfer ownership + - delete workspace + - transfer ownership type: string default: delete workspace description: '' @@ -8395,10 +8708,10 @@ components: maxLength: 254 role: enum: - - admin - - manager - - member - - billing_manager + - admin + - manager + - member + - billing_manager type: string created_at: type: string @@ -8420,17 +8733,17 @@ components: type: string readOnly: true required: - - accepted_at - - created_at - - email - - expired - - expires_at - - id - - invite_key - - is_accepted - - role - - sender - - workspace + - accepted_at + - created_at + - email + - expired + - expires_at + - id + - invite_key + - is_accepted + - role + - sender + - workspace description: '' MergeHistory: type: object @@ -8440,7 +8753,7 @@ components: readOnly: true template: allOf: - - $ref: '#/components/schemas/ChildTemplate' + - $ref: '#/components/schemas/ChildTemplate' readOnly: true nullable: true data: @@ -8455,9 +8768,9 @@ components: maxLength: 255 status: enum: - - pending - - success - - error + - pending + - success + - error type: string created_time: type: string @@ -8476,9 +8789,9 @@ components: maxLength: 255 callback_status: enum: - - success - - fail - - null + - success + - fail + - null type: string nullable: true callback_failure_message: @@ -8488,15 +8801,15 @@ components: type: integer nullable: true required: - - created_file_name - - created_time - - data - - data_expired - - delivery_type - - document_expired - - id - - status - - template + - created_file_name + - created_time + - data + - data_expired + - delivery_type + - document_expired + - id + - status + - template description: '' Meta: type: object @@ -8508,9 +8821,9 @@ components: iam: type: string required: - - batch_process_max_allowed_test_rows - - file_uploads - - iam + - batch_process_max_allowed_test_rows + - file_uploads + - iam description: '' MoveTemplate: type: object @@ -8523,8 +8836,8 @@ components: type: integer nullable: true required: - - new_folder_id - - template_ids + - new_folder_id + - template_ids description: '' NewTemplate: type: object @@ -8541,13 +8854,13 @@ components: maxLength: 120 output_type: enum: - - html - - pdf - - jpeg - - png - - docx - - pptx - - xlsx + - html + - pdf + - jpeg + - png + - docx + - pptx + - xlsx type: string description: type: string @@ -8556,15 +8869,15 @@ components: template_gallery_id: type: integer required: - - output_type - - title + - output_type + - title NotFoundError: type: object properties: detail: type: string required: - - detail + - detail description: '' NpsNextReminder: type: object @@ -8572,7 +8885,7 @@ components: days: type: integer required: - - days + - days description: '' NpsRating: type: object @@ -8601,21 +8914,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -8636,11 +8949,14 @@ components: folder: type: string required: - - account - - id - - name + - account + - id + - name PaginatedAccountDeliveryList: type: object + required: + - count + - results properties: count: type: integer @@ -8661,6 +8977,9 @@ components: $ref: '#/components/schemas/AccountDelivery' PaginatedBulkGenList: type: object + required: + - count + - results properties: count: type: integer @@ -8679,8 +8998,34 @@ components: type: array items: $ref: '#/components/schemas/BulkGen' + PaginatedDocumentMergeHistoryList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DocumentMergeHistory' PaginatedMergeHistoryList: type: object + required: + - count + - results properties: count: type: integer @@ -8701,6 +9046,9 @@ components: $ref: '#/components/schemas/MergeHistory' PaginatedTemplateList: type: object + required: + - count + - results properties: count: type: integer @@ -8748,9 +9096,9 @@ components: readOnly: true permission: enum: - - read - - write - - manage + - read + - write + - manage type: string user: type: integer @@ -8771,9 +9119,9 @@ components: readOnly: true permission: enum: - - read - - write - - manage + - read + - write + - manage type: string user: type: integer @@ -8787,9 +9135,9 @@ components: maxLength: 5 theme: enum: - - light - - dark - - system + - light + - dark + - system type: string description: '' PatchedWorkspace: @@ -8809,130 +9157,130 @@ components: readOnly: true timezone: enum: - - Pacific/Midway - - America/Adak - - Pacific/Honolulu - - Pacific/Marquesas - - America/Anchorage - - America/Tijuana - - America/Los_Angeles - - America/Phoenix - - America/Chihuahua - - America/Denver - - America/Belize - - America/Chicago - - Pacific/Easter - - America/Mexico_City - - America/Regina - - America/Bogota - - America/Cancun - - America/New_York - - America/Port-au-Prince - - America/Havana - - America/Indiana/Indianapolis - - America/Asuncion - - America/Halifax - - America/Caracas - - America/Cuiaba - - America/Manaus - - America/Santiago - - America/Grand_Turk - - America/St_Johns - - America/Fortaleza - - America/Sao_Paulo - - America/Cayenne - - America/Buenos_Aires - - America/Godthab - - America/Montevideo - - America/Miquelon - - America/Bahia - - America/Noronha - - Atlantic/Azores - - Atlantic/Cape_Verde - - UTC - - Africa/Casablanca - - Europe/London - - Africa/Monrovia - - Europe/Amsterdam - - Europe/Belgrade - - Europe/Brussels - - Europe/Warsaw - - Africa/Algiers - - Africa/Windhoek - - Asia/Amman - - Europe/Athens - - Asia/Beirut - - Africa/Cairo - - Asia/Damascus - - Asia/Gaza - - Africa/Harare - - Europe/Helsinki - - Asia/Jerusalem - - Europe/Kaliningrad - - Africa/Tripoli - - Asia/Baghdad - - Asia/Istanbul - - Asia/Kuwait - - Europe/Minsk - - Europe/Moscow - - Africa/Nairobi - - Asia/Tehran - - Asia/Muscat - - Europe/Astrakhan - - Asia/Baku - - Europe/Samara - - Indian/Mauritius - - Asia/Tbilisi - - Asia/Yerevan - - Asia/Kabul - - Asia/Tashkent - - Asia/Yekaterinburg - - Asia/Karachi - - Asia/Kolkata - - Asia/Colombo - - Asia/Katmandu - - Asia/Almaty - - Asia/Dhaka - - Asia/Rangoon - - Asia/Novosibirsk - - Asia/Bangkok - - Asia/Barnaul - - Asia/Hovd - - Asia/Krasnoyarsk - - Asia/Tomsk - - Asia/Chongqing - - Asia/Irkutsk - - Asia/Kuala_Lumpur - - Australia/Perth - - Asia/Taipei - - Asia/Ulaanbaatar - - Asia/Pyongyang - - Australia/Eucla - - Asia/Chita - - Asia/Tokyo - - Asia/Seoul - - Asia/Yakutsk - - Australia/Adelaide - - Australia/Darwin - - Australia/Brisbane - - Australia/Canberra - - Pacific/Guam - - Australia/Hobart - - Asia/Vladivostok - - Australia/Lord_Howe - - Pacific/Bougainville - - Asia/Srednekolymsk - - Asia/Magadan - - Pacific/Norfolk - - Asia/Sakhalin - - Pacific/Guadalcanal - - Asia/Anadyr - - Pacific/Auckland - - Pacific/Fiji - - Pacific/Chatham - - Pacific/Tongatapu - - Pacific/Apia - - Pacific/Kiritimati + - Pacific/Midway + - America/Adak + - Pacific/Honolulu + - Pacific/Marquesas + - America/Anchorage + - America/Tijuana + - America/Los_Angeles + - America/Phoenix + - America/Chihuahua + - America/Denver + - America/Belize + - America/Chicago + - Pacific/Easter + - America/Mexico_City + - America/Regina + - America/Bogota + - America/Cancun + - America/New_York + - America/Port-au-Prince + - America/Havana + - America/Indiana/Indianapolis + - America/Asuncion + - America/Halifax + - America/Caracas + - America/Cuiaba + - America/Manaus + - America/Santiago + - America/Grand_Turk + - America/St_Johns + - America/Fortaleza + - America/Sao_Paulo + - America/Cayenne + - America/Buenos_Aires + - America/Godthab + - America/Montevideo + - America/Miquelon + - America/Bahia + - America/Noronha + - Atlantic/Azores + - Atlantic/Cape_Verde + - UTC + - Africa/Casablanca + - Europe/London + - Africa/Monrovia + - Europe/Amsterdam + - Europe/Belgrade + - Europe/Brussels + - Europe/Warsaw + - Africa/Algiers + - Africa/Windhoek + - Asia/Amman + - Europe/Athens + - Asia/Beirut + - Africa/Cairo + - Asia/Damascus + - Asia/Gaza + - Africa/Harare + - Europe/Helsinki + - Asia/Jerusalem + - Europe/Kaliningrad + - Africa/Tripoli + - Asia/Baghdad + - Asia/Istanbul + - Asia/Kuwait + - Europe/Minsk + - Europe/Moscow + - Africa/Nairobi + - Asia/Tehran + - Asia/Muscat + - Europe/Astrakhan + - Asia/Baku + - Europe/Samara + - Indian/Mauritius + - Asia/Tbilisi + - Asia/Yerevan + - Asia/Kabul + - Asia/Tashkent + - Asia/Yekaterinburg + - Asia/Karachi + - Asia/Kolkata + - Asia/Colombo + - Asia/Katmandu + - Asia/Almaty + - Asia/Dhaka + - Asia/Rangoon + - Asia/Novosibirsk + - Asia/Bangkok + - Asia/Barnaul + - Asia/Hovd + - Asia/Krasnoyarsk + - Asia/Tomsk + - Asia/Chongqing + - Asia/Irkutsk + - Asia/Kuala_Lumpur + - Australia/Perth + - Asia/Taipei + - Asia/Ulaanbaatar + - Asia/Pyongyang + - Australia/Eucla + - Asia/Chita + - Asia/Tokyo + - Asia/Seoul + - Asia/Yakutsk + - Australia/Adelaide + - Australia/Darwin + - Australia/Brisbane + - Australia/Canberra + - Pacific/Guam + - Australia/Hobart + - Asia/Vladivostok + - Australia/Lord_Howe + - Pacific/Bougainville + - Asia/Srednekolymsk + - Asia/Magadan + - Pacific/Norfolk + - Asia/Sakhalin + - Pacific/Guadalcanal + - Asia/Anadyr + - Pacific/Auckland + - Pacific/Fiji + - Pacific/Chatham + - Pacific/Tongatapu + - Pacific/Apia + - Pacific/Kiritimati type: string readOnly: true plan_id: @@ -8969,31 +9317,31 @@ components: readOnly: true billing_period_unit: enum: - - year - - month + - year + - month type: string readOnly: true required: - - billing_period_unit - - documents_allowed - - plan_id - - price + - billing_period_unit + - documents_allowed + - plan_id + - price description: '' PolymorphicDelivery: oneOf: - - $ref: '#/components/schemas/EmailDelivery' - - $ref: '#/components/schemas/WebhookDelivery' - - $ref: '#/components/schemas/DropboxDelivery' - - $ref: '#/components/schemas/OneDriveDelivery' - - $ref: '#/components/schemas/SignNowDelivery' - - $ref: '#/components/schemas/GoogleDriveDelivery' - - $ref: '#/components/schemas/S3Delivery' - - $ref: '#/components/schemas/HelloSignDelivery' - - $ref: '#/components/schemas/DocuSignDelivery' - - $ref: '#/components/schemas/EversignDelivery' - - $ref: '#/components/schemas/SignableDelivery' - - $ref: '#/components/schemas/YouSignDelivery' - - $ref: '#/components/schemas/SftpDelivery' + - $ref: '#/components/schemas/EmailDelivery' + - $ref: '#/components/schemas/WebhookDelivery' + - $ref: '#/components/schemas/DropboxDelivery' + - $ref: '#/components/schemas/OneDriveDelivery' + - $ref: '#/components/schemas/SignNowDelivery' + - $ref: '#/components/schemas/GoogleDriveDelivery' + - $ref: '#/components/schemas/S3Delivery' + - $ref: '#/components/schemas/HelloSignDelivery' + - $ref: '#/components/schemas/DocuSignDelivery' + - $ref: '#/components/schemas/EversignDelivery' + - $ref: '#/components/schemas/SignableDelivery' + - $ref: '#/components/schemas/YouSignDelivery' + - $ref: '#/components/schemas/SftpDelivery' discriminator: propertyName: type mapping: @@ -9026,8 +9374,8 @@ components: type: string readOnly: true required: - - prompts - - template_title + - prompts + - template_title description: '' RenewSubscription: type: object @@ -9062,21 +9410,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -9106,10 +9454,10 @@ components: nullable: true maxLength: 50 required: - - account - - bucket - - id - - name + - account + - bucket + - id + - name SaveCustomerFeedback: type: object properties: @@ -9122,24 +9470,24 @@ components: feature_improvement: type: string required: - - challenges_faced + - challenges_faced required: - - feedback + - feedback description: '' SendEmailAccountAuthorizationOTP: type: object properties: action_name: enum: - - verify - - update + - verify + - update type: string email: type: string format: email nullable: true required: - - action_name + - action_name description: '' SendTestSmtpMail: type: object @@ -9157,19 +9505,19 @@ components: type: integer smtp_encryption_type: enum: - - TLS - - SSL + - TLS + - SSL type: string email: type: string format: email required: - - email - - smtp_encryption_type - - smtp_port - - smtp_server_address - - smtp_server_password - - smtp_server_username + - email + - smtp_encryption_type + - smtp_port + - smtp_server_address + - smtp_server_password + - smtp_server_username description: '' SftpDelivery: type: object @@ -9189,21 +9537,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -9226,9 +9574,9 @@ components: nullable: true maxLength: 255 required: - - account - - id - - name + - account + - id + - name SharingInfoFolder: type: object properties: @@ -9239,8 +9587,8 @@ components: type: boolean readOnly: true required: - - id - - is_shared + - id + - is_shared description: '' SharingInfoTemplate: type: object @@ -9252,8 +9600,19 @@ components: type: boolean readOnly: true required: - - id - - is_shared + - id + - is_shared + description: '' + ShowDemographicPrompt: + type: object + properties: + user_demographic: + type: boolean + workspace_demographic: + type: boolean + required: + - user_demographic + - workspace_demographic description: '' SignNowDelivery: type: object @@ -9283,28 +9642,28 @@ components: type: string format: email required: - - role - - email + - role + - email name: type: string maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -9338,10 +9697,10 @@ components: enable_optional_signers: type: boolean required: - - account - - id - - name - - signers + - account + - id + - name + - signers SignableDelivery: type: object description: '' @@ -9370,32 +9729,32 @@ components: party_role: type: string enum: - - signer - - copy + - signer + - copy required: - - party_name - - party_email - - party_role + - party_name + - party_email + - party_role name: type: string maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -9427,10 +9786,10 @@ components: minimum: 1 nullable: true required: - - account - - id - - name - - parties + - account + - id + - name + - parties SurveyPrompt: type: object properties: @@ -9438,7 +9797,7 @@ components: type: boolean readOnly: true required: - - show_survey_prompt + - show_survey_prompt description: '' TeamMember: type: object @@ -9448,21 +9807,21 @@ components: readOnly: true user: allOf: - - $ref: '#/components/schemas/User' + - $ref: '#/components/schemas/User' readOnly: true role: enum: - - owner - - admin - - manager - - member - - billing_manager + - owner + - admin + - manager + - member + - billing_manager type: string is_deleted: type: boolean required: - - id - - user + - id + - user description: '' Template: type: object @@ -9482,14 +9841,14 @@ components: maxLength: 255 type: enum: - - docx - - html - - fillable_pdf - - pptx - - xlsx - - g_document - - g_presentation - - g_spreadsheet + - docx + - html + - fillable_pdf + - pptx + - xlsx + - g_document + - g_presentation + - g_spreadsheet type: string readOnly: true created_time: @@ -9500,10 +9859,11 @@ components: type: string format: date-time readOnly: true + nullable: true document_status: enum: - - active - - test + - active + - test type: string deleted_time: type: string @@ -9521,21 +9881,21 @@ components: type: integer nullable: true required: - - created_by - - created_time - - deleted_time - - id - - title - - type - - updated_by - - updated_time + - created_by + - created_time + - deleted_time + - id + - title + - type + - updated_by + - updated_time TemplateCount: type: object properties: templates_count: type: integer required: - - templates_count + - templates_count description: '' TemplateDelivery: type: object @@ -9548,27 +9908,27 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string readOnly: true required: - - id - - name - - type + - id + - name + - type description: '' TemplateGallery: type: object @@ -9597,11 +9957,11 @@ components: minimum: 0 nullable: true required: - - category - - file_type - - id - - image_path - - title + - category + - file_type + - id + - image_path + - title description: '' TemplateInfo: type: object @@ -9619,10 +9979,10 @@ components: type: string readOnly: true required: - - id - - name - - status - - type + - id + - name + - status + - type description: '' TemplateSchema: type: object @@ -9631,27 +9991,27 @@ components: type: string type: enum: - - string - - array - - object - - generic + - string + - array + - object + - generic type: string generics: enum: - - string - - array - - object - - generic + - string + - array + - object + - generic type: string fields: type: array items: $ref: '#/components/schemas/TemplateSchema' required: - - fields - - generics - - name - - type + - fields + - generics + - name + - type description: '' TemplateSettings: type: object @@ -9685,7 +10045,7 @@ components: type: string info: allOf: - - $ref: '#/components/schemas/FillablePdfSettings' + - $ref: '#/components/schemas/FillablePdfSettings' readOnly: true dynamic_images: type: array @@ -9697,13 +10057,13 @@ components: maxLength: 255 output_type: enum: - - html - - pdf - - jpeg - - png - - docx - - pptx - - xlsx + - html + - pdf + - jpeg + - png + - docx + - pptx + - xlsx type: string password: type: string @@ -9711,18 +10071,18 @@ components: maxLength: 255 format: enum: - - A3 - - A4 - - A5 - - Legal - - Letter - - Tabloid - - Custom + - A3 + - A4 + - A5 + - Legal + - Letter + - Tabloid + - Custom type: string orientation: enum: - - portrait - - landscape + - portrait + - landscape type: string header: type: string @@ -9752,13 +10112,13 @@ components: type: boolean emulate_mode: enum: - - print - - screen - - null + - print + - screen + - null type: string nullable: true required: - - info + - info description: '' TemplateSharing: type: object @@ -9769,15 +10129,15 @@ components: readOnly: true permission: enum: - - read - - write - - manage + - read + - write + - manage type: string user: type: integer required: - - id - - user + - id + - user ThreadMessages: type: object properties: @@ -9785,7 +10145,7 @@ components: type: object additionalProperties: {} required: - - messages + - messages description: '' Timezone: type: object @@ -9797,8 +10157,8 @@ components: type: string readOnly: true required: - - name - - tz + - name + - tz description: '' TransferOwnership: type: object @@ -9808,8 +10168,8 @@ components: otp: type: integer required: - - otp - - transfer_to + - otp + - transfer_to description: '' UnauthenticatedError: type: object @@ -9817,7 +10177,7 @@ components: detail: type: string required: - - detail + - detail description: '' UpdateCustomerThreadInput: type: object @@ -9826,7 +10186,7 @@ components: type: string writeOnly: true required: - - message + - message description: '' UpdateCustomerThreadOutput: type: object @@ -9834,7 +10194,7 @@ components: output_message: type: string required: - - output_message + - output_message description: '' UpdateDeliveryAccount: type: object @@ -9845,13 +10205,14 @@ components: readOnly: true type: enum: - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string + readOnly: true sub_type: type: string readOnly: true @@ -9873,17 +10234,18 @@ components: type: string format: date-time readOnly: true + nullable: true use_for_images: type: boolean required: - - credentials - - id - - is_expired - - name - - sub_type - - type - - updated_at - - used_by + - credentials + - id + - is_expired + - name + - sub_type + - type + - updated_at + - used_by UpdateThreadName: type: object properties: @@ -9891,7 +10253,7 @@ components: type: string writeOnly: true required: - - thread_name + - thread_name description: '' UploadTemplateImage: type: object @@ -9900,7 +10262,7 @@ components: type: string format: binary required: - - upload + - upload description: '' User: type: object @@ -9925,130 +10287,130 @@ components: maxLength: 255 timezone: enum: - - Pacific/Midway - - America/Adak - - Pacific/Honolulu - - Pacific/Marquesas - - America/Anchorage - - America/Tijuana - - America/Los_Angeles - - America/Phoenix - - America/Chihuahua - - America/Denver - - America/Belize - - America/Chicago - - Pacific/Easter - - America/Mexico_City - - America/Regina - - America/Bogota - - America/Cancun - - America/New_York - - America/Port-au-Prince - - America/Havana - - America/Indiana/Indianapolis - - America/Asuncion - - America/Halifax - - America/Caracas - - America/Cuiaba - - America/Manaus - - America/Santiago - - America/Grand_Turk - - America/St_Johns - - America/Fortaleza - - America/Sao_Paulo - - America/Cayenne - - America/Buenos_Aires - - America/Godthab - - America/Montevideo - - America/Miquelon - - America/Bahia - - America/Noronha - - Atlantic/Azores - - Atlantic/Cape_Verde - - UTC - - Africa/Casablanca - - Europe/London - - Africa/Monrovia - - Europe/Amsterdam - - Europe/Belgrade - - Europe/Brussels - - Europe/Warsaw - - Africa/Algiers - - Africa/Windhoek - - Asia/Amman - - Europe/Athens - - Asia/Beirut - - Africa/Cairo - - Asia/Damascus - - Asia/Gaza - - Africa/Harare - - Europe/Helsinki - - Asia/Jerusalem - - Europe/Kaliningrad - - Africa/Tripoli - - Asia/Baghdad - - Asia/Istanbul - - Asia/Kuwait - - Europe/Minsk - - Europe/Moscow - - Africa/Nairobi - - Asia/Tehran - - Asia/Muscat - - Europe/Astrakhan - - Asia/Baku - - Europe/Samara - - Indian/Mauritius - - Asia/Tbilisi - - Asia/Yerevan - - Asia/Kabul - - Asia/Tashkent - - Asia/Yekaterinburg - - Asia/Karachi - - Asia/Kolkata - - Asia/Colombo - - Asia/Katmandu - - Asia/Almaty - - Asia/Dhaka - - Asia/Rangoon - - Asia/Novosibirsk - - Asia/Bangkok - - Asia/Barnaul - - Asia/Hovd - - Asia/Krasnoyarsk - - Asia/Tomsk - - Asia/Chongqing - - Asia/Irkutsk - - Asia/Kuala_Lumpur - - Australia/Perth - - Asia/Taipei - - Asia/Ulaanbaatar - - Asia/Pyongyang - - Australia/Eucla - - Asia/Chita - - Asia/Tokyo - - Asia/Seoul - - Asia/Yakutsk - - Australia/Adelaide - - Australia/Darwin - - Australia/Brisbane - - Australia/Canberra - - Pacific/Guam - - Australia/Hobart - - Asia/Vladivostok - - Australia/Lord_Howe - - Pacific/Bougainville - - Asia/Srednekolymsk - - Asia/Magadan - - Pacific/Norfolk - - Asia/Sakhalin - - Pacific/Guadalcanal - - Asia/Anadyr - - Pacific/Auckland - - Pacific/Fiji - - Pacific/Chatham - - Pacific/Tongatapu - - Pacific/Apia - - Pacific/Kiritimati + - Pacific/Midway + - America/Adak + - Pacific/Honolulu + - Pacific/Marquesas + - America/Anchorage + - America/Tijuana + - America/Los_Angeles + - America/Phoenix + - America/Chihuahua + - America/Denver + - America/Belize + - America/Chicago + - Pacific/Easter + - America/Mexico_City + - America/Regina + - America/Bogota + - America/Cancun + - America/New_York + - America/Port-au-Prince + - America/Havana + - America/Indiana/Indianapolis + - America/Asuncion + - America/Halifax + - America/Caracas + - America/Cuiaba + - America/Manaus + - America/Santiago + - America/Grand_Turk + - America/St_Johns + - America/Fortaleza + - America/Sao_Paulo + - America/Cayenne + - America/Buenos_Aires + - America/Godthab + - America/Montevideo + - America/Miquelon + - America/Bahia + - America/Noronha + - Atlantic/Azores + - Atlantic/Cape_Verde + - UTC + - Africa/Casablanca + - Europe/London + - Africa/Monrovia + - Europe/Amsterdam + - Europe/Belgrade + - Europe/Brussels + - Europe/Warsaw + - Africa/Algiers + - Africa/Windhoek + - Asia/Amman + - Europe/Athens + - Asia/Beirut + - Africa/Cairo + - Asia/Damascus + - Asia/Gaza + - Africa/Harare + - Europe/Helsinki + - Asia/Jerusalem + - Europe/Kaliningrad + - Africa/Tripoli + - Asia/Baghdad + - Asia/Istanbul + - Asia/Kuwait + - Europe/Minsk + - Europe/Moscow + - Africa/Nairobi + - Asia/Tehran + - Asia/Muscat + - Europe/Astrakhan + - Asia/Baku + - Europe/Samara + - Indian/Mauritius + - Asia/Tbilisi + - Asia/Yerevan + - Asia/Kabul + - Asia/Tashkent + - Asia/Yekaterinburg + - Asia/Karachi + - Asia/Kolkata + - Asia/Colombo + - Asia/Katmandu + - Asia/Almaty + - Asia/Dhaka + - Asia/Rangoon + - Asia/Novosibirsk + - Asia/Bangkok + - Asia/Barnaul + - Asia/Hovd + - Asia/Krasnoyarsk + - Asia/Tomsk + - Asia/Chongqing + - Asia/Irkutsk + - Asia/Kuala_Lumpur + - Australia/Perth + - Asia/Taipei + - Asia/Ulaanbaatar + - Asia/Pyongyang + - Australia/Eucla + - Asia/Chita + - Asia/Tokyo + - Asia/Seoul + - Asia/Yakutsk + - Australia/Adelaide + - Australia/Darwin + - Australia/Brisbane + - Australia/Canberra + - Pacific/Guam + - Australia/Hobart + - Asia/Vladivostok + - Australia/Lord_Howe + - Pacific/Bougainville + - Asia/Srednekolymsk + - Asia/Magadan + - Pacific/Norfolk + - Asia/Sakhalin + - Pacific/Guadalcanal + - Asia/Anadyr + - Pacific/Auckland + - Pacific/Fiji + - Pacific/Chatham + - Pacific/Tongatapu + - Pacific/Apia + - Pacific/Kiritimati type: string locale: type: string @@ -10056,9 +10418,9 @@ components: maxLength: 5 theme: enum: - - light - - dark - - system + - light + - dark + - system type: string readOnly: true g2_verified: @@ -10067,19 +10429,36 @@ components: is_mfa_enabled: type: boolean required: - - email - - g2_verified - - guid - - id - - theme + - email + - g2_verified + - guid + - id + - theme + description: '' + UserDemographic: + type: object + properties: + id: + type: integer + readOnly: true + product_referral_source: + type: string + nullable: true + maxLength: 52 + role: + type: string + maxLength: 52 + required: + - id + - role description: '' UserPersonalization: type: object properties: ui_version: enum: - - 1 - - 2 + - 1 + - 2 type: integer list_view:templates: $ref: '#/components/schemas/UserPersonalizationListViewTemplate' @@ -10092,11 +10471,11 @@ components: properties: type: enum: - - card - - template + - card + - template type: string required: - - type + - type description: '' ValidationError: type: object @@ -10112,16 +10491,29 @@ components: items: type: string required: - - errors - - non_field_errors + - errors + - non_field_errors + description: '' + VerifyDomain: + type: object + properties: + domain_name: + type: string + maxLength: 255 + show_workspace_demographic_prompt: + type: boolean + readOnly: true + required: + - domain_name + - show_workspace_demographic_prompt description: '' VerifyEmailAccountOTP: type: object properties: action_name: enum: - - verify - - update + - verify + - update type: string email: type: string @@ -10131,8 +10523,8 @@ components: type: string maxLength: 6 required: - - action_name - - otp + - action_name + - otp description: '' WebhookDelivery: type: object @@ -10150,21 +10542,21 @@ components: maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -10194,9 +10586,9 @@ components: additionalProperties: {} nullable: true required: - - id - - name - - url + - id + - name + - url Workspace: type: object properties: @@ -10214,130 +10606,130 @@ components: readOnly: true timezone: enum: - - Pacific/Midway - - America/Adak - - Pacific/Honolulu - - Pacific/Marquesas - - America/Anchorage - - America/Tijuana - - America/Los_Angeles - - America/Phoenix - - America/Chihuahua - - America/Denver - - America/Belize - - America/Chicago - - Pacific/Easter - - America/Mexico_City - - America/Regina - - America/Bogota - - America/Cancun - - America/New_York - - America/Port-au-Prince - - America/Havana - - America/Indiana/Indianapolis - - America/Asuncion - - America/Halifax - - America/Caracas - - America/Cuiaba - - America/Manaus - - America/Santiago - - America/Grand_Turk - - America/St_Johns - - America/Fortaleza - - America/Sao_Paulo - - America/Cayenne - - America/Buenos_Aires - - America/Godthab - - America/Montevideo - - America/Miquelon - - America/Bahia - - America/Noronha - - Atlantic/Azores - - Atlantic/Cape_Verde - - UTC - - Africa/Casablanca - - Europe/London - - Africa/Monrovia - - Europe/Amsterdam - - Europe/Belgrade - - Europe/Brussels - - Europe/Warsaw - - Africa/Algiers - - Africa/Windhoek - - Asia/Amman - - Europe/Athens - - Asia/Beirut - - Africa/Cairo - - Asia/Damascus - - Asia/Gaza - - Africa/Harare - - Europe/Helsinki - - Asia/Jerusalem - - Europe/Kaliningrad - - Africa/Tripoli - - Asia/Baghdad - - Asia/Istanbul - - Asia/Kuwait - - Europe/Minsk - - Europe/Moscow - - Africa/Nairobi - - Asia/Tehran - - Asia/Muscat - - Europe/Astrakhan - - Asia/Baku - - Europe/Samara - - Indian/Mauritius - - Asia/Tbilisi - - Asia/Yerevan - - Asia/Kabul - - Asia/Tashkent - - Asia/Yekaterinburg - - Asia/Karachi - - Asia/Kolkata - - Asia/Colombo - - Asia/Katmandu - - Asia/Almaty - - Asia/Dhaka - - Asia/Rangoon - - Asia/Novosibirsk - - Asia/Bangkok - - Asia/Barnaul - - Asia/Hovd - - Asia/Krasnoyarsk - - Asia/Tomsk - - Asia/Chongqing - - Asia/Irkutsk - - Asia/Kuala_Lumpur - - Australia/Perth - - Asia/Taipei - - Asia/Ulaanbaatar - - Asia/Pyongyang - - Australia/Eucla - - Asia/Chita - - Asia/Tokyo - - Asia/Seoul - - Asia/Yakutsk - - Australia/Adelaide - - Australia/Darwin - - Australia/Brisbane - - Australia/Canberra - - Pacific/Guam - - Australia/Hobart - - Asia/Vladivostok - - Australia/Lord_Howe - - Pacific/Bougainville - - Asia/Srednekolymsk - - Asia/Magadan - - Pacific/Norfolk - - Asia/Sakhalin - - Pacific/Guadalcanal - - Asia/Anadyr - - Pacific/Auckland - - Pacific/Fiji - - Pacific/Chatham - - Pacific/Tongatapu - - Pacific/Apia - - Pacific/Kiritimati + - Pacific/Midway + - America/Adak + - Pacific/Honolulu + - Pacific/Marquesas + - America/Anchorage + - America/Tijuana + - America/Los_Angeles + - America/Phoenix + - America/Chihuahua + - America/Denver + - America/Belize + - America/Chicago + - Pacific/Easter + - America/Mexico_City + - America/Regina + - America/Bogota + - America/Cancun + - America/New_York + - America/Port-au-Prince + - America/Havana + - America/Indiana/Indianapolis + - America/Asuncion + - America/Halifax + - America/Caracas + - America/Cuiaba + - America/Manaus + - America/Santiago + - America/Grand_Turk + - America/St_Johns + - America/Fortaleza + - America/Sao_Paulo + - America/Cayenne + - America/Buenos_Aires + - America/Godthab + - America/Montevideo + - America/Miquelon + - America/Bahia + - America/Noronha + - Atlantic/Azores + - Atlantic/Cape_Verde + - UTC + - Africa/Casablanca + - Europe/London + - Africa/Monrovia + - Europe/Amsterdam + - Europe/Belgrade + - Europe/Brussels + - Europe/Warsaw + - Africa/Algiers + - Africa/Windhoek + - Asia/Amman + - Europe/Athens + - Asia/Beirut + - Africa/Cairo + - Asia/Damascus + - Asia/Gaza + - Africa/Harare + - Europe/Helsinki + - Asia/Jerusalem + - Europe/Kaliningrad + - Africa/Tripoli + - Asia/Baghdad + - Asia/Istanbul + - Asia/Kuwait + - Europe/Minsk + - Europe/Moscow + - Africa/Nairobi + - Asia/Tehran + - Asia/Muscat + - Europe/Astrakhan + - Asia/Baku + - Europe/Samara + - Indian/Mauritius + - Asia/Tbilisi + - Asia/Yerevan + - Asia/Kabul + - Asia/Tashkent + - Asia/Yekaterinburg + - Asia/Karachi + - Asia/Kolkata + - Asia/Colombo + - Asia/Katmandu + - Asia/Almaty + - Asia/Dhaka + - Asia/Rangoon + - Asia/Novosibirsk + - Asia/Bangkok + - Asia/Barnaul + - Asia/Hovd + - Asia/Krasnoyarsk + - Asia/Tomsk + - Asia/Chongqing + - Asia/Irkutsk + - Asia/Kuala_Lumpur + - Australia/Perth + - Asia/Taipei + - Asia/Ulaanbaatar + - Asia/Pyongyang + - Australia/Eucla + - Asia/Chita + - Asia/Tokyo + - Asia/Seoul + - Asia/Yakutsk + - Australia/Adelaide + - Australia/Darwin + - Australia/Brisbane + - Australia/Canberra + - Pacific/Guam + - Australia/Hobart + - Asia/Vladivostok + - Australia/Lord_Howe + - Pacific/Bougainville + - Asia/Srednekolymsk + - Asia/Magadan + - Pacific/Norfolk + - Asia/Sakhalin + - Pacific/Guadalcanal + - Asia/Anadyr + - Pacific/Auckland + - Pacific/Fiji + - Pacific/Chatham + - Pacific/Tongatapu + - Pacific/Apia + - Pacific/Kiritimati type: string readOnly: true plan_id: @@ -10360,16 +10752,50 @@ components: format: date-time readOnly: true required: - - active - - created_time - - id - - org_name - - plan_id - - plan_status - - role - - timezone - - unique_key - - use_froala + - active + - created_time + - id + - org_name + - plan_id + - plan_status + - role + - timezone + - unique_key + - use_froala + description: '' + WorkspaceDemographic: + type: object + properties: + id: + type: integer + readOnly: true + domain_name: + type: string + maxLength: 255 + employee_count: + enum: + - JUST ME + - 2 to 5 + - 6 to 10 + - 11 to 25 + - 26 to 50 + - 51 to 200 + - 201 to 1,000 + - 1,001 to 10,000 + - 10,001 or more + type: string + industry: + type: string + maxLength: 100 + primary_region: + type: string + maxLength: 100 + required: + - domain_name + - employee_count + - id + - industry + - primary_region description: '' YouSignDelivery: type: object @@ -10405,13 +10831,13 @@ components: type: string minLength: 2 enum: - - en - - fr - - de - - it - - nl - - es - - pl + - en + - fr + - de + - it + - nl + - es + - pl success_url: type: string format: uri @@ -10421,25 +10847,25 @@ components: signature_authentication_mode: type: string enum: - - otp_email - - otp_sms - - no_otp + - otp_email + - otp_sms + - no_otp signature_level: type: string enum: - - electronic_signature - - advanced_electronic_signature - - electronic_signature_with_qualified_certificate - - qualified_electronic_signature_mode_1 + - electronic_signature + - advanced_electronic_signature + - electronic_signature_with_qualified_certificate + - qualified_electronic_signature_mode_1 order: type: number required: - - first_name - - last_name - - email - - locale - - signature_level - - signature_authentication_mode + - first_name + - last_name + - email + - locale + - signature_level + - signature_authentication_mode approvers: type: array items: @@ -10449,13 +10875,13 @@ components: type: string minLength: 2 enum: - - en - - fr - - de - - it - - nl - - es - - pl + - en + - fr + - de + - it + - nl + - es + - pl first_name: type: string minLength: 2 @@ -10468,10 +10894,10 @@ components: phone_number: type: string required: - - locale - - first_name - - last_name - - email + - locale + - first_name + - last_name + - email nullable: true followers: type: array @@ -10482,19 +10908,19 @@ components: type: string minLength: 2 enum: - - en - - fr - - de - - it - - nl - - es - - pl + - en + - fr + - de + - it + - nl + - es + - pl email: type: string format: email required: - - locale - - email + - locale + - email nullable: true reminder_settings: type: object @@ -10502,38 +10928,38 @@ components: interval_in_days: type: number enum: - - 1 - - 2 - - 7 - - 14 + - 1 + - 2 + - 7 + - 14 max_occurrences: type: number minimum: 1 maximum: 10 required: - - interval_in_days - - max_occurrences + - interval_in_days + - max_occurrences nullable: true name: type: string maxLength: 255 type: enum: - - webhook - - docu_sign - - sign_now - - zoho_crm - - dropbox - - google_drive - - podio - - one_drive - - eversign - - hellosign - - aws_s3 - - signable - - yousign - - email - - sftp + - webhook + - docu_sign + - sign_now + - zoho_crm + - dropbox + - google_drive + - podio + - one_drive + - eversign + - hellosign + - aws_s3 + - signable + - yousign + - email + - sftp type: string success_callback_url: type: string @@ -10559,7 +10985,7 @@ components: nullable: true delivery_mode: enum: - - email + - email type: string ordered_signers: type: boolean @@ -10575,7 +11001,7 @@ components: type: string nullable: true maxLength: 256 - workspace_id: + yousign_workspace_id: type: string nullable: true maxLength: 256 @@ -10586,11 +11012,11 @@ components: enable_optional_signers: type: boolean required: - - account - - id - - name - - signers - - title + - account + - id + - name + - signers + - title securitySchemes: OAuthAuthentication: type: http @@ -10608,4 +11034,4 @@ components: description: Token-based authentication with required prefix "Basic" externalDocs: description: Help docs on how to use API - url: https://help.docupilot.app/developers/api-overview + url: https://help.docupilot.app/developers/api-overview \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 6f47520..1853097 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,58 +1,29 @@ { - "name": "@flackoninc/docupilot-js-sdk", + "name": "@docupilot/docupilot-js-sdk", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@flackoninc/docupilot-js-sdk", + "name": "@docupilot/docupilot-js-sdk", "version": "1.0.0", "license": "ISC", "devDependencies": { - "@flackonInc/openapi-typescript-codegen": "^0.23.7", + "@hey-api/openapi-ts": "^0.59.2", "@types/node-fetch": "^2.6.2", "braces": "^3.0.3", + "commander": "^12.1.0", "form-data": "^4.0.0", "node-fetch": "^2.6.7", "prettier": "^2.7.1", "ts-loader": "^9.5.1", "ts-node": "^10.9.1", - "typescript": "^4.7.4", + "typescript": "^5.7.2", "webpack": "^5.94.0", "webpack-cli": "^5.1.4", "yaml": "^2.5.1" } }, - "node_modules/@apidevtools/json-schema-ref-parser": { - "version": "9.0.9", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.0.9.tgz", - "integrity": "sha512-GBD2Le9w2+lVFoc4vswGI/TjkNIZSVp7+9xPf+X3uidBfWnAeUWmquteSyt0+VCrhNMWj/FTABISQrD3Z/YA+w==", - "dev": true, - "dependencies": { - "@jsdevtools/ono": "^7.1.3", - "@types/json-schema": "^7.0.6", - "call-me-maybe": "^1.0.1", - "js-yaml": "^4.1.0" - } - }, - "node_modules/@apidevtools/json-schema-ref-parser/node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true - }, - "node_modules/@apidevtools/json-schema-ref-parser/node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dev": true, - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, "node_modules/@cspotcode/source-map-support": { "version": "0.8.1", "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", @@ -84,21 +55,47 @@ "node": ">=10.0.0" } }, - "node_modules/@flackonInc/openapi-typescript-codegen": { - "version": "0.23.7", - "resolved": "https://npm.pkg.github.com/download/@flackonInc/openapi-typescript-codegen/0.23.7/e0c5177fea1c0e9c1e8c8454f68cb8b99b2685ed", - "integrity": "sha512-PXv9zdiuPlHZKJFctGvbiWyGtwTQWSrarKo1XSJmJ011nv1+yp6/HPvUdMQA34q+94LnQZxqF5BpyYQ4YOjPsA==", + "node_modules/@hey-api/openapi-ts": { + "version": "0.59.2", + "resolved": "https://registry.npmjs.org/@hey-api/openapi-ts/-/openapi-ts-0.59.2.tgz", + "integrity": "sha512-knb7KL+qb6vFVf/LlP8DcrRQW39VZlW2LcJDZan5RrnJkeZ00ZK6sE3WAC3pI6TaI3TYHmS6yJMWaLL08L2iVQ==", "dev": true, - "license": "MIT", + "license": "FSL-1.1-MIT", "dependencies": { - "camelcase": "^6.3.0", - "commander": "^9.3.0", - "fs-extra": "^10.1.0", - "handlebars": "^4.7.7", - "json-schema-ref-parser": "^9.0.9" + "@apidevtools/json-schema-ref-parser": "11.7.3", + "c12": "2.0.1", + "commander": "12.1.0", + "handlebars": "4.7.8" }, "bin": { - "openapi": "bin/index.js" + "openapi-ts": "bin/index.cjs" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/hey-api" + }, + "peerDependencies": { + "typescript": "^5.x" + } + }, + "node_modules/@hey-api/openapi-ts/node_modules/@apidevtools/json-schema-ref-parser": { + "version": "11.7.3", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.7.3.tgz", + "integrity": "sha512-WApSdLdXEBb/1FUPca2lteASewEfpjEYJ8oXZP+0gExK5qSfsEKBKcA+WjY6Q4wvXwyv0+W6Kvc372pSceib9w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.15", + "js-yaml": "^4.1.0" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://github.com/sponsors/philsturgeon" } }, "node_modules/@jridgewell/gen-mapping": { @@ -168,7 +165,8 @@ "version": "7.1.3", "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@tsconfig/node10": { "version": "1.0.9", @@ -195,10 +193,11 @@ "dev": true }, "node_modules/@types/json-schema": { - "version": "7.0.11", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz", - "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==", - "dev": true + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true, + "license": "MIT" }, "node_modules/@types/node": { "version": "22.5.5", @@ -457,9 +456,9 @@ "license": "Apache-2.0" }, "node_modules/acorn": { - "version": "8.12.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.1.tgz", - "integrity": "sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==", + "version": "8.14.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz", + "integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==", "dev": true, "license": "MIT", "bin": { @@ -488,12 +487,52 @@ "node": ">=0.4.0" } }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", "dev": true }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -514,9 +553,9 @@ } }, "node_modules/browserslist": { - "version": "4.23.3", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", - "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", + "version": "4.24.2", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.2.tgz", + "integrity": "sha512-ZIc+Q62revdMcqC6aChtW4jz3My3klmCO1fEmINZY/8J3EpBg5/A/D0AKmBveUh6pgoeycoMkVMko84tuYS+Gg==", "dev": true, "funding": [ { @@ -534,10 +573,10 @@ ], "license": "MIT", "dependencies": { - "caniuse-lite": "^1.0.30001646", - "electron-to-chromium": "^1.5.4", + "caniuse-lite": "^1.0.30001669", + "electron-to-chromium": "^1.5.41", "node-releases": "^2.0.18", - "update-browserslist-db": "^1.1.0" + "update-browserslist-db": "^1.1.1" }, "bin": { "browserslist": "cli.js" @@ -552,28 +591,69 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, - "node_modules/call-me-maybe": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.1.tgz", - "integrity": "sha512-wCyFsDQkKPwwF8BDwOiWNx/9K45L/hvggQiDbve+viMNMQnWhrlYIuBk09offfwCRtCO9P6XwUttufzU11WCVw==", - "dev": true + "node_modules/c12": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/c12/-/c12-2.0.1.tgz", + "integrity": "sha512-Z4JgsKXHG37C6PYUtIxCfLJZvo6FyhHJoClwwb9ftUkLpPSkuYqn6Tr+vnaN8hymm0kIbcg6Ey3kv/Q71k5w/A==", + "dev": true, + "license": "MIT", + "dependencies": { + "chokidar": "^4.0.1", + "confbox": "^0.1.7", + "defu": "^6.1.4", + "dotenv": "^16.4.5", + "giget": "^1.2.3", + "jiti": "^2.3.0", + "mlly": "^1.7.1", + "ohash": "^1.1.4", + "pathe": "^1.1.2", + "perfect-debounce": "^1.0.0", + "pkg-types": "^1.2.0", + "rc9": "^2.1.2" + }, + "peerDependencies": { + "magicast": "^0.3.5" + }, + "peerDependenciesMeta": { + "magicast": { + "optional": true + } + } }, - "node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "node_modules/c12/node_modules/chokidar": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.2.tgz", + "integrity": "sha512-/b57FK+bblSU+dfewfFe0rT1YjVDfOmeLQwCAuC+vwvgLkXboATqqmy+Ipux6JrF6L5joe5CBnFOw+gLWH6yKg==", "dev": true, + "license": "MIT", + "dependencies": { + "readdirp": "^4.0.1" + }, "engines": { - "node": ">=10" + "node": ">= 14.16.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/c12/node_modules/readdirp": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.0.2.tgz", + "integrity": "sha512-yDMz9g+VaZkqBYS/ozoBJwaBhTbZo3UNYQHNRw1D3UFQB8oHB4uS/tAODO+ZLjGWmUbKnIlOWO+aaIiAxrUWHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16.0" + }, + "funding": { + "type": "individual", + "url": "https://paulmillr.com/funding/" } }, "node_modules/caniuse-lite": { - "version": "1.0.30001662", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001662.tgz", - "integrity": "sha512-sgMUVwLmGseH8ZIrm1d51UbrhqMCH3jvS7gF/M6byuHOnKyLOBL7W8yz5V02OHwgLGA36o/AFhWzzh4uc5aqTA==", + "version": "1.0.30001687", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001687.tgz", + "integrity": "sha512-0S/FDhf4ZiqrTUiQ39dKeUjYRjkv7lOZU1Dgif2rIqrTzX/1wV2hfKu9TOm1IHkdSijfLswxTFzl/cvir+SLSQ==", "dev": true, "funding": [ { @@ -591,6 +671,33 @@ ], "license": "CC-BY-4.0" }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/chownr": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", + "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, "node_modules/chrome-trace-event": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz", @@ -600,6 +707,16 @@ "node": ">=6.0" } }, + "node_modules/citty": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/citty/-/citty-0.1.6.tgz", + "integrity": "sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "consola": "^3.2.3" + } + }, "node_modules/clone-deep": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", @@ -614,6 +731,26 @@ "node": ">=6" } }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, "node_modules/colorette": { "version": "2.0.20", "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", @@ -634,12 +771,30 @@ } }, "node_modules/commander": { - "version": "9.4.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.0.tgz", - "integrity": "sha512-sRPT+umqkz90UA8M1yqYfnHlZA7fF6nSphDtxeywPZ49ysjxDQybzk13CL+mXekDRG92skbcqCLVovuCusNmFw==", + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz", + "integrity": "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/confbox": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.1.8.tgz", + "integrity": "sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/consola": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/consola/-/consola-3.2.3.tgz", + "integrity": "sha512-I5qxpzLv+sJhTVEoLYNcTW+bThDCPsit0vLNKShZx6rLtpilNpmmeTPaeqJb9ZE9dV3DGaeby6Vuhrw38WjeyQ==", "dev": true, + "license": "MIT", "engines": { - "node": "^12.20.0 || >=14" + "node": "^14.18.0 || >=16.10.0" } }, "node_modules/create-require": { @@ -662,6 +817,13 @@ "node": ">= 8" } }, + "node_modules/defu": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", + "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==", + "dev": true, + "license": "MIT" + }, "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", @@ -671,6 +833,13 @@ "node": ">=0.4.0" } }, + "node_modules/destr": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.3.tgz", + "integrity": "sha512-2N3BOUU4gYMpTP24s5rF5iP7BDr7uNTCs4ozw3kf/eKfvWSIu93GEBi5m427YoyJoeOzQ5smuu4nNAPGb8idSQ==", + "dev": true, + "license": "MIT" + }, "node_modules/diff": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", @@ -680,10 +849,23 @@ "node": ">=0.3.1" } }, + "node_modules/dotenv": { + "version": "16.4.7", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.7.tgz", + "integrity": "sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, "node_modules/electron-to-chromium": { - "version": "1.5.27", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.27.tgz", - "integrity": "sha512-o37j1vZqCoEgBuWWXLHQgTN/KDKe7zwpiY5CPeq2RvUqOyJw9xnrULzZAEVQ5p4h+zjMk7hgtOoPdnLxr7m/jw==", + "version": "1.5.72", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.72.tgz", + "integrity": "sha512-ZpSAUOZ2Izby7qnZluSrAlGgGQzucmFbN0n64dYzocYxnxV5ufurpj3VgEe4cUp7ir9LmeLxNYo8bVnlM8bQHw==", "dev": true, "license": "ISC" }, @@ -810,6 +992,30 @@ "node": ">=0.8.x" } }, + "node_modules/execa": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", + "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^8.0.1", + "human-signals": "^5.0.0", + "is-stream": "^3.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^5.1.0", + "onetime": "^6.0.0", + "signal-exit": "^4.1.0", + "strip-final-newline": "^3.0.0" + }, + "engines": { + "node": ">=16.17" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -871,20 +1077,39 @@ "node": ">= 6" } }, - "node_modules/fs-extra": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", - "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "node_modules/fs-minipass": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", + "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", "dev": true, + "license": "ISC", "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" + "minipass": "^3.0.0" }, "engines": { - "node": ">=12" + "node": ">= 8" + } + }, + "node_modules/fs-minipass/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" } }, + "node_modules/fs-minipass/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true, + "license": "ISC" + }, "node_modules/function-bind": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", @@ -895,6 +1120,39 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/get-stream": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz", + "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/giget": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/giget/-/giget-1.2.3.tgz", + "integrity": "sha512-8EHPljDvs7qKykr6uw8b+lqLiUc/vUg+KVTI0uND4s63TdsZM2Xus3mflvF0DDG9SiM4RlCkFGL+7aAjRmV7KA==", + "dev": true, + "license": "MIT", + "dependencies": { + "citty": "^0.1.6", + "consola": "^3.2.3", + "defu": "^6.1.4", + "node-fetch-native": "^1.6.3", + "nypm": "^0.3.8", + "ohash": "^1.1.3", + "pathe": "^1.1.2", + "tar": "^6.2.0" + }, + "bin": { + "giget": "dist/cli.mjs" + } + }, "node_modules/glob-to-regexp": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", @@ -909,13 +1167,14 @@ "license": "ISC" }, "node_modules/handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", + "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", "dev": true, + "license": "MIT", "dependencies": { "minimist": "^1.2.5", - "neo-async": "^2.6.0", + "neo-async": "^2.6.2", "source-map": "^0.6.1", "wordwrap": "^1.0.0" }, @@ -934,10 +1193,21 @@ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/hasown": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", @@ -951,6 +1221,16 @@ "node": ">= 0.4" } }, + "node_modules/human-signals": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", + "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=16.17.0" + } + }, "node_modules/import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -1018,6 +1298,19 @@ "node": ">=0.10.0" } }, + "node_modules/is-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", + "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -1033,37 +1326,42 @@ "node": ">=0.10.0" } }, - "node_modules/json-parse-even-better-errors": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", - "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", - "dev": true - }, - "node_modules/json-schema-ref-parser": { - "version": "9.0.9", - "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-9.0.9.tgz", - "integrity": "sha512-qcP2lmGy+JUoQJ4DOQeLaZDqH9qSkeGCK3suKWxJXS82dg728Mn3j97azDMaOUmJAN4uCq91LdPx4K7E8F1a7Q==", - "deprecated": "Please switch to @apidevtools/json-schema-ref-parser", + "node_modules/jiti": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.4.1.tgz", + "integrity": "sha512-yPBThwecp1wS9DmoA4x4KR2h3QoslacnDR8ypuFM962kI4/456Iy1oHx2RAgh4jfZNdn0bctsdadceiBUgpU1g==", "dev": true, - "dependencies": { - "@apidevtools/json-schema-ref-parser": "9.0.9" - }, - "engines": { - "node": ">=10" + "license": "MIT", + "bin": { + "jiti": "lib/jiti-cli.mjs" } }, - "node_modules/jsonfile": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", - "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, + "license": "MIT", "dependencies": { - "universalify": "^2.0.0" + "argparse": "^2.0.1" }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" + "bin": { + "js-yaml": "bin/js-yaml.js" } }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true, + "license": "MIT" + }, "node_modules/kind-of": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", @@ -1141,11 +1439,98 @@ "node": ">= 0.6" } }, + "node_modules/mimic-fn": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", + "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", - "dev": true + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/minipass": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", + "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=8" + } + }, + "node_modules/minizlib": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", + "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "minipass": "^3.0.0", + "yallist": "^4.0.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/minizlib/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minizlib/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true, + "license": "ISC" + }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "license": "MIT", + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/mlly": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.7.3.tgz", + "integrity": "sha512-xUsx5n/mN0uQf4V548PKQ+YShA4/IW0KI1dZhrNrPCLG+xizETbHTkOa1f8/xut9JRPp8kQuMnz0oqwkTiLo/A==", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^8.14.0", + "pathe": "^1.1.2", + "pkg-types": "^1.2.1", + "ufo": "^1.5.4" + } }, "node_modules/neo-async": { "version": "2.6.2", @@ -1173,6 +1558,13 @@ } } }, + "node_modules/node-fetch-native": { + "version": "1.6.4", + "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.4.tgz", + "integrity": "sha512-IhOigYzAKHd244OC0JIMIUrjzctirCmPkaIfhDeGcEETWof5zKYUW7e7MYvChGWh/4CJeXEgsRyGzuF334rOOQ==", + "dev": true, + "license": "MIT" + }, "node_modules/node-releases": { "version": "2.0.18", "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", @@ -1180,6 +1572,79 @@ "dev": true, "license": "MIT" }, + "node_modules/npm-run-path": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz", + "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path/node_modules/path-key": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz", + "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/nypm": { + "version": "0.3.12", + "resolved": "https://registry.npmjs.org/nypm/-/nypm-0.3.12.tgz", + "integrity": "sha512-D3pzNDWIvgA+7IORhD/IuWzEk4uXv6GsgOxiid4UU3h9oq5IqV1KtPDi63n4sZJ/xcWlr88c0QM2RgN5VbOhFA==", + "dev": true, + "license": "MIT", + "dependencies": { + "citty": "^0.1.6", + "consola": "^3.2.3", + "execa": "^8.0.1", + "pathe": "^1.1.2", + "pkg-types": "^1.2.0", + "ufo": "^1.5.4" + }, + "bin": { + "nypm": "dist/cli.mjs" + }, + "engines": { + "node": "^14.16.0 || >=16.10.0" + } + }, + "node_modules/ohash": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/ohash/-/ohash-1.1.4.tgz", + "integrity": "sha512-FlDryZAahJmEF3VR3w1KogSEdWX3WhA5GPakFx4J81kEAiHyLMpdLLElS8n8dfNadMgAne/MywcvmogzscVt4g==", + "dev": true, + "license": "MIT" + }, + "node_modules/onetime": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz", + "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "mimic-fn": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/p-locate": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", @@ -1240,6 +1705,20 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, + "node_modules/pathe": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-1.1.2.tgz", + "integrity": "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/perfect-debounce": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/perfect-debounce/-/perfect-debounce-1.0.0.tgz", + "integrity": "sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==", + "dev": true, + "license": "MIT" + }, "node_modules/picocolors": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", @@ -1271,6 +1750,18 @@ "node": ">=8" } }, + "node_modules/pkg-types": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-1.2.1.tgz", + "integrity": "sha512-sQoqa8alT3nHjGuTjuKgOnvjo4cljkufdtLMnO2LBP/wRwuDlo1tkaEdMxCRhyGRPacv/ztlZgDPm2b7FAmEvw==", + "dev": true, + "license": "MIT", + "dependencies": { + "confbox": "^0.1.8", + "mlly": "^1.7.2", + "pathe": "^1.1.2" + } + }, "node_modules/prettier": { "version": "2.7.1", "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz", @@ -1305,6 +1796,17 @@ "safe-buffer": "^5.1.0" } }, + "node_modules/rc9": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/rc9/-/rc9-2.1.2.tgz", + "integrity": "sha512-btXCnMmRIBINM2LDZoEmOogIZU7Qe7zn4BpomSKZ/ykbLObuBdvG+mFq11DL6fjH1DRwHhrlgtYWG96bJiC7Cg==", + "dev": true, + "license": "MIT", + "dependencies": { + "defu": "^6.1.4", + "destr": "^2.0.3" + } + }, "node_modules/rechoir": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.8.0.tgz", @@ -1443,6 +1945,19 @@ "node": ">=8" } }, + "node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/source-map": { "version": "0.7.4", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", @@ -1472,6 +1987,32 @@ "node": ">=0.10.0" } }, + "node_modules/strip-final-newline": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", + "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/supports-preserve-symlinks-flag": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", @@ -1493,6 +2034,31 @@ "node": ">=6" } }, + "node_modules/tar": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/tar/-/tar-6.2.1.tgz", + "integrity": "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==", + "dev": true, + "license": "ISC", + "dependencies": { + "chownr": "^2.0.0", + "fs-minipass": "^2.0.0", + "minipass": "^5.0.0", + "minizlib": "^2.1.1", + "mkdirp": "^1.0.3", + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/tar/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true, + "license": "ISC" + }, "node_modules/terser": { "version": "5.31.6", "resolved": "https://registry.npmjs.org/terser/-/terser-5.31.6.tgz", @@ -1547,23 +2113,6 @@ } } }, - "node_modules/terser-webpack-plugin/node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, "node_modules/terser-webpack-plugin/node_modules/ajv-keywords": { "version": "3.5.2", "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", @@ -1574,16 +2123,6 @@ "ajv": "^6.9.1" } }, - "node_modules/terser-webpack-plugin/node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/terser-webpack-plugin/node_modules/jest-worker": { "version": "27.5.1", "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", @@ -1599,13 +2138,6 @@ "node": ">= 10.13.0" } }, - "node_modules/terser-webpack-plugin/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, "node_modules/terser-webpack-plugin/node_modules/schema-utils": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", @@ -1687,76 +2219,6 @@ "webpack": "^5.0.0" } }, - "node_modules/ts-loader/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/ts-loader/node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/ts-loader/node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/ts-loader/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "node_modules/ts-loader/node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/ts-loader/node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/ts-node": { "version": "10.9.1", "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", @@ -1801,23 +2263,32 @@ } }, "node_modules/typescript": { - "version": "4.7.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", - "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz", + "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==", "dev": true, + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=14.17" } }, + "node_modules/ufo": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.5.4.tgz", + "integrity": "sha512-UsUk3byDzKd04EyoZ7U4DOlxQaD14JUKQl6/P7wiX4FNvUfm3XL246n9W5AmqwW5RSFJ27NAuM0iLscAOYUiGQ==", + "dev": true, + "license": "MIT" + }, "node_modules/uglify-js": { - "version": "3.16.3", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.16.3.tgz", - "integrity": "sha512-uVbFqx9vvLhQg0iBaau9Z75AxWJ8tqM9AV890dIZCLApF4rTcyHwmAvLeEdYRs+BzYWu8Iw81F79ah0EfTXbaw==", + "version": "3.19.3", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz", + "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==", "dev": true, + "license": "BSD-2-Clause", "optional": true, "bin": { "uglifyjs": "bin/uglifyjs" @@ -1833,19 +2304,10 @@ "dev": true, "license": "MIT" }, - "node_modules/universalify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", - "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", - "dev": true, - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/update-browserslist-db": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", - "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz", + "integrity": "sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==", "dev": true, "funding": [ { @@ -1863,8 +2325,8 @@ ], "license": "MIT", "dependencies": { - "escalade": "^3.1.2", - "picocolors": "^1.0.1" + "escalade": "^3.2.0", + "picocolors": "^1.1.0" }, "bin": { "update-browserslist-db": "cli.js" @@ -2040,23 +2502,6 @@ "dev": true, "license": "MIT" }, - "node_modules/webpack/node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, "node_modules/webpack/node_modules/ajv-keywords": { "version": "3.5.2", "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", @@ -2067,13 +2512,6 @@ "ajv": "^6.9.1" } }, - "node_modules/webpack/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, "node_modules/webpack/node_modules/schema-utils": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", @@ -2129,7 +2567,8 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/yaml": { "version": "2.5.1", @@ -2154,7 +2593,7 @@ } }, "openapi-typescript-codegen": { - "name": "@flackonInc/openapi-typescript-codegen", + "name": "@docupilot/openapi-typescript-codegen", "version": "0.23.7", "extraneous": true, "license": "MIT", diff --git a/package.json b/package.json index 681a595..ff10c35 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,19 @@ { - "name": "@flackoninc/docupilot-js-sdk", + "name": "@docupilot/docupilot-js-sdk", "version": "1.0.0", "description": "interact with docupilot.app APIs", "main": "dist/cjs/index.js", "module": "dist/esm/index.js", + "type": "module", "files": [ "dist" ], "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "example": "ts-node examples/basic.ts", - "generate.spec.node": "node generate.js --input ./openapi.yaml --output ./src/api --useOptions --useUnionTypes --client node", - "generate.spec.react": "node generate.js --input ./openapi.yaml --output ./src/api --useOptions --useUnionTypes --client xhr", - "generate.spec.browser": "node generate.js --input ./openapi.yaml --output ./src/api --useUnionTypes --client xhr", + "generate.spec.node": "node generate.js --input ./openapi.yaml --output ./src/api --useOptions --useUnionTypes --client legacy/node", + "generate.spec.react": "node generate.js --input ./openapi.yaml --output ./src/api --useOptions --useUnionTypes --client legacy/xhr", + "generate.spec.browser": "node generate.js --input ./openapi.yaml --output ./src/api --useUnionTypes --client legacy/xhr", "build": "npm run clean:dist && npm run build:web && npm run build:esm && npm run build:cjs", "clean:dist": "rm -rf dist/", "build:esm": "tsc", @@ -21,10 +22,10 @@ }, "repository": { "type": "git", - "url": "https://github.com/flackonInc/docupilot-js-sdk" + "url": "https://github.com/docupilot/docupilot-js-sdk" }, "publishConfig": { - "@flackoninc:registry": "https://npm.pkg.github.com" + "@docupilot:registry": "https://npm.pkg.github.com" }, "keywords": [ "docupilot.app", @@ -39,15 +40,16 @@ "author": "", "license": "ISC", "devDependencies": { + "@hey-api/openapi-ts": "^0.59.2", "@types/node-fetch": "^2.6.2", "braces": "^3.0.3", + "commander": "^12.1.0", "form-data": "^4.0.0", "node-fetch": "^2.6.7", - "@flackonInc/openapi-typescript-codegen": "^0.23.7", "prettier": "^2.7.1", "ts-loader": "^9.5.1", "ts-node": "^10.9.1", - "typescript": "^4.7.4", + "typescript": "^5.7.2", "webpack": "^5.94.0", "webpack-cli": "^5.1.4", "yaml": "^2.5.1" diff --git a/src/api/core/ApiError.ts b/src/api/core/ApiError.ts index 99d7929..36675d2 100644 --- a/src/api/core/ApiError.ts +++ b/src/api/core/ApiError.ts @@ -1,24 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ import type { ApiRequestOptions } from './ApiRequestOptions'; import type { ApiResult } from './ApiResult'; export class ApiError extends Error { - public readonly url: string; - public readonly status: number; - public readonly statusText: string; - public readonly body: any; - public readonly request: ApiRequestOptions; + public readonly url: string; + public readonly status: number; + public readonly statusText: string; + public readonly body: unknown; + public readonly request: ApiRequestOptions; - constructor(request: ApiRequestOptions, response: ApiResult, message: string) { - super(message); + constructor(request: ApiRequestOptions, response: ApiResult, message: string) { + super(message); - this.name = 'ApiError'; - this.url = response.url; - this.status = response.status; - this.statusText = response.statusText; - this.body = response.body; - this.request = request; - } -} + this.name = 'ApiError'; + this.url = response.url; + this.status = response.status; + this.statusText = response.statusText; + this.body = response.body; + this.request = request; + } +} \ No newline at end of file diff --git a/src/api/core/ApiRequestOptions.ts b/src/api/core/ApiRequestOptions.ts index c7b7753..939a0aa 100644 --- a/src/api/core/ApiRequestOptions.ts +++ b/src/api/core/ApiRequestOptions.ts @@ -1,16 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ -export type ApiRequestOptions = { - readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH'; - readonly url: string; - readonly path?: Record; - readonly cookies?: Record; - readonly headers?: Record; - readonly query?: Record; - readonly formData?: Record; - readonly body?: any; - readonly mediaType?: string; - readonly responseHeader?: string; - readonly errors?: Record; -}; +export type ApiRequestOptions = { + readonly body?: any; + readonly cookies?: Record; + readonly errors?: Record; + readonly formData?: Record | any[] | Blob | File; + readonly headers?: Record; + readonly mediaType?: string; + readonly method: + | 'DELETE' + | 'GET' + | 'HEAD' + | 'OPTIONS' + | 'PATCH' + | 'POST' + | 'PUT'; + readonly path?: Record; + readonly query?: Record; + readonly responseHeader?: string; + readonly responseTransformer?: (data: unknown) => Promise; + readonly url: string; +}; \ No newline at end of file diff --git a/src/api/core/ApiResult.ts b/src/api/core/ApiResult.ts index b095dc7..4c58e39 100644 --- a/src/api/core/ApiResult.ts +++ b/src/api/core/ApiResult.ts @@ -1,10 +1,7 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ -export type ApiResult = { - readonly url: string; - readonly ok: boolean; - readonly status: number; - readonly statusText: string; - readonly body: any; -}; +export type ApiResult = { + readonly body: TData; + readonly ok: boolean; + readonly status: number; + readonly statusText: string; + readonly url: string; +}; \ No newline at end of file diff --git a/src/api/core/CancelablePromise.ts b/src/api/core/CancelablePromise.ts index 26ad303..ccc082e 100644 --- a/src/api/core/CancelablePromise.ts +++ b/src/api/core/CancelablePromise.ts @@ -1,128 +1,126 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ export class CancelError extends Error { - - constructor(message: string) { - super(message); - this.name = 'CancelError'; - } - - public get isCancelled(): boolean { - return true; - } + constructor(message: string) { + super(message); + this.name = 'CancelError'; + } + + public get isCancelled(): boolean { + return true; + } } export interface OnCancel { - readonly isResolved: boolean; - readonly isRejected: boolean; - readonly isCancelled: boolean; + readonly isResolved: boolean; + readonly isRejected: boolean; + readonly isCancelled: boolean; - (cancelHandler: () => void): void; + (cancelHandler: () => void): void; } export class CancelablePromise implements Promise { - readonly [Symbol.toStringTag]!: string; - - private _isResolved: boolean; - private _isRejected: boolean; - private _isCancelled: boolean; - private readonly _cancelHandlers: (() => void)[]; - private readonly _promise: Promise; - private _resolve?: (value: T | PromiseLike) => void; - private _reject?: (reason?: any) => void; - - constructor( - executor: ( - resolve: (value: T | PromiseLike) => void, - reject: (reason?: any) => void, - onCancel: OnCancel - ) => void - ) { - this._isResolved = false; - this._isRejected = false; - this._isCancelled = false; - this._cancelHandlers = []; - this._promise = new Promise((resolve, reject) => { - this._resolve = resolve; - this._reject = reject; - - const onResolve = (value: T | PromiseLike): void => { - if (this._isResolved || this._isRejected || this._isCancelled) { - return; - } - this._isResolved = true; - this._resolve?.(value); - }; - - const onReject = (reason?: any): void => { - if (this._isResolved || this._isRejected || this._isCancelled) { - return; - } - this._isRejected = true; - this._reject?.(reason); - }; - - const onCancel = (cancelHandler: () => void): void => { - if (this._isResolved || this._isRejected || this._isCancelled) { - return; - } - this._cancelHandlers.push(cancelHandler); - }; - - Object.defineProperty(onCancel, 'isResolved', { - get: (): boolean => this._isResolved, - }); - - Object.defineProperty(onCancel, 'isRejected', { - get: (): boolean => this._isRejected, - }); - - Object.defineProperty(onCancel, 'isCancelled', { - get: (): boolean => this._isCancelled, - }); - - return executor(onResolve, onReject, onCancel as OnCancel); - }); - } - - public then( - onFulfilled?: ((value: T) => TResult1 | PromiseLike) | null, - onRejected?: ((reason: any) => TResult2 | PromiseLike) | null - ): Promise { - return this._promise.then(onFulfilled, onRejected); - } - - public catch( - onRejected?: ((reason: any) => TResult | PromiseLike) | null - ): Promise { - return this._promise.catch(onRejected); - } - - public finally(onFinally?: (() => void) | null): Promise { - return this._promise.finally(onFinally); - } - - public cancel(): void { - if (this._isResolved || this._isRejected || this._isCancelled) { - return; - } - this._isCancelled = true; - if (this._cancelHandlers.length) { - try { - for (const cancelHandler of this._cancelHandlers) { - cancelHandler(); - } - } catch (error) { - console.warn('Cancellation threw an error', error); - return; - } - } - this._cancelHandlers.length = 0; - this._reject?.(new CancelError('Request aborted')); - } - - public get isCancelled(): boolean { - return this._isCancelled; - } -} + private _isResolved: boolean; + private _isRejected: boolean; + private _isCancelled: boolean; + readonly cancelHandlers: (() => void)[]; + readonly promise: Promise; + private _resolve?: (value: T | PromiseLike) => void; + private _reject?: (reason?: unknown) => void; + + constructor( + executor: ( + resolve: (value: T | PromiseLike) => void, + reject: (reason?: unknown) => void, + onCancel: OnCancel + ) => void + ) { + this._isResolved = false; + this._isRejected = false; + this._isCancelled = false; + this.cancelHandlers = []; + this.promise = new Promise((resolve, reject) => { + this._resolve = resolve; + this._reject = reject; + + const onResolve = (value: T | PromiseLike): void => { + if (this._isResolved || this._isRejected || this._isCancelled) { + return; + } + this._isResolved = true; + if (this._resolve) this._resolve(value); + }; + + const onReject = (reason?: unknown): void => { + if (this._isResolved || this._isRejected || this._isCancelled) { + return; + } + this._isRejected = true; + if (this._reject) this._reject(reason); + }; + + const onCancel = (cancelHandler: () => void): void => { + if (this._isResolved || this._isRejected || this._isCancelled) { + return; + } + this.cancelHandlers.push(cancelHandler); + }; + + Object.defineProperty(onCancel, 'isResolved', { + get: (): boolean => this._isResolved, + }); + + Object.defineProperty(onCancel, 'isRejected', { + get: (): boolean => this._isRejected, + }); + + Object.defineProperty(onCancel, 'isCancelled', { + get: (): boolean => this._isCancelled, + }); + + return executor(onResolve, onReject, onCancel as OnCancel); + }); + } + + get [Symbol.toStringTag]() { + return "Cancellable Promise"; + } + + public then( + onFulfilled?: ((value: T) => TResult1 | PromiseLike) | null, + onRejected?: ((reason: unknown) => TResult2 | PromiseLike) | null + ): Promise { + return this.promise.then(onFulfilled, onRejected); + } + + public catch( + onRejected?: ((reason: unknown) => TResult | PromiseLike) | null + ): Promise { + return this.promise.catch(onRejected); + } + + public finally(onFinally?: (() => void) | null): Promise { + return this.promise.finally(onFinally); + } + + public cancel(): void { + if (this._isResolved || this._isRejected || this._isCancelled) { + return; + } + this._isCancelled = true; + if (this.cancelHandlers.length) { + try { + for (const cancelHandler of this.cancelHandlers) { + cancelHandler(); + } + } catch (error) { + console.warn('Cancellation threw an error', error); + return; + } + } + this.cancelHandlers.length = 0; + if (this._reject) this._reject(new CancelError('Request aborted')); + } + + public get isCancelled(): boolean { + return this._isCancelled; + } +} \ No newline at end of file diff --git a/src/api/core/OpenAPI.ts b/src/api/core/OpenAPI.ts index ecbed14..6dbf084 100644 --- a/src/api/core/OpenAPI.ts +++ b/src/api/core/OpenAPI.ts @@ -1,31 +1,56 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ import type { ApiRequestOptions } from './ApiRequestOptions'; -type Resolver = (options: ApiRequestOptions) => Promise; type Headers = Record; +type Middleware = (value: T) => T | Promise; +type Resolver = (options: ApiRequestOptions) => Promise; + +export class Interceptors { + _fns: Middleware[]; + + constructor() { + this._fns = []; + } + + eject(fn: Middleware): void { + const index = this._fns.indexOf(fn); + if (index !== -1) { + this._fns = [...this._fns.slice(0, index), ...this._fns.slice(index + 1)]; + } + } + + use(fn: Middleware): void { + this._fns = [...this._fns, fn]; + } +} export type OpenAPIConfig = { - BASE: string; - VERSION: string; - WITH_CREDENTIALS: boolean; - CREDENTIALS: 'include' | 'omit' | 'same-origin'; - TOKEN?: string | Resolver; - USERNAME?: string | Resolver; - PASSWORD?: string | Resolver; - HEADERS?: Headers | Resolver; - ENCODE_PATH?: (path: string) => string; + BASE: string; + CREDENTIALS: 'include' | 'omit' | 'same-origin'; + ENCODE_PATH?: ((path: string) => string) | undefined; + HEADERS?: Headers | Resolver | undefined; + PASSWORD?: string | Resolver | undefined; + TOKEN?: string | Resolver | undefined; + USERNAME?: string | Resolver | undefined; + VERSION: string; + WITH_CREDENTIALS: boolean; + interceptors: { + request: Interceptors; + response: Interceptors; + }; }; export const OpenAPI: OpenAPIConfig = { - BASE: '', - VERSION: '2.0', - WITH_CREDENTIALS: false, - CREDENTIALS: 'include', - TOKEN: undefined, - USERNAME: undefined, - PASSWORD: undefined, - HEADERS: undefined, - ENCODE_PATH: undefined, -}; + BASE: '', + CREDENTIALS: 'include', + ENCODE_PATH: undefined, + HEADERS: undefined, + PASSWORD: undefined, + TOKEN: undefined, + USERNAME: undefined, + VERSION: '2.0', + WITH_CREDENTIALS: false, + interceptors: { + request: new Interceptors(), + response: new Interceptors(), + }, +}; \ No newline at end of file diff --git a/src/api/core/request.ts b/src/api/core/request.ts index eee5a68..9b08a59 100644 --- a/src/api/core/request.ts +++ b/src/api/core/request.ts @@ -1,6 +1,3 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ import { ApiError } from './ApiError'; import type { ApiRequestOptions } from './ApiRequestOptions'; import type { ApiResult } from './ApiResult'; @@ -8,267 +5,300 @@ import { CancelablePromise } from './CancelablePromise'; import type { OnCancel } from './CancelablePromise'; import type { OpenAPIConfig } from './OpenAPI'; -const isDefined = (value: T | null | undefined): value is Exclude => { - return value !== undefined && value !== null; +export const isString = (value: unknown): value is string => { + return typeof value === 'string'; }; -const isString = (value: any): value is string => { - return typeof value === 'string'; +export const isStringWithValue = (value: unknown): value is string => { + return isString(value) && value !== ''; }; -const isStringWithValue = (value: any): value is string => { - return isString(value) && value !== ''; +export const isBlob = (value: any): value is Blob => { + return value instanceof Blob; }; -const isBlob = (value: any): value is Blob => { - return ( - typeof value === 'object' && - typeof value.type === 'string' && - typeof value.stream === 'function' && - typeof value.arrayBuffer === 'function' && - typeof value.constructor === 'function' && - typeof value.constructor.name === 'string' && - /^(Blob|File)$/.test(value.constructor.name) && - /^(Blob|File)$/.test(value[Symbol.toStringTag]) - ); +export const isFormData = (value: unknown): value is FormData => { + return value instanceof FormData; }; -const isFormData = (value: any): value is FormData => { - return value instanceof FormData; +export const isSuccess = (status: number): boolean => { + return status >= 200 && status < 300; }; -const isSuccess = (status: number): boolean => { - return status >= 200 && status < 300; +export const base64 = (str: string): string => { + try { + return btoa(str); + } catch (err) { + // @ts-ignore + return Buffer.from(str).toString('base64'); + } }; -const base64 = (str: string): string => { - try { - return btoa(str); - } catch (err) { - // @ts-ignore - return Buffer.from(str).toString('base64'); - } -}; +export const getQueryString = (params: Record): string => { + const qs: string[] = []; + + const append = (key: string, value: unknown) => { + qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); + }; + + const encodePair = (key: string, value: unknown) => { + if (value === undefined || value === null) { + return; + } -const getQueryString = (params: Record): string => { - const qs: string[] = []; - - const append = (key: string, value: any) => { - qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); - }; - - const process = (key: string, value: any) => { - if (isDefined(value)) { - if (Array.isArray(value)) { - value.forEach(v => { - process(key, v); - }); - } else if (typeof value === 'object') { - Object.entries(value).forEach(([k, v]) => { - process(`${key}[${k}]`, v); - }); - } else { - append(key, value); - } - } - }; - - Object.entries(params).forEach(([key, value]) => { - process(key, value); - }); - - if (qs.length > 0) { - return `?${qs.join('&')}`; - } - - return ''; + if (value instanceof Date) { + append(key, value.toISOString()); + } else if (Array.isArray(value)) { + value.forEach(v => encodePair(key, v)); + } else if (typeof value === 'object') { + Object.entries(value).forEach(([k, v]) => encodePair(`${key}[${k}]`, v)); + } else { + append(key, value); + } + }; + + Object.entries(params).forEach(([key, value]) => encodePair(key, value)); + + return qs.length ? `?${qs.join('&')}` : ''; }; const getUrl = (config: OpenAPIConfig, options: ApiRequestOptions): string => { - const encoder = config.ENCODE_PATH || encodeURI; - - const path = options.url - .replace('{api-version}', config.VERSION) - .replace(/{(.*?)}/g, (substring: string, group: string) => { - if (options.path?.hasOwnProperty(group)) { - return encoder(String(options.path[group])); - } - return substring; - }); - - const url = `${config.BASE}${path}`; - if (options.query) { - return `${url}${getQueryString(options.query)}`; - } - return url; + const encoder = config.ENCODE_PATH || encodeURI; + + const path = options.url + .replace('{api-version}', config.VERSION) + .replace(/{(.*?)}/g, (substring: string, group: string) => { + if (options.path?.hasOwnProperty(group)) { + return encoder(String(options.path[group])); + } + return substring; + }); + + const url = config.BASE + path; + return options.query ? url + getQueryString(options.query) : url; }; -const getFormData = (options: ApiRequestOptions): FormData | undefined => { - if (options.formData) { - const formData = new FormData(); - - const process = (key: string, value: any) => { - if (isString(value) || isBlob(value)) { - formData.append(key, value); - } else { - formData.append(key, JSON.stringify(value)); - } - }; - - Object.entries(options.formData) - .filter(([_, value]) => isDefined(value)) - .forEach(([key, value]) => { - if (Array.isArray(value)) { - value.forEach(v => process(key, v)); - } else { - process(key, value); - } - }); - - return formData; - } - return undefined; +export const getFormData = (options: ApiRequestOptions): FormData | undefined => { + if (options.formData) { + const formData = new FormData(); + + const process = (key: string, value: unknown) => { + if (isString(value) || isBlob(value)) { + formData.append(key, value); + } else { + formData.append(key, JSON.stringify(value)); + } + }; + + Object.entries(options.formData) + .filter(([, value]) => value !== undefined && value !== null) + .forEach(([key, value]) => { + if (Array.isArray(value)) { + value.forEach(v => process(key, v)); + } else { + process(key, value); + } + }); + + return formData; + } + return undefined; }; -type Resolver = (options: ApiRequestOptions) => Promise; +type Resolver = (options: ApiRequestOptions) => Promise; -const resolve = async (options: ApiRequestOptions, resolver?: T | Resolver): Promise => { - if (typeof resolver === 'function') { - return (resolver as Resolver)(options); - } - return resolver; +export const resolve = async (options: ApiRequestOptions, resolver?: T | Resolver): Promise => { + if (typeof resolver === 'function') { + return (resolver as Resolver)(options); + } + return resolver; }; -const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise => { - const token = await resolve(options, config.TOKEN); - const username = await resolve(options, config.USERNAME); - const password = await resolve(options, config.PASSWORD); - const additionalHeaders = await resolve(options, config.HEADERS); - - const headers = Object.entries({ - Accept: 'application/json', - ...additionalHeaders, - ...options.headers, - }) - .filter(([_, value]) => isDefined(value)) - .reduce((headers, [key, value]) => ({ - ...headers, - [key]: String(value), - }), {} as Record); - - if (isStringWithValue(token)) { - headers['Authorization'] = `Bearer ${token}`; - } - - if (isStringWithValue(username) && isStringWithValue(password)) { - const credentials = base64(`${username}:${password}`); - headers['Authorization'] = `Basic ${credentials}`; - } - - if (options.body) { - if (options.mediaType) { - headers['Content-Type'] = options.mediaType; - } else if (isBlob(options.body)) { - headers['Content-Type'] = options.body.type || 'application/octet-stream'; - } else if (isString(options.body)) { - headers['Content-Type'] = 'text/plain'; - } else if (!isFormData(options.body)) { - headers['Content-Type'] = 'application/json'; - } - } - - return new Headers(headers); +export const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise => { + const [token, username, password, additionalHeaders] = await Promise.all([ + // @ts-ignore + resolve(options, config.TOKEN), + // @ts-ignore + resolve(options, config.USERNAME), + // @ts-ignore + resolve(options, config.PASSWORD), + // @ts-ignore + resolve(options, config.HEADERS), + ]); + + const headers = Object.entries({ + Accept: 'application/json', + ...additionalHeaders, + ...options.headers, + }) + .filter(([, value]) => value !== undefined && value !== null) + .reduce((headers, [key, value]) => ({ + ...headers, + [key]: String(value), + }), {} as Record); + + if (isStringWithValue(token)) { + headers['Authorization'] = `Bearer ${token}`; + } + + if (isStringWithValue(username) && isStringWithValue(password)) { + const credentials = base64(`${username}:${password}`); + headers['Authorization'] = `Basic ${credentials}`; + } + + if (options.body !== undefined) { + if (options.mediaType) { + headers['Content-Type'] = options.mediaType; + } else if (isBlob(options.body)) { + headers['Content-Type'] = options.body.type || 'application/octet-stream'; + } else if (isString(options.body)) { + headers['Content-Type'] = 'text/plain'; + } else if (!isFormData(options.body)) { + headers['Content-Type'] = 'application/json'; + } + } + + return new Headers(headers); }; -const getRequestBody = (options: ApiRequestOptions): any => { - if (options.body !== undefined) { - if (options.mediaType?.includes('/json')) { - return JSON.stringify(options.body) - } else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) { - return options.body; - } else { - return JSON.stringify(options.body); - } - } - return undefined; +export const getRequestBody = (options: ApiRequestOptions): unknown => { + if (options.body !== undefined) { + if (options.mediaType?.includes('application/json') || options.mediaType?.includes('+json')) { + return JSON.stringify(options.body); + } else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) { + return options.body; + } else { + return JSON.stringify(options.body); + } + } + return undefined; }; export const sendRequest = async ( - config: OpenAPIConfig, - options: ApiRequestOptions, - url: string, - body: any, - formData: FormData | undefined, - headers: Headers, - onCancel: OnCancel + config: OpenAPIConfig, + options: ApiRequestOptions, + url: string, + body: any, + formData: FormData | undefined, + headers: Headers, + onCancel: OnCancel ): Promise => { - const xhr = new XMLHttpRequest(); - xhr.open(options.method, url, true); - xhr.withCredentials = config.WITH_CREDENTIALS; - - headers.forEach((value, key) => { - xhr.setRequestHeader(key, value); - }); - - return new Promise((resolve, reject) => { - xhr.onload = () => resolve(xhr); - xhr.onabort = () => reject(new Error('Request aborted')); - xhr.onerror = () => reject(new Error('Network error')); - xhr.send(body ?? formData); - - onCancel(() => xhr.abort()); - }); + let xhr = new XMLHttpRequest(); + xhr.open(options.method, url, true); + xhr.withCredentials = config.WITH_CREDENTIALS; + + headers.forEach((value, key) => { + xhr.setRequestHeader(key, value); + }); + + return new Promise(async (resolve, reject) => { + xhr.onload = () => resolve(xhr); + xhr.onabort = () => reject(new Error('Request aborted')); + xhr.onerror = () => reject(new Error('Network error')); + + for (const fn of config.interceptors.request._fns) { + xhr = await fn(xhr); + } + + xhr.send(body ?? formData); + + onCancel(() => xhr.abort()); + }); }; -const getResponseHeader = (xhr: XMLHttpRequest, responseHeader?: string): string | undefined => { - if (responseHeader) { - const content = xhr.getResponseHeader(responseHeader); - if (isString(content)) { - return content; - } - } - return undefined; +export const getResponseHeader = (xhr: XMLHttpRequest, responseHeader?: string): string | undefined => { + if (responseHeader) { + const content = xhr.getResponseHeader(responseHeader); + if (isString(content)) { + return content; + } + } + return undefined; }; -const getResponseBody = (xhr: XMLHttpRequest): any => { - if (xhr.status !== 204) { - try { - const contentType = xhr.getResponseHeader('Content-Type'); - if (contentType) { - const isJSON = contentType.toLowerCase().startsWith('application/json'); - if (isJSON) { - return JSON.parse(xhr.responseText); - } else { - return xhr.responseText; - } - } - } catch (error) { - console.error(error); - } - } - return undefined; +export const getResponseBody = (xhr: XMLHttpRequest): unknown => { + if (xhr.status !== 204) { + try { + const contentType = xhr.getResponseHeader('Content-Type'); + if (contentType) { + if (contentType.includes('application/json') || contentType.includes('+json')) { + return JSON.parse(xhr.responseText); + } else { + return xhr.responseText; + } + } + } catch (error) { + console.error(error); + } + } + return undefined; }; -const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult): void => { - const errors: Record = { - 400: 'Bad Request', - 401: 'Unauthorized', - 403: 'Forbidden', - 404: 'Not Found', - 500: 'Internal Server Error', - 502: 'Bad Gateway', - 503: 'Service Unavailable', - ...options.errors, - } - - const error = errors[result.status]; - if (error) { - throw new ApiError(options, result, error); - } - - if (!result.ok) { - throw new ApiError(options, result, 'Generic Error'); - } +export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult): void => { + const errors: Record = { + 400: 'Bad Request', + 401: 'Unauthorized', + 402: 'Payment Required', + 403: 'Forbidden', + 404: 'Not Found', + 405: 'Method Not Allowed', + 406: 'Not Acceptable', + 407: 'Proxy Authentication Required', + 408: 'Request Timeout', + 409: 'Conflict', + 410: 'Gone', + 411: 'Length Required', + 412: 'Precondition Failed', + 413: 'Payload Too Large', + 414: 'URI Too Long', + 415: 'Unsupported Media Type', + 416: 'Range Not Satisfiable', + 417: 'Expectation Failed', + 418: 'Im a teapot', + 421: 'Misdirected Request', + 422: 'Unprocessable Content', + 423: 'Locked', + 424: 'Failed Dependency', + 425: 'Too Early', + 426: 'Upgrade Required', + 428: 'Precondition Required', + 429: 'Too Many Requests', + 431: 'Request Header Fields Too Large', + 451: 'Unavailable For Legal Reasons', + 500: 'Internal Server Error', + 501: 'Not Implemented', + 502: 'Bad Gateway', + 503: 'Service Unavailable', + 504: 'Gateway Timeout', + 505: 'HTTP Version Not Supported', + 506: 'Variant Also Negotiates', + 507: 'Insufficient Storage', + 508: 'Loop Detected', + 510: 'Not Extended', + 511: 'Network Authentication Required', + ...options.errors, + } + + const error = errors[result.status]; + if (error) { + throw new ApiError(options, result, error); + } + + if (!result.ok) { + const errorStatus = result.status ?? 'unknown'; + const errorStatusText = result.statusText ?? 'unknown'; + const errorBody = (() => { + try { + return JSON.stringify(result.body, null, 2); + } catch (e) { + return undefined; + } + })(); + + throw new ApiError(options, result, + `Generic Error: status: ${errorStatus}; status text: ${errorStatusText}; body: ${errorBody}` + ); + } }; /** @@ -278,33 +308,43 @@ const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult): void => * @returns CancelablePromise * @throws ApiError */ -export const request = (config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise => { - return new CancelablePromise(async (resolve, reject, onCancel) => { - try { - const url = getUrl(config, options); - const formData = getFormData(options); - const body = getRequestBody(options); - const headers = await getHeaders(config, options); - - if (!onCancel.isCancelled) { - const response = await sendRequest(config, options, url, body, formData, headers, onCancel); - const responseBody = getResponseBody(response); - const responseHeader = getResponseHeader(response, options.responseHeader); - - const result: ApiResult = { - url, - ok: isSuccess(response.status), - status: response.status, - statusText: response.statusText, - body: responseHeader ?? responseBody, - }; - - catchErrorCodes(options, result); - - resolve(result.body); - } - } catch (error) { - reject(error); - } - }); -}; +export const request = (config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise => { + return new CancelablePromise(async (resolve, reject, onCancel) => { + try { + const url = getUrl(config, options); + const formData = getFormData(options); + const body = getRequestBody(options); + const headers = await getHeaders(config, options); + + if (!onCancel.isCancelled) { + let response = await sendRequest(config, options, url, body, formData, headers, onCancel); + + for (const fn of config.interceptors.response._fns) { + response = await fn(response); + } + + const responseBody = getResponseBody(response); + const responseHeader = getResponseHeader(response, options.responseHeader); + + let transformedBody = responseBody; + if (options.responseTransformer && isSuccess(response.status)) { + transformedBody = await options.responseTransformer(responseBody) + } + + const result: ApiResult = { + url, + ok: isSuccess(response.status), + status: response.status, + statusText: response.statusText, + body: responseHeader ?? transformedBody, + }; + + catchErrorCodes(options, result); + + resolve(result.body); + } + } catch (error) { + reject(error); + } + }); +}; \ No newline at end of file diff --git a/src/api/index.ts b/src/api/index.ts index c0f7d36..50a1dd7 100644 --- a/src/api/index.ts +++ b/src/api/index.ts @@ -1,140 +1,6 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts export { ApiError } from './core/ApiError'; export { CancelablePromise, CancelError } from './core/CancelablePromise'; -export { OpenAPI } from './core/OpenAPI'; -export type { OpenAPIConfig } from './core/OpenAPI'; - -export type { AcceptInvite } from './models/AcceptInvite'; -export type { AccountDelivery } from './models/AccountDelivery'; -export type { AITemplateCreate } from './models/AITemplateCreate'; -export type { AITemplateEdit } from './models/AITemplateEdit'; -export type { AppendFiles } from './models/AppendFiles'; -export type { AttachmentsConfig } from './models/AttachmentsConfig'; -export type { AuthToken } from './models/AuthToken'; -export type { BannerNotification } from './models/BannerNotification'; -export type { BannerNotificationAction } from './models/BannerNotificationAction'; -export type { BulkGen } from './models/BulkGen'; -export type { BulkGenData } from './models/BulkGenData'; -export type { BulkGenerateMeta } from './models/BulkGenerateMeta'; -export type { BulkGenTask } from './models/BulkGenTask'; -export type { BulkGenUpload } from './models/BulkGenUpload'; -export type { ChangeRole } from './models/ChangeRole'; -export type { ChargebeeSubscription } from './models/ChargebeeSubscription'; -export type { ChatThreads } from './models/ChatThreads'; -export type { ChildTemplate } from './models/ChildTemplate'; -export type { CopyTemplate } from './models/CopyTemplate'; -export type { CreateCustomerThreadInput } from './models/CreateCustomerThreadInput'; -export type { CreateCustomerThreadOutput } from './models/CreateCustomerThreadOutput'; -export type { CSMDetails } from './models/CSMDetails'; -export type { DeleteCurrentWorkspace } from './models/DeleteCurrentWorkspace'; -export type { DeliveryAccount } from './models/DeliveryAccount'; -export type { DocumentMergeLink } from './models/DocumentMergeLink'; -export type { DocuSignDelivery } from './models/DocuSignDelivery'; -export type { Domain } from './models/Domain'; -export type { DomainFailure } from './models/DomainFailure'; -export type { DomainVerify } from './models/DomainVerify'; -export type { DropboxDelivery } from './models/DropboxDelivery'; -export type { DynamicImage } from './models/DynamicImage'; -export type { EmailDelivery } from './models/EmailDelivery'; -export type { EmailDeliveryAttachment } from './models/EmailDeliveryAttachment'; -export type { EversignDelivery } from './models/EversignDelivery'; -export type { ExportMergeHistory } from './models/ExportMergeHistory'; -export type { File } from './models/File'; -export type { FileUploadMeta } from './models/FileUploadMeta'; -export type { FillablePdfSettings } from './models/FillablePdfSettings'; -export type { Folder } from './models/Folder'; -export type { FolderCount } from './models/FolderCount'; -export type { FolderSharing } from './models/FolderSharing'; -export type { ForbiddenError } from './models/ForbiddenError'; -export type { GalleryCategory } from './models/GalleryCategory'; -export type { GlobalPermission } from './models/GlobalPermission'; -export type { GoogleDriveDelivery } from './models/GoogleDriveDelivery'; -export type { GoogleDrivePickerPayload } from './models/GoogleDrivePickerPayload'; -export type { HelloSignDelivery } from './models/HelloSignDelivery'; -export type { HostedPage } from './models/HostedPage'; -export type { InitiateAuthorizationSequence } from './models/InitiateAuthorizationSequence'; -export type { Invitation } from './models/Invitation'; -export type { MergeHistory } from './models/MergeHistory'; -export type { Meta } from './models/Meta'; -export type { MoveTemplate } from './models/MoveTemplate'; -export type { NewTemplate } from './models/NewTemplate'; -export type { NotFoundError } from './models/NotFoundError'; -export type { NpsNextReminder } from './models/NpsNextReminder'; -export type { NpsRating } from './models/NpsRating'; -export type { OneDriveDelivery } from './models/OneDriveDelivery'; -export type { PaginatedAccountDeliveryList } from './models/PaginatedAccountDeliveryList'; -export type { PaginatedBulkGenList } from './models/PaginatedBulkGenList'; -export type { PaginatedMergeHistoryList } from './models/PaginatedMergeHistoryList'; -export type { PaginatedTemplateList } from './models/PaginatedTemplateList'; -export type { PatchedDomain } from './models/PatchedDomain'; -export type { PatchedUpdateFolderSharing } from './models/PatchedUpdateFolderSharing'; -export type { PatchedUpdateNewTemplate } from './models/PatchedUpdateNewTemplate'; -export type { PatchedUpdateTemplateSharing } from './models/PatchedUpdateTemplateSharing'; -export type { PatchedUpdateUser } from './models/PatchedUpdateUser'; -export type { PatchedWorkspace } from './models/PatchedWorkspace'; -export type { Plan } from './models/Plan'; -export type { PolymorphicDelivery } from './models/PolymorphicDelivery'; -export type { PromptSuggestions } from './models/PromptSuggestions'; -export type { RenewSubscription } from './models/RenewSubscription'; -export type { RetentionPreference } from './models/RetentionPreference'; -export type { S3Delivery } from './models/S3Delivery'; -export type { SaveCustomerFeedback } from './models/SaveCustomerFeedback'; -export type { SendEmailAccountAuthorizationOTP } from './models/SendEmailAccountAuthorizationOTP'; -export type { SendTestSmtpMail } from './models/SendTestSmtpMail'; -export type { SftpDelivery } from './models/SftpDelivery'; -export type { SharingInfoFolder } from './models/SharingInfoFolder'; -export type { SharingInfoTemplate } from './models/SharingInfoTemplate'; -export type { SignableDelivery } from './models/SignableDelivery'; -export type { SignNowDelivery } from './models/SignNowDelivery'; -export type { SurveyPrompt } from './models/SurveyPrompt'; -export type { TeamMember } from './models/TeamMember'; -export type { Template } from './models/Template'; -export type { TemplateCount } from './models/TemplateCount'; -export type { TemplateDelivery } from './models/TemplateDelivery'; -export type { TemplateGallery } from './models/TemplateGallery'; -export type { TemplateInfo } from './models/TemplateInfo'; -export type { TemplateSchema } from './models/TemplateSchema'; -export type { TemplateSettings } from './models/TemplateSettings'; -export type { TemplateSharing } from './models/TemplateSharing'; -export type { ThreadMessages } from './models/ThreadMessages'; -export type { Timezone } from './models/Timezone'; -export type { TransferOwnership } from './models/TransferOwnership'; -export type { UnauthenticatedError } from './models/UnauthenticatedError'; -export type { UpdateCustomerThreadInput } from './models/UpdateCustomerThreadInput'; -export type { UpdateCustomerThreadOutput } from './models/UpdateCustomerThreadOutput'; -export type { UpdateDeliveryAccount } from './models/UpdateDeliveryAccount'; -export type { UpdateThreadName } from './models/UpdateThreadName'; -export type { UploadTemplateImage } from './models/UploadTemplateImage'; -export type { User } from './models/User'; -export type { UserPersonalization } from './models/UserPersonalization'; -export type { UserPersonalizationListViewTemplate } from './models/UserPersonalizationListViewTemplate'; -export type { ValidationError } from './models/ValidationError'; -export type { VerifyEmailAccountOTP } from './models/VerifyEmailAccountOTP'; -export type { WebhookDelivery } from './models/WebhookDelivery'; -export type { Workspace } from './models/Workspace'; -export type { YouSignDelivery } from './models/YouSignDelivery'; - -export { AiService } from './services/AiService'; -export { AiChatService } from './services/AiChatService'; -export { AppendService } from './services/AppendService'; -export { AuthTokensService } from './services/AuthTokensService'; -export { DomainService } from './services/DomainService'; -export { FoldersService } from './services/FoldersService'; -export { GalleryTemplatesService } from './services/GalleryTemplatesService'; -export { GeneralService } from './services/GeneralService'; -export { GenerateService } from './services/GenerateService'; -export { GenerateBulkService } from './services/GenerateBulkService'; -export { HistoryService } from './services/HistoryService'; -export { InvitationsService } from './services/InvitationsService'; -export { LinkedAccountsService } from './services/LinkedAccountsService'; -export { PermissionsService } from './services/PermissionsService'; -export { PersonalizationService } from './services/PersonalizationService'; -export { SubscriptionService } from './services/SubscriptionService'; -export { TeamService } from './services/TeamService'; -export { TemplateDeliveryService } from './services/TemplateDeliveryService'; -export { TemplatesService } from './services/TemplatesService'; -export { UsersService } from './services/UsersService'; -export { UserSatisfactionSurveyService } from './services/UserSatisfactionSurveyService'; -export { WorkspacesService } from './services/WorkspacesService'; +export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI'; +export * from './sdk.gen'; +export * from './types.gen'; \ No newline at end of file diff --git a/src/api/models/AITemplateCreate.ts b/src/api/models/AITemplateCreate.ts deleted file mode 100644 index c276347..0000000 --- a/src/api/models/AITemplateCreate.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AITemplateCreate = { - ai_prompt: string; - title: string; - description?: string | null; - folder?: number | null; -}; - diff --git a/src/api/models/AITemplateEdit.ts b/src/api/models/AITemplateEdit.ts deleted file mode 100644 index 0a6e324..0000000 --- a/src/api/models/AITemplateEdit.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AITemplateEdit = { - ai_prompt: string; - selected_content: string; - readonly ai_response: string; -}; - diff --git a/src/api/models/AcceptInvite.ts b/src/api/models/AcceptInvite.ts deleted file mode 100644 index 2d0e4f7..0000000 --- a/src/api/models/AcceptInvite.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AcceptInvite = { - workspace_unique_key: string; -}; - diff --git a/src/api/models/AccountDelivery.ts b/src/api/models/AccountDelivery.ts deleted file mode 100644 index b3881dc..0000000 --- a/src/api/models/AccountDelivery.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { TemplateInfo } from './TemplateInfo'; - -export type AccountDelivery = { - readonly id: number; - name: string; - last_used_on?: string | null; - template_info: TemplateInfo; -}; - diff --git a/src/api/models/AppendFiles.ts b/src/api/models/AppendFiles.ts deleted file mode 100644 index 6aa6288..0000000 --- a/src/api/models/AppendFiles.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AppendFiles = { - files: Array; - output_file_name?: string; -}; - diff --git a/src/api/models/AttachmentsConfig.ts b/src/api/models/AttachmentsConfig.ts deleted file mode 100644 index adc9d7a..0000000 --- a/src/api/models/AttachmentsConfig.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AttachmentsConfig = { - allowed_types: string; - max_files: number; - max_total_size: number; -}; - diff --git a/src/api/models/AuthToken.ts b/src/api/models/AuthToken.ts deleted file mode 100644 index 583b054..0000000 --- a/src/api/models/AuthToken.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type AuthToken = { - readonly id: number; - readonly token: string; - name: string; - readonly created_time: string; - readonly last_used_time: string | null; - active?: boolean; -}; - diff --git a/src/api/models/BannerNotification.ts b/src/api/models/BannerNotification.ts deleted file mode 100644 index bc2becc..0000000 --- a/src/api/models/BannerNotification.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { BannerNotificationAction } from './BannerNotificationAction'; - -export type BannerNotification = { - id: string; - content: string; - action: BannerNotificationAction; -}; - diff --git a/src/api/models/BannerNotificationAction.ts b/src/api/models/BannerNotificationAction.ts deleted file mode 100644 index f952632..0000000 --- a/src/api/models/BannerNotificationAction.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type BannerNotificationAction = { - text: string; - attributes: Record; -}; - diff --git a/src/api/models/BulkGen.ts b/src/api/models/BulkGen.ts deleted file mode 100644 index d8bdf5f..0000000 --- a/src/api/models/BulkGen.ts +++ /dev/null @@ -1,20 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { BulkGenTask } from './BulkGenTask'; - -export type BulkGen = { - readonly id: number; - readonly errors: Array; - readonly file_name: string; - status?: 0 | 1 | 2 | 3 | 4 | 5; - start_time?: string | null; - end_time?: string | null; - total?: number | null; - success?: number | null; - readonly updated_time: string; - readonly created_by: number; - readonly updated_by: number | null; -}; - diff --git a/src/api/models/BulkGenData.ts b/src/api/models/BulkGenData.ts deleted file mode 100644 index 2b984a5..0000000 --- a/src/api/models/BulkGenData.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type BulkGenData = { - id: number; - data: Record; - row_count: number; - suggested_mapping: Record; -}; - diff --git a/src/api/models/BulkGenTask.ts b/src/api/models/BulkGenTask.ts deleted file mode 100644 index d651fb5..0000000 --- a/src/api/models/BulkGenTask.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type BulkGenTask = { - status_message?: string | null; -}; - diff --git a/src/api/models/BulkGenUpload.ts b/src/api/models/BulkGenUpload.ts deleted file mode 100644 index aff386d..0000000 --- a/src/api/models/BulkGenUpload.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type BulkGenUpload = { - file: Blob; -}; - diff --git a/src/api/models/BulkGenerateMeta.ts b/src/api/models/BulkGenerateMeta.ts deleted file mode 100644 index a67d72b..0000000 --- a/src/api/models/BulkGenerateMeta.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type BulkGenerateMeta = { - max_test_rows: number; -}; - diff --git a/src/api/models/CSMDetails.ts b/src/api/models/CSMDetails.ts deleted file mode 100644 index 5bbae13..0000000 --- a/src/api/models/CSMDetails.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type CSMDetails = { - name: string; - phone_number: string; -}; - diff --git a/src/api/models/ChangeRole.ts b/src/api/models/ChangeRole.ts deleted file mode 100644 index ba1b37d..0000000 --- a/src/api/models/ChangeRole.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ChangeRole = { - role: 'owner' | 'admin' | 'manager' | 'member' | 'billing_manager'; -}; - diff --git a/src/api/models/ChargebeeSubscription.ts b/src/api/models/ChargebeeSubscription.ts deleted file mode 100644 index 08aae47..0000000 --- a/src/api/models/ChargebeeSubscription.ts +++ /dev/null @@ -1,20 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ChargebeeSubscription = { - plan_id?: string | null; - status?: 'a' | 't' | 'e' | 'c' | 'p'; - trial_end?: string; - billing_period_unit?: string | null; - readonly current_term_start: string; - readonly current_term_end: string; - unpaid_invoices?: number; - max_allowed_unpaid_invoices?: number; - overage_enabled: boolean; - documents_allowed?: number; - documents_created?: number; - readonly can_extend_trial: boolean; - readonly subscribed_on: string; -}; - diff --git a/src/api/models/ChatThreads.ts b/src/api/models/ChatThreads.ts deleted file mode 100644 index 590f99e..0000000 --- a/src/api/models/ChatThreads.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ChatThreads = { - readonly id: number; - thread_id: string; - thread_name?: string | null; - tokens_used?: number; - model_name: string; -}; - diff --git a/src/api/models/ChildTemplate.ts b/src/api/models/ChildTemplate.ts deleted file mode 100644 index 52f80f7..0000000 --- a/src/api/models/ChildTemplate.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ChildTemplate = { - readonly id: number; - readonly title: string; - description?: string | null; - type?: 'docx' | 'html' | 'fillable_pdf' | 'pptx' | 'xlsx' | 'g_document' | 'g_presentation' | 'g_spreadsheet'; - readonly created_time: string; - readonly updated_time: string; - document_status?: 'active' | 'test'; - deleted_time?: string | null; - readonly created_by: number; - readonly updated_by: number | null; - folder?: number | null; -}; - diff --git a/src/api/models/CopyTemplate.ts b/src/api/models/CopyTemplate.ts deleted file mode 100644 index 1f856f9..0000000 --- a/src/api/models/CopyTemplate.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type CopyTemplate = { - title: string; -}; - diff --git a/src/api/models/CreateCustomerThreadInput.ts b/src/api/models/CreateCustomerThreadInput.ts deleted file mode 100644 index c966f39..0000000 --- a/src/api/models/CreateCustomerThreadInput.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type CreateCustomerThreadInput = { - message: string; -}; - diff --git a/src/api/models/CreateCustomerThreadOutput.ts b/src/api/models/CreateCustomerThreadOutput.ts deleted file mode 100644 index fb4891f..0000000 --- a/src/api/models/CreateCustomerThreadOutput.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type CreateCustomerThreadOutput = { - output_message: string; - thread_id: number; - thread_display_name: string; -}; - diff --git a/src/api/models/DeleteCurrentWorkspace.ts b/src/api/models/DeleteCurrentWorkspace.ts deleted file mode 100644 index 2969224..0000000 --- a/src/api/models/DeleteCurrentWorkspace.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DeleteCurrentWorkspace = { - otp: string; -}; - diff --git a/src/api/models/DeliveryAccount.ts b/src/api/models/DeliveryAccount.ts deleted file mode 100644 index f949077..0000000 --- a/src/api/models/DeliveryAccount.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DeliveryAccount = { - readonly id: number; - type: 'hellosign' | 'aws_s3' | 'signable' | 'yousign' | 'email' | 'sftp'; - readonly sub_type: string; - readonly used_by: number; - readonly name: string | null; - credentials: Record; - readonly is_expired: boolean; - readonly updated_at: string; - use_for_images?: boolean; -}; - diff --git a/src/api/models/DocuSignDelivery.ts b/src/api/models/DocuSignDelivery.ts deleted file mode 100644 index 4bfe69c..0000000 --- a/src/api/models/DocuSignDelivery.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DocuSignDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - custom_tags?: Record>> | null; - signers: Array<{ - order?: string; - recipient_type: 'signer' | 'agent' | 'cc' | 'editor'; - name: string; - is_email_delivery: boolean; - is_sms_delivery: boolean; - email_address?: string; - country_code?: string; - phone_number?: string; - }>; - reminder_settings?: { - reminder_delay: number; - reminder_frequency: number; - } | null; - overwrite_account_defaults?: boolean; - name: string; - type?: 'docu_sign'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - subject?: string | null; - message?: string | null; - fullname_anchor_tags?: boolean; - sequenced_signing?: boolean; - expire_after?: number | null; - enable_optional_signers?: boolean; - readonly api_version: '2.0' | '2.1'; - folder_id?: string | null; - folder_name?: string | null; - allow_reassign?: boolean; -}; - diff --git a/src/api/models/DocumentMergeLink.ts b/src/api/models/DocumentMergeLink.ts deleted file mode 100644 index bc2e796..0000000 --- a/src/api/models/DocumentMergeLink.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DocumentMergeLink = { - readonly path: string; -}; - diff --git a/src/api/models/Domain.ts b/src/api/models/Domain.ts deleted file mode 100644 index 753c9cd..0000000 --- a/src/api/models/Domain.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type Domain = { - readonly id: number; - domain_name: string; - txt_record: string; - is_txt_verified?: boolean; - is_spf_verified?: boolean; - readonly spf_record: string; -}; - diff --git a/src/api/models/DomainFailure.ts b/src/api/models/DomainFailure.ts deleted file mode 100644 index 1107481..0000000 --- a/src/api/models/DomainFailure.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DomainFailure = { - spf_record: string; - txt_record: string; -}; - diff --git a/src/api/models/DomainVerify.ts b/src/api/models/DomainVerify.ts deleted file mode 100644 index e34e9b6..0000000 --- a/src/api/models/DomainVerify.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { DomainFailure } from './DomainFailure'; - -export type DomainVerify = { - success: Array<'txt_record' | 'spf_record'>; - failures: DomainFailure; -}; - diff --git a/src/api/models/DropboxDelivery.ts b/src/api/models/DropboxDelivery.ts deleted file mode 100644 index 87542e6..0000000 --- a/src/api/models/DropboxDelivery.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DropboxDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - name: string; - type?: 'dropbox'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - folder?: string; - mode?: 'add_as_new' | 'conflict' | 'overwrite'; -}; - diff --git a/src/api/models/DynamicImage.ts b/src/api/models/DynamicImage.ts deleted file mode 100644 index 2e6d0ce..0000000 --- a/src/api/models/DynamicImage.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type DynamicImage = { - token: string; - page?: number; - left: number; - top: number; - width: number; - height: number; -}; - diff --git a/src/api/models/EmailDelivery.ts b/src/api/models/EmailDelivery.ts deleted file mode 100644 index 2ba5161..0000000 --- a/src/api/models/EmailDelivery.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { File } from './File'; - -export type EmailDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number | null; - readonly attachments: Array; - name: string; - type?: 'email'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - from_email?: string | null; - to_email: Array; - cc?: Array; - bcc?: Array; - headers?: Record | null; - subject?: string; - body?: string; - enable_optional_recipients?: boolean; -}; - diff --git a/src/api/models/EmailDeliveryAttachment.ts b/src/api/models/EmailDeliveryAttachment.ts deleted file mode 100644 index cfcea6b..0000000 --- a/src/api/models/EmailDeliveryAttachment.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type EmailDeliveryAttachment = { - attachments: Array; -}; - diff --git a/src/api/models/EversignDelivery.ts b/src/api/models/EversignDelivery.ts deleted file mode 100644 index c7fccda..0000000 --- a/src/api/models/EversignDelivery.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type EversignDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - signers: Array<{ - pin?: string; - name: string; - email: string; - order?: string; - }>; - recipients?: Array<{ - name: string; - email: string; - }> | null; - name: string; - type?: 'eversign'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - title?: string | null; - message?: string | null; - use_signer_order?: boolean; - reminders?: boolean; - require_all_signers?: boolean; - expires_in?: number | null; - enable_optional_signers?: boolean; -}; - diff --git a/src/api/models/ExportMergeHistory.ts b/src/api/models/ExportMergeHistory.ts deleted file mode 100644 index 04c8f71..0000000 --- a/src/api/models/ExportMergeHistory.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ExportMergeHistory = { - readonly id: number; - readonly name: string; - from_date: string; - to_date: string; - status?: 'pending' | 'success' | 'error'; -}; - diff --git a/src/api/models/File.ts b/src/api/models/File.ts deleted file mode 100644 index 221fa6e..0000000 --- a/src/api/models/File.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type File = { - readonly id: number; - path: string; - name: string; - tag: string; - readonly size: number; -}; - diff --git a/src/api/models/FileUploadMeta.ts b/src/api/models/FileUploadMeta.ts deleted file mode 100644 index 38cc9ae..0000000 --- a/src/api/models/FileUploadMeta.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { AttachmentsConfig } from './AttachmentsConfig'; - -export type FileUploadMeta = { - email_attachments: AttachmentsConfig; -}; - diff --git a/src/api/models/FillablePdfSettings.ts b/src/api/models/FillablePdfSettings.ts deleted file mode 100644 index b1dbf70..0000000 --- a/src/api/models/FillablePdfSettings.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type FillablePdfSettings = { - width: number; - height: number; - no_of_pages: number; - dynamic_images?: Record | null; -}; - diff --git a/src/api/models/Folder.ts b/src/api/models/Folder.ts deleted file mode 100644 index 3413e33..0000000 --- a/src/api/models/Folder.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type Folder = { - readonly id: number; - name: string; - readonly created_time: string; - readonly updated_time: string; - readonly created_by: number; - readonly updated_by: number | null; -}; - diff --git a/src/api/models/FolderCount.ts b/src/api/models/FolderCount.ts deleted file mode 100644 index 8f06f33..0000000 --- a/src/api/models/FolderCount.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type FolderCount = { - folders_count: number; -}; - diff --git a/src/api/models/FolderSharing.ts b/src/api/models/FolderSharing.ts deleted file mode 100644 index 2c69a81..0000000 --- a/src/api/models/FolderSharing.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type FolderSharing = { - readonly id: number; - permission?: 'read' | 'write' | 'manage'; - user: number; -}; - diff --git a/src/api/models/ForbiddenError.ts b/src/api/models/ForbiddenError.ts deleted file mode 100644 index eab1130..0000000 --- a/src/api/models/ForbiddenError.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type ForbiddenError = { - detail: string; -}; - diff --git a/src/api/models/GalleryCategory.ts b/src/api/models/GalleryCategory.ts deleted file mode 100644 index 8fbd415..0000000 --- a/src/api/models/GalleryCategory.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type GalleryCategory = { - readonly id: number; - name: string; -}; - diff --git a/src/api/models/GlobalPermission.ts b/src/api/models/GlobalPermission.ts deleted file mode 100644 index 27d0b14..0000000 --- a/src/api/models/GlobalPermission.ts +++ /dev/null @@ -1,17 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type GlobalPermission = { - templates: boolean; - folders: boolean; - workspace: boolean; - 'workspace:update': boolean; - 'workspace:delete': boolean; - billing: boolean; - 'team:manage': boolean; - integrations: boolean; - reports: boolean; - api_settings: boolean; -}; - diff --git a/src/api/models/GoogleDriveDelivery.ts b/src/api/models/GoogleDriveDelivery.ts deleted file mode 100644 index 3d80ac7..0000000 --- a/src/api/models/GoogleDriveDelivery.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type GoogleDriveDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - name: string; - type?: 'google_drive'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - /** - * Base folder name - */ - folder?: string; - /** - * Base folder id - */ - folder_id?: string | null; - /** - * Dynamic folder path - */ - path?: string | null; -}; - diff --git a/src/api/models/GoogleDrivePickerPayload.ts b/src/api/models/GoogleDrivePickerPayload.ts deleted file mode 100644 index b8fa589..0000000 --- a/src/api/models/GoogleDrivePickerPayload.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type GoogleDrivePickerPayload = { - payload: string; -}; - diff --git a/src/api/models/HelloSignDelivery.ts b/src/api/models/HelloSignDelivery.ts deleted file mode 100644 index 8937372..0000000 --- a/src/api/models/HelloSignDelivery.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type HelloSignDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - signers: Array<{ - name: string; - email_address: string; - }>; - name: string; - type?: 'hellosign'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - title?: string | null; - subject?: string | null; - message?: string | null; - cc?: Array; - use_text_tags?: boolean; - hide_text_tags?: boolean; - sequenced_signing?: boolean; - enable_optional_signers?: boolean; -}; - diff --git a/src/api/models/HostedPage.ts b/src/api/models/HostedPage.ts deleted file mode 100644 index 4350458..0000000 --- a/src/api/models/HostedPage.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type HostedPage = { - url: string; -}; - diff --git a/src/api/models/InitiateAuthorizationSequence.ts b/src/api/models/InitiateAuthorizationSequence.ts deleted file mode 100644 index b1a70a5..0000000 --- a/src/api/models/InitiateAuthorizationSequence.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type InitiateAuthorizationSequence = { - action_name?: 'delete workspace' | 'transfer ownership'; -}; - diff --git a/src/api/models/Invitation.ts b/src/api/models/Invitation.ts deleted file mode 100644 index 3710a4a..0000000 --- a/src/api/models/Invitation.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type Invitation = { - readonly id: number; - readonly workspace: string; - readonly sender: string; - readonly expired: string; - email: string; - role: 'admin' | 'manager' | 'member' | 'billing_manager'; - readonly created_at: string; - readonly expires_at: string; - readonly accepted_at: string | null; - readonly is_accepted: boolean; - readonly invite_key: string; -}; - diff --git a/src/api/models/MergeHistory.ts b/src/api/models/MergeHistory.ts deleted file mode 100644 index cd5194b..0000000 --- a/src/api/models/MergeHistory.ts +++ /dev/null @@ -1,23 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { ChildTemplate } from './ChildTemplate'; - -export type MergeHistory = { - readonly id: number; - readonly template: ChildTemplate | null; - data: Record; - data_expired: boolean; - document_expired: boolean; - delivery_type: string; - status: 'pending' | 'success' | 'error'; - readonly created_time: string; - created_file_name: string; - message?: Record | null; - mode?: string | null; - callback_status?: 'success' | 'fail' | null; - callback_failure_message?: string | null; - delivery?: number | null; -}; - diff --git a/src/api/models/Meta.ts b/src/api/models/Meta.ts deleted file mode 100644 index 70975ba..0000000 --- a/src/api/models/Meta.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { BulkGenerateMeta } from './BulkGenerateMeta'; -import type { FileUploadMeta } from './FileUploadMeta'; - -export type Meta = { - file_uploads: FileUploadMeta; - batch_process_max_allowed_test_rows: BulkGenerateMeta; - iam: string; -}; - diff --git a/src/api/models/MoveTemplate.ts b/src/api/models/MoveTemplate.ts deleted file mode 100644 index d8662c1..0000000 --- a/src/api/models/MoveTemplate.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type MoveTemplate = { - template_ids: Array; - new_folder_id: number | null; -}; - diff --git a/src/api/models/NewTemplate.ts b/src/api/models/NewTemplate.ts deleted file mode 100644 index df9e87b..0000000 --- a/src/api/models/NewTemplate.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type NewTemplate = { - file?: Blob; - folder?: number | null; - title: string; - output_type: 'html' | 'pdf' | 'jpeg' | 'png' | 'docx' | 'pptx' | 'xlsx'; - description?: string | null; - template_gallery_id?: number; -}; - diff --git a/src/api/models/NotFoundError.ts b/src/api/models/NotFoundError.ts deleted file mode 100644 index dadc5a1..0000000 --- a/src/api/models/NotFoundError.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type NotFoundError = { - detail: string; -}; - diff --git a/src/api/models/NpsNextReminder.ts b/src/api/models/NpsNextReminder.ts deleted file mode 100644 index d4dc881..0000000 --- a/src/api/models/NpsNextReminder.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type NpsNextReminder = { - days: number; -}; - diff --git a/src/api/models/NpsRating.ts b/src/api/models/NpsRating.ts deleted file mode 100644 index e6055c5..0000000 --- a/src/api/models/NpsRating.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type NpsRating = { - nps_rating?: number | null; -}; - diff --git a/src/api/models/OneDriveDelivery.ts b/src/api/models/OneDriveDelivery.ts deleted file mode 100644 index 71002cb..0000000 --- a/src/api/models/OneDriveDelivery.ts +++ /dev/null @@ -1,17 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type OneDriveDelivery = { - readonly id: number; - failure_email_recipients?: string | null; - account: number; - name: string; - type?: 'one_drive'; - success_callback_url?: string | null; - success_callback_payload?: Record | null; - success_callback_headers?: Record | null; - last_used_on?: string | null; - folder?: string; -}; - diff --git a/src/api/models/PaginatedAccountDeliveryList.ts b/src/api/models/PaginatedAccountDeliveryList.ts deleted file mode 100644 index 5d66067..0000000 --- a/src/api/models/PaginatedAccountDeliveryList.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { AccountDelivery } from './AccountDelivery'; - -export type PaginatedAccountDeliveryList = { - count?: number; - next?: string | null; - previous?: string | null; - results?: Array; -}; - diff --git a/src/api/models/PaginatedBulkGenList.ts b/src/api/models/PaginatedBulkGenList.ts deleted file mode 100644 index 0b49d6d..0000000 --- a/src/api/models/PaginatedBulkGenList.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { BulkGen } from './BulkGen'; - -export type PaginatedBulkGenList = { - count?: number; - next?: string | null; - previous?: string | null; - results?: Array; -}; - diff --git a/src/api/models/PaginatedMergeHistoryList.ts b/src/api/models/PaginatedMergeHistoryList.ts deleted file mode 100644 index ac53535..0000000 --- a/src/api/models/PaginatedMergeHistoryList.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { MergeHistory } from './MergeHistory'; - -export type PaginatedMergeHistoryList = { - count?: number; - next?: string | null; - previous?: string | null; - results?: Array; -}; - diff --git a/src/api/models/PaginatedTemplateList.ts b/src/api/models/PaginatedTemplateList.ts deleted file mode 100644 index 93b9149..0000000 --- a/src/api/models/PaginatedTemplateList.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { Template } from './Template'; - -export type PaginatedTemplateList = { - count?: number; - next?: string | null; - previous?: string | null; - results?: Array