PayeesApi.md in velopayments-2.19.40.beta1

- old
+ new

@@ -2,26 +2,31 @@
 
 All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**delete_payee_by_id**](PayeesApi.md#delete_payee_by_id) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
-[**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /v1/payees/{payeeId} | Get Payee by Id
+[**delete_payee_by_id_v1**](PayeesApi.md#delete_payee_by_id_v1) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
+[**delete_payee_by_id_v3**](PayeesApi.md#delete_payee_by_id_v3) | **DELETE** /v3/payees/{payeeId} | Delete Payee by Id
+[**get_payee_by_id_v1**](PayeesApi.md#get_payee_by_id_v1) | **GET** /v1/payees/{payeeId} | Get Payee by Id
+[**get_payee_by_id_v2**](PayeesApi.md#get_payee_by_id_v2) | **GET** /v2/payees/{payeeId} | Get Payee by Id
+[**get_payee_by_id_v3**](PayeesApi.md#get_payee_by_id_v3) | **GET** /v3/payees/{payeeId} | Get Payee by Id
 [**list_payee_changes**](PayeesApi.md#list_payee_changes) | **GET** /v1/deltas/payees | List Payee Changes
-[**list_payees**](PayeesApi.md#list_payees) | **GET** /v1/payees | List Payees
+[**list_payee_changes_v3**](PayeesApi.md#list_payee_changes_v3) | **GET** /v3/payees/deltas | List Payee Changes
+[**list_payees_v1**](PayeesApi.md#list_payees_v1) | **GET** /v1/payees | List Payees V1
 [**list_payees_v3**](PayeesApi.md#list_payees_v3) | **GET** /v3/payees | List Payees
 [**v1_payees_payee_id_remote_id_update_post**](PayeesApi.md#v1_payees_payee_id_remote_id_update_post) | **POST** /v1/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
+[**v3_payees_payee_id_remote_id_update_post**](PayeesApi.md#v3_payees_payee_id_remote_id_update_post) | **POST** /v3/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
 
 
 
-## delete_payee_by_id
+## delete_payee_by_id_v1
 
-> delete_payee_by_id(payee_id)
+> delete_payee_by_id_v1(payee_id)
 
 Delete Payee by Id
 
-This API will delete Payee by Id (UUID). Deletion by ID is not allowed if: * Payee ID is not found * If Payee has not been on-boarded * If Payee is in grace period * If Payee has existing payments 
+<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> <p>Please use V3 instead.</p> 
 
 ### Example
 
 ```ruby
 # load the gem
@@ -31,17 +36,17 @@
   # Configure OAuth2 access token for authorization: OAuth2
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
 api_instance = VeloPayments::PayeesApi.new
-payee_id = 'payee_id_example' # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 
 begin
   #Delete Payee by Id
-  api_instance.delete_payee_by_id(payee_id)
+  api_instance.delete_payee_by_id_v1(payee_id)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayeesApi->delete_payee_by_id: #{e}"
+  puts "Exception when calling PayeesApi->delete_payee_by_id_v1: #{e}"
 end
 ```
 
 ### Parameters
 
@@ -62,18 +67,69 @@
 
 - **Content-Type**: Not defined
 - **Accept**: Not defined
 
 
-## get_payee_by_id
+## delete_payee_by_id_v3
 
-> Payee get_payee_by_id(payee_id, opts)
+> delete_payee_by_id_v3(payee_id)
 
-Get Payee by Id
+Delete Payee by Id
 
+<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</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::PayeesApi.new
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
+
+begin
+  #Delete Payee by Id
+  api_instance.delete_payee_by_id_v3(payee_id)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->delete_payee_by_id_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_payee_by_id_v1
+
+> Payee get_payee_by_id_v1(payee_id, opts)
+
 Get Payee by Id
 
+<p>Get Payee by Id</p> <p>Please use V3 instead.</p> 
+
 ### Example
 
 ```ruby
 # load the gem
 require 'velopayments'
@@ -82,21 +138,21 @@
   # Configure OAuth2 access token for authorization: OAuth2
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
 api_instance = VeloPayments::PayeesApi.new
-payee_id = 'payee_id_example' # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 opts = {
   sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
 }
 
 begin
   #Get Payee by Id
-  result = api_instance.get_payee_by_id(payee_id, opts)
+  result = api_instance.get_payee_by_id_v1(payee_id, opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayeesApi->get_payee_by_id: #{e}"
+  puts "Exception when calling PayeesApi->get_payee_by_id_v1: #{e}"
 end
 ```
 
 ### Parameters
 
@@ -118,17 +174,129 @@
 
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
 
+## get_payee_by_id_v2
+
+> PayeeResponseV2 get_payee_by_id_v2(payee_id, opts)
+
+Get Payee by Id
+
+<p>Get Payee by Id</p> <p>Please use V3 instead.</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::PayeesApi.new
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
+opts = {
+  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
+}
+
+begin
+  #Get Payee by Id
+  result = api_instance.get_payee_by_id_v2(payee_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->get_payee_by_id_v2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | 
+ **sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.  | [optional] 
+
+### Return type
+
+[**PayeeResponseV2**](PayeeResponseV2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payee_by_id_v3
+
+> PayeeResponseV3 get_payee_by_id_v3(payee_id, opts)
+
+Get Payee by Id
+
+Get Payee 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::PayeesApi.new
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
+opts = {
+  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
+}
+
+begin
+  #Get Payee by Id
+  result = api_instance.get_payee_by_id_v3(payee_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->get_payee_by_id_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | 
+ **sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.  | [optional] 
+
+### Return type
+
+[**PayeeResponseV3**](PayeeResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_payee_changes
 
 > PayeeDeltaResponse list_payee_changes(payor_id, updated_since, opts)
 
 List Payee Changes
 
-Get a paginated response listing payee changes.
+<p>Get a paginated response listing payee changes.</p> <p>Please use V3 instead.</p> 
 
 ### Example
 
 ```ruby
 # load the gem
@@ -178,17 +346,17 @@
 
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
 
-## list_payees
+## list_payee_changes_v3
 
-> PagedPayeeResponse list_payees(payor_id, opts)
+> PayeeDeltaResponse2 list_payee_changes_v3(payor_id, updated_since, opts)
 
-List Payees
+List Payee Changes
 
-Get a paginated response listing the payees for a payor.
+Get a paginated response listing payee changes.
 
 ### Example
 
 ```ruby
 # load the gem
@@ -198,30 +366,90 @@
   # Configure OAuth2 access token for authorization: OAuth2
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
 api_instance = VeloPayments::PayeesApi.new
+payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
+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
+opts = {
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+}
+
+begin
+  #List Payee Changes
+  result = api_instance.list_payee_changes_v3(payor_id, updated_since, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->list_payee_changes_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The Payor ID to find associated Payees | 
+ **updated_since** | **DateTime**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | 
+ **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]
+
+### Return type
+
+[**PayeeDeltaResponse2**](PayeeDeltaResponse2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_payees_v1
+
+> PagedPayeeResponse list_payees_v1(payor_id, opts)
+
+List Payees V1
+
+<p>Get a paginated response listing the payees for a payor.</p> <p>Please use V3 instead.</> 
+
+### 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::PayeesApi.new
 payor_id = 'payor_id_example' # String | The account owner Payor ID
 opts = {
   ofac_status: VeloPayments::OfacStatus.new, # OfacStatus | The ofacStatus of the payees.
   onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
-  email: 'email_example', # String | Email address
-  display_name: 'display_name_example', # String | The display name of the payees.
-  remote_id: 'remote_id_example', # String | The remote id of the payees.
+  email: 'bob@example.com', # String | Email address
+  display_name: 'Bob Smith', # String | The display name of the payees.
+  remote_id: 'remoteId123', # String | The remote id of the payees.
   payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
-  payee_country: 'payee_country_example', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
+  payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
   page: 1, # Integer | Page number. Default is 1.
   page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
   sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
 }
 
 begin
-  #List Payees
-  result = api_instance.list_payees(payor_id, opts)
+  #List Payees V1
+  result = api_instance.list_payees_v1(payor_id, opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayeesApi->list_payees: #{e}"
+  puts "Exception when calling PayeesApi->list_payees_v1: #{e}"
 end
 ```
 
 ### Parameters
 
@@ -276,15 +504,15 @@
 api_instance = VeloPayments::PayeesApi.new
 payor_id = 'payor_id_example' # String | The account owner Payor ID
 opts = {
   ofac_status: VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
   onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
-  email: 'email_example', # String | Email address
-  display_name: 'display_name_example', # String | The display name of the payees.
-  remote_id: 'remote_id_example', # String | The remote id of the payees.
+  email: 'bob@example.com', # String | Email address
+  display_name: 'Bob Smith', # String | The display name of the payees.
+  remote_id: 'remoteId123', # String | The remote id of the payees.
   payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
-  payee_country: 'payee_country_example', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
+  payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
   page: 1, # Integer | Page number. Default is 1.
   page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
   sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
 }
 
@@ -332,11 +560,11 @@
 
 > v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
 
 Update Payee Remote Id
 
-Update the remote Id for the given Payee Id.
+<p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p> 
 
 ### Example
 
 ```ruby
 # load the gem
@@ -346,12 +574,12 @@
   # Configure OAuth2 access token for authorization: OAuth2
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
 api_instance = VeloPayments::PayeesApi.new
-payee_id = 'payee_id_example' # String | The UUID of the payee.
-update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
+update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v1
 
 begin
   #Update Payee Remote Id
   api_instance.v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
 rescue VeloPayments::ApiError => e
@@ -363,10 +591,63 @@
 
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **payee_id** | [**String**](.md)| The UUID of the payee. | 
- **update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id | 
+ **update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v1 | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v3_payees_payee_id_remote_id_update_post
+
+> v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
+
+Update Payee Remote Id
+
+<p>Update the remote Id for the given Payee Id.</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::PayeesApi.new
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
+update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v3
+
+begin
+  #Update Payee Remote Id
+  api_instance.v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->v3_payees_payee_id_remote_id_update_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | 
+ **update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v3 | 
 
 ### Return type
 
 nil (empty response body)
 