Class: Refsheet::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/refsheet/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



30
31
32
 
# File 'lib/refsheet/api/users_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/refsheet/api/users_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#find(id, opts = {}) ⇒ InlineResponse200

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`

Parameters:

  • id —

    User GUID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
 
# 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

#find_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

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 &#x60;/users/lookup/id&#x60;

Parameters:

  • id —

    User GUID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse200, Fixnum, Hash)>) —

    InlineResponse200 data, response status code and response headers



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 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

#lookup(username, opts = {}) ⇒ InlineResponse200

Retrieve User by Username Finds a user by Username. This operation is not case sensitive. Please consider using ‘/users/id` directly if possible.

Parameters:

  • username —

    Username of the user to find

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



96
97
98
99
 
# 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

#lookup_with_http_info(username, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Retrieve User by Username Finds a user by Username. This operation is not case sensitive. Please consider using &#x60;/users/id&#x60; directly if possible.

Parameters:

  • username —

    Username of the user to find

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse200, Fixnum, Hash)>) —

    InlineResponse200 data, response status code and response headers



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# 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