plaid 13.2.0 → 14.1.0

data/lib/plaid/models/override_account_type.rb

@@ -0,0 +1,40 @@
+=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.26.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class OverrideAccountType
+    INVESTMENT = "investment".freeze
+    CREDIT = "credit".freeze
+    DEPOSITORY = "depository".freeze
+    LOAN = "loan".freeze
+    OTHER = "other".freeze
+
+    # 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)
+      constantValues = OverrideAccountType.constants.select { |c| OverrideAccountType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #OverrideAccountType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/plaid/models/override_accounts.rb

@@ -0,0 +1,384 @@
+=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.26.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Data to use to set values of test accounts. Some values cannot be specified in the schema and will instead will be calculated from other test data in order to achieve more consistent, realistic test data.
+  class OverrideAccounts
+    attr_accessor :type
+
+    attr_accessor :subtype
+
+    # If provided, the account will start with this amount as the current balance. 
+    attr_accessor :starting_balance
+
+    # If provided, the account will always have this amount as its  available balance, regardless of current balance or changes in transactions over time.
+    attr_accessor :force_available_balance
+
+    # ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default.
+    attr_accessor :currency
+
+    attr_accessor :meta
+
+    attr_accessor :numbers
+
+    # Specify the list of transactions on the account.
+    attr_accessor :transactions
+
+    attr_accessor :holdings
+
+    attr_accessor :investment_transactions
+
+    attr_accessor :identity
+
+    attr_accessor :liability
+
+    attr_accessor :inflow_model
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'subtype' => :'subtype',
+        :'starting_balance' => :'starting_balance',
+        :'force_available_balance' => :'force_available_balance',
+        :'currency' => :'currency',
+        :'meta' => :'meta',
+        :'numbers' => :'numbers',
+        :'transactions' => :'transactions',
+        :'holdings' => :'holdings',
+        :'investment_transactions' => :'investment_transactions',
+        :'identity' => :'identity',
+        :'liability' => :'liability',
+        :'inflow_model' => :'inflow_model'
+      }
+    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
+      {
+        :'type' => :'OverrideAccountType',
+        :'subtype' => :'AccountSubtype',
+        :'starting_balance' => :'Float',
+        :'force_available_balance' => :'Float',
+        :'currency' => :'String',
+        :'meta' => :'Meta',
+        :'numbers' => :'Numbers',
+        :'transactions' => :'Array<TransactionOverride>',
+        :'holdings' => :'HoldingsOverride',
+        :'investment_transactions' => :'InvestmentsTransactionsOverride',
+        :'identity' => :'OwnerOverride',
+        :'liability' => :'LiabilityOverride',
+        :'inflow_model' => :'InflowModel'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'subtype',
+      ])
+    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::OverrideAccounts` 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::OverrideAccounts`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'subtype')
+        self.subtype = attributes[:'subtype']
+      end
+
+      if attributes.key?(:'starting_balance')
+        self.starting_balance = attributes[:'starting_balance']
+      end
+
+      if attributes.key?(:'force_available_balance')
+        self.force_available_balance = attributes[:'force_available_balance']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
+
+      if attributes.key?(:'numbers')
+        self.numbers = attributes[:'numbers']
+      end
+
+      if attributes.key?(:'transactions')
+        if (value = attributes[:'transactions']).is_a?(Array)
+          self.transactions = value
+        end
+      end
+
+      if attributes.key?(:'holdings')
+        self.holdings = attributes[:'holdings']
+      end
+
+      if attributes.key?(:'investment_transactions')
+        self.investment_transactions = attributes[:'investment_transactions']
+      end
+
+      if attributes.key?(:'identity')
+        self.identity = attributes[:'identity']
+      end
+
+      if attributes.key?(:'liability')
+        self.liability = attributes[:'liability']
+      end
+
+      if attributes.key?(:'inflow_model')
+        self.inflow_model = attributes[:'inflow_model']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @starting_balance.nil?
+        invalid_properties.push('invalid value for "starting_balance", starting_balance cannot be nil.')
+      end
+
+      if @force_available_balance.nil?
+        invalid_properties.push('invalid value for "force_available_balance", force_available_balance cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @numbers.nil?
+        invalid_properties.push('invalid value for "numbers", numbers cannot be nil.')
+      end
+
+      if @transactions.nil?
+        invalid_properties.push('invalid value for "transactions", transactions cannot be nil.')
+      end
+
+      if @identity.nil?
+        invalid_properties.push('invalid value for "identity", identity cannot be nil.')
+      end
+
+      if @liability.nil?
+        invalid_properties.push('invalid value for "liability", liability cannot be nil.')
+      end
+
+      if @inflow_model.nil?
+        invalid_properties.push('invalid value for "inflow_model", inflow_model 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 @type.nil?
+      return false if @starting_balance.nil?
+      return false if @force_available_balance.nil?
+      return false if @currency.nil?
+      return false if @meta.nil?
+      return false if @numbers.nil?
+      return false if @transactions.nil?
+      return false if @identity.nil?
+      return false if @liability.nil?
+      return false if @inflow_model.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 &&
+          type == o.type &&
+          subtype == o.subtype &&
+          starting_balance == o.starting_balance &&
+          force_available_balance == o.force_available_balance &&
+          currency == o.currency &&
+          meta == o.meta &&
+          numbers == o.numbers &&
+          transactions == o.transactions &&
+          holdings == o.holdings &&
+          investment_transactions == o.investment_transactions &&
+          identity == o.identity &&
+          liability == o.liability &&
+          inflow_model == o.inflow_model
+    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
+      [type, subtype, starting_balance, force_available_balance, currency, meta, numbers, transactions, holdings, investment_transactions, identity, liability, inflow_model].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/owner.rb

@@ -0,0 +1,278 @@
+=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.26.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Data returned from the financial institution about the owner or owners of an account. Only the `names` array must be non-empty.
+  class Owner
+    # A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.  If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's `names` array.
+    attr_accessor :names
+
+    # A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
+    attr_accessor :phone_numbers
+
+    # A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
+    attr_accessor :emails
+
+    # Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
+    attr_accessor :addresses
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'names' => :'names',
+        :'phone_numbers' => :'phone_numbers',
+        :'emails' => :'emails',
+        :'addresses' => :'addresses'
+      }
+    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
+      {
+        :'names' => :'Array<String>',
+        :'phone_numbers' => :'Array<PhoneNumber>',
+        :'emails' => :'Array<Email>',
+        :'addresses' => :'Array<Address>'
+      }
+    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::Owner` 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::Owner`. 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?(:'names')
+        if (value = attributes[:'names']).is_a?(Array)
+          self.names = value
+        end
+      end
+
+      if attributes.key?(:'phone_numbers')
+        if (value = attributes[:'phone_numbers']).is_a?(Array)
+          self.phone_numbers = value
+        end
+      end
+
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
+      if attributes.key?(:'addresses')
+        if (value = attributes[:'addresses']).is_a?(Array)
+          self.addresses = value
+        end
+      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 @names.nil?
+        invalid_properties.push('invalid value for "names", names cannot be nil.')
+      end
+
+      if @phone_numbers.nil?
+        invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
+      end
+
+      if @emails.nil?
+        invalid_properties.push('invalid value for "emails", emails cannot be nil.')
+      end
+
+      if @addresses.nil?
+        invalid_properties.push('invalid value for "addresses", addresses 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 @names.nil?
+      return false if @phone_numbers.nil?
+      return false if @emails.nil?
+      return false if @addresses.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 &&
+          names == o.names &&
+          phone_numbers == o.phone_numbers &&
+          emails == o.emails &&
+          addresses == o.addresses
+    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
+      [names, phone_numbers, emails, addresses].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