class ElasticEmail::CampaignsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

campaigns_by_name_delete(name, opts = {}) click to toggle source

Delete Campaign Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns @param name [String] Name of Campaign to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/ElasticEmail/api/campaigns_api.rb, line 27
def campaigns_by_name_delete(name, opts = {})
  campaigns_by_name_delete_with_http_info(name, opts)
  nil
end
campaigns_by_name_delete_with_http_info(name, opts = {}) click to toggle source

Delete Campaign Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns @param name [String] Name of Campaign to delete @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/ElasticEmail/api/campaigns_api.rb, line 37
def campaigns_by_name_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_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 CampaignsApi.campaigns_by_name_delete"
  end
  # resource path
  local_var_path = '/campaigns/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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 => :"CampaignsApi.campaigns_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: CampaignsApi#campaigns_by_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
campaigns_by_name_get(name, opts = {}) click to toggle source

Load Campaign Returns the specified campaign details. Required Access Level: ViewCampaigns @param name [String] Name of Campaign to get @param [Hash] opts the optional parameters @return [Campaign]

# File lib/ElasticEmail/api/campaigns_api.rb, line 88
def campaigns_by_name_get(name, opts = {})
  data, _status_code, _headers = campaigns_by_name_get_with_http_info(name, opts)
  data
end
campaigns_by_name_get_with_http_info(name, opts = {}) click to toggle source

Load Campaign Returns the specified campaign details. Required Access Level: ViewCampaigns @param name [String] Name of Campaign to get @param [Hash] opts the optional parameters @return [Array<(Campaign, Integer, Hash)>] Campaign data, response status code and response headers

# File lib/ElasticEmail/api/campaigns_api.rb, line 98
def campaigns_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_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 CampaignsApi.campaigns_by_name_get"
  end
  # resource path
  local_var_path = '/campaigns/{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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"CampaignsApi.campaigns_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: CampaignsApi#campaigns_by_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
campaigns_by_name_put(name, campaign, opts = {}) click to toggle source

Update Campaign Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns @param name [String] Name of Campaign to update @param campaign [Campaign] JSON representation of a campaign @param [Hash] opts the optional parameters @return [Campaign]

# File lib/ElasticEmail/api/campaigns_api.rb, line 152
def campaigns_by_name_put(name, campaign, opts = {})
  data, _status_code, _headers = campaigns_by_name_put_with_http_info(name, campaign, opts)
  data
end
campaigns_by_name_put_with_http_info(name, campaign, opts = {}) click to toggle source

Update Campaign Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns @param name [String] Name of Campaign to update @param campaign [Campaign] JSON representation of a campaign @param [Hash] opts the optional parameters @return [Array<(Campaign, Integer, Hash)>] Campaign data, response status code and response headers

# File lib/ElasticEmail/api/campaigns_api.rb, line 163
def campaigns_by_name_put_with_http_info(name, campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_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 CampaignsApi.campaigns_by_name_put"
  end
  # verify the required parameter 'campaign' is set
  if @api_client.config.client_side_validation && campaign.nil?
    fail ArgumentError, "Missing the required parameter 'campaign' when calling CampaignsApi.campaigns_by_name_put"
  end
  # resource path
  local_var_path = '/campaigns/{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'
  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(campaign)

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

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

  new_options = opts.merge(
    :operation => :"CampaignsApi.campaigns_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: CampaignsApi#campaigns_by_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
campaigns_get(opts = {}) click to toggle source

Load Campaigns Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns @param [Hash] opts the optional parameters @option opts [String] :search Text fragment used for searching in Campaign name (using the &#39;contains&#39; rule) @option opts [Integer] :offset How many items should be returned ahead. @option opts [Integer] :limit Maximum number of returned items. @return [Array<Campaign>]

# File lib/ElasticEmail/api/campaigns_api.rb, line 224
def campaigns_get(opts = {})
  data, _status_code, _headers = campaigns_get_with_http_info(opts)
  data
end
campaigns_get_with_http_info(opts = {}) click to toggle source

Load Campaigns Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns @param [Hash] opts the optional parameters @option opts [String] :search Text fragment used for searching in Campaign name (using the &#39;contains&#39; rule) @option opts [Integer] :offset How many items should be returned ahead. @option opts [Integer] :limit Maximum number of returned items. @return [Array<(Array<Campaign>, Integer, Hash)>] Array<Campaign> data, response status code and response headers

# File lib/ElasticEmail/api/campaigns_api.rb, line 236
def campaigns_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_get ...'
  end
  # resource path
  local_var_path = '/campaigns'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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<Campaign>'

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

  new_options = opts.merge(
    :operation => :"CampaignsApi.campaigns_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: CampaignsApi#campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
campaigns_post(campaign, opts = {}) click to toggle source

Add Campaign Add a campaign for processing. Required Access Level: ModifyCampaigns @param campaign [Campaign] JSON representation of a campaign @param [Hash] opts the optional parameters @return [Campaign]

# File lib/ElasticEmail/api/campaigns_api.rb, line 288
def campaigns_post(campaign, opts = {})
  data, _status_code, _headers = campaigns_post_with_http_info(campaign, opts)
  data
end
campaigns_post_with_http_info(campaign, opts = {}) click to toggle source

Add Campaign Add a campaign for processing. Required Access Level: ModifyCampaigns @param campaign [Campaign] JSON representation of a campaign @param [Hash] opts the optional parameters @return [Array<(Campaign, Integer, Hash)>] Campaign data, response status code and response headers

# File lib/ElasticEmail/api/campaigns_api.rb, line 298
def campaigns_post_with_http_info(campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_post ...'
  end
  # verify the required parameter 'campaign' is set
  if @api_client.config.client_side_validation && campaign.nil?
    fail ArgumentError, "Missing the required parameter 'campaign' when calling CampaignsApi.campaigns_post"
  end
  # resource path
  local_var_path = '/campaigns'

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

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

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

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