openapi: 3.0.3 info: title: '_t__OpenApi::TITLE' description: '_t__OpenApi::DESCRIPTION' termsOfService: 'https://www.hellosign.com/terms' contact: email: apisupport@hellosign.com license: name: MIT url: 'https://opensource.org/licenses/MIT' version: 3.0.0 servers: - url: 'https://api.hellosign.com/v3' paths: /account/create: post: tags: - Account summary: '_t__AccountCreate::SUMMARY' description: '_t__AccountCreate::DESCRIPTION' operationId: accountCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: default_example: $ref: '#/components/examples/AccountCreateRequestDefaultExample' oauth: $ref: '#/components/examples/AccountCreateRequestOAuthExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: default_example: $ref: '#/components/examples/AccountCreateResponseExample' oauth: $ref: '#/components/examples/AccountCreateOAuthResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountCreate.ts - lang: Java label: Java source: $ref: examples/AccountCreate.java - lang: Ruby label: Ruby source: $ref: examples/AccountCreate.rb - lang: Python label: Python source: $ref: examples/AccountCreate.py x-meta: seo: title: '_t__AccountCreate::SEO::TITLE' description: '_t__AccountCreate::SEO::DESCRIPTION' /account: get: tags: - Account summary: '_t__AccountGet::SUMMARY' description: '_t__AccountGet::DESCRIPTION' operationId: accountGet parameters: - name: account_id in: query description: '_t__AccountGet::ACCOUNT_ID' required: false schema: type: string responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountGetResponse' examples: default_example: $ref: '#/components/examples/AccountGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access - basic_account_info x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountGet.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountGet.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountGet.ts - lang: Java label: Java source: $ref: examples/AccountGet.java - lang: Ruby label: Ruby source: $ref: examples/AccountGet.rb - lang: Python label: Python source: $ref: examples/AccountGet.py x-meta: seo: title: '_t__AccountGet::SEO::TITLE' description: '_t__AccountGet::SEO::DESCRIPTION' put: tags: - Account summary: '_t__AccountUpdate::SUMMARY' description: '_t__AccountUpdate::DESCRIPTION' operationId: accountUpdate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: default_example: $ref: '#/components/examples/AccountUpdateRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountGetResponse' examples: default_example: $ref: '#/components/examples/AccountUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountUpdate.ts - lang: Java label: Java source: $ref: examples/AccountUpdate.java - lang: Ruby label: Ruby source: $ref: examples/AccountUpdate.rb - lang: Python label: Python source: $ref: examples/AccountUpdate.py x-meta: seo: title: '_t__AccountUpdate::SEO::TITLE' description: '_t__AccountUpdate::SEO::DESCRIPTION' /account/verify: post: tags: - Account summary: '_t__AccountVerify::SUMMARY' description: '_t__AccountVerify::DESCRIPTION' operationId: accountVerify requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: default_example: $ref: '#/components/examples/AccountVerifyRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: default_example: $ref: '#/components/examples/AccountVerifyFoundResponseExample' not_found: $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountVerify.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountVerify.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountVerify.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountVerify.ts - lang: Java label: Java source: $ref: examples/AccountVerify.java - lang: Ruby label: Ruby source: $ref: examples/AccountVerify.rb - lang: Python label: Python source: $ref: examples/AccountVerify.py x-meta: seo: title: '_t__AccountVerify::SEO::TITLE' description: '_t__AccountVerify::SEO::DESCRIPTION' /api_app: post: tags: - 'Api App' summary: '_t__ApiAppCreate::SUMMARY' description: '_t__ApiAppCreate::DESCRIPTION' operationId: apiAppCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: default_example: $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: default_example: $ref: '#/components/examples/ApiAppCreateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppCreate.ts - lang: Java label: Java source: $ref: examples/ApiAppCreate.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppCreate.rb - lang: Python label: Python source: $ref: examples/ApiAppCreate.py x-meta: seo: title: '_t__ApiAppCreate::SEO::TITLE' description: '_t__ApiAppCreate::SEO::DESCRIPTION' '/api_app/{client_id}': get: tags: - 'Api App' summary: '_t__ApiAppGet::SUMMARY' description: '_t__ApiAppGet::DESCRIPTION' operationId: apiAppGet parameters: - name: client_id in: path description: '_t__ApiAppGet::CLIENT_ID' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppGet.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppGet.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppGet.ts - lang: Java label: Java source: $ref: examples/ApiAppGet.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppGet.rb - lang: Python label: Python source: $ref: examples/ApiAppGet.py x-meta: seo: title: '_t__ApiAppGet::SEO::TITLE' description: '_t__ApiAppGet::SEO::DESCRIPTION' put: tags: - 'Api App' summary: '_t__ApiAppUpdate::SUMMARY' description: '_t__ApiAppUpdate::DESCRIPTION' operationId: apiAppUpdate parameters: - name: client_id in: path description: '_t__ApiAppUpdate::CLIENT_ID' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: default_example: $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: default_example: $ref: '#/components/examples/ApiAppUpdateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppUpdate.ts - lang: Java label: Java source: $ref: examples/ApiAppUpdate.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppUpdate.rb - lang: Python label: Python source: $ref: examples/ApiAppUpdate.py x-meta: seo: title: '_t__ApiAppUpdate::SEO::TITLE' description: '_t__ApiAppUpdate::SEO::DESCRIPTION' delete: tags: - 'Api App' summary: '_t__ApiAppDelete::SUMMARY' description: '_t__ApiAppDelete::DESCRIPTION' operationId: apiAppDelete parameters: - name: client_id in: path description: '_t__ApiAppDelete::CLIENT_ID' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: '204': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppDelete.ts - lang: Java label: Java source: $ref: examples/ApiAppDelete.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppDelete.rb - lang: Python label: Python source: $ref: examples/ApiAppDelete.py x-meta: seo: title: '_t__ApiAppDelete::SEO::TITLE' description: '_t__ApiAppDelete::SEO::DESCRIPTION' /api_app/list: get: tags: - 'Api App' summary: '_t__ApiAppList::SUMMARY' description: '_t__ApiAppList::DESCRIPTION' operationId: apiAppList parameters: - name: page in: query description: '_t__ApiAppList::PAGE' schema: type: integer default: 1 - name: page_size in: query description: '_t__ApiAppList::PAGE_SIZE' schema: type: integer default: 20 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: default_example: $ref: '#/components/examples/ApiAppListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppList.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppList.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppList.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppList.ts - lang: Java label: Java source: $ref: examples/ApiAppList.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppList.rb - lang: Python label: Python source: $ref: examples/ApiAppList.py x-meta: seo: title: '_t__ApiAppList::SEO::TITLE' description: '_t__ApiAppList::SEO::DESCRIPTION' '/bulk_send_job/{bulk_send_job_id}': get: tags: - 'Bulk Send Job' summary: '_t__BulkSendJobGet::SUMMARY' description: '_t__BulkSendJobGet::DESCRIPTION' operationId: bulkSendJobGet parameters: - name: bulk_send_job_id in: path description: '_t__BulkSendJobGet::BULK_SEND_JOB_ID' required: true schema: type: string example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: default_example: $ref: '#/components/examples/BulkSendJobGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/BulkSendJobGet.php - lang: 'C#' label: 'C#' source: $ref: examples/BulkSendJobGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/BulkSendJobGet.js - lang: TypeScript label: TypeScript source: $ref: examples/BulkSendJobGet.ts - lang: Java label: Java source: $ref: examples/BulkSendJobGet.java - lang: Ruby label: Ruby source: $ref: examples/BulkSendJobGet.rb - lang: Python label: Python source: $ref: examples/BulkSendJobGet.py x-meta: seo: title: '_t__BulkSendJobGet::SEO::TITLE' description: '_t__BulkSendJobGet::SEO::DESCRIPTION' /bulk_send_job/list: get: tags: - 'Bulk Send Job' summary: '_t__BulkSendJobList::SUMMARY' description: '_t__BulkSendJobList::DESCRIPTION' operationId: bulkSendJobList parameters: - name: page in: query description: '_t__BulkSendJobList::PAGE' schema: type: integer default: 1 - name: page_size in: query description: '_t__BulkSendJobList::PAGE_SIZE' schema: type: integer default: 20 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: default_example: $ref: '#/components/examples/BulkSendJobListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/BulkSendJobList.php - lang: 'C#' label: 'C#' source: $ref: examples/BulkSendJobList.cs - lang: JavaScript label: JavaScript source: $ref: examples/BulkSendJobList.js - lang: TypeScript label: TypeScript source: $ref: examples/BulkSendJobList.ts - lang: Java label: Java source: $ref: examples/BulkSendJobList.java - lang: Ruby label: Ruby source: $ref: examples/BulkSendJobList.rb - lang: Python label: Python source: $ref: examples/BulkSendJobList.py x-meta: seo: title: '_t__BulkSendJobList::SEO::TITLE' description: '_t__BulkSendJobList::SEO::DESCRIPTION' '/embedded/edit_url/{template_id}': post: tags: - Embedded summary: '_t__EmbeddedEditUrl::SUMMARY' description: '_t__EmbeddedEditUrl::DESCRIPTION' operationId: embeddedEditUrl parameters: - name: template_id in: path description: '_t__EmbeddedEditUrl::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EmbeddedEditUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/EmbeddedEditUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/EmbeddedEditUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/EmbeddedEditUrl.ts - lang: Java label: Java source: $ref: examples/EmbeddedEditUrl.java - lang: Ruby label: Ruby source: $ref: examples/EmbeddedEditUrl.rb - lang: Python label: Python source: $ref: examples/EmbeddedEditUrl.py x-meta: seo: title: '_t__EmbeddedEditUrl::SEO::TITLE' description: '_t__EmbeddedEditUrl::SEO::DESCRIPTION' '/embedded/sign_url/{signature_id}': get: tags: - Embedded summary: '_t__EmbeddedSignUrl::SUMMARY' description: '_t__EmbeddedSignUrl::DESCRIPTION' operationId: embeddedSignUrl parameters: - name: signature_id in: path description: '_t__EmbeddedSignUrl::SIGNATURE_ID' required: true schema: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: default_example: $ref: '#/components/examples/EmbeddedSignUrlResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EmbeddedSignUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/EmbeddedSignUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/EmbeddedSignUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/EmbeddedSignUrl.ts - lang: Java label: Java source: $ref: examples/EmbeddedSignUrl.java - lang: Ruby label: Ruby source: $ref: examples/EmbeddedSignUrl.rb - lang: Python label: Python source: $ref: examples/EmbeddedSignUrl.py x-meta: seo: title: '_t__EmbeddedSignUrl::SEO::TITLE' description: '_t__EmbeddedSignUrl::SEO::DESCRIPTION' /oauth/token: post: tags: - OAuth summary: '_t__OAuthTokenGenerate::SUMMARY' description: '_t__OAuthTokenGenerate::DESCRIPTION' operationId: oauthTokenGenerate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateRequestExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' security: [] servers: - url: 'https://app.hellosign.com' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/OauthTokenGenerate.php - lang: 'C#' label: 'C#' source: $ref: examples/OauthTokenGenerate.cs - lang: JavaScript label: JavaScript source: $ref: examples/OauthTokenGenerate.js - lang: TypeScript label: TypeScript source: $ref: examples/OauthTokenGenerate.ts - lang: Java label: Java source: $ref: examples/OauthTokenGenerate.java - lang: Ruby label: Ruby source: $ref: examples/OauthTokenGenerate.rb - lang: Python label: Python source: $ref: examples/OauthTokenGenerate.py x-hideTryItPanel: true x-meta: seo: title: '_t__OAuthTokenGenerate::SEO::TITLE' description: '_t__OAuthTokenGenerate::SEO::DESCRIPTION' '/oauth/token?refresh': post: tags: - OAuth summary: '_t__OAuthTokenRefresh::SUMMARY' description: '_t__OAuthTokenRefresh::DESCRIPTION' operationId: oauthTokenRefresh requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshRequestExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' security: [] servers: - url: 'https://app.hellosign.com' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/OauthTokenRefresh.php - lang: 'C#' label: 'C#' source: $ref: examples/OauthTokenRefresh.cs - lang: JavaScript label: JavaScript source: $ref: examples/OauthTokenRefresh.js - lang: TypeScript label: TypeScript source: $ref: examples/OauthTokenRefresh.ts - lang: Java label: Java source: $ref: examples/OauthTokenRefresh.java - lang: Ruby label: Ruby source: $ref: examples/OauthTokenRefresh.rb - lang: Python label: Python source: $ref: examples/OauthTokenRefresh.py x-hideTryItPanel: true x-meta: seo: title: '_t__OAuthTokenRefresh::SEO::TITLE' description: '_t__OAuthTokenRefresh::SEO::DESCRIPTION' /report/create: post: tags: - Report summary: '_t__ReportCreate::SUMMARY' description: '_t__ReportCreate::DESCRIPTION' operationId: reportCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: default_example: $ref: '#/components/examples/ReportCreateRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: default_example: $ref: '#/components/examples/ReportCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ReportCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/ReportCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ReportCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/ReportCreate.ts - lang: Java label: Java source: $ref: examples/ReportCreate.java - lang: Ruby label: Ruby source: $ref: examples/ReportCreate.rb - lang: Python label: Python source: $ref: examples/ReportCreate.py x-meta: seo: title: '_t__ReportCreate::SEO::TITLE' description: '_t__ReportCreate::SEO::DESCRIPTION' /signature_request/bulk_create_embedded_with_template: post: tags: - 'Signature Request' summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SUMMARY' description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::DESCRIPTION' operationId: signatureRequestBulkCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py x-meta: seo: title: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE' description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::DESCRIPTION' /signature_request/bulk_send_with_template: post: tags: - 'Signature Request' summary: '_t__SignatureRequestBulkSendWithTemplate::SUMMARY' description: '_t__SignatureRequestBulkSendWithTemplate::DESCRIPTION' operationId: signatureRequestBulkSendWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestBulkSendWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestBulkSendWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestBulkSendWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestBulkSendWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestBulkSendWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestBulkSendWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestBulkSendWithTemplate.py x-meta: seo: title: '_t__SignatureRequestBulkSendWithTemplate::SEO::TITLE' description: '_t__SignatureRequestBulkSendWithTemplate::SEO::DESCRIPTION' '/signature_request/cancel/{signature_request_id}': post: tags: - 'Signature Request' summary: '_t__SignatureRequestCancel::SUMMARY' description: '_t__SignatureRequestCancel::DESCRIPTION' operationId: signatureRequestCancel parameters: - name: signature_request_id in: path description: '_t__SignatureRequestCancel::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: { } 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCancel.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCancel.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCancel.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCancel.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCancel.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCancel.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCancel.py x-meta: seo: title: '_t__SignatureRequestCancel::SEO::TITLE' description: '_t__SignatureRequestCancel::SEO::DESCRIPTION' /signature_request/create_embedded: post: tags: - 'Signature Request' summary: '_t__SignatureRequestCreateEmbedded::SUMMARY' description: '_t__SignatureRequestCreateEmbedded::DESCRIPTION' operationId: signatureRequestCreateEmbedded requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCreateEmbedded.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCreateEmbedded.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCreateEmbedded.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCreateEmbedded.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCreateEmbedded.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCreateEmbedded.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCreateEmbedded.py x-meta: seo: title: '_t__SignatureRequestCreateEmbedded::SEO::TITLE' description: '_t__SignatureRequestCreateEmbedded::SEO::DESCRIPTION' /signature_request/create_embedded_with_template: post: tags: - 'Signature Request' summary: '_t__SignatureRequestCreateEmbeddedWithTemplate::SUMMARY' description: '_t__SignatureRequestCreateEmbeddedWithTemplate::DESCRIPTION' operationId: signatureRequestCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py x-meta: seo: title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' summary: '_t__SignatureRequestFiles::SUMMARY' description: '_t__SignatureRequestFiles::DESCRIPTION' operationId: signatureRequestFiles parameters: - name: signature_request_id in: path description: '_t__SignatureRequestFiles::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - name: file_type in: query description: '_t__SignatureRequestFiles::FILE_TYPE' schema: type: string default: pdf enum: - pdf - zip - name: get_url in: query description: '_t__SignatureRequestFiles::GET_URL' schema: type: boolean default: false - name: get_data_uri in: query description: '_t__SignatureRequestFiles::GET_DATA_URI' schema: type: boolean default: false responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access - request_signature x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestFiles.ts - lang: Java label: Java source: $ref: examples/SignatureRequestFiles.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestFiles.rb - lang: Python label: Python source: $ref: examples/SignatureRequestFiles.py x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/{signature_request_id}': get: tags: - 'Signature Request' summary: '_t__SignatureRequestGet::SUMMARY' description: '_t__SignatureRequestGet::DESCRIPTION' operationId: signatureRequestGet parameters: - name: signature_request_id in: path description: '_t__SignatureRequestGet::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestGet.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestGet.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestGet.ts - lang: Java label: Java source: $ref: examples/SignatureRequestGet.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestGet.rb - lang: Python label: Python source: $ref: examples/SignatureRequestGet.py x-meta: seo: title: '_t__SignatureRequestGet::SEO::TITLE' description: '_t__SignatureRequestGet::SEO::DESCRIPTION' /signature_request/list: get: tags: - 'Signature Request' summary: '_t__SignatureRequestList::SUMMARY' description: '_t__SignatureRequestList::DESCRIPTION' operationId: signatureRequestList parameters: - name: account_id in: query description: '_t__SignatureRequestList::ACCOUNT_ID' schema: type: string - name: page in: query description: '_t__SignatureRequestList::PAGE' schema: type: integer default: 1 example: 1 - name: page_size in: query description: '_t__SignatureRequestList::PAGE_SIZE' schema: type: integer default: 20 - name: query in: query description: '_t__SignatureRequestList::QUERY' schema: type: string responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestList.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestList.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestList.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestList.ts - lang: Java label: Java source: $ref: examples/SignatureRequestList.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestList.rb - lang: Python label: Python source: $ref: examples/SignatureRequestList.py x-meta: seo: title: '_t__SignatureRequestList::SEO::TITLE' description: '_t__SignatureRequestList::SEO::DESCRIPTION' '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' summary: '_t__SignatureRequestReleaseHold::SUMMARY' description: '_t__SignatureRequestReleaseHold::DESCRIPTION' operationId: signatureRequestReleaseHold parameters: - name: signature_request_id in: path description: '_t__SignatureRequestReleaseHold::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestReleaseHold.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestReleaseHold.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestReleaseHold.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestReleaseHold.ts - lang: Java label: Java source: $ref: examples/SignatureRequestReleaseHold.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestReleaseHold.rb - lang: Python label: Python source: $ref: examples/SignatureRequestReleaseHold.py x-meta: seo: title: '_t__SignatureRequestReleaseHold::SEO::TITLE' description: '_t__SignatureRequestReleaseHold::SEO::DESCRIPTION' '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' summary: '_t__SignatureRequestRemind::SUMMARY' description: '_t__SignatureRequestRemind::DESCRIPTION' operationId: signatureRequestRemind parameters: - name: signature_request_id in: path description: '_t__SignatureRequestRemind::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestRemindResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestRemind.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestRemind.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestRemind.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestRemind.ts - lang: Java label: Java source: $ref: examples/SignatureRequestRemind.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestRemind.rb - lang: Python label: Python source: $ref: examples/SignatureRequestRemind.py x-meta: seo: title: '_t__SignatureRequestRemind::SEO::TITLE' description: '_t__SignatureRequestRemind::SEO::DESCRIPTION' '/signature_request/remove/{signature_request_id}': post: tags: - 'Signature Request' summary: '_t__SignatureRequestRemove::SUMMARY' description: '_t__SignatureRequestRemove::DESCRIPTION' operationId: signatureRequestRemove parameters: - name: signature_request_id in: path description: '_t__SignatureRequestRemove::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: { } 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestRemove.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestRemove.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestRemove.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestRemove.ts - lang: Java label: Java source: $ref: examples/SignatureRequestRemove.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestRemove.rb - lang: Python label: Python source: $ref: examples/SignatureRequestRemove.py x-meta: seo: title: '_t__SignatureRequestRemove::SEO::TITLE' description: '_t__SignatureRequestRemove::SEO::DESCRIPTION' /signature_request/send: post: tags: - 'Signature Request' summary: '_t__SignatureRequestSend::SUMMARY' description: '_t__SignatureRequestSend::DESCRIPTION' operationId: signatureRequestSend requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestSendResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestSend.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestSend.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestSend.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestSend.ts - lang: Java label: Java source: $ref: examples/SignatureRequestSend.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestSend.rb - lang: Python label: Python source: $ref: examples/SignatureRequestSend.py x-meta: seo: title: '_t__SignatureRequestSend::SEO::TITLE' description: '_t__SignatureRequestSend::SEO::DESCRIPTION' /signature_request/send_with_template: post: tags: - 'Signature Request' summary: '_t__SignatureRequestSendWithTemplate::SUMMARY' description: '_t__SignatureRequestSendWithTemplate::DESCRIPTION' operationId: signatureRequestSendWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestSendWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestSendWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestSendWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestSendWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestSendWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestSendWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestSendWithTemplate.py x-meta: seo: title: '_t__SignatureRequestSendWithTemplate::SEO::TITLE' description: '_t__SignatureRequestSendWithTemplate::SEO::DESCRIPTION' '/signature_request/update/{signature_request_id}': post: tags: - 'Signature Request' summary: '_t__SignatureRequestUpdate::SUMMARY' description: '_t__SignatureRequestUpdate::DESCRIPTION' operationId: signatureRequestUpdate parameters: - name: signature_request_id in: path description: '_t__SignatureRequestUpdate::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestUpdate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestUpdate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestUpdate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestUpdate.py x-meta: seo: title: '_t__SignatureRequestUpdate::SEO::TITLE' description: '_t__SignatureRequestUpdate::SEO::DESCRIPTION' /team/add_member: put: tags: - Team summary: '_t__TeamAddMember::SUMMARY' description: '_t__TeamAddMember::DESCRIPTION' operationId: teamAddMember parameters: - name: team_id in: query description: '_t__TeamAddMember::TEAM_ID' required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c x-beta: closed requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: email_address: $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' account_id: $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamAddMemberResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamAddMember.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamAddMember.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamAddMember.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamAddMember.ts - lang: Java label: Java source: $ref: examples/TeamAddMember.java - lang: Ruby label: Ruby source: $ref: examples/TeamAddMember.rb - lang: Python label: Python source: $ref: examples/TeamAddMember.py x-meta: seo: title: '_t__TeamAddMember::SEO::TITLE' description: '_t__TeamAddMember::SEO::DESCRIPTION' /team/create: post: tags: - Team summary: '_t__TeamCreate::SUMMARY' description: '_t__TeamCreate::DESCRIPTION' operationId: teamCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: default_example: $ref: '#/components/examples/TeamCreateRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamCreate.ts - lang: Java label: Java source: $ref: examples/TeamCreate.java - lang: Ruby label: Ruby source: $ref: examples/TeamCreate.rb - lang: Python label: Python source: $ref: examples/TeamCreate.py x-meta: seo: title: '_t__TeamCreate::SEO::TITLE' description: '_t__TeamCreate::SEO::DESCRIPTION' /team/destroy: delete: tags: - Team summary: '_t__TeamDelete::SUMMARY' description: '_t__TeamDelete::DESCRIPTION' operationId: teamDelete responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamDelete.ts - lang: Java label: Java source: $ref: examples/TeamDelete.java - lang: Ruby label: Ruby source: $ref: examples/TeamDelete.rb - lang: Python label: Python source: $ref: examples/TeamDelete.py x-meta: seo: title: '_t__TeamDelete::SEO::TITLE' description: '_t__TeamDelete::SEO::DESCRIPTION' /team: get: tags: - Team summary: '_t__TeamGet::SUMMARY' description: '_t__TeamGet::DESCRIPTION' operationId: teamGet responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/TeamDoesNotExistResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamGet.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamGet.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamGet.ts - lang: Java label: Java source: $ref: examples/TeamGet.java - lang: Ruby label: Ruby source: $ref: examples/TeamGet.rb - lang: Python label: Python source: $ref: examples/TeamGet.py x-meta: seo: title: '_t__TeamGet::SEO::TITLE' description: '_t__TeamGet::SEO::DESCRIPTION' put: tags: - Team summary: '_t__TeamUpdate::SUMMARY' description: '_t__TeamUpdate::DESCRIPTION' operationId: teamUpdate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: default_example: $ref: '#/components/examples/TeamUpdateRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamUpdate.ts - lang: Java label: Java source: $ref: examples/TeamUpdate.java - lang: Ruby label: Ruby source: $ref: examples/TeamUpdate.rb - lang: Python label: Python source: $ref: examples/TeamUpdate.py x-meta: seo: title: '_t__TeamUpdate::SEO::TITLE' description: '_t__TeamUpdate::SEO::DESCRIPTION' /team/info: get: tags: - Team summary: '_t__TeamInfo::SUMMARY' description: '_t__TeamInfo::DESCRIPTION' operationId: teamInfo parameters: - name: team_id in: query description: '_t__TeamInfo::TEAM_ID' required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: default_example: $ref: '#/components/examples/TeamGetInfoResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamInfo.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamInfo.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamInfo.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamInfo.ts - lang: Java label: Java source: $ref: examples/TeamInfo.java - lang: Ruby label: Ruby source: $ref: examples/TeamInfo.rb - lang: Python label: Python source: $ref: examples/TeamInfo.py x-beta: closed x-meta: seo: title: '_t__TeamInfo::SEO::TITLE' description: '_t__TeamInfo::SEO::DESCRIPTION' '/team/members/{team_id}': get: tags: - Team summary: '_t__TeamMembers::SUMMARY' description: '_t__TeamMembers::DESCRIPTION' operationId: teamMembers parameters: - name: team_id in: path description: '_t__TeamMembers::TEAM_ID' required: true schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - name: page in: query description: '_t__TeamMembers::PAGE' schema: type: integer default: 1 - name: page_size in: query description: '_t__TeamMembers::PAGE_SIZE' schema: type: integer default: 20 maximum: 100 minimum: 1 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: default_example: $ref: '#/components/examples/TeamMembersResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamMembers.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamMembers.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamMembers.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamMembers.ts - lang: Java label: Java source: $ref: examples/TeamMembers.java - lang: Ruby label: Ruby source: $ref: examples/TeamMembers.rb - lang: Python label: Python source: $ref: examples/TeamMembers.py x-beta: closed x-meta: seo: title: '_t__TeamMembers::SEO::TITLE' description: '_t__TeamMembers::SEO::DESCRIPTION' /team/remove_member: post: tags: - Team summary: '_t__TeamRemoveMember::SUMMARY' description: '_t__TeamRemoveMember::DESCRIPTION' operationId: teamRemoveMember requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: email_address: $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' account_id: $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamRemoveMemberResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamRemoveMember.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamRemoveMember.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamRemoveMember.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamRemoveMember.ts - lang: Java label: Java source: $ref: examples/TeamRemoveMember.java - lang: Ruby label: Ruby source: $ref: examples/TeamRemoveMember.rb - lang: Python label: Python source: $ref: examples/TeamRemoveMember.py x-meta: seo: title: '_t__TeamRemoveMember::SEO::TITLE' description: '_t__TeamRemoveMember::SEO::DESCRIPTION' '/team/sub_teams/{team_id}': get: tags: - Team summary: '_t__TeamSubTeams::SUMMARY' description: '_t__TeamSubTeams::DESCRIPTION' operationId: teamSubTeams parameters: - name: team_id in: path description: '_t__TeamSubTeams::TEAM_ID' required: true schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - name: page in: query description: '_t__TeamSubTeams::PAGE' schema: type: integer default: 1 - name: page_size in: query description: '_t__TeamSubTeams::PAGE_SIZE' schema: type: integer default: 20 maximum: 100 minimum: 1 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: default_example: $ref: '#/components/examples/TeamSubTeamsResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamSubTeams.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamSubTeams.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamSubTeams.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamSubTeams.ts - lang: Java label: Java source: $ref: examples/TeamSubTeams.java - lang: Ruby label: Ruby source: $ref: examples/TeamSubTeams.rb - lang: Python label: Python source: $ref: examples/TeamSubTeams.py x-beta: closed x-meta: seo: title: '_t__TeamSubTeams::SEO::TITLE' description: '_t__TeamSubTeams::SEO::DESCRIPTION' '/template/add_user/{template_id}': post: tags: - Template summary: '_t__TemplateAddUser::SUMMARY' description: '_t__TemplateAddUser::DESCRIPTION' operationId: templateAddUser parameters: - name: template_id in: path description: '_t__TemplateAddUser::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: default_example: $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateAddUserResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateAddUser.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateAddUser.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateAddUser.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateAddUser.ts - lang: Java label: Java source: $ref: examples/TemplateAddUser.java - lang: Ruby label: Ruby source: $ref: examples/TemplateAddUser.rb - lang: Python label: Python source: $ref: examples/TemplateAddUser.py x-meta: seo: title: '_t__TemplateAddUser::SEO::TITLE' description: '_t__TemplateAddUser::SEO::DESCRIPTION' /template/create_embedded_draft: post: tags: - Template summary: '_t__TemplateCreateEmbeddedDraft::SUMMARY' description: '_t__TemplateCreateEmbeddedDraft::DESCRIPTION' operationId: templateCreateEmbeddedDraft requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateCreateEmbeddedDraft.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateCreateEmbeddedDraft.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateCreateEmbeddedDraft.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateCreateEmbeddedDraft.ts - lang: Java label: Java source: $ref: examples/TemplateCreateEmbeddedDraft.java - lang: Ruby label: Ruby source: $ref: examples/TemplateCreateEmbeddedDraft.rb - lang: Python label: Python source: $ref: examples/TemplateCreateEmbeddedDraft.py x-meta: seo: title: '_t__TemplateCreateEmbeddedDraft::SEO::TITLE' description: '_t__TemplateCreateEmbeddedDraft::SEO::DESCRIPTION' '/template/delete/{template_id}': post: tags: - Template summary: '_t__TemplateDelete::SUMMARY' description: '_t__TemplateDelete::DESCRIPTION' operationId: templateDelete parameters: - name: template_id in: path description: '_t__TemplateDelete::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: { } 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateDelete.ts - lang: Java label: Java source: $ref: examples/TemplateDelete.java - lang: Ruby label: Ruby source: $ref: examples/TemplateDelete.rb - lang: Python label: Python source: $ref: examples/TemplateDelete.py x-meta: seo: title: '_t__TemplateDelete::SEO::TITLE' description: '_t__TemplateDelete::SEO::DESCRIPTION' '/template/files/{template_id}': get: tags: - Template summary: '_t__TemplateFiles::SUMMARY' description: '_t__TemplateFiles::DESCRIPTION' operationId: templateFiles parameters: - name: template_id in: path description: '_t__TemplateFiles::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - name: file_type in: query description: '_t__TemplateFiles::FILE_TYPE' schema: type: string enum: - pdf - zip - name: get_url in: query description: '_t__TemplateFiles::GET_URL' schema: type: boolean default: false - name: get_data_uri in: query description: '_t__TemplateFiles::GET_DATA_URI' schema: type: boolean default: false responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponse' examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 422_example: $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateFiles.ts - lang: Java label: Java source: $ref: examples/TemplateFiles.java - lang: Ruby label: Ruby source: $ref: examples/TemplateFiles.rb - lang: Python label: Python source: $ref: examples/TemplateFiles.py x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/{template_id}': get: tags: - Template summary: '_t__TemplateGet::SUMMARY' description: '_t__TemplateGet::DESCRIPTION' operationId: templateGet parameters: - name: template_id in: path description: '_t__TemplateGet::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateGet.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateGet.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateGet.ts - lang: Java label: Java source: $ref: examples/TemplateGet.java - lang: Ruby label: Ruby source: $ref: examples/TemplateGet.rb - lang: Python label: Python source: $ref: examples/TemplateGet.py x-meta: seo: title: '_t__TemplateGet::SEO::TITLE' description: '_t__TemplateGet::SEO::DESCRIPTION' /template/list: get: tags: - Template summary: '_t__TemplateList::SUMMARY' description: '_t__TemplateList::DESCRIPTION' operationId: templateList parameters: - name: account_id in: query description: '_t__TemplateList::ACCOUNT_ID' schema: type: string - name: page in: query description: '_t__TemplateList::PAGE' schema: type: integer default: 1 - name: page_size in: query description: '_t__TemplateList::PAGE_SIZE' schema: type: integer default: 20 maximum: 100 minimum: 1 - name: query in: query description: '_t__TemplateList::QUERY' schema: type: string responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateListResponse' examples: default_example: $ref: '#/components/examples/TemplateListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateList.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateList.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateList.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateList.ts - lang: Java label: Java source: $ref: examples/TemplateList.java - lang: Ruby label: Ruby source: $ref: examples/TemplateList.rb - lang: Python label: Python source: $ref: examples/TemplateList.py x-meta: seo: title: '_t__TemplateList::SEO::TITLE' description: '_t__TemplateList::SEO::DESCRIPTION' '/template/remove_user/{template_id}': post: tags: - Template summary: '_t__TemplateRemoveUser::SUMMARY' description: '_t__TemplateRemoveUser::DESCRIPTION' operationId: templateRemoveUser parameters: - name: template_id in: path description: '_t__TemplateRemoveUser::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: default_example: $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateRemoveUserResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateRemoveUser.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateRemoveUser.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateRemoveUser.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateRemoveUser.ts - lang: Java label: Java source: $ref: examples/TemplateRemoveUser.java - lang: Ruby label: Ruby source: $ref: examples/TemplateRemoveUser.rb - lang: Python label: Python source: $ref: examples/TemplateRemoveUser.py x-meta: seo: title: '_t__TemplateRemoveUser::SEO::TITLE' description: '_t__TemplateRemoveUser::SEO::DESCRIPTION' '/template/update_files/{template_id}': post: tags: - Template summary: '_t__TemplateUpdateFiles::SUMMARY' description: '_t__TemplateUpdateFiles::DESCRIPTION' operationId: templateUpdateFiles parameters: - name: template_id in: path description: '_t__TemplateUpdateFiles::TEMPLATE_ID' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateUpdateFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateUpdateFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateUpdateFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateUpdateFiles.ts - lang: Java label: Java source: $ref: examples/TemplateUpdateFiles.java - lang: Ruby label: Ruby source: $ref: examples/TemplateUpdateFiles.rb - lang: Python label: Python source: $ref: examples/TemplateUpdateFiles.py x-meta: seo: title: '_t__TemplateUpdateFiles::SEO::TITLE' description: '_t__TemplateUpdateFiles::SEO::DESCRIPTION' /unclaimed_draft/create: post: tags: - 'Unclaimed Draft' summary: '_t__UnclaimedDraftCreate::SUMMARY' description: '_t__UnclaimedDraftCreate::DESCRIPTION' operationId: unclaimedDraftCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreate.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreate.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreate.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreate.py x-meta: seo: title: '_t__UnclaimedDraftCreate::SEO::TITLE' description: '_t__UnclaimedDraftCreate::SEO::DESCRIPTION' /unclaimed_draft/create_embedded: post: tags: - 'Unclaimed Draft' summary: '_t__UnclaimedDraftCreateEmbedded::SUMMARY' description: '_t__UnclaimedDraftCreateEmbedded::DESCRIPTION' operationId: unclaimedDraftCreateEmbedded requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreateEmbedded.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreateEmbedded.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreateEmbedded.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreateEmbedded.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreateEmbedded.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreateEmbedded.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreateEmbedded.py x-meta: seo: title: '_t__UnclaimedDraftCreateEmbedded::SEO::TITLE' description: '_t__UnclaimedDraftCreateEmbedded::SEO::DESCRIPTION' /unclaimed_draft/create_embedded_with_template: post: tags: - 'Unclaimed Draft' summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SUMMARY' description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::DESCRIPTION' operationId: unclaimedDraftCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py x-meta: seo: title: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE' description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/unclaimed_draft/edit_and_resend/{signature_request_id}': post: tags: - 'Unclaimed Draft' summary: '_t__UnclaimedDraftEditAndResend::SUMMARY' description: '_t__UnclaimedDraftEditAndResend::DESCRIPTION' operationId: unclaimedDraftEditAndResend parameters: - name: signature_request_id in: path description: '_t__UnclaimedDraftEditAndResend::SIGNATURE_REQUEST_ID' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' responses: '200': description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftEditAndResend.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftEditAndResend.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftEditAndResend.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftEditAndResend.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftEditAndResend.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftEditAndResend.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftEditAndResend.py x-meta: seo: title: '_t__UnclaimedDraftEditAndResend::SEO::TITLE' description: '_t__UnclaimedDraftEditAndResend::SEO::DESCRIPTION' components: schemas: AccountCreateRequest: required: - email_address properties: client_id: description: '_t__AccountCreate::CLIENT_ID' type: string client_secret: description: '_t__AccountCreate::CLIENT_SECRET' type: string email_address: description: '_t__AccountCreate::EMAIL_ADDRESS' type: string format: email locale: description: '_t__AccountCreate::LOCALE' type: string type: object AccountUpdateRequest: properties: account_id: nullable: true description: '_t__AccountUpdate::ACCOUNT_ID' type: string callback_url: description: '_t__AccountUpdate::CALLBACK_URL' type: string locale: description: '_t__AccountUpdate::LOCALE' type: string type: object AccountVerifyRequest: required: - email_address properties: email_address: description: '_t__AccountVerify::EMAIL_ADDRESS' type: string format: email type: object ApiAppCreateRequest: required: - name - domains properties: callback_url: description: '_t__ApiAppCreate::CALLBACK_URL' type: string custom_logo_file: description: '_t__ApiAppCreate::CUSTOM_LOGO_FILE' type: string format: binary domains: description: '_t__ApiAppCreate::DOMAINS' type: array items: type: string maxItems: 2 minItems: 1 name: description: '_t__ApiAppCreate::NAME' type: string oauth: $ref: '#/components/schemas/SubOAuth' options: $ref: '#/components/schemas/SubOptions' white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object ApiAppUpdateRequest: properties: callback_url: description: '_t__ApiAppUpdate::CALLBACK_URL' type: string custom_logo_file: description: '_t__ApiAppUpdate::CUSTOM_LOGO_FILE' type: string format: binary domains: description: '_t__ApiAppUpdate::DOMAINS' type: array items: type: string maxItems: 2 name: description: '_t__ApiAppUpdate::NAME' type: string oauth: $ref: '#/components/schemas/SubOAuth' options: $ref: '#/components/schemas/SubOptions' white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object EmbeddedEditUrlRequest: properties: allow_edit_ccs: description: '_t__EmbeddedEditUrl::ALLOW_EDIT_CCS' type: boolean default: false cc_roles: description: '_t__EmbeddedEditUrl::CC_ROLES' type: array items: type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' force_signer_roles: description: '_t__EmbeddedEditUrl::FORCE_SIGNER_ROLES' type: boolean default: false force_subject_message: description: '_t__EmbeddedEditUrl::FORCE_SUBJECT_MESSAGE' type: boolean default: false merge_fields: description: '_t__EmbeddedEditUrl::MERGE_FIELDS' type: array items: $ref: '#/components/schemas/SubMergeField' preview_only: description: '_t__EmbeddedEditUrl::PREVIEW_ONLY' type: boolean default: false show_preview: description: '_t__EmbeddedEditUrl::SHOW_PREVIEW' type: boolean default: false show_progress_stepper: description: '_t__EmbeddedEditUrl::SHOW_PROGRESS_STEPPER' type: boolean default: true test_mode: description: '_t__EmbeddedEditUrl::TEST_MODE' type: boolean default: false type: object SubFormFieldsPerDocumentTypeEnum: type: string enum: - checkbox - checkbox-merge - date_signed - dropdown - hyperlink - initials - signature - radio - text - text-merge SubFormFieldsPerDocumentText: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - options properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_TEXT' type: string default: text placeholder: description: '_t__Sub::FormFieldsPerDocument::PLACEHOLDER' type: string auto_fill_type: description: '_t__Sub::FormFieldsPerDocument::AUTO_FILL_TYPE' type: string link_id: description: '_t__Sub::FormFieldsPerDocument::LINK_ID' type: string masked: description: '_t__Sub::FormFieldsPerDocument::MASKED' type: boolean validation_type: description: '_t__Sub::FormFieldsPerDocument::VALIDATION_TYPE' type: string enum: - numbers_only - letters_only - phone_number - bank_routing_number - bank_account_number - email_address - zip_code - social_security_number - employer_identification_number - custom_regex validation_custom_regex: type: string validation_custom_regex_format_label: type: string type: object SubFormFieldsPerDocumentDropdown: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - options properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_DROPDOWN' type: string default: dropdown options: description: '_t__Sub::FormFieldsPerDocument::OPTIONS' type: array items: type: string minItems: 1 content: description: '_t__Sub::FormFieldsPerDocument::CONTENT_DROPDOWN' type: string type: object SubFormFieldsPerDocumentHyperlink: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - content - content_url properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_HYPERLINK' type: string default: hyperlink content: description: '_t__Sub::FormFieldsPerDocument::CONTENT_HYPERLINK' type: string content_url: description: '_t__Sub::FormFieldsPerDocument::CONTENT_URL' type: string type: object SubFormFieldsPerDocumentCheckbox: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - is_checked properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_CHECKBOX' type: string default: checkbox group: description: '_t__Sub::FormFieldsPerDocument::GROUP' type: string is_checked: description: '_t__Sub::FormFieldsPerDocument::IS_CHECKED_CHECKBOX' type: boolean type: object SubFormFieldsPerDocumentRadio: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - group - is_checked properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_RADIO' type: string default: radio group: description: '_t__Sub::FormFieldsPerDocument::GROUP' type: string is_checked: description: '_t__Sub::FormFieldsPerDocument::IS_CHECKED_RADIO' type: boolean type: object SubFormFieldsPerDocumentSignature: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_SIGNATURE' type: string default: signature type: object SubFormFieldsPerDocumentDateSigned: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_DATE_SIGNED' type: string default: date_signed type: object SubFormFieldsPerDocumentInitials: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_INITIALS' type: string default: initials type: object SubFormFieldsPerDocumentTextMerge: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE' type: string default: text-merge type: object SubFormFieldsPerDocumentCheckboxMerge: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: '_t__Sub::FormFieldsPerDocument::TYPE_CHECKBOX_MERGE' type: string default: checkbox-merge type: object OAuthTokenGenerateRequest: required: - client_id - client_secret - code - state - grant_type properties: client_id: description: '_t__OAuthTokenGenerate::CLIENT_ID' type: string client_secret: description: '_t__OAuthTokenGenerate::CLIENT_SECRET' type: string code: description: '_t__OAuthTokenGenerate::CODE' type: string grant_type: description: '_t__OAuthTokenGenerate::GRANT_TYPE' type: string default: authorization_code state: description: '_t__OAuthTokenGenerate::STATE' type: string type: object OAuthTokenRefreshRequest: required: - grant_type - refresh_token properties: grant_type: description: '_t__OAuthTokenRefresh::GRANT_TYPE' type: string default: refresh_token refresh_token: description: '_t__OAuthTokenRefresh::REFRESH_TOKEN' type: string type: object ReportCreateRequest: required: - start_date - end_date - report_type properties: end_date: description: '_t__ReportCreate::END_DATE' type: string report_type: description: '_t__ReportCreate::REPORT_TYPE' type: array items: type: string enum: - user_activity - document_status maxItems: 2 minItems: 1 start_date: description: '_t__ReportCreate::START_DATE' type: string type: object SignatureRequestBulkCreateEmbeddedWithTemplateRequest: description: 'Calls SignatureRequestBulkSendWithTemplate in controller' required: - client_id - template_ids properties: template_ids: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEMPLATE_IDS' type: array items: type: string signer_file: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE' type: string format: binary signer_list: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_LIST' type: array items: $ref: '#/components/schemas/SubBulkSignerList' allow_decline: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::ALLOW_DECLINE' type: boolean default: false ccs: description: '_t__Sub::CC::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' message: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signing_redirect_url: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL' type: string subject: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TITLE' type: string maxLength: 255 type: object SignatureRequestBulkSendWithTemplateRequest: required: - template_ids properties: template_ids: description: '_t__SignatureRequestBulkSendWithTemplate::TEMPLATE_IDS' type: array items: type: string signer_file: description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_FILE' type: string format: binary signer_list: description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_LIST' type: array items: $ref: '#/components/schemas/SubBulkSignerList' allow_decline: description: '_t__SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE' type: boolean default: false ccs: description: '_t__Sub::CC::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: '_t__SignatureRequestBulkSendWithTemplate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' message: description: '_t__SignatureRequestBulkSendWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signing_redirect_url: description: '_t__SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL' type: string subject: description: '_t__SignatureRequestBulkSendWithTemplate::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestBulkSendWithTemplate::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestBulkSendWithTemplate::TITLE' type: string maxLength: 255 type: object SignatureRequestCreateEmbeddedRequest: description: 'Calls SignatureRequestSend in controller' required: - client_id - signers properties: file: description: '_t__SignatureRequestCreateEmbedded::FILE' type: array items: type: string format: binary file_url: description: '_t__SignatureRequestCreateEmbedded::FILE_URL' type: array items: type: string allow_decline: description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' type: boolean default: false allow_reassign: description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' type: boolean default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: '_t__SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES' type: array items: type: string format: email client_id: description: '_t__SignatureRequestCreateEmbedded::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: description: '_t__Sub::FormFieldGroup::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: '_t__Sub::FormFieldRule::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: '_t__SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS' type: boolean default: false message: description: '_t__SignatureRequestCreateEmbedded::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signers: description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' subject: description: '_t__SignatureRequestCreateEmbedded::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestCreateEmbedded::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestCreateEmbedded::TITLE' type: string maxLength: 255 use_text_tags: description: '_t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS' type: boolean default: false populate_auto_fill_fields: description: '_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false x-beta: closed type: object SignatureRequestCreateEmbeddedWithTemplateRequest: description: 'Calls SignatureRequestSend in controller' required: - client_id - template_ids - signers properties: template_ids: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TEMPLATE_IDS' type: array items: type: string allow_decline: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::ALLOW_DECLINE' type: boolean default: false ccs: description: '_t__Sub::CC::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::TEMPLATE' type: array items: $ref: '#/components/schemas/SubCustomField' file: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::FILE' type: array items: type: string format: binary file_url: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::FILE_URL' type: array items: type: string message: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signers: description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' subject: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TITLE' type: string maxLength: 255 populate_auto_fill_fields: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false x-beta: closed type: object SignatureRequestRemindRequest: required: - email_address properties: email_address: description: '_t__SignatureRequestRemind::EMAIL_ADDRESS' type: string format: email name: description: '_t__SignatureRequestRemind::NAME' type: string type: object SignatureRequestSendRequest: required: - signers properties: file: description: '_t__SignatureRequestSend::FILE' type: array items: type: string format: binary file_url: description: '_t__SignatureRequestSend::FILE_URL' type: array items: type: string allow_decline: description: '_t__SignatureRequestSend::ALLOW_DECLINE' type: boolean default: false allow_reassign: description: '_t__SignatureRequestSend::ALLOW_REASSIGN' type: boolean default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: '_t__SignatureRequestSend::CC_EMAIL_ADDRESSES' type: array items: type: string format: email client_id: description: '_t__SignatureRequestSend::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: description: '_t__Sub::FormFieldGroup::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: '_t__Sub::FormFieldRule::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: '_t__SignatureRequestSend::HIDE_TEXT_TAGS' type: boolean default: false is_qualified_signature: description: '_t__SignatureRequestSend::IS_QUALIFIED_SIGNATURE' type: boolean default: false message: description: '_t__SignatureRequestSend::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signers: description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: '_t__SignatureRequestSend::SIGNING_REDIRECT_URL' type: string subject: description: '_t__SignatureRequestSend::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestSend::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestSend::TITLE' type: string maxLength: 255 use_text_tags: description: '_t__SignatureRequestSend::USE_PREEXISTING_FIELDS' type: boolean default: false type: object SignatureRequestSendWithTemplateRequest: description: '' required: - signers - template_ids properties: template_ids: description: '_t__SignatureRequestSendWithTemplate::TEMPLATE_IDS' type: array items: type: string allow_decline: description: '_t__SignatureRequestSendWithTemplate::ALLOW_DECLINE' type: boolean default: false ccs: description: '_t__Sub::CC::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: '_t__SignatureRequestSendWithTemplate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::TEMPLATE' type: array items: $ref: '#/components/schemas/SubCustomField' file: description: '_t__SignatureRequestSendWithTemplate::FILE' type: array items: type: string format: binary file_url: description: '_t__SignatureRequestSendWithTemplate::FILE_URL' type: array items: type: string is_qualified_signature: description: '_t__SignatureRequestSendWithTemplate::IS_QUALIFIED_SIGNATURE' type: boolean default: false message: description: '_t__SignatureRequestSendWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } signers: description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: '_t__SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL' type: string subject: description: '_t__SignatureRequestSendWithTemplate::SUBJECT' type: string maxLength: 255 test_mode: description: '_t__SignatureRequestSendWithTemplate::TEST_MODE' type: boolean default: false title: description: '_t__SignatureRequestSendWithTemplate::TITLE' type: string maxLength: 255 type: object SignatureRequestUpdateRequest: required: - signature_id properties: email_address: description: '_t__SignatureRequestUpdate::EMAIL_ADDRESS' type: string format: email name: description: '_t__SignatureRequestUpdate::NAME' type: string signature_id: description: '_t__SignatureRequestUpdate::SIGNATURE_ID' type: string type: object SubAttachment: required: - name - signer_index properties: instructions: description: '_t__Sub::Attachment::INSTRUCTIONS' type: string name: description: '_t__Sub::Attachment::NAME' type: string required: description: '_t__Sub::Attachment::REQUIRED' type: boolean default: false signer_index: description: '_t__Sub::Attachment::SIGNER_INDEX' type: integer type: object SubBulkSignerList: properties: custom_fields: description: '_t__Sub::BulkCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubBulkSignerListCustomField' signers: description: '_t__Sub::BulkSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' type: object SubBulkSignerListCustomField: required: - name - value properties: name: description: '_t__Sub::BulkCustomField::NAME' type: string value: description: '_t__Sub::BulkCustomField::VALUE' type: string type: object SubCC: required: - role - email_address properties: role: description: '_t__Sub::CC::ROLE' type: string email_address: description: '_t__Sub::CC::EMAIL_ADDRESS' type: string format: email type: object SubCustomField: description: '_t__Sub::CustomField::DESCRIPTION' required: - name properties: editor: description: '_t__Sub::CustomField::EDITOR' type: string name: description: '_t__Sub::CustomField::NAME' type: string required: description: '_t__Sub::CustomField::REQUIRED' type: boolean default: false value: description: '_t__Sub::CustomField::VALUE' type: string type: object SubEditorOptions: description: '_t__Sub::EditorOptions::DESCRIPTION' properties: allow_edit_signers: description: '_t__Sub::EditorOptions::ALLOW_EDIT_SIGNERS' type: boolean default: false allow_edit_documents: description: '_t__Sub::EditorOptions::ALLOW_EDIT_DOCUMENTS' type: boolean default: false type: object SubFieldOptions: description: '_t__Sub::FieldOptions::DESCRIPTION' required: - date_format properties: date_format: description: '_t__Sub::FieldOptions::DATE_FORMAT' type: string enum: - 'MM / DD / YYYY' - 'MM - DD - YYYY' - 'DD / MM / YYYY' - 'DD - MM - YYYY' - 'YYYY / MM / DD' - 'YYYY - MM - DD' x-enum-varnames: - MMDDYYYY - MM_DD_YYYY - DDMMYYYY - DD_MM_YYYY - YYYYMMDD - YYYY_MM_DD type: object SubFormFieldGroup: required: - group_id - group_label - requirement properties: group_id: description: '_t__Sub::FormFieldGroup::GROUP_ID_LABEL' type: string group_label: description: '_t__Sub::FormFieldGroup::GROUP_LABEL' type: string requirement: description: '_t__Sub::FormFieldGroup::REQUIREMENT' type: string type: object SubFormFieldRule: required: - id - trigger_operator - triggers - actions properties: id: description: '_t__Sub::FormFieldRule::ID' type: string trigger_operator: description: '_t__Sub::FormFieldRule::TRIGGER_OPERATOR' type: string default: AND triggers: description: '_t__Sub::FormFieldRuleTrigger::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRuleTrigger' maxItems: 1 minItems: 1 actions: description: '_t__Sub::FormFieldRuleAction::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRuleAction' minItems: 1 type: object SubFormFieldRuleAction: required: - hidden - type properties: field_id: description: '_t__Sub::FormFieldRuleAction::FIELD_ID' type: string group_id: description: '_t__Sub::FormFieldRuleAction::GROUP_ID' type: string hidden: description: '_t__Sub::FormFieldRuleAction::HIDDEN' type: boolean type: type: string enum: - change-field-visibility - change-group-visibility type: object SubFormFieldRuleTrigger: required: - id - operator properties: id: description: '_t__Sub::FormFieldRuleTrigger::ID' type: string operator: description: '_t__Sub::FormFieldRuleTrigger::OPERATOR' type: string enum: - any - is - match - none - not value: description: '_t__Sub::FormFieldRuleTrigger::VALUE_SINGLE' type: string values: description: '_t__Sub::FormFieldRuleTrigger::VALUE_MULTI' type: array items: type: string type: object SubFormFieldsPerDocumentBase: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' required: - document_index - api_id - type - required - signer - width - height - x - 'y' properties: document_index: description: '_t__Sub::FormFieldsPerDocument::DOCUMENT_INDEX' type: integer api_id: description: '_t__Sub::FormFieldsPerDocument::API_ID' type: string height: description: '_t__Sub::FormFieldsPerDocument::HEIGHT' type: integer name: description: '_t__Sub::FormFieldsPerDocument::NAME' type: string page: nullable: true description: '_t__Sub::FormFieldsPerDocument::PAGE' type: integer required: description: '_t__Sub::FormFieldsPerDocument::REQUIRED' type: boolean signer: description: '_t__Sub::FormFieldsPerDocument::SIGNER' type: string type: type: string width: description: '_t__Sub::FormFieldsPerDocument::WIDTH' type: integer x: description: '_t__Sub::FormFieldsPerDocument::X' type: integer 'y': description: '_t__Sub::FormFieldsPerDocument::Y' type: integer type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SubFormFieldsPerDocumentText' dropdown: '#/components/schemas/SubFormFieldsPerDocumentDropdown' hyperlink: '#/components/schemas/SubFormFieldsPerDocumentHyperlink' checkbox: '#/components/schemas/SubFormFieldsPerDocumentCheckbox' radio: '#/components/schemas/SubFormFieldsPerDocumentRadio' signature: '#/components/schemas/SubFormFieldsPerDocumentSignature' date_signed: '#/components/schemas/SubFormFieldsPerDocumentDateSigned' initials: '#/components/schemas/SubFormFieldsPerDocumentInitials' text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge' checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge' x-internal: true x-base-class: true SubMergeField: required: - name - type properties: name: description: '_t__Sub::MergeField::NAME' type: string type: description: '_t__Sub::MergeField::TYPE' type: string enum: - text - checkbox x-enumDescriptions: text: '_t__Sub::MergeField::EnumDescriptions::TEXT' checkbox: '_t__Sub::MergeField::EnumDescriptions::CHECKBOX' type: object SubOAuth: description: '_t__Sub::OAuth::DESCRIPTION' properties: callback_url: description: '_t__Sub::OAuth::CALLBACK_URL' type: string scopes: description: '_t__Sub::OAuth::SCOPES' type: array items: type: string enum: - request_signature - basic_account_info - account_access - signature_request_access - template_access - team_access - api_app_access - '' type: object SubOptions: description: '_t__Sub::Options::DESCRIPTION' properties: can_insert_everywhere: description: '_t__Sub::Options::CAN_INSERT_EVERYWHERE' type: boolean default: false type: object SubSignatureRequestSigner: required: - name - email_address properties: name: description: '_t__Sub::SignatureRequestSigner::SIGNER_NAME' type: string email_address: description: '_t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS' type: string format: email order: nullable: true description: '_t__Sub::SignatureRequestSigner::SIGNER_ORDER' type: integer pin: description: '_t__Sub::SignatureRequestSigner::SIGNER_PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER' type: string sms_phone_number_type: description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication - delivery x-beta: closed type: object SubSignatureRequestTemplateSigner: required: - role - name - email_address properties: role: description: '_t__Sub::SignatureRequestTemplateSigner::ROLE' type: string name: description: '_t__Sub::SignatureRequestTemplateSigner::NAME' type: string email_address: description: '_t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS' type: string format: email pin: description: '_t__Sub::SignatureRequestTemplateSigner::PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: description: '_t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER' type: string sms_phone_number_type: description: '_t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication - delivery x-beta: closed type: object SubUnclaimedDraftSigner: required: - name - email_address properties: email_address: description: '_t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS' type: string format: email name: description: '_t__Sub::UnclaimedDraftSigner::NAME' type: string order: nullable: true description: '_t__Sub::UnclaimedDraftSigner::ORDER' type: integer type: object SubUnclaimedDraftTemplateSigner: required: - role - name - email_address properties: role: description: '_t__Sub::UnclaimedDraftTemplateSigner::ROLE' type: string name: description: '_t__Sub::UnclaimedDraftTemplateSigner::NAME' type: string email_address: description: '_t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS' type: string format: email type: object SubTemplateRole: properties: name: description: '_t__Sub::SignerRole::NAME' type: string order: nullable: true description: '_t__Sub::SignerRole::ORDER' type: integer type: object SubSigningOptions: description: '_t__Sub::SigningOptions::DESCRIPTION' required: - default_type properties: default_type: description: '_t__Sub::SigningOptions::DEFAULT' type: string enum: - draw - phone - type - upload draw: description: '_t__Sub::SigningOptions::DRAW' type: boolean default: false phone: description: '_t__Sub::SigningOptions::PHONE' type: boolean default: false type: description: '_t__Sub::SigningOptions::TYPE' type: boolean default: false upload: description: '_t__Sub::SigningOptions::UPLOAD' type: boolean default: false type: object SubWhiteLabelingOptions: description: '_t__Sub::WhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string default: '#1A1A1A' legal_version: type: string default: terms1 enum: - terms1 - terms2 link_color: type: string default: '#00B3E6' page_background_color: type: string default: '#F7F8F9' primary_button_color: type: string default: '#00B3E6' primary_button_color_hover: type: string default: '#00B3E6' primary_button_text_color: type: string default: '#FFFFFF' primary_button_text_color_hover: type: string default: '#FFFFFF' secondary_button_color: type: string default: '#FFFFFF' secondary_button_color_hover: type: string default: '#FFFFFF' secondary_button_text_color: type: string default: '#00B3E6' secondary_button_text_color_hover: type: string default: '#00B3E6' text_color1: type: string default: '#808080' text_color2: type: string default: '#FFFFFF' reset_to_default: description: '_t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT' type: boolean type: object TeamAddMemberRequest: properties: account_id: description: '_t__TeamAddMember::ACCOUNT_ID' type: string email_address: description: '_t__TeamAddMember::EMAIL_ADDRESS' type: string format: email role: description: '_t__TeamAddMember::ROLE' type: string enum: - Member - Developer - 'Team Manager' - Admin x-beta: closed type: object TeamCreateRequest: properties: name: description: '_t__TeamCreate::NAME' type: string default: 'Untitled Team' type: object TeamRemoveMemberRequest: properties: account_id: description: '_t__TeamRemoveMember::ACCOUNT_ID' type: string email_address: description: '_t__TeamRemoveMember::EMAIL_ADDRESS' type: string format: email new_owner_email_address: description: '_t__TeamRemoveMember::NEW_OWNER_EMAIL_ADDRESS' type: string format: email new_team_id: description: '_t__TeamRemoveMember::NEW_TEAM_ID' type: string x-beta: closed new_role: description: '_t__TeamRemoveMember::NEW_ROLE' type: string enum: - Member - Developer - 'Team Manager' - Admin x-beta: closed type: object TeamUpdateRequest: properties: name: description: '_t__TeamUpdate::NAME' type: string type: object TemplateAddUserRequest: properties: account_id: description: '_t__TemplateAddUser::ACCOUNT_ID' type: string email_address: description: '_t__TemplateAddUser::EMAIL_ADDRESS' type: string format: email skip_notification: description: '_t__TemplateAddUser::SKIP_NOTIFICATION' type: boolean default: false type: object TemplateCreateEmbeddedDraftRequest: required: - client_id properties: file: description: '_t__TemplateCreateEmbeddedDraft::FILE' type: array items: type: string format: binary file_url: description: '_t__TemplateCreateEmbeddedDraft::FILE_URL' type: array items: type: string allow_ccs: description: '_t__TemplateCreateEmbeddedDraft::ALLOW_CCS' type: boolean default: true allow_reassign: description: '_t__TemplateCreateEmbeddedDraft::ALLOW_REASSIGN' type: boolean default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' cc_roles: description: '_t__TemplateCreateEmbeddedDraft::CC_ROLES' type: array items: type: string client_id: description: '_t__TemplateCreateEmbeddedDraft::CLIENT_ID' type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' force_signer_roles: description: '_t__TemplateCreateEmbeddedDraft::FORCE_SIGNER_ROLES' type: boolean default: false force_subject_message: description: '_t__TemplateCreateEmbeddedDraft::FORCE_SUBJECT_MESSAGE' type: boolean default: false form_field_groups: description: '_t__Sub::FormFieldGroup::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: '_t__Sub::FormFieldRule::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' merge_fields: description: '_t__TemplateCreateEmbeddedDraft::MERGE_FIELDS' type: array items: $ref: '#/components/schemas/SubMergeField' message: description: '_t__TemplateCreateEmbeddedDraft::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } show_preview: description: '_t__TemplateCreateEmbeddedDraft::SHOW_PREVIEW' type: boolean default: false show_progress_stepper: description: '_t__TemplateCreateEmbeddedDraft::SHOW_PROGRESS_STEPPER' type: boolean default: true signer_roles: description: '_t__TemplateCreateEmbeddedDraft::SIGNER_ROLES' type: array items: $ref: '#/components/schemas/SubTemplateRole' skip_me_now: description: '_t__TemplateCreateEmbeddedDraft::SKIP_ME_NOW' type: boolean default: false subject: description: '_t__TemplateCreateEmbeddedDraft::SUBJECT' type: string maxLength: 200 test_mode: description: '_t__TemplateCreateEmbeddedDraft::TEST_MODE' type: boolean default: false title: description: '_t__TemplateCreateEmbeddedDraft::TITLE' type: string use_preexisting_fields: description: '_t__TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS' type: boolean default: false type: object TemplateRemoveUserRequest: properties: account_id: description: '_t__TemplateRemoveUser::ACCOUNT_ID' type: string email_address: description: '_t__TemplateRemoveUser::EMAIL_ADDRESS' type: string format: email type: object TemplateUpdateFilesRequest: properties: client_id: description: '_t__TemplateUpdateFiles::CLIENT_ID' type: string file: description: '_t__TemplateUpdateFiles::FILE' type: array items: type: string format: binary file_url: description: '_t__TemplateUpdateFiles::FILE_URL' type: array items: type: string message: description: '_t__TemplateUpdateFiles::MESSAGE' type: string maxLength: 5000 subject: description: '_t__TemplateUpdateFiles::SUBJECT' type: string maxLength: 100 test_mode: description: '_t__TemplateUpdateFiles::TEST_MODE' type: boolean default: false type: object UnclaimedDraftCreateRequest: description: '' required: - type properties: file: description: '_t__UnclaimedDraftCreate::FILE' type: array items: type: string format: binary file_url: description: '_t__UnclaimedDraftCreate::FILE_URL' type: array items: type: string allow_decline: description: '_t__UnclaimedDraftCreate::ALLOW_DECLINE' type: boolean default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: '_t__UnclaimedDraftCreate::CC_EMAIL_ADDRESSES' type: array items: type: string format: email client_id: description: '_t__UnclaimedDraftCreate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: description: '_t__Sub::FormFieldGroup::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: '_t__Sub::FormFieldRule::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: '_t__UnclaimedDraftCreate::HIDE_TEXT_TAGS' type: boolean default: false message: description: '_t__UnclaimedDraftCreate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } show_progress_stepper: description: '_t__UnclaimedDraftCreate::SHOW_PROGRESS_STEPPER' type: boolean default: true signers: description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: '_t__UnclaimedDraftCreate::SIGNING_REDIRECT_URL' type: string subject: description: '_t__UnclaimedDraftCreate::SUBJECT' type: string maxLength: 200 test_mode: description: '_t__UnclaimedDraftCreate::TEST_MODE' type: boolean default: false type: description: '_t__UnclaimedDraftCreate::TYPE' type: string enum: - send_document - request_signature use_preexisting_fields: description: '_t__UnclaimedDraftCreate::USE_PREEXISTING_FIELDS' type: boolean default: false use_text_tags: description: '_t__UnclaimedDraftCreate::USE_TEXT_TAGS' type: boolean default: false type: object UnclaimedDraftCreateEmbeddedRequest: description: '' required: - client_id - requester_email_address properties: file: description: '_t__UnclaimedDraftCreateEmbedded::FILE' type: array items: type: string format: binary file_url: description: '_t__UnclaimedDraftCreateEmbedded::FILE_URL' type: array items: type: string allow_ccs: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_CCS' type: boolean default: true allow_decline: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_DECLINE' type: boolean default: false allow_reassign: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_REASSIGN' type: boolean default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: '_t__UnclaimedDraftCreateEmbedded::CC_EMAIL_ADDRESSES' type: array items: type: string format: email client_id: description: '_t__UnclaimedDraftCreateEmbedded::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' force_signer_page: description: '_t__UnclaimedDraftCreateEmbedded::FORCE_SIGNER_PAGE' type: boolean default: false force_subject_message: description: '_t__UnclaimedDraftCreateEmbedded::FORCE_SUBJECT_MESSAGE' type: boolean default: false form_field_groups: description: '_t__Sub::FormFieldGroup::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: '_t__Sub::FormFieldRule::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: '_t__UnclaimedDraftCreateEmbedded::HIDE_TEXT_TAGS' type: boolean default: false hold_request: description: '_t__UnclaimedDraftCreateEmbedded::HOLD_REQUEST' type: boolean default: false is_for_embedded_signing: description: '_t__UnclaimedDraftCreateEmbedded::IS_FOR_EMBEDDED_SIGNING' type: boolean default: false message: description: '_t__UnclaimedDraftCreateEmbedded::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } requester_email_address: description: '_t__UnclaimedDraftCreateEmbedded::REQUESTER_EMAIL_ADDRESS' type: string format: email requesting_redirect_url: description: '_t__UnclaimedDraftCreateEmbedded::REQUESTING_REDIRECT_URL' type: string show_preview: description: '_t__UnclaimedDraftCreateEmbedded::SHOW_PREVIEW' type: boolean show_progress_stepper: description: '_t__UnclaimedDraftCreateEmbedded::SHOW_PROGRESS_STEPPER' type: boolean default: true signers: description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: '_t__UnclaimedDraftCreateEmbedded::SIGNING_REDIRECT_URL' type: string skip_me_now: description: '_t__UnclaimedDraftCreateEmbedded::SKIP_ME_NOW' type: boolean default: false subject: description: '_t__UnclaimedDraftCreateEmbedded::SUBJECT' type: string maxLength: 200 test_mode: description: '_t__UnclaimedDraftCreateEmbedded::TEST_MODE' type: boolean default: false type: description: '_t__UnclaimedDraftCreateEmbedded::TYPE' type: string default: request_signature enum: - send_document - request_signature use_preexisting_fields: description: '_t__UnclaimedDraftCreateEmbedded::USE_PREEXISTING_FIELDS' type: boolean default: false use_text_tags: description: '_t__UnclaimedDraftCreateEmbedded::USE_TEXT_TAGS' type: boolean default: false populate_auto_fill_fields: description: '_t__UnclaimedDraftCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false x-beta: closed type: object UnclaimedDraftCreateEmbeddedWithTemplateRequest: required: - client_id - requester_email_address - template_ids properties: allow_decline: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_DECLINE' type: boolean default: false allow_reassign: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_REASSIGN' type: boolean default: false ccs: description: '_t__Sub::CC::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::TEMPLATE' type: array items: $ref: '#/components/schemas/SubCustomField' editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' file: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::FILE' type: array items: type: string format: binary file_url: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::FILE_URL' type: array items: type: string force_signer_roles: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SIGNER_ROLES' type: boolean default: false force_subject_message: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SUBJECT_MESSAGE' type: boolean default: false hold_request: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::HOLD_REQUEST' type: boolean default: false is_for_embedded_signing: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::IS_FOR_EMBEDDED_SIGNING' type: boolean default: false message: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: { } preview_only: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::PREVIEW_ONLY' type: boolean default: false requester_email_address: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTER_EMAIL_ADDRESS' type: string format: email requesting_redirect_url: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTING_REDIRECT_URL' type: string show_preview: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PREVIEW' type: boolean default: false show_progress_stepper: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PROGRESS_STEPPER' type: boolean default: true signers: description: '_t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL' type: string skip_me_now: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SKIP_ME_NOW' type: boolean default: false subject: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SUBJECT' type: string maxLength: 255 template_ids: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::TEMPLATE_IDS' type: array items: type: string test_mode: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::TEST_MODE' type: boolean default: false title: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::TITLE' type: string maxLength: 255 populate_auto_fill_fields: description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false x-beta: closed type: object UnclaimedDraftEditAndResendRequest: required: - client_id properties: client_id: description: '_t__UnclaimedDraftEditAndResend::CLIENT_ID' type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' is_for_embedded_signing: description: '_t__UnclaimedDraftEditAndResend::IS_FOR_EMBEDDED_SIGNING' type: boolean requester_email_address: description: '_t__UnclaimedDraftEditAndResend::REQUESTER_EMAIL_ADDRESS' type: string format: email requesting_redirect_url: description: '_t__UnclaimedDraftEditAndResend::REQUESTING_REDIRECT_URL' type: string show_progress_stepper: description: '_t__UnclaimedDraftEditAndResend::SHOW_PROGRESS_STEPPER' type: boolean default: true signing_redirect_url: description: '_t__UnclaimedDraftEditAndResend::SIGNING_REDIRECT_URL' type: string test_mode: description: '_t__UnclaimedDraftEditAndResend::TEST_MODE' type: boolean default: false type: object AccountResponse: properties: account_id: description: '_t__Account::ACCOUNT_ID' type: string email_address: description: '_t__Account::EMAIL_ADDRESS' type: string is_locked: description: '_t__Account::IS_LOCKED' type: boolean is_paid_hs: description: '_t__Account::IS_PAID_HS' type: boolean is_paid_hf: description: '_t__Account::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/AccountResponseQuotas' callback_url: nullable: true description: '_t__Account::CALLBACK_URL' type: string role_code: nullable: true description: '_t__Account::ROLE_CODE' type: string locale: nullable: true description: '_t__Account::LOCALE' type: string type: object x-internal: true AccountCreateResponse: properties: account: $ref: '#/components/schemas/AccountResponse' oauth_data: $ref: '#/components/schemas/OAuthTokenResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountGetResponse: properties: account: $ref: '#/components/schemas/AccountResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountVerifyResponse: properties: account: $ref: '#/components/schemas/AccountVerifyResponseAccount' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountVerifyResponseAccount: properties: email_address: description: '_t__Account::EMAIL_ADDRESS' type: string type: object x-internal: true AccountResponseQuotas: description: '_t__Account::QUOTA' properties: api_signature_requests_left: nullable: true description: '_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer documents_left: nullable: true description: '_t__AccountQuota::DOCUMENTS_LEFT' type: integer templates_left: nullable: true description: '_t__AccountQuota::TEMPLATES_LEFT' type: integer sms_verifications_left: nullable: true description: '_t__AccountQuota::SMS_VERIFICATIONS_LEFT' type: integer type: object x-internal: true ApiAppResponse: description: '_t__ApiAppResponse::DESCRIPTION' properties: callback_url: nullable: true description: '_t__ApiAppResponse::CALLBACK_URL' type: string client_id: description: '_t__ApiAppResponse::CLIENT_ID' type: string created_at: description: '_t__ApiAppResponse::CREATED_AT' type: integer domains: description: '_t__ApiAppResponse::DOMAINS' type: array items: type: string name: description: '_t__ApiAppResponse::NAME' type: string is_approved: description: '_t__ApiAppResponse::IS_APPROVED' type: boolean oauth: $ref: '#/components/schemas/ApiAppResponseOAuth' options: $ref: '#/components/schemas/ApiAppResponseOptions' owner_account: $ref: '#/components/schemas/ApiAppResponseOwnerAccount' white_labeling_options: $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions' type: object x-internal: true ApiAppGetResponse: properties: api_app: $ref: '#/components/schemas/ApiAppResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true ApiAppListResponse: properties: api_apps: description: '_t__ApiAppListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/ApiAppResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true ApiAppResponseOAuth: description: '_t__ApiAppResponseOAuth::DESCRIPTION' properties: callback_url: description: '_t__ApiAppResponseOAuth::CALLBACK_URL' type: string secret: description: '_t__ApiAppResponseOAuth::SECRET' type: string scopes: description: '_t__ApiAppResponseOAuth::SCOPES' type: array items: type: string charges_users: description: '_t__ApiAppResponseOAuth::CHARGES_USERS' type: boolean type: object nullable: true x-internal: true ApiAppResponseOptions: description: '_t__ApiAppResponseOptions::DESCRIPTION' properties: can_insert_everywhere: description: '_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE' type: boolean type: object nullable: true x-internal: true ApiAppResponseOwnerAccount: description: '_t__ApiAppResponseOwnerAccount::DESCRIPTION' properties: account_id: description: '_t__ApiAppResponseOwnerAccount::ACCOUNT_ID' type: string email_address: description: '_t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS' type: string type: object x-internal: true ApiAppResponseWhiteLabelingOptions: description: '_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string legal_version: type: string link_color: type: string page_background_color: type: string primary_button_color: type: string primary_button_color_hover: type: string primary_button_text_color: type: string primary_button_text_color_hover: type: string secondary_button_color: type: string secondary_button_color_hover: type: string secondary_button_text_color: type: string secondary_button_text_color_hover: type: string text_color1: type: string text_color2: type: string type: object x-internal: true BulkSendJobResponse: description: '_t__BulkSendJobResponse::DESCRIPTION' properties: bulk_send_job_id: nullable: true description: '_t__BulkSendJobResponse::BULK_SEND_JOB_ID' type: string total: description: '_t__BulkSendJobResponse::TOTAL' type: integer is_creator: description: '_t__BulkSendJobResponse::IS_CREATOR' type: boolean created_at: description: '_t__BulkSendJobResponse::CREATED_AT' type: integer type: object x-internal: true BulkSendJobGetResponse: properties: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' signature_requests: description: '_t__BulkSendJobGetResponse::SIGNATURE_REQUESTS' type: array items: $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true BulkSendJobGetResponseSignatureRequests: title: BulkSendJobGetResponseSignatureRequests type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponse' - properties: bulk_send_job_id: description: '_t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID' type: string x-internal: true BulkSendJobListResponse: properties: bulk_send_jobs: description: '_t__BulkSendJobListResponse::BULK_SEND_JOBS' type: array items: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true BulkSendJobSendResponse: properties: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EmbeddedEditUrlResponse: properties: embedded: $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EmbeddedEditUrlResponseEmbedded: description: '_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION' properties: edit_url: description: '_t__EmbeddedEditUrlResponseEmbedded::EDIT_URL' type: string expires_at: description: '_t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal: true EmbeddedSignUrlResponse: properties: embedded: $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EmbeddedSignUrlResponseEmbedded: description: '_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION' properties: sign_url: description: '_t__EmbeddedSignUrlResponseEmbedded::SIGN_URL' type: string expires_at: description: '_t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal: true ErrorResponse: required: - error properties: error: $ref: '#/components/schemas/ErrorResponseError' type: object ErrorResponseError: description: '_t__ErrorResponseError::DESCRIPTION' required: - error_msg - error_name properties: error_msg: description: '_t__ErrorResponseError::ERROR_MSG' type: string error_path: description: '_t__ErrorResponseError::ERROR_PATH' type: string error_name: description: '_t__ErrorResponseError::ERROR_NAME' type: string type: object EventCallbackAccountRequest: required: - json properties: json: $ref: '#/components/schemas/EventCallbackAccountRequestPayload' type: object EventCallbackAccountRequestPayload: title: EventCallbackAccountRequestPayload required: - event properties: event: $ref: '#/components/schemas/EventCallbackRequestEvent' signature_request: $ref: '#/components/schemas/SignatureRequestResponse' template: $ref: '#/components/schemas/TemplateResponse' type: object EventCallbackApiAppRequest: required: - json properties: json: $ref: '#/components/schemas/EventCallbackApiAppRequestPayload' type: object EventCallbackApiAppRequestPayload: title: EventCallbackApiAppRequestPayload required: - event properties: event: $ref: '#/components/schemas/EventCallbackRequestEvent' account: $ref: '#/components/schemas/AccountResponse' signature_request: $ref: '#/components/schemas/SignatureRequestResponse' template: $ref: '#/components/schemas/TemplateResponse' type: object EventCallbackRequestEvent: description: '_t__EventCallbackRequestEvent::DESCRIPTION' required: - event_time - event_type - event_hash - event_metadata properties: event_time: description: '_t__EventCallbackRequestEvent::EVENT_TIME' type: string event_type: description: '_t__EventCallbackRequestEvent::EVENT_TYPE' type: string enum: - account_confirmed - unknown_error - file_error - sign_url_invalid - signature_request_viewed - signature_request_signed - signature_request_sent - signature_request_all_signed - signature_request_email_bounce - signature_request_remind - signature_request_incomplete_qes - signature_request_destroyed - signature_request_canceled - signature_request_downloadable - signature_request_declined - signature_request_reassigned - signature_request_invalid - signature_request_prepared - template_created - template_error event_hash: description: '_t__EventCallbackRequestEvent::EVENT_HASH' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object EventCallbackRequestEventMetadata: description: '_t__EventCallbackRequestEventMetadata::DESCRIPTION' properties: related_signature_id: nullable: true description: '_t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID' type: string reported_for_account_id: nullable: true description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID' type: string reported_for_app_id: nullable: true description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID' type: string event_message: nullable: true description: '_t__EventCallbackRequestEventMetadata::EVENT_MESSAGE' type: string type: object FileResponse: properties: file_url: description: '_t__FileResponse::FILE_URL' type: string expires_at: description: '_t__FileResponse::EXPIRES_AT' type: integer type: object x-internal: true ListInfoResponse: description: '_t__ListInfoResponse::DESCRIPTION' properties: num_pages: description: '_t__ListInfoResponse::NUM_PAGES' type: integer num_results: nullable: true description: '_t__ListInfoResponse::NUM_RESULTS' type: integer page: description: '_t__ListInfoResponse::PAGE' type: integer page_size: description: '_t__ListInfoResponse::PAGE_SIZE' type: integer type: object x-internal: true SignatureRequestResponseDataTypeEnum: type: string enum: - text - checkbox - date_signed - dropdown - initials - radio - signature - text-merge - checkbox-merge SignatureRequestResponseDataValueText: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::TEXT_TYPE' type: string default: text value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueDropdown: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::DROPDOWN_TYPE' type: string default: dropdown value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueRadio: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::RADIO_TYPE' type: string default: radio value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueDateSigned: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::DATESIGNED_TYPE' type: string default: date_signed value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueInitials: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::INITIAL_TYPE' type: string default: initials value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueCheckbox: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::CHECKBOX_TYPE' type: string default: checkbox value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueSignature: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::SIGNATURE_TYPE' type: string default: signature value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueTextMerge: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE' type: string default: text-merge value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueCheckboxMerge: type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: '_t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE' type: string default: checkbox-merge value: description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object OAuthTokenResponse: properties: access_token: type: string token_type: type: string refresh_token: type: string expires_in: description: '_t__OAuthTokenResponse::EXPIRES_IN' type: integer state: nullable: true type: string type: object x-internal: true ReportResponse: description: '_t__ReportResponse::DESCRIPTION' properties: success: description: '_t__ReportResponse::SUCCESS' type: string start_date: description: '_t__ReportResponse::START_DATE' type: string end_date: description: '_t__ReportResponse::END_DATE' type: string report_type: description: '_t__ReportResponse::REPORT_TYPE' type: array items: enum: - user_activity - document_status type: object x-internal: true ReportCreateResponse: properties: report: $ref: '#/components/schemas/ReportResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true SignatureRequestResponse: description: '_t__SignatureRequestResponse::DESCRIPTION' properties: test_mode: nullable: true description: '_t__SignatureRequestResponse::TEST_MODE' type: boolean default: false signature_request_id: description: '_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID' type: string requester_email_address: description: '_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS' type: string title: description: '_t__SignatureRequestResponse::TITLE' type: string original_title: description: '_t__SignatureRequestResponse::ORIGINAL_TITLE' type: string subject: nullable: true description: '_t__SignatureRequestResponse::SUBJECT' type: string message: nullable: true description: '_t__SignatureRequestResponse::MESSAGE' type: string metadata: description: '_t__SignatureRequestResponse::METADATA' type: object created_at: description: '_t__SignatureRequestResponse::CREATED_AT' type: integer is_complete: description: '_t__SignatureRequestResponse::IS_COMPLETE' type: boolean is_declined: description: '_t__SignatureRequestResponse::IS_DECLINED' type: boolean has_error: description: '_t__SignatureRequestResponse::HAS_ERROR' type: boolean files_url: description: '_t__SignatureRequestResponse::FILES_URL' type: string signing_url: nullable: true description: '_t__SignatureRequestResponse::SIGNING_URL' type: string details_url: description: '_t__SignatureRequestResponse::DETAILS_URL' type: string cc_email_addresses: description: '_t__SignatureRequestResponse::CC_EMAIL_ADDRESSES' type: array items: type: string signing_redirect_url: nullable: true description: '_t__SignatureRequestResponse::SIGNING_REDIRECT_URL' type: string template_ids: nullable: true description: '_t__SignatureRequestResponse::TEMPLATE_IDS' type: array items: type: string custom_fields: nullable: true description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' attachments: nullable: true description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' response_data: nullable: true description: '_t__SignatureRequestResponseData::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseDataBase' signatures: description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseSignatures' type: object x-internal: true SignatureRequestGetResponse: properties: signature_request: $ref: '#/components/schemas/SignatureRequestResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true SignatureRequestListResponse: properties: signature_requests: description: '_t__SignatureRequestListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true SignatureRequestResponseAttachment: description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' required: - id - signer - name - required properties: id: description: '_t__SignatureRequestResponseAttachment::ID' type: string signer: description: '_t__SignatureRequestResponseAttachment::SIGNER' type: string name: description: '_t__SignatureRequestResponseAttachment::NAME' type: string required: description: '_t__SignatureRequestResponseAttachment::REQUIRED' type: boolean instructions: nullable: true description: '_t__SignatureRequestResponseAttachment::INSTRUCTIONS' type: string uploaded_at: nullable: true description: '_t__SignatureRequestResponseAttachment::UPLOADED_AT' type: integer type: object x-internal: true SignatureRequestResponseCustomFieldTypeEnum: type: string enum: - text - checkbox SignatureRequestResponseCustomFieldBase: description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' required: - name - type properties: type: description: '_t__SignatureRequestResponseCustomField::TYPE' type: string name: description: '_t__SignatureRequestResponseCustomField::NAME' type: string required: description: '_t__SignatureRequestResponseCustomField::REQUIRED' type: boolean api_id: description: '_t__SignatureRequestResponseCustomField::API_ID' type: string editor: description: '_t__SignatureRequestResponseCustomField::EDITOR' type: string type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SignatureRequestResponseCustomFieldText' checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox' x-internal: true x-base-class: true SignatureRequestResponseCustomFieldText: description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - required: - type - options properties: type: description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: text value: description: '_t__SignatureRequestResponseCustomField::VALUE_TEXT' type: string type: object SignatureRequestResponseCustomFieldCheckbox: description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - required: - type - options properties: type: description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: checkbox value: description: '_t__SignatureRequestResponseCustomField::VALUE_CHECKBOX' type: boolean type: object SignatureRequestResponseDataBase: description: '_t__SignatureRequestResponseData::DESCRIPTION' properties: api_id: description: '_t__SignatureRequestResponseData::API_ID' type: string signature_id: description: '_t__SignatureRequestResponseData::SIGNATURE_ID' type: string name: description: '_t__SignatureRequestResponseData::NAME' type: string required: description: '_t__SignatureRequestResponseData::REQUIRED' type: boolean type: type: string type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SignatureRequestResponseDataValueText' checkbox: '#/components/schemas/SignatureRequestResponseDataValueCheckbox' dropdown: '#/components/schemas/SignatureRequestResponseDataValueDropdown' radio: '#/components/schemas/SignatureRequestResponseDataValueRadio' signature: '#/components/schemas/SignatureRequestResponseDataValueSignature' date_signed: '#/components/schemas/SignatureRequestResponseDataValueDateSigned' initials: '#/components/schemas/SignatureRequestResponseDataValueInitials' text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge' checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge' x-internal: true x-base-class: true SignatureRequestResponseSignatures: description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' properties: signature_id: description: '_t__SignatureRequestResponseSignatures::SIGNATURE_ID' type: string signer_email_address: description: '_t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS' type: string signer_name: nullable: true description: '_t__SignatureRequestResponseSignatures::SIGNER_NAME' type: string signer_role: nullable: true description: '_t__SignatureRequestResponseSignatures::SIGNER_ROLE' type: string order: nullable: true description: '_t__SignatureRequestResponseSignatures::ORDER' type: integer status_code: description: '_t__SignatureRequestResponseSignatures::STATUS_CODE' type: string decline_reason: nullable: true description: '_t__SignatureRequestResponseSignatures::DECLINE_REASON' type: string signed_at: nullable: true description: '_t__SignatureRequestResponseSignatures::SIGNED_AT' type: integer last_viewed_at: nullable: true description: '_t__SignatureRequestResponseSignatures::LAST_VIEWED_AT' type: integer last_reminded_at: nullable: true description: '_t__SignatureRequestResponseSignatures::LAST_REMINDED_AT' type: integer has_pin: description: '_t__SignatureRequestResponseSignatures::HAS_PIN' type: boolean has_sms_auth: nullable: true description: '_t__SignatureRequestResponseSignatures::HAS_SMS_AUTH' type: boolean has_sms_delivery: nullable: true description: '_t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY' type: boolean sms_phone_number: nullable: true description: '_t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER' type: string reassigned_by: nullable: true description: '_t__SignatureRequestResponseSignatures::REASSIGNED_BY' type: string reassignment_reason: nullable: true description: '_t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON' type: string error: nullable: true description: '_t__SignatureRequestResponseSignatures::ERROR' type: string type: object x-internal: true TeamResponse: description: '_t__TeamResponse::DESCRIPTION' properties: name: description: '_t__Team::NAME' type: string accounts: type: array items: $ref: '#/components/schemas/AccountResponse' invited_accounts: description: '_t__Team::INVITED_ACCOUNTS' type: array items: $ref: '#/components/schemas/AccountResponse' type: object x-internal: true TeamParentResponse: description: '_t__TeamInfo::TEAM_PARENT' properties: team_id: description: '_t__TeamGeneral::TEAM_ID' type: string name: description: '_t__TeamGeneral::NAME' type: string type: object nullable: true x-internal: true TeamInfoResponse: properties: team_id: description: '_t__TeamGeneral::TEAM_ID' type: string team_parent: $ref: '#/components/schemas/TeamParentResponse' name: description: '_t__TeamGeneral::NAME' type: string num_members: description: '_t__TeamGeneral::NUM_MEMBERS' type: integer num_sub_teams: description: '_t__TeamGeneral::NUM_SUB_TEAMS' type: integer type: object x-internal: true TeamGetInfoResponse: properties: team: $ref: '#/components/schemas/TeamInfoResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamMemberResponse: properties: account_id: description: '_t__TeamMemberResponse::ACCOUNT_ID' type: string email_address: description: '_t__TeamMemberResponse::EMAIL_ADDRESS' type: string role: description: '_t__TeamMemberResponse::MEMBER_ROLE' type: string type: object x-internal: true SubTeamResponse: properties: team_id: description: '_t__TeamGeneral::TEAM_ID' type: string name: description: '_t__TeamGeneral::NAME' type: string type: object x-internal: true TeamGetResponse: properties: team: $ref: '#/components/schemas/TeamResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamMembersResponse: properties: team_members: description: '_t__TeamMembersResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/TeamMemberResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamSubTeamsResponse: properties: sub_teams: description: '_t__SubTeamResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubTeamResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateResponse: description: '_t__TemplateResponse::DESCRIPTION' properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' type: string title: description: '_t__TemplateResponse::TITLE' type: string message: description: '_t__TemplateResponse::MESSAGE' type: string updated_at: description: '_t__TemplateResponse::UPDATED_AT' type: integer is_embedded: nullable: true description: '_t__TemplateResponse::IS_EMBEDDED' type: boolean is_creator: nullable: true description: '_t__TemplateResponse::IS_CREATOR' type: boolean can_edit: nullable: true description: '_t__TemplateResponse::CAN_EDIT' type: boolean is_locked: nullable: true description: '_t__TemplateResponse::IS_LOCKED' type: boolean metadata: description: '_t__TemplateResponse::METADATA' type: object signer_roles: description: '_t__TemplateResponse::SIGNER_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseSignerRole' cc_roles: description: '_t__TemplateResponse::CC_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseCCRole' documents: description: '_t__TemplateResponse::DOCUMENTS' type: array items: $ref: '#/components/schemas/TemplateResponseDocument' custom_fields: nullable: true description: '_t__TemplateResponse::CUSTOM_FIELDS' type: array items: $ref: '#/components/schemas/TemplateResponseCustomField' named_form_fields: nullable: true description: '_t__TemplateResponse::NAMED_FORM_FIELDS' type: array items: $ref: '#/components/schemas/TemplateResponseNamedFormField' deprecated: true accounts: nullable: true description: '_t__TemplateResponse::ACCOUNTS' type: array items: $ref: '#/components/schemas/TemplateResponseAccount' type: object x-internal: true TemplateCreateEmbeddedDraftResponse: properties: template: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateCreateEmbeddedDraftResponseTemplate: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' type: string edit_url: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL' type: string expires_at: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT' type: integer warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateUpdateFilesResponse: properties: template: $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate' type: object x-internal: true TemplateUpdateFilesResponseTemplate: description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' type: string warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateGetResponse: properties: template: $ref: '#/components/schemas/TemplateResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateListResponse: properties: templates: description: '_t__TemplateListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateEditResponse: properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' type: string type: object TemplateResponseAccount: properties: account_id: description: '_t__TemplateResponseAccount::ACCOUNT_ID' type: string email_address: description: '_t__TemplateResponseAccount::EMAIL_ADDRESS' type: string is_locked: description: '_t__TemplateResponseAccount::IS_LOCKED' type: boolean is_paid_hs: description: '_t__TemplateResponseAccount::IS_PAID_HS' type: boolean is_paid_hf: description: '_t__TemplateResponseAccount::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/TemplateResponseAccountQuota' type: object x-internal: true TemplateResponseAccountQuota: description: '_t__TemplateResponseAccountQuota::DESCRIPTION' properties: templates_left: description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' type: integer api_signature_requests_left: description: '_t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer documents_left: description: '_t__TemplateResponseAccountQuota::DOCUMENTS_LEFT' type: integer sms_verifications_left: description: '_t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT' type: integer type: object x-internal: true TemplateResponseCCRole: properties: name: description: '_t__TemplateResponseCCRole::TEMPLATES_LEFT' type: string type: object x-internal: true TemplateResponseCustomField: properties: name: description: '_t__TemplateResponseCustomField::NAME' type: string type: description: '_t__TemplateResponseCustomField::TYPE' type: string enum: - text - checkbox x: description: '_t__TemplateResponseCustomField::X' type: integer 'y': description: '_t__TemplateResponseCustomField::Y' type: integer width: description: '_t__TemplateResponseCustomField::WIDTH' type: integer height: description: '_t__TemplateResponseCustomField::HEIGHT' type: integer required: description: '_t__TemplateResponseCustomField::REQUIRED' type: boolean api_id: description: '_t__TemplateResponseCustomField::API_ID' type: string group: nullable: true description: '_t__TemplateResponseCustomField::GROUP' type: string avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: nullable: true description: '_t__TemplateResponseCustomField::IS_MULTILINE' type: boolean originalFontSize: nullable: true description: '_t__TemplateResponseCustomField::ORIGINAL_FONT_SIZE' type: integer fontFamily: nullable: true description: '_t__TemplateResponseCustomField::FONT_FAMILY' type: string type: object x-internal: true TemplateResponseDocument: properties: name: description: '_t__TemplateResponseDocument::NAME' type: string index: description: '_t__TemplateResponseDocument::INDEX' type: integer field_groups: description: '_t__TemplateResponseDocument::FIELD_GROUPS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup' form_fields: description: '_t__TemplateResponseDocument::FORM_FIELDS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormField' custom_fields: description: '_t__TemplateResponseDocument::CUSTOM_FIELDS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomField' static_fields: nullable: true description: '_t__TemplateResponseDocument::STATIC_FIELDS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticField' type: object x-internal: true TemplateResponseDocumentCustomField: properties: name: description: '_t__TemplateResponseDocumentCustomField::NAME' type: string type: description: '_t__TemplateResponseDocumentCustomField::TYPE' type: string enum: - text - checkbox signer: description: '_t__TemplateResponseDocumentCustomField::SIGNER' type: string x: description: '_t__TemplateResponseDocumentCustomField::X' type: integer 'y': description: '_t__TemplateResponseDocumentCustomField::Y' type: integer width: description: '_t__TemplateResponseDocumentCustomField::WIDTH' type: integer height: description: '_t__TemplateResponseDocumentCustomField::HEIGHT' type: integer required: description: '_t__TemplateResponseDocumentCustomField::REQUIRED' type: boolean api_id: description: '_t__TemplateResponseDocumentCustomField::API_ID' type: string group: nullable: true description: '_t__TemplateResponseDocumentCustomField::GROUP' type: string avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: nullable: true description: '_t__TemplateResponseDocumentCustomField::IS_MULTILINE' type: boolean originalFontSize: nullable: true description: '_t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE' type: integer fontFamily: nullable: true description: '_t__TemplateResponseDocumentCustomField::FONT_FAMILY' type: string named_form_fields: nullable: true description: '_t__TemplateResponseDocumentCustomField::NAMED_FORM_FIELDS' type: object deprecated: true reusable_form_id: nullable: true type: string deprecated: true type: object x-internal: true TemplateResponseDocumentFieldGroup: properties: name: description: '_t__TemplateResponseDocumentFieldGroup::NAME' type: string rule: description: '_t__TemplateResponseDocumentFieldGroup::RULE' type: string type: object x-internal: true TemplateResponseDocumentFormField: properties: api_id: description: '_t__TemplateResponseDocumentFormField::API_ID' type: string name: description: '_t__TemplateResponseDocumentFormField::NAME' type: string type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string enum: - checkbox - checkbox-merge - date_signed - dropdown - hyperlink - initials - signature - radio - text - text-merge signer: description: '_t__TemplateResponseDocumentFormField::SIGNER' type: string x: description: '_t__TemplateResponseDocumentFormField::X' type: integer 'y': description: '_t__TemplateResponseDocumentFormField::Y' type: integer width: description: '_t__TemplateResponseDocumentFormField::WIDTH' type: integer height: description: '_t__TemplateResponseDocumentFormField::HEIGHT' type: integer required: description: '_t__TemplateResponseDocumentFormField::REQUIRED' type: boolean group: nullable: true description: '_t__TemplateResponseDocumentFormField::GROUP' type: string avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: nullable: true description: '_t__TemplateResponseDocumentFormField::IS_MULTILINE' type: boolean originalFontSize: nullable: true description: '_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: nullable: true description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string type: object x-internal: true TemplateResponseDocumentStaticField: properties: name: description: '_t__TemplateResponseDocumentStaticField::NAME' type: string type: description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string signer: description: '_t__TemplateResponseDocumentStaticField::SIGNER' type: string x: description: '_t__TemplateResponseDocumentStaticField::X' type: integer 'y': description: '_t__TemplateResponseDocumentStaticField::Y' type: integer width: description: '_t__TemplateResponseDocumentStaticField::WIDTH' type: integer height: description: '_t__TemplateResponseDocumentStaticField::HEIGHT' type: integer required: description: '_t__TemplateResponseDocumentStaticField::REQUIRED' type: boolean api_id: description: '_t__TemplateResponseDocumentStaticField::API_ID' type: string group: nullable: true description: '_t__TemplateResponseDocumentStaticField::GROUP' type: string type: object x-internal: true TemplateResponseFieldAvgTextLength: description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' properties: num_lines: description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' type: integer num_chars_per_line: description: '_t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE' type: integer type: object x-internal: true TemplateResponseNamedFormField: properties: name: description: '_t__TemplateResponseNamedFormField::NAME' type: string type: description: '_t__TemplateResponseNamedFormField::TYPE' type: string signer: description: '_t__TemplateResponseNamedFormField::SIGNER' type: string x: description: '_t__TemplateResponseNamedFormField::X' type: integer 'y': description: '_t__TemplateResponseNamedFormField::Y' type: integer width: description: '_t__TemplateResponseNamedFormField::WIDTH' type: integer height: description: '_t__TemplateResponseNamedFormField::HEIGHT' type: integer required: description: '_t__TemplateResponseNamedFormField::REQUIRED' type: boolean api_id: description: '_t__TemplateResponseNamedFormField::API_ID' type: string group: nullable: true description: '_t__TemplateResponseNamedFormField::GROUP' type: string avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: nullable: true description: '_t__TemplateResponseNamedFormField::IS_MULTILINE' type: boolean originalFontSize: nullable: true description: '_t__TemplateResponseNamedFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: nullable: true description: '_t__TemplateResponseNamedFormField::FONT_FAMILY' type: string type: object x-internal: true TemplateResponseSignerRole: properties: name: description: '_t__TemplateResponseSignerRole::NAME' type: string order: description: '_t__TemplateResponseSignerRole::ORDER' type: integer type: object x-internal: true UnclaimedDraftResponse: description: '_t__UnclaimedDraftResponse::DESCRIPTION' properties: signature_request_id: nullable: true description: '_t__UnclaimedDraft::SIGNATURE_REQUEST_ID' type: string claim_url: description: '_t__UnclaimedDraft::CLAIM_URL' type: string signing_redirect_url: nullable: true description: '_t__UnclaimedDraft::SIGNING_REDIRECT_URL' type: string requesting_redirect_url: nullable: true description: '_t__UnclaimedDraft::REQUESTING_REDIRECT_URL' type: string expires_at: nullable: true description: '_t__UnclaimedDraft::EXPIRES_AT' type: integer test_mode: description: '_t__UnclaimedDraft::TEST_MODE' type: boolean type: object x-internal: true UnclaimedDraftCreateResponse: properties: unclaimed_draft: $ref: '#/components/schemas/UnclaimedDraftResponse' warnings: description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true WarningResponse: description: '_t__WarningResponse::LIST_DESCRIPTION' required: - warning_msg - warning_name properties: warning_msg: description: '_t__WarningResponse::WARNING_MSG' type: string warning_name: description: '_t__WarningResponse::WARNING_NAME' type: string type: object responses: EventCallbackResponse: description: 'successful operation' content: text/plain: schema: type: string default: 'Hello API Event Received' examples: AccountCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountCreateRequestDefaultExample.json AccountCreateRequestOAuthExample: summary: 'OAuth Example' value: $ref: examples/json/AccountCreateRequestOAuthExample.json AccountUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountUpdateRequestDefaultExample.json AccountVerifyRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountVerifyRequestDefaultExample.json ApiAppCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ApiAppCreateRequestDefaultExample.json ApiAppCreateRequestFormDataExample: summary: 'With Custom Logo File Example' value: $ref: examples/json/ApiAppCreateRequestFormDataExample.json ApiAppUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ApiAppUpdateRequestDefaultExample.json ApiAppUpdateRequestFormDataExample: summary: 'With Custom Logo File Example' value: $ref: examples/json/ApiAppUpdateRequestFormDataExample.json EmbeddedEditUrlRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: $ref: examples/json/OAuthTokenGenerateRequestExample.json OAuthTokenRefreshRequestExample: summary: 'OAuth Token Refresh Example' value: $ref: examples/json/OAuthTokenRefreshRequestExample.json ReportCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ReportCreateRequestDefaultExample.json SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample: summary: 'With Signer File Example' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json SignatureRequestBulkSendWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json SignatureRequestBulkSendWithTemplateRequestFormDataExample: summary: 'With Signer File Example' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json SignatureRequestCreateEmbeddedRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json SignatureRequestCreateEmbeddedRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedRequestFormDataExample.json SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample: summary: 'With Signer File Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample.json SignatureRequestRemindRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json SignatureRequestSendRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestSendRequestDefaultExample.json SignatureRequestSendFormDataExample: summary: 'With File Example' value: $ref: examples/json/SignatureRequestSendFormDataExample.json SignatureRequestSendWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json SignatureRequestSendWithTemplateRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/SignatureRequestSendWithTemplateRequestFormDataExample.json SignatureRequestUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json TeamAddMemberRequestEmailAddressExample: summary: 'Email Address Example' value: $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json TeamAddMemberRequestAccountIdExample: summary: 'Account ID Example' value: $ref: examples/json/TeamAddMemberRequestAccountIdExample.json TeamCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TeamCreateRequestDefaultExample.json TeamRemoveMemberRequestEmailAddressExample: summary: 'Email Address Example' value: $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json TeamRemoveMemberRequestAccountIdExample: summary: 'Account ID Example' value: $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json TeamUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TeamUpdateRequestDefaultExample.json TemplateAddUserRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateAddUserRequestDefaultExample.json TemplateCreateEmbeddedDraftRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json TemplateCreateEmbeddedDraftRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormDataExample.json TemplateRemoveUserRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json TemplateUpdateFilesRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json TemplateUpdateFilesRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/TemplateUpdateFilesRequestFormDataExample.json UnclaimedDraftCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json UnclaimedDraftCreateRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json UnclaimedDraftCreateRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json UnclaimedDraftCreateRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormDataExample.json UnclaimedDraftCreateEmbeddedRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json UnclaimedDraftCreateEmbeddedRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormDataExample.json UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample: summary: 'With File Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample.json UnclaimedDraftEditAndResendRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json AccountGetResponseExample: summary: '_t__AccountGetResponseExample::SUMMARY' value: $ref: examples/json/AccountGetResponseExample.json AccountCreateResponseExample: summary: '_t__AccountCreateResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateResponseExample.json AccountCreateOAuthResponseExample: summary: '_t__AccountCreateOAuthResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateOAuthResponseExample.json AccountUpdateResponseExample: summary: '_t__AccountUpdateResponseExample::SUMMARY' value: $ref: examples/json/AccountUpdateResponseExample.json AccountVerifyFoundResponseExample: summary: '_t__AccountVerifyFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyFoundResponseExample.json AccountVerifyNotFoundResponseExample: summary: '_t__AccountVerifyNotFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyNotFoundResponseExample.json ApiAppCreateResponseExample: summary: '_t__ApiAppCreateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppCreateResponseExample.json ApiAppGetResponseExample: summary: '_t__ApiAppGetResponseExample::SUMMARY' value: $ref: examples/json/ApiAppGetResponseExample.json ApiAppListResponseExample: summary: '_t__ApiAppListResponseExample::SUMMARY' value: $ref: examples/json/ApiAppListResponseExample.json ApiAppUpdateResponseExample: summary: '_t__ApiAppUpdateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppUpdateResponseExample.json BulkSendJobGetResponseExample: summary: '_t__BulkSendJobGetResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobGetResponseExample.json BulkSendJobListResponseExample: summary: '_t__BulkSendJobListResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobListResponseExample.json EmbeddedEditUrlResponseExample: summary: '_t__EmbeddedEditUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedEditUrlResponseExample.json EmbeddedSignUrlResponseExample: summary: '_t__EmbeddedSignUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedSignUrlResponseExample.json Error400ResponseExample: summary: '_t__Error::400' value: $ref: examples/json/Error400ResponseExample.json Error401ResponseExample: summary: '_t__Error::401' value: $ref: examples/json/Error401ResponseExample.json Error402ResponseExample: summary: '_t__Error::402' value: $ref: examples/json/Error402ResponseExample.json Error403ResponseExample: summary: '_t__Error::403' value: $ref: examples/json/Error403ResponseExample.json Error404ResponseExample: summary: '_t__Error::404' value: $ref: examples/json/Error404ResponseExample.json Error409ResponseExample: summary: '_t__Error::409' value: $ref: examples/json/Error409ResponseExample.json Error410ResponseExample: summary: '_t__Error::410' value: $ref: examples/json/Error410ResponseExample.json Error422ResponseExample: summary: '_t__Error::422' value: $ref: examples/json/Error422ResponseExample.json Error429ResponseExample: summary: '_t__Error::429' value: $ref: examples/json/Error429ResponseExample.json Error4XXResponseExample: summary: '_t__Error::4XX' value: $ref: examples/json/Error4XXResponseExample.json EventCallbackAccountSignatureRequestSentExample: summary: '_t__EventCallbackAccountSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json EventCallbackAccountTemplateCreatedExample: summary: '_t__EventCallbackAccountTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json EventCallbackApiAppAccountConfirmedExample: summary: '_t__EventCallbackApiAppAccountConfirmedExample::SUMMARY' value: $ref: examples/json/EventCallbackApiAppAccountConfirmedExample.json EventCallbackApiAppSignatureRequestSentExample: summary: '_t__EventCallbackApiAppSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackApiAppSignatureRequestSentExample.json EventCallbackApiAppTemplateCreatedExample: summary: '_t__EventCallbackApiAppTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackApiAppTemplateCreatedExample.json OAuthTokenGenerateResponseExample: summary: '_t__OAuthTokenGenerateResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenGenerateResponseExample.json OAuthTokenRefreshResponseExample: summary: '_t__OAuthTokenRefreshResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenRefreshResponseExample.json ReportCreateResponseExample: summary: '_t__ReportCreateResponseExample::SUMMARY' value: $ref: examples/json/ReportCreateResponseExample.json SignatureRequestCreateEmbeddedResponseExample: summary: '_t__SignatureRequestCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json SignatureRequestCreateEmbeddedWithTemplateResponseExample: summary: '_t__SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json SignatureRequestGetResponseExample: summary: '_t__SignatureRequestGetResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestGetResponseExample.json SignatureRequestFilesResponseExample: summary: '_t__SignatureRequestFilesResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestFilesResponseExample.json SignatureRequestListResponseExample: summary: '_t__SignatureRequestListResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestListResponseExample.json SignatureRequestReleaseHoldResponseExample: summary: '_t__SignatureRequestReleaseHoldResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json SignatureRequestRemindResponseExample: summary: '_t__SignatureRequestRemindResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestRemindResponseExample.json SignatureRequestSendResponseExample: summary: '_t__SignatureRequestSendResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendResponseExample.json SignatureRequestSendWithTemplateResponseExample: summary: '_t__SignatureRequestSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json SignatureRequestUpdateResponseExample: summary: '_t__SignatureRequestUpdateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestUpdateResponseExample.json SignatureRequestBulkSendWithTemplateResponseExample: summary: '_t__SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json TeamAddMemberResponseExample: summary: '_t__TeamAddMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamAddMemberResponseExample.json TeamCreateResponseExample: summary: '_t__TeamCreateResponseExample::SUMMARY' value: $ref: examples/json/TeamCreateResponseExample.json TeamGetResponseExample: summary: '_t__TeamGetResponseExample::SUMMARY' value: $ref: examples/json/TeamGetResponseExample.json TeamGetInfoResponseExample: summary: '_t__TeamInfoResponseExample::SUMMARY' value: $ref: examples/json/TeamGetInfoResponseExample.json TeamMembersResponseExample: summary: '_t__TeamMembersResponseExample::SUMMARY' value: $ref: examples/json/TeamMembersResponseExample.json TeamSubTeamsResponseExample: summary: '_t__TeamSubTeamsResponseExample::SUMMARY' value: $ref: examples/json/TeamSubTeamsResponseExample.json TeamRemoveMemberResponseExample: summary: '_t__TeamRemoveMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamRemoveMemberResponseExample.json TeamUpdateResponseExample: summary: '_t__TeamUpdateResponseExample::SUMMARY' value: $ref: examples/json/TeamUpdateResponseExample.json TeamDoesNotExistResponseExample: summary: '_t__TeamDoesNotExistResponseExample::SUMMARY' value: $ref: examples/json/TeamDoesNotExistResponseExample.json TemplateAddUserResponseExample: summary: '_t__TemplateAddUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateAddUserResponseExample.json TemplateCreateEmbeddedDraftResponseExample: summary: '_t__TemplateCreateEmbeddedDraftResponseExample::SUMMARY' value: $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json TemplateFilesResponseExample: summary: '_t__TemplateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateFilesResponseExample.json TemplateGetResponseExample: summary: '_t__TemplateGetResponseExample::SUMMARY' value: $ref: examples/json/TemplateGetResponseExample.json TemplateListResponseExample: summary: '_t__TemplateListResponseExample::SUMMARY' value: $ref: examples/json/TemplateListResponseExample.json TemplateRemoveUserResponseExample: summary: '_t__TemplateRemoveUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateRemoveUserResponseExample.json TemplateUpdateFilesResponseExample: summary: '_t__TemplateUpdateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateUpdateFilesResponseExample.json UnclaimedDraftCreateResponseExample: summary: '_t__UnclaimedDraftCreateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateResponseExample.json UnclaimedDraftCreateEmbeddedResponseExample: summary: '_t__UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json UnclaimedDraftEditAndResendExample: summary: '_t__UnclaimedDraftEditAndResendExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftEditAndResendExample.json requestBodies: EventCallbackAccountRequest: description: '_t__EventCallbackAccountRequest::DESCRIPTION' content: application/json: schema: $ref: '#/components/schemas/EventCallbackAccountRequest' examples: signature_request_sent_example: $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' multipart/form-data: schema: $ref: '#/components/schemas/EventCallbackAccountRequest' examples: signature_request_example: $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' encoding: json: contentType: application/json EventCallbackApiAppRequest: description: '_t__EventCallbackApiAppRequest::DESCRIPTION' content: application/json: schema: $ref: '#/components/schemas/EventCallbackApiAppRequest' examples: account_confirmed_example: $ref: '#/components/examples/EventCallbackApiAppAccountConfirmedExample' signature_request_sent_example: $ref: '#/components/examples/EventCallbackApiAppSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackApiAppTemplateCreatedExample' multipart/form-data: schema: $ref: '#/components/schemas/EventCallbackApiAppRequest' examples: account_confirmed_example: $ref: '#/components/examples/EventCallbackApiAppAccountConfirmedExample' signature_request_sent_example: $ref: '#/components/examples/EventCallbackApiAppSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackApiAppTemplateCreatedExample' encoding: json: contentType: application/json headers: X-RateLimit-Limit: description: '_t__Common::RateLimiting::LIMIT' schema: type: integer format: int32 example: 100 X-RateLimit-Remaining: description: '_t__Common::RateLimiting::REMAINING' schema: type: integer format: int32 example: 99 X-Ratelimit-Reset: description: '_t__Common::RateLimiting::RESET' schema: type: integer format: int64 example: 1430170900 securitySchemes: api_key: type: http description: '_t__OpenApi::AUTH::API_KEY' scheme: basic oauth2: type: http description: '_t__OpenApi::AUTH::OAUTH' bearerFormat: JWT scheme: bearer security: - api_key: [] oauth2: - account_access - signature_request_access - template_access - team_access - api_app_access - basic_account_info - request_signature tags: - name: Account description: '_md__OpenApi::TAG::ACCOUNT::DESCRIPTION' - name: 'Signature Request' description: '_md__OpenApi::TAG::SIGNATURE_REQUEST::DESCRIPTION' - name: Template description: '_md__OpenApi::TAG::TEMPLATE::DESCRIPTION' - name: 'Bulk Send Job' description: '_md__OpenApi::TAG::BULK_SEND_JOB::DESCRIPTION' - name: Report description: '_md__OpenApi::TAG::REPORT::DESCRIPTION' - name: Team description: '_md__OpenApi::TAG::TEAM::DESCRIPTION' - name: 'Unclaimed Draft' description: '_md__OpenApi::TAG::UNCLAIMED_DRAFT::DESCRIPTION' - name: Embedded description: '_md__OpenApi::TAG::EMBEDDED::DESCRIPTION' - name: 'Api App' description: '_md__OpenApi::TAG::API_APP::DESCRIPTION' - name: OAuth description: '_md__OpenApi::TAG::OAUTH::DESCRIPTION' - name: 'Callbacks and Events' description: '_md__OpenApi::TAG::CALLBACKS_AND_EVENTS::DESCRIPTION' externalDocs: description: 'Legacy API Reference' url: 'https://app.hellosign.com/api/reference' x-webhooks: accountCallback: post: summary: '_t__OpenApi::ACCOUNT_CALLBACK::SUMMARY' operationId: accountUpdateEventCallback description: '_md__OpenApi::ACCOUNT_CALLBACK::DESCRIPTION' x-meta: seo: title: '_t__accountUpdateEventCallback::SEO::TITLE' description: '_t__accountUpdateEventCallback::SEO::DESCRIPTION' tags: - 'Callbacks and Events' requestBody: $ref: '#/components/requestBodies/EventCallbackAccountRequest' responses: '200': $ref: '#/components/responses/EventCallbackResponse' apiAppCallback: post: summary: '_t__OpenApi::APP_CALLBACK::SUMMARY' description: '_md__OpenApi::APP_CALLBACK::DESCRIPTION' operationId: apiAppCreateEventCallback x-meta: seo: title: '_t__apiAppCreateEventCallback::SEO::TITLE' description: '_t__apiAppCreateEventCallback::SEO::DESCRIPTION' tags: - 'Callbacks and Events' requestBody: $ref: '#/components/requestBodies/EventCallbackApiAppRequest' responses: '200': $ref: '#/components/responses/EventCallbackResponse'