class Refsheet::UsersApi
Attributes
Public Class Methods
# File lib/refsheet/api/users_api.rb, line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Retrieve User by ID Finds a user by ID. The ID supplied should be the hexadecimal user GUID, not the username. To find a user by username, use `/users/lookup/{id}` @param id User GUID @param [Hash] opts the optional parameters @return [InlineResponse200]
# File lib/refsheet/api/users_api.rb, line 39 def find(id, opts = {}) data, _status_code, _headers = find_with_http_info(id, opts) return data end
Retrieve User by ID Finds a user by ID. The ID supplied should be the hexadecimal user GUID, not the username. To find a user by username, use `/users/lookup/{id}` @param id User GUID @param [Hash] opts the optional parameters @return [Array<(InlineResponse200
, Fixnum, Hash)>] InlineResponse200
data, response status code and response headers
# File lib/refsheet/api/users_api.rb, line 49 def find_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UsersApi.find ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.find" if id.nil? # resource path local_var_path = "/users/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKeySecret', 'apiKeyId'] 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 => 'InlineResponse200') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieve User by Username Finds a user by Username. This operation is not case sensitive. Please consider using `/users/{id}` directly if possible. @param username Username of the user to find @param [Hash] opts the optional parameters @return [InlineResponse200]
# File lib/refsheet/api/users_api.rb, line 96 def lookup(username, opts = {}) data, _status_code, _headers = lookup_with_http_info(username, opts) return data end
Retrieve User by Username Finds a user by Username. This operation is not case sensitive. Please consider using `/users/{id}` directly if possible. @param username Username of the user to find @param [Hash] opts the optional parameters @return [Array<(InlineResponse200
, Fixnum, Hash)>] InlineResponse200
data, response status code and response headers
# File lib/refsheet/api/users_api.rb, line 106 def lookup_with_http_info(username, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UsersApi.lookup ..." end # verify the required parameter 'username' is set fail ArgumentError, "Missing the required parameter 'username' when calling UsersApi.lookup" if username.nil? # resource path local_var_path = "/users/lookup/{username}".sub('{format}','json').sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKeySecret', 'apiKeyId'] 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 => 'InlineResponse200') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end