velopayments 2.18.113 → 2.19.40.beta1

data/docs/UnregisterMFARequest.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **mfa_type** | **String** | The type of the MFA device | 
-**verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them  | [optional] 
+**verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>  | [optional] 
 
 ## Code Sample
 

data/docs/UpdateRemoteIdRequest.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::UpdateRemoteIdRequest.new(payor_id: null,
-                                 remote_id: null)
+instance = VeloPayments::UpdateRemoteIdRequest.new(payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e,
+                                 remote_id: remoteId123)
 ```
 
 

data/docs/UserDetailsUpdateRequest.md

@@ -0,0 +1,31 @@
+# VeloPayments::UserDetailsUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**primary_contact_number** | **String** | The main contact number for the user  | [optional] 
+**secondary_contact_number** | **String** | The secondary contact number for the user  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**email** | **String** | the email address of the user | [optional] 
+**sms_number** | **String** | The phone number of a device that the user can receive sms messages on  | [optional] 
+**mfa_type** | [**MFAType**](MFAType.md) |  | [optional] 
+**verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::UserDetailsUpdateRequest.new(primary_contact_number: 11235555555,
+                                 secondary_contact_number: 11235555550,
+                                 first_name: John,
+                                 last_name: Doe,
+                                 email: foo@example.com,
+                                 sms_number: 11235555555,
+                                 mfa_type: null,
+                                 verification_code: 123456)
+```
+
+

data/docs/UsersApi.md

@@ -6,7 +6,6 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete_user_by_id_v2**](UsersApi.md#delete_user_by_id_v2) | **DELETE** /v2/users/{userId} | Delete a User
 [**disable_user_v2**](UsersApi.md#disable_user_v2) | **POST** /v2/users/{userId}/disable | Disable a User
-[**email_update**](UsersApi.md#email_update) | **POST** /v2/users/{userId}/emailUpdate | Update Email Address
 [**enable_user_v2**](UsersApi.md#enable_user_v2) | **POST** /v2/users/{userId}/enable | Enable a User
 [**get_self**](UsersApi.md#get_self) | **GET** /v2/users/self | Get Self
 [**get_user_by_id_v2**](UsersApi.md#get_user_by_id_v2) | **GET** /v2/users/{userId} | Get User
@@ -14,10 +13,12 @@ Method | HTTP request | Description
 [**list_users**](UsersApi.md#list_users) | **GET** /v2/users | List Users
 [**register_sms**](UsersApi.md#register_sms) | **POST** /v2/users/registration/sms | Register SMS Number
 [**resend_token**](UsersApi.md#resend_token) | **POST** /v2/users/{userId}/tokens | Resend a token
+[**role_update**](UsersApi.md#role_update) | **POST** /v2/users/{userId}/roleUpdate | Update User Role
 [**unlock_user_v2**](UsersApi.md#unlock_user_v2) | **POST** /v2/users/{userId}/unlock | Unlock a User
 [**unregister_mfa**](UsersApi.md#unregister_mfa) | **POST** /v2/users/{userId}/mfa/unregister | Unregister MFA for the user
 [**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
 [**validate_password_self**](UsersApi.md#validate_password_self) | **POST** /v2/users/self/password/validate | Validate the proposed password
 
 
@@ -124,59 +125,6 @@ nil (empty response body)
 - **Accept**: application/json
 
 
-## email_update
-
-> email_update(user_id, email_update_request)
-
-Update Email Address
-
-<p>Update the user's email address </p> <p>If the email address is already in use a 409 will be returned</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
-user_id = 'user_id_example' # String | The UUID of the User.
-email_update_request = VeloPayments::EmailUpdateRequest.new # EmailUpdateRequest | a new email address
-
-begin
-  #Update Email Address
-  api_instance.email_update(user_id, email_update_request)
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling UsersApi->email_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | [**String**](.md)| The UUID of the User. | 
- **email_update_request** | [**EmailUpdateRequest**](EmailUpdateRequest.md)| a new email address | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
 ## enable_user_v2
 
 > enable_user_v2(user_id)
@@ -547,6 +495,59 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## role_update
+
+> role_update(user_id, role_update_request)
+
+Update User Role
+
+<p>Update the user's Role</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
+user_id = 'user_id_example' # String | The UUID of the User.
+role_update_request = VeloPayments::RoleUpdateRequest.new # RoleUpdateRequest | The Role to change to
+
+begin
+  #Update User Role
+  api_instance.role_update(user_id, role_update_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling UsersApi->role_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | [**String**](.md)| The UUID of the User. | 
+ **role_update_request** | [**RoleUpdateRequest**](RoleUpdateRequest.md)| The Role to change to | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## unlock_user_v2
 
 > unlock_user_v2(user_id)
@@ -753,6 +754,59 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## user_details_update
+
+> user_details_update(user_id, user_details_update_request)
+
+Update User Details
+
+<p>Update the profile details for the given user</p> <p>When updating Payor users with the role of payor.master_admin a verificationCode is required</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
+user_id = 'user_id_example' # String | The UUID of the User.
+user_details_update_request = VeloPayments::UserDetailsUpdateRequest.new # UserDetailsUpdateRequest | The details of the user to update
+
+begin
+  #Update User Details
+  api_instance.user_details_update(user_id, user_details_update_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling UsersApi->user_details_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | [**String**](.md)| The UUID of the User. | 
+ **user_details_update_request** | [**UserDetailsUpdateRequest**](UserDetailsUpdateRequest.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/WithdrawPayoutApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**withdraw_payout_v3**](WithdrawPayoutApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
+[**v3_payouts_payout_id_delete**](WithdrawPayoutApi.md#v3_payouts_payout_id_delete) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
 
 
 
-## withdraw_payout_v3
+## v3_payouts_payout_id_delete
 
-> withdraw_payout_v3(payout_id)
+> v3_payouts_payout_id_delete(payout_id)
 
 Withdraw Payout
 
@@ -32,9 +32,9 @@ payout_id = 'payout_id_example' # String | Id of the payout
 
 begin
   #Withdraw Payout
-  api_instance.withdraw_payout_v3(payout_id)
+  api_instance.v3_payouts_payout_id_delete(payout_id)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling WithdrawPayoutApi->withdraw_payout_v3: #{e}"
+  puts "Exception when calling WithdrawPayoutApi->v3_payouts_payout_id_delete: #{e}"
 end
 ```
 
@@ -56,5 +56,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 

data/lib/velopayments.rb

@@ -3,10 +3,10 @@
 
 ### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
 
-The version of the OpenAPI document: 2.18.113
+The version of the OpenAPI document: 2.19.40
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -23,12 +23,14 @@ require 'velopayments/models/access_token_validation_request'
 require 'velopayments/models/auth_response'
 require 'velopayments/models/auto_top_up_config'
 require 'velopayments/models/challenge'
-require 'velopayments/models/check_token_response'
+require 'velopayments/models/company'
+require 'velopayments/models/company2'
 require 'velopayments/models/company_response'
 require 'velopayments/models/company_v1'
 require 'velopayments/models/create_funding_account_request'
 require 'velopayments/models/create_individual'
 require 'velopayments/models/create_individual2'
+require 'velopayments/models/create_individual2_name'
 require 'velopayments/models/create_payee'
 require 'velopayments/models/create_payee2'
 require 'velopayments/models/create_payee_address'
@@ -37,6 +39,7 @@ require 'velopayments/models/create_payees_csv_request'
 require 'velopayments/models/create_payees_csv_request2'
 require 'velopayments/models/create_payees_csv_response'
 require 'velopayments/models/create_payees_csv_response2'
+require 'velopayments/models/create_payees_csv_response_rejected_csv_rows'
 require 'velopayments/models/create_payees_request'
 require 'velopayments/models/create_payees_request2'
 require 'velopayments/models/create_payment_channel'
@@ -44,10 +47,10 @@ require 'velopayments/models/create_payment_channel2'
 require 'velopayments/models/create_payor_link_request'
 require 'velopayments/models/create_payout_request'
 require 'velopayments/models/currency_type'
-require 'velopayments/models/email_update_request'
 require 'velopayments/models/error'
 require 'velopayments/models/error_response'
 require 'velopayments/models/failed_submission'
+require 'velopayments/models/failed_submission2'
 require 'velopayments/models/funding_account_response'
 require 'velopayments/models/funding_audit'
 require 'velopayments/models/funding_event'
@@ -57,7 +60,6 @@ require 'velopayments/models/funding_request_v1'
 require 'velopayments/models/funding_request_v2'
 require 'velopayments/models/fx_summary_v3'
 require 'velopayments/models/fx_summary_v4'
-require 'velopayments/models/generate_otp_request'
 require 'velopayments/models/get_fundings_response'
 require 'velopayments/models/get_fundings_response_all_of'
 require 'velopayments/models/get_payments_for_payout_response_v3'
@@ -70,15 +72,25 @@ require 'velopayments/models/get_payouts_response_v3'
 require 'velopayments/models/get_payouts_response_v3_links'
 require 'velopayments/models/get_payouts_response_v3_page'
 require 'velopayments/models/get_payouts_response_v4'
+require 'velopayments/models/individual'
+require 'velopayments/models/individual2'
 require 'velopayments/models/individual_response'
 require 'velopayments/models/individual_v1'
 require 'velopayments/models/individual_v1_name'
+require 'velopayments/models/inline_response400'
+require 'velopayments/models/inline_response400_errors'
+require 'velopayments/models/inline_response401'
+require 'velopayments/models/inline_response401_errors'
+require 'velopayments/models/inline_response403'
+require 'velopayments/models/inline_response403_errors'
 require 'velopayments/models/invitation_status'
 require 'velopayments/models/invitation_status_response'
 require 'velopayments/models/invite_payee_request'
+require 'velopayments/models/invite_payee_request2'
 require 'velopayments/models/invite_user_request'
 require 'velopayments/models/kyc_state'
 require 'velopayments/models/language'
+require 'velopayments/models/language2'
 require 'velopayments/models/link_for_response'
 require 'velopayments/models/list_funding_accounts_response'
 require 'velopayments/models/list_payments_response'
@@ -88,17 +100,20 @@ require 'velopayments/models/list_source_account_response'
 require 'velopayments/models/list_source_account_response_links'
 require 'velopayments/models/list_source_account_response_page'
 require 'velopayments/models/list_source_account_response_v2'
+require 'velopayments/models/location_type'
 require 'velopayments/models/mfa_details'
-require 'velopayments/models/mfa_status'
 require 'velopayments/models/mfa_type'
 require 'velopayments/models/marketing_opt_in'
 require 'velopayments/models/notifications'
-require 'velopayments/models/otp_type'
 require 'velopayments/models/ofac_status'
+require 'velopayments/models/ofac_status2'
 require 'velopayments/models/onboarded_status'
+require 'velopayments/models/onboarded_status2'
 require 'velopayments/models/page_for_response'
 require 'velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response'
 require 'velopayments/models/paged_payee_invitation_status_response'
+require 'velopayments/models/paged_payee_invitation_status_response2'
+require 'velopayments/models/paged_payee_invitation_status_response_page'
 require 'velopayments/models/paged_payee_response'
 require 'velopayments/models/paged_payee_response2'
 require 'velopayments/models/paged_payee_response2_summary'
@@ -112,18 +127,28 @@ require 'velopayments/models/paged_user_response_links'
 require 'velopayments/models/paged_user_response_page'
 require 'velopayments/models/password_request'
 require 'velopayments/models/payee'
+require 'velopayments/models/payee2'
 require 'velopayments/models/payee_address'
+require 'velopayments/models/payee_address2'
 require 'velopayments/models/payee_delta'
+require 'velopayments/models/payee_delta2'
 require 'velopayments/models/payee_delta_response'
+require 'velopayments/models/payee_delta_response2'
+require 'velopayments/models/payee_delta_response2_links'
 require 'velopayments/models/payee_delta_response_links'
 require 'velopayments/models/payee_delta_response_page'
 require 'velopayments/models/payee_invitation_status'
 require 'velopayments/models/payee_invitation_status_response'
+require 'velopayments/models/payee_invitation_status_response2'
 require 'velopayments/models/payee_payment_channel'
+require 'velopayments/models/payee_payment_channel2'
 require 'velopayments/models/payee_payor_ref'
-require 'velopayments/models/payee_payor_ref2'
+require 'velopayments/models/payee_payor_ref_v2'
+require 'velopayments/models/payee_payor_ref_v3'
 require 'velopayments/models/payee_response'
 require 'velopayments/models/payee_response2'
+require 'velopayments/models/payee_response_v2'
+require 'velopayments/models/payee_response_v3'
 require 'velopayments/models/payee_type'
 require 'velopayments/models/payment_audit_currency_v3'
 require 'velopayments/models/payment_audit_currency_v4'
@@ -139,7 +164,6 @@ require 'velopayments/models/payment_rails'
 require 'velopayments/models/payment_response_v3'
 require 'velopayments/models/payment_response_v4'
 require 'velopayments/models/payment_response_v4_payout'
-require 'velopayments/models/payment_status'
 require 'velopayments/models/payor_address'
 require 'velopayments/models/payor_address_v2'
 require 'velopayments/models/payor_aml_transaction_v3'
@@ -164,16 +188,16 @@ require 'velopayments/models/payout_summary_audit_v4'
 require 'velopayments/models/payout_summary_response'
 require 'velopayments/models/payout_type_v4'
 require 'velopayments/models/query_batch_response'
+require 'velopayments/models/query_batch_response2'
 require 'velopayments/models/quote_fx_summary'
 require 'velopayments/models/quote_response'
 require 'velopayments/models/region'
-require 'velopayments/models/register_mfa_request'
-require 'velopayments/models/register_mfa_response'
 require 'velopayments/models/register_sms_request'
 require 'velopayments/models/rejected_payment'
 require 'velopayments/models/resend_token_request'
 require 'velopayments/models/reset_password_request'
 require 'velopayments/models/role'
+require 'velopayments/models/role_update_request'
 require 'velopayments/models/self_mfa_type_unregister_request'
 require 'velopayments/models/self_update_password_request'
 require 'velopayments/models/set_notifications_request'
@@ -185,13 +209,13 @@ require 'velopayments/models/source_account_summary_v4'
 require 'velopayments/models/supported_countries_response'
 require 'velopayments/models/supported_countries_response2'
 require 'velopayments/models/supported_country'
-require 'velopayments/models/supported_country_v2'
+require 'velopayments/models/supported_country2'
 require 'velopayments/models/supported_currency'
 require 'velopayments/models/supported_currency_response'
-require 'velopayments/models/token_type'
 require 'velopayments/models/transfer_request'
 require 'velopayments/models/unregister_mfa_request'
 require 'velopayments/models/update_remote_id_request'
+require 'velopayments/models/user_details_update_request'
 require 'velopayments/models/user_info'
 require 'velopayments/models/user_response'
 require 'velopayments/models/user_response2'
@@ -199,16 +223,14 @@ require 'velopayments/models/user_response2_roles'
 require 'velopayments/models/user_status'
 require 'velopayments/models/user_type'
 require 'velopayments/models/user_type2'
-require 'velopayments/models/validate_mfa_request'
-require 'velopayments/models/validate_otp_request'
 require 'velopayments/models/validate_password_response'
 require 'velopayments/models/watchlist_status'
 
 # APIs
 require 'velopayments/api/countries_api'
 require 'velopayments/api/currencies_api'
-require 'velopayments/api/default_api'
 require 'velopayments/api/funding_manager_api'
+require 'velopayments/api/funding_manager_private_api'
 require 'velopayments/api/get_payout_api'
 require 'velopayments/api/instruct_payout_api'
 require 'velopayments/api/login_api'