Class: Norbelys::SendersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/api/senders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SendersApi

Returns a new instance of SendersApi.



19
20
21
 
# File 'lib/norbelys/api/senders_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/norbelys/api/senders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#senders_bulk(bulk_update_senders_input, opts = {}) ⇒ BulkUpdateSendersResult

Bulk-update senders Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



28
29
30
31
 
# File 'lib/norbelys/api/senders_api.rb', line 28

def senders_bulk(bulk_update_senders_input, opts = {})
  data, _status_code, _headers = senders_bulk_with_http_info(bulk_update_senders_input, opts)
  data
end

#senders_bulk_with_http_info(bulk_update_senders_input, opts = {}) ⇒ Array<(BulkUpdateSendersResult, Integer, Hash)>

Bulk-update senders Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    BulkUpdateSendersResult data, 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
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/norbelys/api/senders_api.rb', line 39

def senders_bulk_with_http_info(bulk_update_senders_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_bulk ...'
  end
  # verify the required parameter 'bulk_update_senders_input' is set
  if @api_client.config.client_side_validation && bulk_update_senders_input.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_update_senders_input' when calling SendersApi.senders_bulk"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_bulk, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/senders/bulk'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#senders_create(create_sender_input, opts = {}) ⇒ Sender

Connect a sender Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



103
104
105
106
 
# File 'lib/norbelys/api/senders_api.rb', line 103

def senders_create(create_sender_input, opts = {})
  data, _status_code, _headers = senders_create_with_http_info(create_sender_input, opts)
  data
end

#senders_create_with_http_info(create_sender_input, opts = {}) ⇒ Array<(Sender, Integer, Hash)>

Connect a sender Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Sender data, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/norbelys/api/senders_api.rb', line 114

def senders_create_with_http_info(create_sender_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_create ...'
  end
  # verify the required parameter 'create_sender_input' is set
  if @api_client.config.client_side_validation && create_sender_input.nil?
    fail ArgumentError, "Missing the required parameter 'create_sender_input' when calling SendersApi.senders_create"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_create, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/senders'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#senders_find(id, opts = {}) ⇒ SenderDetail

Get a sender Return one mailbox. Use expand[]=usage to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and expand[]=warmup for the warmup config plus today's slot tally.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



178
179
180
181
 
# File 'lib/norbelys/api/senders_api.rb', line 178

def senders_find(id, opts = {})
  data, _status_code, _headers = senders_find_with_http_info(id, opts)
  data
end

#senders_find_with_http_info(id, opts = {}) ⇒ Array<(SenderDetail, Integer, Hash)>

Get a sender Return one mailbox. Use `expand=usage` to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and `expand=warmup` for the warmup config plus today's slot tally.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    SenderDetail data, response status code and response headers



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/norbelys/api/senders_api.rb', line 189

def senders_find_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_find ...'
  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 SendersApi.senders_find"
  end
  allowable_values = ["usage", "warmup"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !opts[:'expand'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"expand\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/senders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].nil?

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

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

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

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

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

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

#senders_list(opts = {}) ⇒ SenderList

List senders List the mailboxes (senders) on this workspace. Filter by search (matches fromName, fromEmail and clientLabel), state[], reputation[], or sendingDomainId; the page carries total for page / totalPages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)
  • :reputation (Array<String>)
  • :search (String)
  • :sending_domain_id (String)
  • :state (Array<String>)

Returns:



253
254
255
256
 
# File 'lib/norbelys/api/senders_api.rb', line 253

def senders_list(opts = {})
  data, _status_code, _headers = senders_list_with_http_info(opts)
  data
end

#senders_list_with_http_info(opts = {}) ⇒ Array<(SenderList, Integer, Hash)>

List senders List the mailboxes (senders) on this workspace. Filter by `search` (matches fromName, fromEmail and clientLabel), `state`, `reputation`, or `sendingDomainId`; the page carries `total` for page / totalPages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)
  • :reputation (Array<String>)
  • :search (String)
  • :sending_domain_id (String)
  • :state (Array<String>)

Returns:

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

    SenderList data, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/norbelys/api/senders_api.rb', line 269

def senders_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendersApi.senders_list, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendersApi.senders_list, must be greater than or equal to 1.'
  end

  allowable_values = ["good", "warning", "bad"]
  if @api_client.config.client_side_validation && opts[:'reputation'] && !opts[:'reputation'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"reputation\", must include one of #{allowable_values}"
  end
  allowable_values = ["healthy", "throttled", "paused"]
  if @api_client.config.client_side_validation && opts[:'state'] && !opts[:'state'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"state\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/senders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'reputation'] = @api_client.build_collection_param(opts[:'reputation'], :csv) if !opts[:'reputation'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'sendingDomainId'] = opts[:'sending_domain_id'] if !opts[:'sending_domain_id'].nil?
  query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :csv) if !opts[:'state'].nil?

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

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

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

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

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

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

#senders_remove(id, opts = {}) ⇒ SenderRemoveResult

Delete or archive a sender The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response's outcome says which happened. Archived mailboxes can be restored.

Parameters:

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

    the optional parameters

Returns:



341
342
343
344
 
# File 'lib/norbelys/api/senders_api.rb', line 341

def senders_remove(id, opts = {})
  data, _status_code, _headers = senders_remove_with_http_info(id, opts)
  data
end

#senders_remove_with_http_info(id, opts = {}) ⇒ Array<(SenderRemoveResult, Integer, Hash)>

Delete or archive a sender The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response's outcome says which happened. Archived mailboxes can be restored.

Parameters:

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

    the optional parameters

Returns:

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

    SenderRemoveResult data, response status code and response headers



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/norbelys/api/senders_api.rb', line 351

def senders_remove_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_remove ...'
  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 SendersApi.senders_remove"
  end
  # resource path
  local_var_path = '/senders/{id}'.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/json']) unless header_params['Accept']

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

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

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

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

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

#senders_restore(id, opts = {}) ⇒ Sender

Restore an archived sender Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



405
406
407
408
 
# File 'lib/norbelys/api/senders_api.rb', line 405

def senders_restore(id, opts = {})
  data, _status_code, _headers = senders_restore_with_http_info(id, opts)
  data
end

#senders_restore_with_http_info(id, opts = {}) ⇒ Array<(Sender, Integer, Hash)>

Restore an archived sender Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Sender data, response status code and response headers



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/norbelys/api/senders_api.rb', line 416

def senders_restore_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_restore ...'
  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 SendersApi.senders_restore"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_restore, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/senders/{id}/restore'.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/json']) unless header_params['Accept']
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#senders_update(id, opts = {}) ⇒ Sender

Update a sender Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



475
476
477
478
 
# File 'lib/norbelys/api/senders_api.rb', line 475

def senders_update(id, opts = {})
  data, _status_code, _headers = senders_update_with_http_info(id, opts)
  data
end

#senders_update_with_http_info(id, opts = {}) ⇒ Array<(Sender, Integer, Hash)>

Update a sender Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Sender 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/norbelys/api/senders_api.rb', line 486

def senders_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SendersApi.senders_update ...'
  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 SendersApi.senders_update"
  end
  # resource path
  local_var_path = '/senders/{id}'.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/json']) unless header_params['Accept']
  # 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(opts[:'update_sender_input'])

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

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

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