class Bfwd::UsersApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_user(user, opts = {}) click to toggle source

Create a user. {"nickname":"Create a new user","request":"createUserRequest.html","response":"createUserResponse.html"} @param user The user object to be created. @param [Hash] opts the optional parameters @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 28
def create_user(user, opts = {})
  data, _status_code, _headers = create_user_with_http_info(user, opts)
  return data
end
create_user_login(user, opts = {}) click to toggle source

Create a user. {"nickname":"Create a new user with login","request":"createUserWithLoginRequest.html","response":"createUserWithLoginResponse.html"} @param user The user object to be created. @param [Hash] opts the optional parameters @return [UserCreationResponsePagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 83
def create_user_login(user, opts = {})
  data, _status_code, _headers = create_user_login_with_http_info(user, opts)
  return data
end
create_user_login_with_http_info(user, opts = {}) click to toggle source

Create a user. {&quot;nickname&quot;:&quot;Create a new user with login&quot;,&quot;request&quot;:&quot;createUserWithLoginRequest.html&quot;,&quot;response&quot;:&quot;createUserWithLoginResponse.html&quot;} @param user The user object to be created. @param [Hash] opts the optional parameters @return [Array<(UserCreationResponsePagedMetadata, Fixnum, Hash)>] UserCreationResponsePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 93
def create_user_login_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.create_user_login ..."
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.create_user_login"
  end
  # resource path
  local_var_path = "/users/create-user-login"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserCreationResponsePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#create_user_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_user_with_http_info(user, opts = {}) click to toggle source

Create a user. {&quot;nickname&quot;:&quot;Create a new user&quot;,&quot;request&quot;:&quot;createUserRequest.html&quot;,&quot;response&quot;:&quot;createUserResponse.html&quot;} @param user The user object to be created. @param [Hash] opts the optional parameters @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_all_users(opts = {}) click to toggle source

Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Get all users","response" : "getUserAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first user to return. (default to 0) @option opts [Integer] :records The maximum number of users to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 142
def get_all_users(opts = {})
  data, _status_code, _headers = get_all_users_with_http_info(opts)
  return data
end
get_all_users_with_http_info(opts = {}) click to toggle source

Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. { "nickname&quot; : "Get all users&quot;,&quot;response&quot; : "getUserAll.html&quot;} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first user to return. @option opts [Integer] :records The maximum number of users to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 156
def get_all_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_all_users ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/users"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_by_id(user_id, opts = {}) click to toggle source

Returns a single User, specified by the ID parameter. { "nickname" : "Retrieve an existing user","response" : "getUserByID.html"} @param user_id ID of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization -IDs used to restrict the scope of API calls. @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 204
def get_user_by_id(user_id, opts = {})
  data, _status_code, _headers = get_user_by_id_with_http_info(user_id, opts)
  return data
end
get_user_by_id_with_http_info(user_id, opts = {}) click to toggle source

Returns a single User, specified by the ID parameter. { "nickname&quot; : "Retrieve an existing user&quot;,&quot;response&quot; : "getUserByID.html&quot;} @param user_id ID of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization -IDs used to restrict the scope of API calls. @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 215
def get_user_by_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_by_id ..."
  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"
  end
  # resource path
  local_var_path = "/users/{user-ID}".sub('{' + 'user-ID' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_by_password_reset_code(password_reset_code, opts = {}) click to toggle source

Returns a single User, specified by the password-reset-code parameter. { "nickname" : "Retrieve by reset code","response" : "getUserByPasswordResetCode.html"} @param password_reset_code The unique password reset code of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 262
def get_user_by_password_reset_code(password_reset_code, opts = {})
  data, _status_code, _headers = get_user_by_password_reset_code_with_http_info(password_reset_code, opts)
  return data
end
get_user_by_password_reset_code_with_http_info(password_reset_code, opts = {}) click to toggle source

Returns a single User, specified by the password-reset-code parameter. { "nickname&quot; : "Retrieve by reset code&quot;,&quot;response&quot; : "getUserByPasswordResetCode.html&quot;} @param password_reset_code The unique password reset code of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 273
def get_user_by_password_reset_code_with_http_info(password_reset_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_by_password_reset_code ..."
  end
  # verify the required parameter 'password_reset_code' is set
  if @api_client.config.client_side_validation && password_reset_code.nil?
    fail ArgumentError, "Missing the required parameter 'password_reset_code' when calling UsersApi.get_user_by_password_reset_code"
  end
  # resource path
  local_var_path = "/users/password-reset-code/{password-reset-code}".sub('{' + 'password-reset-code' + '}', password_reset_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_by_password_reset_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_by_sms_password_reset_code(sms_password_reset_code, opts = {}) click to toggle source

Returns a single User, specified by the sms-password-reset-code parameter. { "nickname" : "Retrieve by sms reset code","response" : "getUserBySMSPasswordResetCode.html"} @param sms_password_reset_code The unique SMS password reset code of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 320
def get_user_by_sms_password_reset_code(sms_password_reset_code, opts = {})
  data, _status_code, _headers = get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, opts)
  return data
end
get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, opts = {}) click to toggle source

Returns a single User, specified by the sms-password-reset-code parameter. { "nickname&quot; : "Retrieve by sms reset code&quot;,&quot;response&quot; : "getUserBySMSPasswordResetCode.html&quot;} @param sms_password_reset_code The unique SMS password reset code of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 331
def get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_by_sms_password_reset_code ..."
  end
  # verify the required parameter 'sms_password_reset_code' is set
  if @api_client.config.client_side_validation && sms_password_reset_code.nil?
    fail ArgumentError, "Missing the required parameter 'sms_password_reset_code' when calling UsersApi.get_user_by_sms_password_reset_code"
  end
  # resource path
  local_var_path = "/users/sms-password-reset-code/{sms-password-reset-code}".sub('{' + 'sms-password-reset-code' + '}', sms_password_reset_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_by_sms_password_reset_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_by_username(username, opts = {}) click to toggle source

Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. { "nickname" : "Retrieve by username","response" : "getUserByUsername.html"} @param username The unique username of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 378
def get_user_by_username(username, opts = {})
  data, _status_code, _headers = get_user_by_username_with_http_info(username, opts)
  return data
end
get_user_by_username_with_http_info(username, opts = {}) click to toggle source

Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. { "nickname&quot; : "Retrieve by username&quot;,&quot;response&quot; : "getUserByUsername.html&quot;} @param username The unique username of the User. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 389
def get_user_by_username_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_by_username ..."
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling UsersApi.get_user_by_username"
  end
  # resource path
  local_var_path = "/users/username/{username}".sub('{' + 'username' + '}', username.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_by_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
reset_user_password(request, opts = {}) click to toggle source

Create a password reset request. {"nickname":"Create a password reset request","request":"PasswordResetRequest.html","response":"PasswordResetResponse.html"} @param request @param [Hash] opts the optional parameters @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 435
def reset_user_password(request, opts = {})
  data, _status_code, _headers = reset_user_password_with_http_info(request, opts)
  return data
end
reset_user_password_with_http_info(request, opts = {}) click to toggle source

Create a password reset request. {&quot;nickname&quot;:&quot;Create a password reset request&quot;,&quot;request&quot;:&quot;PasswordResetRequest.html&quot;,&quot;response&quot;:&quot;PasswordResetResponse.html&quot;} @param request @param [Hash] opts the optional parameters @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 445
def reset_user_password_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.reset_user_password ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.reset_user_password"
  end
  # resource path
  local_var_path = "/users/password-reset"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#reset_user_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
retire_user(user_id, organizations, opts = {}) click to toggle source

Retires the user with the specified user-ID. { "nickname" : "Delete a user","response" : "deleteUser.html"} @param user_id ID of the User. @param organizations A list of organization-IDs used to restrict the scope of API calls. @param [Hash] opts the optional parameters @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 491
def retire_user(user_id, organizations, opts = {})
  data, _status_code, _headers = retire_user_with_http_info(user_id, organizations, opts)
  return data
end
retire_user_with_http_info(user_id, organizations, opts = {}) click to toggle source

Retires the user with the specified user-ID. { "nickname&quot; : "Delete a user&quot;,&quot;response&quot; : "deleteUser.html&quot;} @param user_id ID of the User. @param organizations A list of organization-IDs used to restrict the scope of API calls. @param [Hash] opts the optional parameters @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 502
def retire_user_with_http_info(user_id, organizations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.retire_user ..."
  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.retire_user"
  end
  # verify the required parameter 'organizations' is set
  if @api_client.config.client_side_validation && organizations.nil?
    fail ArgumentError, "Missing the required parameter 'organizations' when calling UsersApi.retire_user"
  end
  # resource path
  local_var_path = "/users/{user-ID}".sub('{' + 'user-ID' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#retire_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_user(user, opts = {}) click to toggle source

Update a user. { "nickname" : "Update a user", "request" : "updateUserRequest.html" ,"response" : "updateUserResponse.html" } @param user The user object to be updated. @param [Hash] opts the optional parameters @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 552
def update_user(user, opts = {})
  data, _status_code, _headers = update_user_with_http_info(user, opts)
  return data
end
update_user_password(password_reset, opts = {}) click to toggle source

Update a user's password. { "nickname" : "Update password using reset code", "request" : "updateUserPassword.html" ,"response" : "updateUserPasswordResponse.html" } @param password_reset The password reset object. @param [Hash] opts the optional parameters @return [UserPagedMetadata]

# File lib/bf_ruby2/api/users_api.rb, line 607
def update_user_password(password_reset, opts = {})
  data, _status_code, _headers = update_user_password_with_http_info(password_reset, opts)
  return data
end
update_user_password_with_http_info(password_reset, opts = {}) click to toggle source

Update a user&#39;s password. { "nickname&quot; : "Update password using reset code&quot;, "request&quot; : "updateUserPassword.html&quot; ,&quot;response&quot; : "updateUserPasswordResponse.html&quot; } @param password_reset The password reset object. @param [Hash] opts the optional parameters @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/users_api.rb, line 617
def update_user_password_with_http_info(password_reset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_user_password ..."
  end
  # verify the required parameter 'password_reset' is set
  if @api_client.config.client_side_validation && password_reset.nil?
    fail ArgumentError, "Missing the required parameter 'password_reset' when calling UsersApi.update_user_password"
  end
  # resource path
  local_var_path = "/users/password-update"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(password_reset)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_user_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_user_with_http_info(user, opts = {}) click to toggle source

Update a user. { "nickname&quot; : "Update a user&quot;, "request&quot; : "updateUserRequest.html&quot; ,&quot;response&quot; : "updateUserResponse.html&quot; } @param user The user object to be updated. @param [Hash] opts the optional parameters @return [Array<(UserPagedMetadata, Fixnum, Hash)>] UserPagedMetadata data, response status code and response headers

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end