dropbox-sign 1.6.1 → 1.8.0

data/lib/dropbox-sign/models/fax_send_request.rb

@@ -0,0 +1,345 @@
+=begin
+#Dropbox Sign API
+
+#Dropbox Sign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  class FaxSendRequest
+    # Fax Send To Recipient
+    # @return [String]
+    attr_accessor :recipient
+
+    # Fax Send From Sender (used only with fax number)
+    # @return [String]
+    attr_accessor :sender
+
+    # Fax File to Send
+    # @return [Array<File>]
+    attr_accessor :files
+
+    # Fax File URL to Send
+    # @return [Array<String>]
+    attr_accessor :file_urls
+
+    # API Test Mode Setting
+    # @return [Boolean]
+    attr_accessor :test_mode
+
+    # Fax Cover Page for Recipient
+    # @return [String]
+    attr_accessor :cover_page_to
+
+    # Fax Cover Page for Sender
+    # @return [String]
+    attr_accessor :cover_page_from
+
+    # Fax Cover Page Message
+    # @return [String]
+    attr_accessor :cover_page_message
+
+    # Fax Title
+    # @return [String]
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'recipient' => :'recipient',
+        :'sender' => :'sender',
+        :'files' => :'files',
+        :'file_urls' => :'file_urls',
+        :'test_mode' => :'test_mode',
+        :'cover_page_to' => :'cover_page_to',
+        :'cover_page_from' => :'cover_page_from',
+        :'cover_page_message' => :'cover_page_message',
+        :'title' => :'title'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'recipient' => :'String',
+        :'sender' => :'String',
+        :'files' => :'Array<File>',
+        :'file_urls' => :'Array<String>',
+        :'test_mode' => :'Boolean',
+        :'cover_page_to' => :'String',
+        :'cover_page_from' => :'String',
+        :'cover_page_message' => :'String',
+        :'title' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
+    # Returns list of attributes with nullable: true of this model + parent
+    def self.merged_nullable
+      self.openapi_nullable
+    end
+
+    # Attempt to instantiate and hydrate a new instance of this class
+    # @param [Object] data Data to be converted
+    # @return [FaxSendRequest]
+    def self.init(data)
+      ApiClient.default.convert_to_type(
+        data,
+        "FaxSendRequest"
+      ) || FaxSendRequest.new
+    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 `Dropbox::Sign::FaxSendRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.merged_attributes.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxSendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'recipient')
+        self.recipient = attributes[:'recipient']
+      end
+
+      if attributes.key?(:'sender')
+        self.sender = attributes[:'sender']
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'file_urls')
+        if (value = attributes[:'file_urls']).is_a?(Array)
+          self.file_urls = value
+        end
+      end
+
+      if attributes.key?(:'test_mode')
+        self.test_mode = attributes[:'test_mode']
+      else
+        self.test_mode = false
+      end
+
+      if attributes.key?(:'cover_page_to')
+        self.cover_page_to = attributes[:'cover_page_to']
+      end
+
+      if attributes.key?(:'cover_page_from')
+        self.cover_page_from = attributes[:'cover_page_from']
+      end
+
+      if attributes.key?(:'cover_page_message')
+        self.cover_page_message = attributes[:'cover_page_message']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      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
+      invalid_properties = Array.new
+      if @recipient.nil?
+        invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
+      end
+
+      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?
+      return false if @recipient.nil?
+      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 &&
+          recipient == o.recipient &&
+          sender == o.sender &&
+          files == o.files &&
+          file_urls == o.file_urls &&
+          test_mode == o.test_mode &&
+          cover_page_to == o.cover_page_to &&
+          cover_page_from == o.cover_page_from &&
+          cover_page_message == o.cover_page_message &&
+          title == o.title
+    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
+      [recipient, sender, files, file_urls, test_mode, cover_page_to, cover_page_from, cover_page_message, title].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attribute_map = self.class.merged_attributes
+
+      self.class.merged_types.each_pair do |key, type|
+        if 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)
+            self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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
+        klass = Dropbox::Sign.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(include_nil = true)
+      hash = {}
+      self.class.merged_attributes.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          next unless include_nil
+          is_nullable = self.class.merged_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value, include_nil)
+      end
+      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, include_nil = true)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v, include_nil) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(include_nil)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb

@@ -26,11 +26,21 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :refresh_token
 
+    # The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.
+    # @return [String]
+    attr_accessor :client_secret
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'grant_type' => :'grant_type',
-        :'refresh_token' => :'refresh_token'
+        :'refresh_token' => :'refresh_token',
+        :'client_id' => :'client_id',
+        :'client_secret' => :'client_secret'
       }
     end
 
@@ -43,7 +53,9 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'grant_type' => :'String',
-        :'refresh_token' => :'String'
+        :'refresh_token' => :'String',
+        :'client_id' => :'String',
+        :'client_secret' => :'String'
       }
     end
 
@@ -102,6 +114,14 @@ module Dropbox::Sign
       if attributes.key?(:'refresh_token')
         self.refresh_token = attributes[:'refresh_token']
       end
+
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'client_secret')
+        self.client_secret = attributes[:'client_secret']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +153,9 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           grant_type == o.grant_type &&
-          refresh_token == o.refresh_token
+          refresh_token == o.refresh_token &&
+          client_id == o.client_id &&
+          client_secret == o.client_secret
     end
 
     # @see the `==` method
@@ -145,7 +167,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [grant_type, refresh_token].hash
+      [grant_type, refresh_token, client_id, client_secret].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/signature_request_response.rb

@@ -20,7 +20,7 @@ module Dropbox::Sign
   # Contains information about a signature request.
   class SignatureRequestResponse
     # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
-    # @return [Boolean, nil]
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # The id of the SignatureRequest.
@@ -28,7 +28,7 @@ module Dropbox::Sign
     attr_accessor :signature_request_id
 
     # The email address of the initiator of the SignatureRequest.
-    # @return [String]
+    # @return [String, nil]
     attr_accessor :requester_email_address
 
     # The title the specified Account uses for the SignatureRequest.
@@ -48,7 +48,7 @@ module Dropbox::Sign
     attr_accessor :message
 
     # The metadata attached to the signature request.
-    # @return [Object]
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # Time the signature request was created.
@@ -56,7 +56,7 @@ module Dropbox::Sign
     attr_accessor :created_at
 
     # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
-    # @return [Integer]
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     # Whether or not the SignatureRequest has been fully executed by all signers.
@@ -165,7 +165,7 @@ module Dropbox::Sign
         :'original_title' => :'String',
         :'subject' => :'String',
         :'message' => :'String',
-        :'metadata' => :'Object',
+        :'metadata' => :'Hash<String, Object>',
         :'created_at' => :'Integer',
         :'expires_at' => :'Integer',
         :'is_complete' => :'Boolean',
@@ -189,9 +189,10 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'test_mode',
+        :'requester_email_address',
         :'subject',
         :'message',
+        :'expires_at',
         :'signing_url',
         :'signing_redirect_url',
         :'final_copy_uri',
@@ -274,7 +275,9 @@ module Dropbox::Sign
       end
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
       if attributes.key?(:'created_at')

data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb

@@ -36,7 +36,7 @@ module Dropbox::Sign
     attr_accessor :api_id
 
     # The name of the Role that is able to edit this field.
-    # @return [String]
+    # @return [String, nil]
     attr_accessor :editor
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -69,6 +69,7 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'editor'
       ])
     end
 

data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb

@@ -26,11 +26,16 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :value
 
+    # This field contains the boolean true if the field is signed.
+    # @return [Boolean, nil]
+    attr_accessor :is_signed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'is_signed' => :'is_signed'
       }
     end
 
@@ -43,13 +48,15 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'is_signed' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_signed'
       ])
     end
 
@@ -105,6 +112,10 @@ module Dropbox::Sign
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'is_signed')
+        self.is_signed = attributes[:'is_signed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +137,8 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value && super(o)
+          value == o.value &&
+          is_signed == o.is_signed && super(o)
     end
 
     # @see the `==` method
@@ -138,7 +150,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value].hash
+      [type, value, is_signed].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb

@@ -26,11 +26,16 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :value
 
+    # This field contains the boolean true if the field is signed.
+    # @return [Boolean, nil]
+    attr_accessor :is_signed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'is_signed' => :'is_signed'
       }
     end
 
@@ -43,13 +48,15 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'is_signed' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_signed'
       ])
     end
 
@@ -105,6 +112,10 @@ module Dropbox::Sign
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'is_signed')
+        self.is_signed = attributes[:'is_signed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +137,8 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value && super(o)
+          value == o.value &&
+          is_signed == o.is_signed && super(o)
     end
 
     # @see the `==` method
@@ -138,7 +150,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value].hash
+      [type, value, is_signed].hash
     end
 
     # Builds the object from hash