velopayments 2.18.113 → 2.23.78.beta1

data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md}

@@ -1,11 +1,11 @@
-# VeloPayments::AcceptedPayment
+# VeloPayments::AcceptedPaymentV3
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **remote_id** | **String** |  | 
-**currency_type** | **String** |  | 
+**currency_type** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. | 
 **amount** | **Integer** |  | 
 **source_account_name** | **String** |  | 
 **payor_payment_id** | **String** |  | 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::AcceptedPayment.new(remote_id: remoteIdVal123,
+instance = VeloPayments::AcceptedPaymentV3.new(remote_id: remoteIdVal123,
                                  currency_type: USD,
                                  amount: 1234,
                                  source_account_name: Chase,

data/docs/AutoTopUpConfig2.md

@@ -0,0 +1,23 @@
+# VeloPayments::AutoTopUpConfig2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **Boolean** | Is auto top-up enabled? automatically trigger funding to top-up the source account balance when the balance falls below the configured minimum level. | 
+**min_balance** | **Integer** | When the payor balance falls below this level then auto top-up will be triggered. Note - This is in minor units. | [optional] 
+**target_balance** | **Integer** | When the payor balance falls below the min balance then auto top-up will request funds bring the balance to this level. Note - this is in minor units. | [optional] 
+**funding_account_id** | **String** | Id of funding account from which to pull funds when auto top-up is triggered.  Note - if this is not set then auto top-up is effectively disabled. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::AutoTopUpConfig2.new(enabled: true,
+                                 min_balance: 10000,
+                                 target_balance: 300000,
+                                 funding_account_id: 640ab1bd-8a6a-4603-a83a-1edbc3ed5689)
+```
+
+

data/docs/Challenge.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::Challenge.new(value: null,
-                                 description: null)
+instance = VeloPayments::Challenge.new(value: challenge test,
+                                 description: challenge description)
 ```
 
 

data/docs/Challenge2.md

@@ -0,0 +1,19 @@
+# VeloPayments::Challenge2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+**description** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Challenge2.new(value: challenge test,
+                                 description: challenge description)
+```
+
+

data/docs/Company.md

@@ -0,0 +1,21 @@
+# VeloPayments::Company
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**tax_id** | **String** | Company Tax Id must be between 6 and 30 characters long | [optional] 
+**operating_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Company.new(name: ABC Group Plc,
+                                 tax_id: 123123123,
+                                 operating_name: ABC Co)
+```
+
+

data/docs/Company2.md

@@ -0,0 +1,21 @@
+# VeloPayments::Company2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**tax_id** | **String** | Company Tax Id must be between 6 and 30 characters long | [optional] 
+**operating_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Company2.new(name: ABC Group Plc,
+                                 tax_id: 123123123,
+                                 operating_name: ABC Co)
+```
+
+

data/docs/CompanyResponse.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::CompanyResponse.new(name: null,
-                                 operating_name: null)
+instance = VeloPayments::CompanyResponse.new(name: ABC Ltd.,
+                                 operating_name: ABC)
 ```
 
 

data/docs/CompanyV1.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::CompanyV1.new(name: null,
-                                 tax_id: null,
-                                 operating_name: null)
+instance = VeloPayments::CompanyV1.new(name: ABC Ltd,
+                                 tax_id: 123,
+                                 operating_name: ABC)
 ```
 
 

data/docs/CountriesApi.md

@@ -4,19 +4,19 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**list_supported_countries**](CountriesApi.md#list_supported_countries) | **GET** /v2/supportedCountries | List Supported Countries
+[**list_payment_channel_rules_v1**](CountriesApi.md#list_payment_channel_rules_v1) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
 [**list_supported_countries_v1**](CountriesApi.md#list_supported_countries_v1) | **GET** /v1/supportedCountries | List Supported Countries
-[**v1_payment_channel_rules_get**](CountriesApi.md#v1_payment_channel_rules_get) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
+[**list_supported_countries_v2**](CountriesApi.md#list_supported_countries_v2) | **GET** /v2/supportedCountries | List Supported Countries
 
 
 
-## list_supported_countries
+## list_payment_channel_rules_v1
 
-> SupportedCountriesResponse2 list_supported_countries
+> PaymentChannelRulesResponse list_payment_channel_rules_v1
 
-List Supported Countries
+List Payment Channel Country Rules
 
-List the supported countries.
+List the country specific payment channel rules.
 
 ### Example
 
@@ -32,11 +32,11 @@ end
 api_instance = VeloPayments::CountriesApi.new
 
 begin
-  #List Supported Countries
-  result = api_instance.list_supported_countries
+  #List Payment Channel Country Rules
+  result = api_instance.list_payment_channel_rules_v1
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling CountriesApi->list_supported_countries: #{e}"
+  puts "Exception when calling CountriesApi->list_payment_channel_rules_v1: #{e}"
 end
 ```
 
@@ -46,7 +46,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**SupportedCountriesResponse2**](SupportedCountriesResponse2.md)
+[**PaymentChannelRulesResponse**](PaymentChannelRulesResponse.md)
 
 ### Authorization
 
@@ -64,18 +64,13 @@ This endpoint does not need any parameter.
 
 List Supported Countries
 
-List the supported countries.
+<p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p> 
 
 ### 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::CountriesApi.new
 
@@ -98,7 +93,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2)
+No authorization required
 
 ### HTTP request headers
 
@@ -106,33 +101,28 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## v1_payment_channel_rules_get
+## list_supported_countries_v2
 
-> PaymentChannelRulesResponse v1_payment_channel_rules_get
+> SupportedCountriesResponseV2 list_supported_countries_v2
 
-List Payment Channel Country Rules
+List Supported Countries
 
-List the country specific payment channel rules.
+List the supported countries.
 
 ### 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::CountriesApi.new
 
 begin
-  #List Payment Channel Country Rules
-  result = api_instance.v1_payment_channel_rules_get
+  #List Supported Countries
+  result = api_instance.list_supported_countries_v2
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling CountriesApi->v1_payment_channel_rules_get: #{e}"
+  puts "Exception when calling CountriesApi->list_supported_countries_v2: #{e}"
 end
 ```
 
@@ -142,11 +132,11 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**PaymentChannelRulesResponse**](PaymentChannelRulesResponse.md)
+[**SupportedCountriesResponseV2**](SupportedCountriesResponseV2.md)
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2)
+No authorization required
 
 ### HTTP request headers
 

data/docs/CreateFundingAccountRequestV2.md

@@ -0,0 +1,29 @@
+# VeloPayments::CreateFundingAccountRequestV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**name** | **String** |  | 
+**payor_id** | **String** |  | 
+**account_name** | **String** | Required if type is FBO | [optional] 
+**account_number** | **String** | Required if type is FBO | [optional] 
+**routing_number** | **String** | Required if type is FBO | [optional] 
+**currency** | **String** | ISO 4217 currency code, Required if type is WUBS_DECOUPLED | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreateFundingAccountRequestV2.new(type: null,
+                                 name: null,
+                                 payor_id: null,
+                                 account_name: null,
+                                 account_number: null,
+                                 routing_number: null,
+                                 currency: USD)
+```
+
+

data/docs/CreateIndividual.md

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

data/docs/CreateIndividual2.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+**name** | [**CreateIndividual2Name**](CreateIndividual2Name.md) |  | 
 **national_identification** | **String** |  | [optional] 
 **date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | 
 
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::CreateIndividual2.new(name: null,
-                                 national_identification: null,
-                                 date_of_birth: null)
+                                 national_identification: SA211123K,
+                                 date_of_birth: Wed May 20 00:00:00 GMT 1970)
 ```
 
 

data/docs/CreateIndividual2Name.md

@@ -0,0 +1,23 @@
+# VeloPayments::CreateIndividual2Name
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** |  | [optional] 
+**first_name** | **String** |  | 
+**other_names** | **String** |  | [optional] 
+**last_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreateIndividual2Name.new(title: Mr,
+                                 first_name: Bob,
+                                 other_names: H,
+                                 last_name: Smith)
+```
+
+

data/docs/CreatePayee.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payee_id** | **String** |  | [optional] [readonly] 
-**payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRefV2>**](PayeePayorRefV2.md) |  | [optional] [readonly] 
 **email** | **String** |  | 
 **remote_id** | **String** |  | 
 **type** | [**PayeeType**](PayeeType.md) |  | 
@@ -21,10 +21,10 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::CreatePayee.new(payee_id: null,
+instance = VeloPayments::CreatePayee.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
                                  payor_refs: null,
-                                 email: null,
-                                 remote_id: null,
+                                 email: bob@example.com,
+                                 remote_id: remoteId123,
                                  type: null,
                                  address: null,
                                  payment_channel: null,

data/docs/CreatePayee2.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payee_id** | **String** |  | [optional] [readonly] 
-**payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRefV3>**](PayeePayorRefV3.md) |  | [optional] [readonly] 
 **email** | **String** |  | 
 **remote_id** | **String** |  | 
 **type** | [**PayeeType**](PayeeType.md) |  | 
 **address** | [**CreatePayeeAddress2**](CreatePayeeAddress2.md) |  | 
 **payment_channel** | [**CreatePaymentChannel2**](CreatePaymentChannel2.md) |  | [optional] 
-**challenge** | [**Challenge**](Challenge.md) |  | [optional] 
-**language** | [**Language**](Language.md) |  | [optional] 
-**company** | [**CompanyV1**](CompanyV1.md) |  | [optional] 
+**challenge** | [**Challenge2**](Challenge2.md) |  | [optional] 
+**language** | [**Language2**](Language2.md) |  | [optional] 
+**company** | [**Company2**](Company2.md) |  | [optional] 
 **individual** | [**CreateIndividual2**](CreateIndividual2.md) |  | [optional] 
 
 ## Code Sample
@@ -21,10 +21,10 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::CreatePayee2.new(payee_id: null,
+instance = VeloPayments::CreatePayee2.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
                                  payor_refs: null,
-                                 email: null,
-                                 remote_id: null,
+                                 email: bob@example.com,
+                                 remote_id: Remote ID,
                                  type: null,
                                  address: null,
                                  payment_channel: null,

data/docs/CreatePayeesCSVRequest.md

@@ -40,33 +40,33 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::CreatePayeesCSVRequest.new(type: null,
-                                 remote_id: null,
-                                 email: null,
-                                 address_line1: null,
+                                 remote_id: remoteId123,
+                                 email: bob@example.com,
+                                 address_line1: 500 Duval St,
                                  address_line2: null,
                                  address_line3: null,
                                  address_line4: null,
-                                 address_city: null,
-                                 address_county_or_province: null,
-                                 address_zip_or_postcode: null,
-                                 address_country: null,
-                                 individual_national_identification: null,
-                                 individual_date_of_birth: null,
-                                 individual_title: null,
+                                 address_city: Key West,
+                                 address_county_or_province: FL,
+                                 address_zip_or_postcode: 33945,
+                                 address_country: US,
+                                 individual_national_identification: AB123456C,
+                                 individual_date_of_birth: Tue Jan 01 00:00:00 GMT 1985,
+                                 individual_title: Mr,
                                  individual_first_name: null,
-                                 individual_other_names: null,
-                                 individual_last_name: null,
-                                 company_name: null,
-                                 company_ein: null,
-                                 company_operating_name: null,
-                                 payment_channel_account_number: null,
-                                 payment_channel_routing_number: null,
-                                 payment_channel_account_name: null,
-                                 payment_channel_iban: null,
-                                 payment_channel_country_code: null,
+                                 individual_other_names: Bob,
+                                 individual_last_name: Smith,
+                                 company_name: ABC Ltd,
+                                 company_ein: 123456789,
+                                 company_operating_name: ABC,
+                                 payment_channel_account_number: XXXXXX5678,
+                                 payment_channel_routing_number: XXXXX6789,
+                                 payment_channel_account_name: My Account,
+                                 payment_channel_iban: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234,
+                                 payment_channel_country_code: US,
                                  payment_channel_currency: null,
-                                 challenge_description: null,
-                                 challenge_value: null,
+                                 challenge_description: challenge description,
+                                 challenge_value: challenge value,
                                  payee_language: null)
 ```