velopayments 2.18.113 → 2.19.40.beta1

data/docs/{DefaultApi.md → FundingManagerPrivateApi.md}

@@ -1,10 +1,10 @@
-# VeloPayments::DefaultApi
+# VeloPayments::FundingManagerPrivateApi
 
 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**](FundingManagerPrivateApi.md#create_funding_account) | **POST** /v1/fundingAccounts | Create Funding Account
 
 
 
@@ -27,7 +27,7 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::DefaultApi.new
+api_instance = VeloPayments::FundingManagerPrivateApi.new
 opts = {
   create_funding_account_request: VeloPayments::CreateFundingAccountRequest.new # CreateFundingAccountRequest | 
 }
@@ -36,7 +36,7 @@ begin
   #Create Funding Account
   api_instance.create_funding_account(opts)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling DefaultApi->create_funding_account: #{e}"
+  puts "Exception when calling FundingManagerPrivateApi->create_funding_account: #{e}"
 end
 ```
 

data/docs/GetPaymentsForPayoutResponseV4.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **summary** | [**GetPaymentsForPayoutResponseV4Summary**](GetPaymentsForPayoutResponseV4Summary.md) |  | [optional] 
-**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) |  | [optional] 
 **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV4>**](PaymentResponseV4.md) |  | [optional] 
 

data/docs/GetPayoutApi.md

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

data/docs/GetPayoutsResponseV4.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) |  | [optional] 
 **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PayoutSummaryAuditV4>**](PayoutSummaryAuditV4.md) |  | [optional] 
 

data/docs/Individual.md

@@ -0,0 +1,21 @@
+# VeloPayments::Individual
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+**national_identification** | **String** | If not authorized to view, value will be masked. Example: XXXXX1234 | [optional] [readonly] 
+**date_of_birth** | **String** | If not authorized to view, value will be masked. Example: - XXXX-XX-XX | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Individual.new(name: null,
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
+```
+
+

data/docs/Individual2.md

@@ -0,0 +1,21 @@
+# VeloPayments::Individual2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+**national_identification** | **String** | If not authorized to view, value will be masked. Example: XXXXX1234 | [optional] [readonly] 
+**date_of_birth** | **String** | If not authorized to view, value will be masked. Example: - XXXX-XX-XX | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Individual2.new(name: null,
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
+```
+
+

data/docs/IndividualV1.md

@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::IndividualV1.new(name: null,
-                                 national_identification: null,
-                                 date_of_birth: null)
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
 ```
 
 

data/docs/IndividualV1Name.md

@@ -14,10 +14,10 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::IndividualV1Name.new(title: null,
-                                 first_name: null,
-                                 other_names: null,
-                                 last_name: null)
+instance = VeloPayments::IndividualV1Name.new(title: Mr,
+                                 first_name: Bob,
+                                 other_names: A,
+                                 last_name: Smith)
 ```
 
 

data/docs/InlineResponse400.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse400
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse400Errors>**](InlineResponse400Errors.md) | one or more errors | [optional] 
+**correlation_id** | **String** | a unique identifier to track a request or related sequence of requests | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse400.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse400Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse400Errors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | verbose message indicating the nature of the error Will be localised  | [optional] 
+**location** | **String** | the property or object that caused the error | [optional] 
+**location_type** | [**LocationType**](LocationType.md) |  | [optional] 
+**reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse400Errors.new(error_message: smsNumber must be in the E.164 format e.g. +15551231234,
+                                 location: smsNumber,
+                                 location_type: null,
+                                 reason_code: validationError)
+```
+
+

data/docs/InlineResponse401.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse401
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse401Errors>**](InlineResponse401Errors.md) | one or more errors | [optional] 
+**correlation_id** | **String** | a unique identifier to track a request or related sequence of requests | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse401.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse401Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse401Errors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | verbose message indicating the nature of the error Will be localised  | [optional] 
+**location** | **String** | the property or object that caused the error | [optional] 
+**location_type** | [**LocationType**](LocationType.md) |  | [optional] 
+**reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse401Errors.new(error_message: Authentication is required and has not been provided or access has expired,
+                                 location: accessToken,
+                                 location_type: null,
+                                 reason_code: tokenExpired)
+```
+
+

data/docs/InlineResponse403.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse403
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse403Errors>**](InlineResponse403Errors.md) | one or more errors | [optional] 
+**correlation_id** | **String** | a unique identifier to track a request or related sequence of requests | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse403.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse403Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse403Errors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | verbose message indicating the nature of the error Will be localised  | [optional] 
+**location** | **String** | the property or object that caused the error | [optional] 
+**location_type** | [**LocationType**](LocationType.md) |  | [optional] 
+**reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse403Errors.new(error_message: The invoker does not have the required permissions to access the resource,
+                                 location: accessToken,
+                                 location_type: null,
+                                 reason_code: permissions)
+```
+
+

data/docs/InstructPayoutApi.md

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

data/docs/InvitePayeeRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::InvitePayeeRequest.new(payor_id: null)
+instance = VeloPayments::InvitePayeeRequest.new(payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e)
 ```
 
 

data/docs/{GenerateOTPRequest.md → InvitePayeeRequest2.md}

@@ -1,17 +1,17 @@
-# VeloPayments::GenerateOTPRequest
+# VeloPayments::InvitePayeeRequest2
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | [**OTPType**](OTPType.md) |  | 
+**payor_id** | **String** |  | 
 
 ## Code Sample
 
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GenerateOTPRequest.new(type: null)
+instance = VeloPayments::InvitePayeeRequest2.new(payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e)
 ```
 
 

data/docs/InviteUserRequest.md

@@ -5,7 +5,7 @@
 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  | 
+**mfa_type** | **String** | <p>The MFA type that the user will use</p> <p>The type may be conditional on the role(s) the user has</p>  | 
 **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] 
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::InviteUserRequest.new(email: foo@example.com,
-                                 mfa_type: null,
+                                 mfa_type: TOTP,
                                  sms_number: 11235555555,
                                  primary_contact_number: 11235555555,
                                  secondary_contact_number: 11235555550,

data/docs/{MFAStatus.md → Language2.md}

@@ -1,4 +1,4 @@
-# VeloPayments::MFAStatus
+# VeloPayments::Language2
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::MFAStatus.new()
+instance = VeloPayments::Language2.new()
 ```
 
 

data/docs/{TokenType.md → LocationType.md}

@@ -1,4 +1,4 @@
-# VeloPayments::TokenType
+# VeloPayments::LocationType
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::TokenType.new()
+instance = VeloPayments::LocationType.new()
 ```
 
 

data/docs/MarketingOptIn.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::MarketingOptIn.new(opted_in: null,
-                                 timestamp: null)
+                                 timestamp: 2019-01-20T09:00Z)
 ```
 
 

data/docs/{OTPType.md → OfacStatus2.md}

@@ -1,4 +1,4 @@
-# VeloPayments::OTPType
+# VeloPayments::OfacStatus2
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::OTPType.new()
+instance = VeloPayments::OfacStatus2.new()
 ```
 
 

data/docs/{PaymentStatus.md → OnboardedStatus2.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PaymentStatus
+# VeloPayments::OnboardedStatus2
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentStatus.new()
+instance = VeloPayments::OnboardedStatus2.new()
 ```