velopayments 2.11.73

data/docs/ListPaymentsResponse.md

@@ -0,0 +1,23 @@
+# VeloPayments::ListPaymentsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**summary** | [**GetPaymentsForPayoutResponseSummary**](GetPaymentsForPayoutResponseSummary.md) |  | [optional] 
+**page** | [**GetPaymentsForPayoutResponsePage**](GetPaymentsForPayoutResponsePage.md) |  | [optional] 
+**links** | [**Array<GetPaymentsForPayoutResponseLinks>**](GetPaymentsForPayoutResponseLinks.md) |  | [optional] 
+**content** | [**Array<PaymentResponse>**](PaymentResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ListPaymentsResponse.new(summary: null,
+                                 page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/ListSourceAccountResponse.md

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

data/docs/MarketingOptIn.md

@@ -0,0 +1,19 @@
+# VeloPayments::MarketingOptIn
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opted_in** | **Boolean** |  | [optional] 
+**timestamp** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::MarketingOptIn.new(opted_in: null,
+                                 timestamp: null)
+```
+
+

data/docs/OfacStatus.md

@@ -0,0 +1,16 @@
+# VeloPayments::OfacStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::OfacStatus.new()
+```
+
+

data/docs/OnboardedStatus.md

@@ -0,0 +1,16 @@
+# VeloPayments::OnboardedStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::OnboardedStatus.new()
+```
+
+

data/docs/PagedResponse.md

@@ -0,0 +1,19 @@
+# VeloPayments::PagedResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**PagedResponsePage**](PagedResponsePage.md) |  | [optional] 
+**links** | **Array<Object>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PagedResponse.new(page: null,
+                                 links: null)
+```
+
+

data/docs/PagedResponsePage.md

@@ -0,0 +1,25 @@
+# VeloPayments::PagedResponsePage
+
+## 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::PagedResponsePage.new(number_of_elements: null,
+                                 total_elements: null,
+                                 total_pages: null,
+                                 page: null,
+                                 page_size: null)
+```
+
+

data/docs/Payee.md

@@ -0,0 +1,57 @@
+# VeloPayments::Payee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | [optional] 
+**payor_refs** | [**Array<PayorRef>**](PayorRef.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**address** | [**Address**](Address.md) |  | [optional] 
+**country** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**payment_channel** | [**PaymentChannel**](PaymentChannel.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] 
+**cellphone_number** | **String** |  | [optional] 
+**payee_type** | [**PayeeType**](PayeeType.md) |  | [optional] 
+**company** | [**Company**](Company.md) |  | [optional] 
+**individual** | [**Individual**](Individual.md) |  | [optional] 
+**created** | **DateTime** |  | [optional] 
+**grace_period_end_date** | **Date** |  | [optional] 
+**last_ofac_check_timestamp** | **String** |  | [optional] 
+**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
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Payee.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,
+                                 social: null)
+```
+
+

data/docs/PayeeInvitationApi.md

@@ -0,0 +1,222 @@
+# VeloPayments::PayeeInvitationApi
+
+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
+[**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
+
+> InvitationStatusResponse get_payor(payor_id)
+
+Get Payee Invitation Status
+
+Returns a 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
+
+begin
+  #Get Payee Invitation Status
+  result = api_instance.get_payor(payor_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->get_payor: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+
+### Return type
+
+[**InvitationStatusResponse**](InvitationStatusResponse.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)
+
+Resend Payee Invite
+
+Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined Any previous invites to the payee by this Payor will be invalidated
+
+### 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
+payee_id = 'payee_id_example' # String | The UUID of the payee.
+invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest | 
+
+begin
+  #Resend Payee Invite
+  result = api_instance.resend_payee_invite(payee_id, invite_payee_request)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->resend_payee_invite: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | 
+ **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)|  | 
+
+### Return type
+
+[**InvitationStatusResponse**](InvitationStatusResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v2_create_payee
+
+> CreatePayeesCSVResponse v2_create_payee(create_payees_request)
+
+Intiate Payee Creation
+
+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_request = VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
+
+begin
+  #Intiate Payee Creation
+  result = api_instance.v2_create_payee(create_payees_request)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. | 
+
+### Return type
+
+[**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## v2_query_batch_status
+
+> QueryBatchResponse v2_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.v2_query_batch_status(batch_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayeeInvitationApi->v2_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/PayeeInvitationStatus.md

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