Class: MailSlurpClient::DomainMonitorControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/domain_monitor_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainMonitorControllerApi

Returns a new instance of DomainMonitorControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_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/mailslurp_client/api/domain_monitor_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_domain_monitor(create_domain_monitor_options, opts = {}) ⇒ DomainMonitorDto

Create domain monitor

Parameters:

Returns:



26
27
28
29
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 26

def create_domain_monitor(create_domain_monitor_options, opts = {})
  data, _status_code, _headers = create_domain_monitor_with_http_info(create_domain_monitor_options, opts)
  data
end

#create_domain_monitor_alert_sink(monitor_id, create_domain_monitor_alert_sink_options, opts = {}) ⇒ DomainMonitorAlertSinkDto

Create alert sink for monitor

Parameters:

Returns:



89
90
91
92
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 89

def create_domain_monitor_alert_sink(monitor_id, create_domain_monitor_alert_sink_options, opts = {})
  data, _status_code, _headers = create_domain_monitor_alert_sink_with_http_info(monitor_id, create_domain_monitor_alert_sink_options, opts)
  data
end

#create_domain_monitor_alert_sink_with_http_info(monitor_id, create_domain_monitor_alert_sink_options, opts = {}) ⇒ Array<(DomainMonitorAlertSinkDto, Integer, Hash)>

Create alert sink for monitor

Parameters:

Returns:

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

    DomainMonitorAlertSinkDto data, 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
149
150
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 99

def create_domain_monitor_alert_sink_with_http_info(monitor_id, create_domain_monitor_alert_sink_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.create_domain_monitor_alert_sink ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.create_domain_monitor_alert_sink"
  end
  # verify the required parameter 'create_domain_monitor_alert_sink_options' is set
  if @api_client.config.client_side_validation && create_domain_monitor_alert_sink_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_domain_monitor_alert_sink_options' when calling DomainMonitorControllerApi.create_domain_monitor_alert_sink"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_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(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorAlertSinkDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#create_domain_monitor_with_http_info(create_domain_monitor_options, opts = {}) ⇒ Array<(DomainMonitorDto, Integer, Hash)>

Create domain monitor

Parameters:

Returns:

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

    DomainMonitorDto data, 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
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 35

def create_domain_monitor_with_http_info(create_domain_monitor_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.create_domain_monitor ...'
  end
  # verify the required parameter 'create_domain_monitor_options' is set
  if @api_client.config.client_side_validation && create_domain_monitor_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_domain_monitor_options' when calling DomainMonitorControllerApi.create_domain_monitor"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors'

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

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#delete_domain_monitor(monitor_id, opts = {}) ⇒ nil

Delete domain monitor

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


156
157
158
159
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 156

def delete_domain_monitor(monitor_id, opts = {})
  delete_domain_monitor_with_http_info(monitor_id, opts)
  nil
end

#delete_domain_monitor_alert_sink(monitor_id, sink_id, opts = {}) ⇒ nil

Delete monitor alert sink

Parameters:

  • monitor_id (String)
  • sink_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


215
216
217
218
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 215

def delete_domain_monitor_alert_sink(monitor_id, sink_id, opts = {})
  delete_domain_monitor_alert_sink_with_http_info(monitor_id, sink_id, opts)
  nil
end

#delete_domain_monitor_alert_sink_with_http_info(monitor_id, sink_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete monitor alert sink

Parameters:

  • monitor_id (String)
  • sink_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 225

def delete_domain_monitor_alert_sink_with_http_info(monitor_id, sink_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.delete_domain_monitor_alert_sink ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.delete_domain_monitor_alert_sink"
  end
  # verify the required parameter 'sink_id' is set
  if @api_client.config.client_side_validation && sink_id.nil?
    fail ArgumentError, "Missing the required parameter 'sink_id' when calling DomainMonitorControllerApi.delete_domain_monitor_alert_sink"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks/{sinkId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'sinkId' + '}', CGI.escape(sink_id.to_s))

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

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

Delete domain monitor

Parameters:

  • monitor_id (String)
  • 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
206
207
208
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 165

def delete_domain_monitor_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.delete_domain_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.delete_domain_monitor"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitor(monitor_id, opts = {}) ⇒ DomainMonitorDto

Get domain monitor

Parameters:

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

    the optional parameters

Returns:



278
279
280
281
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 278

def get_domain_monitor(monitor_id, opts = {})
  data, _status_code, _headers = get_domain_monitor_with_http_info(monitor_id, opts)
  data
end

#get_domain_monitor_alert_sinks(monitor_id, opts = {}) ⇒ Array<DomainMonitorAlertSinkDto>

List alert sinks for monitor

Parameters:

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

    the optional parameters

Returns:



338
339
340
341
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 338

def get_domain_monitor_alert_sinks(monitor_id, opts = {})
  data, _status_code, _headers = get_domain_monitor_alert_sinks_with_http_info(monitor_id, opts)
  data
end

#get_domain_monitor_alert_sinks_with_http_info(monitor_id, opts = {}) ⇒ Array<(Array<DomainMonitorAlertSinkDto>, Integer, Hash)>

List alert sinks for monitor

Parameters:

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

    the optional parameters

Returns:

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

    Array<DomainMonitorAlertSinkDto> data, response status code and response headers



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
387
388
389
390
391
392
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 347

def get_domain_monitor_alert_sinks_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_alert_sinks ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_alert_sinks"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<DomainMonitorAlertSinkDto>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitor_insights(monitor_id, opts = {}) ⇒ DomainMonitorInsightsDto

Get monitor insights

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)

Returns:



400
401
402
403
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 400

def get_domain_monitor_insights(monitor_id, opts = {})
  data, _status_code, _headers = get_domain_monitor_insights_with_http_info(monitor_id, opts)
  data
end

#get_domain_monitor_insights_with_http_info(monitor_id, opts = {}) ⇒ Array<(DomainMonitorInsightsDto, Integer, Hash)>

Get monitor insights

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)

Returns:

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

    DomainMonitorInsightsDto data, response status code and response headers



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
453
454
455
456
457
458
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 411

def get_domain_monitor_insights_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_insights ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_insights"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/insights'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorInsightsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitor_runs(monitor_id, opts = {}) ⇒ Array<DomainMonitorRunDto>

List monitor runs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)
  • :status (String)
  • :limit (Integer)

Returns:



468
469
470
471
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 468

def get_domain_monitor_runs(monitor_id, opts = {})
  data, _status_code, _headers = get_domain_monitor_runs_with_http_info(monitor_id, opts)
  data
end

#get_domain_monitor_runs_with_http_info(monitor_id, opts = {}) ⇒ Array<(Array<DomainMonitorRunDto>, Integer, Hash)>

List monitor runs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)
  • :status (String)
  • :limit (Integer)

Returns:

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

    Array<DomainMonitorRunDto> data, response status code and response headers



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
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 481

def get_domain_monitor_runs_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_runs ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_runs"
  end
  allowable_values = ["HEALTHY", "DEGRADED", "CRITICAL", "FAILED"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/runs'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<DomainMonitorRunDto>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitor_series(monitor_id, opts = {}) ⇒ DomainMonitorSeriesDto

Get monitor trend series

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)
  • :bucket (String) — default: default to 'DAY'

Returns:



543
544
545
546
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 543

def get_domain_monitor_series(monitor_id, opts = {})
  data, _status_code, _headers = get_domain_monitor_series_with_http_info(monitor_id, opts)
  data
end

#get_domain_monitor_series_with_http_info(monitor_id, opts = {}) ⇒ Array<(DomainMonitorSeriesDto, Integer, Hash)>

Get monitor trend series

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime)
  • :before (DateTime)
  • :bucket (String)

Returns:

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

    DomainMonitorSeriesDto data, response status code and response headers



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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 555

def get_domain_monitor_series_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_series ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_series"
  end
  allowable_values = ["HOUR", "DAY"]
  if @api_client.config.client_side_validation && opts[:'bucket'] && !allowable_values.include?(opts[:'bucket'])
    fail ArgumentError, "invalid value for \"bucket\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/series'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'bucket'] = opts[:'bucket'] if !opts[:'bucket'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorSeriesDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(DomainMonitorDto, Integer, Hash)>

Get domain monitor

Parameters:

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

    the optional parameters

Returns:

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

    DomainMonitorDto data, response status code and response headers



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
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 287

def get_domain_monitor_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#get_domain_monitors(opts = {}) ⇒ Array<DomainMonitorDto>

List domain monitors

Parameters:

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

    the optional parameters

Returns:



612
613
614
615
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 612

def get_domain_monitors(opts = {})
  data, _status_code, _headers = get_domain_monitors_with_http_info(opts)
  data
end

#get_domain_monitors_with_http_info(opts = {}) ⇒ Array<(Array<DomainMonitorDto>, Integer, Hash)>

List domain monitors

Parameters:

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

    the optional parameters

Returns:

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

    Array<DomainMonitorDto> data, response status code and response headers



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 620

def get_domain_monitors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitors ...'
  end
  # resource path
  local_var_path = '/domain-monitor/monitors'

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<DomainMonitorDto>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#run_domain_monitor_now(monitor_id, opts = {}) ⇒ DomainMonitorRunNowResult

Run monitor now

Parameters:

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

    the optional parameters

Returns:



667
668
669
670
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 667

def run_domain_monitor_now(monitor_id, opts = {})
  data, _status_code, _headers = run_domain_monitor_now_with_http_info(monitor_id, opts)
  data
end

#run_domain_monitor_now_with_http_info(monitor_id, opts = {}) ⇒ Array<(DomainMonitorRunNowResult, Integer, Hash)>

Run monitor now

Parameters:

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

    the optional parameters

Returns:

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

    DomainMonitorRunNowResult data, response status code and response headers



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/mailslurp_client/api/domain_monitor_controller_api.rb', line 676

def run_domain_monitor_now_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.run_domain_monitor_now ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.run_domain_monitor_now"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}/run-now'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorRunNowResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#run_due_domain_monitors(opts = {}) ⇒ DomainMonitorRunDueResult

Run due monitors for user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :max_runs (Integer)

Returns:



727
728
729
730
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 727

def run_due_domain_monitors(opts = {})
  data, _status_code, _headers = run_due_domain_monitors_with_http_info(opts)
  data
end

#run_due_domain_monitors_with_http_info(opts = {}) ⇒ Array<(DomainMonitorRunDueResult, Integer, Hash)>

Run due monitors for user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :max_runs (Integer)

Returns:

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

    DomainMonitorRunDueResult data, response status code and response headers



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
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 736

def run_due_domain_monitors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.run_due_domain_monitors ...'
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/run-due'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'maxRuns'] = opts[:'max_runs'] if !opts[:'max_runs'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorRunDueResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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

#update_domain_monitor(monitor_id, update_domain_monitor_options, opts = {}) ⇒ DomainMonitorDto

Update domain monitor

Parameters:

  • monitor_id (String)
  • update_domain_monitor_options (UpdateDomainMonitorOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



785
786
787
788
 
# File 'lib/mailslurp_client/api/domain_monitor_controller_api.rb', line 785

def update_domain_monitor(monitor_id, update_domain_monitor_options, opts = {})
  data, _status_code, _headers = update_domain_monitor_with_http_info(monitor_id, update_domain_monitor_options, opts)
  data
end

#update_domain_monitor_with_http_info(monitor_id, update_domain_monitor_options, opts = {}) ⇒ Array<(DomainMonitorDto, Integer, Hash)>

Update domain monitor

Parameters:

  • monitor_id (String)
  • update_domain_monitor_options (UpdateDomainMonitorOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    DomainMonitorDto 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/mailslurp_client/api/domain_monitor_controller_api.rb', line 795

def update_domain_monitor_with_http_info(monitor_id, update_domain_monitor_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.update_domain_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.update_domain_monitor"
  end
  # verify the required parameter 'update_domain_monitor_options' is set
  if @api_client.config.client_side_validation && update_domain_monitor_options.nil?
    fail ArgumentError, "Missing the required parameter 'update_domain_monitor_options' when calling DomainMonitorControllerApi.update_domain_monitor"
  end
  # resource path
  local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_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(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'DomainMonitorDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

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