plaid 14.8.0 → 14.9.0

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.46.1
+The version of the OpenAPI document: 2020-09-14_1.54.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -40,6 +40,12 @@ module Plaid
 
     attr_accessor :failure_reason
 
+    # Plaid’s unique identifier for a sweep.
+    attr_accessor :sweep_id
+
+    # A signed amount of how much was `swept` or `reverse_swept` (decimal string with two digits of precision e.g. “-5.50”).
+    attr_accessor :sweep_amount
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,7 +57,9 @@ module Plaid
         :'origination_account_id' => :'origination_account_id',
         :'transfer_type' => :'transfer_type',
         :'transfer_amount' => :'transfer_amount',
-        :'failure_reason' => :'failure_reason'
+        :'failure_reason' => :'failure_reason',
+        :'sweep_id' => :'sweep_id',
+        :'sweep_amount' => :'sweep_amount'
       }
     end
 
@@ -71,7 +79,9 @@ module Plaid
         :'origination_account_id' => :'String',
         :'transfer_type' => :'TransferType',
         :'transfer_amount' => :'String',
-        :'failure_reason' => :'TransferFailure'
+        :'failure_reason' => :'TransferFailure',
+        :'sweep_id' => :'String',
+        :'sweep_amount' => :'String'
       }
     end
 
@@ -79,7 +89,7 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'origination_account_id',
-        :'failure_reason'
+        :'failure_reason',
       ])
     end
 
@@ -133,6 +143,14 @@ module Plaid
       if attributes.key?(:'failure_reason')
         self.failure_reason = attributes[:'failure_reason']
       end
+
+      if attributes.key?(:'sweep_id')
+        self.sweep_id = attributes[:'sweep_id']
+      end
+
+      if attributes.key?(:'sweep_amount')
+        self.sweep_amount = attributes[:'sweep_amount']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -217,7 +235,9 @@ module Plaid
           origination_account_id == o.origination_account_id &&
           transfer_type == o.transfer_type &&
           transfer_amount == o.transfer_amount &&
-          failure_reason == o.failure_reason
+          failure_reason == o.failure_reason &&
+          sweep_id == o.sweep_id &&
+          sweep_amount == o.sweep_amount
     end
 
     # @see the `==` method
@@ -229,7 +249,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].hash
+      [event_id, timestamp, event_type, account_id, transfer_id, origination_account_id, transfer_type, transfer_amount, failure_reason, sweep_id, sweep_amount].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.46.1
+The version of the OpenAPI document: 2020-09-14_1.54.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -40,6 +40,9 @@ module Plaid
     # Filter events by event type.
     attr_accessor :event_types
 
+    # Plaid’s unique identifier for a sweep.
+    attr_accessor :sweep_id
+
     # The maximum number of transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned.
     attr_accessor :count
 
@@ -82,6 +85,7 @@ module Plaid
         :'account_id' => :'account_id',
         :'transfer_type' => :'transfer_type',
         :'event_types' => :'event_types',
+        :'sweep_id' => :'sweep_id',
         :'count' => :'count',
         :'offset' => :'offset',
         :'origination_account_id' => :'origination_account_id'
@@ -104,6 +108,7 @@ module Plaid
         :'account_id' => :'String',
         :'transfer_type' => :'String',
         :'event_types' => :'Array<TransferEventType>',
+        :'sweep_id' => :'String',
         :'count' => :'Integer',
         :'offset' => :'Integer',
         :'origination_account_id' => :'String'
@@ -173,6 +178,10 @@ module Plaid
         end
       end
 
+      if attributes.key?(:'sweep_id')
+        self.sweep_id = attributes[:'sweep_id']
+      end
+
       if attributes.key?(:'count')
         self.count = attributes[:'count']
       else
@@ -271,6 +280,7 @@ module Plaid
           account_id == o.account_id &&
           transfer_type == o.transfer_type &&
           event_types == o.event_types &&
+          sweep_id == o.sweep_id &&
           count == o.count &&
           offset == o.offset &&
           origination_account_id == o.origination_account_id
@@ -285,7 +295,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, 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].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.46.1
+The version of the OpenAPI document: 2020-09-14_1.54.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

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

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

data/lib/plaid/models/transfer_event_type.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.46.1
+The version of the OpenAPI document: 2020-09-14_1.54.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -20,6 +20,8 @@ module Plaid
     FAILED = "failed".freeze
     POSTED = "posted".freeze
     REVERSED = "reversed".freeze
+    SWEPT = "swept".freeze
+    REVERSE_SWEPT = "reverse_swept".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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

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

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

data/lib/plaid/models/transfer_intent_create_mode.rb

@@ -0,0 +1,39 @@
+=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.54.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class TransferIntentCreateMode
+    PAYMENT = "PAYMENT".freeze
+    DISBURSEMENT = "DISBURSEMENT".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_intent_create_request.rb

@@ -0,0 +1,376 @@
+=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.54.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Defines the request schema for `/transfer/intent/create`
+  class TransferIntentCreateRequest
+    # 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
+
+    # The Plaid `account_id` for the account that will be debited or credited.
+    attr_accessor :account_id
+
+    attr_accessor :mode
+
+    # The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).
+    attr_accessor :amount
+
+    # A description for the underlying transfer. Maximum of 8 characters.
+    attr_accessor :description
+
+    attr_accessor :ach_class
+
+    # Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.
+    attr_accessor :origination_account_id
+
+    attr_accessor :user
+
+    # The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters 
+    attr_accessor :metadata
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_id' => :'client_id',
+        :'secret' => :'secret',
+        :'account_id' => :'account_id',
+        :'mode' => :'mode',
+        :'amount' => :'amount',
+        :'description' => :'description',
+        :'ach_class' => :'ach_class',
+        :'origination_account_id' => :'origination_account_id',
+        :'user' => :'user',
+        :'metadata' => :'metadata'
+      }
+    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',
+        :'account_id' => :'String',
+        :'mode' => :'TransferIntentCreateMode',
+        :'amount' => :'String',
+        :'description' => :'String',
+        :'ach_class' => :'ACHClass',
+        :'origination_account_id' => :'String',
+        :'user' => :'TransferUserInRequest',
+        :'metadata' => :'Hash<String, String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'origination_account_id',
+        :'metadata'
+      ])
+    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::TransferIntentCreateRequest` 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::TransferIntentCreateRequest`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'ach_class')
+        self.ach_class = attributes[:'ach_class']
+      end
+
+      if attributes.key?(:'origination_account_id')
+        self.origination_account_id = attributes[:'origination_account_id']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = 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 @client_id.nil?
+        invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
+      end
+
+      if @secret.nil?
+        invalid_properties.push('invalid value for "secret", secret cannot be nil.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @description.to_s.length > 8
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 8.')
+      end
+
+
+      if @ach_class.nil?
+        invalid_properties.push('invalid value for "ach_class", ach_class cannot be nil.')
+      end
+
+      if @user.nil?
+        invalid_properties.push('invalid value for "user", user 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 @client_id.nil?
+      return false if @secret.nil?
+      return false if @mode.nil?
+      return false if @amount.nil?
+      return false if @description.nil?
+      return false if @description.to_s.length > 8
+      return false if @ach_class.nil?
+      return false if @user.nil?
+      return false if !@metadata.nil? && @metadata.length > 50
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 8
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 8.'
+      end
+
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+
+      @metadata = metadata
+    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 &&
+          account_id == o.account_id &&
+          mode == o.mode &&
+          amount == o.amount &&
+          description == o.description &&
+          ach_class == o.ach_class &&
+          origination_account_id == o.origination_account_id &&
+          user == o.user &&
+          metadata == o.metadata
+    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, account_id, mode, amount, description, ach_class, origination_account_id, user, metadata].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