velopayments 2.17.8 → 2.18.31.beta1

data/docs/DefaultApi.md

@@ -0,0 +1,62 @@
+# VeloPayments::DefaultApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_funding_account**](DefaultApi.md#create_funding_account) | **POST** /v1/fundingAccounts | Create Funding Account
+
+
+
+## create_funding_account
+
+> create_funding_account(opts)
+
+Create Funding Account
+
+Create Funding Account
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::DefaultApi.new
+opts = {
+  create_funding_account_request: VeloPayments::CreateFundingAccountRequest.new # CreateFundingAccountRequest | 
+}
+
+begin
+  #Create Funding Account
+  api_instance.create_funding_account(opts)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling DefaultApi->create_funding_account: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_funding_account_request** | [**CreateFundingAccountRequest**](CreateFundingAccountRequest.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailUpdateRequest.md

@@ -0,0 +1,19 @@
+# VeloPayments::EmailUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the invited user | 
+**verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::EmailUpdateRequest.new(email: foo@example.com,
+                                 verification_code: 123456)
+```
+
+

data/docs/FundingAccountResponse.md

@@ -0,0 +1,27 @@
+# VeloPayments::FundingAccountResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Funding Account Id | [optional] 
+**payor_id** | **String** |  | [optional] 
+**account_name** | **String** |  | [optional] 
+**account_number** | **String** |  | [optional] 
+**routing_number** | **String** |  | [optional] 
+**source_account_ids** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingAccountResponse.new(id: null,
+                                 payor_id: null,
+                                 account_name: null,
+                                 account_number: null,
+                                 routing_number: null,
+                                 source_account_ids: null)
+```
+
+

data/docs/FundingManagerApi.md

@@ -6,13 +6,16 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_ach_funding_request**](FundingManagerApi.md#create_ach_funding_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/achFundingRequest | Create Funding Request
 [**create_funding_request**](FundingManagerApi.md#create_funding_request) | **POST** /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request
-[**get_fundings**](FundingManagerApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
+[**get_funding_account**](FundingManagerApi.md#get_funding_account) | **GET** /v1/fundingAccounts/{fundingAccountId} | Get Funding Account
+[**get_funding_accounts**](FundingManagerApi.md#get_funding_accounts) | **GET** /v1/fundingAccounts | Get Funding Accounts
+[**get_fundings_v1**](FundingManagerApi.md#get_fundings_v1) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
 [**get_source_account**](FundingManagerApi.md#get_source_account) | **GET** /v1/sourceAccounts/{sourceAccountId} | Get details about given source account.
 [**get_source_account_v2**](FundingManagerApi.md#get_source_account_v2) | **GET** /v2/sourceAccounts/{sourceAccountId} | Get details about given source account.
 [**get_source_accounts**](FundingManagerApi.md#get_source_accounts) | **GET** /v1/sourceAccounts | Get list of source accounts
 [**get_source_accounts_v2**](FundingManagerApi.md#get_source_accounts_v2) | **GET** /v2/sourceAccounts | Get list of source accounts
-[**list_funding_audit_deltas**](FundingManagerApi.md#list_funding_audit_deltas) | **GET** /v1/deltas/fundings | List Funding changes
+[**list_funding_audit_deltas**](FundingManagerApi.md#list_funding_audit_deltas) | **GET** /v1/deltas/fundings | Get Funding Audit Delta
 [**set_notifications_request**](FundingManagerApi.md#set_notifications_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications
+[**transfer_funds**](FundingManagerApi.md#transfer_funds) | **POST** /v2/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts
 
 
 
@@ -22,7 +25,7 @@ Method | HTTP request | Description
 
 Create Funding Request
 
-Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo  (202 - accepted, 400 - invalid request body, 404 - source account not found).
+Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
 
 ### Example
 
@@ -66,7 +69,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## create_funding_request
@@ -119,12 +122,132 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
+
+
+## get_funding_account
+
+> FundingAccountResponse get_funding_account(funding_account_id, opts)
+
+Get Funding Account
+
+Get Funding Account by ID
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::FundingManagerApi.new
+funding_account_id = 'funding_account_id_example' # String | 
+opts = {
+  sensitive: false # Boolean | 
+}
+
+begin
+  #Get Funding Account
+  result = api_instance.get_funding_account(funding_account_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->get_funding_account: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **funding_account_id** | [**String**](.md)|  | 
+ **sensitive** | **Boolean**|  | [optional] [default to false]
 
+### Return type
+
+[**FundingAccountResponse**](FundingAccountResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_funding_accounts
+
+> ListFundingAccountsResponse get_funding_accounts(opts)
 
-## get_fundings
+Get Funding Accounts
 
-> GetFundingsResponse get_fundings(opts)
+Get the source accounts.
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::FundingManagerApi.new
+opts = {
+  payor_id: 'payor_id_example', # String | 
+  source_account_id: 'source_account_id_example', # String | 
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
+  sort: 'accountName:asc', # String | 
+  sensitive: false # Boolean | 
+}
+
+begin
+  #Get Funding Accounts
+  result = api_instance.get_funding_accounts(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->get_funding_accounts: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)|  | [optional] 
+ **source_account_id** | [**String**](.md)|  | [optional] 
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
+ **sort** | **String**|  | [optional] [default to 'accountName:asc']
+ **sensitive** | **Boolean**|  | [optional] [default to false]
+
+### Return type
+
+[**ListFundingAccountsResponse**](ListFundingAccountsResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_fundings_v1
+
+> GetFundingsResponse get_fundings_v1(opts)
 
 Get Fundings for Payor
 
@@ -151,10 +274,10 @@ opts = {
 
 begin
   #Get Fundings for Payor
-  result = api_instance.get_fundings(opts)
+  result = api_instance.get_fundings_v1(opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling FundingManagerApi->get_fundings: #{e}"
+  puts "Exception when calling FundingManagerApi->get_fundings_v1: #{e}"
 end
 ```
 
@@ -412,11 +535,11 @@ Name | Type | Description  | Notes
 
 ## list_funding_audit_deltas
 
-> FundingDeltaResponse list_funding_audit_deltas(payor_id, updated_since, opts)
+> PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse list_funding_audit_deltas(payor_id, updated_since, opts)
 
-List Funding changes
+Get Funding Audit Delta
 
-Get a paginated response listing funding changes.
+Get funding audit deltas for a payor
 
 ### Example
 
@@ -430,15 +553,15 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::FundingManagerApi.new
-payor_id = 'payor_id_example' # String | The Payor ID to find associated funding records
-updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+payor_id = 'payor_id_example' # String | 
+updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | 
 opts = {
   page: 1, # Integer | Page number. Default is 1.
-  page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+  page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
 }
 
 begin
-  #List Funding changes
+  #Get Funding Audit Delta
   result = api_instance.list_funding_audit_deltas(payor_id, updated_since, opts)
   p result
 rescue VeloPayments::ApiError => e
@@ -451,14 +574,14 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The Payor ID to find associated funding records | 
- **updated_since** | **DateTime**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | 
+ **payor_id** | [**String**](.md)|  | 
+ **updated_since** | **DateTime**|  | 
  **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
- **page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
 
 ### Return type
 
-[**FundingDeltaResponse**](FundingDeltaResponse.md)
+[**PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse**](PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md)
 
 ### Authorization
 
@@ -520,5 +643,58 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
+
+
+## transfer_funds
+
+> transfer_funds(source_account_id, transfer_request)
+
+Transfer Funds between source accounts
+
+Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::FundingManagerApi.new
+source_account_id = 'source_account_id_example' # String | The 'from' source account id, which will be debited
+transfer_request = VeloPayments::TransferRequest.new # TransferRequest | Body
+
+begin
+  #Transfer Funds between source accounts
+  api_instance.transfer_funds(source_account_id, transfer_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->transfer_funds: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_account_id** | [**String**](.md)| The 'from' source account id, which will be debited | 
+ **transfer_request** | [**TransferRequest**](TransferRequest.md)| Body | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/FundingPayorStatusAuditResponse.md

@@ -0,0 +1,23 @@
+# VeloPayments::FundingPayorStatusAuditResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**funding_id** | **String** |  | [optional] 
+**amount** | **Integer** |  | [optional] 
+**currency** | [**CurrencyType**](CurrencyType.md) |  | [optional] 
+**status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingPayorStatusAuditResponse.new(funding_id: null,
+                                 amount: null,
+                                 currency: null,
+                                 status: null)
+```
+
+

data/docs/GenerateOTPRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::GenerateOTPRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**OTPType**](OTPType.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GenerateOTPRequest.new(type: null)
+```
+
+

data/docs/GetPaymentsForPayoutResponseV3Summary.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **payout_status** | **String** | The current status of the payout. | [optional] 
 **submitted_date_time** | **DateTime** | The date/time at which the payout was submitted. | [optional] 
 **instructed_date_time** | **DateTime** | The date/time at which the payout was instructed. | [optional] 
+**withdrawn_date_time** | **DateTime** | The date/time at which the payout was withdrawn. | [optional] 
 **payout_memo** | **String** | The memo attached to the payout. | [optional] 
 **total_payments** | **Integer** | The count of payments within the payout. | [optional] 
 **confirmed_payments** | **Integer** | The count of payments within the payout which have been confirmed. | [optional] 
@@ -22,6 +23,7 @@ require 'VeloPayments'
 instance = VeloPayments::GetPaymentsForPayoutResponseV3Summary.new(payout_status: null,
                                  submitted_date_time: null,
                                  instructed_date_time: null,
+                                 withdrawn_date_time: null,
                                  payout_memo: Payment Memo value,
                                  total_payments: 123,
                                  confirmed_payments: 123,

data/docs/GetPaymentsForPayoutResponseV4Summary.md

@@ -7,20 +7,21 @@ Name | Type | Description | Notes
 **payout_status** | **String** | The current status of the payout. | [optional] 
 **submitted_date_time** | **DateTime** | The date/time at which the payout was submitted. | [optional] 
 **instructed_date_time** | **DateTime** | The date/time at which the payout was instructed. | [optional] 
+**withdrawn_date_time** | **DateTime** |  | [optional] 
+**quoted_date_time** | **DateTime** | The date/time at which the payout was quoted. | [optional] 
 **payout_memo** | **String** | The memo attached to the payout. | [optional] 
+**total_payments** | **Integer** | The count of payments within the payout. | [optional] 
+**confirmed_payments** | **Integer** | The count of payments within the payout which have been confirmed. | [optional] 
+**released_payments** | **Integer** | The count of payments within the payout which have been released. | [optional] 
+**incomplete_payments** | **Integer** | The count of payments within the payout which are incomplete. | [optional] 
+**returned_payments** | **Integer** | The count of payments within the payout which have been returned. | [optional] 
 **payout_type** | [**PayoutTypeV4**](PayoutTypeV4.md) |  | [optional] 
-**quoted_date_time** | **DateTime** | The date/time at which the payout was quoted. | [optional] 
 **submitting** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 **payout_from** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 **payout_to** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 **quoted** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
 **instructed** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
 **withdrawn** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
-**total_payments** | **Integer** | The count of payments within the payout. | [optional] 
-**confirmed_payments** | **Integer** | The count of payments within the payout which have been confirmed. | [optional] 
-**released_payments** | **Integer** | The count of payments within the payout which have been released. | [optional] 
-**incomplete_payments** | **Integer** | The count of payments within the payout which are incomplete. | [optional] 
-**returned_payments** | **Integer** | The count of payments within the payout which have been returned. | [optional] 
 
 ## Code Sample
 
@@ -30,20 +31,21 @@ require 'VeloPayments'
 instance = VeloPayments::GetPaymentsForPayoutResponseV4Summary.new(payout_status: null,
                                  submitted_date_time: null,
                                  instructed_date_time: null,
+                                 withdrawn_date_time: null,
+                                 quoted_date_time: null,
                                  payout_memo: null,
+                                 total_payments: null,
+                                 confirmed_payments: null,
+                                 released_payments: null,
+                                 incomplete_payments: null,
+                                 returned_payments: null,
                                  payout_type: null,
-                                 quoted_date_time: null,
                                  submitting: null,
                                  payout_from: null,
                                  payout_to: null,
                                  quoted: null,
                                  instructed: null,
-                                 withdrawn: null,
-                                 total_payments: null,
-                                 confirmed_payments: null,
-                                 released_payments: null,
-                                 incomplete_payments: null,
-                                 returned_payments: null)
+                                 withdrawn: null)
 ```
 
 

data/docs/GetPayoutApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**v3_payouts_payout_id_get**](GetPayoutApi.md#v3_payouts_payout_id_get) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
+[**get_payout_summary_v3**](GetPayoutApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
 
 
 
-## v3_payouts_payout_id_get
+## get_payout_summary_v3
 
-> PayoutSummaryResponse v3_payouts_payout_id_get(payout_id)
+> PayoutSummaryResponse get_payout_summary_v3(payout_id)
 
 Get Payout Summary
 
@@ -32,10 +32,10 @@ payout_id = 'payout_id_example' # String | Id of the payout
 
 begin
   #Get Payout Summary
-  result = api_instance.v3_payouts_payout_id_get(payout_id)
+  result = api_instance.get_payout_summary_v3(payout_id)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling GetPayoutApi->v3_payouts_payout_id_get: #{e}"
+  puts "Exception when calling GetPayoutApi->get_payout_summary_v3: #{e}"
 end
 ```
 

data/docs/GetPayoutsResponseV3.md

@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**GetPayoutsResponseV3Summary**](GetPayoutsResponseV3Summary.md) |  | [optional] 
 **page** | [**GetPayoutsResponseV3Page**](GetPayoutsResponseV3Page.md) |  | [optional] 
 **links** | [**Array<GetPayoutsResponseV3Links>**](GetPayoutsResponseV3Links.md) |  | [optional] 
 **content** | [**Array<PayoutSummaryAuditV3>**](PayoutSummaryAuditV3.md) |  | [optional] 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GetPayoutsResponseV3.new(summary: null,
-                                 page: null,
+instance = VeloPayments::GetPayoutsResponseV3.new(page: null,
                                  links: null,
                                  content: null)
 ```

data/docs/GetPayoutsResponseV4.md

@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**PagedPayeeResponseSummary**](PagedPayeeResponseSummary.md) |  | [optional] 
 **page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
 **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PayoutSummaryAuditV4>**](PayoutSummaryAuditV4.md) |  | [optional] 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GetPayoutsResponseV4.new(summary: null,
-                                 page: null,
+instance = VeloPayments::GetPayoutsResponseV4.new(page: null,
                                  links: null,
                                  content: null)
 ```

data/docs/InstructPayoutApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**v3_payouts_payout_id_post**](InstructPayoutApi.md#v3_payouts_payout_id_post) | **POST** /v3/payouts/{payoutId} | Instruct Payout
+[**instruct_payout_v3**](InstructPayoutApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout
 
 
 
-## v3_payouts_payout_id_post
+## instruct_payout_v3
 
-> v3_payouts_payout_id_post(payout_id)
+> instruct_payout_v3(payout_id)
 
 Instruct Payout
 
@@ -32,9 +32,9 @@ payout_id = 'payout_id_example' # String | Id of the payout
 
 begin
   #Instruct Payout
-  api_instance.v3_payouts_payout_id_post(payout_id)
+  api_instance.instruct_payout_v3(payout_id)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling InstructPayoutApi->v3_payouts_payout_id_post: #{e}"
+  puts "Exception when calling InstructPayoutApi->instruct_payout_v3: #{e}"
 end
 ```
 

data/docs/InviteUserRequest.md

@@ -0,0 +1,35 @@
+# VeloPayments::InviteUserRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the invited user | 
+**mfa_type** | **String** | The MFA type that the user will use The type may be conditional on the role(s) the user has  | 
+**sms_number** | **String** | The phone number of a device that the user can receive sms messages on  | 
+**primary_contact_number** | **String** | The main contact number for the user  | 
+**secondary_contact_number** | **String** | The secondary contact number for the user  | [optional] 
+**roles** | **Array<String>** | The role(s) for the user The role must exist The role can be a custom role or a system role but the invoker must have the permissions to assign the role System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support  | 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**entity_id** | **String** | The payorId or null if the user is not a payor user  | [optional] 
+**verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InviteUserRequest.new(email: foo@example.com,
+                                 mfa_type: null,
+                                 sms_number: 11235555555,
+                                 primary_contact_number: 11235555555,
+                                 secondary_contact_number: 11235555550,
+                                 roles: ["payor.admin"],
+                                 first_name: John,
+                                 last_name: Doe,
+                                 entity_id: 7fffa261-ac68-49e6-b605-d24a444d9206,
+                                 verification_code: 123456)
+```
+
+

data/docs/KycState.md

@@ -0,0 +1,16 @@
+# VeloPayments::KycState
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::KycState.new()
+```
+
+