plaid 14.0.0.beta.4 → 14.2.0

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

data/lib/plaid/models/transaction_data.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -22,7 +22,7 @@ module Plaid
     # The amount of the transaction.
     attr_accessor :amount
 
-    # The date of the transaction, in ISO 8601 format (\"yyyy-mm-dd\").
+    # The date of the transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
     attr_accessor :date
 
     # A unique identifier for the end user's account.
@@ -52,7 +52,7 @@ module Plaid
       {
         :'description' => :'String',
         :'amount' => :'Float',
-        :'date' => :'String',
+        :'date' => :'Date',
         :'account_id' => :'String',
         :'transaction_id' => :'String'
       }

data/lib/plaid/models/transaction_override.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.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,10 +16,10 @@ require 'time'
 module Plaid
   # Data to populate as test transaction data. If not specified, random transactions will be generated instead.
   class TransactionOverride
-    # The date of the transaction, in ISO8601 (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached.
+    # The date of the transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached.
     attr_accessor :date_transacted
 
-    # The date the transaction posted, in ISO8601 (YYYY-MM-DD) format
+    # The date the transaction posted, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format
     attr_accessor :date_posted
 
     # The transaction amount. Can be negative.
@@ -50,8 +50,8 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'date_transacted' => :'String',
-        :'date_posted' => :'String',
+        :'date_transacted' => :'Date',
+        :'date_posted' => :'Date',
         :'amount' => :'Float',
         :'description' => :'String',
         :'currency' => :'String'

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

data/lib/plaid/models/transactions_get_request_options.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.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -25,12 +25,20 @@ module Plaid
     # The number of transactions to skip. The default value is 0.
     attr_accessor :offset
 
+    # Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
+    attr_accessor :include_original_description
+
+    # Include the `personal_finance_category` object in the response. This feature is currently in beta – to request access, contact transactions-feedback@plaid.com.
+    attr_accessor :include_personal_finance_category_beta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'account_ids' => :'account_ids',
         :'count' => :'count',
-        :'offset' => :'offset'
+        :'offset' => :'offset',
+        :'include_original_description' => :'include_original_description',
+        :'include_personal_finance_category_beta' => :'include_personal_finance_category_beta'
       }
     end
 
@@ -44,13 +52,16 @@ module Plaid
       {
         :'account_ids' => :'Array<String>',
         :'count' => :'Integer',
-        :'offset' => :'Integer'
+        :'offset' => :'Integer',
+        :'include_original_description' => :'Boolean',
+        :'include_personal_finance_category_beta' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'include_original_description',
       ])
     end
 
@@ -86,6 +97,18 @@ module Plaid
       else
         self.offset = 0
       end
+
+      if attributes.key?(:'include_original_description')
+        self.include_original_description = attributes[:'include_original_description']
+      else
+        self.include_original_description = false
+      end
+
+      if attributes.key?(:'include_personal_finance_category_beta')
+        self.include_personal_finance_category_beta = attributes[:'include_personal_finance_category_beta']
+      else
+        self.include_personal_finance_category_beta = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -151,7 +174,9 @@ module Plaid
       self.class == o.class &&
           account_ids == o.account_ids &&
           count == o.count &&
-          offset == o.offset
+          offset == o.offset &&
+          include_original_description == o.include_original_description &&
+          include_personal_finance_category_beta == o.include_personal_finance_category_beta
     end
 
     # @see the `==` method
@@ -163,7 +188,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_ids, count, offset].hash
+      [account_ids, count, offset, include_original_description, include_personal_finance_category_beta].hash
     end
 
     # Builds the object from hash

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

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

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

data/lib/plaid/models/transactions_removed_webhook.rb

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

data/lib/plaid/models/transfer.rb

@@ -0,0 +1,417 @@
+=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.31.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Represents a transfer within the Transfers API.
+  class Transfer
+    # Plaid’s unique identifier for a transfer.
+    attr_accessor :id
+
+    attr_accessor :ach_class
+
+    # The account ID that should be credited/debited for this transfer.
+    attr_accessor :account_id
+
+    attr_accessor :type
+
+    attr_accessor :user
+
+    # The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).
+    attr_accessor :amount
+
+    # The description of the transfer.
+    attr_accessor :description
+
+    # The datetime when this transfer was created. This will be of the form `2006-01-02T15:04:05Z`
+    attr_accessor :created
+
+    attr_accessor :status
+
+    attr_accessor :network
+
+    # When `true`, you can still cancel this transfer.
+    attr_accessor :cancellable
+
+    attr_accessor :failure_reason
+
+    # 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
+
+    # Plaid’s unique identifier for the origination account that was used for this transfer.
+    attr_accessor :origination_account_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'ach_class' => :'ach_class',
+        :'account_id' => :'account_id',
+        :'type' => :'type',
+        :'user' => :'user',
+        :'amount' => :'amount',
+        :'description' => :'description',
+        :'created' => :'created',
+        :'status' => :'status',
+        :'network' => :'network',
+        :'cancellable' => :'cancellable',
+        :'failure_reason' => :'failure_reason',
+        :'metadata' => :'metadata',
+        :'origination_account_id' => :'origination_account_id'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'ach_class' => :'ACHClass',
+        :'account_id' => :'String',
+        :'type' => :'TransferType',
+        :'user' => :'TransferUserInResponse',
+        :'amount' => :'String',
+        :'description' => :'String',
+        :'created' => :'Time',
+        :'status' => :'TransferStatus',
+        :'network' => :'TransferNetwork',
+        :'cancellable' => :'Boolean',
+        :'failure_reason' => :'TransferFailure',
+        :'metadata' => :'Hash<String, String>',
+        :'origination_account_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'failure_reason',
+        :'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::Transfer` 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::Transfer`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'ach_class')
+        self.ach_class = attributes[:'ach_class']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'network')
+        self.network = attributes[:'network']
+      end
+
+      if attributes.key?(:'cancellable')
+        self.cancellable = attributes[:'cancellable']
+      end
+
+      if attributes.key?(:'failure_reason')
+        self.failure_reason = attributes[:'failure_reason']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'origination_account_id')
+        self.origination_account_id = attributes[:'origination_account_id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @ach_class.nil?
+        invalid_properties.push('invalid value for "ach_class", ach_class cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @user.nil?
+        invalid_properties.push('invalid value for "user", user 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 @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @network.nil?
+        invalid_properties.push('invalid value for "network", network cannot be nil.')
+      end
+
+      if @cancellable.nil?
+        invalid_properties.push('invalid value for "cancellable", cancellable cannot be nil.')
+      end
+
+
+      if @origination_account_id.nil?
+        invalid_properties.push('invalid value for "origination_account_id", origination_account_id 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 @id.nil?
+      return false if @ach_class.nil?
+      return false if @account_id.nil?
+      return false if @type.nil?
+      return false if @user.nil?
+      return false if @amount.nil?
+      return false if @description.nil?
+      return false if @created.nil?
+      return false if @status.nil?
+      return false if @network.nil?
+      return false if @cancellable.nil?
+      return false if @metadata.length > 50
+      return false if @origination_account_id.nil?
+      true
+    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 &&
+          id == o.id &&
+          ach_class == o.ach_class &&
+          account_id == o.account_id &&
+          type == o.type &&
+          user == o.user &&
+          amount == o.amount &&
+          description == o.description &&
+          created == o.created &&
+          status == o.status &&
+          network == o.network &&
+          cancellable == o.cancellable &&
+          failure_reason == o.failure_reason &&
+          metadata == o.metadata &&
+          origination_account_id == o.origination_account_id
+    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
+      [id, ach_class, account_id, type, user, amount, description, created, status, network, cancellable, failure_reason, metadata, origination_account_id].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