Class: EjabberdHttpClient::StatisticsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatisticsApi

Returns a new instance of StatisticsApi.



19
20
21
 
# File 'lib/ejabberd_http_client/api/statistics_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/statistics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#connected_users_number(opts = {}) ⇒ ConnectedUsersNumber200Response

Get the number of established sessions.

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 25

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

#connected_users_number_with_http_info(opts = {}) ⇒ Array<(ConnectedUsersNumber200Response, Integer, Hash)>

Get the number of established sessions.

Parameters:

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

    the optional parameters

Returns:



33
34
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
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 33

def connected_users_number_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.connected_users_number ...'
  end
  # resource path
  local_var_path = '/api/connected_users_number'

  # 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] || 'ConnectedUsersNumber200Response'

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

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

#get_outgoing_s2s_number(opts = {}) ⇒ GetOutgoingS2sNumber200Response

Number of outgoing s2s connections on the node.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 80

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

#get_outgoing_s2s_number_with_http_info(opts = {}) ⇒ Array<(GetOutgoingS2sNumber200Response, Integer, Hash)>

Number of outgoing s2s connections on the node.

Parameters:

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

    the optional parameters

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 88

def get_outgoing_s2s_number_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.get_outgoing_s2s_number ...'
  end
  # resource path
  local_var_path = '/api/outgoing_s2s_number'

  # 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] || 'GetOutgoingS2sNumber200Response'

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

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

#get_stats(opts = {}) ⇒ GetStats200Response

Get statistical value - registeredusers, onlineusers, onlineusersnode, uptimeseconds, processes.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



136
137
138
139
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 136

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

#get_stats_host(opts = {}) ⇒ GetStats200Response

Get statistical value for this host - registeredusers, onlineusers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



198
199
200
201
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 198

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

#get_stats_host_with_http_info(opts = {}) ⇒ Array<(GetStats200Response, Integer, Hash)>

Get statistical value for this host - registeredusers, onlineusers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GetStats200Response data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 207

def get_stats_host_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.get_stats_host ...'
  end
  # resource path
  local_var_path = '/api/stats_host'

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

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

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

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

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

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

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

#get_stats_with_http_info(opts = {}) ⇒ Array<(GetStats200Response, Integer, Hash)>

Get statistical value - registeredusers, onlineusers, onlineusersnode, uptimeseconds, processes.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GetStats200Response data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 145

def get_stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.get_stats ...'
  end
  # resource path
  local_var_path = '/api/stats'

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

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

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

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

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

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

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

#get_status_num(opts = {}) ⇒ GetStatusNum200Response

Number of logged users with a specific status.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



260
261
262
263
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 260

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

#get_status_num_host(opts = {}) ⇒ GetStatusNum200Response

Number of logged users with a specific status in a host.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



322
323
324
325
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 322

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

#get_status_num_host_with_http_info(opts = {}) ⇒ Array<(GetStatusNum200Response, Integer, Hash)>

Number of logged users with a specific status in a host.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GetStatusNum200Response data, response status code and response headers



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

def get_status_num_host_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.get_status_num_host ...'
  end
  # resource path
  local_var_path = '/api/status_num_host'

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

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

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

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

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

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

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

#get_status_num_with_http_info(opts = {}) ⇒ Array<(GetStatusNum200Response, Integer, Hash)>

Number of logged users with a specific status.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GetStatusNum200Response data, response status code and response headers



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
312
313
314
315
316
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 269

def get_status_num_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.get_status_num ...'
  end
  # resource path
  local_var_path = '/api/status_num'

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

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

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

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

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

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

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

#incoming_s2s_number(opts = {}) ⇒ IncomingS2sNumber200Response

Number of incoming s2s connections on the node.

Parameters:

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

    the optional parameters

Returns:



383
384
385
386
 
# File 'lib/ejabberd_http_client/api/statistics_api.rb', line 383

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

#incoming_s2s_number_with_http_info(opts = {}) ⇒ Array<(IncomingS2sNumber200Response, Integer, Hash)>

Number of incoming s2s connections on the node.

Parameters:

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

    the optional parameters

Returns:



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

def incoming_s2s_number_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.incoming_s2s_number ...'
  end
  # resource path
  local_var_path = '/api/incoming_s2s_number'

  # 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] || 'IncomingS2sNumber200Response'

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

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