15.6.0 (#427)

Co-authored-by: Matt Nguyen <[email protected]>

.openapi-generator/FILES

@@ -114,6 +114,8 @@ docs/CreateEntityScreeningRequest.md
 docs/CreateEntityWatchlistScreeningReviewRequest.md
 docs/CreateIndividualWatchlistScreeningReviewRequest.md
 docs/CreditAccountSubtype.md
+docs/CreditAuditCopyTokenCreateRequest.md
+docs/CreditAuditCopyTokenCreateResponse.md
 docs/CreditBankIncome.md
 docs/CreditBankIncomeAccount.md
 docs/CreditBankIncomeAccountType.md
@@ -745,8 +747,10 @@ docs/TransferUserAddressInResponse.md
 docs/TransferUserInRequest.md
 docs/TransferUserInResponse.md
 docs/UpdateEntityScreeningRequest.md
+docs/UpdateEntityScreeningRequestResettableField.md
 docs/UpdateEntityScreeningRequestSearchTerms.md
 docs/UpdateIndividualScreeningRequest.md
+docs/UpdateIndividualScreeningRequestResettableField.md
 docs/UpdateIndividualScreeningRequestSearchTerms.md
 docs/UserAddress.md
 docs/UserCreateRequest.md
@@ -769,6 +773,8 @@ docs/WalletCreateResponse.md
 docs/WalletGetRequest.md
 docs/WalletGetResponse.md
 docs/WalletISOCurrencyCode.md
+docs/WalletListRequest.md
+docs/WalletListResponse.md
 docs/WalletNumbers.md
 docs/WalletTransaction.md
 docs/WalletTransactionAmount.md
@@ -927,6 +933,8 @@ lib/plaid/models/create_entity_screening_request.rb
 lib/plaid/models/create_entity_watchlist_screening_review_request.rb
 lib/plaid/models/create_individual_watchlist_screening_review_request.rb
 lib/plaid/models/credit_account_subtype.rb
+lib/plaid/models/credit_audit_copy_token_create_request.rb
+lib/plaid/models/credit_audit_copy_token_create_response.rb
 lib/plaid/models/credit_bank_income.rb
 lib/plaid/models/credit_bank_income_account.rb
 lib/plaid/models/credit_bank_income_account_type.rb
@@ -1557,8 +1565,10 @@ lib/plaid/models/transfer_user_address_in_response.rb
 lib/plaid/models/transfer_user_in_request.rb
 lib/plaid/models/transfer_user_in_response.rb
 lib/plaid/models/update_entity_screening_request.rb
+lib/plaid/models/update_entity_screening_request_resettable_field.rb
 lib/plaid/models/update_entity_screening_request_search_terms.rb
 lib/plaid/models/update_individual_screening_request.rb
+lib/plaid/models/update_individual_screening_request_resettable_field.rb
 lib/plaid/models/update_individual_screening_request_search_terms.rb
 lib/plaid/models/user_address.rb
 lib/plaid/models/user_create_request.rb
@@ -1581,6 +1591,8 @@ lib/plaid/models/wallet_create_response.rb
 lib/plaid/models/wallet_get_request.rb
 lib/plaid/models/wallet_get_response.rb
 lib/plaid/models/wallet_iso_currency_code.rb
+lib/plaid/models/wallet_list_request.rb
+lib/plaid/models/wallet_list_response.rb
 lib/plaid/models/wallet_numbers.rb
 lib/plaid/models/wallet_transaction.rb
 lib/plaid/models/wallet_transaction_amount.rb

CHANGELOG.md

@@ -1,5 +1,32 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 15.6.0
+- Updating to OAS 2020-09-14_1.121.0
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.121.0
+- Add TimestampNullable type
+
+### 2020-09-14_1.120.0
+- Removed `Uploaded`, `Created` and `APPROVAL_STATUS_APPROVED` enum strings from `PayrollItemStatus` field.
+
+### 2020-09-14_1.119.0
+- Add `returned` to TransferStatus enum
+- Add `return_swept` to TransferSweepStatus enum
+- Add `returned` and `return_swept` to TransferEventType enum
+
+### 2020-09-14_1.118.0
+- Added `employee_type` and `last_paystub_date` to `/credit/employment/get` response
+
+### 2020-09-14_1.117.1
+- Make `/payment_initiation/consent/create` API more strict
+
+### 2020-09-14_1.117.0
+- Add `/credit/audit_copy_token/create` endpoint
+
+### 2020-09-14_1.116.0
+- Add `/wallet/list` endpoint
+
 # 15.5.0
 - Updating to OAS 2020-09-14_1.115.2
 

Makefile

@@ -1,5 +1,5 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=15.5.0
+RUBY_PACKAGE_VERSION=15.6.0
 
 .PHONY: release
 release:

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.115.2
+The version of the OpenAPI document: 2020-09-14_1.121.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -133,6 +133,8 @@
 require 'plaid/models/create_entity_watchlist_screening_review_request'
 require 'plaid/models/create_individual_watchlist_screening_review_request'
 require 'plaid/models/credit_account_subtype'
+require 'plaid/models/credit_audit_copy_token_create_request'
+require 'plaid/models/credit_audit_copy_token_create_response'
 require 'plaid/models/credit_bank_income'
 require 'plaid/models/credit_bank_income_account'
 require 'plaid/models/credit_bank_income_account_type'
@@ -763,8 +765,10 @@
 require 'plaid/models/transfer_user_in_request'
 require 'plaid/models/transfer_user_in_response'
 require 'plaid/models/update_entity_screening_request'
+require 'plaid/models/update_entity_screening_request_resettable_field'
 require 'plaid/models/update_entity_screening_request_search_terms'
 require 'plaid/models/update_individual_screening_request'
+require 'plaid/models/update_individual_screening_request_resettable_field'
 require 'plaid/models/update_individual_screening_request_search_terms'
 require 'plaid/models/user_address'
 require 'plaid/models/user_create_request'
@@ -787,6 +791,8 @@
 require 'plaid/models/wallet_get_request'
 require 'plaid/models/wallet_get_response'
 require 'plaid/models/wallet_iso_currency_code'
+require 'plaid/models/wallet_list_request'
+require 'plaid/models/wallet_list_response'
 require 'plaid/models/wallet_numbers'
 require 'plaid/models/wallet_transaction'
 require 'plaid/models/wallet_transaction_amount'

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.115.2
+The version of the OpenAPI document: 2020-09-14_1.121.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -1904,6 +1904,71 @@ def create_payment_token_with_http_info(payment_initiation_payment_token_create_
       return data, status_code, headers
     end
 
+    # Create Asset or Income Report Audit Copy Token
+    # Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get).  To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
+    # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreditAuditCopyTokenCreateResponse]
+    def credit_audit_copy_token_create(credit_audit_copy_token_create_request, opts = {})
+      data, _status_code, _headers = credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts)
+      data
+    end
+
+    # Create Asset or Income Report Audit Copy Token
+    # Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get).  To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
+    # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
+    def credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_create ...'
+      end
+      # verify the required parameter 'credit_audit_copy_token_create_request' is set
+      if @api_client.config.client_side_validation && credit_audit_copy_token_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_create_request' when calling PlaidApi.credit_audit_copy_token_create"
+      end
+      # resource path
+      local_var_path = '/credit/audit_copy_token/create'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenCreateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.credit_audit_copy_token_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve information from the bank accounts used for income verification
     # `/credit/bank_income/get` returns the bank income report(s) for a specified user.
     # @param credit_bank_income_get_request [CreditBankIncomeGetRequest] 
@@ -2880,7 +2945,7 @@ def identity_get_with_http_info(identity_get_request, opts = {})
     end
 
     # Create a new identity verification
-    # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. 
+    # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. 
     # @param identity_verification_create_request [IdentityVerificationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [IdentityVerification]
@@ -2890,7 +2955,7 @@ def identity_verification_create(identity_verification_create_request, opts = {}
     end
 
     # Create a new identity verification
-    # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code. 
+    # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code. 
     # @param identity_verification_create_request [IdentityVerificationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(IdentityVerification, Integer, Hash)>] IdentityVerification data, response status code and response headers
@@ -6585,7 +6650,7 @@ def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request,
     end
 
     # Simulate creating a sweep
-    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `reversed` transfers with a sweep status of `swept` will become `reverse_swept`.
+    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
     # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxTransferSweepSimulateResponse]
@@ -6595,7 +6660,7 @@ def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opt
     end
 
     # Simulate creating a sweep
-    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;reversed&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;reverse_swept&#x60;.
+    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_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
@@ -8534,6 +8599,71 @@ def wallet_get_with_http_info(wallet_get_request, opts = {})
       return data, status_code, headers
     end
 
+    # Fetch a list of e-wallets
+    # This endpoint lists all e-wallets in descending order of creation.
+    # @param wallet_list_request [WalletListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [WalletListResponse]
+    def wallet_list(wallet_list_request, opts = {})
+      data, _status_code, _headers = wallet_list_with_http_info(wallet_list_request, opts)
+      data
+    end
+
+    # Fetch a list of e-wallets
+    # This endpoint lists all e-wallets in descending order of creation.
+    # @param wallet_list_request [WalletListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WalletListResponse, Integer, Hash)>] WalletListResponse data, response status code and response headers
+    def wallet_list_with_http_info(wallet_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_list ...'
+      end
+      # verify the required parameter 'wallet_list_request' is set
+      if @api_client.config.client_side_validation && wallet_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_list_request' when calling PlaidApi.wallet_list"
+      end
+      # resource path
+      local_var_path = '/wallet/list'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WalletListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.wallet_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaidApi#wallet_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Execute a transaction using an e-wallet
     # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
     # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]