Class: Kleister::TeamApi

Inherits:
Object
  • Object
show all
Defined in:
lib/kleister/api/team_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamApi

Returns a new instance of TeamApi.



17
18
19
# File 'lib/kleister/api/team_api.rb', line 17

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



15
16
17
# File 'lib/kleister/api/team_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#attach_team_to_mod(team_id, team_mod_params, opts = {}) ⇒ Notification

Attach a mod to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to attach

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

    the optional parameters

Returns:



26
27
28
29
# File 'lib/kleister/api/team_api.rb', line 26

def attach_team_to_mod(team_id, team_mod_params, opts = {})
  data, _status_code, _headers = attach_team_to_mod_with_http_info(team_id, team_mod_params, opts)
  data
end

#attach_team_to_mod_with_http_info(team_id, team_mod_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a mod to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to attach

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



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
83
84
85
86
87
88
89
90
91
92
# File 'lib/kleister/api/team_api.rb', line 36

def attach_team_to_mod_with_http_info(team_id, team_mod_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.attach_team_to_mod ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.attach_team_to_mod"
  end
  # verify the required parameter 'team_mod_params' is set
  if @api_client.config.client_side_validation && team_mod_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_mod_params' when calling TeamApi.attach_team_to_mod"
  end

  # resource path
  local_var_path = '/teams/{team_id}/mods'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_mod_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.attach_team_to_mod',
    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: TeamApi#attach_team_to_mod\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#attach_team_to_pack(team_id, team_pack_params, opts = {}) ⇒ Notification

Attach a pack to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to attach

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

    the optional parameters

Returns:



99
100
101
102
# File 'lib/kleister/api/team_api.rb', line 99

def attach_team_to_pack(team_id, team_pack_params, opts = {})
  data, _status_code, _headers = attach_team_to_pack_with_http_info(team_id, team_pack_params, opts)
  data
end

#attach_team_to_pack_with_http_info(team_id, team_pack_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a pack to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to attach

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/kleister/api/team_api.rb', line 109

def attach_team_to_pack_with_http_info(team_id, team_pack_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.attach_team_to_pack ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.attach_team_to_pack"
  end
  # verify the required parameter 'team_pack_params' is set
  if @api_client.config.client_side_validation && team_pack_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_pack_params' when calling TeamApi.attach_team_to_pack"
  end

  # resource path
  local_var_path = '/teams/{team_id}/packs'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_pack_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.attach_team_to_pack',
    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: TeamApi#attach_team_to_pack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#attach_team_to_user(team_id, team_user_params, opts = {}) ⇒ Notification

Attach a user to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to attach

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

    the optional parameters

Returns:



172
173
174
175
# File 'lib/kleister/api/team_api.rb', line 172

def attach_team_to_user(team_id, team_user_params, opts = {})
  data, _status_code, _headers = attach_team_to_user_with_http_info(team_id, team_user_params, opts)
  data
end

#attach_team_to_user_with_http_info(team_id, team_user_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a user to team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to attach

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/kleister/api/team_api.rb', line 182

def attach_team_to_user_with_http_info(team_id, team_user_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.attach_team_to_user ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.attach_team_to_user"
  end
  # verify the required parameter 'team_user_params' is set
  if @api_client.config.client_side_validation && team_user_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_user_params' when calling TeamApi.attach_team_to_user"
  end

  # resource path
  local_var_path = '/teams/{team_id}/users'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_user_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.attach_team_to_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamApi#attach_team_to_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#create_team(team, opts = {}) ⇒ Team

Create a new team

Parameters:

  • team (Team)

    The team data to create

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

    the optional parameters

Returns:



244
245
246
247
# File 'lib/kleister/api/team_api.rb', line 244

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

#create_team_with_http_info(team, opts = {}) ⇒ Array<(Team, Integer, Hash)>

Create a new team

Parameters:

  • team (Team)

    The team data to create

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

    the optional parameters

Returns:

  • (Array<(Team, Integer, Hash)>)

    Team data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/kleister/api/team_api.rb', line 253

def create_team_with_http_info(team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.create_team ...'
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    raise ArgumentError, "Missing the required parameter 'team' when calling TeamApi.create_team"
  end

  # resource path
  local_var_path = '/teams'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.create_team',
    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: TeamApi#create_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_team(team_id, opts = {}) ⇒ Notification

Delete a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Returns:



311
312
313
314
# File 'lib/kleister/api/team_api.rb', line 311

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

#delete_team_from_mod(team_id, team_mod_params, opts = {}) ⇒ Notification

Unlink a mod from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to unlink

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

    the optional parameters

Returns:



374
375
376
377
# File 'lib/kleister/api/team_api.rb', line 374

def delete_team_from_mod(team_id, team_mod_params, opts = {})
  data, _status_code, _headers = delete_team_from_mod_with_http_info(team_id, team_mod_params, opts)
  data
end

#delete_team_from_mod_with_http_info(team_id, team_mod_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a mod from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to unlink

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
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
# File 'lib/kleister/api/team_api.rb', line 384

def delete_team_from_mod_with_http_info(team_id, team_mod_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.delete_team_from_mod ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.delete_team_from_mod"
  end
  # verify the required parameter 'team_mod_params' is set
  if @api_client.config.client_side_validation && team_mod_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_mod_params' when calling TeamApi.delete_team_from_mod"
  end

  # resource path
  local_var_path = '/teams/{team_id}/mods'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_mod_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.delete_team_from_mod',
    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: TeamApi#delete_team_from_mod\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_team_from_pack(team_id, team_pack_params, opts = {}) ⇒ Notification

Unlink a pack from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to unlink

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

    the optional parameters

Returns:



447
448
449
450
# File 'lib/kleister/api/team_api.rb', line 447

def delete_team_from_pack(team_id, team_pack_params, opts = {})
  data, _status_code, _headers = delete_team_from_pack_with_http_info(team_id, team_pack_params, opts)
  data
end

#delete_team_from_pack_with_http_info(team_id, team_pack_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a pack from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to unlink

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



457
458
459
460
461
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
505
506
507
508
509
510
511
512
513
# File 'lib/kleister/api/team_api.rb', line 457

def delete_team_from_pack_with_http_info(team_id, team_pack_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.delete_team_from_pack ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.delete_team_from_pack"
  end
  # verify the required parameter 'team_pack_params' is set
  if @api_client.config.client_side_validation && team_pack_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_pack_params' when calling TeamApi.delete_team_from_pack"
  end

  # resource path
  local_var_path = '/teams/{team_id}/packs'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_pack_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.delete_team_from_pack',
    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: TeamApi#delete_team_from_pack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_team_from_user(team_id, team_user_params, opts = {}) ⇒ Notification

Unlink a user from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to unlink

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

    the optional parameters

Returns:



520
521
522
523
# File 'lib/kleister/api/team_api.rb', line 520

def delete_team_from_user(team_id, team_user_params, opts = {})
  data, _status_code, _headers = delete_team_from_user_with_http_info(team_id, team_user_params, opts)
  data
end

#delete_team_from_user_with_http_info(team_id, team_user_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a user from team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to unlink

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/kleister/api/team_api.rb', line 530

def delete_team_from_user_with_http_info(team_id, team_user_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.delete_team_from_user ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.delete_team_from_user"
  end
  # verify the required parameter 'team_user_params' is set
  if @api_client.config.client_side_validation && team_user_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_user_params' when calling TeamApi.delete_team_from_user"
  end

  # resource path
  local_var_path = '/teams/{team_id}/users'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_user_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.delete_team_from_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamApi#delete_team_from_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_team_with_http_info(team_id, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Delete a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
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
# File 'lib/kleister/api/team_api.rb', line 320

def delete_team_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.delete_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.delete_team"
  end

  # resource path
  local_var_path = '/teams/{team_id}'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.delete_team',
    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: TeamApi#delete_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_team_mods(team_id, opts = {}) ⇒ TeamMods

Fetch all mods attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:



597
598
599
600
# File 'lib/kleister/api/team_api.rb', line 597

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

#list_team_mods_with_http_info(team_id, opts = {}) ⇒ Array<(TeamMods, Integer, Hash)>

Fetch all mods attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:

  • (Array<(TeamMods, Integer, Hash)>)

    TeamMods data, response status code and response headers



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'lib/kleister/api/team_api.rb', line 611

def list_team_mods_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_team_mods ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.list_team_mods"
  end

  allowable_values = %w[slug name public]
  if @api_client.config.client_side_validation && opts[:sort] && !allowable_values.include?(opts[:sort])
    raise ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end

  allowable_values = %w[asc desc]
  if @api_client.config.client_side_validation && opts[:order] && !allowable_values.include?(opts[:order])
    raise ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end

  # resource path
  local_var_path = '/teams/{team_id}/mods'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:search] = opts[:search] unless opts[:search].nil?
  query_params[:sort] = opts[:sort] unless opts[:sort].nil?
  query_params[:order] = opts[:order] unless opts[:order].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:offset] = opts[:offset] unless opts[:offset].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.list_team_mods',
    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: TeamApi#list_team_mods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_team_packs(team_id, opts = {}) ⇒ TeamPacks

Fetch all packs attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:



684
685
686
687
# File 'lib/kleister/api/team_api.rb', line 684

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

#list_team_packs_with_http_info(team_id, opts = {}) ⇒ Array<(TeamPacks, Integer, Hash)>

Fetch all packs attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:

  • (Array<(TeamPacks, Integer, Hash)>)

    TeamPacks data, response status code and response headers



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
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
# File 'lib/kleister/api/team_api.rb', line 698

def list_team_packs_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_team_packs ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.list_team_packs"
  end

  allowable_values = %w[slug name public]
  if @api_client.config.client_side_validation && opts[:sort] && !allowable_values.include?(opts[:sort])
    raise ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end

  allowable_values = %w[asc desc]
  if @api_client.config.client_side_validation && opts[:order] && !allowable_values.include?(opts[:order])
    raise ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end

  # resource path
  local_var_path = '/teams/{team_id}/packs'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:search] = opts[:search] unless opts[:search].nil?
  query_params[:sort] = opts[:sort] unless opts[:sort].nil?
  query_params[:order] = opts[:order] unless opts[:order].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:offset] = opts[:offset] unless opts[:offset].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.list_team_packs',
    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: TeamApi#list_team_packs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_team_users(team_id, opts = {}) ⇒ TeamUsers

Fetch all users attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘username’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:



771
772
773
774
# File 'lib/kleister/api/team_api.rb', line 771

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

#list_team_users_with_http_info(team_id, opts = {}) ⇒ Array<(TeamUsers, Integer, Hash)>

Fetch all users attached to team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘username’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:

  • (Array<(TeamUsers, Integer, Hash)>)

    TeamUsers data, response status code and response headers



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
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
# File 'lib/kleister/api/team_api.rb', line 785

def list_team_users_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_team_users ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.list_team_users"
  end

  allowable_values = %w[username email fullname admin active]
  if @api_client.config.client_side_validation && opts[:sort] && !allowable_values.include?(opts[:sort])
    raise ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end

  allowable_values = %w[asc desc]
  if @api_client.config.client_side_validation && opts[:order] && !allowable_values.include?(opts[:order])
    raise ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end

  # resource path
  local_var_path = '/teams/{team_id}/users'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:search] = opts[:search] unless opts[:search].nil?
  query_params[:sort] = opts[:sort] unless opts[:sort].nil?
  query_params[:order] = opts[:order] unless opts[:order].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:offset] = opts[:offset] unless opts[:offset].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.list_team_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: TeamApi#list_team_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_teams(opts = {}) ⇒ Teams

Fetch all available teams

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:



857
858
859
860
# File 'lib/kleister/api/team_api.rb', line 857

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

#list_teams_with_http_info(opts = {}) ⇒ Array<(Teams, Integer, Hash)>

Fetch all available teams

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search query

  • :sort (String)

    Sorting column (default to ‘name’)

  • :order (String)

    Sorting order (default to ‘asc’)

  • :limit (Integer)

    Paging limit (default to 100)

  • :offset (Integer)

    Paging offset (default to 0)

Returns:

  • (Array<(Teams, Integer, Hash)>)

    Teams data, response status code and response headers



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'lib/kleister/api/team_api.rb', line 870

def list_teams_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_teams ...'
  end
  allowable_values = %w[slug name]
  if @api_client.config.client_side_validation && opts[:sort] && !allowable_values.include?(opts[:sort])
    raise ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end

  allowable_values = %w[asc desc]
  if @api_client.config.client_side_validation && opts[:order] && !allowable_values.include?(opts[:order])
    raise ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end

  # resource path
  local_var_path = '/teams'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:search] = opts[:search] unless opts[:search].nil?
  query_params[:sort] = opts[:sort] unless opts[:sort].nil?
  query_params[:order] = opts[:order] unless opts[:order].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:offset] = opts[:offset] unless opts[:offset].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.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: TeamApi#list_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#permit_team_mod(team_id, team_mod_params, opts = {}) ⇒ Notification

Update mod perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to update

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

    the optional parameters

Returns:



934
935
936
937
# File 'lib/kleister/api/team_api.rb', line 934

def permit_team_mod(team_id, team_mod_params, opts = {})
  data, _status_code, _headers = permit_team_mod_with_http_info(team_id, team_mod_params, opts)
  data
end

#permit_team_mod_with_http_info(team_id, team_mod_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Update mod perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_mod_params (TeamModParams)

    The team mod data to update

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
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
# File 'lib/kleister/api/team_api.rb', line 944

def permit_team_mod_with_http_info(team_id, team_mod_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.permit_team_mod ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.permit_team_mod"
  end
  # verify the required parameter 'team_mod_params' is set
  if @api_client.config.client_side_validation && team_mod_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_mod_params' when calling TeamApi.permit_team_mod"
  end

  # resource path
  local_var_path = '/teams/{team_id}/mods'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_mod_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.permit_team_mod',
    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: TeamApi#permit_team_mod\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#permit_team_pack(team_id, team_pack_params, opts = {}) ⇒ Notification

Update pack perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to update

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

    the optional parameters

Returns:



1007
1008
1009
1010
# File 'lib/kleister/api/team_api.rb', line 1007

def permit_team_pack(team_id, team_pack_params, opts = {})
  data, _status_code, _headers = permit_team_pack_with_http_info(team_id, team_pack_params, opts)
  data
end

#permit_team_pack_with_http_info(team_id, team_pack_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Update pack perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_pack_params (TeamPackParams)

    The team pack data to update

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
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
# File 'lib/kleister/api/team_api.rb', line 1017

def permit_team_pack_with_http_info(team_id, team_pack_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.permit_team_pack ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.permit_team_pack"
  end
  # verify the required parameter 'team_pack_params' is set
  if @api_client.config.client_side_validation && team_pack_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_pack_params' when calling TeamApi.permit_team_pack"
  end

  # resource path
  local_var_path = '/teams/{team_id}/packs'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_pack_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.permit_team_pack',
    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: TeamApi#permit_team_pack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#permit_team_user(team_id, team_user_params, opts = {}) ⇒ Notification

Update user perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to update

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

    the optional parameters

Returns:



1080
1081
1082
1083
# File 'lib/kleister/api/team_api.rb', line 1080

def permit_team_user(team_id, team_user_params, opts = {})
  data, _status_code, _headers = permit_team_user_with_http_info(team_id, team_user_params, opts)
  data
end

#permit_team_user_with_http_info(team_id, team_user_params, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Update user perms for team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team_user_params (TeamUserParams)

    The team user data to update

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

    the optional parameters

Returns:

  • (Array<(Notification, Integer, Hash)>)

    Notification data, response status code and response headers



1090
1091
1092
1093
1094
1095
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
# File 'lib/kleister/api/team_api.rb', line 1090

def permit_team_user_with_http_info(team_id, team_user_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.permit_team_user ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.permit_team_user"
  end
  # verify the required parameter 'team_user_params' is set
  if @api_client.config.client_side_validation && team_user_params.nil?
    raise ArgumentError, "Missing the required parameter 'team_user_params' when calling TeamApi.permit_team_user"
  end

  # resource path
  local_var_path = '/teams/{team_id}/users'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team_user_params)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.permit_team_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: TeamApi#permit_team_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#show_team(team_id, opts = {}) ⇒ Team

Fetch a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Returns:



1152
1153
1154
1155
# File 'lib/kleister/api/team_api.rb', line 1152

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

#show_team_with_http_info(team_id, opts = {}) ⇒ Array<(Team, Integer, Hash)>

Fetch a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

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

    the optional parameters

Returns:

  • (Array<(Team, Integer, Hash)>)

    Team data, response status code and response headers



1161
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/kleister/api/team_api.rb', line 1161

def show_team_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.show_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.show_team"
  end

  # resource path
  local_var_path = '/teams/{team_id}'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.show_team',
    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: TeamApi#show_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#update_team(team_id, team, opts = {}) ⇒ Team

Update a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team (Team)

    The team data to update

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

    the optional parameters

Returns:



1215
1216
1217
1218
# File 'lib/kleister/api/team_api.rb', line 1215

def update_team(team_id, team, opts = {})
  data, _status_code, _headers = update_team_with_http_info(team_id, team, opts)
  data
end

#update_team_with_http_info(team_id, team, opts = {}) ⇒ Array<(Team, Integer, Hash)>

Update a specific team

Parameters:

  • team_id (String)

    A team identifier or slug

  • team (Team)

    The team data to update

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

    the optional parameters

Returns:

  • (Array<(Team, Integer, Hash)>)

    Team data, 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
1276
1277
1278
1279
1280
1281
# File 'lib/kleister/api/team_api.rb', line 1225

def update_team_with_http_info(team_id, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.update_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    raise ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.update_team"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    raise ArgumentError, "Missing the required parameter 'team' when calling TeamApi.update_team"
  end

  # resource path
  local_var_path = '/teams/{team_id}'.sub('{' + 'team_id' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless 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(team)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]

  new_options = opts.merge(
    operation: :'TeamApi.update_team',
    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: TeamApi#update_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end