docspring 3.5.0 → 4.0.0

data/lib/docspring/models/{combined_submission.rb → combined_pdf.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,34 +14,49 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class CombinedSubmission
+  # A PDF made by merging other PDFs: submissions, other combined PDFs, templates, custom files and PDFs from URLs.
+  class CombinedPdf < ApiModelBase
+    # The combined PDF's ID.
     attr_accessor :id
 
+    # `pending` until the PDF has been generated, then `processed`. `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. `error`: the PDFs couldn't be merged (see `error_message`). Waiting ends in `error` if it's discarded or takes over 30 days.
     attr_accessor :state
 
-    attr_accessor :expired
+    # The PDFs to merge, in order.
+    attr_accessor :source_pdfs
 
-    attr_accessor :expires_in
+    # Your own data about the combined PDF, such as an ID from your app.
+    attr_accessor :metadata
 
-    attr_accessor :expires_at
+    # Whether the PDF needs a password to open (`password`).
+    attr_accessor :has_password
 
-    attr_accessor :processed_at
+    # Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files.
+    attr_accessor :delete_custom_files
 
+    # Why the PDFs couldn't be merged, when `state` is `error`.
     attr_accessor :error_message
 
-    attr_accessor :submission_ids
+    # The generated files, by format. Empty until the PDF has been generated, and once it has expired.
+    attr_accessor :files
 
-    attr_accessor :source_pdfs
+    # The uploads of the PDF to your storage (account integrations).
+    attr_accessor :actions
 
-    attr_accessor :metadata
+    # An expired combined PDF's PDF, metadata, password and source URLs have been deleted.
+    attr_accessor :expired
 
-    attr_accessor :password
+    # When the combined PDF expires (`expires_in` after it's generated). Null if it's kept until you delete it.
+    attr_accessor :expires_at
 
-    attr_accessor :pdf_hash
+    # When the PDF was generated. Null until then.
+    attr_accessor :processed_at
 
-    attr_accessor :download_url
+    # When the combined PDF was created.
+    attr_accessor :created_at
 
-    attr_accessor :actions
+    # When the combined PDF was last updated.
+    attr_accessor :updated_at
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -70,18 +85,18 @@ module DocSpring
       {
         :'id' => :'id',
         :'state' => :'state',
+        :'source_pdfs' => :'source_pdfs',
+        :'metadata' => :'metadata',
+        :'has_password' => :'has_password',
+        :'delete_custom_files' => :'delete_custom_files',
+        :'error_message' => :'error_message',
+        :'files' => :'files',
+        :'actions' => :'actions',
         :'expired' => :'expired',
-        :'expires_in' => :'expires_in',
         :'expires_at' => :'expires_at',
         :'processed_at' => :'processed_at',
-        :'error_message' => :'error_message',
-        :'submission_ids' => :'submission_ids',
-        :'source_pdfs' => :'source_pdfs',
-        :'metadata' => :'metadata',
-        :'password' => :'password',
-        :'pdf_hash' => :'pdf_hash',
-        :'download_url' => :'download_url',
-        :'actions' => :'actions'
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
       }
     end
 
@@ -99,48 +114,53 @@ module DocSpring
     def self.openapi_types
       {
         :'id' => :'String',
-        :'state' => :'String',
-        :'expired' => :'Boolean',
-        :'expires_in' => :'Integer',
-        :'expires_at' => :'String',
-        :'processed_at' => :'String',
+        :'state' => :'CombinedPdfState',
+        :'source_pdfs' => :'Array<CombinedPdfSource>',
+        :'metadata' => :'Hash<String, Object>',
+        :'has_password' => :'Boolean',
+        :'delete_custom_files' => :'Boolean',
         :'error_message' => :'String',
-        :'submission_ids' => :'Array<String>',
-        :'source_pdfs' => :'Array<Object>',
-        :'metadata' => :'Object',
-        :'password' => :'String',
-        :'pdf_hash' => :'String',
-        :'download_url' => :'String',
-        :'actions' => :'Array<CombinedSubmissionAction>'
+        :'files' => :'CombinedPdfFiles',
+        :'actions' => :'Array<SubmissionAction>',
+        :'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([
-        :'id',
-        :'expires_in',
+        :'error_message',
         :'expires_at',
         :'processed_at',
-        :'error_message',
-        :'password',
-        :'pdf_hash',
-        :'download_url',
       ])
     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 = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::CombinedSubmission` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::CombinedPdf` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::CombinedSubmission`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::CombinedPdf`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -157,28 +177,32 @@ module DocSpring
         self.state = nil
       end
 
-      if attributes.key?(:'expired')
-        self.expired = attributes[:'expired']
+      if attributes.key?(:'source_pdfs')
+        if (value = attributes[:'source_pdfs']).is_a?(Array)
+          self.source_pdfs = value
+        end
       else
-        self.expired = nil
+        self.source_pdfs = nil
       end
 
-      if attributes.key?(:'expires_in')
-        self.expires_in = attributes[:'expires_in']
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       else
-        self.expires_in = nil
+        self.metadata = nil
       end
 
-      if attributes.key?(:'expires_at')
-        self.expires_at = attributes[:'expires_at']
+      if attributes.key?(:'has_password')
+        self.has_password = attributes[:'has_password']
       else
-        self.expires_at = nil
+        self.has_password = nil
       end
 
-      if attributes.key?(:'processed_at')
-        self.processed_at = attributes[:'processed_at']
+      if attributes.key?(:'delete_custom_files')
+        self.delete_custom_files = attributes[:'delete_custom_files']
       else
-        self.processed_at = nil
+        self.delete_custom_files = nil
       end
 
       if attributes.key?(:'error_message')
@@ -187,52 +211,48 @@ module DocSpring
         self.error_message = nil
       end
 
-      if attributes.key?(:'submission_ids')
-        if (value = attributes[:'submission_ids']).is_a?(Array)
-          self.submission_ids = value
-        end
+      if attributes.key?(:'files')
+        self.files = attributes[:'files']
       else
-        self.submission_ids = nil
+        self.files = nil
       end
 
-      if attributes.key?(:'source_pdfs')
-        if (value = attributes[:'source_pdfs']).is_a?(Array)
-          self.source_pdfs = value
+      if attributes.key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
         end
       else
-        self.source_pdfs = nil
+        self.actions = nil
       end
 
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.key?(:'expired')
+        self.expired = attributes[:'expired']
       else
-        self.metadata = nil
+        self.expired = nil
       end
 
-      if attributes.key?(:'password')
-        self.password = attributes[:'password']
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
       else
-        self.password = nil
+        self.expires_at = nil
       end
 
-      if attributes.key?(:'pdf_hash')
-        self.pdf_hash = attributes[:'pdf_hash']
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
       else
-        self.pdf_hash = nil
+        self.processed_at = nil
       end
 
-      if attributes.key?(:'download_url')
-        self.download_url = attributes[:'download_url']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       else
-        self.download_url = nil
+        self.created_at = nil
       end
 
-      if attributes.key?(:'actions')
-        if (value = attributes[:'actions']).is_a?(Array)
-          self.actions = value
-        end
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       else
-        self.actions = nil
+        self.updated_at = nil
       end
     end
 
@@ -241,16 +261,12 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @state.nil?
-        invalid_properties.push('invalid value for "state", state cannot be nil.')
-      end
-
-      if @expired.nil?
-        invalid_properties.push('invalid value for "expired", expired cannot be nil.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @submission_ids.nil?
-        invalid_properties.push('invalid value for "submission_ids", submission_ids cannot be nil.')
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
       if @source_pdfs.nil?
@@ -261,10 +277,34 @@ module DocSpring
         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 @delete_custom_files.nil?
+        invalid_properties.push('invalid value for "delete_custom_files", delete_custom_files cannot be nil.')
+      end
+
+      if @files.nil?
+        invalid_properties.push('invalid value for "files", files cannot be nil.')
+      end
+
       if @actions.nil?
         invalid_properties.push('invalid value for "actions", actions 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
 
@@ -272,46 +312,38 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error", "insufficient_credits"])
-      return false unless state_validator.valid?(@state)
-      return false if @expired.nil?
-      return false if @submission_ids.nil?
       return false if @source_pdfs.nil?
       return false if @metadata.nil?
+      return false if @has_password.nil?
+      return false if @delete_custom_files.nil?
+      return false if @files.nil?
       return false if @actions.nil?
+      return false if @expired.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] state Object to be assigned
-    def state=(state)
-      validator = EnumAttributeValidator.new('String', ["pending", "processed", "error", "insufficient_credits"])
-      # 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}."
-      end
-      @state = state
-    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] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
       end
 
-      @expired = expired
+      @id = id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] submission_ids Value to be assigned
-    def submission_ids=(submission_ids)
-      if submission_ids.nil?
-        fail ArgumentError, 'submission_ids cannot be nil'
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
       end
 
-      @submission_ids = submission_ids
+      @state = state
     end
 
     # Custom attribute writer method with validation
@@ -334,6 +366,36 @@ module DocSpring
       @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] delete_custom_files Value to be assigned
+    def delete_custom_files=(delete_custom_files)
+      if delete_custom_files.nil?
+        fail ArgumentError, 'delete_custom_files cannot be nil'
+      end
+
+      @delete_custom_files = delete_custom_files
+    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] actions Value to be assigned
     def actions=(actions)
@@ -344,6 +406,36 @@ module DocSpring
       @actions = actions
     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.
     # @param [Object] Object to be compared
     def ==(o)
@@ -351,18 +443,18 @@ module DocSpring
       self.class == o.class &&
           id == o.id &&
           state == o.state &&
+          source_pdfs == o.source_pdfs &&
+          metadata == o.metadata &&
+          has_password == o.has_password &&
+          delete_custom_files == o.delete_custom_files &&
+          error_message == o.error_message &&
+          files == o.files &&
+          actions == o.actions &&
           expired == o.expired &&
-          expires_in == o.expires_in &&
           expires_at == o.expires_at &&
           processed_at == o.processed_at &&
-          error_message == o.error_message &&
-          submission_ids == o.submission_ids &&
-          source_pdfs == o.source_pdfs &&
-          metadata == o.metadata &&
-          password == o.password &&
-          pdf_hash == o.pdf_hash &&
-          download_url == o.download_url &&
-          actions == o.actions
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -374,7 +466,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, state, expired, expires_in, expires_at, processed_at, error_message, submission_ids, source_pdfs, metadata, password, pdf_hash, download_url, actions].hash
+      [id, state, source_pdfs, metadata, has_password, delete_custom_files, error_message, files, actions, expired, expires_at, processed_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash
@@ -383,18 +475,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
@@ -406,69 +500,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
 
@@ -477,24 +517,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