Class: ElasticEmail::SecurityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SecurityApi

Returns a new instance of SecurityApi.



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

def api_client
  @api_client
end

Instance Method Details

#security_apikeys_by_name_delete(name, opts = {}) ⇒ nil

Delete ApiKey Delete your existing ApiKey. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKey should be deleted

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/ElasticEmail/api/security_api.rb', line 28

def security_apikeys_by_name_delete(name, opts = {})
  security_apikeys_by_name_delete_with_http_info(name, opts)
  nil
end

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

Delete ApiKey Delete your existing ApiKey. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKey should be deleted

Returns:

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

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ElasticEmail/api/security_api.rb', line 39

def security_apikeys_by_name_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_apikeys_by_name_delete ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_apikeys_by_name_delete"
  end
  # resource path
  local_var_path = '/security/apikeys/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

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

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

#security_apikeys_by_name_get(name, opts = {}) ⇒ ApiKey

Load ApiKey Load your existing ApiKey info. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKey should be loaded

Returns:



92
93
94
95
 
# File 'lib/ElasticEmail/api/security_api.rb', line 92

def security_apikeys_by_name_get(name, opts = {})
  data, _status_code, _headers = security_apikeys_by_name_get_with_http_info(name, opts)
  data
end

#security_apikeys_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(ApiKey, Integer, Hash)>

Load ApiKey Load your existing ApiKey info. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKey should be loaded

Returns:

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

    ApiKey data, response status code and response headers



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/ElasticEmail/api/security_api.rb', line 103

def security_apikeys_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_apikeys_by_name_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_apikeys_by_name_get"
  end
  # resource path
  local_var_path = '/security/apikeys/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subaccount'] = opts[:'subaccount'] if !opts[:'subaccount'].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] || 'ApiKey'

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

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

#security_apikeys_by_name_put(name, api_key_payload, opts = {}) ⇒ ApiKey

Update ApiKey Update your existing ApiKey. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/ElasticEmail/api/security_api.rb', line 158

def security_apikeys_by_name_put(name, api_key_payload, opts = {})
  data, _status_code, _headers = security_apikeys_by_name_put_with_http_info(name, api_key_payload, opts)
  data
end

#security_apikeys_by_name_put_with_http_info(name, api_key_payload, opts = {}) ⇒ Array<(ApiKey, Integer, Hash)>

Update ApiKey Update your existing ApiKey. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the ApiKey

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

    the optional parameters

Returns:

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

    ApiKey data, response status code and response headers



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/ElasticEmail/api/security_api.rb', line 169

def security_apikeys_by_name_put_with_http_info(name, api_key_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_apikeys_by_name_put ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_apikeys_by_name_put"
  end
  # verify the required parameter 'api_key_payload' is set
  if @api_client.config.client_side_validation && api_key_payload.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_payload' when calling SecurityApi.security_apikeys_by_name_put"
  end
  # resource path
  local_var_path = '/security/apikeys/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#security_apikeys_get(opts = {}) ⇒ Array<ApiKey>

List ApiKeys List all your existing ApiKeys. Required Access Level: Security

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKeys should be loaded

Returns:



231
232
233
234
 
# File 'lib/ElasticEmail/api/security_api.rb', line 231

def security_apikeys_get(opts = {})
  data, _status_code, _headers = security_apikeys_get_with_http_info(opts)
  data
end

#security_apikeys_get_with_http_info(opts = {}) ⇒ Array<(Array<ApiKey>, Integer, Hash)>

List ApiKeys List all your existing ApiKeys. Required Access Level: Security

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which ApiKeys should be loaded

Returns:

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

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



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
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ElasticEmail/api/security_api.rb', line 241

def security_apikeys_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_apikeys_get ...'
  end
  # resource path
  local_var_path = '/security/apikeys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subaccount'] = opts[:'subaccount'] if !opts[:'subaccount'].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<ApiKey>'

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

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

#security_apikeys_post(api_key_payload, opts = {}) ⇒ NewApiKey

Add ApiKey Add a new ApiKey. Required Access Level: Security

Parameters:

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/ElasticEmail/api/security_api.rb', line 291

def security_apikeys_post(api_key_payload, opts = {})
  data, _status_code, _headers = security_apikeys_post_with_http_info(api_key_payload, opts)
  data
end

#security_apikeys_post_with_http_info(api_key_payload, opts = {}) ⇒ Array<(NewApiKey, Integer, Hash)>

Add ApiKey Add a new ApiKey. Required Access Level: Security

Parameters:

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

    the optional parameters

Returns:

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

    NewApiKey data, response status code and response headers



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
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/ElasticEmail/api/security_api.rb', line 301

def security_apikeys_post_with_http_info(api_key_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_apikeys_post ...'
  end
  # verify the required parameter 'api_key_payload' is set
  if @api_client.config.client_side_validation && api_key_payload.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_payload' when calling SecurityApi.security_apikeys_post"
  end
  # resource path
  local_var_path = '/security/apikeys'

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

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

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

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

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

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

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

#security_smtp_by_name_delete(name, opts = {}) ⇒ nil

Delete SMTP Credential Delete your existing SMTP Credentials. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credential should be deleted

Returns:

  • (nil) 


360
361
362
363
 
# File 'lib/ElasticEmail/api/security_api.rb', line 360

def security_smtp_by_name_delete(name, opts = {})
  security_smtp_by_name_delete_with_http_info(name, opts)
  nil
end

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

Delete SMTP Credential Delete your existing SMTP Credentials. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credential should be deleted

Returns:

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

    nil, response status code and response headers



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
416
 
# File 'lib/ElasticEmail/api/security_api.rb', line 371

def security_smtp_by_name_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_smtp_by_name_delete ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_smtp_by_name_delete"
  end
  # resource path
  local_var_path = '/security/smtp/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

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

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

#security_smtp_by_name_get(name, opts = {}) ⇒ SmtpCredentials

Load SMTP Credential Load your existing SMTP Credential info. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credential should be loaded

Returns:



424
425
426
427
 
# File 'lib/ElasticEmail/api/security_api.rb', line 424

def security_smtp_by_name_get(name, opts = {})
  data, _status_code, _headers = security_smtp_by_name_get_with_http_info(name, opts)
  data
end

#security_smtp_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(SmtpCredentials, Integer, Hash)>

Load SMTP Credential Load your existing SMTP Credential info. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credential should be loaded

Returns:

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

    SmtpCredentials data, response status code and response headers



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
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/ElasticEmail/api/security_api.rb', line 435

def security_smtp_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_smtp_by_name_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_smtp_by_name_get"
  end
  # resource path
  local_var_path = '/security/smtp/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subaccount'] = opts[:'subaccount'] if !opts[:'subaccount'].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] || 'SmtpCredentials'

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

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

#security_smtp_by_name_put(name, smtp_credentials_payload, opts = {}) ⇒ SmtpCredentials

Update SMTP Credential Update your existing SMTP Credentials. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/ElasticEmail/api/security_api.rb', line 490

def security_smtp_by_name_put(name, smtp_credentials_payload, opts = {})
  data, _status_code, _headers = security_smtp_by_name_put_with_http_info(name, smtp_credentials_payload, opts)
  data
end

#security_smtp_by_name_put_with_http_info(name, smtp_credentials_payload, opts = {}) ⇒ Array<(SmtpCredentials, Integer, Hash)>

Update SMTP Credential Update your existing SMTP Credentials. Required Access Level: Security

Parameters:

  • name (String) —

    Name of the SMTP Credential

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

    the optional parameters

Returns:

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

    SmtpCredentials data, response status code and response headers



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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/ElasticEmail/api/security_api.rb', line 501

def security_smtp_by_name_put_with_http_info(name, smtp_credentials_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_smtp_by_name_put ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SecurityApi.security_smtp_by_name_put"
  end
  # verify the required parameter 'smtp_credentials_payload' is set
  if @api_client.config.client_side_validation && smtp_credentials_payload.nil?
    fail ArgumentError, "Missing the required parameter 'smtp_credentials_payload' when calling SecurityApi.security_smtp_by_name_put"
  end
  # resource path
  local_var_path = '/security/smtp/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#security_smtp_get(opts = {}) ⇒ Array<SmtpCredentials>

List SMTP Credentials List all your existing SMTP Credentials. Required Access Level: Security

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credentials should be listed

Returns:



563
564
565
566
 
# File 'lib/ElasticEmail/api/security_api.rb', line 563

def security_smtp_get(opts = {})
  data, _status_code, _headers = security_smtp_get_with_http_info(opts)
  data
end

#security_smtp_get_with_http_info(opts = {}) ⇒ Array<(Array<SmtpCredentials>, Integer, Hash)>

List SMTP Credentials List all your existing SMTP Credentials. Required Access Level: Security

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subaccount (String) —

    Email of the subaccount of which credentials should be listed

Returns:

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

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



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
608
609
610
611
612
613
614
615
616
 
# File 'lib/ElasticEmail/api/security_api.rb', line 573

def security_smtp_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_smtp_get ...'
  end
  # resource path
  local_var_path = '/security/smtp'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subaccount'] = opts[:'subaccount'] if !opts[:'subaccount'].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<SmtpCredentials>'

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

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

#security_smtp_post(smtp_credentials_payload, opts = {}) ⇒ NewSmtpCredentials

Add SMTP Credential Add new SMTP Credential. Required Access Level: Security

Parameters:

Returns:



623
624
625
626
 
# File 'lib/ElasticEmail/api/security_api.rb', line 623

def security_smtp_post(smtp_credentials_payload, opts = {})
  data, _status_code, _headers = security_smtp_post_with_http_info(smtp_credentials_payload, opts)
  data
end

#security_smtp_post_with_http_info(smtp_credentials_payload, opts = {}) ⇒ Array<(NewSmtpCredentials, Integer, Hash)>

Add SMTP Credential Add new SMTP Credential. Required Access Level: Security

Parameters:

Returns:

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

    NewSmtpCredentials data, response status code and response headers



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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/ElasticEmail/api/security_api.rb', line 633

def security_smtp_post_with_http_info(smtp_credentials_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecurityApi.security_smtp_post ...'
  end
  # verify the required parameter 'smtp_credentials_payload' is set
  if @api_client.config.client_side_validation && smtp_credentials_payload.nil?
    fail ArgumentError, "Missing the required parameter 'smtp_credentials_payload' when calling SecurityApi.security_smtp_post"
  end
  # resource path
  local_var_path = '/security/smtp'

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

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

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

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

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

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

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