plaid 21.3.0 → 23.0.0

data/lib/plaid/models/{credit_freddie_verification_of_employment_voe25.rb → transfer_ledger_get_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.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -14,18 +14,18 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Verification of Employment Report
-  class CreditFreddieVerificationOfEmploymentVOE25
-    attr_accessor :deal
+  # Defines the response schema for `/transfer/ledger/get`
+  class TransferLedgerGetResponse
+    attr_accessor :balance
 
-    # The Verification Of Employment (VOE) schema version.
-    attr_accessor :schema_version
+    # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
+    attr_accessor :request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'deal' => :'DEAL',
-        :'schema_version' => :'SchemaVersion'
+        :'balance' => :'balance',
+        :'request_id' => :'request_id'
       }
     end
 
@@ -37,8 +37,8 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'deal' => :'CreditFreddieVerificationOfEmploymentDealVOE25',
-        :'schema_version' => :'Float'
+        :'balance' => :'TransferLedgerBalance',
+        :'request_id' => :'String'
       }
     end
 
@@ -52,23 +52,23 @@ module Plaid
     # @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::CreditFreddieVerificationOfEmploymentVOE25` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferLedgerGetResponse` 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::CreditFreddieVerificationOfEmploymentVOE25`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferLedgerGetResponse`. 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?(:'deal')
-        self.deal = attributes[:'deal']
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
       end
 
-      if attributes.key?(:'schema_version')
-        self.schema_version = attributes[:'schema_version']
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
       end
     end
 
@@ -76,12 +76,12 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @deal.nil?
-        invalid_properties.push('invalid value for "deal", deal cannot be nil.')
+      if @balance.nil?
+        invalid_properties.push('invalid value for "balance", balance cannot be nil.')
       end
 
-      if @schema_version.nil?
-        invalid_properties.push('invalid value for "schema_version", schema_version cannot be nil.')
+      if @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
       end
 
       invalid_properties
@@ -90,8 +90,8 @@ module Plaid
     # 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 @deal.nil?
-      return false if @schema_version.nil?
+      return false if @balance.nil?
+      return false if @request_id.nil?
       true
     end
 
@@ -100,8 +100,8 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          deal == o.deal &&
-          schema_version == o.schema_version
+          balance == o.balance &&
+          request_id == o.request_id
     end
 
     # @see the `==` method
@@ -113,7 +113,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [deal, schema_version].hash
+      [balance, request_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb

@@ -0,0 +1,41 @@
+=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.457.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class TransferLedgerSweepSimulateEventType
+    POSTED = "sweep.posted".freeze
+    SETTLED = "sweep.settled".freeze
+    RETURNED = "sweep.returned".freeze
+    FAILED = "sweep.failed".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_ledger_withdraw_request.rb

@@ -0,0 +1,346 @@
+=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.457.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Defines the request schema for `/transfer/ledger/withdraw`
+  class TransferLedgerWithdrawRequest
+    # Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
+    attr_accessor :client_id
+
+    # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
+    attr_accessor :secret
+
+    # Client ID of the customer that owns the Ledger balance. This is so Plaid knows which of your customers to payout or collect funds. Only applicable for [Platform customers](https://plaid.com/docs/transfer/application/#originators-vs-platforms). Do not include if you’re paying out to yourself.
+    attr_accessor :originator_client_id
+
+    # Specify which funding account linked to this Plaid Ledger to use. Customers can find a list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the \"Account ID\" column. If this field is left blank, this will default to the default `funding_account_id` specified during onboarding. If an `originator_client_id` is specified, the `funding_account_id` must belong to the specified originator, and if `funding_account_id` is left blank, the originator's default `funding_account_id` will be used.
+    attr_accessor :funding_account_id
+
+    # A positive amount of how much will be withdrawn from the ledger balance (decimal string with two digits of precision e.g. \"5.50\").
+    attr_accessor :amount
+
+    # The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
+    attr_accessor :description
+
+    # A unique key provided by the client, per unique ledger withdraw. Maximum of 50 characters.  The API supports idempotency for safely retrying the request without accidentally performing the same operation twice. For example, if a request to create a ledger withdraw fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single withdraw is created.
+    attr_accessor :idempotency_key
+
+    attr_accessor :network
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_id' => :'client_id',
+        :'secret' => :'secret',
+        :'originator_client_id' => :'originator_client_id',
+        :'funding_account_id' => :'funding_account_id',
+        :'amount' => :'amount',
+        :'description' => :'description',
+        :'idempotency_key' => :'idempotency_key',
+        :'network' => :'network'
+      }
+    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
+      {
+        :'client_id' => :'String',
+        :'secret' => :'String',
+        :'originator_client_id' => :'String',
+        :'funding_account_id' => :'String',
+        :'amount' => :'String',
+        :'description' => :'String',
+        :'idempotency_key' => :'String',
+        :'network' => :'TransferNetwork'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'originator_client_id',
+        :'funding_account_id',
+        :'description',
+      ])
+    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::TransferLedgerWithdrawRequest` 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::TransferLedgerWithdrawRequest`. 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?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      end
+
+      if attributes.key?(:'originator_client_id')
+        self.originator_client_id = attributes[:'originator_client_id']
+      end
+
+      if attributes.key?(:'funding_account_id')
+        self.funding_account_id = attributes[:'funding_account_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      end
+
+      if attributes.key?(:'network')
+        self.network = attributes[:'network']
+      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 @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 10
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 10.')
+      end
+
+
+      if @idempotency_key.nil?
+        invalid_properties.push('invalid value for "idempotency_key", idempotency_key cannot be nil.')
+      end
+
+      if @idempotency_key.to_s.length > 50
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
+      end
+
+
+      if @network.nil?
+        invalid_properties.push('invalid value for "network", network 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 @amount.nil?
+      return false if !@description.nil? && @description.to_s.length > 10
+      return false if @idempotency_key.nil?
+      return false if @idempotency_key.to_s.length > 50
+      return false if @network.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 10
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 10.'
+      end
+
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] idempotency_key Value to be assigned
+    def idempotency_key=(idempotency_key)
+      if idempotency_key.nil?
+        fail ArgumentError, 'idempotency_key cannot be nil'
+      end
+
+      if idempotency_key.to_s.length > 50
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 50.'
+      end
+
+
+      @idempotency_key = idempotency_key
+    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 &&
+          client_id == o.client_id &&
+          secret == o.secret &&
+          originator_client_id == o.originator_client_id &&
+          funding_account_id == o.funding_account_id &&
+          amount == o.amount &&
+          description == o.description &&
+          idempotency_key == o.idempotency_key &&
+          network == o.network
+    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
+      [client_id, secret, originator_client_id, funding_account_id, amount, description, idempotency_key, network].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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/{credit_freddie_mac_verification_of_assets_voa24.rb → transfer_ledger_withdraw_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.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -14,18 +14,18 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Verification of Assets Report
-  class CreditFreddieMacVerificationOfAssetsVOA24
-    attr_accessor :deal
+  # Defines the response schema for `/transfer/ledger/withdraw`
+  class TransferLedgerWithdrawResponse
+    attr_accessor :sweep
 
-    # The Verification Of Assets (VOA) schema version.
-    attr_accessor :schema_version
+    # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
+    attr_accessor :request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'deal' => :'DEAL',
-        :'schema_version' => :'SchemaVersion'
+        :'sweep' => :'sweep',
+        :'request_id' => :'request_id'
       }
     end
 
@@ -37,8 +37,8 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'deal' => :'CreditFreddieMacVerificationOfAssetsDealVOA24',
-        :'schema_version' => :'Float'
+        :'sweep' => :'TransferSweep',
+        :'request_id' => :'String'
       }
     end
 
@@ -52,23 +52,23 @@ module Plaid
     # @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::CreditFreddieMacVerificationOfAssetsVOA24` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferLedgerWithdrawResponse` 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::CreditFreddieMacVerificationOfAssetsVOA24`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferLedgerWithdrawResponse`. 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?(:'deal')
-        self.deal = attributes[:'deal']
+      if attributes.key?(:'sweep')
+        self.sweep = attributes[:'sweep']
       end
 
-      if attributes.key?(:'schema_version')
-        self.schema_version = attributes[:'schema_version']
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
       end
     end
 
@@ -76,12 +76,12 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @deal.nil?
-        invalid_properties.push('invalid value for "deal", deal cannot be nil.')
+      if @sweep.nil?
+        invalid_properties.push('invalid value for "sweep", sweep cannot be nil.')
       end
 
-      if @schema_version.nil?
-        invalid_properties.push('invalid value for "schema_version", schema_version cannot be nil.')
+      if @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
       end
 
       invalid_properties
@@ -90,8 +90,8 @@ module Plaid
     # 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 @deal.nil?
-      return false if @schema_version.nil?
+      return false if @sweep.nil?
+      return false if @request_id.nil?
       true
     end
 
@@ -100,8 +100,8 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          deal == o.deal &&
-          schema_version == o.schema_version
+          sweep == o.sweep &&
+          request_id == o.request_id
     end
 
     # @see the `==` method
@@ -113,7 +113,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [deal, schema_version].hash
+      [sweep, request_id].hash
     end
 
     # Builds the object from hash

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

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

data/lib/plaid/models/transfer_metrics_get_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.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -22,7 +22,7 @@ module Plaid
     # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
     attr_accessor :secret
 
-    # The Plaid client ID of the transfer originator. Should only be present if `client_id` is a third-party sender (TPS).
+    # The Plaid client ID of the transfer originator. Should only be present if `client_id` is a [Platform customer](https://plaid.com/docs/transfer/application/#originators-vs-platforms).
     attr_accessor :originator_client_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

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