velopayments 2.11.73 → 2.14.90.pre.1

data/docs/CreatePayeeAddress.md

@@ -0,0 +1,31 @@
+# VeloPayments::CreatePayeeAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line1** | **String** |  | 
+**line2** | **String** |  | [optional] 
+**line3** | **String** |  | [optional] 
+**line4** | **String** |  | [optional] 
+**city** | **String** |  | 
+**county_or_province** | **String** |  | [optional] 
+**zip_or_postcode** | **String** |  | [optional] 
+**country** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayeeAddress.new(line1: 500 Duval St,
+                                 line2: null,
+                                 line3: null,
+                                 line4: null,
+                                 city: Key West,
+                                 county_or_province: FL,
+                                 zip_or_postcode: 33945,
+                                 country: US)
+```
+
+

data/docs/CreatePayeesCSVRequest.md

@@ -15,22 +15,23 @@ Name | Type | Description | Notes
 **address_county_or_province** | **String** |  | [optional] 
 **address_zip_or_postcode** | **String** |  | 
 **address_country** | **String** |  | 
+**individual_national_identification** | **String** |  | [optional] 
+**individual_date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | [optional] 
 **individual_title** | **String** |  | [optional] 
 **individual_first_name** | **String** |  | [optional] 
 **individual_other_names** | **String** |  | [optional] 
 **individual_last_name** | **String** |  | [optional] 
-**individual_national_identification** | **String** |  | [optional] 
-**individual_date_of_birth** | **Date** | example - 1970-05-20 | [optional] 
 **company_name** | **String** |  | [optional] 
-**company_tax_id** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional] 
+**company_ein** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional] 
+**company_operating_name** | **String** |  | [optional] 
+**payment_channel_account_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**payment_channel_routing_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**payment_channel_account_name** | **String** |  | [optional] 
 **payment_channel_iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional] 
-**payment_channel_account_number** | **String** |  | [optional] 
-**payment_channel_routing_no** | **String** |  | [optional] 
-**payment_channel_country_code** | **String** | Must be a 3 character currency code. ISO 4217 | [optional] 
+**payment_channel_country_code** | **String** | Must be a 2 character country code - per ISO 3166-1 | [optional] 
 **payment_channel_currency** | **String** |  | [optional] 
-**payment_channel_account_name** | **String** |  | [optional] 
-**challenge_value** | **String** |  | [optional] 
 **challenge_description** | **String** |  | [optional] 
+**challenge_value** | **String** |  | [optional] 
 **payee_language** | **String** |  | [optional] 
 
 ## Code Sample
@@ -49,22 +50,23 @@ instance = VeloPayments::CreatePayeesCSVRequest.new(type: 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,
                                  individual_first_name: null,
                                  individual_other_names: null,
                                  individual_last_name: null,
-                                 individual_national_identification: null,
-                                 individual_date_of_birth: null,
                                  company_name: null,
-                                 company_tax_id: null,
-                                 payment_channel_iban: null,
+                                 company_ein: null,
+                                 company_operating_name: null,
                                  payment_channel_account_number: null,
-                                 payment_channel_routing_no: null,
+                                 payment_channel_routing_number: null,
+                                 payment_channel_account_name: null,
+                                 payment_channel_iban: null,
                                  payment_channel_country_code: null,
                                  payment_channel_currency: null,
-                                 payment_channel_account_name: null,
-                                 challenge_value: null,
                                  challenge_description: null,
+                                 challenge_value: null,
                                  payee_language: null)
 ```
 

data/docs/CreatePayoutRequest.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::CreatePayoutRequest.new(payor_id: null,
-                                 payout_memo: null,
+                                 payout_memo: A memo,
                                  payments: null)
 ```
 

data/docs/FundingManagerApi.md

@@ -8,14 +8,17 @@ Method | HTTP request | Description
 [**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_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
+[**set_notifications_request**](FundingManagerApi.md#set_notifications_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications
 [**set_payor_funding_bank_details**](FundingManagerApi.md#set_payor_funding_bank_details) | **POST** /v1/payors/{payorId}/payorFundingBankDetailsUpdate | Set Funding Bank Details
 
 
 
 ## create_ach_funding_request
 
-> create_ach_funding_request(source_account_id, funding_request)
+> create_ach_funding_request(source_account_id, funding_request_v1)
 
 Create Funding Request
 
@@ -34,11 +37,11 @@ end
 
 api_instance = VeloPayments::FundingManagerApi.new
 source_account_id = 'source_account_id_example' # String | Source account id
-funding_request = VeloPayments::FundingRequest.new # FundingRequest | Body to included ammount to be funded
+funding_request_v1 = VeloPayments::FundingRequestV1.new # FundingRequestV1 | Body to included ammount to be funded
 
 begin
   #Create Funding Request
-  api_instance.create_ach_funding_request(source_account_id, funding_request)
+  api_instance.create_ach_funding_request(source_account_id, funding_request_v1)
 rescue VeloPayments::ApiError => e
   puts "Exception when calling FundingManagerApi->create_ach_funding_request: #{e}"
 end
@@ -50,7 +53,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source_account_id** | [**String**](.md)| Source account id | 
- **funding_request** | [**FundingRequest**](FundingRequest.md)| Body to included ammount to be funded | 
+ **funding_request_v1** | [**FundingRequestV1**](FundingRequestV1.md)| Body to included ammount to be funded | 
 
 ### Return type
 
@@ -63,12 +66,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: application/json
+- **Accept**: Not defined
 
 
 ## create_funding_request
 
-> create_funding_request(source_account_id, funding_request2)
+> create_funding_request(source_account_id, funding_request_v2)
 
 Create Funding Request
 
@@ -87,11 +90,11 @@ end
 
 api_instance = VeloPayments::FundingManagerApi.new
 source_account_id = 'source_account_id_example' # String | Source account id
-funding_request2 = VeloPayments::FundingRequest2.new # FundingRequest2 | Body to included ammount to be funded
+funding_request_v2 = VeloPayments::FundingRequestV2.new # FundingRequestV2 | Body to included ammount to be funded
 
 begin
   #Create Funding Request
-  api_instance.create_funding_request(source_account_id, funding_request2)
+  api_instance.create_funding_request(source_account_id, funding_request_v2)
 rescue VeloPayments::ApiError => e
   puts "Exception when calling FundingManagerApi->create_funding_request: #{e}"
 end
@@ -103,7 +106,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source_account_id** | [**String**](.md)| Source account id | 
- **funding_request2** | [**FundingRequest2**](FundingRequest2.md)| Body to included ammount to be funded | 
+ **funding_request_v2** | [**FundingRequestV2**](FundingRequestV2.md)| Body to included ammount to be funded | 
 
 ### Return type
 
@@ -116,7 +119,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: application/json
+- **Accept**: Not defined
 
 
 ## get_fundings
@@ -231,6 +234,58 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_source_account_v2
+
+> SourceAccountResponseV2 get_source_account_v2(source_account_id)
+
+Get details about given source account.
+
+Get details about given source 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::FundingManagerApi.new
+source_account_id = 'source_account_id_example' # String | Source account id
+
+begin
+  #Get details about given source account.
+  result = api_instance.get_source_account_v2(source_account_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->get_source_account_v2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_account_id** | [**String**](.md)| Source account id | 
+
+### Return type
+
+[**SourceAccountResponseV2**](SourceAccountResponseV2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_source_accounts
 
 > ListSourceAccountResponse get_source_accounts(opts)
@@ -293,6 +348,121 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_source_accounts_v2
+
+> ListSourceAccountResponseV2 get_source_accounts_v2(opts)
+
+Get list of source accounts
+
+List 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 = {
+  physical_account_name: 'physical_account_name_example', # String | Physical Account Name
+  payor_id: 'payor_id_example', # String | The account owner Payor ID
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
+  sort: 'sort_example' # String | Sort String
+}
+
+begin
+  #Get list of source accounts
+  result = api_instance.get_source_accounts_v2(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->get_source_accounts_v2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **physical_account_name** | **String**| Physical Account Name | [optional] 
+ **payor_id** | [**String**](.md)| The account owner Payor ID | [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**| Sort String | [optional] 
+
+### Return type
+
+[**ListSourceAccountResponseV2**](ListSourceAccountResponseV2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_notifications_request
+
+> set_notifications_request(source_account_id, set_notifications_request)
+
+Set notifications
+
+Set notifications for a given source 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::FundingManagerApi.new
+source_account_id = 'source_account_id_example' # String | Source account id
+set_notifications_request = VeloPayments::SetNotificationsRequest.new # SetNotificationsRequest | Body to included minimum balance to set
+
+begin
+  #Set notifications
+  api_instance.set_notifications_request(source_account_id, set_notifications_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling FundingManagerApi->set_notifications_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_account_id** | [**String**](.md)| Source account id | 
+ **set_notifications_request** | [**SetNotificationsRequest**](SetNotificationsRequest.md)| Body to included minimum balance to set | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
 ## set_payor_funding_bank_details
 
 > set_payor_funding_bank_details(payor_id, payor_funding_bank_details_update)

data/docs/{FundingRequest.md → FundingRequestV1.md}

@@ -1,4 +1,4 @@
-# VeloPayments::FundingRequest
+# VeloPayments::FundingRequestV1
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::FundingRequest.new(amount: null)
+instance = VeloPayments::FundingRequestV1.new(amount: null)
 ```
 
 

data/docs/{FundingRequest2.md → FundingRequestV2.md}

@@ -1,4 +1,4 @@
-# VeloPayments::FundingRequest2
+# VeloPayments::FundingRequestV2
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::FundingRequest2.new(amount: null)
+instance = VeloPayments::FundingRequestV2.new(amount: null)
 ```
 
 

data/docs/FxSummaryV3.md

@@ -0,0 +1,35 @@
+# VeloPayments::FxSummaryV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quote_id** | **String** |  | 
+**creation_date_time** | **DateTime** |  | 
+**rate** | **Float** |  | 
+**inverted_rate** | **Float** |  | 
+**total_cost** | **Integer** |  | 
+**total_payment_amount** | **Integer** |  | 
+**source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**status** | **String** |  | 
+**funding_status** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FxSummaryV3.new(quote_id: null,
+                                 creation_date_time: null,
+                                 rate: 1.12,
+                                 inverted_rate: 1.12,
+                                 total_cost: 1234,
+                                 total_payment_amount: 1234,
+                                 source_currency: null,
+                                 payment_currency: null,
+                                 status: null,
+                                 funding_status: null)
+```
+
+

data/docs/{FxSummary.md → FxSummaryV4.md}

@@ -1,4 +1,4 @@
-# VeloPayments::FxSummary
+# VeloPayments::FxSummaryV4
 
 ## Properties
 
@@ -10,8 +10,8 @@ Name | Type | Description | Notes
 **inverted_rate** | **Float** |  | 
 **total_cost** | **Integer** |  | 
 **total_payment_amount** | **Integer** |  | 
-**source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
-**payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**source_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
+**payment_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
 **status** | **String** |  | 
 **funding_status** | **String** |  | 
 
@@ -20,12 +20,12 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::FxSummary.new(quote_id: null,
+instance = VeloPayments::FxSummaryV4.new(quote_id: null,
                                  creation_date_time: null,
-                                 rate: null,
-                                 inverted_rate: null,
+                                 rate: 123.23,
+                                 inverted_rate: 123.23,
                                  total_cost: null,
-                                 total_payment_amount: null,
+                                 total_payment_amount: 34235,
                                  source_currency: null,
                                  payment_currency: null,
                                  status: null,