docs/UsersApi.md in velopayments-2.26.124.beta1 vs docs/UsersApi.md in velopayments-2.29.128.beta1
- old
+ new
@@ -41,11 +41,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
begin
# Delete a User
api_instance.delete_user_by_id_v2(user_id)
rescue VeloPayments::ApiError => e
@@ -73,11 +73,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
### Return type
nil (empty response body)
@@ -109,11 +109,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
begin
# Disable a User
api_instance.disable_user_v2(user_id)
rescue VeloPayments::ApiError => e
@@ -141,11 +141,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
### Return type
nil (empty response body)
@@ -177,11 +177,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
begin
# Enable a User
api_instance.enable_user_v2(user_id)
rescue VeloPayments::ApiError => e
@@ -209,11 +209,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
### Return type
nil (empty response body)
@@ -311,11 +311,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
begin
# Get User
result = api_instance.get_user_by_id_v2(user_id)
p result
@@ -344,11 +344,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
### Return type
[**UserResponse**](UserResponse.md)
@@ -380,11 +380,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-invite_user_request = VeloPayments::InviteUserRequest.new({email: 'foo@example.com', mfa_type: 'SMS', sms_number: '11235555555', primary_contact_number: '11235555555', roles: ['roles_example']}) # InviteUserRequest | Details of User to invite
+invite_user_request = VeloPayments::InviteUserRequest.new({email: 'foo@example.com', mfa_type: 'SMS', sms_number: '11235555555', primary_contact_number: '11235555555', roles: ["velo.payor.admin"]}) # InviteUserRequest | Details of User to invite
begin
# Invite a User
api_instance.invite_user(invite_user_request)
rescue VeloPayments::ApiError => e
@@ -451,11 +451,12 @@
api_instance = VeloPayments::UsersApi.new
opts = {
type: VeloPayments::UserType::BACKOFFICE, # UserType | The Type of the User.
status: VeloPayments::UserStatus::ENABLED, # UserStatus | The status of the User.
- entity_id: TODO, # String | The entityId of the User.
+ entity_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The entityId of the User.
+ payee_type: VeloPayments::PayeeType::COMPANY, # PayeeType | The Type of the Payee entity. Either COMPANY or INDIVIDUAL.
page: 56, # Integer | Page number. Default is 1.
page_size: 56, # Integer | The number of results to return in a page
sort: 'sort_example' # String | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.
}
@@ -490,11 +491,12 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **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] |
+| **entity_id** | **String** | The entityId of the User. | [optional] |
+| **payee_type** | [**PayeeType**](.md) | The Type of the Payee entity. Either COMPANY or INDIVIDUAL. | [optional] |
| **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] |
| **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
@@ -597,11 +599,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
resend_token_request = VeloPayments::ResendTokenRequest.new({token_type: 'INVITE_MFA_USER'}) # ResendTokenRequest | The type of token to resend
begin
# Resend a token
api_instance.resend_token(user_id, resend_token_request)
@@ -630,11 +632,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
| **resend_token_request** | [**ResendTokenRequest**](ResendTokenRequest.md) | The type of token to resend | |
### Return type
nil (empty response body)
@@ -667,12 +669,12 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
-role_update_request = VeloPayments::RoleUpdateRequest.new({roles: ['roles_example']}) # RoleUpdateRequest | The Role to change to
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
+role_update_request = VeloPayments::RoleUpdateRequest.new({roles: ["payor.admin"]}) # RoleUpdateRequest | The Role to change to
begin
# Update User Role
api_instance.role_update(user_id, role_update_request)
rescue VeloPayments::ApiError => e
@@ -700,11 +702,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
| **role_update_request** | [**RoleUpdateRequest**](RoleUpdateRequest.md) | The Role to change to | |
### Return type
nil (empty response body)
@@ -737,11 +739,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
begin
# Unlock a User
api_instance.unlock_user_v2(user_id)
rescue VeloPayments::ApiError => e
@@ -769,11 +771,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
### Return type
nil (empty response body)
@@ -805,11 +807,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
unregister_mfa_request = VeloPayments::UnregisterMFARequest.new({mfa_type: 'YUBIKEY'}) # UnregisterMFARequest | The MFA Type to unregister
begin
# Unregister MFA for the user
api_instance.unregister_mfa(user_id, unregister_mfa_request)
@@ -838,11 +840,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | The UUID of the User. | |
| **unregister_mfa_request** | [**UnregisterMFARequest**](UnregisterMFARequest.md) | The MFA Type to unregister | |
### Return type
nil (empty response body)
@@ -1015,11 +1017,11 @@
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = VeloPayments::UsersApi.new
-user_id = TODO # String | The UUID of the User.
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # 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)
@@ -1048,10 +1050,10 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **user_id** | [**String**](.md) | The UUID of the User. | |
+| **user_id** | **String** | 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)