openapi: 3.0.3
info:
  title: Docupilot accounts APIs ai esign API
  version: '1.0'
  description: Docupilot accounts APIs
  termsOfService: https://docupilot.app/terms-and-conditions/
  contact:
    name: Team Docupilot
    email: support@docupilot.app
tags:
- name: esign
paths:
  /dashboard/esign/envelope-exports/:
    get:
      operationId: get_created_envelope_export
      summary: Get created envelope export
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvelopeBulkDownloadList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: create_envelope_export_task
      summary: Create envelope export task
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: status
        schema:
          type: string
          enum:
          - completed
          - created
          - declined
          - pending
          - voided
          - waiting_for_me
        description: Status filter
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeBulkDownload'
      security:
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeBulkDownload'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/esign/envelope-exports/{id}/download/:
    get:
      operationId: download_exported_envelopes
      summary: Download generated export envelopes if available
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeExportDownloadResponse'
          description: The response contains file_name and file_url to download the generated export file.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/:
    get:
      operationId: list_envelopes
      summary: Get list of envelopes
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: folder
        schema:
          type: integer
        description: Filter by folder id
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: status
        schema:
          type: array
          items:
            type: string
            enum:
            - completed
            - created
            - declined
            - pending
            - voided
            - waiting_for_me
        description: Filter by status
        explode: false
        style: form
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvelopeList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: create_envelope
      summary: Create a new envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - esign
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateEnvelope'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateEnvelope'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/esign/envelopes/{envelope_id}/documents/{id}/:
    patch:
      operationId: update_envelope_document
      summary: Update envelope document
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: envelope_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate'
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocuments'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{envelope_id}/recipients/:
    get:
      operationId: list_envelope_recipients
      summary: Get list of envelope recipients
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: envelope_id
        schema:
          type: string
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvelopeRecipientList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: create_envelope_recipient
      summary: Create a new envelope recipient
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: envelope_id
        schema:
          type: string
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvelopeRecipient'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateEnvelopeRecipient'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateEnvelopeRecipient'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeRecipient'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{envelope_id}/recipients/{id}/:
    patch:
      operationId: update_envelope_recipient
      summary: Partial update of envelope recipient
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: envelope_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient'
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeRecipient'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
    delete:
      operationId: delete_envelope_recipient
      summary: Delete an envelope recipient
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: envelope_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/:
    patch:
      operationId: update_envelope_config
      summary: Update envelope config
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEnvelopeUpdate'
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
    delete:
      operationId: trash_envelope
      summary: Move envelope to trash
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/attachment/{attachment_id}/download/:
    get:
      operationId: download_attachment
      summary: Download an individual attachment
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: attachment_id
        schema:
          type: string
        required: true
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - octet-stream
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/cancel/:
    post:
      operationId: cancel_envelope
      summary: Cancel an Envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeVoid'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnvelopeVoid'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnvelopeVoid'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/copy/:
    post:
      operationId: copy_envelope
      summary: Copy an envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDetails'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/details/:
    get:
      operationId: envelope_details
      summary: details of an envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDetails'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/documents/{document_id}/download/:
    get:
      operationId: download_envelope_file
      summary: Download envelope file
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: document_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      - in: query
        name: response_type
        schema:
          type: string
          enum:
          - stream
          - url
        description: If stream, returns the document as a downloadable file. If url, returns JSON with file_url and file_name.
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentDownloadResponse'
            application/octet-stream:
              schema:
                type: string
                format: binary
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/documents/{document_id}/preview/:
    get:
      operationId: preview_envelope
      summary: Preview Envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: document_id
        schema:
          type: string
        required: true
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - pdf
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/pdf:
              schema:
                type: string
                format: binary
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
            application/pdf:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
            application/pdf:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
            application/pdf:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
            application/pdf:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/download/:
    get:
      operationId: download_envelope
      summary: Download all envelope documents
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: history
        schema:
          type: boolean
        description: Whether to include history in the response
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/zip:
              schema:
                type: string
                format: binary
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/email_copy/:
    post:
      operationId: send_copy_via_email
      summary: send copy via email
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendEnvelopeViaEmail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SendEnvelopeViaEmail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SendEnvelopeViaEmail'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/history/:
    get:
      operationId: envelope_history
      summary: envelope history
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeHistory'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/permanent_delete/:
    delete:
      operationId: delete_envelope_permanently
      summary: Delete a envelope permanently from trash
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/recipient/{recipient_id}/attachments/download/:
    get:
      operationId: download_recipient_attachments
      summary: Download all attachments of an envelope recipient as a zip file
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - zip
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      - in: path
        name: recipient_id
        schema:
          type: string
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/zip:
              schema:
                type: string
                format: binary
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
            application/zip:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
            application/zip:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
            application/zip:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/responses/:
    get:
      operationId: get_envelope_responses
      summary: Get consolidated field responses for an envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      - in: query
        name: recipient_id
        schema:
          type: string
        description: Filter responses by recipient id
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeResponses'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/restore/:
    post:
      operationId: restore_envelope_from_trash
      summary: Restore a envelope from trash
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/send/:
    post:
      operationId: send_envelope
      summary: Send an Envelope
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnvelopeUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnvelopeUpdate'
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/send_reminder/:
    post:
      operationId: send_reminder
      summary: Send a reminder for Envelope Signers
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/{id}/signing-link/:
    get:
      operationId: get_signing_link
      summary: Get signing link for the envelope (sender self-sign)
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope.
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningLinkResponse'
          description: Signing link for the sender if available. Null otherwise.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/envelopes/bulk-move/:
    post:
      operationId: bulk_move_envelopes
      summary: Bulk move envelopes across folders
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: folder
        schema:
          type: integer
        description: Restrict bulk move to envelopes currently in this folder
      - in: query
        name: status
        schema:
          type: string
          enum:
          - completed
          - created
          - declined
          - pending
          - voided
          - waiting_for_me
        description: Filter envelopes by status when moving all envelopes
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeBulkMove'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnvelopeBulkMove'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnvelopeBulkMove'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '207':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMoveEnvelopesResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/esign/envelopes/count/:
    get:
      operationId: envelope_count_by_status
      summary: Get envelope count grouped by status
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeStatusCountResponse'
          description: Counts of envelopes grouped by status.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
  /dashboard/esign/envelopes/trash/:
    get:
      operationId: list_trashed_envelopes
      summary: List all envelopes in trash
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: page
        schema:
          type: integer
      tags:
      - esign
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvelopeList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/esign/folders/{folder_id}/permissions/:
    get:
      operationId: list_esign_folder_sharing
      summary: Get all shared permissions for specific signature folder
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: folder_id
        schema:
          type: integer
        required: true
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EnvelopeFolderSharing'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: create_esign_folder_sharing_permission
      summary: Create signature folder sharing permission
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: folder_id
        schema:
          type: integer
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/EnvelopeFolderSharing'
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/EnvelopeFolderSharing'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/EnvelopeFolderSharing'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EnvelopeFolderSharing'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/folders/{folder_id}/permissions/{id}/:
    get:
      operationId: get_esign_folder_sharing
      summary: Get specific permission details for given signature folder
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: folder_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope folder sharing setting.
        required: true
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeFolderSharing'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
    patch:
      operationId: update_esign_folder_sharing_permission
      summary: Update signature folder sharing permission partially
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: folder_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope folder sharing setting.
        required: true
      tags:
      - esign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing'
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeFolderSharing'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
    delete:
      operationId: revoke_esign_folder_sharing_permission
      summary: Revoke signature folder sharing permission
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: folder_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this envelope folder sharing setting.
        required: true
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/esign/permissions/folder/:
    get:
      operationId: get_esign_folder_permissions
      summary: Get e-sign folder permissions
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: ids
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - esign
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                      enum:
                      - read
                      - write
                      - manage
                  example:
                    '199':
                    - read
                    - write
                    '1201':
                    - read
                    '90':
                    - write
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    EnvelopeRecipient:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        recipient_id:
          type: string
          readOnly: true
        email_address:
          type: string
          format: email
          maxLength: 254
        subject:
          type: string
          maxLength: 255
        email_body:
          type: string
        name:
          type: string
          maxLength: 255
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        status:
          enum:
          - created
          - failed
          - sent
          - viewed
          - completed
          - declined
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        invited_at:
          type: string
          format: date-time
          nullable: true
        last_reminded_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        workspace:
          type: integer
        envelope:
          type: integer
      required:
      - created_at
      - email_address
      - email_body
      - envelope
      - id
      - name
      - order
      - recipient_id
      - subject
      - updated_at
      - workspace
      description: ''
    EnvelopeVoid:
      type: object
      properties:
        reason:
          type: string
          maxLength: 255
      required:
      - reason
      description: ''
    PaginatedEnvelopeRecipientList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeRecipient'
    EnvelopeFolderSharing:
      type: object
      description: ''
      properties:
        id:
          type: integer
          readOnly: true
        user:
          type: integer
        permission:
          enum:
          - read
          - write
          - manage
          type: string
      required:
      - id
      - user
    CreateEnvelope:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        attachments:
          type: array
          items:
            type: string
            format: binary
          writeOnly: true
          maxItems: 3
        folder:
          type: integer
          nullable: true
      required:
      - attachments
      - name
      description: ''
    EnvelopeDetails:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        documents:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeDocuments'
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeRecipient'
        envelope_id:
          type: string
          readOnly: true
        sn_envelope_id:
          type: string
          nullable: true
          maxLength: 255
        sn_invite_id:
          type: string
          nullable: true
          maxLength: 255
        name:
          type: string
          maxLength: 255
        status:
          enum:
          - created
          - pending
          - voided
          - declined
          - completed
          type: string
        cc:
          type: array
          items:
            type: string
            maxLength: 1000
        sequenced_signing:
          type: boolean
        expiry:
          type: string
          format: date-time
          nullable: true
        first_reminder:
          type: string
          nullable: true
          description: 'ex: P3D to send first reminders after 3 days of sending invite'
        reminder_frequency:
          type: string
          nullable: true
          description: 'ex: P3D to send follow up reminders every 3 days'
        warn_before:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        deleted_at:
          type: string
          format: date-time
          nullable: true
        archived_at:
          type: string
          format: date-time
          nullable: true
        declined_at:
          type: string
          format: date-time
          nullable: true
        voided_at:
          type: string
          format: date-time
          nullable: true
        reason:
          type: string
          nullable: true
          description: 'ex: Reason for Declining or Voiding provided by signer or sender respectively'
          minLength: 4
          maxLength: 500
        audit_log_doc:
          type: string
          format: uri
          nullable: true
        source:
          enum:
          - 1
          - 2
          type: integer
          minimum: -2147483648
          maximum: 2147483647
        workspace:
          type: integer
        sender:
          type: integer
        voided_by:
          type: integer
          nullable: true
        updated_by:
          type: integer
          nullable: true
        folder:
          type: integer
          nullable: true
      required:
      - created_at
      - documents
      - envelope_id
      - id
      - name
      - recipients
      - sender
      - updated_at
      - workspace
      description: ''
    PatchedEnvelopeDocumentsUpdate:
      type: object
      properties:
        fields_meta:
          type: object
          additionalProperties: {}
          nullable: true
      description: ''
    SendEnvelopeViaEmail:
      type: object
      properties:
        emails:
          type: array
          items:
            type: string
            format: email
          nullable: true
      required:
      - emails
      description: ''
    EnvelopeHistory:
      type: object
      properties:
        envelope_id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 255
        status:
          enum:
          - created
          - pending
          - voided
          - declined
          - completed
          type: string
        cc:
          type: array
          items:
            type: string
            maxLength: 1000
        created_at:
          type: string
          format: date-time
          readOnly: true
        signers:
          type: array
          items:
            type: string
          readOnly: true
        history:
          type: array
          items:
            $ref: '#/components/schemas/HistoryRecord'
          readOnly: true
        sender_email:
          type: string
          readOnly: true
      required:
      - created_at
      - envelope_id
      - history
      - name
      - sender_email
      - signers
      description: ''
    EnvelopeDocumentDownloadResponse:
      type: object
      properties:
        file_url:
          type: string
          format: uri
        file_name:
          type: string
      required:
      - file_name
      - file_url
      description: ''
    CreateEnvelopeRecipient:
      type: object
      properties:
        email_address:
          type: string
          format: email
          maxLength: 254
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
      required:
      - email_address
      - order
      description: ''
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    PatchedEnvelopeUpdate:
      type: object
      properties:
        expiry:
          type: string
          format: date-time
          description: Expiry date and time for the envelope
        first_reminder:
          type: integer
          nullable: true
          description: Days after sending invite to send first reminder
        reminder_frequency:
          type: integer
          nullable: true
          description: Frequency in days for follow-up reminders
        warn_before:
          type: string
          format: date-time
          description: Days before expiry to send warning
        sequenced_signing:
          type: boolean
        use_default_reminders:
          type: boolean
          writeOnly: true
          default: false
        cc:
          type: array
          items:
            type: string
            format: email
          nullable: true
      description: ''
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    PatchedUpdateEnvelopeRecipient:
      type: object
      properties:
        email_address:
          type: string
          format: email
          maxLength: 254
        subject:
          type: string
          maxLength: 255
        email_body:
          type: string
        name:
          type: string
          maxLength: 255
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
      description: ''
    EnvelopeResponses:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeFieldResponse'
      required:
      - data
      description: ''
    EnvelopeFieldResponse:
      type: object
      properties:
        signer_id:
          type: string
        document_id:
          type: string
          nullable: true
        name:
          type: string
        type:
          type: string
        value:
          type: string
          nullable: true
        file_name:
          type: string
          nullable: true
      required:
      - name
      - signer_id
      - type
      description: ''
    EnvelopeBulkMove:
      type: object
      properties:
        envelope_ids:
          type: array
          items:
            type: integer
          writeOnly: true
        is_move_all:
          type: boolean
          writeOnly: true
        new_folder_id:
          type: integer
          writeOnly: true
          nullable: true
      required:
      - new_folder_id
      description: ''
    SigningLinkResponse:
      type: object
      properties:
        signing_link:
          type: string
          format: uri
      required:
      - signing_link
      description: ''
    PaginatedEnvelopeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Envelope'
    EnvelopeBulkDownload:
      type: object
      description: ''
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          readOnly: true
        status:
          enum:
          - pending
          - success
          - error
          type: string
          readOnly: true
        envelope_ids:
          type: array
          items:
            type: integer
          writeOnly: true
        created_time:
          type: string
          format: date-time
          readOnly: true
        filters:
          type: object
          additionalProperties: {}
          readOnly: true
        is_export_all:
          type: boolean
          writeOnly: true
      required:
      - created_time
      - filters
      - id
      - name
      - status
    EnvelopeStatusCountResponse:
      type: object
      properties:
        created:
          type: integer
        pending:
          type: integer
        voided:
          type: integer
        declined:
          type: integer
        completed:
          type: integer
      required:
      - completed
      - created
      - declined
      - pending
      - voided
      description: ''
    PaginatedEnvelopeBulkDownloadList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeBulkDownload'
    HistoryRecord:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        event_name:
          enum:
          - created
          - invited
          - send_failed
          - resent
          - viewed
          - signed
          - completed
          - declined
          - voided
          - recipient_changed
          type: string
        event_meta:
          type: object
          additionalProperties: {}
          nullable: true
        server_time:
          type: string
          format: date-time
        client_time:
          type: string
          format: date-time
        ip_address:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp when this history log was created
        actor:
          type: string
          readOnly: true
      required:
      - actor
      - client_time
      - created_at
      - event_name
      - id
      - server_time
      description: ''
    BulkMoveEnvelopesResponse:
      type: object
      properties:
        total_count:
          type: integer
          description: Number of envelopes requested for the bulk move
        moved_count:
          type: integer
          description: Number of envelopes moved successfully
        failure_count:
          type: integer
          description: Number of envelopes that were not moved
        failures:
          type: array
          items:
            $ref: '#/components/schemas/EnvelopeMoveFailureDetail'
          description: Failures grouped by reason
      required:
      - failure_count
      - failures
      - moved_count
      - total_count
      description: ''
    EnvelopeMoveFailureDetail:
      type: object
      properties:
        code:
          type: string
        detail:
          type: string
        ids:
          type: array
          items:
            type: integer
        count:
          type: integer
      required:
      - code
      - count
      - detail
      - ids
      description: ''
    PatchedUpdateEnvelopeFolderSharing:
      type: object
      description: ''
      properties:
        id:
          type: integer
          readOnly: true
        permission:
          enum:
          - read
          - write
          - manage
          type: string
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        non_field_errors:
          type: array
          items:
            type: string
      required:
      - errors
      - non_field_errors
      description: ''
    EnvelopeUpdate:
      type: object
      properties:
        expiry:
          type: string
          format: date-time
          description: Expiry date and time for the envelope
        first_reminder:
          type: integer
          nullable: true
          description: Days after sending invite to send first reminder
        reminder_frequency:
          type: integer
          nullable: true
          description: Frequency in days for follow-up reminders
        warn_before:
          type: string
          format: date-time
          description: Days before expiry to send warning
        sequenced_signing:
          type: boolean
        use_default_reminders:
          type: boolean
          writeOnly: true
          default: false
        cc:
          type: array
          items:
            type: string
            format: email
          nullable: true
      description: ''
    Envelope:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        pending_signers_count:
          type: integer
          readOnly: true
        is_waiting_for_me:
          type: boolean
          readOnly: true
        source:
          type: string
          enum:
          - DOC_GEN
          - MANUAL_SEND
          readOnly: true
        envelope_id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 255
        status:
          enum:
          - created
          - pending
          - voided
          - declined
          - completed
          type: string
        cc:
          type: array
          items:
            type: string
            maxLength: 1000
        sequenced_signing:
          type: boolean
        expiry:
          type: string
          format: date-time
          nullable: true
        first_reminder:
          type: string
          nullable: true
          description: 'ex: P3D to send first reminders after 3 days of sending invite'
        reminder_frequency:
          type: string
          nullable: true
          description: 'ex: P3D to send follow up reminders every 3 days'
        warn_before:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        archived_at:
          type: string
          format: date-time
          nullable: true
        declined_at:
          type: string
          format: date-time
          nullable: true
        voided_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        reason:
          type: string
          nullable: true
          description: 'ex: Reason for Declining or Voiding provided by signer or sender respectively'
          minLength: 4
          maxLength: 500
        sender:
          type: integer
        voided_by:
          type: integer
          nullable: true
        updated_by:
          type: integer
          readOnly: true
          nullable: true
        folder:
          type: integer
          nullable: true
      required:
      - created_at
      - deleted_at
      - envelope_id
      - id
      - is_waiting_for_me
      - name
      - pending_signers_count
      - sender
      - source
      - updated_at
      - updated_by
      - voided_at
      description: ''
    NotFoundError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    EnvelopeExportDownloadResponse:
      type: object
      properties:
        file_url:
          type: string
          format: uri
        file_name:
          type: string
      required:
      - file_name
      - file_url
      description: ''
    EnvelopeDocuments:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        document_name:
          type: string
          readOnly: true
        fields_meta:
          type: object
          additionalProperties: {}
          readOnly: true
          nullable: true
      required:
      - document_name
      - fields_meta
      - id
      description: ''
  securitySchemes:
    OAuthAuthentication:
      type: http
      scheme: bearer
      description: OAuth2 Bearer Token Authentication
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: sessionid
      description: browser based login takes care of this
externalDocs:
  description: Help docs on how to use API
  url: https://help.docupilot.app/developers/api-overview