14.11.0

plaid · Jan 6, 2022 · 9eb9468 · 9eb9468
1 parent 989e25a
commit 9eb9468
Show file tree

Hide file tree

Showing 520 changed files with 1,581 additions and 803 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -85,7 +85,6 @@ docs/BankTransferNetwork.md
 docs/BankTransferReceiverDetails.md
 docs/BankTransferStatus.md
 docs/BankTransferSweep.md
-docs/BankTransferSweepAccount.md
 docs/BankTransferSweepGetRequest.md
 docs/BankTransferSweepGetResponse.md
 docs/BankTransferSweepListRequest.md
@@ -172,6 +171,7 @@ docs/IncomeVerificationPaystubsGetResponse.md
 docs/IncomeVerificationPrecheckConfidence.md
 docs/IncomeVerificationPrecheckEmployer.md
 docs/IncomeVerificationPrecheckEmployerAddress.md
+docs/IncomeVerificationPrecheckEmployerAddressData.md
 docs/IncomeVerificationPrecheckMilitaryInfo.md
 docs/IncomeVerificationPrecheckRequest.md
 docs/IncomeVerificationPrecheckResponse.md
@@ -316,6 +316,7 @@ docs/PaymentInitiationRefund.md
 docs/PaymentInitiationStandingOrderMetadata.md
 docs/PaymentMeta.md
 docs/PaymentScheduleInterval.md
+docs/PaymentScheme.md
 docs/PaymentStatusUpdateWebhook.md
 docs/Paystub.md
 docs/PaystubAddress.md
@@ -334,6 +335,7 @@ docs/PendingExpirationWebhook.md
 docs/PersonalFinanceCategory.md
 docs/PhoneNumber.md
 docs/PlaidApi.md
+docs/PlaidError.md
 docs/PlatformIds.md
 docs/ProcessorApexProcessorTokenCreateRequest.md
 docs/ProcessorAuthGetRequest.md
@@ -404,6 +406,7 @@ docs/SignalReturnReportRequest.md
 docs/SignalReturnReportResponse.md
 docs/SignalScores.md
 docs/SignalUser.md
+docs/SimulatedTransferSweep.md
 docs/StandaloneAccountType.md
 docs/StandaloneCurrencyCodeList.md
 docs/StandaloneInvestmentTransactionType.md
@@ -597,7 +600,6 @@ lib/plaid/models/bank_transfer_network.rb
 lib/plaid/models/bank_transfer_receiver_details.rb
 lib/plaid/models/bank_transfer_status.rb
 lib/plaid/models/bank_transfer_sweep.rb
-lib/plaid/models/bank_transfer_sweep_account.rb
 lib/plaid/models/bank_transfer_sweep_get_request.rb
 lib/plaid/models/bank_transfer_sweep_get_response.rb
 lib/plaid/models/bank_transfer_sweep_list_request.rb
@@ -684,6 +686,7 @@ lib/plaid/models/income_verification_paystubs_get_response.rb
 lib/plaid/models/income_verification_precheck_confidence.rb
 lib/plaid/models/income_verification_precheck_employer.rb
 lib/plaid/models/income_verification_precheck_employer_address.rb
+lib/plaid/models/income_verification_precheck_employer_address_data.rb
 lib/plaid/models/income_verification_precheck_military_info.rb
 lib/plaid/models/income_verification_precheck_request.rb
 lib/plaid/models/income_verification_precheck_response.rb
@@ -827,6 +830,7 @@ lib/plaid/models/payment_initiation_refund.rb
 lib/plaid/models/payment_initiation_standing_order_metadata.rb
 lib/plaid/models/payment_meta.rb
 lib/plaid/models/payment_schedule_interval.rb
+lib/plaid/models/payment_scheme.rb
 lib/plaid/models/payment_status_update_webhook.rb
 lib/plaid/models/paystub.rb
 lib/plaid/models/paystub_address.rb
@@ -844,6 +848,7 @@ lib/plaid/models/paystub_ytd_details.rb
 lib/plaid/models/pending_expiration_webhook.rb
 lib/plaid/models/personal_finance_category.rb
 lib/plaid/models/phone_number.rb
+lib/plaid/models/plaid_error.rb
 lib/plaid/models/platform_ids.rb
 lib/plaid/models/processor_apex_processor_token_create_request.rb
 lib/plaid/models/processor_auth_get_request.rb
@@ -915,6 +920,7 @@ lib/plaid/models/signal_return_report_request.rb
 lib/plaid/models/signal_return_report_response.rb
 lib/plaid/models/signal_scores.rb
 lib/plaid/models/signal_user.rb
+lib/plaid/models/simulated_transfer_sweep.rb
 lib/plaid/models/standalone_account_type.rb
 lib/plaid/models/standalone_currency_code_list.rb
 lib/plaid/models/standalone_investment_transaction_type.rb

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 14.11.0
+- Updating to OAS 2020-09-14_1.61.0
+
 # 14.10.0
 - Updating to OAS 2020-09-14_1.58.1
 

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (14.10.0)
+    plaid (14.11.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM

diff --git a/Makefile b/Makefile
@@ -1,2 +1,2 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=14.10.0
+RUBY_PACKAGE_VERSION=14.11.0
diff --git a/README.md b/README.md
@@ -78,6 +78,10 @@ client = Plaid::Configuration.new do |builder|
   builder.options[:timeout] = 60*20    # 20 minutes
 end
 ```
+## Data type differences from API and from previous versions
+
+### Dates
+Dates and date times in requests and responses, which are represented as strings in the API and in previous client library versions, are represented in this version of the library as Ruby `Date` or `DateTime` objects. 
 
 ## Examples
 
@@ -162,6 +166,7 @@ while transactions.length < transaction_response.total_transactions
   transactions_get_request.access_token = access_token
   transactions_get_request.start_date = "2020-01-01"
   transactions_get_request.end_date = "2021-01-01"
+  transactions_get_request.options = options_payload
 
   transaction_response = client.transactions_get(transactions_get_request)
   transactions += transaction_response.transactions

diff --git a/lib/plaid.rb b/lib/plaid.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -104,7 +104,6 @@
 require 'plaid/models/bank_transfer_receiver_details'
 require 'plaid/models/bank_transfer_status'
 require 'plaid/models/bank_transfer_sweep'
-require 'plaid/models/bank_transfer_sweep_account'
 require 'plaid/models/bank_transfer_sweep_get_request'
 require 'plaid/models/bank_transfer_sweep_get_response'
 require 'plaid/models/bank_transfer_sweep_list_request'
@@ -191,6 +190,7 @@
 require 'plaid/models/income_verification_precheck_confidence'
 require 'plaid/models/income_verification_precheck_employer'
 require 'plaid/models/income_verification_precheck_employer_address'
+require 'plaid/models/income_verification_precheck_employer_address_data'
 require 'plaid/models/income_verification_precheck_military_info'
 require 'plaid/models/income_verification_precheck_request'
 require 'plaid/models/income_verification_precheck_response'
@@ -335,6 +335,7 @@
 require 'plaid/models/payment_initiation_standing_order_metadata'
 require 'plaid/models/payment_meta'
 require 'plaid/models/payment_schedule_interval'
+require 'plaid/models/payment_scheme'
 require 'plaid/models/payment_status_update_webhook'
 require 'plaid/models/paystub'
 require 'plaid/models/paystub_address'
@@ -352,6 +353,7 @@
 require 'plaid/models/pending_expiration_webhook'
 require 'plaid/models/personal_finance_category'
 require 'plaid/models/phone_number'
+require 'plaid/models/plaid_error'
 require 'plaid/models/platform_ids'
 require 'plaid/models/processor_apex_processor_token_create_request'
 require 'plaid/models/processor_auth_get_request'
@@ -422,6 +424,7 @@
 require 'plaid/models/signal_return_report_response'
 require 'plaid/models/signal_scores'
 require 'plaid/models/signal_user'
+require 'plaid/models/simulated_transfer_sweep'
 require 'plaid/models/standalone_account_type'
 require 'plaid/models/standalone_currency_code_list'
 require 'plaid/models/standalone_investment_transaction_type'

diff --git a/lib/plaid/api/plaid_api.rb b/lib/plaid/api/plaid_api.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -85,7 +85,7 @@ def accounts_balance_get_with_http_info(accounts_balance_get_request, opts = {})
     end
 
     # Retrieve accounts
-    # The `/accounts/get`  endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
+    # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.  This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
     # @param accounts_get_request [AccountsGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountsGetResponse]
@@ -95,7 +95,7 @@ def accounts_get(accounts_get_request, opts = {})
     end
 
     # Retrieve accounts
-    # The &#x60;/accounts/get&#x60;  endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use &#x60;/accounts/balance/get&#x60; instead.
+    # The &#x60;/accounts/get&#x60; endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.  This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [&#x60;NEW_ACCOUNTS_AVAILABLE&#x60;](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link&#39;s [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use &#x60;/accounts/balance/get&#x60; instead. Note that some information is nullable.
     # @param accounts_get_request [AccountsGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -5280,8 +5280,8 @@ def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request,
       return data, status_code, headers
     end
 
-    # Simulate creating a sweep for a set of transfers
-    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.
+    # Simulate creating a sweep
+    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.  - All `posted` or `pending` Transfers with sweep_status `unswept` will become `swept` - All `reversed` Transfers with sweep_status `swept` will become `reverse_swept`
     # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxTransferSweepSimulateResponse]
@@ -5290,8 +5290,8 @@ def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opt
       data
     end
 
-    # Simulate creating a sweep for a set of transfers
-    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment.
+    # Simulate creating a sweep
+    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment.  - All &#x60;posted&#x60; or &#x60;pending&#x60; Transfers with sweep_status &#x60;unswept&#x60; will become &#x60;swept&#x60; - All &#x60;reversed&#x60; Transfers with sweep_status &#x60;swept&#x60; will become &#x60;reverse_swept&#x60;
     # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers

diff --git a/lib/plaid/api_client.rb b/lib/plaid/api_client.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -30,7 +30,7 @@ class ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Plaid Ruby v14.10.0"
+      @user_agent = "Plaid Ruby v14.11.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,

diff --git a/lib/plaid/api_error.rb b/lib/plaid/api_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/configuration.rb b/lib/plaid/configuration.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_access.rb b/lib/plaid/models/account_access.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_assets.rb b/lib/plaid/models/account_assets.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_assets_all_of.rb b/lib/plaid/models/account_assets_all_of.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_balance.rb b/lib/plaid/models/account_balance.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_base.rb b/lib/plaid/models/account_base.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_filter.rb b/lib/plaid/models/account_filter.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_filters_response.rb b/lib/plaid/models/account_filters_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_identity.rb b/lib/plaid/models/account_identity.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_identity_all_of.rb b/lib/plaid/models/account_identity_all_of.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_product_access.rb b/lib/plaid/models/account_product_access.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_product_access_nullable.rb b/lib/plaid/models/account_product_access_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_selection_cardinality.rb b/lib/plaid/models/account_selection_cardinality.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_subtype.rb b/lib/plaid/models/account_subtype.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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/account_type.rb b/lib/plaid/models/account_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/accounts_balance_get_request.rb b/lib/plaid/models/accounts_balance_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

diff --git a/lib/plaid/models/accounts_balance_get_request_options.rb b/lib/plaid/models/accounts_balance_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.58.1
+The version of the OpenAPI document: 2020-09-14_1.61.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0