plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 14.0.0

data/lib/plaid/models/customer_initiated_return_risk.rb

@@ -0,0 +1,300 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.20.6
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: “R05”, \"R07\", \"R10\", \"R11\", \"R29\". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
+  class CustomerInitiatedReturnRisk
+    # A score from 0-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
+    attr_accessor :score
+
+    # A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return.  In the `customer_initiated_return_risk` object, there are five risk tiers corresponding to the scores:   1: Predicted customer-initiated return incidence rate between 0.00% - 0.02%   2: Predicted customer-initiated return incidence rate between 0.02% - 0.05%   3: Predicted customer-initiated return incidence rate between 0.05% - 0.1%   4: Predicted customer-initiated return incidence rate between 0.1% - 0.5%   5: Predicted customer-initiated return incidence rate greater than 0.5% 
+    attr_accessor :risk_tier
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'score' => :'score',
+        :'risk_tier' => :'risk_tier'
+      }
+    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
+      {
+        :'score' => :'Integer',
+        :'risk_tier' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.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 `Plaid::CustomerInitiatedReturnRisk` 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.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CustomerInitiatedReturnRisk`. 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?(:'score')
+        self.score = attributes[:'score']
+      end
+
+      if attributes.key?(:'risk_tier')
+        self.risk_tier = attributes[:'risk_tier']
+      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 @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @score > 100
+        invalid_properties.push('invalid value for "score", must be smaller than or equal to 100.')
+      end
+
+      if @score < 0
+        invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
+      end
+
+
+      if @risk_tier.nil?
+        invalid_properties.push('invalid value for "risk_tier", risk_tier cannot be nil.')
+      end
+
+      if @risk_tier > 5
+        invalid_properties.push('invalid value for "risk_tier", must be smaller than or equal to 5.')
+      end
+
+      if @risk_tier < 1
+        invalid_properties.push('invalid value for "risk_tier", must be greater than or equal to 1.')
+      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 @score.nil?
+      return false if @score > 100
+      return false if @score < 0
+      return false if @risk_tier.nil?
+      return false if @risk_tier > 5
+      return false if @risk_tier < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, 'score cannot be nil'
+      end
+
+      if score > 100
+        fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 100.'
+      end
+
+      if score < 0
+        fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
+      end
+
+
+      @score = score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] risk_tier Value to be assigned
+    def risk_tier=(risk_tier)
+      if risk_tier.nil?
+        fail ArgumentError, 'risk_tier cannot be nil'
+      end
+
+      if risk_tier > 5
+        fail ArgumentError, 'invalid value for "risk_tier", must be smaller than or equal to 5.'
+      end
+
+      if risk_tier < 1
+        fail ArgumentError, 'invalid value for "risk_tier", must be greater than or equal to 1.'
+      end
+
+
+      @risk_tier = risk_tier
+    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 &&
+          score == o.score &&
+          risk_tier == o.risk_tier
+    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
+      [score, risk_tier].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.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) or oneOf
+        klass = Plaid.const_get(type)
+        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|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      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)
+      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/plaid/models/default_update_webhook.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/deposit_switch_address_data.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/deposit_switch_alt_create_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -26,13 +26,42 @@ module Plaid
 
     attr_accessor :target_user
 
+    attr_accessor :options
+
+    # ISO-3166-1 alpha-2 country code standard.
+    attr_accessor :country_code
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
         :'target_account' => :'target_account',
-        :'target_user' => :'target_user'
+        :'target_user' => :'target_user',
+        :'options' => :'options',
+        :'country_code' => :'country_code'
       }
     end
 
@@ -47,13 +76,16 @@ module Plaid
         :'client_id' => :'String',
         :'secret' => :'String',
         :'target_account' => :'DepositSwitchTargetAccount',
-        :'target_user' => :'DepositSwitchTargetUser'
+        :'target_user' => :'DepositSwitchTargetUser',
+        :'options' => :'DepositSwitchCreateRequestOptions',
+        :'country_code' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'country_code'
       ])
     end
 
@@ -87,6 +119,14 @@ module Plaid
       if attributes.key?(:'target_user')
         self.target_user = attributes[:'target_user']
       end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,9 +149,21 @@ module Plaid
     def valid?
       return false if @target_account.nil?
       return false if @target_user.nil?
+      country_code_validator = EnumAttributeValidator.new('String', ["US", "CA"])
+      return false unless country_code_validator.valid?(@country_code)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] country_code Object to be assigned
+    def country_code=(country_code)
+      validator = EnumAttributeValidator.new('String', ["US", "CA"])
+      unless validator.valid?(country_code)
+        fail ArgumentError, "invalid value for \"country_code\", must be one of #{validator.allowable_values}."
+      end
+      @country_code = country_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -120,7 +172,9 @@ module Plaid
           client_id == o.client_id &&
           secret == o.secret &&
           target_account == o.target_account &&
-          target_user == o.target_user
+          target_user == o.target_user &&
+          options == o.options &&
+          country_code == o.country_code
     end
 
     # @see the `==` method
@@ -132,7 +186,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, target_account, target_user].hash
+      [client_id, secret, target_account, target_user, options, country_code].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/deposit_switch_alt_create_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/deposit_switch_create_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -28,13 +28,42 @@ module Plaid
     # Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit.
     attr_accessor :target_account_id
 
+    # ISO-3166-1 alpha-2 country code standard.
+    attr_accessor :country_code
+
+    attr_accessor :options
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
         :'target_access_token' => :'target_access_token',
-        :'target_account_id' => :'target_account_id'
+        :'target_account_id' => :'target_account_id',
+        :'country_code' => :'country_code',
+        :'options' => :'options'
       }
     end
 
@@ -49,13 +78,16 @@ module Plaid
         :'client_id' => :'String',
         :'secret' => :'String',
         :'target_access_token' => :'String',
-        :'target_account_id' => :'String'
+        :'target_account_id' => :'String',
+        :'country_code' => :'String',
+        :'options' => :'DepositSwitchCreateRequestOptions'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'country_code',
       ])
     end
 
@@ -89,6 +121,14 @@ module Plaid
       if attributes.key?(:'target_account_id')
         self.target_account_id = attributes[:'target_account_id']
       end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,9 +151,21 @@ module Plaid
     def valid?
       return false if @target_access_token.nil?
       return false if @target_account_id.nil?
+      country_code_validator = EnumAttributeValidator.new('String', ["US", "CA"])
+      return false unless country_code_validator.valid?(@country_code)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] country_code Object to be assigned
+    def country_code=(country_code)
+      validator = EnumAttributeValidator.new('String', ["US", "CA"])
+      unless validator.valid?(country_code)
+        fail ArgumentError, "invalid value for \"country_code\", must be one of #{validator.allowable_values}."
+      end
+      @country_code = country_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -122,7 +174,9 @@ module Plaid
           client_id == o.client_id &&
           secret == o.secret &&
           target_access_token == o.target_access_token &&
-          target_account_id == o.target_account_id
+          target_account_id == o.target_account_id &&
+          country_code == o.country_code &&
+          options == o.options
     end
 
     # @see the `==` method
@@ -134,7 +188,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, target_access_token, target_account_id].hash
+      [client_id, secret, target_access_token, target_account_id, country_code, options].hash
     end
 
     # Builds the object from hash