docs/UsersApi.md in velopayments-2.20.119 vs docs/UsersApi.md in velopayments-2.23.78.beta1

- old
+ new

@@ -17,10 +17,11 @@ [**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 ## delete_user_by_id_v2 @@ -176,11 +177,11 @@ - **Accept**: application/json ## get_self -> UserResponse2 get_self +> UserResponse get_self Get Self Get the user's details @@ -210,11 +211,11 @@ This endpoint does not need any parameter. ### Return type -[**UserResponse2**](UserResponse2.md) +[**UserResponse**](UserResponse.md) ### Authorization [OAuth2](../README.md#OAuth2) @@ -350,11 +351,11 @@ opts = { type: VeloPayments::UserType.new, # UserType | The Type of the User. 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. } begin #List Users @@ -372,11 +373,11 @@ ------------- | ------------- | ------------- | ------------- **type** | [**UserType**](.md)| The Type of the User. | [optional] **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 [**PagedUserResponse**](PagedUserResponse.md) @@ -652,11 +653,11 @@ - **Accept**: application/json ## 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 <p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p> @@ -671,14 +672,17 @@ config.access_token = 'YOUR ACCESS TOKEN' 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 ``` @@ -686,10 +690,11 @@ 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 nil (empty response body) @@ -790,9 +795,60 @@ 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)