docspring 3.5.0 → 4.0.0

data/lib/docspring/models/{submission_data_request_show.rb → signature_request.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,52 +14,82 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class SubmissionDataRequestShow
+  # A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.
+  class SignatureRequest < ApiModelBase
+    # The signature request's ID.
     attr_accessor :id
 
-    attr_accessor :email
+    # The ID of the submission the signature request belongs to.
+    attr_accessor :submission_id
 
+    # The name of the person the request is for.
     attr_accessor :name
 
-    attr_accessor :order
-
-    attr_accessor :sort_order
+    # Their email address.
+    attr_accessor :email
 
+    # The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have.
     attr_accessor :fields
 
+    # Your own data about the signature request, such as an ID from your app.
     attr_accessor :metadata
 
+    # Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print.
+    attr_accessor :role
+
+    # The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details.
+    attr_accessor :sort_order
+
+    # `pending` until the person completes the signature request (`completed`) or declines it (`declined`).
     attr_accessor :state
 
+    # The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired.
+    attr_accessor :data
+
+    # When the person first opened the signature request.
     attr_accessor :viewed_at
 
+    # When they completed it.
     attr_accessor :completed_at
 
+    # When they declined it.
     attr_accessor :declined_at
 
-    attr_accessor :data
-
+    # How your app authenticated the person before it showed them the signature request.
     attr_accessor :auth_type
 
+    # The second factor your app authenticated them with, if any.
     attr_accessor :auth_second_factor_type
 
+    # The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`.
     attr_accessor :auth_provider
 
+    # When your app authenticated them. Set for you with `email_link`.
     attr_accessor :auth_session_started_at
 
+    # A hash of your app's session ID, for the audit trail.
     attr_accessor :auth_session_id_hash
 
+    # Their user ID in your app, or a SHA-256 hash of a salt and the user ID.
     attr_accessor :auth_user_id_hash
 
+    # Their username in your app, or a SHA-256 hash of a salt and the username.
     attr_accessor :auth_username_hash
 
+    # The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
     attr_accessor :auth_phone_number_hash
 
+    # The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data.
     attr_accessor :ip_address
 
+    # The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data.
     attr_accessor :user_agent
 
-    attr_accessor :submission_id
+    # When the signature request was created.
+    attr_accessor :created_at
+
+    # When the signature request was last updated.
+    attr_accessor :updated_at
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -87,17 +117,18 @@ module DocSpring
     def self.attribute_map
       {
         :'id' => :'id',
-        :'email' => :'email',
+        :'submission_id' => :'submission_id',
         :'name' => :'name',
-        :'order' => :'order',
-        :'sort_order' => :'sort_order',
+        :'email' => :'email',
         :'fields' => :'fields',
         :'metadata' => :'metadata',
+        :'role' => :'role',
+        :'sort_order' => :'sort_order',
         :'state' => :'state',
+        :'data' => :'data',
         :'viewed_at' => :'viewed_at',
         :'completed_at' => :'completed_at',
         :'declined_at' => :'declined_at',
-        :'data' => :'data',
         :'auth_type' => :'auth_type',
         :'auth_second_factor_type' => :'auth_second_factor_type',
         :'auth_provider' => :'auth_provider',
@@ -108,7 +139,8 @@ module DocSpring
         :'auth_phone_number_hash' => :'auth_phone_number_hash',
         :'ip_address' => :'ip_address',
         :'user_agent' => :'user_agent',
-        :'submission_id' => :'submission_id'
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
       }
     end
 
@@ -126,44 +158,43 @@ module DocSpring
     def self.openapi_types
       {
         :'id' => :'String',
-        :'email' => :'String',
+        :'submission_id' => :'String',
         :'name' => :'String',
-        :'order' => :'Integer',
-        :'sort_order' => :'Integer',
+        :'email' => :'String',
         :'fields' => :'Array<String>',
-        :'metadata' => :'Object',
-        :'state' => :'String',
-        :'viewed_at' => :'String',
-        :'completed_at' => :'String',
-        :'declined_at' => :'String',
-        :'data' => :'Object',
-        :'auth_type' => :'String',
-        :'auth_second_factor_type' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'role' => :'String',
+        :'sort_order' => :'Integer',
+        :'state' => :'SignatureRequestState',
+        :'data' => :'Hash<String, Object>',
+        :'viewed_at' => :'Time',
+        :'completed_at' => :'Time',
+        :'declined_at' => :'Time',
+        :'auth_type' => :'SignatureRequestAuthType',
+        :'auth_second_factor_type' => :'SignatureRequestAuthSecondFactorType',
         :'auth_provider' => :'String',
-        :'auth_session_started_at' => :'String',
+        :'auth_session_started_at' => :'Time',
         :'auth_session_id_hash' => :'String',
         :'auth_user_id_hash' => :'String',
         :'auth_username_hash' => :'String',
         :'auth_phone_number_hash' => :'String',
         :'ip_address' => :'String',
         :'user_agent' => :'String',
-        :'submission_id' => :'String'
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id',
-        :'email',
         :'name',
-        :'order',
+        :'email',
         :'fields',
-        :'metadata',
+        :'data',
         :'viewed_at',
         :'completed_at',
         :'declined_at',
-        :'data',
         :'auth_provider',
         :'auth_session_started_at',
         :'auth_session_id_hash',
@@ -172,22 +203,31 @@ module DocSpring
         :'auth_phone_number_hash',
         :'ip_address',
         :'user_agent',
-        :'submission_id'
       ])
     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::SubmissionDataRequestShow` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SignatureRequest` 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::SubmissionDataRequestShow`. 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::SignatureRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -198,10 +238,10 @@ module DocSpring
         self.id = nil
       end
 
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
+      if attributes.key?(:'submission_id')
+        self.submission_id = attributes[:'submission_id']
       else
-        self.email = nil
+        self.submission_id = nil
       end
 
       if attributes.key?(:'name')
@@ -210,20 +250,14 @@ module DocSpring
         self.name = nil
       end
 
-      if attributes.key?(:'order')
-        self.order = attributes[:'order']
-      else
-        self.order = nil
-      end
-
-      if attributes.key?(:'sort_order')
-        self.sort_order = attributes[:'sort_order']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       else
-        self.sort_order = nil
+        self.email = nil
       end
 
       if attributes.key?(:'fields')
-        if (value = attributes[:'fields']).is_a?(Array)
+        if (value = attributes[:'fields']).is_a?(Array) || value.nil?
           self.fields = value
         end
       else
@@ -231,17 +265,39 @@ 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?(:'role')
+        self.role = attributes[:'role']
+      else
+        self.role = nil
+      end
+
+      if attributes.key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      else
+        self.sort_order = nil
+      end
+
       if attributes.key?(:'state')
         self.state = attributes[:'state']
       else
         self.state = nil
       end
 
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Hash) || value.nil?
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
       if attributes.key?(:'viewed_at')
         self.viewed_at = attributes[:'viewed_at']
       else
@@ -260,12 +316,6 @@ module DocSpring
         self.declined_at = nil
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
-      else
-        self.data = nil
-      end
-
       if attributes.key?(:'auth_type')
         self.auth_type = attributes[:'auth_type']
       else
@@ -326,10 +376,16 @@ module DocSpring
         self.user_agent = nil
       end
 
-      if attributes.key?(:'submission_id')
-        self.submission_id = attributes[:'submission_id']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       else
-        self.submission_id = nil
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
       end
     end
 
@@ -338,6 +394,22 @@ 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 @submission_id.nil?
+        invalid_properties.push('invalid value for "submission_id", submission_id cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @role.nil?
+        invalid_properties.push('invalid value for "role", role cannot be nil.')
+      end
+
       if @sort_order.nil?
         invalid_properties.push('invalid value for "sort_order", sort_order cannot be nil.')
       end
@@ -354,6 +426,14 @@ module DocSpring
         invalid_properties.push('invalid value for "auth_second_factor_type", auth_second_factor_type 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
 
@@ -361,19 +441,59 @@ 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 @submission_id.nil?
+      return false if @metadata.nil?
+      return false if @role.nil?
       return false if @sort_order.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "completed", "declined"])
-      return false unless state_validator.valid?(@state)
       return false if @auth_type.nil?
-      auth_type_validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
-      return false unless auth_type_validator.valid?(@auth_type)
       return false if @auth_second_factor_type.nil?
-      auth_second_factor_type_validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
-      return false unless auth_second_factor_type_validator.valid?(@auth_second_factor_type)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
       true
     end
 
+    # 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] submission_id Value to be assigned
+    def submission_id=(submission_id)
+      if submission_id.nil?
+        fail ArgumentError, 'submission_id cannot be nil'
+      end
+
+      @submission_id = submission_id
+    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] role Value to be assigned
+    def role=(role)
+      if role.nil?
+        fail ArgumentError, 'role cannot be nil'
+      end
+
+      @role = role
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] sort_order Value to be assigned
     def sort_order=(sort_order)
@@ -384,56 +504,74 @@ module DocSpring
       @sort_order = sort_order
     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", "completed", "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] auth_type Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] auth_type Value to be assigned
     def auth_type=(auth_type)
-      validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(auth_type)
-        fail ArgumentError, "invalid value for \"auth_type\", must be one of #{validator.allowable_values}."
+      if auth_type.nil?
+        fail ArgumentError, 'auth_type cannot be nil'
       end
+
       @auth_type = auth_type
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] auth_second_factor_type Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] auth_second_factor_type Value to be assigned
     def auth_second_factor_type=(auth_second_factor_type)
-      validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(auth_second_factor_type)
-        fail ArgumentError, "invalid value for \"auth_second_factor_type\", must be one of #{validator.allowable_values}."
+      if auth_second_factor_type.nil?
+        fail ArgumentError, 'auth_second_factor_type cannot be nil'
       end
+
       @auth_second_factor_type = auth_second_factor_type
     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)
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          email == o.email &&
+          submission_id == o.submission_id &&
           name == o.name &&
-          order == o.order &&
-          sort_order == o.sort_order &&
+          email == o.email &&
           fields == o.fields &&
           metadata == o.metadata &&
+          role == o.role &&
+          sort_order == o.sort_order &&
           state == o.state &&
+          data == o.data &&
           viewed_at == o.viewed_at &&
           completed_at == o.completed_at &&
           declined_at == o.declined_at &&
-          data == o.data &&
           auth_type == o.auth_type &&
           auth_second_factor_type == o.auth_second_factor_type &&
           auth_provider == o.auth_provider &&
@@ -444,7 +582,8 @@ module DocSpring
           auth_phone_number_hash == o.auth_phone_number_hash &&
           ip_address == o.ip_address &&
           user_agent == o.user_agent &&
-          submission_id == o.submission_id
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -456,7 +595,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, declined_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id].hash
+      [id, submission_id, name, email, fields, metadata, role, sort_order, state, data, viewed_at, completed_at, declined_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, created_at, updated_at].hash
     end
 
     # Builds the object from hash
@@ -465,18 +604,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
@@ -488,69 +629,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
 
@@ -559,24 +646,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