hanzoai 8.5.156

data/lib/hanzoai/api/esign_api.rb

@@ -0,0 +1,908 @@
+=begin
+#Hanzo Cloud API
+
+#The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module Hanzoai
+  class EsignApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns your org's documents, newest first.
+    # Returns your org's documents, newest first.  Each carries its status, recipients and field layout. The listing is capped at 200 and there is no paging, so treat it as the recent window rather than a complete export. It reads the caller's own tenant store, so no other org's documents can appear in it.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignDocuments]
+    def get_esign_documents(opts = {})
+      data, _status_code, _headers = get_esign_documents_with_http_info(opts)
+      data
+    end
+
+    # Returns your org's documents, newest first.
+    # Returns your org's documents, newest first.  Each carries its status, recipients and field layout. The listing is capped at 200 and there is no paging, so treat it as the recent window rather than a complete export. It reads the caller's own tenant store, so no other org's documents can appear in it.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignDocuments, Integer, Hash)>] EsignDocuments data, response status code and response headers
+    def get_esign_documents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_documents ...'
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignDocuments'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns one document with its recipients and field layout.
+    # Returns one document with its recipients and field layout.  It answers the document, its recipients with each one's read and signing status, and every field with its type, page and position — the view a sender's UI renders, and where the field ids come from. The id is resolved in the caller's OWN tenant store, so another org's document id is a 404 rather than a refusal that would confirm it exists.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignDocument]
+    def get_esign_documents_by_id(id, opts = {})
+      data, _status_code, _headers = get_esign_documents_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Returns one document with its recipients and field layout.
+    # Returns one document with its recipients and field layout.  It answers the document, its recipients with each one&#39;s read and signing status, and every field with its type, page and position — the view a sender&#39;s UI renders, and where the field ids come from. The id is resolved in the caller&#39;s OWN tenant store, so another org&#39;s document id is a 404 rather than a refusal that would confirm it exists.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignDocument, Integer, Hash)>] EsignDocument data, response status code and response headers
+    def get_esign_documents_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_documents_by_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.get_esign_documents_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignDocument'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_documents_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_documents_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the document's full audit trail, oldest first.
+    # Returns the document's full audit trail, oldest first.  It answers every recorded event for the document in order — created, recipient added, field created, sent, opened, each field inserted, each recipient completed or rejected, and completion — with the actor and timestamp on each. This is the evidence record behind a signature, so it is append-only and nothing in the surface edits it.  The id is resolved in the caller's OWN tenant store, so another org's document id is a 404.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignTrail]
+    def get_esign_documents_by_id_audit(id, opts = {})
+      data, _status_code, _headers = get_esign_documents_by_id_audit_with_http_info(id, opts)
+      data
+    end
+
+    # Returns the document&#39;s full audit trail, oldest first.
+    # Returns the document&#39;s full audit trail, oldest first.  It answers every recorded event for the document in order — created, recipient added, field created, sent, opened, each field inserted, each recipient completed or rejected, and completion — with the actor and timestamp on each. This is the evidence record behind a signature, so it is append-only and nothing in the surface edits it.  The id is resolved in the caller&#39;s OWN tenant store, so another org&#39;s document id is a 404.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignTrail, Integer, Hash)>] EsignTrail data, response status code and response headers
+    def get_esign_documents_by_id_audit_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_documents_by_id_audit ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.get_esign_documents_by_id_audit"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}/audit'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignTrail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_documents_by_id_audit",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_documents_by_id_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the document — the sealed PDF once it is complete.
+    # Returns the document — the sealed PDF once it is complete.  It answers the document's current PDF as base64 with a sealed flag and a filename. Before completion that is the original upload; once every signer has finished it is the SEALED artifact, with the field values rendered onto the page and a real x509 PKCS#7 digital signature applied. There is one pdfBase64 field either way, so sealed is what tells you which you are holding.  The id is resolved in the caller's OWN tenant store, so another org's document id is a 404.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignPDF]
+    def get_esign_documents_by_id_download(id, opts = {})
+      data, _status_code, _headers = get_esign_documents_by_id_download_with_http_info(id, opts)
+      data
+    end
+
+    # Returns the document — the sealed PDF once it is complete.
+    # Returns the document — the sealed PDF once it is complete.  It answers the document&#39;s current PDF as base64 with a sealed flag and a filename. Before completion that is the original upload; once every signer has finished it is the SEALED artifact, with the field values rendered onto the page and a real x509 PKCS#7 digital signature applied. There is one pdfBase64 field either way, so sealed is what tells you which you are holding.  The id is resolved in the caller&#39;s OWN tenant store, so another org&#39;s document id is a 404.
+    # @param id [String] ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller&#39;s principal, so an id belonging to another tenant is simply not found.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignPDF, Integer, Hash)>] EsignPDF data, response status code and response headers
+    def get_esign_documents_by_id_download_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_documents_by_id_download ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.get_esign_documents_by_id_download"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}/download'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignPDF'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_documents_by_id_download",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_documents_by_id_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reports whether the e-signature surface is mounted.
+    # Reports whether the e-signature surface is mounted.  It answers ok whenever the subsystem is mounted, takes no tenant and needs no principal. It is deliberately shallow: it is registered before the document host is built, so it still answers on a deployment that came up WITHOUT object storage and therefore serves nothing else. Read it as reachability, never as a promise that documents can be stored.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignHealth]
+    def get_esign_health(opts = {})
+      data, _status_code, _headers = get_esign_health_with_http_info(opts)
+      data
+    end
+
+    # Reports whether the e-signature surface is mounted.
+    # Reports whether the e-signature surface is mounted.  It answers ok whenever the subsystem is mounted, takes no tenant and needs no principal. It is deliberately shallow: it is registered before the document host is built, so it still answers on a deployment that came up WITHOUT object storage and therefore serves nothing else. Read it as reachability, never as a promise that documents can be stored.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignHealth, Integer, Hash)>] EsignHealth data, response status code and response headers
+    def get_esign_health_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_health ...'
+      end
+      # resource path
+      local_var_path = '/v1/esign/health'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignHealth'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_health",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Opens a document you were asked to sign, using your signing link.
+    # Opens a document you were asked to sign, using your signing link.  It answers the document, the recipient the link identifies, the fields THAT recipient must fill, and the PDF to display. The first open also marks the recipient as having opened it and records that on the audit trail, so this read has a side effect by design.  This surface takes NO account: the signing token is the entire credential, and it names the recipient, so a signer sees only their own fields and never the other recipients' tokens. The token resolves to its owning tenant FIRST, before any per-tenant store is opened, and the org segment is only checked against that answer. An unknown or wrong-org token is one and the same 404, never a hint that some other document exists.
+    # @param org [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignSession]
+    def get_esign_oby_org_sign_by_token(org, token, opts = {})
+      data, _status_code, _headers = get_esign_oby_org_sign_by_token_with_http_info(org, token, opts)
+      data
+    end
+
+    # Opens a document you were asked to sign, using your signing link.
+    # Opens a document you were asked to sign, using your signing link.  It answers the document, the recipient the link identifies, the fields THAT recipient must fill, and the PDF to display. The first open also marks the recipient as having opened it and records that on the audit trail, so this read has a side effect by design.  This surface takes NO account: the signing token is the entire credential, and it names the recipient, so a signer sees only their own fields and never the other recipients&#39; tokens. The token resolves to its owning tenant FIRST, before any per-tenant store is opened, and the org segment is only checked against that answer. An unknown or wrong-org token is one and the same 404, never a hint that some other document exists.
+    # @param org [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignSession, Integer, Hash)>] EsignSession data, response status code and response headers
+    def get_esign_oby_org_sign_by_token_with_http_info(org, token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.get_esign_oby_org_sign_by_token ...'
+      end
+      # verify the required parameter 'org' is set
+      if @api_client.config.client_side_validation && org.nil?
+        fail ArgumentError, "Missing the required parameter 'org' when calling EsignApi.get_esign_oby_org_sign_by_token"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling EsignApi.get_esign_oby_org_sign_by_token"
+      end
+      # resource path
+      local_var_path = '/v1/esign/o/{org}/sign/{token}'.sub('{' + 'org' + '}', CGI.escape(org.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignSession'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.get_esign_oby_org_sign_by_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#get_esign_oby_org_sign_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Uploads a PDF and opens a draft ready for recipients and fields.
+    # Uploads a PDF and opens a draft ready for recipients and fields.  It answers 201 with the document in DRAFT — the state where recipients and fields may still be added, and the only state they may. The bytes go to object storage rather than into the tenant database, and the original is kept under its own key so it survives sealing untouched: a completed document can always be compared against what was uploaded. Creation is recorded on the audit trail.  This is the sender's surface: a validated principal is required, and the document lands in that principal's OWN org. Isolation is physical rather than a filter — each tenant has its own store — so another org's document id is simply not there. A body over 32 MiB is refused with 413.
+    # @param esign_upload_in [EsignUploadIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignDocument]
+    def post_esign_documents(esign_upload_in, opts = {})
+      data, _status_code, _headers = post_esign_documents_with_http_info(esign_upload_in, opts)
+      data
+    end
+
+    # Uploads a PDF and opens a draft ready for recipients and fields.
+    # Uploads a PDF and opens a draft ready for recipients and fields.  It answers 201 with the document in DRAFT — the state where recipients and fields may still be added, and the only state they may. The bytes go to object storage rather than into the tenant database, and the original is kept under its own key so it survives sealing untouched: a completed document can always be compared against what was uploaded. Creation is recorded on the audit trail.  This is the sender&#39;s surface: a validated principal is required, and the document lands in that principal&#39;s OWN org. Isolation is physical rather than a filter — each tenant has its own store — so another org&#39;s document id is simply not there. A body over 32 MiB is refused with 413.
+    # @param esign_upload_in [EsignUploadIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignDocument, Integer, Hash)>] EsignDocument data, response status code and response headers
+    def post_esign_documents_with_http_info(esign_upload_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_documents ...'
+      end
+      # verify the required parameter 'esign_upload_in' is set
+      if @api_client.config.client_side_validation && esign_upload_in.nil?
+        fail ArgumentError, "Missing the required parameter 'esign_upload_in' when calling EsignApi.post_esign_documents"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(esign_upload_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignDocument'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Places a field on the page for one recipient to fill.
+    # Places a field on the page for one recipient to fill.  It adds a signature, date, name, email or text box at a page and position for ONE named recipient, and answers 201 with its id. The recipient must belong to this document; one from elsewhere is refused.  Fields are what make a recipient signable: a document cannot be sent while any signing recipient has none. Only while DRAFT — adding a field to a sent document is a 409 — and an unknown document is a 404. The addition is recorded on the audit trail.
+    # @param id [String] 
+    # @param esign_field_in [EsignFieldIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignPlacement]
+    def post_esign_documents_by_id_fields(id, esign_field_in, opts = {})
+      data, _status_code, _headers = post_esign_documents_by_id_fields_with_http_info(id, esign_field_in, opts)
+      data
+    end
+
+    # Places a field on the page for one recipient to fill.
+    # Places a field on the page for one recipient to fill.  It adds a signature, date, name, email or text box at a page and position for ONE named recipient, and answers 201 with its id. The recipient must belong to this document; one from elsewhere is refused.  Fields are what make a recipient signable: a document cannot be sent while any signing recipient has none. Only while DRAFT — adding a field to a sent document is a 409 — and an unknown document is a 404. The addition is recorded on the audit trail.
+    # @param id [String] 
+    # @param esign_field_in [EsignFieldIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignPlacement, Integer, Hash)>] EsignPlacement data, response status code and response headers
+    def post_esign_documents_by_id_fields_with_http_info(id, esign_field_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_documents_by_id_fields ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.post_esign_documents_by_id_fields"
+      end
+      # verify the required parameter 'esign_field_in' is set
+      if @api_client.config.client_side_validation && esign_field_in.nil?
+        fail ArgumentError, "Missing the required parameter 'esign_field_in' when calling EsignApi.post_esign_documents_by_id_fields"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}/fields'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(esign_field_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignPlacement'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_documents_by_id_fields",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_documents_by_id_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Adds someone to a draft and mints their signing token.
+    # Adds someone to a draft and mints their signing token.  It answers 201 with the recipient's id and their signing TOKEN — the crypto-random capability that is the only credential the signer's surface accepts — so this response is where the signing link is built from. A CC recipient is recorded as already complete, because they are never asked to sign.  Only while DRAFT: adding a recipient to a document already sent is a 409, because the field layout and the turn order were fixed when it went out. An unknown document is a 404. The addition is recorded on the audit trail.
+    # @param id [String] 
+    # @param esign_recipient_in [EsignRecipientIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignInvite]
+    def post_esign_documents_by_id_recipients(id, esign_recipient_in, opts = {})
+      data, _status_code, _headers = post_esign_documents_by_id_recipients_with_http_info(id, esign_recipient_in, opts)
+      data
+    end
+
+    # Adds someone to a draft and mints their signing token.
+    # Adds someone to a draft and mints their signing token.  It answers 201 with the recipient&#39;s id and their signing TOKEN — the crypto-random capability that is the only credential the signer&#39;s surface accepts — so this response is where the signing link is built from. A CC recipient is recorded as already complete, because they are never asked to sign.  Only while DRAFT: adding a recipient to a document already sent is a 409, because the field layout and the turn order were fixed when it went out. An unknown document is a 404. The addition is recorded on the audit trail.
+    # @param id [String] 
+    # @param esign_recipient_in [EsignRecipientIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignInvite, Integer, Hash)>] EsignInvite data, response status code and response headers
+    def post_esign_documents_by_id_recipients_with_http_info(id, esign_recipient_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_documents_by_id_recipients ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.post_esign_documents_by_id_recipients"
+      end
+      # verify the required parameter 'esign_recipient_in' is set
+      if @api_client.config.client_side_validation && esign_recipient_in.nil?
+        fail ArgumentError, "Missing the required parameter 'esign_recipient_in' when calling EsignApi.post_esign_documents_by_id_recipients"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}/recipients'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(esign_recipient_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignInvite'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_documents_by_id_recipients",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_documents_by_id_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Sends the document out and answers each signer's link.
+    # Sends the document out and answers each signer's link.  It moves the document from DRAFT to PENDING and answers the signing tokens — one per signing recipient, with the path to hand them — which is how the links reach the people who must sign. Nothing is emailed by this call; delivering the links is the caller's.  It refuses to send an unsignable document: no recipients at all is a 400, and so is any signing recipient with no fields to fill, named in the error. Re-sending an already-pending document is allowed and re-issues the same links rather than restarting anything; a completed document is a 409, and an unknown one a 404. The send is recorded on the audit trail.
+    # @param id [String] ID is the document to send. The URL is the addressing authority.
+    # @param [Hash] opts the optional parameters
+    # @return [EsignLinks]
+    def post_esign_documents_by_id_send(id, opts = {})
+      data, _status_code, _headers = post_esign_documents_by_id_send_with_http_info(id, opts)
+      data
+    end
+
+    # Sends the document out and answers each signer&#39;s link.
+    # Sends the document out and answers each signer&#39;s link.  It moves the document from DRAFT to PENDING and answers the signing tokens — one per signing recipient, with the path to hand them — which is how the links reach the people who must sign. Nothing is emailed by this call; delivering the links is the caller&#39;s.  It refuses to send an unsignable document: no recipients at all is a 400, and so is any signing recipient with no fields to fill, named in the error. Re-sending an already-pending document is allowed and re-issues the same links rather than restarting anything; a completed document is a 409, and an unknown one a 404. The send is recorded on the audit trail.
+    # @param id [String] ID is the document to send. The URL is the addressing authority.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignLinks, Integer, Hash)>] EsignLinks data, response status code and response headers
+    def post_esign_documents_by_id_send_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_documents_by_id_send ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EsignApi.post_esign_documents_by_id_send"
+      end
+      # resource path
+      local_var_path = '/v1/esign/documents/{id}/send'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignLinks'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_documents_by_id_send",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_documents_by_id_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Finishes your signing — and seals the document if you were the last.
+    # Finishes your signing — and seals the document if you were the last.  It marks this recipient as done and answers whether the DOCUMENT sealed with it. When every signing recipient has completed, sealing happens right here in the same call: the collected values are rendered onto the PDF, a real x509 PKCS#7 signature is applied, the sealed bytes are stored beside the untouched original, and the document moves to COMPLETED. Until then the answer is the recipient's own completion with the document still pending.  It refuses to complete a half-filled signature: a recipient with any unfilled field is a 400 naming how many remain. A document not out for signature is a 409, as is a recipient who has already completed, and under SEQUENTIAL order a signer out of turn is a 403. The token is the whole credential — no account, and a token that does not resolve under the org segment is a 404. Sealing and completion are one transaction, so a failure anywhere leaves the document exactly as it was.
+    # @param org [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignCompletion]
+    def post_esign_oby_org_sign_by_token_complete(org, token, opts = {})
+      data, _status_code, _headers = post_esign_oby_org_sign_by_token_complete_with_http_info(org, token, opts)
+      data
+    end
+
+    # Finishes your signing — and seals the document if you were the last.
+    # Finishes your signing — and seals the document if you were the last.  It marks this recipient as done and answers whether the DOCUMENT sealed with it. When every signing recipient has completed, sealing happens right here in the same call: the collected values are rendered onto the PDF, a real x509 PKCS#7 signature is applied, the sealed bytes are stored beside the untouched original, and the document moves to COMPLETED. Until then the answer is the recipient&#39;s own completion with the document still pending.  It refuses to complete a half-filled signature: a recipient with any unfilled field is a 400 naming how many remain. A document not out for signature is a 409, as is a recipient who has already completed, and under SEQUENTIAL order a signer out of turn is a 403. The token is the whole credential — no account, and a token that does not resolve under the org segment is a 404. Sealing and completion are one transaction, so a failure anywhere leaves the document exactly as it was.
+    # @param org [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignCompletion, Integer, Hash)>] EsignCompletion data, response status code and response headers
+    def post_esign_oby_org_sign_by_token_complete_with_http_info(org, token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_oby_org_sign_by_token_complete ...'
+      end
+      # verify the required parameter 'org' is set
+      if @api_client.config.client_side_validation && org.nil?
+        fail ArgumentError, "Missing the required parameter 'org' when calling EsignApi.post_esign_oby_org_sign_by_token_complete"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling EsignApi.post_esign_oby_org_sign_by_token_complete"
+      end
+      # resource path
+      local_var_path = '/v1/esign/o/{org}/sign/{token}/complete'.sub('{' + 'org' + '}', CGI.escape(org.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignCompletion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_oby_org_sign_by_token_complete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_oby_org_sign_by_token_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fills in one of your fields.
+    # Fills in one of your fields.  It records a value for one field and marks it inserted. A signature field takes a value with isBase64 true for drawn image bytes, or false for a typed signature; a date, name or email field falls back to today, the recipient's name or their email when the value is omitted; any other type requires one.  Nothing is sealed here — filling every field still leaves the document pending until the completion call. The token is the whole credential and it bounds what can be written: a field belonging to another recipient is refused with 401 even under a valid token, an unknown field is a 404, and a field already filled is a 409. A document not out for signature is a 409, as is a recipient who has already completed or rejected. Under SEQUENTIAL order a signer whose turn has not come is refused 403 until every earlier signer has signed. Each insertion is recorded on the audit trail.
+    # @param org [String] 
+    # @param token [String] 
+    # @param field_id [String] 
+    # @param esign_value_in [EsignValueIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignInsertion]
+    def post_esign_oby_org_sign_by_token_fields_by_fieldid(org, token, field_id, esign_value_in, opts = {})
+      data, _status_code, _headers = post_esign_oby_org_sign_by_token_fields_by_fieldid_with_http_info(org, token, field_id, esign_value_in, opts)
+      data
+    end
+
+    # Fills in one of your fields.
+    # Fills in one of your fields.  It records a value for one field and marks it inserted. A signature field takes a value with isBase64 true for drawn image bytes, or false for a typed signature; a date, name or email field falls back to today, the recipient&#39;s name or their email when the value is omitted; any other type requires one.  Nothing is sealed here — filling every field still leaves the document pending until the completion call. The token is the whole credential and it bounds what can be written: a field belonging to another recipient is refused with 401 even under a valid token, an unknown field is a 404, and a field already filled is a 409. A document not out for signature is a 409, as is a recipient who has already completed or rejected. Under SEQUENTIAL order a signer whose turn has not come is refused 403 until every earlier signer has signed. Each insertion is recorded on the audit trail.
+    # @param org [String] 
+    # @param token [String] 
+    # @param field_id [String] 
+    # @param esign_value_in [EsignValueIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignInsertion, Integer, Hash)>] EsignInsertion data, response status code and response headers
+    def post_esign_oby_org_sign_by_token_fields_by_fieldid_with_http_info(org, token, field_id, esign_value_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid ...'
+      end
+      # verify the required parameter 'org' is set
+      if @api_client.config.client_side_validation && org.nil?
+        fail ArgumentError, "Missing the required parameter 'org' when calling EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid"
+      end
+      # verify the required parameter 'field_id' is set
+      if @api_client.config.client_side_validation && field_id.nil?
+        fail ArgumentError, "Missing the required parameter 'field_id' when calling EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid"
+      end
+      # verify the required parameter 'esign_value_in' is set
+      if @api_client.config.client_side_validation && esign_value_in.nil?
+        fail ArgumentError, "Missing the required parameter 'esign_value_in' when calling EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid"
+      end
+      # resource path
+      local_var_path = '/v1/esign/o/{org}/sign/{token}/fields/{fieldId}'.sub('{' + 'org' + '}', CGI.escape(org.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s)).sub('{' + 'fieldId' + '}', CGI.escape(field_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(esign_value_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignInsertion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_oby_org_sign_by_token_fields_by_fieldid",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_oby_org_sign_by_token_fields_by_fieldid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Declines to sign, with an optional reason.
+    # Declines to sign, with an optional reason.  It records this recipient's refusal and moves the WHOLE DOCUMENT to REJECTED — one declining signer ends it for everyone, and there is no route back: the document cannot then be signed or completed. An optional reason is stored and written onto the audit trail with the rejection, which is what the sender sees.  A document not out for signature is a 409, and so is a recipient who has already signed or already rejected — a refusal cannot be taken back or repeated. The token is the whole credential; one that does not resolve under the org segment is a 404.
+    # @param org [String] 
+    # @param token [String] 
+    # @param esign_reject_in [EsignRejectIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [EsignRejection]
+    def post_esign_oby_org_sign_by_token_reject(org, token, esign_reject_in, opts = {})
+      data, _status_code, _headers = post_esign_oby_org_sign_by_token_reject_with_http_info(org, token, esign_reject_in, opts)
+      data
+    end
+
+    # Declines to sign, with an optional reason.
+    # Declines to sign, with an optional reason.  It records this recipient&#39;s refusal and moves the WHOLE DOCUMENT to REJECTED — one declining signer ends it for everyone, and there is no route back: the document cannot then be signed or completed. An optional reason is stored and written onto the audit trail with the rejection, which is what the sender sees.  A document not out for signature is a 409, and so is a recipient who has already signed or already rejected — a refusal cannot be taken back or repeated. The token is the whole credential; one that does not resolve under the org segment is a 404.
+    # @param org [String] 
+    # @param token [String] 
+    # @param esign_reject_in [EsignRejectIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EsignRejection, Integer, Hash)>] EsignRejection data, response status code and response headers
+    def post_esign_oby_org_sign_by_token_reject_with_http_info(org, token, esign_reject_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EsignApi.post_esign_oby_org_sign_by_token_reject ...'
+      end
+      # verify the required parameter 'org' is set
+      if @api_client.config.client_side_validation && org.nil?
+        fail ArgumentError, "Missing the required parameter 'org' when calling EsignApi.post_esign_oby_org_sign_by_token_reject"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling EsignApi.post_esign_oby_org_sign_by_token_reject"
+      end
+      # verify the required parameter 'esign_reject_in' is set
+      if @api_client.config.client_side_validation && esign_reject_in.nil?
+        fail ArgumentError, "Missing the required parameter 'esign_reject_in' when calling EsignApi.post_esign_oby_org_sign_by_token_reject"
+      end
+      # resource path
+      local_var_path = '/v1/esign/o/{org}/sign/{token}/reject'.sub('{' + 'org' + '}', CGI.escape(org.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(esign_reject_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EsignRejection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"EsignApi.post_esign_oby_org_sign_by_token_reject",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EsignApi#post_esign_oby_org_sign_by_token_reject\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end