plaid 17.0.0 → 17.2.0

data/lib/plaid/models/transfer_capabilities_get_rtp.rb

@@ -0,0 +1,222 @@
+=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.210.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Contains the supported service types in RTP
+  class TransferCapabilitiesGetRTP
+    # When `true`, meaning the linked item's institution supports RTP credit transfer
+    attr_accessor :credit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'credit' => :'credit'
+      }
+    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
+      {
+        :'credit' => :'Boolean'
+      }
+    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::TransferCapabilitiesGetRTP` 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::TransferCapabilitiesGetRTP`. 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?(:'credit')
+        self.credit = attributes[:'credit']
+      else
+        self.credit = false
+      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 &&
+          credit == o.credit
+    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
+      [credit].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/transfer_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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_device.rb

@@ -0,0 +1,240 @@
+=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.210.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Information about the device being used to initiate the authorization.
+  class TransferDevice
+    # The IP address of the device being used to initiate the authorization.
+    attr_accessor :ip_address
+
+    # The user agent of the device being used to initiate the authorization.
+    attr_accessor :user_agent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ip_address' => :'ip_address',
+        :'user_agent' => :'user_agent'
+      }
+    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
+      {
+        :'ip_address' => :'String',
+        :'user_agent' => :'String'
+      }
+    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::TransferDevice` 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::TransferDevice`. 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?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'user_agent')
+        self.user_agent = attributes[:'user_agent']
+      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 @ip_address.nil?
+        invalid_properties.push('invalid value for "ip_address", ip_address cannot be nil.')
+      end
+
+      if @user_agent.nil?
+        invalid_properties.push('invalid value for "user_agent", user_agent 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 @ip_address.nil?
+      return false if @user_agent.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 &&
+          ip_address == o.ip_address &&
+          user_agent == o.user_agent
+    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
+      [ip_address, user_agent].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/transfer_diligence_status.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.210.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class TransferDiligenceStatus
+    UNDER_REVIEW = "under_review".freeze
+    APPROVED = "approved".freeze
+    DENIED = "denied".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)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/transfer_event.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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -46,6 +46,12 @@ module Plaid
     # A signed amount of how much was `swept` or `return_swept` (decimal string with two digits of precision e.g. \"-5.50\").
     attr_accessor :sweep_amount
 
+    # Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.
+    attr_accessor :refund_id
+
+    # The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).
+    attr_accessor :originator_client_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -59,7 +65,9 @@ module Plaid
         :'transfer_amount' => :'transfer_amount',
         :'failure_reason' => :'failure_reason',
         :'sweep_id' => :'sweep_id',
-        :'sweep_amount' => :'sweep_amount'
+        :'sweep_amount' => :'sweep_amount',
+        :'refund_id' => :'refund_id',
+        :'originator_client_id' => :'originator_client_id'
       }
     end
 
@@ -81,7 +89,9 @@ module Plaid
         :'transfer_amount' => :'String',
         :'failure_reason' => :'TransferFailure',
         :'sweep_id' => :'String',
-        :'sweep_amount' => :'String'
+        :'sweep_amount' => :'String',
+        :'refund_id' => :'String',
+        :'originator_client_id' => :'String'
       }
     end
 
@@ -91,7 +101,9 @@ module Plaid
         :'origination_account_id',
         :'failure_reason',
         :'sweep_id',
-        :'sweep_amount'
+        :'sweep_amount',
+        :'refund_id',
+        :'originator_client_id'
       ])
     end
 
@@ -153,6 +165,14 @@ module Plaid
       if attributes.key?(:'sweep_amount')
         self.sweep_amount = attributes[:'sweep_amount']
       end
+
+      if attributes.key?(:'refund_id')
+        self.refund_id = attributes[:'refund_id']
+      end
+
+      if attributes.key?(:'originator_client_id')
+        self.originator_client_id = attributes[:'originator_client_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -239,7 +259,9 @@ module Plaid
           transfer_amount == o.transfer_amount &&
           failure_reason == o.failure_reason &&
           sweep_id == o.sweep_id &&
-          sweep_amount == o.sweep_amount
+          sweep_amount == o.sweep_amount &&
+          refund_id == o.refund_id &&
+          originator_client_id == o.originator_client_id
     end
 
     # @see the `==` method
@@ -251,7 +273,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event_id, timestamp, event_type, account_id, transfer_id, origination_account_id, transfer_type, transfer_amount, failure_reason, sweep_id, sweep_amount].hash
+      [event_id, timestamp, event_type, account_id, transfer_id, origination_account_id, transfer_type, transfer_amount, failure_reason, sweep_id, sweep_amount, refund_id, originator_client_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_event_list_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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -51,6 +51,9 @@ module Plaid
     # The origination account ID to get events for transfers from a specific origination account.
     attr_accessor :origination_account_id
 
+    # Filter transfer events to only those with the specified originator client.
+    attr_accessor :originator_client_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -65,7 +68,8 @@ module Plaid
         :'sweep_id' => :'sweep_id',
         :'count' => :'count',
         :'offset' => :'offset',
-        :'origination_account_id' => :'origination_account_id'
+        :'origination_account_id' => :'origination_account_id',
+        :'originator_client_id' => :'originator_client_id'
       }
     end
 
@@ -88,7 +92,8 @@ module Plaid
         :'sweep_id' => :'String',
         :'count' => :'Integer',
         :'offset' => :'Integer',
-        :'origination_account_id' => :'String'
+        :'origination_account_id' => :'String',
+        :'originator_client_id' => :'String'
       }
     end
 
@@ -102,7 +107,8 @@ module Plaid
         :'transfer_type',
         :'count',
         :'offset',
-        :'origination_account_id'
+        :'origination_account_id',
+        :'originator_client_id'
       ])
     end
 
@@ -174,6 +180,10 @@ module Plaid
       if attributes.key?(:'origination_account_id')
         self.origination_account_id = attributes[:'origination_account_id']
       end
+
+      if attributes.key?(:'originator_client_id')
+        self.originator_client_id = attributes[:'originator_client_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -248,7 +258,8 @@ module Plaid
           sweep_id == o.sweep_id &&
           count == o.count &&
           offset == o.offset &&
-          origination_account_id == o.origination_account_id
+          origination_account_id == o.origination_account_id &&
+          originator_client_id == o.originator_client_id
     end
 
     # @see the `==` method
@@ -260,7 +271,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, start_date, end_date, transfer_id, account_id, transfer_type, event_types, sweep_id, count, offset, origination_account_id].hash
+      [client_id, secret, start_date, end_date, transfer_id, account_id, transfer_type, event_types, sweep_id, count, offset, origination_account_id, originator_client_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_event_list_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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1