plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 15.3.0

data/lib/plaid/models/simulated_transfer_sweep.rb

@@ -0,0 +1,277 @@
+=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.97.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # A sweep returned from the `/sandbox/transfer/sweep/simulate` endpoint. Can be null if there are no transfers to include in a sweep.
+  class SimulatedTransferSweep
+    # Identifier of the sweep.
+    attr_accessor :id
+
+    # The datetime when the sweep occurred, in RFC 3339 format.
+    attr_accessor :created
+
+    # Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. \"-10.00\")  If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
+    attr_accessor :amount
+
+    # The currency of the sweep, e.g. \"USD\".
+    attr_accessor :iso_currency_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'amount' => :'amount',
+        :'iso_currency_code' => :'iso_currency_code'
+      }
+    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',
+        :'created' => :'Time',
+        :'amount' => :'String',
+        :'iso_currency_code' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'TransferSweep'
+      ]
+    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::SimulatedTransferSweep` 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::SimulatedTransferSweep`. 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?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'iso_currency_code')
+        self.iso_currency_code = attributes[:'iso_currency_code']
+      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 @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @iso_currency_code.nil?
+        invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code 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 @created.nil?
+      return false if @amount.nil?
+      return false if @iso_currency_code.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 &&
+          id == o.id &&
+          created == o.created &&
+          amount == o.amount &&
+          iso_currency_code == o.iso_currency_code
+    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, created, amount, iso_currency_code].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/standalone_account_type.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # The schema below describes the various `types` and corresponding `subtypes` that Plaid recognizes and reports for financial institution accounts.
   class StandaloneAccountType
-    # An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth, Balance, Transactions, Identity, Payment Initiation, and Assets.
+    # An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth (`checking` and `savings` types only), Balance, Transactions, Identity, Payment Initiation, and Assets.
     attr_accessor :depository
 
     # A credit card type account. Supported products for `credit` accounts are: Balance, Transactions, Identity, and Liabilities.
@@ -25,7 +25,7 @@ module Plaid
     # A loan type account. Supported products for `loan` accounts are: Balance, Liabilities, and Transactions.
     attr_accessor :loan
 
-    # An investment account. Supported products for `investment` accounts are: Balance and Investments.
+    # An investment account. Supported products for `investment` accounts are: Balance and Investments. In API versions 2018-05-22 and earlier, this type is called `brokerage`.
     attr_accessor :investment
 
     # Other or unknown account type. Supported products for `other` accounts are: Balance, Transactions, Identity, and Assets.

data/lib/plaid/models/standalone_currency_code_list.rb

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

data/lib/plaid/models/standalone_investment_transaction_type.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Valid values for investment transaction types
+  # Valid values for investment transaction types and subtypes. Note that transactions representing inflow of cash will appear as negative amounts, outflow of cash will appear as positive amounts.
   class StandaloneInvestmentTransactionType
     # Buying an investment
     attr_accessor :buy
@@ -31,7 +31,7 @@ module Plaid
     # Fees on the account, e.g. commission, bookkeeping, options-related.
     attr_accessor :fee
 
-    # Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
+    # Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
     attr_accessor :transfer
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/plaid/models/student_loan.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -22,10 +22,10 @@ module Plaid
     # The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).
     attr_accessor :account_number
 
-    # The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :disbursement_dates
 
-    # The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :expected_payoff_date
 
     # The guarantor of the student loan.
@@ -40,10 +40,10 @@ module Plaid
     # The amount of the last payment.
     attr_accessor :last_payment_amount
 
-    # The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :last_payment_date
 
-    # The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :last_statement_issue_date
 
     # The type of loan, e.g., \"Consolidation Loans\".
@@ -51,13 +51,13 @@ module Plaid
 
     attr_accessor :loan_status
 
-    # The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) will display as $0 if there is an autopay program in effect.
+    # The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) and Navient (`ins_116248`) will display as $0 if there is an autopay program in effect.
     attr_accessor :minimum_payment_amount
 
-    # The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :next_payment_due_date
 
-    # The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD). 
+    # The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). 
     attr_accessor :origination_date
 
     # The original principal balance of the loan.
@@ -124,19 +124,19 @@ module Plaid
       {
         :'account_id' => :'String',
         :'account_number' => :'String',
-        :'disbursement_dates' => :'Array<String>',
-        :'expected_payoff_date' => :'String',
+        :'disbursement_dates' => :'Array<Date>',
+        :'expected_payoff_date' => :'Date',
         :'guarantor' => :'String',
         :'interest_rate_percentage' => :'Float',
         :'is_overdue' => :'Boolean',
         :'last_payment_amount' => :'Float',
-        :'last_payment_date' => :'String',
-        :'last_statement_issue_date' => :'String',
+        :'last_payment_date' => :'Date',
+        :'last_statement_issue_date' => :'Date',
         :'loan_name' => :'String',
         :'loan_status' => :'StudentLoanStatus',
         :'minimum_payment_amount' => :'Float',
-        :'next_payment_due_date' => :'String',
-        :'origination_date' => :'String',
+        :'next_payment_due_date' => :'Date',
+        :'origination_date' => :'Date',
         :'origination_principal_amount' => :'Float',
         :'outstanding_interest_amount' => :'Float',
         :'payment_reference_number' => :'String',
@@ -296,6 +296,22 @@ module Plaid
         invalid_properties.push('invalid value for "interest_rate_percentage", interest_rate_percentage cannot be nil.')
       end
 
+      if @loan_status.nil?
+        invalid_properties.push('invalid value for "loan_status", loan_status cannot be nil.')
+      end
+
+      if @pslf_status.nil?
+        invalid_properties.push('invalid value for "pslf_status", pslf_status cannot be nil.')
+      end
+
+      if @repayment_plan.nil?
+        invalid_properties.push('invalid value for "repayment_plan", repayment_plan cannot be nil.')
+      end
+
+      if @servicer_address.nil?
+        invalid_properties.push('invalid value for "servicer_address", servicer_address cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -303,6 +319,10 @@ module Plaid
     # @return true if the model is valid
     def valid?
       return false if @interest_rate_percentage.nil?
+      return false if @loan_status.nil?
+      return false if @pslf_status.nil?
+      return false if @repayment_plan.nil?
+      return false if @servicer_address.nil?
       true
     end
 

data/lib/plaid/models/student_loan_repayment_model.rb

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

data/lib/plaid/models/student_loan_status.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # An object representing the status of the student loan
   class StudentLoanStatus
-    # The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD). 
+    # The date until which the loan will be in its current status. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). 
     attr_accessor :end_date
 
     # The status type of the student loan
@@ -60,7 +60,7 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'end_date' => :'String',
+        :'end_date' => :'Date',
         :'type' => :'String'
       }
     end

data/lib/plaid/models/student_repayment_plan.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -107,7 +107,7 @@ module Plaid
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard"])
+      type_validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard", "null"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -115,7 +115,7 @@ module Plaid
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard"])
+      validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard", "null"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end