velopayments 2.18.113 → 2.23.78.beta1

data/docs/TransferRequest2.md

@@ -0,0 +1,21 @@
+# VeloPayments::TransferRequest2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to_source_account_id** | **String** | The 'to' source account id, which will be credited | 
+**amount** | **Integer** | Amount to transfer, in minor units | 
+**currency** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::TransferRequest2.new(to_source_account_id: null,
+                                 amount: null,
+                                 currency: USD)
+```
+
+

data/docs/TransmissionType.md

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

data/docs/TransmissionTypes.md

@@ -0,0 +1,21 @@
+# VeloPayments::TransmissionTypes
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ach** | **Boolean** | Whether the Payor is allowed to pay via ACH | 
+**same_day_ach** | **Boolean** | Whether the Payor is allowed to pay via same day ACH | 
+**wire** | **Boolean** | Whether the Payor is allowed to pay via wire | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::TransmissionTypes.new(ach: true,
+                                 same_day_ach: true,
+                                 wire: true)
+```
+
+

data/docs/TransmissionTypes2.md

@@ -0,0 +1,21 @@
+# VeloPayments::TransmissionTypes2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ach** | **Boolean** | Whether the Payor is allowed to pay via ACH | 
+**same_day_ach** | **Boolean** | Whether the Payor is allowed to pay via same day ACH | 
+**wire** | **Boolean** | Whether the Payor is allowed to pay via wire | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::TransmissionTypes2.new(ach: true,
+                                 same_day_ach: true,
+                                 wire: true)
+```
+
+

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/UpdatePayeeDetailsRequest.md

@@ -0,0 +1,29 @@
+# VeloPayments::UpdatePayeeDetailsRequest
+
+## 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::UpdatePayeeDetailsRequest.new(address: null,
+                                 individual: null,
+                                 company: null,
+                                 language: null,
+                                 payee_type: null,
+                                 challenge: null,
+                                 email: bob@example.com)
+```
+
+

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/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/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/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/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

@@ -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,13 @@ 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
+[**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
 
 
@@ -124,59 +126,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)
@@ -230,7 +179,7 @@ nil (empty response body)
 
 ## get_self
 
-> UserResponse2 get_self
+> UserResponse get_self
 
 Get Self
 
@@ -264,7 +213,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**UserResponse2**](UserResponse2.md)
+[**UserResponse**](UserResponse.md)
 
 ### Authorization
 
@@ -404,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. 
 }
 
@@ -426,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&#x3D;email:asc,lastName:asc) Default is email:asc &#39;name&#39; The supported sort fields are - email, lastNmae.  | [optional] [default to &#39;email:asc&#39;]
 
 ### Return type
@@ -547,6 +496,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)
@@ -653,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
 
@@ -672,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
@@ -687,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
 
@@ -753,6 +759,110 @@ 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
+
+
+## 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)