Solvimon signatureRequests API

openapi: 3.1.0
info:
  title: Configuration alertRules signatureRequests API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: signatureRequests
paths:
  /v{version}/signature-requests/{resourceId}/void:
    post:
      operationId: postSignatureRequestsByResourceIdVoid
      summary: Void a signature request
      description: Requires the SIGNATURE_REQUEST.UPDATE permission.
      tags:
      - signatureRequests
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/signature-requests/{resourceId}/complete:
    post:
      operationId: postSignatureRequestsByResourceIdComplete
      summary: Complete a signature request
      description: Requires the SIGNATURE_REQUEST.UPDATE permission.
      tags:
      - signatureRequests
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/signature-requests/{resourceId}/recipient-action:
    post:
      operationId: postSignatureRequestsByResourceIdRecipientAction
      summary: Perform a recipient action on a signature request
      description: Requires the SIGNATURE_REQUEST.UPDATE permission.
      tags:
      - signatureRequests
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestRecipientActionCreateRequest'
components:
  schemas:
    ApiErrorResourceType:
      type: string
      enum:
      - CUSTOMER
      - CUSTOM_FIELD
      - PLATFORM
      - PLATFORM_UPTODATE
      - METER
      - METER_VALUE
      - METER_PROPERTY
      - METER_VALUE_CALCULATION
      - INGEST_DATA
      - METER_DATA
      - CHARGE_DATA
      - PERSIST_DATA
      - ADJUSTMENT_DATA
      - PRODUCT_CATEGORY
      - PRODUCT
      - PRODUCT_ITEM
      - PRICING
      - PRICING_GROUP
      - PRICING_ITEM
      - PRICING_ITEM_CONFIG
      - PRICING_PLAN_SUBSCRIPTION
      - PRICING_PLAN_SUBSCRIPTION_GROUP
      - PRICING_PLAN_SCHEDULE
      - PRICING_PLAN
      - PRICING_PLAN_VERSION
      - QUOTE
      - QUOTE_VERSION
      - QUOTE_TEMPLATE
      - API_KEY
      - USER
      - ROLE
      - PROXY_USER
      - EXTERNAL_CREDENTIALS
      - TOKEN
      - INVOICE
      - E_INVOICE
      - PDF
      - BILLING_ENTITY
      - FEATURE
      - MEMBERSHIP
      - PAYMENT
      - PAYMENT_ACCEPTOR
      - PAYMENT_METHOD
      - PAYMENT_METHOD_OPTIONS
      - PAYMENT_SCHEDULE
      - PAYMENT_REQUEST
      - INTEGRATION
      - WEBHOOK
      - FILE
      - FILE_PROCESSING_SETTINGS
      - TEAM
      - DOWNLOAD_URL
      - CSV_REPORT
      - REPORT
      - REPORT_GENERATE_REQUEST
      - REPORT_CONFIGURATION
      - REPORT_SUBSCRIPTION
      - REPORT_DEFINITION
      - ACCOUNT_GROUP
      - ENTITY
      - EVENT_TRACE
      - EVENT_TRACE_LINK
      - PRICING_CATEGORY
      - CONTACT
      - ALERT_RULE
      - ALERT
      - AUDIT_RECORD
      - PORTAL_URL
      - AUTHENTICATION_PROVIDER
      - REPROCESS
      - APPROVAL_POLICY
      - APPROVAL_REQUEST
      - BULK_ACTION
      - COUPON
      - PROMOTION_CODE
      - WALLET
      - WALLET_TYPE
      - WALLET_GRANT
      - WORKFLOW
      - WORKFLOW_TRIGGER
      - WORKFLOW_ACTION
      - CREDIT_TYPE
      - SIGNATURE_REQUEST
      - ATTACHMENT
      - DOCUMENT
      title: ApiErrorResourceType
    SignatureRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        updated_at:
          type:
          - string
          - 'null'
        status:
          oneOf:
          - $ref: '#/components/schemas/SignatureRequestStatus'
          - type: 'null'
          description: The status of the signature request.
        type:
          oneOf:
          - $ref: '#/components/schemas/SignatureRequestType'
          - type: 'null'
          description: The type of the signature request.
        quote_version:
          $ref: '#/components/schemas/SignatureRequestQuoteVersion'
        recipients:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SignatureRequestRecipientData'
          description: The recipients of the signature request.
      title: SignatureRequest
    SignatureRequestQuoteVersion:
      type: object
      properties:
        quote_version_id:
          type:
          - string
          - 'null'
          description: The ID of the quote version this signature request belongs to.
      title: SignatureRequestQuoteVersion
    SignatureRequestRecipientDataStatus:
      type: string
      enum:
      - PENDING
      - COMPLETED
      description: The status of the recipient.
      title: SignatureRequestRecipientDataStatus
    SignatureRequestStatus:
      type: string
      enum:
      - IN_PROGRESS
      - COMPLETED
      - VOID
      description: The status of the signature request.
      title: SignatureRequestStatus
    SignatureRequestRecipientDataRole:
      type: string
      enum:
      - SIGNER
      - VIEWER
      description: The role of the recipient.
      title: SignatureRequestRecipientDataRole
    SignatureRequestType:
      type: string
      enum:
      - QUOTE_VERSION
      description: The type of the signature request.
      title: SignatureRequestType
    ApiErrorCode:
      type: string
      enum:
      - RESOURCE_NOT_FOUND
      - RESOURCES_NOT_FOUND
      - UNABLE_TO_PROCESS_INSTRUCTIONS
      - BAD_REQUEST
      - UNSUPPORTED_MEDIA_TYPE
      - RESOURCE_ALREADY_EXISTS
      - CUSTOM_FIELD_VALUE_ALREADY_EXISTS
      - COULD_NOT_CREATE_RESOURCE
      - COULD_NOT_UPDATE_RESOURCE
      - COULD_NOT_DELETE_RESOURCE
      - MISSING_VERSION
      - UNSUPPORTED_VERSION
      - UNAUTHORISED
      - CUSTOMER_NOT_FOUND
      - PLATFORM_NOT_FOUND
      - PRICING_PLAN_NOT_FOUND
      - PRODUCT_NOT_FOUND
      - PRODUCT_ITEM_NOT_FOUND
      - PRICING_NOT_FOUND
      - PRICING_ITEM_NOT_FOUND
      - USER_NOT_FOUND
      - METER_NOT_FOUND
      - METER_VALUE_NOT_FOUND
      - METER_PROPERTY_NOT_FOUND
      - PRICING_ITEM_SUMMARIES_NOT_FOUND
      - MISSING_ID
      - INVALID_ID
      - MISSING_REFERENCE
      - MISSING_FIELD
      - INVALID_FIELD
      - INVALID_OPERATION
      - INTERNAL_ERROR
      - USER_NOT_ALLOWED
      - IDEMPOTENCY_CHECK_FAILED
      - INVALID_REQUEST
      title: ApiErrorCode
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    SignatureRequestRecipientData:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The unique identifier of this recipient.
        contact_id:
          type:
          - string
          - 'null'
          description: The contact ID, present when the recipient originates from a contact.
        name:
          oneOf:
          - $ref: '#/components/schemas/Name'
          - type: 'null'
          description: The name of the recipient.
        email:
          type:
          - string
          - 'null'
          description: The email of the recipient.
        role:
          oneOf:
          - $ref: '#/components/schemas/SignatureRequestRecipientDataRole'
          - type: 'null'
          description: The role of the recipient.
        status:
          oneOf:
          - $ref: '#/components/schemas/SignatureRequestRecipientDataStatus'
          - type: 'null'
          description: The status of the recipient.
      title: SignatureRequestRecipientData
    SignatureRequestRecipientActionCreateRequest:
      type: object
      properties:
        recipient_id:
          type: string
          description: The recipient ID of the recipient performing the action.
        action:
          $ref: '#/components/schemas/SignatureRequestRecipientActionCreateRequestAction'
          description: The action the recipient is performing.
      required:
      - recipient_id
      - action
      title: SignatureRequestRecipientActionCreateRequest
    SignatureRequestRecipientActionCreateRequestAction:
      type: string
      enum:
      - VIEW
      - SIGN
      description: The action the recipient is performing.
      title: SignatureRequestRecipientActionCreateRequestAction
    Name:
      type: object
      properties:
        first_name:
          type:
          - string
          - 'null'
        last_name:
          type:
          - string
          - 'null'
        infix:
          type:
          - string
          - 'null'
      title: Name
  securitySchemes:
    API-Key:
      type: apiKey
      in: header
      name: X-API-KEY
    JWT-Authentication:
      type: http
      scheme: bearer