docspring 3.5.0 → 4.0.0

data/lib/docspring/models/signature_request_auth_second_factor_type.rb

@@ -0,0 +1,45 @@
+=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 SignatureRequestAuthSecondFactorType
+    NONE = "none".freeze
+    PHONE_NUMBER = "phone_number".freeze
+    TOTP = "totp".freeze
+    MOBILE_PUSH = "mobile_push".freeze
+    SECURITY_KEY = "security_key".freeze
+    FINGERPRINT = "fingerprint".freeze
+
+    def self.all_vars
+      @all_vars ||= [NONE, PHONE_NUMBER, TOTP, MOBILE_PUSH, SECURITY_KEY, FINGERPRINT].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_auth_type.rb

@@ -0,0 +1,46 @@
+=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 SignatureRequestAuthType
+    NONE = "none".freeze
+    PASSWORD = "password".freeze
+    OAUTH = "oauth".freeze
+    EMAIL_LINK = "email_link".freeze
+    PHONE_NUMBER = "phone_number".freeze
+    LDAP = "ldap".freeze
+    SAML = "saml".freeze
+
+    def self.all_vars
+      @all_vars ||= [NONE, PASSWORD, OAUTH, EMAIL_LINK, PHONE_NUMBER, LDAP, SAML].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_data_request_event.rb → signature_request_event.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,21 +14,32 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class SubmissionDataRequestEvent
+  # Something that happened to a signature request outside DocSpring, for its audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account.
+  class SignatureRequestEvent < ApiModelBase
+    # The event's ID.
     attr_accessor :id
 
+    # The ID of the signature request's submission.
     attr_accessor :submission_id
 
-    attr_accessor :submission_data_request_id
+    # The ID of the signature request.
+    attr_accessor :signature_request_id
 
+    # What happened.
     attr_accessor :event_type
 
+    # How you sent the request. Required for `send_request`.
     attr_accessor :message_type
 
+    # Where you sent the request, such as an email address or a phone number. Required for `send_request`.
     attr_accessor :message_recipient
 
+    # When it happened. Default now.
     attr_accessor :occurred_at
 
+    # When the event was recorded.
+    attr_accessor :created_at
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -56,11 +67,12 @@ module DocSpring
       {
         :'id' => :'id',
         :'submission_id' => :'submission_id',
-        :'submission_data_request_id' => :'submission_data_request_id',
+        :'signature_request_id' => :'signature_request_id',
         :'event_type' => :'event_type',
         :'message_type' => :'message_type',
         :'message_recipient' => :'message_recipient',
-        :'occurred_at' => :'occurred_at'
+        :'occurred_at' => :'occurred_at',
+        :'created_at' => :'created_at'
       }
     end
 
@@ -79,38 +91,45 @@ module DocSpring
       {
         :'id' => :'String',
         :'submission_id' => :'String',
-        :'submission_data_request_id' => :'String',
-        :'event_type' => :'String',
-        :'message_type' => :'String',
+        :'signature_request_id' => :'String',
+        :'event_type' => :'SignatureRequestEventType',
+        :'message_type' => :'SignatureRequestMessageType',
         :'message_recipient' => :'String',
-        :'occurred_at' => :'String'
+        :'occurred_at' => :'Time',
+        :'created_at' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id',
-        :'submission_id',
-        :'submission_data_request_id',
         :'message_type',
         :'message_recipient',
-        :'occurred_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 = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SubmissionDataRequestEvent` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SignatureRequestEvent` 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::SubmissionDataRequestEvent`. 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::SignatureRequestEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -127,10 +146,10 @@ module DocSpring
         self.submission_id = nil
       end
 
-      if attributes.key?(:'submission_data_request_id')
-        self.submission_data_request_id = attributes[:'submission_data_request_id']
+      if attributes.key?(:'signature_request_id')
+        self.signature_request_id = attributes[:'signature_request_id']
       else
-        self.submission_data_request_id = nil
+        self.signature_request_id = nil
       end
 
       if attributes.key?(:'event_type')
@@ -156,6 +175,12 @@ module DocSpring
       else
         self.occurred_at = nil
       end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -163,10 +188,30 @@ 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 @signature_request_id.nil?
+        invalid_properties.push('invalid value for "signature_request_id", signature_request_id cannot be nil.')
+      end
+
       if @event_type.nil?
         invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
       end
 
+      if @occurred_at.nil?
+        invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -174,34 +219,73 @@ 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 @signature_request_id.nil?
       return false if @event_type.nil?
-      event_type_validator = EnumAttributeValidator.new('String', ["send_request", "view_request", "accepted_terms", "decline_request", "sign_request", "all_completed"])
-      return false unless event_type_validator.valid?(@event_type)
-      message_type_validator = EnumAttributeValidator.new('String', ["email", "sms", "fax", "mail", "slack", "msteams", "discord", "telegram", "whatsapp"])
-      return false unless message_type_validator.valid?(@message_type)
+      return false if @occurred_at.nil?
+      return false if @created_at.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] event_type 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] 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] signature_request_id Value to be assigned
+    def signature_request_id=(signature_request_id)
+      if signature_request_id.nil?
+        fail ArgumentError, 'signature_request_id cannot be nil'
+      end
+
+      @signature_request_id = signature_request_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_type Value to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ["send_request", "view_request", "accepted_terms", "decline_request", "sign_request", "all_completed"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(event_type)
-        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      if event_type.nil?
+        fail ArgumentError, 'event_type cannot be nil'
       end
+
       @event_type = event_type
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] message_type Object to be assigned
-    def message_type=(message_type)
-      validator = EnumAttributeValidator.new('String', ["email", "sms", "fax", "mail", "slack", "msteams", "discord", "telegram", "whatsapp"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(message_type)
-        fail ArgumentError, "invalid value for \"message_type\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] occurred_at Value to be assigned
+    def occurred_at=(occurred_at)
+      if occurred_at.nil?
+        fail ArgumentError, 'occurred_at cannot be nil'
       end
-      @message_type = message_type
+
+      @occurred_at = occurred_at
+    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
 
     # Checks equality by comparing each attribute.
@@ -211,11 +295,12 @@ module DocSpring
       self.class == o.class &&
           id == o.id &&
           submission_id == o.submission_id &&
-          submission_data_request_id == o.submission_data_request_id &&
+          signature_request_id == o.signature_request_id &&
           event_type == o.event_type &&
           message_type == o.message_type &&
           message_recipient == o.message_recipient &&
-          occurred_at == o.occurred_at
+          occurred_at == o.occurred_at &&
+          created_at == o.created_at
     end
 
     # @see the `==` method
@@ -227,7 +312,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, submission_id, submission_data_request_id, event_type, message_type, message_recipient, occurred_at].hash
+      [id, submission_id, signature_request_id, event_type, message_type, message_recipient, occurred_at, created_at].hash
     end
 
     # Builds the object from hash
@@ -236,18 +321,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
@@ -259,69 +346,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
 
@@ -330,24 +363,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_event_type.rb

@@ -0,0 +1,45 @@
+=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 SignatureRequestEventType
+    SEND_REQUEST = "send_request".freeze
+    VIEW_REQUEST = "view_request".freeze
+    ACCEPTED_TERMS = "accepted_terms".freeze
+    DECLINE_REQUEST = "decline_request".freeze
+    SIGN_REQUEST = "sign_request".freeze
+    ALL_COMPLETED = "all_completed".freeze
+
+    def self.all_vars
+      @all_vars ||= [SEND_REQUEST, VIEW_REQUEST, ACCEPTED_TERMS, DECLINE_REQUEST, SIGN_REQUEST, ALL_COMPLETED].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