Class: MailSlurpClient::InboxReplierControllerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InboxReplierControllerApi

Returns a new instance of InboxReplierControllerApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_new_inbox_replier(create_inbox_replier_options, opts = {}) ⇒ InboxReplierDto

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Parameters:

Returns:



27
28
29
30
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 27

def create_new_inbox_replier(create_inbox_replier_options, opts = {})
  data, _status_code, _headers = create_new_inbox_replier_with_http_info(create_inbox_replier_options, opts)
  data
end

#create_new_inbox_replier_with_http_info(create_inbox_replier_options, opts = {}) ⇒ Array<(InboxReplierDto, Integer, Hash)>

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Parameters:

Returns:

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

    InboxReplierDto data, 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
82
83
84
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 37

def create_new_inbox_replier_with_http_info(create_inbox_replier_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.create_new_inbox_replier ...'
  end
  # verify the required parameter 'create_inbox_replier_options' is set
  if @api_client.config.client_side_validation && create_inbox_replier_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_inbox_replier_options' when calling InboxReplierControllerApi.create_new_inbox_replier"
  end
  # resource path
  local_var_path = '/repliers'

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

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

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

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

Delete an inbox replier Delete inbox replier

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 91

def delete_inbox_replier(id, opts = {})
  delete_inbox_replier_with_http_info(id, opts)
  nil
end

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

Delete an inbox replier Delete inbox replier

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_inbox_replier_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.delete_inbox_replier ...'
  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 InboxReplierControllerApi.delete_inbox_replier"
  end
  # resource path
  local_var_path = '/repliers/{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[: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: InboxReplierControllerApi#delete_inbox_replier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_inbox_repliers(opts = {}) ⇒ nil

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to attach replier to

Returns:

  • (nil) 


151
152
153
154
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 151

def delete_inbox_repliers(opts = {})
  delete_inbox_repliers_with_http_info(opts)
  nil
end

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

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to attach replier to

Returns:

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

    nil, 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
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 161

def delete_inbox_repliers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.delete_inbox_repliers ...'
  end
  # resource path
  local_var_path = '/repliers'

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

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

#get_inbox_replier(id, opts = {}) ⇒ InboxReplierDto

Get an inbox replier Get inbox ruleset

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:



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

def get_inbox_replier(id, opts = {})
  data, _status_code, _headers = get_inbox_replier_with_http_info(id, opts)
  data
end

#get_inbox_replier_events(id, opts = {}) ⇒ PageInboxReplierEvents

Get an inbox replier event list Get inbox ruleset events

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox replier event list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox replier event list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to ‘ASC’)

Returns:



273
274
275
276
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 273

def get_inbox_replier_events(id, opts = {})
  data, _status_code, _headers = get_inbox_replier_events_with_http_info(id, opts)
  data
end

#get_inbox_replier_events_with_http_info(id, opts = {}) ⇒ Array<(PageInboxReplierEvents, Integer, Hash)>

Get an inbox replier event list Get inbox ruleset events

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox replier event list pagination

  • :size (Integer) —

    Optional page size in inbox replier event list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:

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

    PageInboxReplierEvents data, response status code and response headers



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
335
336
337
338
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 286

def get_inbox_replier_events_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_replier_events ...'
  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 InboxReplierControllerApi.get_inbox_replier_events"
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/repliers/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'PageInboxReplierEvents' 

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

#get_inbox_replier_with_http_info(id, opts = {}) ⇒ Array<(InboxReplierDto, Integer, Hash)>

Get an inbox replier Get inbox ruleset

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:

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

    InboxReplierDto data, response status code and response headers



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

def get_inbox_replier_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_replier ...'
  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 InboxReplierControllerApi.get_inbox_replier"
  end
  # resource path
  local_var_path = '/repliers/{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(['*/*'])

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

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

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

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

#get_inbox_repliers(opts = {}) ⇒ PageInboxReplierDto

List inbox repliers List all repliers attached to an inbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to get repliers from

  • :page (Integer) —

    Optional page index in inbox replier list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox replier list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to ‘ASC’)

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:



350
351
352
353
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 350

def get_inbox_repliers(opts = {})
  data, _status_code, _headers = get_inbox_repliers_with_http_info(opts)
  data
end

#get_inbox_repliers_with_http_info(opts = {}) ⇒ Array<(PageInboxReplierDto, Integer, Hash)>

List inbox repliers List all repliers attached to an inbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to get repliers from

  • :page (Integer) —

    Optional page index in inbox replier list pagination

  • :size (Integer) —

    Optional page size in inbox replier list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:

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

    PageInboxReplierDto data, response status code and response headers



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
416
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 365

def get_inbox_repliers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_repliers ...'
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/repliers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  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] || 'PageInboxReplierDto' 

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

#update_inbox_replier(id, update_inbox_replier_options, opts = {}) ⇒ InboxReplierDto

Update an inbox replier Update inbox ruleset

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:



424
425
426
427
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 424

def update_inbox_replier(id, update_inbox_replier_options, opts = {})
  data, _status_code, _headers = update_inbox_replier_with_http_info(id, update_inbox_replier_options, opts)
  data
end

#update_inbox_replier_with_http_info(id, update_inbox_replier_options, opts = {}) ⇒ Array<(InboxReplierDto, Integer, Hash)>

Update an inbox replier Update inbox ruleset

Parameters:

  • id (String) —

    ID of inbox replier

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

    the optional parameters

Returns:

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

    InboxReplierDto 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
483
484
485
486
 
# File 'lib/mailslurp_client/api/inbox_replier_controller_api.rb', line 435

def update_inbox_replier_with_http_info(id, update_inbox_replier_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.update_inbox_replier ...'
  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 InboxReplierControllerApi.update_inbox_replier"
  end
  # verify the required parameter 'update_inbox_replier_options' is set
  if @api_client.config.client_side_validation && update_inbox_replier_options.nil?
    fail ArgumentError, "Missing the required parameter 'update_inbox_replier_options' when calling InboxReplierControllerApi.update_inbox_replier"
  end
  # resource path
  local_var_path = '/repliers/{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(['*/*'])
  # 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_inbox_replier_options) 

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

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