velopayments 2.18.113 → 2.23.78.beta1

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/InlineResponse404.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse404
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse404Errors>**](InlineResponse404Errors.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::InlineResponse404.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse404Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse404Errors
+
+## 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::InlineResponse404Errors.new(error_message: The resource was not found,
+                                 location: paymentId,
+                                 location_type: null,
+                                 reason_code: permissions)
+```
+
+

data/docs/InlineResponse409.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse409
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse409Errors>**](InlineResponse409Errors.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::InlineResponse409.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse409Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse409Errors
+
+## 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::InlineResponse409Errors.new(error_message: The resource already exists,
+                                 location: email,
+                                 location_type: null,
+                                 reason_code: duplicateEmail)
+```
+
+

data/docs/InlineResponse412.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse412
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse412Errors>**](InlineResponse412Errors.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::InlineResponse412.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse412Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse412Errors
+
+## 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::InlineResponse412Errors.new(error_message: The request could not be completed as the pre conditions have not been met,
+                                 location: accessToken,
+                                 location_type: null,
+                                 reason_code: permissions)
+```
+
+

data/docs/InvitationStatus2.md

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

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/InvitePayeeRequest2.md

@@ -0,0 +1,17 @@
+# VeloPayments::InvitePayeeRequest2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+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/{TokenType.md → Language2.md}

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

data/docs/ListFundingAccountsResponse2.md

@@ -0,0 +1,21 @@
+# VeloPayments::ListFundingAccountsResponse2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**ListSourceAccountResponsePage**](ListSourceAccountResponsePage.md) |  | [optional] 
+**links** | [**Array<ListSourceAccountResponseLinks>**](ListSourceAccountResponseLinks.md) |  | [optional] 
+**content** | [**Array<FundingAccountResponse2>**](FundingAccountResponse2.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListFundingAccountsResponse2.new(page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md}

@@ -1,10 +1,10 @@
-# VeloPayments::ListPaymentsResponse
+# VeloPayments::ListPaymentsResponseV3
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**ListPaymentsResponsePage**](ListPaymentsResponsePage.md) |  | [optional] 
+**page** | [**ListPaymentsResponseV3Page**](ListPaymentsResponseV3Page.md) |  | [optional] 
 **links** | [**Array<GetPayoutsResponseV3Links>**](GetPayoutsResponseV3Links.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV3>**](PaymentResponseV3.md) |  | [optional] 
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::ListPaymentsResponse.new(page: null,
+instance = VeloPayments::ListPaymentsResponseV3.new(page: null,
                                  links: null,
                                  content: null)
 ```

data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md}

@@ -1,4 +1,4 @@
-# VeloPayments::ListPaymentsResponsePage
+# VeloPayments::ListPaymentsResponseV3Page
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::ListPaymentsResponsePage.new(number_of_elements: 12,
+instance = VeloPayments::ListPaymentsResponseV3Page.new(number_of_elements: 12,
                                  total_elements: 12,
                                  total_pages: 12,
                                  page: 1,

data/docs/ListPaymentsResponseV4.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**ListPaymentsResponsePage**](ListPaymentsResponsePage.md) |  | [optional] 
+**page** | [**ListPaymentsResponseV3Page**](ListPaymentsResponseV3Page.md) |  | [optional] 
 **links** | [**Array<GetPayoutsResponseV3Links>**](GetPayoutsResponseV3Links.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV4>**](PaymentResponseV4.md) |  | [optional] 
 

data/docs/ListSourceAccountResponseV2.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **page** | [**PagedUserResponsePage**](PagedUserResponsePage.md) |  | [optional] 
-**links** | [**Array<ListSourceAccountResponseLinks>**](ListSourceAccountResponseLinks.md) |  | [optional] 
+**links** | [**Array<ListSourceAccountResponseV2Links>**](ListSourceAccountResponseV2Links.md) |  | [optional] 
 **content** | [**Array<SourceAccountResponseV2>**](SourceAccountResponseV2.md) |  | [optional] 
 
 ## Code Sample

data/docs/ListSourceAccountResponseV2Links.md

@@ -0,0 +1,19 @@
+# VeloPayments::ListSourceAccountResponseV2Links
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListSourceAccountResponseV2Links.new(rel: first,
+                                 href: https://api.sandbox.velopayments.com/v2/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc)
+```
+
+

data/docs/ListSourceAccountResponseV3.md

@@ -0,0 +1,21 @@
+# VeloPayments::ListSourceAccountResponseV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**PagedUserResponsePage**](PagedUserResponsePage.md) |  | [optional] 
+**links** | [**Array<ListSourceAccountResponseV3Links>**](ListSourceAccountResponseV3Links.md) |  | [optional] 
+**content** | [**Array<SourceAccountResponseV3>**](SourceAccountResponseV3.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListSourceAccountResponseV3.new(page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/ListSourceAccountResponseV3Links.md

@@ -0,0 +1,19 @@
+# VeloPayments::ListSourceAccountResponseV3Links
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListSourceAccountResponseV3Links.new(rel: first,
+                                 href: https://api.sandbox.velopayments.com/v3/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc)
+```
+
+

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

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

data/docs/LoginApi.md

@@ -106,7 +106,7 @@ No authorization required
 
 ## validate_access_token
 
-> AccessTokenResponse validate_access_token(access_token_validation_request)
+> AccessTokenResponse validate_access_token(access_token_validation_request, opts)
 
 validate
 
@@ -125,10 +125,13 @@ end
 
 api_instance = VeloPayments::LoginApi.new
 access_token_validation_request = VeloPayments::AccessTokenValidationRequest.new # AccessTokenValidationRequest | An OTP from the user's registered MFA Device 
+opts = {
+  authorization: 'authorization_example' # String | Bearer token authorization leg of validate
+}
 
 begin
   #validate
-  result = api_instance.validate_access_token(access_token_validation_request)
+  result = api_instance.validate_access_token(access_token_validation_request, opts)
   p result
 rescue VeloPayments::ApiError => e
   puts "Exception when calling LoginApi->validate_access_token: #{e}"
@@ -141,6 +144,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **access_token_validation_request** | [**AccessTokenValidationRequest**](AccessTokenValidationRequest.md)| An OTP from the user's registered MFA Device  | 
+ **authorization** | **String**| Bearer token authorization leg of validate | [optional] 
 
 ### Return type