velopayments 2.20.119 → 2.23.78.beta1

data/docs/UpdatePayeeDetailsRequest2.md

@@ -0,0 +1,29 @@
+# VeloPayments::UpdatePayeeDetailsRequest2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**PayeeAddress2**](PayeeAddress2.md) |  | [optional] 
+**individual** | [**Individual2**](Individual2.md) |  | [optional] 
+**company** | [**Company2**](Company2.md) |  | [optional] 
+**language** | [**Language2**](Language2.md) |  | [optional] 
+**payee_type** | [**PayeeType2**](PayeeType2.md) |  | [optional] 
+**challenge** | [**Challenge2**](Challenge2.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::UpdatePayeeDetailsRequest2.new(address: null,
+                                 individual: null,
+                                 company: null,
+                                 language: null,
+                                 payee_type: null,
+                                 challenge: null,
+                                 email: bob@example.com)
+```
+
+

data/docs/UpdateWebhookRequest.md

@@ -0,0 +1,21 @@
+# VeloPayments::UpdateWebhookRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook_url** | **String** |  | [optional] 
+**authorization_header** | **String** |  | [optional] 
+**enabled** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::UpdateWebhookRequest.new(webhook_url: null,
+                                 authorization_header: null,
+                                 enabled: null)
+```
+
+

data/docs/UserResponse.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **mfa_type** | **String** | The type of the MFA device | [optional] 
 **mfa_status** | **String** | The status of the MFA device | [optional] 
 **locked_out** | **Boolean** | If true the user is currently locked out and unable to log in | [optional] 
-**locked_out_timestamp** | **DateTime** | A timestamp showing when the user was locked out If null then the user is not currently locked out  | [optional] 
+**locked_out_timestamp** | **Time** | A timestamp showing when the user was locked out If null then the user is not currently locked out  | [optional] 
 
 ## Code Sample
 

data/docs/UsersApi.md

@@ -19,6 +19,7 @@ Method | HTTP request | Description
 [**unregister_mfa_for_self**](UsersApi.md#unregister_mfa_for_self) | **POST** /v2/users/self/mfa/unregister | Unregister MFA for Self
 [**update_password_self**](UsersApi.md#update_password_self) | **POST** /v2/users/self/password | Update Password for self
 [**user_details_update**](UsersApi.md#user_details_update) | **POST** /v2/users/{userId}/userDetailsUpdate | Update User Details
+[**user_details_update_for_self**](UsersApi.md#user_details_update_for_self) | **POST** /v2/users/self/userDetailsUpdate | Update User Details for self
 [**validate_password_self**](UsersApi.md#validate_password_self) | **POST** /v2/users/self/password/validate | Validate the proposed password
 
 
@@ -178,7 +179,7 @@ nil (empty response body)
 
 ## get_self
 
-> UserResponse2 get_self
+> UserResponse get_self
 
 Get Self
 
@@ -212,7 +213,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**UserResponse2**](UserResponse2.md)
+[**UserResponse**](UserResponse.md)
 
 ### Authorization
 
@@ -352,7 +353,7 @@ opts = {
   status: VeloPayments::UserStatus.new, # UserStatus | The status of the User.
   entity_id: 'entity_id_example', # String | The entityId of the User.
   page: 1, # Integer | Page number. Default is 1.
-  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
+  page_size: 25, # Integer | The number of results to return in a page
   sort: 'email:asc' # String | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. 
 }
 
@@ -374,7 +375,7 @@ Name | Type | Description  | Notes
  **status** | [**UserStatus**](.md)| The status of the User. | [optional] 
  **entity_id** | [**String**](.md)| The entityId of the User. | [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]
+ **page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
  **sort** | **String**| List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.  | [optional] [default to 'email:asc']
 
 ### Return type
@@ -654,7 +655,7 @@ nil (empty response body)
 
 ## unregister_mfa_for_self
 
-> unregister_mfa_for_self(self_mfa_type_unregister_request)
+> unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
 
 Unregister MFA for Self
 
@@ -673,10 +674,13 @@ end
 
 api_instance = VeloPayments::UsersApi.new
 self_mfa_type_unregister_request = VeloPayments::SelfMFATypeUnregisterRequest.new # SelfMFATypeUnregisterRequest | The MFA Type to unregister
+opts = {
+  authorization: 'authorization_example' # String | Bearer token authorization leg of validate
+}
 
 begin
   #Unregister MFA for Self
-  api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request)
+  api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
 rescue VeloPayments::ApiError => e
   puts "Exception when calling UsersApi->unregister_mfa_for_self: #{e}"
 end
@@ -688,6 +692,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **self_mfa_type_unregister_request** | [**SelfMFATypeUnregisterRequest**](SelfMFATypeUnregisterRequest.md)| The MFA Type to unregister | 
+ **authorization** | **String**| Bearer token authorization leg of validate | [optional] 
 
 ### Return type
 
@@ -807,6 +812,57 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## user_details_update_for_self
+
+> user_details_update_for_self(payee_user_self_update_request)
+
+Update User Details for self
+
+<p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p> 
+
+### 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::UsersApi.new
+payee_user_self_update_request = VeloPayments::PayeeUserSelfUpdateRequest.new # PayeeUserSelfUpdateRequest | The details of the user to update
+
+begin
+  #Update User Details for self
+  api_instance.user_details_update_for_self(payee_user_self_update_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling UsersApi->user_details_update_for_self: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_user_self_update_request** | [**PayeeUserSelfUpdateRequest**](PayeeUserSelfUpdateRequest.md)| The details of the user to update | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## validate_password_self
 
 > ValidatePasswordResponse validate_password_self(password_request)

data/docs/WatchlistStatus2.md

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

data/docs/WebhookResponse.md

@@ -0,0 +1,25 @@
+# VeloPayments::WebhookResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**payor_id** | **String** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**authorization_header** | **String** |  | [optional] 
+**enabled** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::WebhookResponse.new(id: null,
+                                 payor_id: null,
+                                 webhook_url: null,
+                                 authorization_header: null,
+                                 enabled: null)
+```
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,280 @@
+# VeloPayments::WebhooksApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_webhook_v1**](WebhooksApi.md#create_webhook_v1) | **POST** /v1/webhooks | Create Webhook
+[**get_webhook_v1**](WebhooksApi.md#get_webhook_v1) | **GET** /v1/webhooks/{webhookId} | Get details about the given webhook.
+[**list_webhooks_v1**](WebhooksApi.md#list_webhooks_v1) | **GET** /v1/webhooks | List the details about the webhooks for the given payor.
+[**ping_webhook_v1**](WebhooksApi.md#ping_webhook_v1) | **POST** /v1/webhooks/{webhookId}/ping | 
+[**update_webhook_v1**](WebhooksApi.md#update_webhook_v1) | **POST** /v1/webhooks/{webhookId} | Update Webhook
+
+
+
+## create_webhook_v1
+
+> create_webhook_v1(opts)
+
+Create Webhook
+
+Create Webhook
+
+### 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::WebhooksApi.new
+opts = {
+  create_webhook_request: VeloPayments::CreateWebhookRequest.new # CreateWebhookRequest | 
+}
+
+begin
+  #Create Webhook
+  api_instance.create_webhook_v1(opts)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WebhooksApi->create_webhook_v1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_webhook_v1
+
+> WebhookResponse get_webhook_v1(webhook_id)
+
+Get details about the given webhook.
+
+Get details about the given webhook.
+
+### 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::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook id
+
+begin
+  #Get details about the given webhook.
+  result = api_instance.get_webhook_v1(webhook_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WebhooksApi->get_webhook_v1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | [**String**](.md)| Webhook id | 
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_webhooks_v1
+
+> WebhooksResponse list_webhooks_v1(payor_id, opts)
+
+List the details about the webhooks for the given payor.
+
+List the details about the webhooks for the given 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::WebhooksApi.new
+payor_id = 'payor_id_example' # String | The Payor ID
+opts = {
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 25 # Integer | The number of results to return in a page
+}
+
+begin
+  #List the details about the webhooks for the given payor.
+  result = api_instance.list_webhooks_v1(payor_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WebhooksApi->list_webhooks_v1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The Payor ID | 
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+ **page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
+
+### Return type
+
+[**WebhooksResponse**](WebhooksResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## ping_webhook_v1
+
+> PingResponse ping_webhook_v1(webhook_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::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook id
+
+begin
+  result = api_instance.ping_webhook_v1(webhook_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WebhooksApi->ping_webhook_v1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | [**String**](.md)| Webhook id | 
+
+### Return type
+
+[**PingResponse**](PingResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook_v1
+
+> update_webhook_v1(webhook_id, opts)
+
+Update Webhook
+
+Update Webhook
+
+### 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::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook id
+opts = {
+  update_webhook_request: VeloPayments::UpdateWebhookRequest.new # UpdateWebhookRequest | 
+}
+
+begin
+  #Update Webhook
+  api_instance.update_webhook_v1(webhook_id, opts)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WebhooksApi->update_webhook_v1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | [**String**](.md)| Webhook id | 
+ **update_webhook_request** | [**UpdateWebhookRequest**](UpdateWebhookRequest.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+