Class: Forgejo::UserApi

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/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/forgejo/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/forgejo/api/user_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_current_user_repo(opts = {}) ⇒ Repository

Create a repository

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def create_current_user_repo(opts = {})
  data, _status_code, _headers = create_current_user_repo_with_http_info(opts)
  data
end

#create_current_user_repo_with_http_info(opts = {}) ⇒ Array<(Repository, Integer, Hash)>

Create a repository

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Repository, Integer, Hash)>) —

    Repository 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
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/forgejo/api/user_api.rb', line 35

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Repository'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.create_current_user_repo",
    :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: UserApi#create_current_user_repo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user_variable(variablename, opts = {}) ⇒ nil

Create a user-level variable

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/forgejo/api/user_api.rb', line 89

def create_user_variable(variablename, opts = {})
  create_user_variable_with_http_info(variablename, opts)
  nil
end

#create_user_variable_with_http_info(variablename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create a user-level variable

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



99
100
101
102
103
104
105
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
147
148
149
150
 
# File 'lib/forgejo/api/user_api.rb', line 99

def create_user_variable_with_http_info(variablename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.create_user_variable ...'
  end
  # verify the required parameter 'variablename' is set
  if @api_client.config.client_side_validation && variablename.nil?
    fail ArgumentError, "Missing the required parameter 'variablename' when calling UserApi.create_user_variable"
  end
  # resource path
  local_var_path = '/user/actions/variables/{variablename}'.sub('{' + 'variablename' + '}', CGI.escape(variablename.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.create_user_variable",
    :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: UserApi#create_user_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_secret(secretname, opts = {}) ⇒ nil

Delete a secret in a user scope

Parameters:

  • secretname (String) —

    name of the secret

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

    the optional parameters

Returns:

  • (nil) 


156
157
158
159
 
# File 'lib/forgejo/api/user_api.rb', line 156

def delete_user_secret(secretname, opts = {})
  delete_user_secret_with_http_info(secretname, opts)
  nil
end

#delete_user_secret_with_http_info(secretname, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a secret in a user scope

Parameters:

  • secretname (String) —

    name of the secret

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
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
 
# File 'lib/forgejo/api/user_api.rb', line 165

def delete_user_secret_with_http_info(secretname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.delete_user_secret ...'
  end
  # verify the required parameter 'secretname' is set
  if @api_client.config.client_side_validation && secretname.nil?
    fail ArgumentError, "Missing the required parameter 'secretname' when calling UserApi.delete_user_secret"
  end
  # resource path
  local_var_path = '/user/actions/secrets/{secretname}'.sub('{' + 'secretname' + '}', CGI.escape(secretname.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.delete_user_secret",
    :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: UserApi#delete_user_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_variable(variablename, opts = {}) ⇒ nil

Delete a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Returns:

  • (nil) 


217
218
219
220
 
# File 'lib/forgejo/api/user_api.rb', line 217

def delete_user_variable(variablename, opts = {})
  delete_user_variable_with_http_info(variablename, opts)
  nil
end

#delete_user_variable_with_http_info(variablename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
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
 
# File 'lib/forgejo/api/user_api.rb', line 226

def delete_user_variable_with_http_info(variablename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.delete_user_variable ...'
  end
  # verify the required parameter 'variablename' is set
  if @api_client.config.client_side_validation && variablename.nil?
    fail ArgumentError, "Missing the required parameter 'variablename' when calling UserApi.delete_user_variable"
  end
  # resource path
  local_var_path = '/user/actions/variables/{variablename}'.sub('{' + 'variablename' + '}', CGI.escape(variablename.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.delete_user_variable",
    :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: UserApi#delete_user_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_settings(opts = {}) ⇒ UserSettings

Get user settings

Parameters:

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/forgejo/api/user_api.rb', line 277

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

#get_user_settings_with_http_info(opts = {}) ⇒ Array<(UserSettings, Integer, Hash)>

Get user settings

Parameters:

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

    the optional parameters

Returns:

  • (Array<(UserSettings, Integer, Hash)>) —

    UserSettings data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/forgejo/api/user_api.rb', line 285

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UserSettings'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.get_user_settings",
    :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: UserApi#get_user_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_variable(variablename, opts = {}) ⇒ ActionVariable

Get a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Returns:



333
334
335
336
 
# File 'lib/forgejo/api/user_api.rb', line 333

def get_user_variable(variablename, opts = {})
  data, _status_code, _headers = get_user_variable_with_http_info(variablename, opts)
  data
end

#get_user_variable_with_http_info(variablename, opts = {}) ⇒ Array<(ActionVariable, Integer, Hash)>

Get a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Returns:

  • (Array<(ActionVariable, Integer, Hash)>) —

    ActionVariable data, response status code and response headers



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/forgejo/api/user_api.rb', line 342

def get_user_variable_with_http_info(variablename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.get_user_variable ...'
  end
  # verify the required parameter 'variablename' is set
  if @api_client.config.client_side_validation && variablename.nil?
    fail ArgumentError, "Missing the required parameter 'variablename' when calling UserApi.get_user_variable"
  end
  # resource path
  local_var_path = '/user/actions/variables/{variablename}'.sub('{' + 'variablename' + '}', CGI.escape(variablename.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ActionVariable'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.get_user_variable",
    :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: UserApi#get_user_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_variables_list(opts = {}) ⇒ Array<ActionVariable>

Get the user-level list of variables which is created by current doer

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



395
396
397
398
 
# File 'lib/forgejo/api/user_api.rb', line 395

def get_user_variables_list(opts = {})
  data, _status_code, _headers = get_user_variables_list_with_http_info(opts)
  data
end

#get_user_variables_list_with_http_info(opts = {}) ⇒ Array<(Array<ActionVariable>, Integer, Hash)>

Get the user-level list of variables which is created by current doer

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<ActionVariable>, Integer, Hash)>) —

    Array<ActionVariable> data, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/forgejo/api/user_api.rb', line 405

def get_user_variables_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.get_user_variables_list ...'
  end
  # resource path
  local_var_path = '/user/actions/variables'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ActionVariable>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.get_user_variables_list",
    :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: UserApi#get_user_variables_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_verification_token(opts = {}) ⇒ String

Get a Token to verify

Parameters:

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

    the optional parameters

Returns:

  • (String) 


454
455
456
457
 
# File 'lib/forgejo/api/user_api.rb', line 454

def get_verification_token(opts = {})
  data, _status_code, _headers = get_verification_token_with_http_info(opts)
  data
end

#get_verification_token_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Get a Token to verify

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/forgejo/api/user_api.rb', line 462

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

  # 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(['text/plain']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.get_verification_token",
    :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: UserApi#get_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_secret(secretname, opts = {}) ⇒ nil

Create or Update a secret value in a user scope

Parameters:

  • secretname (String) —

    name of the secret

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


511
512
513
514
 
# File 'lib/forgejo/api/user_api.rb', line 511

def update_user_secret(secretname, opts = {})
  update_user_secret_with_http_info(secretname, opts)
  nil
end

#update_user_secret_with_http_info(secretname, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create or Update a secret value in a user scope

Parameters:

  • secretname (String) —

    name of the secret

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/forgejo/api/user_api.rb', line 521

def update_user_secret_with_http_info(secretname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.update_user_secret ...'
  end
  # verify the required parameter 'secretname' is set
  if @api_client.config.client_side_validation && secretname.nil?
    fail ArgumentError, "Missing the required parameter 'secretname' when calling UserApi.update_user_secret"
  end
  # resource path
  local_var_path = '/user/actions/secrets/{secretname}'.sub('{' + 'secretname' + '}', CGI.escape(secretname.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.update_user_secret",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_settings(opts = {}) ⇒ UserSettings

Update user settings

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



578
579
580
581
 
# File 'lib/forgejo/api/user_api.rb', line 578

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

#update_user_settings_with_http_info(opts = {}) ⇒ Array<(UserSettings, Integer, Hash)>

Update user settings

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UserSettings, Integer, Hash)>) —

    UserSettings data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/forgejo/api/user_api.rb', line 587

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UserSettings'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.update_user_settings",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_variable(variablename, opts = {}) ⇒ nil

Update a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


641
642
643
644
 
# File 'lib/forgejo/api/user_api.rb', line 641

def update_user_variable(variablename, opts = {})
  update_user_variable_with_http_info(variablename, opts)
  nil
end

#update_user_variable_with_http_info(variablename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a user-level variable which is created by current doer

Parameters:

  • variablename (String) —

    name of the variable

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/forgejo/api/user_api.rb', line 651

def update_user_variable_with_http_info(variablename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.update_user_variable ...'
  end
  # verify the required parameter 'variablename' is set
  if @api_client.config.client_side_validation && variablename.nil?
    fail ArgumentError, "Missing the required parameter 'variablename' when calling UserApi.update_user_variable"
  end
  # resource path
  local_var_path = '/user/actions/variables/{variablename}'.sub('{' + 'variablename' + '}', CGI.escape(variablename.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.update_user_variable",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_add_email(opts = {}) ⇒ Array<Email>

Add email addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



708
709
710
711
 
# File 'lib/forgejo/api/user_api.rb', line 708

def user_add_email(opts = {})
  data, _status_code, _headers = user_add_email_with_http_info(opts)
  data
end

#user_add_email_with_http_info(opts = {}) ⇒ Array<(Array<Email>, Integer, Hash)>

Add email addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<Email>, Integer, Hash)>) —

    Array<Email> data, response status code and response headers



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/forgejo/api/user_api.rb', line 717

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Email>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_add_email",
    :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: UserApi#user_add_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_block_user(username, opts = {}) ⇒ nil

Blocks a user from the doer.

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Returns:

  • (nil) 


770
771
772
773
 
# File 'lib/forgejo/api/user_api.rb', line 770

def user_block_user(username, opts = {})
  user_block_user_with_http_info(username, opts)
  nil
end

#user_block_user_with_http_info(username, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Blocks a user from the doer.

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/forgejo/api/user_api.rb', line 779

def user_block_user_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_block_user ...'
  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 UserApi.user_block_user"
  end
  # resource path
  local_var_path = '/user/block/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_block_user",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_block_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_check_following(username, target, opts = {}) ⇒ nil

Check if one user is following another user

Parameters:

  • username (String) —

    username of following user

  • target (String) —

    username of followed user

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

    the optional parameters

Returns:

  • (nil) 


832
833
834
835
 
# File 'lib/forgejo/api/user_api.rb', line 832

def user_check_following(username, target, opts = {})
  user_check_following_with_http_info(username, target, opts)
  nil
end

#user_check_following_with_http_info(username, target, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Check if one user is following another user

Parameters:

  • username (String) —

    username of following user

  • target (String) —

    username of followed user

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/forgejo/api/user_api.rb', line 842

def user_check_following_with_http_info(username, target, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_check_following ...'
  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 UserApi.user_check_following"
  end
  # verify the required parameter 'target' is set
  if @api_client.config.client_side_validation && target.nil?
    fail ArgumentError, "Missing the required parameter 'target' when calling UserApi.user_check_following"
  end
  # resource path
  local_var_path = '/users/{username}/following/{target}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'target' + '}', CGI.escape(target.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_check_following",
    :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: UserApi#user_check_following\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_check_quota(opts = {}) ⇒ nil

Check if the authenticated user is over quota for a given subject

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


897
898
899
900
 
# File 'lib/forgejo/api/user_api.rb', line 897

def user_check_quota(opts = {})
  user_check_quota_with_http_info(opts)
  nil
end

#user_check_quota_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Check if the authenticated user is over quota for a given subject

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/forgejo/api/user_api.rb', line 905

def user_check_quota_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_check_quota ...'
  end
  # resource path
  local_var_path = '/user/quota/check'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_check_quota",
    :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: UserApi#user_check_quota\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_create_hook(body, opts = {}) ⇒ Hook

Create a hook

Parameters:

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

    the optional parameters

Returns:



953
954
955
956
 
# File 'lib/forgejo/api/user_api.rb', line 953

def user_create_hook(body, opts = {})
  data, _status_code, _headers = user_create_hook_with_http_info(body, opts)
  data
end

#user_create_hook_with_http_info(body, opts = {}) ⇒ Array<(Hook, Integer, Hash)>

Create a hook

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Hook, Integer, Hash)>) —

    Hook data, response status code and response headers



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/forgejo/api/user_api.rb', line 962

def user_create_hook_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_create_hook ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling UserApi.user_create_hook"
  end
  # resource path
  local_var_path = '/user/hooks'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_create_hook",
    :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: UserApi#user_create_hook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_create_o_auth2_application(body, opts = {}) ⇒ OAuth2Application

creates a new OAuth2 application

Parameters:

Returns:



1019
1020
1021
1022
 
# File 'lib/forgejo/api/user_api.rb', line 1019

def user_create_o_auth2_application(body, opts = {})
  data, _status_code, _headers = user_create_o_auth2_application_with_http_info(body, opts)
  data
end

#user_create_o_auth2_application_with_http_info(body, opts = {}) ⇒ Array<(OAuth2Application, Integer, Hash)>

creates a new OAuth2 application

Parameters:

Returns:

  • (Array<(OAuth2Application, Integer, Hash)>) —

    OAuth2Application data, response status code and response headers



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/forgejo/api/user_api.rb', line 1028

def user_create_o_auth2_application_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_create_o_auth2_application ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling UserApi.user_create_o_auth2_application"
  end
  # resource path
  local_var_path = '/user/applications/oauth2'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Application'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_create_o_auth2_application",
    :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: UserApi#user_create_o_auth2_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_create_token(username, opts = {}) ⇒ AccessToken

Create an access token

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

Returns:



1086
1087
1088
1089
 
# File 'lib/forgejo/api/user_api.rb', line 1086

def user_create_token(username, opts = {})
  data, _status_code, _headers = user_create_token_with_http_info(username, opts)
  data
end

#user_create_token_with_http_info(username, opts = {}) ⇒ Array<(AccessToken, Integer, Hash)>

Create an access token

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(AccessToken, Integer, Hash)>) —

    AccessToken data, response status code and response headers



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/forgejo/api/user_api.rb', line 1096

def user_create_token_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_create_token ...'
  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 UserApi.user_create_token"
  end
  # resource path
  local_var_path = '/users/{username}/tokens'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'AccessToken'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_create_token",
    :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: UserApi#user_create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_check_following(username, opts = {}) ⇒ nil

Check whether a user is followed by the authenticated user

Parameters:

  • username (String) —

    username of followed user

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

    the optional parameters

Returns:

  • (nil) 


1153
1154
1155
1156
 
# File 'lib/forgejo/api/user_api.rb', line 1153

def user_current_check_following(username, opts = {})
  user_current_check_following_with_http_info(username, opts)
  nil
end

#user_current_check_following_with_http_info(username, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Check whether a user is followed by the authenticated user

Parameters:

  • username (String) —

    username of followed user

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/forgejo/api/user_api.rb', line 1162

def user_current_check_following_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_check_following ...'
  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 UserApi.user_current_check_following"
  end
  # resource path
  local_var_path = '/user/following/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_check_following",
    :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: UserApi#user_current_check_following\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_check_starring(owner, repo, opts = {}) ⇒ nil

Whether the authenticated is starring the repo

Parameters:

  • owner (String) —

    owner of the repo

  • repo (String) —

    name of the repo

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

    the optional parameters

Returns:

  • (nil) 


1215
1216
1217
1218
 
# File 'lib/forgejo/api/user_api.rb', line 1215

def user_current_check_starring(owner, repo, opts = {})
  user_current_check_starring_with_http_info(owner, repo, opts)
  nil
end

#user_current_check_starring_with_http_info(owner, repo, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Whether the authenticated is starring the repo

Parameters:

  • owner (String) —

    owner of the repo

  • repo (String) —

    name of the repo

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/forgejo/api/user_api.rb', line 1225

def user_current_check_starring_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_check_starring ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling UserApi.user_current_check_starring"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling UserApi.user_current_check_starring"
  end
  # resource path
  local_var_path = '/user/starred/{owner}/{repo}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_check_starring",
    :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: UserApi#user_current_check_starring\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_delete_follow(username, opts = {}) ⇒ nil

Unfollow a user

Parameters:

  • username (String) —

    username of user to unfollow

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

    the optional parameters

Returns:

  • (nil) 


1281
1282
1283
1284
 
# File 'lib/forgejo/api/user_api.rb', line 1281

def user_current_delete_follow(username, opts = {})
  user_current_delete_follow_with_http_info(username, opts)
  nil
end

#user_current_delete_follow_with_http_info(username, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unfollow a user

Parameters:

  • username (String) —

    username of user to unfollow

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/forgejo/api/user_api.rb', line 1290

def user_current_delete_follow_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_delete_follow ...'
  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 UserApi.user_current_delete_follow"
  end
  # resource path
  local_var_path = '/user/following/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_delete_follow",
    :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: UserApi#user_current_delete_follow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_delete_gpg_key(id, opts = {}) ⇒ nil

Remove a GPG key

Parameters:

  • id (Integer) —

    id of key to delete

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

    the optional parameters

Returns:

  • (nil) 


1342
1343
1344
1345
 
# File 'lib/forgejo/api/user_api.rb', line 1342

def user_current_delete_gpg_key(id, opts = {})
  user_current_delete_gpg_key_with_http_info(id, opts)
  nil
end

#user_current_delete_gpg_key_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a GPG key

Parameters:

  • id (Integer) —

    id of key to delete

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/forgejo/api/user_api.rb', line 1351

def user_current_delete_gpg_key_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_delete_gpg_key ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_current_delete_gpg_key"
  end
  # resource path
  local_var_path = '/user/gpg_keys/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_delete_gpg_key",
    :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: UserApi#user_current_delete_gpg_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_delete_key(id, opts = {}) ⇒ nil

Delete a public key

Parameters:

  • id (Integer) —

    id of key to delete

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

    the optional parameters

Returns:

  • (nil) 


1403
1404
1405
1406
 
# File 'lib/forgejo/api/user_api.rb', line 1403

def user_current_delete_key(id, opts = {})
  user_current_delete_key_with_http_info(id, opts)
  nil
end

#user_current_delete_key_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a public key

Parameters:

  • id (Integer) —

    id of key to delete

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/forgejo/api/user_api.rb', line 1412

def user_current_delete_key_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_delete_key ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_current_delete_key"
  end
  # resource path
  local_var_path = '/user/keys/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_delete_key",
    :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: UserApi#user_current_delete_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_delete_star(owner, repo, opts = {}) ⇒ nil

Unstar the given repo

Parameters:

  • owner (String) —

    owner of the repo to unstar

  • repo (String) —

    name of the repo to unstar

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

    the optional parameters

Returns:

  • (nil) 


1465
1466
1467
1468
 
# File 'lib/forgejo/api/user_api.rb', line 1465

def user_current_delete_star(owner, repo, opts = {})
  user_current_delete_star_with_http_info(owner, repo, opts)
  nil
end

#user_current_delete_star_with_http_info(owner, repo, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unstar the given repo

Parameters:

  • owner (String) —

    owner of the repo to unstar

  • repo (String) —

    name of the repo to unstar

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/forgejo/api/user_api.rb', line 1475

def user_current_delete_star_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_delete_star ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling UserApi.user_current_delete_star"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling UserApi.user_current_delete_star"
  end
  # resource path
  local_var_path = '/user/starred/{owner}/{repo}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_delete_star",
    :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: UserApi#user_current_delete_star\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_get_gpg_key(id, opts = {}) ⇒ GPGKey

Get a GPG key

Parameters:

  • id (Integer) —

    id of key to get

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

    the optional parameters

Returns:



1531
1532
1533
1534
 
# File 'lib/forgejo/api/user_api.rb', line 1531

def user_current_get_gpg_key(id, opts = {})
  data, _status_code, _headers = user_current_get_gpg_key_with_http_info(id, opts)
  data
end

#user_current_get_gpg_key_with_http_info(id, opts = {}) ⇒ Array<(GPGKey, Integer, Hash)>

Get a GPG key

Parameters:

  • id (Integer) —

    id of key to get

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

    the optional parameters

Returns:

  • (Array<(GPGKey, Integer, Hash)>) —

    GPGKey data, response status code and response headers



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/forgejo/api/user_api.rb', line 1540

def user_current_get_gpg_key_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_get_gpg_key ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_current_get_gpg_key"
  end
  # resource path
  local_var_path = '/user/gpg_keys/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GPGKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_get_gpg_key",
    :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: UserApi#user_current_get_gpg_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_get_key(id, opts = {}) ⇒ PublicKey

Get a public key

Parameters:

  • id (Integer) —

    id of key to get

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

    the optional parameters

Returns:



1592
1593
1594
1595
 
# File 'lib/forgejo/api/user_api.rb', line 1592

def user_current_get_key(id, opts = {})
  data, _status_code, _headers = user_current_get_key_with_http_info(id, opts)
  data
end

#user_current_get_key_with_http_info(id, opts = {}) ⇒ Array<(PublicKey, Integer, Hash)>

Get a public key

Parameters:

  • id (Integer) —

    id of key to get

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

    the optional parameters

Returns:

  • (Array<(PublicKey, Integer, Hash)>) —

    PublicKey data, response status code and response headers



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'lib/forgejo/api/user_api.rb', line 1601

def user_current_get_key_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_get_key ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_current_get_key"
  end
  # resource path
  local_var_path = '/user/keys/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_get_key",
    :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: UserApi#user_current_get_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_followers(opts = {}) ⇒ Array<User>

List the authenticated user’s followers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



1654
1655
1656
1657
 
# File 'lib/forgejo/api/user_api.rb', line 1654

def user_current_list_followers(opts = {})
  data, _status_code, _headers = user_current_list_followers_with_http_info(opts)
  data
end

#user_current_list_followers_with_http_info(opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

List the authenticated user&#39;s followers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<User>, Integer, Hash)>) —

    Array<User> data, response status code and response headers



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/forgejo/api/user_api.rb', line 1664

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<User>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_followers",
    :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: UserApi#user_current_list_followers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_following(opts = {}) ⇒ Array<User>

List the users that the authenticated user is following

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



1715
1716
1717
1718
 
# File 'lib/forgejo/api/user_api.rb', line 1715

def user_current_list_following(opts = {})
  data, _status_code, _headers = user_current_list_following_with_http_info(opts)
  data
end

#user_current_list_following_with_http_info(opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

List the users that the authenticated user is following

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<User>, Integer, Hash)>) —

    Array<User> data, response status code and response headers



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/forgejo/api/user_api.rb', line 1725

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<User>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_following",
    :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: UserApi#user_current_list_following\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_gpg_keys(opts = {}) ⇒ Array<GPGKey>

List the authenticated user’s GPG keys

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



1776
1777
1778
1779
 
# File 'lib/forgejo/api/user_api.rb', line 1776

def user_current_list_gpg_keys(opts = {})
  data, _status_code, _headers = user_current_list_gpg_keys_with_http_info(opts)
  data
end

#user_current_list_gpg_keys_with_http_info(opts = {}) ⇒ Array<(Array<GPGKey>, Integer, Hash)>

List the authenticated user&#39;s GPG keys

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<GPGKey>, Integer, Hash)>) —

    Array<GPGKey> data, response status code and response headers



1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'lib/forgejo/api/user_api.rb', line 1786

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GPGKey>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_gpg_keys",
    :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: UserApi#user_current_list_gpg_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_keys(opts = {}) ⇒ Array<PublicKey>

List the authenticated user’s public keys

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fingerprint (String) —

    fingerprint of the key

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



1838
1839
1840
1841
 
# File 'lib/forgejo/api/user_api.rb', line 1838

def user_current_list_keys(opts = {})
  data, _status_code, _headers = user_current_list_keys_with_http_info(opts)
  data
end

#user_current_list_keys_with_http_info(opts = {}) ⇒ Array<(Array<PublicKey>, Integer, Hash)>

List the authenticated user&#39;s public keys

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fingerprint (String) —

    fingerprint of the key

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<PublicKey>, Integer, Hash)>) —

    Array<PublicKey> data, response status code and response headers



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/forgejo/api/user_api.rb', line 1849

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PublicKey>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_keys",
    :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: UserApi#user_current_list_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_repos(opts = {}) ⇒ Array<Repository>

List the repos that the authenticated user owns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

  • :order_by (String) —

    order the repositories by name (default), id, or size

Returns:



1902
1903
1904
1905
 
# File 'lib/forgejo/api/user_api.rb', line 1902

def user_current_list_repos(opts = {})
  data, _status_code, _headers = user_current_list_repos_with_http_info(opts)
  data
end

#user_current_list_repos_with_http_info(opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

List the repos that the authenticated user owns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

  • :order_by (String) —

    order the repositories by name (default), id, or size

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/forgejo/api/user_api.rb', line 1913

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_repos",
    :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: UserApi#user_current_list_repos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_starred(opts = {}) ⇒ Array<Repository>

The repos that the authenticated user has starred

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



1965
1966
1967
1968
 
# File 'lib/forgejo/api/user_api.rb', line 1965

def user_current_list_starred(opts = {})
  data, _status_code, _headers = user_current_list_starred_with_http_info(opts)
  data
end

#user_current_list_starred_with_http_info(opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

The repos that the authenticated user has starred

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/forgejo/api/user_api.rb', line 1975

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_starred",
    :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: UserApi#user_current_list_starred\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_list_subscriptions(opts = {}) ⇒ Array<Repository>

List repositories watched by the authenticated user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



2026
2027
2028
2029
 
# File 'lib/forgejo/api/user_api.rb', line 2026

def user_current_list_subscriptions(opts = {})
  data, _status_code, _headers = user_current_list_subscriptions_with_http_info(opts)
  data
end

#user_current_list_subscriptions_with_http_info(opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

List repositories watched by the authenticated user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/forgejo/api/user_api.rb', line 2036

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_list_subscriptions",
    :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: UserApi#user_current_list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_post_gpg_key(opts = {}) ⇒ GPGKey

Create a GPG key

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2086
2087
2088
2089
 
# File 'lib/forgejo/api/user_api.rb', line 2086

def user_current_post_gpg_key(opts = {})
  data, _status_code, _headers = user_current_post_gpg_key_with_http_info(opts)
  data
end

#user_current_post_gpg_key_with_http_info(opts = {}) ⇒ Array<(GPGKey, Integer, Hash)>

Create a GPG key

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GPGKey, Integer, Hash)>) —

    GPGKey data, response status code and response headers



2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/forgejo/api/user_api.rb', line 2095

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GPGKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_post_gpg_key",
    :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: UserApi#user_current_post_gpg_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_post_key(opts = {}) ⇒ PublicKey

Create a public key

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2148
2149
2150
2151
 
# File 'lib/forgejo/api/user_api.rb', line 2148

def user_current_post_key(opts = {})
  data, _status_code, _headers = user_current_post_key_with_http_info(opts)
  data
end

#user_current_post_key_with_http_info(opts = {}) ⇒ Array<(PublicKey, Integer, Hash)>

Create a public key

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PublicKey, Integer, Hash)>) —

    PublicKey data, response status code and response headers



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/forgejo/api/user_api.rb', line 2157

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_post_key",
    :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: UserApi#user_current_post_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_put_follow(username, opts = {}) ⇒ nil

Follow a user

Parameters:

  • username (String) —

    username of user to follow

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

    the optional parameters

Returns:

  • (nil) 


2210
2211
2212
2213
 
# File 'lib/forgejo/api/user_api.rb', line 2210

def user_current_put_follow(username, opts = {})
  user_current_put_follow_with_http_info(username, opts)
  nil
end

#user_current_put_follow_with_http_info(username, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Follow a user

Parameters:

  • username (String) —

    username of user to follow

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/forgejo/api/user_api.rb', line 2219

def user_current_put_follow_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_put_follow ...'
  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 UserApi.user_current_put_follow"
  end
  # resource path
  local_var_path = '/user/following/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_put_follow",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_current_put_follow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_put_star(owner, repo, opts = {}) ⇒ nil

Star the given repo

Parameters:

  • owner (String) —

    owner of the repo to star

  • repo (String) —

    name of the repo to star

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

    the optional parameters

Returns:

  • (nil) 


2272
2273
2274
2275
 
# File 'lib/forgejo/api/user_api.rb', line 2272

def user_current_put_star(owner, repo, opts = {})
  user_current_put_star_with_http_info(owner, repo, opts)
  nil
end

#user_current_put_star_with_http_info(owner, repo, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Star the given repo

Parameters:

  • owner (String) —

    owner of the repo to star

  • repo (String) —

    name of the repo to star

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/forgejo/api/user_api.rb', line 2282

def user_current_put_star_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_current_put_star ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling UserApi.user_current_put_star"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling UserApi.user_current_put_star"
  end
  # resource path
  local_var_path = '/user/starred/{owner}/{repo}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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', 'text/html']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_put_star",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_current_put_star\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_current_tracked_times(opts = {}) ⇒ Array<TrackedTime>

List the current user’s tracked times

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

  • :since (Time) —

    Only show times updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time) —

    Only show times updated before the given time. This is a timestamp in RFC 3339 format

Returns:



2341
2342
2343
2344
 
# File 'lib/forgejo/api/user_api.rb', line 2341

def user_current_tracked_times(opts = {})
  data, _status_code, _headers = user_current_tracked_times_with_http_info(opts)
  data
end

#user_current_tracked_times_with_http_info(opts = {}) ⇒ Array<(Array<TrackedTime>, Integer, Hash)>

List the current user&#39;s tracked times

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

  • :since (Time) —

    Only show times updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time) —

    Only show times updated before the given time. This is a timestamp in RFC 3339 format

Returns:

  • (Array<(Array<TrackedTime>, Integer, Hash)>) —

    Array<TrackedTime> data, response status code and response headers



2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
 
# File 'lib/forgejo/api/user_api.rb', line 2353

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TrackedTime>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_current_tracked_times",
    :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: UserApi#user_current_tracked_times\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_delete_access_token(username, token, opts = {}) ⇒ nil

delete an access token

Parameters:

  • username (String) —

    username of user

  • token (String) —

    token to be deleted, identified by ID and if not available by name

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

    the optional parameters

Returns:

  • (nil) 


2406
2407
2408
2409
 
# File 'lib/forgejo/api/user_api.rb', line 2406

def user_delete_access_token(username, token, opts = {})
  user_delete_access_token_with_http_info(username, token, opts)
  nil
end

#user_delete_access_token_with_http_info(username, token, opts = {}) ⇒ Array<(nil, Integer, Hash)>

delete an access token

Parameters:

  • username (String) —

    username of user

  • token (String) —

    token to be deleted, identified by ID and if not available by name

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
 
# File 'lib/forgejo/api/user_api.rb', line 2416

def user_delete_access_token_with_http_info(username, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_delete_access_token ...'
  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 UserApi.user_delete_access_token"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling UserApi.user_delete_access_token"
  end
  # resource path
  local_var_path = '/users/{username}/tokens/{token}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_delete_access_token",
    :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: UserApi#user_delete_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_delete_avatar(opts = {}) ⇒ nil

Delete Avatar

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2471
2472
2473
2474
 
# File 'lib/forgejo/api/user_api.rb', line 2471

def user_delete_avatar(opts = {})
  user_delete_avatar_with_http_info(opts)
  nil
end

#user_delete_avatar_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Avatar

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
 
# File 'lib/forgejo/api/user_api.rb', line 2479

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_delete_avatar",
    :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: UserApi#user_delete_avatar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_delete_email(opts = {}) ⇒ nil

Delete email addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2527
2528
2529
2530
 
# File 'lib/forgejo/api/user_api.rb', line 2527

def user_delete_email(opts = {})
  user_delete_email_with_http_info(opts)
  nil
end

#user_delete_email_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete email addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'lib/forgejo/api/user_api.rb', line 2536

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_delete_email",
    :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: UserApi#user_delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_delete_hook(id, opts = {}) ⇒ nil

Delete a hook

Parameters:

  • id (Integer) —

    id of the hook to delete

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

    the optional parameters

Returns:

  • (nil) 


2589
2590
2591
2592
 
# File 'lib/forgejo/api/user_api.rb', line 2589

def user_delete_hook(id, opts = {})
  user_delete_hook_with_http_info(id, opts)
  nil
end

#user_delete_hook_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a hook

Parameters:

  • id (Integer) —

    id of the hook to delete

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'lib/forgejo/api/user_api.rb', line 2598

def user_delete_hook_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_delete_hook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_delete_hook"
  end
  # resource path
  local_var_path = '/user/hooks/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_delete_hook",
    :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: UserApi#user_delete_hook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_delete_o_auth2_application(id, opts = {}) ⇒ nil

delete an OAuth2 Application

Parameters:

  • id (Integer) —

    token to be deleted

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

    the optional parameters

Returns:

  • (nil) 


2650
2651
2652
2653
 
# File 'lib/forgejo/api/user_api.rb', line 2650

def user_delete_o_auth2_application(id, opts = {})
  user_delete_o_auth2_application_with_http_info(id, opts)
  nil
end

#user_delete_o_auth2_application_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

delete an OAuth2 Application

Parameters:

  • id (Integer) —

    token to be deleted

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
 
# File 'lib/forgejo/api/user_api.rb', line 2659

def user_delete_o_auth2_application_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_delete_o_auth2_application ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_delete_o_auth2_application"
  end
  # resource path
  local_var_path = '/user/applications/oauth2/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_delete_o_auth2_application",
    :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: UserApi#user_delete_o_auth2_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_edit_hook(id, opts = {}) ⇒ Hook

Update a hook

Parameters:

  • id (Integer) —

    id of the hook to update

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

    the optional parameters

Options Hash (opts):

Returns:



2712
2713
2714
2715
 
# File 'lib/forgejo/api/user_api.rb', line 2712

def user_edit_hook(id, opts = {})
  data, _status_code, _headers = user_edit_hook_with_http_info(id, opts)
  data
end

#user_edit_hook_with_http_info(id, opts = {}) ⇒ Array<(Hook, Integer, Hash)>

Update a hook

Parameters:

  • id (Integer) —

    id of the hook to update

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hook, Integer, Hash)>) —

    Hook data, response status code and response headers



2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
 
# File 'lib/forgejo/api/user_api.rb', line 2722

def user_edit_hook_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_edit_hook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_edit_hook"
  end
  # resource path
  local_var_path = '/user/hooks/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_edit_hook",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_edit_hook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get(username, opts = {}) ⇒ User

Get a user

Parameters:

  • username (String) —

    username of user to get

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

    the optional parameters

Returns:



2779
2780
2781
2782
 
# File 'lib/forgejo/api/user_api.rb', line 2779

def user_get(username, opts = {})
  data, _status_code, _headers = user_get_with_http_info(username, opts)
  data
end

#user_get_current(opts = {}) ⇒ User

Get the authenticated user

Parameters:

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

    the optional parameters

Returns:



2839
2840
2841
2842
 
# File 'lib/forgejo/api/user_api.rb', line 2839

def user_get_current(opts = {})
  data, _status_code, _headers = user_get_current_with_http_info(opts)
  data
end

#user_get_current_with_http_info(opts = {}) ⇒ Array<(User, Integer, Hash)>

Get the authenticated user

Parameters:

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

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
 
# File 'lib/forgejo/api/user_api.rb', line 2847

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'User'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_current",
    :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: UserApi#user_get_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_heatmap_data(username, opts = {}) ⇒ Array<UserHeatmapData>

Get a user’s heatmap

Parameters:

  • username (String) —

    username of user to get

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

    the optional parameters

Returns:



2895
2896
2897
2898
 
# File 'lib/forgejo/api/user_api.rb', line 2895

def user_get_heatmap_data(username, opts = {})
  data, _status_code, _headers = user_get_heatmap_data_with_http_info(username, opts)
  data
end

#user_get_heatmap_data_with_http_info(username, opts = {}) ⇒ Array<(Array<UserHeatmapData>, Integer, Hash)>

Get a user&#39;s heatmap

Parameters:

  • username (String) —

    username of user to get

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

    the optional parameters

Returns:

  • (Array<(Array<UserHeatmapData>, Integer, Hash)>) —

    Array<UserHeatmapData> data, response status code and response headers



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/forgejo/api/user_api.rb', line 2904

def user_get_heatmap_data_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_heatmap_data ...'
  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 UserApi.user_get_heatmap_data"
  end
  # resource path
  local_var_path = '/users/{username}/heatmap'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<UserHeatmapData>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_heatmap_data",
    :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: UserApi#user_get_heatmap_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_hook(id, opts = {}) ⇒ Hook

Get a hook

Parameters:

  • id (Integer) —

    id of the hook to get

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

    the optional parameters

Returns:



2956
2957
2958
2959
 
# File 'lib/forgejo/api/user_api.rb', line 2956

def user_get_hook(id, opts = {})
  data, _status_code, _headers = user_get_hook_with_http_info(id, opts)
  data
end

#user_get_hook_with_http_info(id, opts = {}) ⇒ Array<(Hook, Integer, Hash)>

Get a hook

Parameters:

  • id (Integer) —

    id of the hook to get

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

    the optional parameters

Returns:

  • (Array<(Hook, Integer, Hash)>) —

    Hook data, response status code and response headers



2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
 
# File 'lib/forgejo/api/user_api.rb', line 2965

def user_get_hook_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_hook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_get_hook"
  end
  # resource path
  local_var_path = '/user/hooks/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_hook",
    :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: UserApi#user_get_hook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_o_auth2_application(id, opts = {}) ⇒ OAuth2Application

get an OAuth2 Application

Parameters:

  • id (Integer) —

    Application ID to be found

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

    the optional parameters

Returns:



3017
3018
3019
3020
 
# File 'lib/forgejo/api/user_api.rb', line 3017

def user_get_o_auth2_application(id, opts = {})
  data, _status_code, _headers = user_get_o_auth2_application_with_http_info(id, opts)
  data
end

#user_get_o_auth2_application_with_http_info(id, opts = {}) ⇒ Array<(OAuth2Application, Integer, Hash)>

get an OAuth2 Application

Parameters:

  • id (Integer) —

    Application ID to be found

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

    the optional parameters

Returns:

  • (Array<(OAuth2Application, Integer, Hash)>) —

    OAuth2Application data, response status code and response headers



3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
 
# File 'lib/forgejo/api/user_api.rb', line 3026

def user_get_o_auth2_application_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_o_auth2_application ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_get_o_auth2_application"
  end
  # resource path
  local_var_path = '/user/applications/oauth2/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Application'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_o_auth2_application",
    :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: UserApi#user_get_o_auth2_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_o_auth2_applications(opts = {}) ⇒ Array<OAuth2Application>

List the authenticated user’s oauth2 applications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3079
3080
3081
3082
 
# File 'lib/forgejo/api/user_api.rb', line 3079

def user_get_o_auth2_applications(opts = {})
  data, _status_code, _headers = user_get_o_auth2_applications_with_http_info(opts)
  data
end

#user_get_o_auth2_applications_with_http_info(opts = {}) ⇒ Array<(Array<OAuth2Application>, Integer, Hash)>

List the authenticated user&#39;s oauth2 applications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<OAuth2Application>, Integer, Hash)>) —

    Array<OAuth2Application> data, response status code and response headers



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
 
# File 'lib/forgejo/api/user_api.rb', line 3089

def user_get_o_auth2_applications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_o_auth2_applications ...'
  end
  # resource path
  local_var_path = '/user/applications/oauth2'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<OAuth2Application>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_o_auth2_applications",
    :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: UserApi#user_get_o_auth2_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_quota(opts = {}) ⇒ QuotaInfo

Get quota information for the authenticated user

Parameters:

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

    the optional parameters

Returns:



3138
3139
3140
3141
 
# File 'lib/forgejo/api/user_api.rb', line 3138

def user_get_quota(opts = {})
  data, _status_code, _headers = user_get_quota_with_http_info(opts)
  data
end

#user_get_quota_with_http_info(opts = {}) ⇒ Array<(QuotaInfo, Integer, Hash)>

Get quota information for the authenticated user

Parameters:

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

    the optional parameters

Returns:

  • (Array<(QuotaInfo, Integer, Hash)>) —

    QuotaInfo data, response status code and response headers



3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
 
# File 'lib/forgejo/api/user_api.rb', line 3146

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'QuotaInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_quota",
    :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: UserApi#user_get_quota\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_runner_registration_token(opts = {}) ⇒ nil

Get an user’s actions runner registration token

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


3193
3194
3195
3196
 
# File 'lib/forgejo/api/user_api.rb', line 3193

def user_get_runner_registration_token(opts = {})
  user_get_runner_registration_token_with_http_info(opts)
  nil
end

#user_get_runner_registration_token_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get an user&#39;s actions runner registration token

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
 
# File 'lib/forgejo/api/user_api.rb', line 3201

def user_get_runner_registration_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_runner_registration_token ...'
  end
  # resource path
  local_var_path = '/user/actions/runners/registration-token'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_runner_registration_token",
    :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: UserApi#user_get_runner_registration_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_stop_watches(opts = {}) ⇒ Array<StopWatch>

Get list of all existing stopwatches

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3250
3251
3252
3253
 
# File 'lib/forgejo/api/user_api.rb', line 3250

def user_get_stop_watches(opts = {})
  data, _status_code, _headers = user_get_stop_watches_with_http_info(opts)
  data
end

#user_get_stop_watches_with_http_info(opts = {}) ⇒ Array<(Array<StopWatch>, Integer, Hash)>

Get list of all existing stopwatches

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<StopWatch>, Integer, Hash)>) —

    Array<StopWatch> data, response status code and response headers



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
 
# File 'lib/forgejo/api/user_api.rb', line 3260

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<StopWatch>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_stop_watches",
    :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: UserApi#user_get_stop_watches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_tokens(username, opts = {}) ⇒ Array<AccessToken>

List the authenticated user’s access tokens

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3312
3313
3314
3315
 
# File 'lib/forgejo/api/user_api.rb', line 3312

def user_get_tokens(username, opts = {})
  data, _status_code, _headers = user_get_tokens_with_http_info(username, opts)
  data
end

#user_get_tokens_with_http_info(username, opts = {}) ⇒ Array<(Array<AccessToken>, Integer, Hash)>

List the authenticated user&#39;s access tokens

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<AccessToken>, Integer, Hash)>) —

    Array<AccessToken> data, response status code and response headers



3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
 
# File 'lib/forgejo/api/user_api.rb', line 3323

def user_get_tokens_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_tokens ...'
  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 UserApi.user_get_tokens"
  end
  # resource path
  local_var_path = '/users/{username}/tokens'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AccessToken>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get_tokens",
    :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: UserApi#user_get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_with_http_info(username, opts = {}) ⇒ Array<(User, Integer, Hash)>

Get a user

Parameters:

  • username (String) —

    username of user to get

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

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
 
# File 'lib/forgejo/api/user_api.rb', line 2788

def user_get_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get ...'
  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 UserApi.user_get"
  end
  # resource path
  local_var_path = '/users/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'User'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_get",
    :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: UserApi#user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_activity_feeds(username, opts = {}) ⇒ Array<Activity>

List a user’s activity feeds

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :only_performed_by (Boolean) —

    if true, only show actions performed by the requested user

  • :date (Date) —

    the date of the activities to be found

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3381
3382
3383
3384
 
# File 'lib/forgejo/api/user_api.rb', line 3381

def user_list_activity_feeds(username, opts = {})
  data, _status_code, _headers = user_list_activity_feeds_with_http_info(username, opts)
  data
end

#user_list_activity_feeds_with_http_info(username, opts = {}) ⇒ Array<(Array<Activity>, Integer, Hash)>

List a user&#39;s activity feeds

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :only_performed_by (Boolean) —

    if true, only show actions performed by the requested user

  • :date (Date) —

    the date of the activities to be found

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Activity>, Integer, Hash)>) —

    Array<Activity> data, response status code and response headers



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/forgejo/api/user_api.rb', line 3394

def user_list_activity_feeds_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_activity_feeds ...'
  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 UserApi.user_list_activity_feeds"
  end
  # resource path
  local_var_path = '/users/{username}/activities/feeds'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'only-performed-by'] = opts[:'only_performed_by'] if !opts[:'only_performed_by'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Activity>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_activity_feeds",
    :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: UserApi#user_list_activity_feeds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_blocked_users(opts = {}) ⇒ Array<BlockedUser>

List the authenticated user’s blocked users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3451
3452
3453
3454
 
# File 'lib/forgejo/api/user_api.rb', line 3451

def user_list_blocked_users(opts = {})
  data, _status_code, _headers = user_list_blocked_users_with_http_info(opts)
  data
end

#user_list_blocked_users_with_http_info(opts = {}) ⇒ Array<(Array<BlockedUser>, Integer, Hash)>

List the authenticated user&#39;s blocked users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<BlockedUser>, Integer, Hash)>) —

    Array<BlockedUser> data, response status code and response headers



3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
 
# File 'lib/forgejo/api/user_api.rb', line 3461

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<BlockedUser>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_blocked_users",
    :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: UserApi#user_list_blocked_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_emails(opts = {}) ⇒ Array<Email>

List the authenticated user’s email addresses

Parameters:

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

    the optional parameters

Returns:



3510
3511
3512
3513
 
# File 'lib/forgejo/api/user_api.rb', line 3510

def user_list_emails(opts = {})
  data, _status_code, _headers = user_list_emails_with_http_info(opts)
  data
end

#user_list_emails_with_http_info(opts = {}) ⇒ Array<(Array<Email>, Integer, Hash)>

List the authenticated user&#39;s email addresses

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Email>, Integer, Hash)>) —

    Array<Email> data, response status code and response headers



3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
 
# File 'lib/forgejo/api/user_api.rb', line 3518

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Email>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_emails",
    :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: UserApi#user_list_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_followers(username, opts = {}) ⇒ Array<User>

List the given user’s followers

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3568
3569
3570
3571
 
# File 'lib/forgejo/api/user_api.rb', line 3568

def user_list_followers(username, opts = {})
  data, _status_code, _headers = user_list_followers_with_http_info(username, opts)
  data
end

#user_list_followers_with_http_info(username, opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

List the given user&#39;s followers

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<User>, Integer, Hash)>) —

    Array<User> data, response status code and response headers



3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/forgejo/api/user_api.rb', line 3579

def user_list_followers_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_followers ...'
  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 UserApi.user_list_followers"
  end
  # resource path
  local_var_path = '/users/{username}/followers'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<User>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_followers",
    :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: UserApi#user_list_followers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_following(username, opts = {}) ⇒ Array<User>

List the users that the given user is following

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3635
3636
3637
3638
 
# File 'lib/forgejo/api/user_api.rb', line 3635

def user_list_following(username, opts = {})
  data, _status_code, _headers = user_list_following_with_http_info(username, opts)
  data
end

#user_list_following_with_http_info(username, opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

List the users that the given user is following

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<User>, Integer, Hash)>) —

    Array<User> data, response status code and response headers



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
 
# File 'lib/forgejo/api/user_api.rb', line 3646

def user_list_following_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_following ...'
  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 UserApi.user_list_following"
  end
  # resource path
  local_var_path = '/users/{username}/following'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<User>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_following",
    :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: UserApi#user_list_following\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_gpg_keys(username, opts = {}) ⇒ Array<GPGKey>

List the given user’s GPG keys

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3702
3703
3704
3705
 
# File 'lib/forgejo/api/user_api.rb', line 3702

def user_list_gpg_keys(username, opts = {})
  data, _status_code, _headers = user_list_gpg_keys_with_http_info(username, opts)
  data
end

#user_list_gpg_keys_with_http_info(username, opts = {}) ⇒ Array<(Array<GPGKey>, Integer, Hash)>

List the given user&#39;s GPG keys

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<GPGKey>, Integer, Hash)>) —

    Array<GPGKey> data, response status code and response headers



3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/forgejo/api/user_api.rb', line 3713

def user_list_gpg_keys_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_gpg_keys ...'
  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 UserApi.user_list_gpg_keys"
  end
  # resource path
  local_var_path = '/users/{username}/gpg_keys'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GPGKey>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_gpg_keys",
    :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: UserApi#user_list_gpg_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_hooks(opts = {}) ⇒ Array<Hook>

List the authenticated user’s webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3768
3769
3770
3771
 
# File 'lib/forgejo/api/user_api.rb', line 3768

def user_list_hooks(opts = {})
  data, _status_code, _headers = user_list_hooks_with_http_info(opts)
  data
end

#user_list_hooks_with_http_info(opts = {}) ⇒ Array<(Array<Hook>, Integer, Hash)>

List the authenticated user&#39;s webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Hook>, Integer, Hash)>) —

    Array<Hook> data, response status code and response headers



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'lib/forgejo/api/user_api.rb', line 3778

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Hook>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_hooks",
    :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: UserApi#user_list_hooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_keys(username, opts = {}) ⇒ Array<PublicKey>

List the given user’s public keys

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :fingerprint (String) —

    fingerprint of the key

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3831
3832
3833
3834
 
# File 'lib/forgejo/api/user_api.rb', line 3831

def user_list_keys(username, opts = {})
  data, _status_code, _headers = user_list_keys_with_http_info(username, opts)
  data
end

#user_list_keys_with_http_info(username, opts = {}) ⇒ Array<(Array<PublicKey>, Integer, Hash)>

List the given user&#39;s public keys

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :fingerprint (String) —

    fingerprint of the key

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<PublicKey>, Integer, Hash)>) —

    Array<PublicKey> data, response status code and response headers



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
 
# File 'lib/forgejo/api/user_api.rb', line 3843

def user_list_keys_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_keys ...'
  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 UserApi.user_list_keys"
  end
  # resource path
  local_var_path = '/users/{username}/keys'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PublicKey>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_keys",
    :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: UserApi#user_list_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_quota_artifacts(opts = {}) ⇒ Array<QuotaUsedArtifact>

List the artifacts affecting the authenticated user’s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3899
3900
3901
3902
 
# File 'lib/forgejo/api/user_api.rb', line 3899

def user_list_quota_artifacts(opts = {})
  data, _status_code, _headers = user_list_quota_artifacts_with_http_info(opts)
  data
end

#user_list_quota_artifacts_with_http_info(opts = {}) ⇒ Array<(Array<QuotaUsedArtifact>, Integer, Hash)>

List the artifacts affecting the authenticated user&#39;s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<QuotaUsedArtifact>, Integer, Hash)>) —

    Array<QuotaUsedArtifact> data, response status code and response headers



3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
 
# File 'lib/forgejo/api/user_api.rb', line 3909

def user_list_quota_artifacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_quota_artifacts ...'
  end
  # resource path
  local_var_path = '/user/quota/artifacts'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<QuotaUsedArtifact>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_quota_artifacts",
    :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: UserApi#user_list_quota_artifacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_quota_attachments(opts = {}) ⇒ Array<QuotaUsedAttachment>

List the attachments affecting the authenticated user’s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



3960
3961
3962
3963
 
# File 'lib/forgejo/api/user_api.rb', line 3960

def user_list_quota_attachments(opts = {})
  data, _status_code, _headers = user_list_quota_attachments_with_http_info(opts)
  data
end

#user_list_quota_attachments_with_http_info(opts = {}) ⇒ Array<(Array<QuotaUsedAttachment>, Integer, Hash)>

List the attachments affecting the authenticated user&#39;s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<QuotaUsedAttachment>, Integer, Hash)>) —

    Array<QuotaUsedAttachment> data, response status code and response headers



3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
 
# File 'lib/forgejo/api/user_api.rb', line 3970

def user_list_quota_attachments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_quota_attachments ...'
  end
  # resource path
  local_var_path = '/user/quota/attachments'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<QuotaUsedAttachment>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_quota_attachments",
    :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: UserApi#user_list_quota_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_quota_packages(opts = {}) ⇒ Array<QuotaUsedPackage>

List the packages affecting the authenticated user’s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4021
4022
4023
4024
 
# File 'lib/forgejo/api/user_api.rb', line 4021

def user_list_quota_packages(opts = {})
  data, _status_code, _headers = user_list_quota_packages_with_http_info(opts)
  data
end

#user_list_quota_packages_with_http_info(opts = {}) ⇒ Array<(Array<QuotaUsedPackage>, Integer, Hash)>

List the packages affecting the authenticated user&#39;s quota

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<QuotaUsedPackage>, Integer, Hash)>) —

    Array<QuotaUsedPackage> data, response status code and response headers



4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
 
# File 'lib/forgejo/api/user_api.rb', line 4031

def user_list_quota_packages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_quota_packages ...'
  end
  # resource path
  local_var_path = '/user/quota/packages'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<QuotaUsedPackage>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_quota_packages",
    :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: UserApi#user_list_quota_packages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_repos(username, opts = {}) ⇒ Array<Repository>

List the repos owned by the given user

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4083
4084
4085
4086
 
# File 'lib/forgejo/api/user_api.rb', line 4083

def user_list_repos(username, opts = {})
  data, _status_code, _headers = user_list_repos_with_http_info(username, opts)
  data
end

#user_list_repos_with_http_info(username, opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

List the repos owned by the given user

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
 
# File 'lib/forgejo/api/user_api.rb', line 4094

def user_list_repos_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_repos ...'
  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 UserApi.user_list_repos"
  end
  # resource path
  local_var_path = '/users/{username}/repos'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_repos",
    :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: UserApi#user_list_repos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_starred(username, opts = {}) ⇒ Array<Repository>

The repos that the given user has starred

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4150
4151
4152
4153
 
# File 'lib/forgejo/api/user_api.rb', line 4150

def user_list_starred(username, opts = {})
  data, _status_code, _headers = user_list_starred_with_http_info(username, opts)
  data
end

#user_list_starred_with_http_info(username, opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

The repos that the given user has starred

Parameters:

  • username (String) —

    username of user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
 
# File 'lib/forgejo/api/user_api.rb', line 4161

def user_list_starred_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_starred ...'
  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 UserApi.user_list_starred"
  end
  # resource path
  local_var_path = '/users/{username}/starred'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_starred",
    :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: UserApi#user_list_starred\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_subscriptions(username, opts = {}) ⇒ Array<Repository>

List the repositories watched by a user

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4217
4218
4219
4220
 
# File 'lib/forgejo/api/user_api.rb', line 4217

def user_list_subscriptions(username, opts = {})
  data, _status_code, _headers = user_list_subscriptions_with_http_info(username, opts)
  data
end

#user_list_subscriptions_with_http_info(username, opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

List the repositories watched by a user

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Repository>, Integer, Hash)>) —

    Array<Repository> data, response status code and response headers



4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/forgejo/api/user_api.rb', line 4228

def user_list_subscriptions_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_list_subscriptions ...'
  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 UserApi.user_list_subscriptions"
  end
  # resource path
  local_var_path = '/users/{username}/subscriptions'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Repository>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_subscriptions",
    :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: UserApi#user_list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_list_teams(opts = {}) ⇒ Array<Team>

List all the teams a user belongs to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4283
4284
4285
4286
 
# File 'lib/forgejo/api/user_api.rb', line 4283

def user_list_teams(opts = {})
  data, _status_code, _headers = user_list_teams_with_http_info(opts)
  data
end

#user_list_teams_with_http_info(opts = {}) ⇒ Array<(Array<Team>, Integer, Hash)>

List all the teams a user belongs to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(Array<Team>, Integer, Hash)>) —

    Array<Team> data, response status code and response headers



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
 
# File 'lib/forgejo/api/user_api.rb', line 4293

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Team>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_list_teams",
    :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: UserApi#user_list_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_search(opts = {}) ⇒ UserSearch200Response

Search for users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    keyword

  • :uid (Integer) —

    ID of the user to search for

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:



4346
4347
4348
4349
 
# File 'lib/forgejo/api/user_api.rb', line 4346

def user_search(opts = {})
  data, _status_code, _headers = user_search_with_http_info(opts)
  data
end

#user_search_with_http_info(opts = {}) ⇒ Array<(UserSearch200Response, Integer, Hash)>

Search for users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    keyword

  • :uid (Integer) —

    ID of the user to search for

  • :page (Integer) —

    page number of results to return (1-based)

  • :limit (Integer) —

    page size of results

Returns:

  • (Array<(UserSearch200Response, Integer, Hash)>) —

    UserSearch200Response data, response status code and response headers



4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
 
# File 'lib/forgejo/api/user_api.rb', line 4358

def user_search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_search ...'
  end
  # resource path
  local_var_path = '/users/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UserSearch200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_search",
    :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: UserApi#user_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_unblock_user(username, opts = {}) ⇒ nil

Unblocks a user from the doer.

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Returns:

  • (nil) 


4410
4411
4412
4413
 
# File 'lib/forgejo/api/user_api.rb', line 4410

def user_unblock_user(username, opts = {})
  user_unblock_user_with_http_info(username, opts)
  nil
end

#user_unblock_user_with_http_info(username, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unblocks a user from the doer.

Parameters:

  • username (String) —

    username of the user

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/forgejo/api/user_api.rb', line 4419

def user_unblock_user_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_unblock_user ...'
  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 UserApi.user_unblock_user"
  end
  # resource path
  local_var_path = '/user/unblock/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_unblock_user",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_unblock_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_update_avatar(opts = {}) ⇒ nil

Update Avatar

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


4471
4472
4473
4474
 
# File 'lib/forgejo/api/user_api.rb', line 4471

def user_update_avatar(opts = {})
  user_update_avatar_with_http_info(opts)
  nil
end

#user_update_avatar_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Avatar

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
 
# File 'lib/forgejo/api/user_api.rb', line 4480

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_update_avatar",
    :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: UserApi#user_update_avatar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_update_o_auth2_application(id, body, opts = {}) ⇒ OAuth2Application

update an OAuth2 Application, this includes regenerating the client secret

Parameters:

Returns:



4534
4535
4536
4537
 
# File 'lib/forgejo/api/user_api.rb', line 4534

def user_update_o_auth2_application(id, body, opts = {})
  data, _status_code, _headers = user_update_o_auth2_application_with_http_info(id, body, opts)
  data
end

#user_update_o_auth2_application_with_http_info(id, body, opts = {}) ⇒ Array<(OAuth2Application, Integer, Hash)>

update an OAuth2 Application, this includes regenerating the client secret

Parameters:

Returns:

  • (Array<(OAuth2Application, Integer, Hash)>) —

    OAuth2Application data, response status code and response headers



4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
 
# File 'lib/forgejo/api/user_api.rb', line 4544

def user_update_o_auth2_application_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_update_o_auth2_application ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.user_update_o_auth2_application"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling UserApi.user_update_o_auth2_application"
  end
  # resource path
  local_var_path = '/user/applications/oauth2/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Application'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_update_o_auth2_application",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#user_update_o_auth2_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_verify_gpg_key(opts = {}) ⇒ GPGKey

Verify a GPG key

Parameters:

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

    the optional parameters

Returns:



4604
4605
4606
4607
 
# File 'lib/forgejo/api/user_api.rb', line 4604

def user_verify_gpg_key(opts = {})
  data, _status_code, _headers = user_verify_gpg_key_with_http_info(opts)
  data
end

#user_verify_gpg_key_with_http_info(opts = {}) ⇒ Array<(GPGKey, Integer, Hash)>

Verify a GPG key

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GPGKey, Integer, Hash)>) —

    GPGKey data, response status code and response headers



4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
 
# File 'lib/forgejo/api/user_api.rb', line 4612

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

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GPGKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"UserApi.user_verify_gpg_key",
    :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: UserApi#user_verify_gpg_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end