Class: CloudsmithApi::UserApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/user_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



19
20
21
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#user_self(opts = {}) ⇒ UserBrief

Provide a brief for the current user (if any). Provide a brief for the current user (if any).

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 26

def user_self(opts = {})
  data, _status_code, _headers = user_self_with_http_info(opts)
  data
end

#user_self_with_http_info(opts = {}) ⇒ Array<(UserBrief, Fixnum, Hash)>

Provide a brief for the current user (if any). Provide a brief for the current user (if any).

Parameters:

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

    the optional parameters

Returns:

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

    UserBrief data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 35

def user_self_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_self ...'
  end
  # resource path
  local_var_path = '/user/self/'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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 => 'UserBrief')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_token_create(opts = {}) ⇒ UserAuthToken

Create or retrieve API token for a user. Handles both: - Users authenticating with basic credentials to get a token - Two-factor authentication flow

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



75
76
77
78
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 75

def user_token_create(opts = {})
  data, _status_code, _headers = user_token_create_with_http_info(opts)
  data
end

#user_token_create_with_http_info(opts = {}) ⇒ Array<(UserAuthToken, Fixnum, Hash)>

Create or retrieve API token for a user. Handles both: - Users authenticating with basic credentials to get a token - Two-factor authentication flow

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserAuthToken data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 85

def user_token_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_token_create ...'
  end
  # resource path
  local_var_path = '/user/token/'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['basic']
  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 => 'UserAuthToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tokens_create(opts = {}) ⇒ UserAuthenticationToken

Create an API key for the user that is currently authenticated. Create an API key for the user that is currently authenticated.

Parameters:

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

    the optional parameters

Returns:



124
125
126
127
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 124

def user_tokens_create(opts = {})
  data, _status_code, _headers = user_tokens_create_with_http_info(opts)
  data
end

#user_tokens_create_with_http_info(opts = {}) ⇒ Array<(UserAuthenticationToken, Fixnum, Hash)>

Create an API key for the user that is currently authenticated. Create an API key for the user that is currently authenticated.

Parameters:

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

    the optional parameters

Returns:

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

    UserAuthenticationToken data, response status code and response headers



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 133

def user_tokens_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_tokens_create ...'
  end
  # resource path
  local_var_path = '/user/tokens/'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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 => 'UserAuthenticationToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_tokens_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tokens_list(opts = {}) ⇒ InlineResponse200

Retrieve the API key assigned to the user that is currently authenticated. Retrieve the API key assigned to the user that is currently authenticated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



174
175
176
177
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 174

def user_tokens_list(opts = {})
  data, _status_code, _headers = user_tokens_list_with_http_info(opts)
  data
end

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

Retrieve the API key assigned to the user that is currently authenticated. Retrieve the API key assigned to the user that is currently authenticated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

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

    InlineResponse200 data, response status code and response headers



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 185

def user_tokens_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_tokens_list ...'
  end
  # resource path
  local_var_path = '/user/tokens/'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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: UserApi#user_tokens_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tokens_refresh(slug_perm, opts = {}) ⇒ UserAuthenticationToken

Refresh the specified API key for the user that is currently authenticated. Refresh the specified API key for the user that is currently authenticated.

Parameters:

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

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 227

def user_tokens_refresh(slug_perm, opts = {})
  data, _status_code, _headers = user_tokens_refresh_with_http_info(slug_perm, opts)
  data
end

#user_tokens_refresh_with_http_info(slug_perm, opts = {}) ⇒ Array<(UserAuthenticationToken, Fixnum, Hash)>

Refresh the specified API key for the user that is currently authenticated. Refresh the specified API key for the user that is currently authenticated.

Parameters:

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

    the optional parameters

Returns:

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

    UserAuthenticationToken data, response status code and response headers



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/cloudsmith-api/api/user_api.rb', line 237

def user_tokens_refresh_with_http_info(slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_tokens_refresh ...'
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling UserApi.user_tokens_refresh"
  end
  # resource path
  local_var_path = '/user/tokens/{slug_perm}/refresh/'.sub('{' + 'slug_perm' + '}', slug_perm.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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 => 'UserAuthenticationToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_tokens_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end