docspring 3.5.0 → 4.0.0

data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.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,32 +14,52 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class UpdateSubmissionDataRequestData
-    attr_accessor :auth_phone_number_hash
+  # 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 SignatureRequestInput < ApiModelBase
+    # The name of the person the request is for.
+    attr_accessor :name
 
-    attr_accessor :auth_provider
+    # Their email address.
+    attr_accessor :email
+
+    # The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`.
+    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: `Signer 1`, `Signer 2` and so on, up to `Signer 100`, until templates have roles of their own. Either every signature request has a `role` or none does, and each role can only have one.
+    attr_accessor :role
+
+    # 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
 
-    attr_accessor :auth_session_id_hash
+    # 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
 
-    attr_accessor :auth_type
+    # 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
 
-    attr_accessor :email
-
-    attr_accessor :fields
-
-    attr_accessor :metadata
+    # The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
+    attr_accessor :auth_phone_number_hash
 
-    attr_accessor :name
+    # Leave out names in `fields` that the template doesn't have, for one field list that you send with several templates. Without it, an unknown name makes the submission `invalid_data`.
+    attr_accessor :ignore_unknown_fields
 
-    attr_accessor :order
+    # Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422.
+    attr_accessor :prefilled_values_editable
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -66,19 +86,21 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'auth_phone_number_hash' => :'auth_phone_number_hash',
-        :'auth_provider' => :'auth_provider',
+        :'name' => :'name',
+        :'email' => :'email',
+        :'fields' => :'fields',
+        :'metadata' => :'metadata',
+        :'role' => :'role',
+        :'auth_type' => :'auth_type',
         :'auth_second_factor_type' => :'auth_second_factor_type',
-        :'auth_session_id_hash' => :'auth_session_id_hash',
+        :'auth_provider' => :'auth_provider',
         :'auth_session_started_at' => :'auth_session_started_at',
-        :'auth_type' => :'auth_type',
+        :'auth_session_id_hash' => :'auth_session_id_hash',
         :'auth_user_id_hash' => :'auth_user_id_hash',
         :'auth_username_hash' => :'auth_username_hash',
-        :'email' => :'email',
-        :'fields' => :'fields',
-        :'metadata' => :'metadata',
-        :'name' => :'name',
-        :'order' => :'order'
+        :'auth_phone_number_hash' => :'auth_phone_number_hash',
+        :'ignore_unknown_fields' => :'ignore_unknown_fields',
+        :'prefilled_values_editable' => :'prefilled_values_editable'
       }
     end
 
@@ -95,75 +117,110 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'auth_phone_number_hash' => :'String',
+        :'name' => :'String',
+        :'email' => :'String',
+        :'fields' => :'Array<String>',
+        :'metadata' => :'Hash<String, Object>',
+        :'role' => :'String',
+        :'auth_type' => :'SignatureRequestAuthType',
+        :'auth_second_factor_type' => :'SignatureRequestAuthSecondFactorType',
         :'auth_provider' => :'String',
-        :'auth_second_factor_type' => :'String',
+        :'auth_session_started_at' => :'Time',
         :'auth_session_id_hash' => :'String',
-        :'auth_session_started_at' => :'String',
-        :'auth_type' => :'String',
         :'auth_user_id_hash' => :'String',
         :'auth_username_hash' => :'String',
-        :'email' => :'String',
-        :'fields' => :'Array<String>',
-        :'metadata' => :'Object',
-        :'name' => :'String',
-        :'order' => :'Integer'
+        :'auth_phone_number_hash' => :'String',
+        :'ignore_unknown_fields' => :'Boolean',
+        :'prefilled_values_editable' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'auth_phone_number_hash',
+        :'name',
+        :'email',
         :'auth_provider',
-        :'auth_second_factor_type',
-        :'auth_session_id_hash',
         :'auth_session_started_at',
+        :'auth_session_id_hash',
         :'auth_user_id_hash',
         :'auth_username_hash',
-        :'email',
-        :'name',
+        :'auth_phone_number_hash',
       ])
     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::UpdateSubmissionDataRequestData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SignatureRequestInput` 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::UpdateSubmissionDataRequestData`. 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::SignatureRequestInput`. 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?(:'auth_phone_number_hash')
-        self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'auth_provider')
-        self.auth_provider = attributes[:'auth_provider']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      else
+        self.fields = nil
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.key?(:'auth_type')
+        self.auth_type = attributes[:'auth_type']
+      else
+        self.auth_type = nil
       end
 
       if attributes.key?(:'auth_second_factor_type')
         self.auth_second_factor_type = attributes[:'auth_second_factor_type']
       end
 
-      if attributes.key?(:'auth_session_id_hash')
-        self.auth_session_id_hash = attributes[:'auth_session_id_hash']
+      if attributes.key?(:'auth_provider')
+        self.auth_provider = attributes[:'auth_provider']
       end
 
       if attributes.key?(:'auth_session_started_at')
         self.auth_session_started_at = attributes[:'auth_session_started_at']
       end
 
-      if attributes.key?(:'auth_type')
-        self.auth_type = attributes[:'auth_type']
+      if attributes.key?(:'auth_session_id_hash')
+        self.auth_session_id_hash = attributes[:'auth_session_id_hash']
       end
 
       if attributes.key?(:'auth_user_id_hash')
@@ -174,26 +231,16 @@ module DocSpring
         self.auth_username_hash = attributes[:'auth_username_hash']
       end
 
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
-      end
-
-      if attributes.key?(:'fields')
-        if (value = attributes[:'fields']).is_a?(Array)
-          self.fields = value
-        end
-      end
-
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.key?(:'auth_phone_number_hash')
+        self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'ignore_unknown_fields')
+        self.ignore_unknown_fields = attributes[:'ignore_unknown_fields']
       end
 
-      if attributes.key?(:'order')
-        self.order = attributes[:'order']
+      if attributes.key?(:'prefilled_values_editable')
+        self.prefilled_values_editable = attributes[:'prefilled_values_editable']
       end
     end
 
@@ -202,6 +249,14 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @fields.nil?
+        invalid_properties.push('invalid value for "fields", fields cannot be nil.')
+      end
+
+      if @auth_type.nil?
+        invalid_properties.push('invalid value for "auth_type", auth_type cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -209,32 +264,28 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      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)
-      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 @fields.nil?
+      return false if @auth_type.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] auth_second_factor_type Object 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}."
+    # Custom attribute writer method with validation
+    # @param [Object] fields Value to be assigned
+    def fields=(fields)
+      if fields.nil?
+        fail ArgumentError, 'fields cannot be nil'
       end
-      @auth_second_factor_type = auth_second_factor_type
+
+      @fields = fields
     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
 
@@ -243,19 +294,21 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          auth_phone_number_hash == o.auth_phone_number_hash &&
-          auth_provider == o.auth_provider &&
+          name == o.name &&
+          email == o.email &&
+          fields == o.fields &&
+          metadata == o.metadata &&
+          role == o.role &&
+          auth_type == o.auth_type &&
           auth_second_factor_type == o.auth_second_factor_type &&
-          auth_session_id_hash == o.auth_session_id_hash &&
+          auth_provider == o.auth_provider &&
           auth_session_started_at == o.auth_session_started_at &&
-          auth_type == o.auth_type &&
+          auth_session_id_hash == o.auth_session_id_hash &&
           auth_user_id_hash == o.auth_user_id_hash &&
           auth_username_hash == o.auth_username_hash &&
-          email == o.email &&
-          fields == o.fields &&
-          metadata == o.metadata &&
-          name == o.name &&
-          order == o.order
+          auth_phone_number_hash == o.auth_phone_number_hash &&
+          ignore_unknown_fields == o.ignore_unknown_fields &&
+          prefilled_values_editable == o.prefilled_values_editable
     end
 
     # @see the `==` method
@@ -267,7 +320,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auth_phone_number_hash, auth_provider, auth_second_factor_type, auth_session_id_hash, auth_session_started_at, auth_type, auth_user_id_hash, auth_username_hash, email, fields, metadata, name, order].hash
+      [name, email, fields, metadata, role, 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, ignore_unknown_fields, prefilled_values_editable].hash
     end
 
     # Builds the object from hash
@@ -276,18 +329,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
@@ -299,69 +354,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
 
@@ -370,24 +371,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/signature_request_message_type.rb

@@ -0,0 +1,48 @@
+=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 SignatureRequestMessageType
+    EMAIL = "email".freeze
+    SMS = "sms".freeze
+    FAX = "fax".freeze
+    MAIL = "mail".freeze
+    SLACK = "slack".freeze
+    MSTEAMS = "msteams".freeze
+    DISCORD = "discord".freeze
+    TELEGRAM = "telegram".freeze
+    WHATSAPP = "whatsapp".freeze
+
+    def self.all_vars
+      @all_vars ||= [EMAIL, SMS, FAX, MAIL, SLACK, MSTEAMS, DISCORD, TELEGRAM, WHATSAPP].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/signature_request_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 SignatureRequestState
+    PENDING = "pending".freeze
+    COMPLETED = "completed".freeze
+    DECLINED = "declined".freeze
+
+    def self.all_vars
+      @all_vars ||= [PENDING, COMPLETED, DECLINED].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