docspring 3.5.0 → 4.0.0

data/lib/docspring/models/submission_batch.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,23 +14,41 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class SubmissionBatch
+  # Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
+  class SubmissionBatch < ApiModelBase
+    # The batch's ID.
     attr_accessor :id
 
+    # `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
     attr_accessor :state
 
+    # Your own data about the batch, such as an ID from your app.
     attr_accessor :metadata
 
-    attr_accessor :processed_at
-
+    # The number of submissions in the request.
     attr_accessor :total_count
 
+    # The submissions whose PDFs haven't been generated yet.
     attr_accessor :pending_count
 
+    # The submissions that were invalid or whose PDFs couldn't be generated.
     attr_accessor :error_count
 
+    # The percentage of the batch's submissions that have finished, from 0 to 100.
     attr_accessor :completion_percentage
 
+    # The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
+    attr_accessor :submissions
+
+    # When every submission had finished.
+    attr_accessor :processed_at
+
+    # When the batch was created.
+    attr_accessor :created_at
+
+    # When the batch was last updated.
+    attr_accessor :updated_at
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -59,11 +77,14 @@ module DocSpring
         :'id' => :'id',
         :'state' => :'state',
         :'metadata' => :'metadata',
-        :'processed_at' => :'processed_at',
         :'total_count' => :'total_count',
         :'pending_count' => :'pending_count',
         :'error_count' => :'error_count',
-        :'completion_percentage' => :'completion_percentage'
+        :'completion_percentage' => :'completion_percentage',
+        :'submissions' => :'submissions',
+        :'processed_at' => :'processed_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
       }
     end
 
@@ -81,24 +102,36 @@ module DocSpring
     def self.openapi_types
       {
         :'id' => :'String',
-        :'state' => :'String',
-        :'metadata' => :'Object',
-        :'processed_at' => :'String',
+        :'state' => :'SubmissionBatchState',
+        :'metadata' => :'Hash<String, Object>',
         :'total_count' => :'Integer',
         :'pending_count' => :'Integer',
         :'error_count' => :'Integer',
-        :'completion_percentage' => :'Float'
+        :'completion_percentage' => :'Integer',
+        :'submissions' => :'Array<Submission>',
+        :'processed_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id',
         :'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 = {})
@@ -128,17 +161,13 @@ module DocSpring
       end
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       else
         self.metadata = nil
       end
 
-      if attributes.key?(:'processed_at')
-        self.processed_at = attributes[:'processed_at']
-      else
-        self.processed_at = nil
-      end
-
       if attributes.key?(:'total_count')
         self.total_count = attributes[:'total_count']
       else
@@ -162,6 +191,32 @@ module DocSpring
       else
         self.completion_percentage = nil
       end
+
+      if attributes.key?(:'submissions')
+        if (value = attributes[:'submissions']).is_a?(Array)
+          self.submissions = value
+        end
+      else
+        self.submissions = nil
+      end
+
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      else
+        self.processed_at = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -169,6 +224,10 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
       if @state.nil?
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
@@ -193,6 +252,18 @@ module DocSpring
         invalid_properties.push('invalid value for "completion_percentage", completion_percentage cannot be nil.')
       end
 
+      if @submissions.nil?
+        invalid_properties.push('invalid value for "submissions", submissions 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
 
@@ -200,25 +271,36 @@ 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"])
-      return false unless state_validator.valid?(@state)
       return false if @metadata.nil?
       return false if @total_count.nil?
       return false if @pending_count.nil?
       return false if @error_count.nil?
       return false if @completion_percentage.nil?
+      return false if @submissions.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
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
-      # 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
 
@@ -272,6 +354,36 @@ module DocSpring
       @completion_percentage = completion_percentage
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] submissions Value to be assigned
+    def submissions=(submissions)
+      if submissions.nil?
+        fail ArgumentError, 'submissions cannot be nil'
+      end
+
+      @submissions = submissions
+    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)
@@ -280,11 +392,14 @@ module DocSpring
           id == o.id &&
           state == o.state &&
           metadata == o.metadata &&
-          processed_at == o.processed_at &&
           total_count == o.total_count &&
           pending_count == o.pending_count &&
           error_count == o.error_count &&
-          completion_percentage == o.completion_percentage
+          completion_percentage == o.completion_percentage &&
+          submissions == o.submissions &&
+          processed_at == o.processed_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -296,7 +411,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage].hash
+      [id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash
@@ -305,18 +420,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
@@ -328,69 +445,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
 
@@ -399,24 +462,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

data/lib/docspring/models/submission_batch_state.rb

@@ -0,0 +1,42 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class SubmissionBatchState
+    PENDING = "pending".freeze
+    PROCESSED = "processed".freeze
+    ERROR = "error".freeze
+
+    def self.all_vars
+      @all_vars ||= [PENDING, PROCESSED, ERROR].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
+      # is: the constants are the values this client knows
+      value
+    end
+  end
+end

data/lib/docspring/models/submission_files.rb

@@ -0,0 +1,188 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  # A submission's generated files. Each one is left out until it exists.
+  class SubmissionFiles < ApiModelBase
+    # The submission's PDF.
+    attr_accessor :pdf
+
+    # The audit trail of a submission with signature requests: who signed, when and how. It's also added to the end of the PDF when the template's `merge_audit_trail_pdf` is on.
+    attr_accessor :audit_trail
+
+    # The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests.
+    attr_accessor :preview
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pdf' => :'pdf',
+        :'audit_trail' => :'audit_trail',
+        :'preview' => :'preview'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pdf' => :'GeneratedFile',
+        :'audit_trail' => :'GeneratedFile',
+        :'preview' => :'GeneratedFile'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SubmissionFiles` 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::SubmissionFiles`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'pdf')
+        self.pdf = attributes[:'pdf']
+      end
+
+      if attributes.key?(:'audit_trail')
+        self.audit_trail = attributes[:'audit_trail']
+      end
+
+      if attributes.key?(:'preview')
+        self.preview = attributes[:'preview']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pdf == o.pdf &&
+          audit_trail == o.audit_trail &&
+          preview == o.preview
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [pdf, audit_trail, preview].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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 = {}
+      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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        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
+      # accept any value while the model is built from a response
+      allocate.tap do |model|
+        model.instance_variable_set(:@_skip_enum_validation, true)
+        model.send(:initialize, transformed_hash)
+        model.remove_instance_variable(:@_skip_enum_validation)
+      end
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # 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.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end