Class: ElasticEmail::InboundRouteApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InboundRouteApi

Returns a new instance of InboundRouteApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete Route Deletes the Inbound Route. Required Access Level: ModifySettings

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def inboundroute_by_id_delete(id, opts = {})
  inboundroute_by_id_delete_with_http_info(id, opts)
  nil
end

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

Delete Route Deletes the Inbound Route. Required Access Level: ModifySettings

Parameters:

  • id (String)
  • 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/inbound_route_api.rb', line 37

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

#inboundroute_by_id_get(id, opts = {}) ⇒ InboundRoute

Get Route Load an Inbound Route. Required Access Level: ViewSettings

Parameters:

  • id (String) —

    ID number of your attachment

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

    the optional parameters

Returns:



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

def inboundroute_by_id_get(id, opts = {})
  data, _status_code, _headers = inboundroute_by_id_get_with_http_info(id, opts)
  data
end

#inboundroute_by_id_get_with_http_info(id, opts = {}) ⇒ Array<(InboundRoute, Integer, Hash)>

Get Route Load an Inbound Route. Required Access Level: ViewSettings

Parameters:

  • id (String) —

    ID number of your attachment

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

    the optional parameters

Returns:

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

    InboundRoute 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/inbound_route_api.rb', line 98

def inboundroute_by_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundRouteApi.inboundroute_by_id_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 InboundRouteApi.inboundroute_by_id_get"
  end
  # resource path
  local_var_path = '/inboundroute/{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'])

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

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

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

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

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

#inboundroute_by_id_put(id, inbound_payload, opts = {}) ⇒ InboundRoute

Update Route Update the Inbound Route. Required Access Level: ModifySettings

Parameters:

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 152

def inboundroute_by_id_put(id, inbound_payload, opts = {})
  data, _status_code, _headers = inboundroute_by_id_put_with_http_info(id, inbound_payload, opts)
  data
end

#inboundroute_by_id_put_with_http_info(id, inbound_payload, opts = {}) ⇒ Array<(InboundRoute, Integer, Hash)>

Update Route Update the Inbound Route. Required Access Level: ModifySettings

Parameters:

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

    the optional parameters

Returns:

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

    InboundRoute data, response status code and response headers



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
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 163

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

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

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

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

#inboundroute_get(opts = {}) ⇒ Array<InboundRoute>

Get Routes Get all your Inbound Routes. Required Access Level: ViewSettings

Parameters:

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 224

def inboundroute_get(opts = {})
  data, _status_code, _headers = inboundroute_get_with_http_info(opts)
  data
end

#inboundroute_get_with_http_info(opts = {}) ⇒ Array<(Array<InboundRoute>, Integer, Hash)>

Get Routes Get all your Inbound Routes. Required Access Level: ViewSettings

Parameters:

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

    the optional parameters

Returns:

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

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



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
269
270
271
272
273
274
275
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 233

def inboundroute_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundRouteApi.inboundroute_get ...'
  end
  # resource path
  local_var_path = '/inboundroute'

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

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

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

#inboundroute_order_put(sort_order_item, opts = {}) ⇒ Array<InboundRoute>

Update Sorting Required Access Level: ViewSettings

Parameters:

  • sort_order_item (Array<SortOrderItem>) —

    Change the ordering of inbound routes for when matching the inbound

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 282

def inboundroute_order_put(sort_order_item, opts = {})
  data, _status_code, _headers = inboundroute_order_put_with_http_info(sort_order_item, opts)
  data
end

#inboundroute_order_put_with_http_info(sort_order_item, opts = {}) ⇒ Array<(Array<InboundRoute>, Integer, Hash)>

Update Sorting Required Access Level: ViewSettings

Parameters:

  • sort_order_item (Array<SortOrderItem>) —

    Change the ordering of inbound routes for when matching the inbound

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

    the optional parameters

Returns:

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

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 292

def inboundroute_order_put_with_http_info(sort_order_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundRouteApi.inboundroute_order_put ...'
  end
  # verify the required parameter 'sort_order_item' is set
  if @api_client.config.client_side_validation && sort_order_item.nil?
    fail ArgumentError, "Missing the required parameter 'sort_order_item' when calling InboundRouteApi.inboundroute_order_put"
  end
  # resource path
  local_var_path = '/inboundroute/order'

  # 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(sort_order_item)

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

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

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

#inboundroute_post(inbound_payload, opts = {}) ⇒ InboundRoute

Create Route Create new Inbound Route. Required Access Level: ModifySettings

Parameters:

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 350

def inboundroute_post(inbound_payload, opts = {})
  data, _status_code, _headers = inboundroute_post_with_http_info(inbound_payload, opts)
  data
end

#inboundroute_post_with_http_info(inbound_payload, opts = {}) ⇒ Array<(InboundRoute, Integer, Hash)>

Create Route Create new Inbound Route. Required Access Level: ModifySettings

Parameters:

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

    the optional parameters

Returns:

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

    InboundRoute data, response status code and response headers



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
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ElasticEmail/api/inbound_route_api.rb', line 360

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

  # 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(inbound_payload)

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

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

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