velopayments 2.14.90.pre.1 → 2.17.8.beta1

data/docs/{Address.md → PayeeAddress.md}

@@ -1,4 +1,4 @@
-# VeloPayments::Address
+# VeloPayments::PayeeAddress
 
 ## Properties
 
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::Address.new(line1: 500 Duval St,
+instance = VeloPayments::PayeeAddress.new(line1: 500 Duval St,
                                  line2: null,
                                  line3: null,
                                  line4: null,

data/docs/PayeeDelta.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **remote_id** | **String** |  | 
-**payee_id** | **String** |  | 
+**payee_id** | **String** |  | [readonly] 
 **display_name** | **String** |  | [optional] 
 **dba_name** | **String** |  | [optional] 
 **email** | **String** |  | [optional] 

data/docs/PayeeInvitationApi.md

@@ -7,8 +7,10 @@ Method | HTTP request | Description
 [**get_payees_invitation_status**](PayeeInvitationApi.md#get_payees_invitation_status) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
 [**get_payees_invitation_status_v2**](PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
 [**resend_payee_invite**](PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
-[**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation
+[**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation V2
 [**v2_query_batch_status**](PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
+[**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Intiate Payee Creation V3
+[**v3_query_batch_status**](PayeeInvitationApi.md#v3_query_batch_status) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
 
 
 
@@ -184,7 +186,7 @@ Name | Type | Description  | Notes
 
 > CreatePayeesCSVResponse v2_create_payee(create_payees_request)
 
-Intiate Payee Creation
+Intiate Payee Creation V2
 
 Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). 
 
@@ -203,7 +205,7 @@ api_instance = VeloPayments::PayeeInvitationApi.new
 create_payees_request = VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
 
 begin
-  #Intiate Payee Creation
+  #Intiate Payee Creation V2
   result = api_instance.v2_create_payee(create_payees_request)
   p result
 rescue VeloPayments::ApiError => e
@@ -283,3 +285,107 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## v3_create_payee
+
+> CreatePayeesCSVResponse2 v3_create_payee(create_payees_request2)
+
+Intiate Payee Creation V3
+
+Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). 
+
+### 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::PayeeInvitationApi.new
+create_payees_request2 = VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
+
+begin
+  #Intiate Payee Creation V3
+  result = api_instance.v3_create_payee(create_payees_request2)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | 
+
+### Return type
+
+[**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## v3_query_batch_status
+
+> QueryBatchResponse v3_query_batch_status(batch_id)
+
+Query Batch Status
+
+Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). 
+
+### 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::PayeeInvitationApi.new
+batch_id = 'batch_id_example' # String | Batch Id
+
+begin
+  #Query Batch Status
+  result = api_instance.v3_query_batch_status(batch_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->v3_query_batch_status: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **batch_id** | [**String**](.md)| Batch Id | 
+
+### Return type
+
+[**QueryBatchResponse**](QueryBatchResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{PaymentChannel.md → PayeePaymentChannel.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PaymentChannel
+# VeloPayments::PayeePaymentChannel
 
 ## Properties
 
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentChannel.new(payment_channel_name: null,
+instance = VeloPayments::PayeePaymentChannel.new(payment_channel_name: null,
                                  iban: null,
                                  account_number: null,
                                  routing_no: null,

data/docs/{PayorRef.md → PayeePayorRef.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayorRef
+# VeloPayments::PayeePayorRef
 
 ## Properties
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorRef.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
+instance = VeloPayments::PayeePayorRef.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
                                  remote_id: uniqueIdForRemoteEntity,
                                  invitation_status: null)
 ```

data/docs/PayeePayorRef2.md

@@ -0,0 +1,21 @@
+# VeloPayments::PayeePayorRef2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | [optional] 
+**remote_id** | **String** |  | [optional] 
+**invitation_status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeePayorRef2.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
+                                 remote_id: uniqueIdForRemoteEntity,
+                                 invitation_status: null)
+```
+
+

data/docs/PayeeResponse.md

@@ -4,20 +4,52 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**PayeeResponseSummary**](PayeeResponseSummary.md) |  | [optional] 
-**page** | [**PayeeResponsePage**](PayeeResponsePage.md) |  | [optional] 
-**links** | [**Array<PayeeResponseLinks>**](PayeeResponseLinks.md) |  | [optional] 
-**content** | [**Array<Payee>**](Payee.md) |  | [optional] 
+**payee_id** | **String** |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRef>**](PayeePayorRef.md) |  | [optional] [readonly] 
+**email** | **String** |  | [optional] 
+**address** | [**PayeeAddress**](PayeeAddress.md) |  | [optional] 
+**country** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**payment_channel** | [**PayeePaymentChannel**](PayeePaymentChannel.md) |  | [optional] 
+**challenge** | [**Challenge**](Challenge.md) |  | [optional] 
+**language** | [**Language**](Language.md) |  | [optional] 
+**accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional] [readonly] 
+**cellphone_number** | **String** |  | [optional] 
+**payee_type** | [**PayeeType**](PayeeType.md) |  | [optional] 
+**company** | [**CompanyResponse**](CompanyResponse.md) |  | [optional] 
+**individual** | [**IndividualResponse**](IndividualResponse.md) |  | [optional] 
+**created** | **DateTime** |  | [optional] 
+**grace_period_end_date** | **Date** |  | [optional] [readonly] 
+**last_ofac_check_timestamp** | **String** |  | [optional] [readonly] 
+**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) |  | [optional] 
+**ofac_status** | [**OfacStatus**](OfacStatus.md) |  | [optional] 
+**onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayeeResponse.new(summary: null,
-                                 page: null,
-                                 links: null,
-                                 content: null)
+instance = VeloPayments::PayeeResponse.new(payee_id: null,
+                                 payor_refs: null,
+                                 email: null,
+                                 address: null,
+                                 country: null,
+                                 display_name: null,
+                                 payment_channel: null,
+                                 challenge: null,
+                                 language: null,
+                                 accept_terms_and_conditions_timestamp: null,
+                                 cellphone_number: null,
+                                 payee_type: null,
+                                 company: null,
+                                 individual: null,
+                                 created: null,
+                                 grace_period_end_date: null,
+                                 last_ofac_check_timestamp: null,
+                                 marketing_opt_ins: null,
+                                 ofac_status: null,
+                                 onboarded_status: null)
 ```
 
 

data/docs/PayeeResponse2.md

@@ -0,0 +1,55 @@
+# VeloPayments::PayeeResponse2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRef>**](PayeePayorRef.md) |  | [optional] [readonly] 
+**email** | **String** |  | [optional] 
+**address** | [**PayeeAddress**](PayeeAddress.md) |  | [optional] 
+**country** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**payment_channel** | [**PayeePaymentChannel**](PayeePaymentChannel.md) |  | [optional] 
+**challenge** | [**Challenge**](Challenge.md) |  | [optional] 
+**language** | [**Language**](Language.md) |  | [optional] 
+**accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional] [readonly] 
+**cellphone_number** | **String** |  | [optional] 
+**payee_type** | [**PayeeType**](PayeeType.md) |  | [optional] 
+**company** | [**CompanyResponse**](CompanyResponse.md) |  | [optional] 
+**individual** | [**IndividualResponse**](IndividualResponse.md) |  | [optional] 
+**created** | **DateTime** |  | [optional] 
+**grace_period_end_date** | **Date** |  | [optional] [readonly] 
+**watchlist_status_updated_timestamp** | **String** |  | [optional] [readonly] 
+**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) |  | [optional] 
+**watchlist_status** | [**WatchlistStatus**](WatchlistStatus.md) |  | [optional] 
+**onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeeResponse2.new(payee_id: null,
+                                 payor_refs: null,
+                                 email: null,
+                                 address: null,
+                                 country: null,
+                                 display_name: null,
+                                 payment_channel: null,
+                                 challenge: null,
+                                 language: null,
+                                 accept_terms_and_conditions_timestamp: null,
+                                 cellphone_number: null,
+                                 payee_type: null,
+                                 company: null,
+                                 individual: null,
+                                 created: null,
+                                 grace_period_end_date: null,
+                                 watchlist_status_updated_timestamp: null,
+                                 marketing_opt_ins: null,
+                                 watchlist_status: null,
+                                 onboarded_status: null)
+```
+
+

data/docs/PayeesApi.md

@@ -8,6 +8,8 @@ Method | HTTP request | Description
 [**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /v1/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_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
 
 
 
@@ -180,7 +182,7 @@ Name | Type | Description  | Notes
 
 ## list_payees
 
-> PayeeResponse list_payees(payor_id, opts)
+> PagedPayeeResponse list_payees(payor_id, opts)
 
 List Payees
 
@@ -206,7 +208,7 @@ opts = {
   display_name: 'display_name_example', # String | The display name of the payees.
   remote_id: 'remote_id_example', # 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 payees.
+  payee_country: 'payee_country_example', # 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. 
@@ -233,14 +235,14 @@ Name | Type | Description  | Notes
  **display_name** | **String**| The display name of the payees. | [optional] 
  **remote_id** | **String**| The remote id of the payees. | [optional] 
  **payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional] 
- **payee_country** | **String**| The country of the payees. | [optional] 
+ **payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [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**| 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.  | [optional] [default to 'displayName:asc']
 
 ### Return type
 
-[**PayeeResponse**](PayeeResponse.md)
+[**PagedPayeeResponse**](PagedPayeeResponse.md)
 
 ### Authorization
 
@@ -251,3 +253,130 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## list_payees_v3
+
+> PagedPayeeResponse2 list_payees_v3(payor_id, opts)
+
+List Payees
+
+Get a paginated response listing the payees for a payor.
+
+### 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::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.
+  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)
+  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_v3(payor_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->list_payees_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **ofac_status** | [**WatchlistStatus**](.md)| The watchlistStatus of the payees. | [optional] 
+ **onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional] 
+ **email** | [**String**](.md)| Email address | [optional] 
+ **display_name** | **String**| The display name of the payees. | [optional] 
+ **remote_id** | **String**| The remote id of the payees. | [optional] 
+ **payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional] 
+ **payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [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**| 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.  | [optional] [default to 'displayName:asc']
+
+### Return type
+
+[**PagedPayeeResponse2**](PagedPayeeResponse2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_payees_payee_id_remote_id_update_post
+
+> 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.
+
+### 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 = 'payee_id_example' # String | The UUID of the payee.
+update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id
+
+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
+  puts "Exception when calling PayeesApi->v1_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 | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+