Class: ElasticEmail::VerificationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/api/verifications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VerificationsApi

Returns a new instance of VerificationsApi.



19
20
21
 
# File 'lib/ElasticEmail/api/verifications_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/ElasticEmail/api/verifications_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#verifications_by_email_delete(email, opts = {}) ⇒ nil

Delete Email Verification Result Delete a result with given email if exists. Required Access Level: VerifyEmails

Parameters:

  • email (String) —

    Email address to verification

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 27

def verifications_by_email_delete(email, opts = {})
  verifications_by_email_delete_with_http_info(email, opts)
  nil
end

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

Delete Email Verification Result Delete a result with given email if exists. Required Access Level: VerifyEmails

Parameters:

  • email (String) —

    Email address to verification

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 37

def verifications_by_email_delete_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_by_email_delete ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling VerificationsApi.verifications_by_email_delete"
  end
  # resource path
  local_var_path = '/verifications/{email}'.sub('{' + 'email' + '}', CGI.escape(email.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#verifications_by_email_get(email, opts = {}) ⇒ EmailValidationResult

Get Email Verification Result Returns a result of verified email. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

  • email (String) —

    Email address to view verification result of

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 88

def verifications_by_email_get(email, opts = {})
  data, _status_code, _headers = verifications_by_email_get_with_http_info(email, opts)
  data
end

#verifications_by_email_get_with_http_info(email, opts = {}) ⇒ Array<(EmailValidationResult, Integer, Hash)>

Get Email Verification Result Returns a result of verified email. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

  • email (String) —

    Email address to view verification result of

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

    the optional parameters

Returns:

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

    EmailValidationResult data, response status code and response headers



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
141
142
143
144
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 98

def verifications_by_email_get_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_by_email_get ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling VerificationsApi.verifications_by_email_get"
  end
  # resource path
  local_var_path = '/verifications/{email}'.sub('{' + 'email' + '}', CGI.escape(email.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(['application/json'])

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

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

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

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

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

#verifications_by_email_post(email, opts = {}) ⇒ EmailValidationResult

Verify Email Verify single email address and returns result of verification. Required Access Level: VerifyEmails

Parameters:

  • email (String) —

    Email address to verify

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 151

def verifications_by_email_post(email, opts = {})
  data, _status_code, _headers = verifications_by_email_post_with_http_info(email, opts)
  data
end

#verifications_by_email_post_with_http_info(email, opts = {}) ⇒ Array<(EmailValidationResult, Integer, Hash)>

Verify Email Verify single email address and returns result of verification. Required Access Level: VerifyEmails

Parameters:

  • email (String) —

    Email address to verify

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

    the optional parameters

Returns:

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

    EmailValidationResult data, response status code and response headers



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

def verifications_by_email_post_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_by_email_post ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling VerificationsApi.verifications_by_email_post"
  end
  # resource path
  local_var_path = '/verifications/{email}'.sub('{' + 'email' + '}', CGI.escape(email.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(['application/json'])

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

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

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

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

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

#verifications_files_by_id_delete(id, opts = {}) ⇒ nil

Delete File Verification Result Delete Verification Results if they exist. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:

  • (nil) 


214
215
216
217
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 214

def verifications_files_by_id_delete(id, opts = {})
  verifications_files_by_id_delete_with_http_info(id, opts)
  nil
end

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

Delete File Verification Result Delete Verification Results if they exist. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
267
268
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 224

def verifications_files_by_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_by_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling VerificationsApi.verifications_files_by_id_delete"
  end
  # resource path
  local_var_path = '/verifications/files/{id}'.sub('{' + 'id' + '}', CGI.escape(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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#verifications_files_by_id_result_download_get(id, opts = {}) ⇒ File

Download File Verification Result Download verification results as a ZIP file. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    Verification ID to download

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

    the optional parameters

Returns:

  • (File) 


275
276
277
278
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 275

def verifications_files_by_id_result_download_get(id, opts = {})
  data, _status_code, _headers = verifications_files_by_id_result_download_get_with_http_info(id, opts)
  data
end

#verifications_files_by_id_result_download_get_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Download File Verification Result Download verification results as a ZIP file. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    Verification ID to download

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
323
324
325
326
327
328
329
330
331
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 285

def verifications_files_by_id_result_download_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_by_id_result_download_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling VerificationsApi.verifications_files_by_id_result_download_get"
  end
  # resource path
  local_var_path = '/verifications/files/{id}/result/download'.sub('{' + 'id' + '}', CGI.escape(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(['application/*'])

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

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

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

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

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

#verifications_files_by_id_result_get(id, opts = {}) ⇒ VerificationFileResultDetails

Get Detailed File Verification Result Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

  • id (String) —

    ID of the Verification to display status of

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned email verification results

  • :offset (Integer) —

    How many result items should be returned ahead

Returns:



340
341
342
343
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 340

def verifications_files_by_id_result_get(id, opts = {})
  data, _status_code, _headers = verifications_files_by_id_result_get_with_http_info(id, opts)
  data
end

#verifications_files_by_id_result_get_with_http_info(id, opts = {}) ⇒ Array<(VerificationFileResultDetails, Integer, Hash)>

Get Detailed File Verification Result Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

  • id (String) —

    ID of the Verification to display status of

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned email verification results

  • :offset (Integer) —

    How many result items should be returned ahead

Returns:



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
393
394
395
396
397
398
399
400
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 352

def verifications_files_by_id_result_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_by_id_result_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling VerificationsApi.verifications_files_by_id_result_get"
  end
  # resource path
  local_var_path = '/verifications/files/{id}/result'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#verifications_files_by_id_verification_post(id, opts = {}) ⇒ nil

Start verification Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    File ID to start verification

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

    the optional parameters

Returns:

  • (nil) 


407
408
409
410
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 407

def verifications_files_by_id_verification_post(id, opts = {})
  verifications_files_by_id_verification_post_with_http_info(id, opts)
  nil
end

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

Start verification Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails

Parameters:

  • id (String) —

    File ID to start verification

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
459
460
461
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 417

def verifications_files_by_id_verification_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_by_id_verification_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling VerificationsApi.verifications_files_by_id_verification_post"
  end
  # resource path
  local_var_path = '/verifications/files/{id}/verification'.sub('{' + 'id' + '}', CGI.escape(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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#verifications_files_post(opts = {}) ⇒ VerificationFileResult

Upload File with Emails Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



468
469
470
471
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 468

def verifications_files_post(opts = {})
  data, _status_code, _headers = verifications_files_post_with_http_info(opts)
  data
end

#verifications_files_post_with_http_info(opts = {}) ⇒ Array<(VerificationFileResult, Integer, Hash)>

Upload File with Emails Uploads a CSV file with list of emails that can then be triggered for verification. An &#39;email&#39; column is required. Required Access Level: VerifyEmails

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    VerificationFileResult data, response status code and response headers



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
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 478

def verifications_files_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_post ...'
  end
  # resource path
  local_var_path = '/verifications/files'

  # 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(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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

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

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

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

#verifications_files_result_get(opts = {}) ⇒ Array<VerificationFileResult>

Get Files Verification Results Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

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

    the optional parameters

Returns:



532
533
534
535
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 532

def verifications_files_result_get(opts = {})
  data, _status_code, _headers = verifications_files_result_get_with_http_info(opts)
  data
end

#verifications_files_result_get_with_http_info(opts = {}) ⇒ Array<(Array<VerificationFileResult>, Integer, Hash)>

Get Files Verification Results Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

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

    the optional parameters

Returns:

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

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



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
583
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 541

def verifications_files_result_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_result_get ...'
  end
  # resource path
  local_var_path = '/verifications/files/result'

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

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

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

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

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

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

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

#verifications_get(opts = {}) ⇒ Array<EmailValidationResult>

Get Emails Verification Results Returns a results of all verified single emails. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



591
592
593
594
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 591

def verifications_get(opts = {})
  data, _status_code, _headers = verifications_get_with_http_info(opts)
  data
end

#verifications_get_with_http_info(opts = {}) ⇒ Array<(Array<EmailValidationResult>, Integer, Hash)>

Get Emails Verification Results Returns a results of all verified single emails. Required Access Level: VerifyEmails, ViewEmailVerifications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

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



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
 
# File 'lib/ElasticEmail/api/verifications_api.rb', line 602

def verifications_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_get ...'
  end
  # resource path
  local_var_path = '/verifications'

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

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

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

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

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

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

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