class VeloPayments::UsersApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/velopayments/api/users_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_user_by_id_v2(user_id, opts = {}) click to toggle source

Delete a User Delete User by Id. @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 27
def delete_user_by_id_v2(user_id, opts = {})
  delete_user_by_id_v2_with_http_info(user_id, opts)
  nil
end
delete_user_by_id_v2_with_http_info(user_id, opts = {}) click to toggle source

Delete a User Delete User by Id. @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 37
def delete_user_by_id_v2_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.delete_user_by_id_v2 ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_by_id_v2"
  end
  # resource path
  local_var_path = '/v2/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#delete_user_by_id_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
disable_user_v2(user_id, opts = {}) click to toggle source

Disable a User <p>If a user is enabled this endpoint will disable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot disable themself </p> <p>When a user is disabled any active access tokens will be revoked and the user will not be able to log in</p> @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 89
def disable_user_v2(user_id, opts = {})
  disable_user_v2_with_http_info(user_id, opts)
  nil
end
disable_user_v2_with_http_info(user_id, opts = {}) click to toggle source

Disable a User &lt;p&gt;If a user is enabled this endpoint will disable them &lt;/p&gt; &lt;p&gt;The invoker must have the appropriate permission &lt;/p&gt; &lt;p&gt;A user cannot disable themself &lt;/p&gt; &lt;p&gt;When a user is disabled any active access tokens will be revoked and the user will not be able to log in&lt;/p&gt; @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 99
def disable_user_v2_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.disable_user_v2 ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.disable_user_v2"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/disable'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#disable_user_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
enable_user_v2(user_id, opts = {}) click to toggle source

Enable a User <p>If a user has been disabled this endpoints will enable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot enable themself </p> <p>If the user is a payor user and the payor is disabled this operation is not allowed</p> <p>If enabling a payor user would breach the limit for master admin payor users the request will be rejected </p> @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 151
def enable_user_v2(user_id, opts = {})
  enable_user_v2_with_http_info(user_id, opts)
  nil
end
enable_user_v2_with_http_info(user_id, opts = {}) click to toggle source

Enable a User &lt;p&gt;If a user has been disabled this endpoints will enable them &lt;/p&gt; &lt;p&gt;The invoker must have the appropriate permission &lt;/p&gt; &lt;p&gt;A user cannot enable themself &lt;/p&gt; &lt;p&gt;If the user is a payor user and the payor is disabled this operation is not allowed&lt;/p&gt; &lt;p&gt;If enabling a payor user would breach the limit for master admin payor users the request will be rejected &lt;/p&gt; @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 161
def enable_user_v2_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.enable_user_v2 ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.enable_user_v2"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/enable'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#enable_user_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_self(opts = {}) click to toggle source

Get Self Get the user's details @param [Hash] opts the optional parameters @return [UserResponse2]

# File lib/velopayments/api/users_api.rb, line 212
def get_self(opts = {})
  data, _status_code, _headers = get_self_with_http_info(opts)
  data
end
get_self_with_http_info(opts = {}) click to toggle source

Get Self Get the user&#39;s details @param [Hash] opts the optional parameters @return [Array<(UserResponse2, Integer, Hash)>] UserResponse2 data, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 221
def get_self_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_self ...'
  end
  # resource path
  local_var_path = '/v2/users/self'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UserResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_by_id_v2(user_id, opts = {}) click to toggle source

Get User Get a Single User by Id. @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [UserResponse]

# File lib/velopayments/api/users_api.rb, line 269
def get_user_by_id_v2(user_id, opts = {})
  data, _status_code, _headers = get_user_by_id_v2_with_http_info(user_id, opts)
  data
end
get_user_by_id_v2_with_http_info(user_id, opts = {}) click to toggle source

Get User Get a Single User by Id. @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 279
def get_user_by_id_v2_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_user_by_id_v2 ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_by_id_v2"
  end
  # resource path
  local_var_path = '/v2/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UserResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_by_id_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
invite_user(invite_user_request, opts = {}) click to toggle source

Invite a User Create a User and invite them to the system @param invite_user_request [InviteUserRequest] Details of User to invite @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 331
def invite_user(invite_user_request, opts = {})
  invite_user_with_http_info(invite_user_request, opts)
  nil
end
invite_user_with_http_info(invite_user_request, opts = {}) click to toggle source

Invite a User Create a User and invite them to the system @param invite_user_request [InviteUserRequest] Details of User to invite @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 341
def invite_user_with_http_info(invite_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.invite_user ...'
  end
  # verify the required parameter 'invite_user_request' is set
  if @api_client.config.client_side_validation && invite_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'invite_user_request' when calling UsersApi.invite_user"
  end
  # resource path
  local_var_path = '/v2/users/invite'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(invite_user_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#invite_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_users(opts = {}) click to toggle source

List Users Get a paginated response listing the Users @param [Hash] opts the optional parameters @option opts [UserType] :type The Type of the User. @option opts [UserStatus] :status The status of the User. @option opts [String] :entity_id The entityId of the User. @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @option opts [String] :sort 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. (default to 'email:asc') @return [PagedUserResponse]

# File lib/velopayments/api/users_api.rb, line 400
def list_users(opts = {})
  data, _status_code, _headers = list_users_with_http_info(opts)
  data
end
list_users_with_http_info(opts = {}) click to toggle source

List Users Get a paginated response listing the Users @param [Hash] opts the optional parameters @option opts [UserType] :type The Type of the User. @option opts [UserStatus] :status The status of the User. @option opts [String] :entity_id The entityId of the User. @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. @option opts [String] :sort 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. @return [Array<(PagedUserResponse, Integer, Hash)>] PagedUserResponse data, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 415
def list_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list_users ...'
  end
  pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling UsersApi.list_users, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v2/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PagedUserResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
register_sms(register_sms_request, opts = {}) click to toggle source

Register SMS Number <p>Register an Sms number and send an OTP to it </p> <p>Used for manual verification of a user </p> <p>The backoffice user initiates the request to send the OTP to the user's sms </p> <p>The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it</p> @param register_sms_request [RegisterSmsRequest] a SMS Number to send an OTP to @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 474
def register_sms(register_sms_request, opts = {})
  register_sms_with_http_info(register_sms_request, opts)
  nil
end
register_sms_with_http_info(register_sms_request, opts = {}) click to toggle source

Register SMS Number &lt;p&gt;Register an Sms number and send an OTP to it &lt;/p&gt; &lt;p&gt;Used for manual verification of a user &lt;/p&gt; &lt;p&gt;The backoffice user initiates the request to send the OTP to the user&#39;s sms &lt;/p&gt; &lt;p&gt;The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it&lt;/p&gt; @param register_sms_request [RegisterSmsRequest] a SMS Number to send an OTP to @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 484
def register_sms_with_http_info(register_sms_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.register_sms ...'
  end
  # verify the required parameter 'register_sms_request' is set
  if @api_client.config.client_side_validation && register_sms_request.nil?
    fail ArgumentError, "Missing the required parameter 'register_sms_request' when calling UsersApi.register_sms"
  end
  # resource path
  local_var_path = '/v2/users/registration/sms'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(register_sms_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#register_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
resend_token(user_id, resend_token_request, opts = {}) click to toggle source

Resend a token <p>Resend the specified token </p> <p>The token to resend must already exist for the user </p> <p>It will be revoked and a new one issued</p> @param user_id [String] The UUID of the User. @param resend_token_request [ResendTokenRequest] The type of token to resend @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 539
def resend_token(user_id, resend_token_request, opts = {})
  resend_token_with_http_info(user_id, resend_token_request, opts)
  nil
end
resend_token_with_http_info(user_id, resend_token_request, opts = {}) click to toggle source

Resend a token &lt;p&gt;Resend the specified token &lt;/p&gt; &lt;p&gt;The token to resend must already exist for the user &lt;/p&gt; &lt;p&gt;It will be revoked and a new one issued&lt;/p&gt; @param user_id [String] The UUID of the User. @param resend_token_request [ResendTokenRequest] The type of token to resend @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 550
def resend_token_with_http_info(user_id, resend_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.resend_token ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.resend_token"
  end
  # verify the required parameter 'resend_token_request' is set
  if @api_client.config.client_side_validation && resend_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'resend_token_request' when calling UsersApi.resend_token"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/tokens'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(resend_token_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#resend_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
role_update(user_id, role_update_request, opts = {}) click to toggle source

Update User Role <p>Update the user's Role</p> @param user_id [String] The UUID of the User. @param role_update_request [RoleUpdateRequest] The Role to change to @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 609
def role_update(user_id, role_update_request, opts = {})
  role_update_with_http_info(user_id, role_update_request, opts)
  nil
end
role_update_with_http_info(user_id, role_update_request, opts = {}) click to toggle source

Update User Role &lt;p&gt;Update the user&#39;s Role&lt;/p&gt; @param user_id [String] The UUID of the User. @param role_update_request [RoleUpdateRequest] The Role to change to @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 620
def role_update_with_http_info(user_id, role_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.role_update ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.role_update"
  end
  # verify the required parameter 'role_update_request' is set
  if @api_client.config.client_side_validation && role_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'role_update_request' when calling UsersApi.role_update"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/roleUpdate'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(role_update_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#role_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
unlock_user_v2(user_id, opts = {}) click to toggle source

Unlock a User If a user is locked this endpoint will unlock them @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 678
def unlock_user_v2(user_id, opts = {})
  unlock_user_v2_with_http_info(user_id, opts)
  nil
end
unlock_user_v2_with_http_info(user_id, opts = {}) click to toggle source

Unlock a User If a user is locked this endpoint will unlock them @param user_id [String] The UUID of the User. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 688
def unlock_user_v2_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.unlock_user_v2 ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.unlock_user_v2"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/unlock'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#unlock_user_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
unregister_mfa(user_id, unregister_mfa_request, opts = {}) click to toggle source

Unregister MFA for the user <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> @param user_id [String] The UUID of the User. @param unregister_mfa_request [UnregisterMFARequest] The MFA Type to unregister @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 741
def unregister_mfa(user_id, unregister_mfa_request, opts = {})
  unregister_mfa_with_http_info(user_id, unregister_mfa_request, opts)
  nil
end
unregister_mfa_for_self(self_mfa_type_unregister_request, opts = {}) click to toggle source

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> @param self_mfa_type_unregister_request [SelfMFATypeUnregisterRequest] The MFA Type to unregister @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 810
def unregister_mfa_for_self(self_mfa_type_unregister_request, opts = {})
  unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
  nil
end
unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts = {}) click to toggle source

Unregister MFA for Self &lt;p&gt;Unregister the MFA device for the user &lt;/p&gt; &lt;p&gt;If the user does not require further verification then a register new MFA device token will be sent to them via their email address&lt;/p&gt; @param self_mfa_type_unregister_request [SelfMFATypeUnregisterRequest] The MFA Type to unregister @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 820
def unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.unregister_mfa_for_self ...'
  end
  # verify the required parameter 'self_mfa_type_unregister_request' is set
  if @api_client.config.client_side_validation && self_mfa_type_unregister_request.nil?
    fail ArgumentError, "Missing the required parameter 'self_mfa_type_unregister_request' when calling UsersApi.unregister_mfa_for_self"
  end
  # resource path
  local_var_path = '/v2/users/self/mfa/unregister'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(self_mfa_type_unregister_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#unregister_mfa_for_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
unregister_mfa_with_http_info(user_id, unregister_mfa_request, opts = {}) click to toggle source

Unregister MFA for the user &lt;p&gt;Unregister the MFA device for the user &lt;/p&gt; &lt;p&gt;If the user does not require further verification then a register new MFA device token will be sent to them via their email address&lt;/p&gt; @param user_id [String] The UUID of the User. @param unregister_mfa_request [UnregisterMFARequest] The MFA Type to unregister @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 752
def unregister_mfa_with_http_info(user_id, unregister_mfa_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.unregister_mfa ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.unregister_mfa"
  end
  # verify the required parameter 'unregister_mfa_request' is set
  if @api_client.config.client_side_validation && unregister_mfa_request.nil?
    fail ArgumentError, "Missing the required parameter 'unregister_mfa_request' when calling UsersApi.unregister_mfa"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/mfa/unregister'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(unregister_mfa_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#unregister_mfa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_password_self(self_update_password_request, opts = {}) click to toggle source

Update Password for self Update password for self @param self_update_password_request [SelfUpdatePasswordRequest] The password @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 874
def update_password_self(self_update_password_request, opts = {})
  update_password_self_with_http_info(self_update_password_request, opts)
  nil
end
update_password_self_with_http_info(self_update_password_request, opts = {}) click to toggle source

Update Password for self Update password for self @param self_update_password_request [SelfUpdatePasswordRequest] The password @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 884
def update_password_self_with_http_info(self_update_password_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.update_password_self ...'
  end
  # verify the required parameter 'self_update_password_request' is set
  if @api_client.config.client_side_validation && self_update_password_request.nil?
    fail ArgumentError, "Missing the required parameter 'self_update_password_request' when calling UsersApi.update_password_self"
  end
  # resource path
  local_var_path = '/v2/users/self/password'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(self_update_password_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_password_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
user_details_update(user_id, user_details_update_request, opts = {}) click to toggle source

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> @param user_id [String] The UUID of the User. @param user_details_update_request [UserDetailsUpdateRequest] The details of the user to update @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/users_api.rb, line 939
def user_details_update(user_id, user_details_update_request, opts = {})
  user_details_update_with_http_info(user_id, user_details_update_request, opts)
  nil
end
user_details_update_with_http_info(user_id, user_details_update_request, opts = {}) click to toggle source

Update User Details &lt;p&gt;Update the profile details for the given user&lt;/p&gt; &lt;p&gt;When updating Payor users with the role of payor.master_admin a verificationCode is required&lt;/p&gt; @param user_id [String] The UUID of the User. @param user_details_update_request [UserDetailsUpdateRequest] The details of the user to update @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 950
def user_details_update_with_http_info(user_id, user_details_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.user_details_update ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_details_update"
  end
  # verify the required parameter 'user_details_update_request' is set
  if @api_client.config.client_side_validation && user_details_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_details_update_request' when calling UsersApi.user_details_update"
  end
  # resource path
  local_var_path = '/v2/users/{userId}/userDetailsUpdate'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(user_details_update_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#user_details_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
validate_password_self(password_request, opts = {}) click to toggle source

Validate the proposed password validate the password and return a score @param password_request [PasswordRequest] The password @param [Hash] opts the optional parameters @return [ValidatePasswordResponse]

# File lib/velopayments/api/users_api.rb, line 1008
def validate_password_self(password_request, opts = {})
  data, _status_code, _headers = validate_password_self_with_http_info(password_request, opts)
  data
end
validate_password_self_with_http_info(password_request, opts = {}) click to toggle source

Validate the proposed password validate the password and return a score @param password_request [PasswordRequest] The password @param [Hash] opts the optional parameters @return [Array<(ValidatePasswordResponse, Integer, Hash)>] ValidatePasswordResponse data, response status code and response headers

# File lib/velopayments/api/users_api.rb, line 1018
def validate_password_self_with_http_info(password_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.validate_password_self ...'
  end
  # verify the required parameter 'password_request' is set
  if @api_client.config.client_side_validation && password_request.nil?
    fail ArgumentError, "Missing the required parameter 'password_request' when calling UsersApi.validate_password_self"
  end
  # resource path
  local_var_path = '/v2/users/self/password/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(password_request) 

  # return_type
  return_type = opts[:return_type] || 'ValidatePasswordResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#validate_password_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end