velopayments 2.17.8 → 2.18.31.beta1

data/docs/PayorV2.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payor_id** | **String** |  | [optional] [readonly] 
+**payor_id** | **String** |  | [readonly] 
 **payor_name** | **String** | The name of the payor. | 
 **address** | [**PayorAddressV2**](PayorAddressV2.md) |  | [optional] 
 **primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] 
 **primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] 
 **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] 
-**kyc_state** | **String** | The kyc state of the payor. | [optional] [readonly] 
+**kyc_state** | [**KycState**](KycState.md) |  | [optional] 
 **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] 
 **payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] [readonly] 
 **payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] [readonly] 
@@ -21,7 +21,9 @@ Name | Type | Description | Notes
 **reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] [readonly] 
 **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
 **includes_reports** | **Boolean** |  | [optional] 
+**wu_customer_id** | **String** |  | [optional] 
 **max_master_payor_admins** | **Integer** |  | [optional] 
+**payment_rails** | [**PaymentRails**](PaymentRails.md) |  | [optional] 
 
 ## Code Sample
 
@@ -34,7 +36,7 @@ instance = VeloPayments::PayorV2.new(payor_id: null,
                                  primary_contact_name: Joe Buck,
                                  primary_contact_phone: 123-123-1234,
                                  primary_contact_email: joe.buck@example.com,
-                                 kyc_state: PASSED_KYC,
+                                 kyc_state: null,
                                  manual_lockout: null,
                                  payee_grace_period_processing_enabled: null,
                                  payee_grace_period_days: null,
@@ -45,7 +47,9 @@ instance = VeloPayments::PayorV2.new(payor_id: null,
                                  reminder_emails_opt_out: null,
                                  language: EN,
                                  includes_reports: null,
-                                 max_master_payor_admins: null)
+                                 wu_customer_id: null,
+                                 max_master_payor_admins: null,
+                                 payment_rails: null)
 ```
 
 

data/docs/PayorsApi.md

@@ -7,6 +7,8 @@ Method | HTTP request | Description
 [**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
 [**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor
 [**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
+[**payor_create_api_key_request**](PayorsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
+[**payor_create_application_request**](PayorsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
 [**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
 [**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links
@@ -169,7 +171,116 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: multipart/form-data
-- **Accept**: Not defined
+- **Accept**: application/json
+
+
+## payor_create_api_key_request
+
+> PayorCreateApiKeyResponse payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+
+Create API Key
+
+Create an an API key for the given payor Id and application 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+application_id = 'application_id_example' # String | Application ID
+payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new # PayorCreateApiKeyRequest | Details of application API key to create
+
+begin
+  #Create API Key
+  result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_create_api_key_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **application_id** | [**String**](.md)| Application ID | 
+ **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md)| Details of application API key to create | 
+
+### Return type
+
+[**PayorCreateApiKeyResponse**](PayorCreateApiKeyResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## payor_create_application_request
+
+> payor_create_application_request(payor_id, payor_create_application_request)
+
+Create Application
+
+Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
+
+### 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_create_application_request = VeloPayments::PayorCreateApplicationRequest.new # PayorCreateApplicationRequest | Details of application to create
+
+begin
+  #Create Application
+  api_instance.payor_create_application_request(payor_id, payor_create_application_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_create_application_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md)| Details of application to create | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
 ## payor_email_opt_out
@@ -222,7 +333,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## payor_get_branding

data/docs/PayorsPrivateApi.md

@@ -0,0 +1,60 @@
+# VeloPayments::PayorsPrivateApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_payor_links**](PayorsPrivateApi.md#create_payor_links) | **POST** /v1/payorLinks | Create a Payor Link
+
+
+
+## create_payor_links
+
+> create_payor_links(create_payor_link_request)
+
+Create a Payor Link
+
+This endpoint allows you to create a payor link.
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: oAuthVeloBackOffice
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::PayorsPrivateApi.new
+create_payor_link_request = VeloPayments::CreatePayorLinkRequest.new # CreatePayorLinkRequest | Request to create a payor link
+
+begin
+  #Create a Payor Link
+  api_instance.create_payor_links(create_payor_link_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsPrivateApi->create_payor_links: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payor_link_request** | [**CreatePayorLinkRequest**](CreatePayorLinkRequest.md)| Request to create a payor link | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oAuthVeloBackOffice](../README.md#oAuthVeloBackOffice)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PayoutHistoryApi.md

@@ -6,7 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_payments_for_payout**](PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
 [**get_payments_for_payout_v4**](PayoutHistoryApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
-[**get_payout_stats**](PayoutHistoryApi.md#get_payout_stats) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
+[**get_payout_stats_v1**](PayoutHistoryApi.md#get_payout_stats_v1) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
 
 
 
@@ -166,9 +166,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## get_payout_stats
+## get_payout_stats_v1
 
-> GetPayoutStatistics get_payout_stats(opts)
+> GetPayoutStatistics get_payout_stats_v1(opts)
 
 Get Payout Statistics
 
@@ -192,10 +192,10 @@ opts = {
 
 begin
   #Get Payout Statistics
-  result = api_instance.get_payout_stats(opts)
+  result = api_instance.get_payout_stats_v1(opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayoutHistoryApi->get_payout_stats: #{e}"
+  puts "Exception when calling PayoutHistoryApi->get_payout_stats_v1: #{e}"
 end
 ```
 

data/docs/PayoutSummaryAuditV3.md

@@ -7,7 +7,6 @@ Name | Type | Description | Notes
 **payout_id** | **String** |  | 
 **payor_id** | **String** |  | [optional] 
 **status** | [**PayoutStatusV3**](PayoutStatusV3.md) |  | 
-**date_time** | **DateTime** |  | [optional] 
 **submitted_date_time** | **String** |  | 
 **instructed_date_time** | **String** |  | [optional] 
 **withdrawn_date_time** | **String** |  | [optional] 
@@ -26,7 +25,6 @@ require 'VeloPayments'
 instance = VeloPayments::PayoutSummaryAuditV3.new(payout_id: null,
                                  payor_id: null,
                                  status: null,
-                                 date_time: null,
                                  submitted_date_time: null,
                                  instructed_date_time: null,
                                  withdrawn_date_time: null,

data/docs/PayoutSummaryAuditV4.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payout_id** | **String** |  | 
-**payor_id** | **String** | Deprecated in v2.16. Will be populated with submitting payor ID until removed in a later release. | [optional] 
+**payout_id** | **String** |  | [optional] 
+**payor_id** | **String** |  | [optional] 
 **status** | [**PayoutStatusV4**](PayoutStatusV4.md) |  | 
 **date_time** | **DateTime** |  | [optional] 
 **submitted_date_time** | **String** |  | 
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **fx_summaries** | [**Array<FxSummaryV4>**](FxSummaryV4.md) |  | [optional] 
 **payout_memo** | **String** |  | [optional] 
 **payout_type** | [**PayoutTypeV4**](PayoutTypeV4.md) |  | 
+**payor_name** | **String** |  | 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = VeloPayments::PayoutSummaryAuditV4.new(payout_id: null,
                                  source_account_summary: null,
                                  fx_summaries: null,
                                  payout_memo: null,
-                                 payout_type: null)
+                                 payout_type: null,
+                                 payor_name: null)
 ```
 
 

data/docs/PayoutSummaryResponse.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **payments_rejected** | **Integer** |  | [optional] 
 **fx_summaries** | [**Array<QuoteFxSummary>**](QuoteFxSummary.md) |  | 
 **accounts** | [**Array<SourceAccount>**](SourceAccount.md) |  | 
+**accepted_payments** | [**Array<AcceptedPayment>**](AcceptedPayment.md) |  | 
 **rejected_payments** | [**Array<RejectedPayment>**](RejectedPayment.md) |  | 
 
 ## Code Sample
@@ -25,6 +26,7 @@ instance = VeloPayments::PayoutSummaryResponse.new(payout_id: null,
                                  payments_rejected: 0,
                                  fx_summaries: null,
                                  accounts: null,
+                                 accepted_payments: null,
                                  rejected_payments: null)
 ```
 

data/docs/Region.md

@@ -0,0 +1,19 @@
+# VeloPayments::Region
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**abbreviation** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Region.new(name: California,
+                                 abbreviation: CA)
+```
+
+

data/docs/RegisterMFARequest.md

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

data/docs/RegisterMFAResponse.md

@@ -0,0 +1,19 @@
+# VeloPayments::RegisterMFAResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totp_url** | **String** | A TOTP Url thaty can be parsed by the TOTP device | [optional] 
+**totp_shared_secret** | **String** | The shared secret between the TOTP app and the server | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::RegisterMFAResponse.new(totp_url: otpauth://totp/Velo%20Payments:stephen.smith@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Velo%20Payments,
+                                 totp_shared_secret: JBSWY3DPEHPK3PXP)
+```
+
+

data/docs/RegisterSmsRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::RegisterSmsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms_number** | **String** | The phone number of a device that the user can receive sms messages on  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::RegisterSmsRequest.new(sms_number: 11235555555)
+```
+
+

data/docs/ResendTokenRequest.md

@@ -0,0 +1,19 @@
+# VeloPayments::ResendTokenRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_type** | **String** | The type of the token to resend | 
+**verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user <P> The user's smsNumber is registered via a separate endpoint and an OTP sent to them  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ResendTokenRequest.new(token_type: INVITE_MFA_USER,
+                                 verification_code: 123456)
+```
+
+

data/docs/ResetPasswordRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::ResetPasswordRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the user requesting the reset password | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::ResetPasswordRequest.new(email: foo@example.com)
+```
+
+

data/docs/Role.md

@@ -0,0 +1,17 @@
+# VeloPayments::Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | the name of the role | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Role.new(name: payor.admin)
+```
+
+

data/docs/SelfMFATypeUnregisterRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::SelfMFATypeUnregisterRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mfa_type** | **String** | The type of the MFA device | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SelfMFATypeUnregisterRequest.new(mfa_type: TOTP)
+```
+
+

data/docs/SelfUpdatePasswordRequest.md

@@ -0,0 +1,19 @@
+# VeloPayments::SelfUpdatePasswordRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old_password** | **String** | The user's current password | 
+**new_password** | **String** | The new password | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SelfUpdatePasswordRequest.new(old_password: My_current_password,
+                                 new_password: My_new_password)
+```
+
+

data/docs/SupportedCountriesResponse2.md

@@ -0,0 +1,17 @@
+# VeloPayments::SupportedCountriesResponse2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**countries** | [**Array<SupportedCountry2>**](SupportedCountry2.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SupportedCountriesResponse2.new(countries: null)
+```
+
+

data/docs/SupportedCountry2.md

@@ -0,0 +1,21 @@
+# VeloPayments::SupportedCountry2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iso_country_code** | **String** |  | [optional] 
+**currencies** | **Array<String>** |  | [optional] 
+**regions** | [**Region**](Region.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SupportedCountry2.new(iso_country_code: US,
+                                 currencies: ["USD"],
+                                 regions: null)
+```
+
+

data/docs/TokenType.md

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