dropbox-sign 1.4.1 → 1.5.0

data/lib/dropbox-sign/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -65,6 +65,16 @@ module Dropbox::Sign
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -72,6 +82,14 @@ module Dropbox::Sign
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -136,6 +154,7 @@ module Dropbox::Sign
     # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -144,7 +163,7 @@ module Dropbox::Sign
       @scheme = 'https'
       @host = 'api.hellosign.com'
       @base_path = '/v3'
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -153,11 +172,12 @@ module Dropbox::Sign
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @timeout = 0
+      @params_encoding = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -192,10 +212,13 @@ module Dropbox::Sign
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -210,6 +233,12 @@ module Dropbox::Sign
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -273,8 +302,8 @@ module Dropbox::Sign
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -299,5 +328,6 @@ module Dropbox::Sign
       url
     end
 
+
   end
 end

data/lib/dropbox-sign/event_callback_helper.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -214,8 +214,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -233,7 +231,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -198,8 +198,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -217,7 +215,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -188,8 +188,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -207,7 +205,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -57,6 +57,9 @@ module Dropbox::Sign
     # @return [String, nil]
     attr_accessor :locale
 
+    # @return [AccountResponseUsage]
+    attr_accessor :usage
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,7 +72,8 @@ module Dropbox::Sign
         :'callback_url' => :'callback_url',
         :'role_code' => :'role_code',
         :'team_id' => :'team_id',
-        :'locale' => :'locale'
+        :'locale' => :'locale',
+        :'usage' => :'usage'
       }
     end
 
@@ -95,7 +99,8 @@ module Dropbox::Sign
         :'callback_url' => :'String',
         :'role_code' => :'String',
         :'team_id' => :'String',
-        :'locale' => :'String'
+        :'locale' => :'String',
+        :'usage' => :'AccountResponseUsage'
       }
     end
 
@@ -110,7 +115,7 @@ module Dropbox::Sign
         :'callback_url',
         :'role_code',
         :'team_id',
-        :'locale'
+        :'locale',
       ])
     end
 
@@ -183,6 +188,10 @@ module Dropbox::Sign
       if attributes.key?(:'locale')
         self.locale = attributes[:'locale']
       end
+
+      if attributes.key?(:'usage')
+        self.usage = attributes[:'usage']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -212,7 +221,8 @@ module Dropbox::Sign
           callback_url == o.callback_url &&
           role_code == o.role_code &&
           team_id == o.team_id &&
-          locale == o.locale
+          locale == o.locale &&
+          usage == o.usage
     end
 
     # @see the `==` method
@@ -224,7 +234,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale].hash
+      [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash
     end
 
     # Builds the object from hash
@@ -278,8 +288,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -297,7 +305,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -39,6 +39,10 @@ module Dropbox::Sign
     # @return [Integer, nil]
     attr_accessor :sms_verifications_left
 
+    # Number of fax pages left
+    # @return [Integer, nil]
+    attr_accessor :num_fax_pages_left
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +50,8 @@ module Dropbox::Sign
         :'documents_left' => :'documents_left',
         :'templates_total' => :'templates_total',
         :'templates_left' => :'templates_left',
-        :'sms_verifications_left' => :'sms_verifications_left'
+        :'sms_verifications_left' => :'sms_verifications_left',
+        :'num_fax_pages_left' => :'num_fax_pages_left'
       }
     end
 
@@ -67,7 +72,8 @@ module Dropbox::Sign
         :'documents_left' => :'Integer',
         :'templates_total' => :'Integer',
         :'templates_left' => :'Integer',
-        :'sms_verifications_left' => :'Integer'
+        :'sms_verifications_left' => :'Integer',
+        :'num_fax_pages_left' => :'Integer'
       }
     end
 
@@ -83,7 +89,8 @@ module Dropbox::Sign
         :'documents_left',
         :'templates_total',
         :'templates_left',
-        :'sms_verifications_left'
+        :'sms_verifications_left',
+        :'num_fax_pages_left'
       ])
     end
 
@@ -136,6 +143,10 @@ module Dropbox::Sign
       if attributes.key?(:'sms_verifications_left')
         self.sms_verifications_left = attributes[:'sms_verifications_left']
       end
+
+      if attributes.key?(:'num_fax_pages_left')
+        self.num_fax_pages_left = attributes[:'num_fax_pages_left']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,7 +171,8 @@ module Dropbox::Sign
           documents_left == o.documents_left &&
           templates_total == o.templates_total &&
           templates_left == o.templates_left &&
-          sms_verifications_left == o.sms_verifications_left
+          sms_verifications_left == o.sms_verifications_left &&
+          num_fax_pages_left == o.num_fax_pages_left
     end
 
     # @see the `==` method
@@ -172,7 +184,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [api_signature_requests_left, documents_left, templates_total, templates_left, sms_verifications_left].hash
+      [api_signature_requests_left, documents_left, templates_total, templates_left, sms_verifications_left, num_fax_pages_left].hash
     end
 
     # Builds the object from hash
@@ -226,8 +238,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -245,7 +255,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -0,0 +1,251 @@
+=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.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  # Details concerning monthly usage
+  class AccountResponseUsage
+    # Number of fax pages sent
+    # @return [Integer, nil]
+    attr_accessor :fax_pages_sent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'fax_pages_sent' => :'fax_pages_sent'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'fax_pages_sent' => :'Integer'
+      }
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'fax_pages_sent'
+      ])
+    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 [AccountResponseUsage]
+    def self.init(data)
+      return ApiClient.default.convert_to_type(
+        data,
+        "AccountResponseUsage"
+      ) || AccountResponseUsage.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::AccountResponseUsage` 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::AccountResponseUsage`. 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?(:'fax_pages_sent')
+        self.fax_pages_sent = attributes[:'fax_pages_sent']
+      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
+      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?
+      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 &&
+          fax_pages_sent == o.fax_pages_sent
+    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
+      [fax_pages_sent].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
+        # models (e.g. Pet)
+        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/account_update_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -199,8 +199,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -218,7 +216,7 @@ module Dropbox::Sign
       else # model
         # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end