velopayments 2.11.73

data/docs/PayorCreateApiKeyRequest.md

@@ -0,0 +1,21 @@
+# VeloPayments::PayorCreateApiKeyRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A name for the key. | 
+**description** | **String** | Description of the key. | [optional] 
+**roles** | **Array<String>** | A list of roles to assign to the key. | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorCreateApiKeyRequest.new(name: null,
+                                 description: null,
+                                 roles: null)
+```
+
+

data/docs/PayorCreateApiKeyResponse.md

@@ -0,0 +1,19 @@
+# VeloPayments::PayorCreateApiKeyResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key** | **String** | API Key | [optional] 
+**api_secret** | **String** | API Secret | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorCreateApiKeyResponse.new(api_key: null,
+                                 api_secret: null)
+```
+
+

data/docs/PayorCreateApplicationRequest.md

@@ -0,0 +1,19 @@
+# VeloPayments::PayorCreateApplicationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the application. | 
+**description** | **String** | Description of the application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorCreateApplicationRequest.new(name: null,
+                                 description: null)
+```
+
+

data/docs/PayorEmailOptOutRequest.md

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

data/docs/PayorFundingBankDetailsUpdate.md

@@ -0,0 +1,21 @@
+# VeloPayments::PayorFundingBankDetailsUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**routing_number** | **String** | Routing number for the payor’s bank | 
+**account_number** | **String** | Payor’s bank account number. | 
+**account_name** | **String** | Payor’s bank account name. | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorFundingBankDetailsUpdate.new(routing_number: null,
+                                 account_number: null,
+                                 account_name: null)
+```
+
+

data/docs/PayorLogoRequest.md

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

data/docs/PayorRef.md

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

data/docs/PayorsApi.md

@@ -0,0 +1,224 @@
+# VeloPayments::PayorsApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
+[**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
+[**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out
+[**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding
+
+
+
+## get_payor_by_id
+
+> Payor get_payor_by_id(payor_id)
+
+Get Payor
+
+Get a Single Payor by Id (200 - OK, 404 - payor 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+
+begin
+  #Get Payor
+  result = api_instance.get_payor_by_id(payor_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->get_payor_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+
+### Return type
+
+[**Payor**](Payor.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payor_add_payor_logo
+
+> payor_add_payor_logo(payor_id, opts)
+
+Add Logo
+
+Add Payor Logo
+
+### 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+opts = {
+  logo: File.new('/path/to/file') # File | 
+}
+
+begin
+  #Add Logo
+  api_instance.payor_add_payor_logo(payor_id, opts)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_add_payor_logo: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **logo** | **File**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: Not defined
+
+
+## payor_email_opt_out
+
+> payor_email_opt_out(payor_id, payor_email_opt_out_request)
+
+Reminder Email Opt-Out
+
+Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding. 
+
+### 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new # PayorEmailOptOutRequest | Details of application API key to create
+
+begin
+  #Reminder Email Opt-Out
+  api_instance.payor_email_opt_out(payor_id, payor_email_opt_out_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_email_opt_out: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md)| Details of application API key to create | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## payor_get_branding
+
+> PayorBrandingResponse payor_get_branding(payor_id)
+
+Get Branding
+
+Get the payor branding details.
+
+### 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+
+begin
+  #Get Branding
+  result = api_instance.payor_get_branding(payor_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_get_branding: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+
+### Return type
+
+[**PayorBrandingResponse**](PayorBrandingResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PayoutHistoryApi.md

@@ -0,0 +1,142 @@
+# VeloPayments::PayoutHistoryApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payments_for_payout**](PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
+[**get_payout_stats**](PayoutHistoryApi.md#get_payout_stats) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
+
+
+
+## get_payments_for_payout
+
+> GetPaymentsForPayoutResponse get_payments_for_payout(payout_id, opts)
+
+Get Payments for Payout
+
+Get List of payments for Payout 
+
+### 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::PayoutHistoryApi.new
+payout_id = 'payout_id_example' # String | The id (UUID) of the payout.
+opts = {
+  remote_id: 'remote_id_example', # String | The remote id of the payees.
+  status: 'status_example', # String | Payment Status
+  source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
+  source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
+  payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
+  payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
+  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+  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 | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+  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 Payments for Payout
+  result = api_instance.get_payments_for_payout(payout_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutHistoryApi->get_payments_for_payout: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| The id (UUID) of the payout. | 
+ **remote_id** | **String**| The remote id of the payees. | [optional] 
+ **status** | **String**| Payment Status | [optional] 
+ **source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] 
+ **source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] 
+ **payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] 
+ **payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] 
+ **submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional] 
+ **submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [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=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status  | [optional] 
+ **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
+
+[**GetPaymentsForPayoutResponse**](GetPaymentsForPayoutResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payout_stats
+
+> GetPayoutStatistics get_payout_stats(opts)
+
+Get Payout Statistics
+
+Get payout statistics 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::PayoutHistoryApi.new
+opts = {
+  payor_id: 'payor_id_example' # String | The account owner Payor ID. Required for external users.
+}
+
+begin
+  #Get Payout Statistics
+  result = api_instance.get_payout_stats(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutHistoryApi->get_payout_stats: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID. Required for external users. | [optional] 
+
+### Return type
+
+[**GetPayoutStatistics**](GetPayoutStatistics.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+