class ElasticEmail::InboundRouteApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/ElasticEmail/api/inbound_route_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

inboundroute_by_id_delete(id, opts = {}) click to toggle source

Delete Route Deletes the Inbound Route. Required Access Level: ModifySettings @param id [String] @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

Delete Route Deletes the Inbound Route. Required Access Level: ModifySettings @param id [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

Get Route Load an Inbound Route. Required Access Level: ViewSettings @param id [String] ID number of your attachment @param [Hash] opts the optional parameters @return [InboundRoute]

# 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 = {}) click to toggle source

Get Route Load an Inbound Route. Required Access Level: ViewSettings @param id [String] ID number of your attachment @param [Hash] opts the optional parameters @return [Array<(InboundRoute, Integer, Hash)>] InboundRoute data, response status code and response headers

# 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 = {}) click to toggle source

Update Route Update the Inbound Route. Required Access Level: ModifySettings @param id [String] @param inbound_payload [InboundPayload] @param [Hash] opts the optional parameters @return [InboundRoute]

# 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 = {}) click to toggle source

Update Route Update the Inbound Route. Required Access Level: ModifySettings @param id [String] @param inbound_payload [InboundPayload] @param [Hash] opts the optional parameters @return [Array<(InboundRoute, Integer, Hash)>] InboundRoute data, response status code and response headers

# 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'
  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[: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 = {}) click to toggle source

Get Routes Get all your Inbound Routes. Required Access Level: ViewSettings @param [Hash] opts the optional parameters @return [Array<InboundRoute>]

# File lib/ElasticEmail/api/inbound_route_api.rb, line 221
def inboundroute_get(opts = {})
  data, _status_code, _headers = inboundroute_get_with_http_info(opts)
  data
end
inboundroute_get_with_http_info(opts = {}) click to toggle source

Get Routes Get all your Inbound Routes. Required Access Level: ViewSettings @param [Hash] opts the optional parameters @return [Array<(Array<InboundRoute>, Integer, Hash)>] Array<InboundRoute> data, response status code and response headers

# File lib/ElasticEmail/api/inbound_route_api.rb, line 230
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 = {}) click to toggle source

Update Sorting Required Access Level: ViewSettings @param sort_order_item [Array<SortOrderItem>] Change the ordering of inbound routes for when matching the inbound @param [Hash] opts the optional parameters @return [Array<InboundRoute>]

# File lib/ElasticEmail/api/inbound_route_api.rb, line 279
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 = {}) click to toggle source

Update Sorting Required Access Level: ViewSettings @param sort_order_item [Array<SortOrderItem>] Change the ordering of inbound routes for when matching the inbound @param [Hash] opts the optional parameters @return [Array<(Array<InboundRoute>, Integer, Hash)>] Array<InboundRoute> data, response status code and response headers

# File lib/ElasticEmail/api/inbound_route_api.rb, line 289
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'
  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[: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 = {}) click to toggle source

Create Route Create new Inbound Route. Required Access Level: ModifySettings @param inbound_payload [InboundPayload] @param [Hash] opts the optional parameters @return [InboundRoute]

# File lib/ElasticEmail/api/inbound_route_api.rb, line 344
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 = {}) click to toggle source

Create Route Create new Inbound Route. Required Access Level: ModifySettings @param inbound_payload [InboundPayload] @param [Hash] opts the optional parameters @return [Array<(InboundRoute, Integer, Hash)>] InboundRoute data, response status code and response headers

# File lib/ElasticEmail/api/inbound_route_api.rb, line 354
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'
  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[: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