docspring 3.5.0 → 4.1.0

data/lib/docspring/models/submission.rb

@@ -1,12 +1,12 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end
 
@@ -14,60 +14,82 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class Submission
-    attr_accessor :batch_id
+  # Data submitted to a template, and the PDF generated from it.
+  class Submission < ApiModelBase
+    # The submission's ID.
+    attr_accessor :id
 
-    attr_accessor :data_requests
+    # Null once the template has been permanently deleted.
+    attr_accessor :template_id
 
-    attr_accessor :editable
+    # The template's type: `pdf` or `html`.
+    attr_accessor :template_type
 
-    attr_accessor :error_message
+    # The published version of the template the submission used. Null for the draft.
+    attr_accessor :template_version
 
-    attr_accessor :expired
+    # The ID of the batch the submission was created in.
+    attr_accessor :batch_id
 
-    attr_accessor :expires_at
+    # `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+    attr_accessor :source
 
-    attr_accessor :id
+    # `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+    attr_accessor :state
 
-    attr_accessor :json_schema_errors
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    attr_accessor :test
 
-    attr_accessor :metadata
+    # `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+    attr_accessor :editable
 
-    attr_accessor :password
+    # The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
+    attr_accessor :data
 
-    attr_accessor :processed_at
+    # Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+    attr_accessor :data_errors
 
-    attr_accessor :state
+    # Why the PDF couldn't be generated, when `state` is `error`.
+    attr_accessor :error_message
 
-    attr_accessor :template_id
+    # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+    attr_accessor :metadata
 
-    attr_accessor :template_type
+    # Whether the PDF needs a password to open (`password`).
+    attr_accessor :has_password
 
-    attr_accessor :template_version
+    # The people asked to sign the submission (and fill in their fields), in order.
+    attr_accessor :signature_requests
 
-    attr_accessor :test
+    # The uploads of the submission's PDF to your storage (account integrations).
+    attr_accessor :actions
 
+    # The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
     attr_accessor :truncated_text
 
-    attr_accessor :pdf_hash
-
-    attr_accessor :download_url
-
-    attr_accessor :permanent_download_url
+    # What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+    attr_accessor :output_formats
 
-    attr_accessor :preview_download_url
+    # The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
+    attr_accessor :files
 
+    # When the preview PDF was generated. Null if there is no preview.
     attr_accessor :preview_generated_at
 
-    attr_accessor :audit_trail_download_url
+    # An expired submission's data, metadata, password and PDF have been deleted.
+    attr_accessor :expired
 
-    attr_accessor :actions
+    # When the submission expires. Null if it's kept until you delete it.
+    attr_accessor :expires_at
 
-    attr_accessor :source
+    # When the PDF was generated. Null until then.
+    attr_accessor :processed_at
 
-    attr_accessor :referrer
+    # When the submission was created.
+    attr_accessor :created_at
 
-    attr_accessor :data
+    # When the submission was last updated.
+    attr_accessor :updated_at
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -94,33 +116,31 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'batch_id' => :'batch_id',
-        :'data_requests' => :'data_requests',
-        :'editable' => :'editable',
-        :'error_message' => :'error_message',
-        :'expired' => :'expired',
-        :'expires_at' => :'expires_at',
         :'id' => :'id',
-        :'json_schema_errors' => :'json_schema_errors',
-        :'metadata' => :'metadata',
-        :'password' => :'password',
-        :'processed_at' => :'processed_at',
-        :'state' => :'state',
         :'template_id' => :'template_id',
         :'template_type' => :'template_type',
         :'template_version' => :'template_version',
+        :'batch_id' => :'batch_id',
+        :'source' => :'source',
+        :'state' => :'state',
         :'test' => :'test',
+        :'editable' => :'editable',
+        :'data' => :'data',
+        :'data_errors' => :'data_errors',
+        :'error_message' => :'error_message',
+        :'metadata' => :'metadata',
+        :'has_password' => :'has_password',
+        :'signature_requests' => :'signature_requests',
+        :'actions' => :'actions',
         :'truncated_text' => :'truncated_text',
-        :'pdf_hash' => :'pdf_hash',
-        :'download_url' => :'download_url',
-        :'permanent_download_url' => :'permanent_download_url',
-        :'preview_download_url' => :'preview_download_url',
+        :'output_formats' => :'output_formats',
+        :'files' => :'files',
         :'preview_generated_at' => :'preview_generated_at',
-        :'audit_trail_download_url' => :'audit_trail_download_url',
-        :'actions' => :'actions',
-        :'source' => :'source',
-        :'referrer' => :'referrer',
-        :'data' => :'data'
+        :'expired' => :'expired',
+        :'expires_at' => :'expires_at',
+        :'processed_at' => :'processed_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
       }
     end
 
@@ -137,61 +157,59 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'batch_id' => :'String',
-        :'data_requests' => :'Array<SubmissionDataRequest>',
-        :'editable' => :'Boolean',
-        :'error_message' => :'String',
-        :'expired' => :'Boolean',
-        :'expires_at' => :'String',
         :'id' => :'String',
-        :'json_schema_errors' => :'Array<String>',
-        :'metadata' => :'Object',
-        :'password' => :'String',
-        :'processed_at' => :'String',
-        :'state' => :'String',
         :'template_id' => :'String',
-        :'template_type' => :'String',
+        :'template_type' => :'TemplateType',
         :'template_version' => :'String',
+        :'batch_id' => :'String',
+        :'source' => :'SubmissionSource',
+        :'state' => :'SubmissionState',
         :'test' => :'Boolean',
-        :'truncated_text' => :'Object',
-        :'pdf_hash' => :'String',
-        :'download_url' => :'String',
-        :'permanent_download_url' => :'String',
-        :'preview_download_url' => :'String',
-        :'preview_generated_at' => :'String',
-        :'audit_trail_download_url' => :'String',
+        :'editable' => :'Boolean',
+        :'data' => :'Hash<String, Object>',
+        :'data_errors' => :'Array<ErrorDetail>',
+        :'error_message' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'has_password' => :'Boolean',
+        :'signature_requests' => :'Array<SignatureRequest>',
         :'actions' => :'Array<SubmissionAction>',
-        :'source' => :'String',
-        :'referrer' => :'String',
-        :'data' => :'Object'
+        :'truncated_text' => :'Hash<String, Array<String>>',
+        :'output_formats' => :'Array<OutputFormat>',
+        :'files' => :'SubmissionFiles',
+        :'preview_generated_at' => :'Time',
+        :'expired' => :'Boolean',
+        :'expires_at' => :'Time',
+        :'processed_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'batch_id',
-        :'editable',
-        :'error_message',
-        :'expires_at',
-        :'id',
-        :'json_schema_errors',
-        :'password',
-        :'processed_at',
         :'template_id',
         :'template_version',
+        :'batch_id',
+        :'data',
+        :'error_message',
         :'truncated_text',
-        :'pdf_hash',
-        :'download_url',
-        :'permanent_download_url',
-        :'preview_download_url',
         :'preview_generated_at',
-        :'audit_trail_download_url',
-        :'referrer',
-        :'data'
+        :'expires_at',
+        :'processed_at',
       ])
     end
 
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -208,134 +226,132 @@ module DocSpring
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'batch_id')
-        self.batch_id = attributes[:'batch_id']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       else
-        self.batch_id = nil
+        self.id = nil
       end
 
-      if attributes.key?(:'data_requests')
-        if (value = attributes[:'data_requests']).is_a?(Array)
-          self.data_requests = value
-        end
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
       else
-        self.data_requests = nil
+        self.template_id = nil
       end
 
-      if attributes.key?(:'editable')
-        self.editable = attributes[:'editable']
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
       else
-        self.editable = nil
+        self.template_type = nil
       end
 
-      if attributes.key?(:'error_message')
-        self.error_message = attributes[:'error_message']
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
       else
-        self.error_message = nil
+        self.template_version = nil
       end
 
-      if attributes.key?(:'expired')
-        self.expired = attributes[:'expired']
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
       else
-        self.expired = nil
+        self.batch_id = nil
       end
 
-      if attributes.key?(:'expires_at')
-        self.expires_at = attributes[:'expires_at']
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
       else
-        self.expires_at = nil
+        self.source = nil
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       else
-        self.id = nil
+        self.state = nil
       end
 
-      if attributes.key?(:'json_schema_errors')
-        if (value = attributes[:'json_schema_errors']).is_a?(Array)
-          self.json_schema_errors = value
-        end
+      if attributes.key?(:'test')
+        self.test = attributes[:'test']
       else
-        self.json_schema_errors = nil
+        self.test = nil
       end
 
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.key?(:'editable')
+        self.editable = attributes[:'editable']
       else
-        self.metadata = nil
+        self.editable = nil
       end
 
-      if attributes.key?(:'password')
-        self.password = attributes[:'password']
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Hash) || value.nil?
+          self.data = value
+        end
       else
-        self.password = nil
+        self.data = nil
       end
 
-      if attributes.key?(:'processed_at')
-        self.processed_at = attributes[:'processed_at']
+      if attributes.key?(:'data_errors')
+        if (value = attributes[:'data_errors']).is_a?(Array)
+          self.data_errors = value
+        end
       else
-        self.processed_at = nil
+        self.data_errors = nil
       end
 
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
       else
-        self.state = nil
+        self.error_message = nil
       end
 
-      if attributes.key?(:'template_id')
-        self.template_id = attributes[:'template_id']
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       else
-        self.template_id = nil
+        self.metadata = nil
       end
 
-      if attributes.key?(:'template_type')
-        self.template_type = attributes[:'template_type']
+      if attributes.key?(:'has_password')
+        self.has_password = attributes[:'has_password']
       else
-        self.template_type = nil
+        self.has_password = nil
       end
 
-      if attributes.key?(:'template_version')
-        self.template_version = attributes[:'template_version']
+      if attributes.key?(:'signature_requests')
+        if (value = attributes[:'signature_requests']).is_a?(Array)
+          self.signature_requests = value
+        end
       else
-        self.template_version = nil
+        self.signature_requests = nil
       end
 
-      if attributes.key?(:'test')
-        self.test = attributes[:'test']
+      if attributes.key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
       else
-        self.test = nil
+        self.actions = nil
       end
 
       if attributes.key?(:'truncated_text')
-        self.truncated_text = attributes[:'truncated_text']
+        if (value = attributes[:'truncated_text']).is_a?(Hash) || value.nil?
+          self.truncated_text = value
+        end
       else
         self.truncated_text = nil
       end
 
-      if attributes.key?(:'pdf_hash')
-        self.pdf_hash = attributes[:'pdf_hash']
-      else
-        self.pdf_hash = nil
-      end
-
-      if attributes.key?(:'download_url')
-        self.download_url = attributes[:'download_url']
-      else
-        self.download_url = nil
-      end
-
-      if attributes.key?(:'permanent_download_url')
-        self.permanent_download_url = attributes[:'permanent_download_url']
+      if attributes.key?(:'output_formats')
+        if (value = attributes[:'output_formats']).is_a?(Array)
+          self.output_formats = value
+        end
       else
-        self.permanent_download_url = nil
+        self.output_formats = nil
       end
 
-      if attributes.key?(:'preview_download_url')
-        self.preview_download_url = attributes[:'preview_download_url']
+      if attributes.key?(:'files')
+        self.files = attributes[:'files']
       else
-        self.preview_download_url = nil
+        self.files = nil
       end
 
       if attributes.key?(:'preview_generated_at')
@@ -344,30 +360,34 @@ module DocSpring
         self.preview_generated_at = nil
       end
 
-      if attributes.key?(:'audit_trail_download_url')
-        self.audit_trail_download_url = attributes[:'audit_trail_download_url']
+      if attributes.key?(:'expired')
+        self.expired = attributes[:'expired']
       else
-        self.audit_trail_download_url = nil
+        self.expired = nil
       end
 
-      if attributes.key?(:'actions')
-        if (value = attributes[:'actions']).is_a?(Array)
-          self.actions = value
-        end
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
       else
-        self.actions = nil
+        self.expires_at = nil
       end
 
-      if attributes.key?(:'source')
-        self.source = attributes[:'source']
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      else
+        self.processed_at = nil
       end
 
-      if attributes.key?(:'referrer')
-        self.referrer = attributes[:'referrer']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
       end
     end
 
@@ -376,34 +396,70 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @data_requests.nil?
-        invalid_properties.push('invalid value for "data_requests", data_requests cannot be nil.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @expired.nil?
-        invalid_properties.push('invalid value for "expired", expired cannot be nil.')
+      if @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
       end
 
-      if @metadata.nil?
-        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
       end
 
       if @state.nil?
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
-      if @template_type.nil?
-        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
-      end
-
       if @test.nil?
         invalid_properties.push('invalid value for "test", test cannot be nil.')
       end
 
+      if @editable.nil?
+        invalid_properties.push('invalid value for "editable", editable cannot be nil.')
+      end
+
+      if @data_errors.nil?
+        invalid_properties.push('invalid value for "data_errors", data_errors cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @has_password.nil?
+        invalid_properties.push('invalid value for "has_password", has_password cannot be nil.')
+      end
+
+      if @signature_requests.nil?
+        invalid_properties.push('invalid value for "signature_requests", signature_requests cannot be nil.')
+      end
+
       if @actions.nil?
         invalid_properties.push('invalid value for "actions", actions cannot be nil.')
       end
 
+      if @output_formats.nil?
+        invalid_properties.push('invalid value for "output_formats", output_formats cannot be nil.')
+      end
+
+      if @files.nil?
+        invalid_properties.push('invalid value for "files", files cannot be nil.')
+      end
+
+      if @expired.nil?
+        invalid_properties.push('invalid value for "expired", expired cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -411,72 +467,63 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @data_requests.nil?
-      return false if @expired.nil?
-      return false if @metadata.nil?
-      return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "insufficient_credits", "account_suspended", "license_revoked", "accidental", "declined"])
-      return false unless state_validator.valid?(@state)
+      return false if @id.nil?
       return false if @template_type.nil?
-      template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
-      return false unless template_type_validator.valid?(@template_type)
+      return false if @source.nil?
+      return false if @state.nil?
       return false if @test.nil?
+      return false if @editable.nil?
+      return false if @data_errors.nil?
+      return false if @metadata.nil?
+      return false if @has_password.nil?
+      return false if @signature_requests.nil?
       return false if @actions.nil?
-      source_validator = EnumAttributeValidator.new('String', ["api", "web", "reprocess", "webhook"])
-      return false unless source_validator.valid?(@source)
+      return false if @output_formats.nil?
+      return false if @files.nil?
+      return false if @expired.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] data_requests Value to be assigned
-    def data_requests=(data_requests)
-      if data_requests.nil?
-        fail ArgumentError, 'data_requests cannot be nil'
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
       end
 
-      @data_requests = data_requests
+      @id = id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] expired Value to be assigned
-    def expired=(expired)
-      if expired.nil?
-        fail ArgumentError, 'expired cannot be nil'
+    # @param [Object] template_type Value to be assigned
+    def template_type=(template_type)
+      if template_type.nil?
+        fail ArgumentError, 'template_type cannot be nil'
       end
 
-      @expired = expired
+      @template_type = template_type
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] metadata Value to be assigned
-    def metadata=(metadata)
-      if metadata.nil?
-        fail ArgumentError, 'metadata cannot be nil'
+    # @param [Object] source Value to be assigned
+    def source=(source)
+      if source.nil?
+        fail ArgumentError, 'source cannot be nil'
       end
 
-      @metadata = metadata
+      @source = source
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] state Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "insufficient_credits", "account_suspended", "license_revoked", "accidental", "declined"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(state)
-        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
       end
-      @state = state
-    end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] template_type Object to be assigned
-    def template_type=(template_type)
-      validator = EnumAttributeValidator.new('String', ["pdf", "html"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(template_type)
-        fail ArgumentError, "invalid value for \"template_type\", must be one of #{validator.allowable_values}."
-      end
-      @template_type = template_type
+      @state = state
     end
 
     # Custom attribute writer method with validation
@@ -489,6 +536,56 @@ module DocSpring
       @test = test
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] editable Value to be assigned
+    def editable=(editable)
+      if editable.nil?
+        fail ArgumentError, 'editable cannot be nil'
+      end
+
+      @editable = editable
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data_errors Value to be assigned
+    def data_errors=(data_errors)
+      if data_errors.nil?
+        fail ArgumentError, 'data_errors cannot be nil'
+      end
+
+      @data_errors = data_errors
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_password Value to be assigned
+    def has_password=(has_password)
+      if has_password.nil?
+        fail ArgumentError, 'has_password cannot be nil'
+      end
+
+      @has_password = has_password
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] signature_requests Value to be assigned
+    def signature_requests=(signature_requests)
+      if signature_requests.nil?
+        fail ArgumentError, 'signature_requests cannot be nil'
+      end
+
+      @signature_requests = signature_requests
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] actions Value to be assigned
     def actions=(actions)
@@ -499,15 +596,54 @@ module DocSpring
       @actions = actions
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] source Object to be assigned
-    def source=(source)
-      validator = EnumAttributeValidator.new('String', ["api", "web", "reprocess", "webhook"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(source)
-        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] output_formats Value to be assigned
+    def output_formats=(output_formats)
+      if output_formats.nil?
+        fail ArgumentError, 'output_formats cannot be nil'
       end
-      @source = source
+
+      @output_formats = output_formats
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] files Value to be assigned
+    def files=(files)
+      if files.nil?
+        fail ArgumentError, 'files cannot be nil'
+      end
+
+      @files = files
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expired Value to be assigned
+    def expired=(expired)
+      if expired.nil?
+        fail ArgumentError, 'expired cannot be nil'
+      end
+
+      @expired = expired
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
     end
 
     # Checks equality by comparing each attribute.
@@ -515,33 +651,31 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          batch_id == o.batch_id &&
-          data_requests == o.data_requests &&
-          editable == o.editable &&
-          error_message == o.error_message &&
-          expired == o.expired &&
-          expires_at == o.expires_at &&
           id == o.id &&
-          json_schema_errors == o.json_schema_errors &&
-          metadata == o.metadata &&
-          password == o.password &&
-          processed_at == o.processed_at &&
-          state == o.state &&
           template_id == o.template_id &&
           template_type == o.template_type &&
           template_version == o.template_version &&
+          batch_id == o.batch_id &&
+          source == o.source &&
+          state == o.state &&
           test == o.test &&
+          editable == o.editable &&
+          data == o.data &&
+          data_errors == o.data_errors &&
+          error_message == o.error_message &&
+          metadata == o.metadata &&
+          has_password == o.has_password &&
+          signature_requests == o.signature_requests &&
+          actions == o.actions &&
           truncated_text == o.truncated_text &&
-          pdf_hash == o.pdf_hash &&
-          download_url == o.download_url &&
-          permanent_download_url == o.permanent_download_url &&
-          preview_download_url == o.preview_download_url &&
+          output_formats == o.output_formats &&
+          files == o.files &&
           preview_generated_at == o.preview_generated_at &&
-          audit_trail_download_url == o.audit_trail_download_url &&
-          actions == o.actions &&
-          source == o.source &&
-          referrer == o.referrer &&
-          data == o.data
+          expired == o.expired &&
+          expires_at == o.expires_at &&
+          processed_at == o.processed_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -553,7 +687,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions, source, referrer, data].hash
+      [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash
@@ -562,18 +696,20 @@ module DocSpring
     def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
       transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[map[key]].nil?
           transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[attribute_map[key]].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
         end
       end
       # Responses can include enum values added after this client was released, so the enum setters
@@ -585,69 +721,15 @@ module DocSpring
       end
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = DocSpring.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
 
@@ -656,24 +738,6 @@ module DocSpring
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end