Class: EjabberdHttpClient::PurgeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PurgeApi

Returns a new instance of PurgeApi.



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

def api_client
  @api_client
end

Instance Method Details

#abort_delete_old_mam_messages(abort_delete_old_mam_messages_request, opts = {}) ⇒ AbortDeleteOldMamMessages200Response

Abort currently running delete old MAM messages operation.

Parameters:

Returns:



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

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

#abort_delete_old_mam_messages_with_http_info(abort_delete_old_mam_messages_request, opts = {}) ⇒ Array<(AbortDeleteOldMamMessages200Response, Integer, Hash)>

Abort currently running delete old MAM messages operation.

Parameters:

Returns:



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
85
86
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 35

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

  # 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(abort_delete_old_mam_messages_request)

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

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

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

#abort_delete_old_messages(abort_delete_old_mam_messages_request, opts = {}) ⇒ AbortDeleteOldMamMessages200Response

Abort currently running delete old offline messages operation.

Parameters:

Returns:



92
93
94
95
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 92

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

#abort_delete_old_messages_with_http_info(abort_delete_old_mam_messages_request, opts = {}) ⇒ Array<(AbortDeleteOldMamMessages200Response, Integer, Hash)>

Abort currently running delete old offline messages operation.

Parameters:

Returns:



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

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

  # 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(abort_delete_old_mam_messages_request)

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

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

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

#delete_expired_messages(opts = {}) ⇒ nil

Delete expired offline messages from database.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


157
158
159
160
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 157

def delete_expired_messages(opts = {})
  delete_expired_messages_with_http_info(opts)
  nil
end

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

Delete expired offline messages from database.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # 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 => :"PurgeApi.delete_expired_messages",
    :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: PurgeApi#delete_expired_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_expired_pubsub_items(opts = {}) ⇒ nil

Delete expired PubSub items.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


210
211
212
213
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 210

def delete_expired_pubsub_items(opts = {})
  delete_expired_pubsub_items_with_http_info(opts)
  nil
end

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

Delete expired PubSub items.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/purge_api.rb', line 218

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

  # 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 => :"PurgeApi.delete_expired_pubsub_items",
    :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: PurgeApi#delete_expired_pubsub_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_old_mam_messages(delete_old_mam_messages_request, opts = {}) ⇒ nil

Delete MAM messages older than DAYS.

Parameters:

Returns:

  • (nil) 


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

def delete_old_mam_messages(delete_old_mam_messages_request, opts = {})
  delete_old_mam_messages_with_http_info(delete_old_mam_messages_request, opts)
  nil
end

#delete_old_mam_messages_batch(delete_old_mam_messages_batch_request, opts = {}) ⇒ nil

Delete MAM messages older than DAYS in batches.

Parameters:

Returns:

  • (nil) 


328
329
330
331
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 328

def delete_old_mam_messages_batch(delete_old_mam_messages_batch_request, opts = {})
  delete_old_mam_messages_batch_with_http_info(delete_old_mam_messages_batch_request, opts)
  nil
end

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

Delete MAM messages older than DAYS in batches.

Parameters:

Returns:

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

    nil, response status code and response headers



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
382
383
384
385
386
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 337

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

  # 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(delete_old_mam_messages_batch_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_old_mam_messages_status(delete_old_mam_messages_status_request, opts = {}) ⇒ AbortDeleteOldMamMessages200Response

Status of delete old MAM messages operation.

Parameters:

Returns:



392
393
394
395
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 392

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

#delete_old_mam_messages_status_with_http_info(delete_old_mam_messages_status_request, opts = {}) ⇒ Array<(AbortDeleteOldMamMessages200Response, Integer, Hash)>

Status of delete old MAM messages operation.

Parameters:

Returns:



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
452
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 401

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

  # 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(delete_old_mam_messages_status_request)

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

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

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

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

Delete MAM messages older than DAYS.

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/purge_api.rb', line 273

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

  # 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(delete_old_mam_messages_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_old_messages(delete_old_messages_request, opts = {}) ⇒ nil

Delete offline messages older than DAYS.

Parameters:

Returns:

  • (nil) 


458
459
460
461
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 458

def delete_old_messages(delete_old_messages_request, opts = {})
  delete_old_messages_with_http_info(delete_old_messages_request, opts)
  nil
end

#delete_old_messages_batch(delete_old_messages_batch_request, opts = {}) ⇒ String

Delete offline messages older than DAYS.

Parameters:

Returns:

  • (String) 


522
523
524
525
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 522

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

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

Delete offline messages older than DAYS.

Parameters:

Returns:

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

    String data, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 531

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

  # 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(delete_old_messages_batch_request)

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

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

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

#delete_old_messages_status(delete_old_mam_messages_status_request, opts = {}) ⇒ AbortDeleteOldMamMessages200Response

Status of delete old offline messages operation.

Parameters:

Returns:



588
589
590
591
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 588

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

#delete_old_messages_status_with_http_info(delete_old_mam_messages_status_request, opts = {}) ⇒ Array<(AbortDeleteOldMamMessages200Response, Integer, Hash)>

Status of delete old offline messages operation.

Parameters:

Returns:



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 597

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

  # 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(delete_old_mam_messages_status_request)

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

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

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

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

Delete offline messages older than DAYS.

Parameters:

Returns:

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

    nil, response status code and response headers



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 467

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

  # 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(delete_old_messages_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_old_pubsub_items(delete_old_pubsub_items_request, opts = {}) ⇒ Integer

Keep only NUMBER of PubSub items per node.

Parameters:

Returns:

  • (Integer) 


654
655
656
657
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 654

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

#delete_old_pubsub_items_with_http_info(delete_old_pubsub_items_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>

Keep only NUMBER of PubSub items per node.

Parameters:

Returns:

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

    Integer data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 663

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

  # 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(delete_old_pubsub_items_request)

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

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

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

#delete_old_push_sessions(delete_old_messages_request, opts = {}) ⇒ Integer

Remove push sessions older than DAYS.

Parameters:

Returns:

  • (Integer) 


720
721
722
723
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 720

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

#delete_old_push_sessions_with_http_info(delete_old_messages_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>

Remove push sessions older than DAYS.

Parameters:

Returns:

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

    Integer data, response status code and response headers



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 729

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

  # 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(delete_old_messages_request)

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

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

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

#delete_old_users(delete_old_users_request, opts = {}) ⇒ String

Delete users that didn’t log in last days, or that never logged.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


786
787
788
789
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 786

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

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

Delete users that didn&#39;t log in last days, or that never logged.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/ejabberd_http_client/api/purge_api.rb', line 795

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

  # 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(delete_old_users_request)

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

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

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