Class: MailSlurpClient::CampaignProbeControllerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CampaignProbeControllerApi

Returns a new instance of CampaignProbeControllerApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_campaign_probe(create_campaign_probe_options, opts = {}) ⇒ CampaignProbeDto

Create campaign probe

Parameters:

Returns:



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

def create_campaign_probe(create_campaign_probe_options, opts = {})
  data, _status_code, _headers = create_campaign_probe_with_http_info(create_campaign_probe_options, opts)
  data
end

#create_campaign_probe_with_http_info(create_campaign_probe_options, opts = {}) ⇒ Array<(CampaignProbeDto, Integer, Hash)>

Create campaign probe

Parameters:

Returns:

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

    CampaignProbeDto 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/campaign_probe_controller_api.rb', line 35

def create_campaign_probe_with_http_info(create_campaign_probe_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.create_campaign_probe ...'
  end
  # verify the required parameter 'create_campaign_probe_options' is set
  if @api_client.config.client_side_validation && create_campaign_probe_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_campaign_probe_options' when calling CampaignProbeControllerApi.create_campaign_probe"
  end
  # resource path
  local_var_path = '/campaign-probe/probes'

  # 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_campaign_probe_options) 

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

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

#delete_campaign_probe(probe_id, opts = {}) ⇒ nil

Delete campaign probe

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 88

def delete_campaign_probe(probe_id, opts = {})
  delete_campaign_probe_with_http_info(probe_id, opts)
  nil
end

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

Delete campaign probe

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 97

def delete_campaign_probe_with_http_info(probe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.delete_campaign_probe ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.delete_campaign_probe"
  end
  # resource path
  local_var_path = '/campaign-probe/probes/{probeId}'.sub('{' + 'probeId' + '}', CGI.escape(probe_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: CampaignProbeControllerApi#delete_campaign_probe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_probe(probe_id, opts = {}) ⇒ CampaignProbeDto

Get campaign probe

Parameters:

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 146

def get_campaign_probe(probe_id, opts = {})
  data, _status_code, _headers = get_campaign_probe_with_http_info(probe_id, opts)
  data
end

#get_campaign_probe_insights(probe_id, opts = {}) ⇒ CampaignProbeInsightsDto

Get campaign probe insights

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



208
209
210
211
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 208

def get_campaign_probe_insights(probe_id, opts = {})
  data, _status_code, _headers = get_campaign_probe_insights_with_http_info(probe_id, opts)
  data
end

#get_campaign_probe_insights_with_http_info(probe_id, opts = {}) ⇒ Array<(CampaignProbeInsightsDto, Integer, Hash)>

Get campaign probe insights

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    CampaignProbeInsightsDto data, response status code and response headers



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
259
260
261
262
263
264
265
266
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 219

def get_campaign_probe_insights_with_http_info(probe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probe_insights ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.get_campaign_probe_insights"
  end
  # resource path
  local_var_path = '/campaign-probe/probes/{probeId}/insights'.sub('{' + 'probeId' + '}', CGI.escape(probe_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] || 'CampaignProbeInsightsDto' 

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

#get_campaign_probe_runs(probe_id, opts = {}) ⇒ Array<CampaignProbeRunDto>

List campaign probe runs

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



276
277
278
279
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 276

def get_campaign_probe_runs(probe_id, opts = {})
  data, _status_code, _headers = get_campaign_probe_runs_with_http_info(probe_id, opts)
  data
end

#get_campaign_probe_runs_with_http_info(probe_id, opts = {}) ⇒ Array<(Array<CampaignProbeRunDto>, Integer, Hash)>

List campaign probe runs

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

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



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
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 289

def get_campaign_probe_runs_with_http_info(probe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probe_runs ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.get_campaign_probe_runs"
  end
  allowable_values = ["HEALTHY", "WARNING", "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 = '/campaign-probe/probes/{probeId}/runs'.sub('{' + 'probeId' + '}', CGI.escape(probe_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<CampaignProbeRunDto>' 

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

#get_campaign_probe_series(probe_id, opts = {}) ⇒ CampaignProbeSeriesDto

Get campaign probe trend series

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



351
352
353
354
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 351

def get_campaign_probe_series(probe_id, opts = {})
  data, _status_code, _headers = get_campaign_probe_series_with_http_info(probe_id, opts)
  data
end

#get_campaign_probe_series_with_http_info(probe_id, opts = {}) ⇒ Array<(CampaignProbeSeriesDto, Integer, Hash)>

Get campaign probe trend series

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    CampaignProbeSeriesDto data, response status code and response headers



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 363

def get_campaign_probe_series_with_http_info(probe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probe_series ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.get_campaign_probe_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 = '/campaign-probe/probes/{probeId}/series'.sub('{' + 'probeId' + '}', CGI.escape(probe_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] || 'CampaignProbeSeriesDto' 

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

#get_campaign_probe_with_http_info(probe_id, opts = {}) ⇒ Array<(CampaignProbeDto, Integer, Hash)>

Get campaign probe

Parameters:

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

    the optional parameters

Returns:

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

    CampaignProbeDto data, response status code and response headers



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
193
194
195
196
197
198
199
200
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 155

def get_campaign_probe_with_http_info(probe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probe ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.get_campaign_probe"
  end
  # resource path
  local_var_path = '/campaign-probe/probes/{probeId}'.sub('{' + 'probeId' + '}', CGI.escape(probe_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] || 'CampaignProbeDto' 

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

#get_campaign_probes(opts = {}) ⇒ Array<CampaignProbeDto>

List campaign probes

Parameters:

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

    the optional parameters

Returns:



420
421
422
423
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 420

def get_campaign_probes(opts = {})
  data, _status_code, _headers = get_campaign_probes_with_http_info(opts)
  data
end

#get_campaign_probes_with_http_info(opts = {}) ⇒ Array<(Array<CampaignProbeDto>, Integer, Hash)>

List campaign probes

Parameters:

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

    the optional parameters

Returns:

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

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



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
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 428

def get_campaign_probes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probes ...'
  end
  # resource path
  local_var_path = '/campaign-probe/probes'

  # 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<CampaignProbeDto>' 

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

#run_campaign_probe_now(probe_id, create_campaign_probe_run_options, opts = {}) ⇒ CampaignProbeRunNowResult

Run campaign probe now

Parameters:

Returns:



476
477
478
479
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 476

def run_campaign_probe_now(probe_id, create_campaign_probe_run_options, opts = {})
  data, _status_code, _headers = run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, opts)
  data
end

#run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, opts = {}) ⇒ Array<(CampaignProbeRunNowResult, Integer, Hash)>

Run campaign probe now

Parameters:

Returns:

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

    CampaignProbeRunNowResult data, response status code and response headers



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
535
536
537
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 486

def run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.run_campaign_probe_now ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.run_campaign_probe_now"
  end
  # verify the required parameter 'create_campaign_probe_run_options' is set
  if @api_client.config.client_side_validation && create_campaign_probe_run_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_campaign_probe_run_options' when calling CampaignProbeControllerApi.run_campaign_probe_now"
  end
  # resource path
  local_var_path = '/campaign-probe/probes/{probeId}/run-now'.sub('{' + 'probeId' + '}', CGI.escape(probe_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_campaign_probe_run_options) 

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

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

#run_due_campaign_probes(opts = {}) ⇒ CampaignProbeRunDueResult

Run due campaign probes for user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :max_runs (Integer)

Returns:



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

def run_due_campaign_probes(opts = {})
  data, _status_code, _headers = run_due_campaign_probes_with_http_info(opts)
  data
end

#run_due_campaign_probes_with_http_info(opts = {}) ⇒ Array<(CampaignProbeRunDueResult, Integer, Hash)>

Run due campaign probes for user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :max_runs (Integer)

Returns:

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

    CampaignProbeRunDueResult data, response status code and response headers



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 552

def run_due_campaign_probes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.run_due_campaign_probes ...'
  end
  # resource path
  local_var_path = '/campaign-probe/probes/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] || 'CampaignProbeRunDueResult' 

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

#update_campaign_probe(probe_id, update_campaign_probe_options, opts = {}) ⇒ CampaignProbeDto

Update campaign probe

Parameters:

  • probe_id (String)
  • update_campaign_probe_options (UpdateCampaignProbeOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



601
602
603
604
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 601

def update_campaign_probe(probe_id, update_campaign_probe_options, opts = {})
  data, _status_code, _headers = update_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, opts)
  data
end

#update_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, opts = {}) ⇒ Array<(CampaignProbeDto, Integer, Hash)>

Update campaign probe

Parameters:

  • probe_id (String)
  • update_campaign_probe_options (UpdateCampaignProbeOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    CampaignProbeDto data, response status code and response headers



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
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/mailslurp_client/api/campaign_probe_controller_api.rb', line 611

def update_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.update_campaign_probe ...'
  end
  # verify the required parameter 'probe_id' is set
  if @api_client.config.client_side_validation && probe_id.nil?
    fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.update_campaign_probe"
  end
  # verify the required parameter 'update_campaign_probe_options' is set
  if @api_client.config.client_side_validation && update_campaign_probe_options.nil?
    fail ArgumentError, "Missing the required parameter 'update_campaign_probe_options' when calling CampaignProbeControllerApi.update_campaign_probe"
  end
  # resource path
  local_var_path = '/campaign-probe/probes/{probeId}'.sub('{' + 'probeId' + '}', CGI.escape(probe_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_campaign_probe_options) 

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

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