Class: EjabberdHttpClient::ModulesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ejabberd_http_client/api/modules_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ModulesApi

Returns a new instance of ModulesApi.



19
20
21
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#check_module(check_module_request, opts = {}) ⇒ nil

Check the contributed module repository compliance.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 26

def check_module(check_module_request, opts = {})
  check_module_with_http_info(check_module_request, opts)
  nil
end

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

Check the contributed module repository compliance.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 35

def check_module_with_http_info(check_module_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.check_module ...'
  end
  # verify the required parameter 'check_module_request' is set
  if @api_client.config.client_side_validation && check_module_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_module_request' when calling ModulesApi.check_module"
  end
  # resource path
  local_var_path = '/api/module_check'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#install_module(check_module_request, opts = {}) ⇒ nil

Compile, install and start an available contributed module.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


90
91
92
93
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 90

def install_module(check_module_request, opts = {})
  install_module_with_http_info(check_module_request, opts)
  nil
end

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

Compile, install and start an available contributed module.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 99

def install_module_with_http_info(check_module_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.install_module ...'
  end
  # verify the required parameter 'check_module_request' is set
  if @api_client.config.client_side_validation && check_module_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_module_request' when calling ModulesApi.install_module"
  end
  # resource path
  local_var_path = '/api/module_install'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#list_available_modules(opts = {}) ⇒ Hash<String, String>

List the contributed modules available to install.

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, String>) 


153
154
155
156
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 153

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

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

List the contributed modules available to install.

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, String> data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 161

def list_available_modules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.list_available_modules ...'
  end
  # resource path
  local_var_path = '/api/modules_available'

  # 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] || 'Hash<String, String>'

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

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

#list_installed_modules(opts = {}) ⇒ Hash<String, String>

List the contributed modules already installed.

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, String>) 


208
209
210
211
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 208

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

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

List the contributed modules already installed.

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, String> data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 216

def list_installed_modules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.list_installed_modules ...'
  end
  # resource path
  local_var_path = '/api/modules_installed'

  # 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] || 'Hash<String, String>'

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

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

#uninstall_module(check_module_request, opts = {}) ⇒ nil

Uninstall a contributed module.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


264
265
266
267
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 264

def uninstall_module(check_module_request, opts = {})
  uninstall_module_with_http_info(check_module_request, opts)
  nil
end

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

Uninstall a contributed module.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 273

def uninstall_module_with_http_info(check_module_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.uninstall_module ...'
  end
  # verify the required parameter 'check_module_request' is set
  if @api_client.config.client_side_validation && check_module_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_module_request' when calling ModulesApi.uninstall_module"
  end
  # resource path
  local_var_path = '/api/module_uninstall'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_module_specs(opts = {}) ⇒ nil

Update the module source code from Git.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


327
328
329
330
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 327

def update_module_specs(opts = {})
  update_module_specs_with_http_info(opts)
  nil
end

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

Update the module source code from Git.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 335

def update_module_specs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.update_module_specs ...'
  end
  # resource path
  local_var_path = '/api/modules_update_specs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#upgrade_module(check_module_request, opts = {}) ⇒ nil

Upgrade the running code of an installed module.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


381
382
383
384
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 381

def upgrade_module(check_module_request, opts = {})
  upgrade_module_with_http_info(check_module_request, opts)
  nil
end

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

Upgrade the running code of an installed module.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ejabberd_http_client/api/modules_api.rb', line 390

def upgrade_module_with_http_info(check_module_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModulesApi.upgrade_module ...'
  end
  # verify the required parameter 'check_module_request' is set
  if @api_client.config.client_side_validation && check_module_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_module_request' when calling ModulesApi.upgrade_module"
  end
  # resource path
  local_var_path = '/api/module_upgrade'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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