Class: Kleister::ModApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ModApi

Returns a new instance of ModApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#attach_mod_to_group(mod_id, permit_pack_group_request, opts = {}) ⇒ Notification

Attach a group to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_group_request (PermitPackGroupRequest) —

    The mod group data to permit

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

    the optional parameters

Returns:



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

def attach_mod_to_group(mod_id, permit_pack_group_request, opts = {})
  data, _status_code, _headers = attach_mod_to_group_with_http_info(mod_id, permit_pack_group_request, opts)
  data
end

#attach_mod_to_group_with_http_info(mod_id, permit_pack_group_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a group to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_group_request (PermitPackGroupRequest) —

    The mod group data to permit

  • 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/mod_api.rb', line 36

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

  # resource path
  local_var_path = '/mods/{mod_id}/groups'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(permit_pack_group_request)

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

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

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

#attach_mod_to_user(mod_id, permit_pack_user_request, opts = {}) ⇒ Notification

Attach a user to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_user_request (PermitPackUserRequest) —

    The mod user data to permit

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

    the optional parameters

Returns:



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

def attach_mod_to_user(mod_id, permit_pack_user_request, opts = {})
  data, _status_code, _headers = attach_mod_to_user_with_http_info(mod_id, permit_pack_user_request, opts)
  data
end

#attach_mod_to_user_with_http_info(mod_id, permit_pack_user_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a user to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_user_request (PermitPackUserRequest) —

    The mod user data to permit

  • 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/mod_api.rb', line 109

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

  # resource path
  local_var_path = '/mods/{mod_id}/users'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(permit_pack_user_request)

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

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

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

#attach_version_to_build(mod_id, version_id, attach_minecraft_to_build_request, opts = {}) ⇒ Notification

Attach a build to a version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • attach_minecraft_to_build_request (AttachMinecraftToBuildRequest) —

    The version build data to create or delete

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

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/kleister/api/mod_api.rb', line 173

def attach_version_to_build(mod_id, version_id, attach_minecraft_to_build_request, opts = {})
  data, _status_code, _headers = attach_version_to_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts)
  data
end

#attach_version_to_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Attach a build to a version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • attach_minecraft_to_build_request (AttachMinecraftToBuildRequest) —

    The version build data to create or delete

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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
239
240
241
242
243
244
 
# File 'lib/kleister/api/mod_api.rb', line 184

def attach_version_to_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.attach_version_to_build ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.attach_version_to_build"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    raise ArgumentError, "Missing the required parameter 'version_id' when calling ModApi.attach_version_to_build"
  end
  # verify the required parameter 'attach_minecraft_to_build_request' is set
  if @api_client.config.client_side_validation && attach_minecraft_to_build_request.nil?
    raise ArgumentError, "Missing the required parameter 'attach_minecraft_to_build_request' when calling ModApi.attach_version_to_build"
  end

  # resource path
  local_var_path = '/mods/{mod_id}/versions/{version_id}/builds'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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'])
  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(attach_minecraft_to_build_request)

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

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

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

#create_mod(create_mod_request, opts = {}) ⇒ Mod

Create a new mod

Parameters:

  • create_mod_request (CreateModRequest) —

    The mod data to create

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

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/kleister/api/mod_api.rb', line 250

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

#create_mod_avatar(mod_id, opts = {}) ⇒ ModAvatar

Upload an avatar for the defined mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



318
319
320
321
 
# File 'lib/kleister/api/mod_api.rb', line 318

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

#create_mod_avatar_with_http_info(mod_id, opts = {}) ⇒ Array<(ModAvatar, Integer, Hash)>

Upload an avatar for the defined mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    ModAvatar data, response status code and response headers



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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/kleister/api/mod_api.rb', line 328

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

  # resource path
  local_var_path = '/mods/{mod_id}/avatar'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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(['multipart/form-data'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:file] unless opts[:file].nil?

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

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

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

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

#create_mod_with_http_info(create_mod_request, opts = {}) ⇒ Array<(Mod, Integer, Hash)>

Create a new mod

Parameters:

  • create_mod_request (CreateModRequest) —

    The mod data to create

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

    the optional parameters

Returns:

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

    Mod data, response status code and response headers



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
306
307
308
309
310
311
 
# File 'lib/kleister/api/mod_api.rb', line 259

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

  # resource path
  local_var_path = '/mods'

  # 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'])
  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(create_mod_request)

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

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

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

#create_pack_avatar(pack_id, opts = {}) ⇒ PackAvatar

Upload an avatar for the defined pack

Parameters:

  • pack_id (String) —

    A pack identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



388
389
390
391
 
# File 'lib/kleister/api/mod_api.rb', line 388

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

#create_pack_avatar_with_http_info(pack_id, opts = {}) ⇒ Array<(PackAvatar, Integer, Hash)>

Upload an avatar for the defined pack

Parameters:

  • pack_id (String) —

    A pack identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    PackAvatar data, response status code and response headers



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
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/kleister/api/mod_api.rb', line 398

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

  # resource path
  local_var_path = '/packs/{pack_id}/avatar'.sub('{' + 'pack_id' + '}', CGI.escape(pack_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(['multipart/form-data'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:file] unless opts[:file].nil?

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

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

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

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

#create_version(mod_id, create_version_request, opts = {}) ⇒ Version

Create a new version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • create_version_request (CreateVersionRequest) —

    The version data to create

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

    the optional parameters

Returns:



458
459
460
461
 
# File 'lib/kleister/api/mod_api.rb', line 458

def create_version(mod_id, create_version_request, opts = {})
  data, _status_code, _headers = create_version_with_http_info(mod_id, create_version_request, opts)
  data
end

#create_version_with_http_info(mod_id, create_version_request, opts = {}) ⇒ Array<(Version, Integer, Hash)>

Create a new version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • create_version_request (CreateVersionRequest) —

    The version data to create

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

    the optional parameters

Returns:

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

    Version data, response status code and response headers



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
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/kleister/api/mod_api.rb', line 468

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

  # resource path
  local_var_path = '/mods/{mod_id}/versions'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(create_version_request)

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

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

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

#delete_mod(mod_id, opts = {}) ⇒ Notification

Delete a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:



530
531
532
533
 
# File 'lib/kleister/api/mod_api.rb', line 530

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

#delete_mod_avatar(mod_id, opts = {}) ⇒ ModAvatar

Delete the avatar for the defined mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:



592
593
594
595
 
# File 'lib/kleister/api/mod_api.rb', line 592

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

#delete_mod_avatar_with_http_info(mod_id, opts = {}) ⇒ Array<(ModAvatar, Integer, Hash)>

Delete the avatar for the defined mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:

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

    ModAvatar data, response status code and response headers



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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/kleister/api/mod_api.rb', line 601

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

  # resource path
  local_var_path = '/mods/{mod_id}/avatar'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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] || 'ModAvatar'

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

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

#delete_mod_from_group(mod_id, delete_pack_from_group_request, opts = {}) ⇒ Notification

Unlink a group from mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • delete_pack_from_group_request (DeletePackFromGroupRequest) —

    The mod group data to unlink

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

    the optional parameters

Returns:



655
656
657
658
 
# File 'lib/kleister/api/mod_api.rb', line 655

def delete_mod_from_group(mod_id, delete_pack_from_group_request, opts = {})
  data, _status_code, _headers = delete_mod_from_group_with_http_info(mod_id, delete_pack_from_group_request, opts)
  data
end

#delete_mod_from_group_with_http_info(mod_id, delete_pack_from_group_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a group from mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • delete_pack_from_group_request (DeletePackFromGroupRequest) —

    The mod group data to unlink

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/kleister/api/mod_api.rb', line 665

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

  # resource path
  local_var_path = '/mods/{mod_id}/groups'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(delete_pack_from_group_request)

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

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

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

#delete_mod_from_user(mod_id, delete_pack_from_user_request, opts = {}) ⇒ Notification

Unlink a user from mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • delete_pack_from_user_request (DeletePackFromUserRequest) —

    The mod user data to unlink

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

    the optional parameters

Returns:



728
729
730
731
 
# File 'lib/kleister/api/mod_api.rb', line 728

def delete_mod_from_user(mod_id, delete_pack_from_user_request, opts = {})
  data, _status_code, _headers = delete_mod_from_user_with_http_info(mod_id, delete_pack_from_user_request, opts)
  data
end

#delete_mod_from_user_with_http_info(mod_id, delete_pack_from_user_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a user from mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • delete_pack_from_user_request (DeletePackFromUserRequest) —

    The mod user data to unlink

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/kleister/api/mod_api.rb', line 738

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

  # resource path
  local_var_path = '/mods/{mod_id}/users'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(delete_pack_from_user_request)

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

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

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

#delete_mod_with_http_info(mod_id, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Delete a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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/mod_api.rb', line 539

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

  # resource path
  local_var_path = '/mods/{mod_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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] || 'Notification'

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

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

#delete_pack_avatar(pack_id, opts = {}) ⇒ PackAvatar

Delete the avatar for the defined pack

Parameters:

  • pack_id (String) —

    A pack identifier or slug

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

    the optional parameters

Returns:



800
801
802
803
 
# File 'lib/kleister/api/mod_api.rb', line 800

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

#delete_pack_avatar_with_http_info(pack_id, opts = {}) ⇒ Array<(PackAvatar, Integer, Hash)>

Delete the avatar for the defined pack

Parameters:

  • pack_id (String) —

    A pack identifier or slug

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

    the optional parameters

Returns:

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

    PackAvatar data, response status code and response headers



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
848
849
850
851
852
853
854
855
856
 
# File 'lib/kleister/api/mod_api.rb', line 809

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

  # resource path
  local_var_path = '/packs/{pack_id}/avatar'.sub('{' + 'pack_id' + '}', CGI.escape(pack_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] || 'PackAvatar'

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

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

#delete_version(mod_id, version_id, opts = {}) ⇒ Notification

Delete a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Returns:



863
864
865
866
 
# File 'lib/kleister/api/mod_api.rb', line 863

def delete_version(mod_id, version_id, opts = {})
  data, _status_code, _headers = delete_version_with_http_info(mod_id, version_id, opts)
  data
end

#delete_version_from_build(mod_id, version_id, attach_minecraft_to_build_request, opts = {}) ⇒ Notification

Unlink a build from a version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • attach_minecraft_to_build_request (AttachMinecraftToBuildRequest) —

    The version build data to create or delete

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/kleister/api/mod_api.rb', line 932

def delete_version_from_build(mod_id, version_id, attach_minecraft_to_build_request, opts = {})
  data, _status_code, _headers = delete_version_from_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts)
  data
end

#delete_version_from_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Unlink a build from a version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • attach_minecraft_to_build_request (AttachMinecraftToBuildRequest) —

    The version build data to create or delete

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



943
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
1001
1002
1003
 
# File 'lib/kleister/api/mod_api.rb', line 943

def delete_version_from_build_with_http_info(mod_id, version_id, attach_minecraft_to_build_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.delete_version_from_build ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.delete_version_from_build"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    raise ArgumentError, "Missing the required parameter 'version_id' when calling ModApi.delete_version_from_build"
  end
  # verify the required parameter 'attach_minecraft_to_build_request' is set
  if @api_client.config.client_side_validation && attach_minecraft_to_build_request.nil?
    raise ArgumentError, "Missing the required parameter 'attach_minecraft_to_build_request' when calling ModApi.delete_version_from_build"
  end

  # resource path
  local_var_path = '/mods/{mod_id}/versions/{version_id}/builds'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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'])
  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(attach_minecraft_to_build_request)

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

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

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

#delete_version_with_http_info(mod_id, version_id, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Delete a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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
 
# File 'lib/kleister/api/mod_api.rb', line 873

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

  # resource path
  local_var_path = '/mods/{mod_id}/versions/{version_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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] || 'Notification'

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

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

#list_mod_groups(mod_id, opts = {}) ⇒ ListModGroups200Response

Fetch all groups attached to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1014
1015
1016
1017
 
# File 'lib/kleister/api/mod_api.rb', line 1014

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

#list_mod_groups_with_http_info(mod_id, opts = {}) ⇒ Array<(ListModGroups200Response, Integer, Hash)>

Fetch all groups attached to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:

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

    ListModGroups200Response 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
1080
1081
1082
1083
1084
1085
 
# File 'lib/kleister/api/mod_api.rb', line 1028

def list_mod_groups_with_http_info(mod_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.list_mod_groups ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.list_mod_groups"
  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 = '/mods/{mod_id}/groups'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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']) 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] || 'ListModGroups200Response'

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

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

#list_mod_users(mod_id, opts = {}) ⇒ ListModUsers200Response

Fetch all users attached to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1096
1097
1098
1099
 
# File 'lib/kleister/api/mod_api.rb', line 1096

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

#list_mod_users_with_http_info(mod_id, opts = {}) ⇒ Array<(ListModUsers200Response, Integer, Hash)>

Fetch all users attached to mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:

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

    ListModUsers200Response data, response status code and response headers



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
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/kleister/api/mod_api.rb', line 1110

def list_mod_users_with_http_info(mod_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.list_mod_users ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.list_mod_users"
  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 = '/mods/{mod_id}/users'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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']) 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] || 'ListModUsers200Response'

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

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

#list_mods(opts = {}) ⇒ ListMods200Response

Fetch all available mods

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1177
1178
1179
1180
 
# File 'lib/kleister/api/mod_api.rb', line 1177

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

#list_mods_with_http_info(opts = {}) ⇒ Array<(ListMods200Response, Integer, Hash)>

Fetch all available mods

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:

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

    ListMods200Response data, response status code and response headers



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/kleister/api/mod_api.rb', line 1190

def list_mods_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.list_mods ...'
  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 = '/mods'

  # 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']) 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] || 'ListMods200Response'

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

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

#list_version_builds(mod_id, version_id, opts = {}) ⇒ ListVersionBuilds200Response

Fetch all builds attached to version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1254
1255
1256
1257
 
# File 'lib/kleister/api/mod_api.rb', line 1254

def list_version_builds(mod_id, version_id, opts = {})
  data, _status_code, _headers = list_version_builds_with_http_info(mod_id, version_id, opts)
  data
end

#list_version_builds_with_http_info(mod_id, version_id, opts = {}) ⇒ Array<(ListVersionBuilds200Response, Integer, Hash)>

Fetch all builds attached to version

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
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
 
# File 'lib/kleister/api/mod_api.rb', line 1269

def list_version_builds_with_http_info(mod_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.list_version_builds ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.list_version_builds"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    raise ArgumentError, "Missing the required parameter 'version_id' when calling ModApi.list_version_builds"
  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 = '/mods/{mod_id}/versions/{version_id}/builds'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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']) 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] || 'ListVersionBuilds200Response'

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

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

#list_versions(mod_id, opts = {}) ⇒ ListVersions200Response

Fetch all available versions for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:



1341
1342
1343
1344
 
# File 'lib/kleister/api/mod_api.rb', line 1341

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

#list_versions_with_http_info(mod_id, opts = {}) ⇒ Array<(ListVersions200Response, Integer, Hash)>

Fetch all available versions for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search query

  • :sort (String) —

    Sorting column

  • :order (String) —

    Sorting order (default to ‘asc’)

  • :limit (Integer) —

    Paging limit (default to 100)

  • :offset (Integer) —

    Paging offset (default to 0)

Returns:

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

    ListVersions200Response data, response status code and response headers



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
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/kleister/api/mod_api.rb', line 1355

def list_versions_with_http_info(mod_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.list_versions ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.list_versions"
  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 = '/mods/{mod_id}/versions'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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']) 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] || 'ListVersions200Response'

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

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

#permit_mod_group(mod_id, permit_pack_group_request, opts = {}) ⇒ Notification

Update group perms for mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_group_request (PermitPackGroupRequest) —

    The mod group data to permit

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

    the optional parameters

Returns:



1419
1420
1421
1422
 
# File 'lib/kleister/api/mod_api.rb', line 1419

def permit_mod_group(mod_id, permit_pack_group_request, opts = {})
  data, _status_code, _headers = permit_mod_group_with_http_info(mod_id, permit_pack_group_request, opts)
  data
end

#permit_mod_group_with_http_info(mod_id, permit_pack_group_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Update group perms for mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_group_request (PermitPackGroupRequest) —

    The mod group data to permit

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



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
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/kleister/api/mod_api.rb', line 1429

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

  # resource path
  local_var_path = '/mods/{mod_id}/groups'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(permit_pack_group_request)

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

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

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

#permit_mod_user(mod_id, permit_pack_user_request, opts = {}) ⇒ Notification

Update user perms for mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_user_request (PermitPackUserRequest) —

    The mod user data to permit

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

    the optional parameters

Returns:



1492
1493
1494
1495
 
# File 'lib/kleister/api/mod_api.rb', line 1492

def permit_mod_user(mod_id, permit_pack_user_request, opts = {})
  data, _status_code, _headers = permit_mod_user_with_http_info(mod_id, permit_pack_user_request, opts)
  data
end

#permit_mod_user_with_http_info(mod_id, permit_pack_user_request, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Update user perms for mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • permit_pack_user_request (PermitPackUserRequest) —

    The mod user data to permit

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/kleister/api/mod_api.rb', line 1502

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

  # resource path
  local_var_path = '/mods/{mod_id}/users'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(permit_pack_user_request)

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

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

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

#show_mod(mod_id, opts = {}) ⇒ Mod

Fetch a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:



1564
1565
1566
1567
 
# File 'lib/kleister/api/mod_api.rb', line 1564

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

#show_mod_with_http_info(mod_id, opts = {}) ⇒ Array<(Mod, Integer, Hash)>

Fetch a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

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

    the optional parameters

Returns:

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

    Mod data, response status code and response headers



1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/kleister/api/mod_api.rb', line 1573

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

  # resource path
  local_var_path = '/mods/{mod_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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] || 'Mod'

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

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

#show_version(mod_id, version_id, opts = {}) ⇒ Version

Fetch a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Returns:



1627
1628
1629
1630
 
# File 'lib/kleister/api/mod_api.rb', line 1627

def show_version(mod_id, version_id, opts = {})
  data, _status_code, _headers = show_version_with_http_info(mod_id, version_id, opts)
  data
end

#show_version_with_http_info(mod_id, version_id, opts = {}) ⇒ Array<(Version, Integer, Hash)>

Fetch a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

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

    the optional parameters

Returns:

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

    Version data, response status code and response headers



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
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
 
# File 'lib/kleister/api/mod_api.rb', line 1637

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

  # resource path
  local_var_path = '/mods/{mod_id}/versions/{version_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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] || 'Version'

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

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

#update_mod(mod_id, create_mod_request, opts = {}) ⇒ Mod

Update a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • create_mod_request (CreateModRequest) —

    The mod data to update

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

    the optional parameters

Returns:



1695
1696
1697
1698
 
# File 'lib/kleister/api/mod_api.rb', line 1695

def update_mod(mod_id, create_mod_request, opts = {})
  data, _status_code, _headers = update_mod_with_http_info(mod_id, create_mod_request, opts)
  data
end

#update_mod_with_http_info(mod_id, create_mod_request, opts = {}) ⇒ Array<(Mod, Integer, Hash)>

Update a specific mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • create_mod_request (CreateModRequest) —

    The mod data to update

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

    the optional parameters

Returns:

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

    Mod data, response status code and response headers



1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
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
 
# File 'lib/kleister/api/mod_api.rb', line 1705

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

  # resource path
  local_var_path = '/mods/{mod_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_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'])
  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(create_mod_request)

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

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

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

#update_version(mod_id, version_id, create_version_request, opts = {}) ⇒ Version

Update a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • create_version_request (CreateVersionRequest) —

    The version data to update

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

    the optional parameters

Returns:



1769
1770
1771
1772
 
# File 'lib/kleister/api/mod_api.rb', line 1769

def update_version(mod_id, version_id, create_version_request, opts = {})
  data, _status_code, _headers = update_version_with_http_info(mod_id, version_id, create_version_request, opts)
  data
end

#update_version_with_http_info(mod_id, version_id, create_version_request, opts = {}) ⇒ Array<(Version, Integer, Hash)>

Update a specific version for a mod

Parameters:

  • mod_id (String) —

    A mod identifier or slug

  • version_id (String) —

    A version identifier or slug

  • create_version_request (CreateVersionRequest) —

    The version data to update

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

    the optional parameters

Returns:

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

    Version data, response status code and response headers



1780
1781
1782
1783
1784
1785
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
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
 
# File 'lib/kleister/api/mod_api.rb', line 1780

def update_version_with_http_info(mod_id, version_id, create_version_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModApi.update_version ...'
  end
  # verify the required parameter 'mod_id' is set
  if @api_client.config.client_side_validation && mod_id.nil?
    raise ArgumentError, "Missing the required parameter 'mod_id' when calling ModApi.update_version"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    raise ArgumentError, "Missing the required parameter 'version_id' when calling ModApi.update_version"
  end
  # verify the required parameter 'create_version_request' is set
  if @api_client.config.client_side_validation && create_version_request.nil?
    raise ArgumentError, "Missing the required parameter 'create_version_request' when calling ModApi.update_version"
  end

  # resource path
  local_var_path = '/mods/{mod_id}/versions/{version_id}'.sub('{' + 'mod_id' + '}', CGI.escape(mod_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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'])
  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(create_version_request)

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

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

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