plaid 14.0.0.beta.2 → 14.0.0

data/docs/TransactionsGetResponse.md

@@ -1,26 +0,0 @@
-# Plaid::TransactionsGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **accounts** | [**Array<AccountBase>**](AccountBase.md) | An array containing the `accounts` associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the `account_id` field. |  |
-| **transactions** | [**Array<Transaction>**](Transaction.md) | An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the `count` parameter. |  |
-| **total_transactions** | **Integer** | The total number of transactions available within the date range specified. If `total_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter. |  |
-| **item** | [**Item**](Item.md) |  |  |
-| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionsGetResponse.new(
-  accounts: null,
-  transactions: null,
-  total_transactions: null,
-  item: null,
-  request_id: null
-)
-```
-

data/docs/TransactionsRefreshRequest.md

@@ -1,22 +0,0 @@
-# Plaid::TransactionsRefreshRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **access_token** | **String** | The access token associated with the Item data is being requested for. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionsRefreshRequest.new(
-  client_id: null,
-  access_token: null,
-  secret: null
-)
-```
-

data/docs/TransactionsRefreshResponse.md

@@ -1,18 +0,0 @@
-# Plaid::TransactionsRefreshResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionsRefreshResponse.new(
-  request_id: null
-)
-```
-

data/docs/TransactionsRemovedWebhook.md

@@ -1,26 +0,0 @@
-# Plaid::TransactionsRemovedWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `TRANSACTIONS` |  |
-| **webhook_code** | **String** | `TRANSACTIONS_REMOVED` |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-| **removed_transactions** | **Array<String>** | An array of `transaction_ids` corresponding to the removed transactions |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionsRemovedWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  error: null,
-  removed_transactions: null,
-  item_id: null
-)
-```
-

data/docs/UserCustomPassword.md

@@ -1,28 +0,0 @@
-# Plaid::UserCustomPassword
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **version** | **String** | The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite. | [optional] |
-| **seed** | **String** | A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument. If no seed is specified, the randomly generated data will be different each time.  Note that transactions data is generated relative to the Item's creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19. |  |
-| **override_accounts** | [**Array<OverrideAccounts>**](OverrideAccounts.md) | An array of account overrides to configure the accounts for the Item. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data. |  |
-| **mfa** | [**MFA**](MFA.md) |  |  |
-| **recaptcha** | **String** | You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field. Possible values are `good` or `bad`. A value of `good` will result in successful Item creation and `bad` will result in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link. |  |
-| **force_error** | **String** | An error code to force on Item creation. Possible values are:  `\"INSTITUTION_NOT_RESPONDING\"` `\"INSTITUTION_NO_LONGER_SUPPORTED\"` `\"INVALID_CREDENTIALS\"` `\"INVALID_MFA\"` `\"ITEM_LOCKED\"` `\"ITEM_LOGIN_REQUIRED\"` `\"ITEM_NOT_SUPPORTED\"` `\"INVALID_LINK_TOKEN\"` `\"MFA_NOT_SUPPORTED\"` `\"NO_ACCOUNTS\"` `\"PLAID_ERROR\"` `\"PRODUCTS_NOT_SUPPORTED\"` `\"USER_SETUP_REQUIRED\"` |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::UserCustomPassword.new(
-  version: null,
-  seed: null,
-  override_accounts: null,
-  mfa: null,
-  recaptcha: null,
-  force_error: null
-)
-```
-

data/docs/UserPermissionRevokedWebhook.md

@@ -1,24 +0,0 @@
-# Plaid::UserPermissionRevokedWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `ITEM` |  |
-| **webhook_code** | **String** | `USER_PERMISSION_REVOKED` |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::UserPermissionRevokedWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  item_id: null,
-  error: null
-)
-```
-

data/docs/VerificationExpiredWebhook.md

@@ -1,24 +0,0 @@
-# Plaid::VerificationExpiredWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `AUTH` |  |
-| **webhook_code** | **String** | `VERIFICATION_EXPIRED` |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-| **account_id** | **String** | The `account_id` of the account associated with the webhook |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::VerificationExpiredWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  item_id: null,
-  account_id: null
-)
-```
-

data/docs/VerificationStatus.md

@@ -1,15 +0,0 @@
-# Plaid::VerificationStatus
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::VerificationStatus.new()
-```
-

data/docs/Warning.md

@@ -1,22 +0,0 @@
-# Plaid::Warning
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **warning_type** | **String** | The warning type, which will always be `ASSET_REPORT_WARNING` |  |
-| **warning_code** | **String** | The warning code identifies a specific kind of warning. Currently, the only possible warning code is `OWNERS_UNAVAILABLE`, which indicates that account-owner information is not available. |  |
-| **cause** | [**Cause**](Cause.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Warning.new(
-  warning_type: null,
-  warning_code: null,
-  cause: null
-)
-```
-

data/docs/WebhookUpdateAcknowledgedWebhook.md

@@ -1,26 +0,0 @@
-# Plaid::WebhookUpdateAcknowledgedWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `ITEM` |  |
-| **webhook_code** | **String** | `WEBHOOK_UPDATE_ACKNOWLEDGED` |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-| **new_webhook_url** | **String** | The new webhook URL |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::WebhookUpdateAcknowledgedWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  item_id: null,
-  new_webhook_url: null,
-  error: null
-)
-```
-

data/docs/WebhookVerificationKeyGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::WebhookVerificationKeyGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **key_id** | **String** | The key ID ( `kid` ) from the JWT header. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::WebhookVerificationKeyGetRequest.new(
-  client_id: null,
-  secret: null,
-  key_id: null
-)
-```
-

data/docs/WebhookVerificationKeyGetResponse.md

@@ -1,20 +0,0 @@
-# Plaid::WebhookVerificationKeyGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | [**JWKPublicKey**](JWKPublicKey.md) |  |  |
-| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::WebhookVerificationKeyGetResponse.new(
-  key: null,
-  request_id: null
-)
-```
-

data/docs/YTDGrossIncomeSummaryFieldNumber.md

@@ -1,20 +0,0 @@
-# Plaid::YTDGrossIncomeSummaryFieldNumber
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Float** | The value of the field. |  |
-| **verification_status** | [**VerificationStatus**](VerificationStatus.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::YTDGrossIncomeSummaryFieldNumber.new(
-  value: null,
-  verification_status: null
-)
-```
-

data/docs/YTDNetIncomeSummaryFieldNumber.md

@@ -1,20 +0,0 @@
-# Plaid::YTDNetIncomeSummaryFieldNumber
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Float** | The value of the field. |  |
-| **verification_status** | [**VerificationStatus**](VerificationStatus.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::YTDNetIncomeSummaryFieldNumber.new(
-  value: null,
-  verification_status: null
-)
-```
-

data/lib/plaid/models/link_token_create_request_account_subtypes_depository.rb

@@ -1,222 +0,0 @@
-=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.5.3
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
-
-=end
-
-require 'date'
-require 'time'
-
-module Plaid
-  # A filter to apply to `depository`-type accounts
-  class LinkTokenCreateRequestAccountSubtypesDepository
-    # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema). 
-    attr_accessor :account_subtypes
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'account_subtypes' => :'account_subtypes'
-      }
-    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
-      {
-        :'account_subtypes' => :'Array<AccountSubtype>'
-      }
-    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::LinkTokenCreateRequestAccountSubtypesDepository` 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::LinkTokenCreateRequestAccountSubtypesDepository`. 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?(:'account_subtypes')
-        if (value = attributes[:'account_subtypes']).is_a?(Array)
-          self.account_subtypes = 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
-      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?
-      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 &&
-          account_subtypes == o.account_subtypes
-    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
-      [account_subtypes].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