velopayments 2.11.73 → 2.14.90.pre.1

data/docs/ListSourceAccountResponseV2.md

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

data/docs/ListSourceAccountResponseV2Page.md

@@ -0,0 +1,25 @@
+# VeloPayments::ListSourceAccountResponseV2Page
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_elements** | **Integer** |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+**page** | **Integer** |  | [optional] 
+**page_size** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListSourceAccountResponseV2Page.new(number_of_elements: 12,
+                                 total_elements: 33,
+                                 total_pages: 2,
+                                 page: 1,
+                                 page_size: 25)
+```
+
+

data/docs/Notifications.md

@@ -0,0 +1,17 @@
+# VeloPayments::Notifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**minimum_balance** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Notifications.new(minimum_balance: 120000)
+```
+
+

data/docs/PagedPayeeInvitationStatusResponse.md

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

data/docs/Payee.md

@@ -24,7 +24,6 @@ Name | Type | Description | Notes
 **marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) |  | [optional] 
 **ofac_status** | [**OfacStatus**](OfacStatus.md) |  | [optional] 
 **onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional] 
-**social** | [**Social**](Social.md) |  | [optional] 
 
 ## Code Sample
 
@@ -50,8 +49,7 @@ instance = VeloPayments::Payee.new(payee_id: null,
                                  last_ofac_check_timestamp: null,
                                  marketing_opt_ins: null,
                                  ofac_status: null,
-                                 onboarded_status: null,
-                                 social: null)
+                                 onboarded_status: null)
 ```
 
 

data/docs/PayeeDelta.md

@@ -0,0 +1,29 @@
+# VeloPayments::PayeeDelta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote_id** | **String** |  | 
+**payee_id** | **String** |  | 
+**display_name** | **String** |  | [optional] 
+**dba_name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**payee_country** | **String** |  | [optional] 
+**onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeeDelta.new(remote_id: payee_1,
+                                 payee_id: null,
+                                 display_name: Payee1,
+                                 dba_name: Payee DBA Name,
+                                 email: payee1@example.com,
+                                 payee_country: US,
+                                 onboarded_status: null)
+```
+
+

data/docs/PayeeDeltaResponse.md

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

data/docs/PayeeDeltaResponseLinks.md

@@ -0,0 +1,19 @@
+# VeloPayments::PayeeDeltaResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeeDeltaResponseLinks.new(rel: first,
+                                 href: http://api.sandbox.velopayments.com/v1/deltas/payees?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
+```
+
+

data/docs/PayeeDeltaResponsePage.md

@@ -0,0 +1,25 @@
+# VeloPayments::PayeeDeltaResponsePage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_elements** | **Integer** |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+**page** | **Integer** |  | [optional] 
+**page_size** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeeDeltaResponsePage.new(number_of_elements: 2,
+                                 total_elements: 2,
+                                 total_pages: 1,
+                                 page: 1,
+                                 page_size: 25)
+```
+
+

data/docs/PayeeInvitationApi.md

@@ -4,16 +4,17 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_payor**](PayeeInvitationApi.md#get_payor) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
+[**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_query_batch_status**](PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
 
 
 
-## get_payor
+## get_payees_invitation_status
 
-> InvitationStatusResponse get_payor(payor_id)
+> InvitationStatusResponse get_payees_invitation_status(payor_id)
 
 Get Payee Invitation Status
 
@@ -35,10 +36,10 @@ payor_id = 'payor_id_example' # String | The account owner Payor ID
 
 begin
   #Get Payee Invitation Status
-  result = api_instance.get_payor(payor_id)
+  result = api_instance.get_payees_invitation_status(payor_id)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayeeInvitationApi->get_payor: #{e}"
+  puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status: #{e}"
 end
 ```
 
@@ -63,6 +64,68 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_payees_invitation_status_v2
+
+> PagedPayeeInvitationStatusResponse get_payees_invitation_status_v2(payor_id, opts)
+
+Get Payee Invitation Status
+
+Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. 
+
+### 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
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+opts = {
+  payee_id: 'payee_id_example', # String | The UUID of the payee.
+  invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
+}
+
+begin
+  #Get Payee Invitation Status
+  result = api_instance.get_payees_invitation_status_v2(payor_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payee_id** | [**String**](.md)| The UUID of the payee. | [optional] 
+ **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [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]
+
+### Return type
+
+[**PagedPayeeInvitationStatusResponse**](PagedPayeeInvitationStatusResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## resend_payee_invite
 
 > InvitationStatusResponse resend_payee_invite(payee_id, invite_payee_request)

data/docs/PayeeInvitationStatus.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::PayeeInvitationStatus.new(payee_id: null,
-                                 invitation_status: null,
+                                 invitation_status: ACCEPTED,
                                  grace_period_end_date: null)
 ```
 

data/docs/PayeeInvitationStatusResponse.md

@@ -0,0 +1,21 @@
+# VeloPayments::PayeeInvitationStatusResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | 
+**invitation_status** | [**InvitationStatus**](InvitationStatus.md) |  | 
+**grace_period_end_date** | **Date** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayeeInvitationStatusResponse.new(payee_id: null,
+                                 invitation_status: null,
+                                 grace_period_end_date: null)
+```
+
+

data/docs/PayeeResponse.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**GetPaymentsForPayoutResponseSummary**](GetPaymentsForPayoutResponseSummary.md) |  | [optional] 
-**page** | [**GetPaymentsForPayoutResponsePage**](GetPaymentsForPayoutResponsePage.md) |  | [optional] 
-**links** | [**Array<GetPaymentsForPayoutResponseLinks>**](GetPaymentsForPayoutResponseLinks.md) |  | [optional] 
+**summary** | [**PayeeResponseSummary**](PayeeResponseSummary.md) |  | [optional] 
+**page** | [**PayeeResponsePage**](PayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PayeeResponseLinks>**](PayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<Payee>**](Payee.md) |  | [optional] 
 
 ## Code Sample

data/docs/{GetPaymentsForPayoutResponseLinks.md → PayeeResponseLinks.md}

@@ -1,4 +1,4 @@
-# VeloPayments::GetPaymentsForPayoutResponseLinks
+# VeloPayments::PayeeResponseLinks
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GetPaymentsForPayoutResponseLinks.new(rel: null,
+instance = VeloPayments::PayeeResponseLinks.new(rel: null,
                                  href: null)
 ```
 

data/docs/{GetPaymentsForPayoutResponsePage.md → PayeeResponsePage.md}

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

data/docs/{GetPaymentsForPayoutResponseSummary.md → PayeeResponseSummary.md}

@@ -1,4 +1,4 @@
-# VeloPayments::GetPaymentsForPayoutResponseSummary
+# VeloPayments::PayeeResponseSummary
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GetPaymentsForPayoutResponseSummary.new(total_payees_count: null,
+instance = VeloPayments::PayeeResponseSummary.new(total_payees_count: null,
                                  total_invited_count: null,
                                  total_registered_count: null,
                                  total_onboarded_count: null,

data/docs/PayeesApi.md

@@ -6,6 +6,7 @@ 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
+[**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
 
 
@@ -117,6 +118,66 @@ Name | Type | Description  | Notes
 - **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.
+
+### 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 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(payor_id, updated_since, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeesApi->list_payee_changes: #{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
+
+[**PayeeDeltaResponse**](PayeeDeltaResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_payees
 
 > PayeeResponse list_payees(payor_id, opts)