plaid 15.10.0 → 16.0.0

data/lib/plaid/models/product_status_breakdown.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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
-  # A detailed breakdown of the institution's performance for a request type. The values for `success`, `error_plaid`, and `error_institution` sum to 1.
+  # A detailed breakdown of the institution's performance for a request type. The values for `success`, `error_plaid`, and `error_institution` sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see [Institution status details](https://plaid.com/docs/account/activity/#institution-status-details).
   class ProductStatusBreakdown
     # The percentage of login attempts that are successful, expressed as a decimal.
     attr_accessor :success

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

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

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

data/lib/plaid/models/pslf_status.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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is Fedloan (`ins_116527`). 
+  # Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is FedLoan (`ins_116527`). 
   class PSLFStatus
     # The estimated date borrower will have completed 120 qualifying monthly payments. Returned in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :estimated_eligibility_date

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

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

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

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

data/lib/plaid/models/{assets_relay_webhook.rb → recurring_transactions_update_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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,34 +14,30 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Fired when the Secondary Client successfully retrieves an Asset Report by calling `asset_report/relay/get`.
-  class AssetsRelayWebhook
-    # `ASSETS`
+  # Fired when an Item's recurring transactions data is updated. After receipt of this webhook, the updated data can be fetched from `/transactions/recurring/get`.
+  class RecurringTransactionsUpdateWebhook
+    # `TRANSACTIONS`
     attr_accessor :webhook_type
 
-    # `RELAY_EVENT`
+    # `RECURRING_TRANSACTIONS_UPDATE`
     attr_accessor :webhook_code
 
-    attr_accessor :relay_event
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    attr_accessor :item_id
 
-    # The id of the client with whom the Asset Report is being shared.
-    attr_accessor :secondary_client_id
+    # A list of `account_ids` for accounts that have new or updated recurring transactions data.
+    attr_accessor :account_ids
 
-    # The `asset_relay_token` that was created by calling `/asset_report/relay/create.
-    attr_accessor :asset_relay_token
-
-    # The `asset_report_id` that can be provided to `/asset_report/relay/get` to retrieve the Asset Report.
-    attr_accessor :asset_report_id
+    attr_accessor :environment
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'webhook_type' => :'webhook_type',
         :'webhook_code' => :'webhook_code',
-        :'relay_event' => :'relay_event',
-        :'secondary_client_id' => :'secondary_client_id',
-        :'asset_relay_token' => :'asset_relay_token',
-        :'asset_report_id' => :'asset_report_id'
+        :'item_id' => :'item_id',
+        :'account_ids' => :'account_ids',
+        :'environment' => :'environment'
       }
     end
 
@@ -55,10 +51,9 @@ module Plaid
       {
         :'webhook_type' => :'String',
         :'webhook_code' => :'String',
-        :'relay_event' => :'RelayEvent',
-        :'secondary_client_id' => :'String',
-        :'asset_relay_token' => :'String',
-        :'asset_report_id' => :'String'
+        :'item_id' => :'String',
+        :'account_ids' => :'Array<String>',
+        :'environment' => :'WebhookEnvironmentValues'
       }
     end
 
@@ -72,13 +67,13 @@ 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::AssetsRelayWebhook` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::RecurringTransactionsUpdateWebhook` 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::AssetsRelayWebhook`. 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::RecurringTransactionsUpdateWebhook`. 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
       }
@@ -91,20 +86,18 @@ module Plaid
         self.webhook_code = attributes[:'webhook_code']
       end
 
-      if attributes.key?(:'relay_event')
-        self.relay_event = attributes[:'relay_event']
-      end
-
-      if attributes.key?(:'secondary_client_id')
-        self.secondary_client_id = attributes[:'secondary_client_id']
+      if attributes.key?(:'item_id')
+        self.item_id = attributes[:'item_id']
       end
 
-      if attributes.key?(:'asset_relay_token')
-        self.asset_relay_token = attributes[:'asset_relay_token']
+      if attributes.key?(:'account_ids')
+        if (value = attributes[:'account_ids']).is_a?(Array)
+          self.account_ids = value
+        end
       end
 
-      if attributes.key?(:'asset_report_id')
-        self.asset_report_id = attributes[:'asset_report_id']
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
       end
     end
 
@@ -120,20 +113,16 @@ module Plaid
         invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.')
       end
 
-      if @relay_event.nil?
-        invalid_properties.push('invalid value for "relay_event", relay_event cannot be nil.')
-      end
-
-      if @secondary_client_id.nil?
-        invalid_properties.push('invalid value for "secondary_client_id", secondary_client_id cannot be nil.')
+      if @item_id.nil?
+        invalid_properties.push('invalid value for "item_id", item_id cannot be nil.')
       end
 
-      if @asset_relay_token.nil?
-        invalid_properties.push('invalid value for "asset_relay_token", asset_relay_token cannot be nil.')
+      if @account_ids.nil?
+        invalid_properties.push('invalid value for "account_ids", account_ids cannot be nil.')
       end
 
-      if @asset_report_id.nil?
-        invalid_properties.push('invalid value for "asset_report_id", asset_report_id cannot be nil.')
+      if @environment.nil?
+        invalid_properties.push('invalid value for "environment", environment cannot be nil.')
       end
 
       invalid_properties
@@ -144,10 +133,9 @@ module Plaid
     def valid?
       return false if @webhook_type.nil?
       return false if @webhook_code.nil?
-      return false if @relay_event.nil?
-      return false if @secondary_client_id.nil?
-      return false if @asset_relay_token.nil?
-      return false if @asset_report_id.nil?
+      return false if @item_id.nil?
+      return false if @account_ids.nil?
+      return false if @environment.nil?
       true
     end
 
@@ -158,10 +146,9 @@ module Plaid
       self.class == o.class &&
           webhook_type == o.webhook_type &&
           webhook_code == o.webhook_code &&
-          relay_event == o.relay_event &&
-          secondary_client_id == o.secondary_client_id &&
-          asset_relay_token == o.asset_relay_token &&
-          asset_report_id == o.asset_report_id
+          item_id == o.item_id &&
+          account_ids == o.account_ids &&
+          environment == o.environment
     end
 
     # @see the `==` method
@@ -173,7 +160,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_type, webhook_code, relay_event, secondary_client_id, asset_relay_token, asset_report_id].hash
+      [webhook_type, webhook_code, item_id, account_ids, environment].hash
     end
 
     # Builds the object from hash

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

data/lib/plaid/models/report_type.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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class ReportType
+    ASSETS = "assets".freeze
+    INCOME = "income".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/reporting_information.rb

@@ -0,0 +1,225 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Information about an report identifier and a report name.
+  class ReportingInformation
+    # No documentation available
+    attr_accessor :reporting_information_identifier
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reporting_information_identifier' => :'ReportingInformationIdentifier'
+      }
+    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
+      {
+        :'reporting_information_identifier' => :'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::ReportingInformation` 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::ReportingInformation`. 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?(:'reporting_information_identifier')
+        self.reporting_information_identifier = attributes[:'reporting_information_identifier']
+      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 @reporting_information_identifier.nil?
+        invalid_properties.push('invalid value for "reporting_information_identifier", reporting_information_identifier 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 @reporting_information_identifier.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 &&
+          reporting_information_identifier == o.reporting_information_identifier
+    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
+      [reporting_information_identifier].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/risk_signal_document_reference.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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1