Class: Klaviyo::Campaigns

Inherits:
Client
  • Object
show all
Defined in:
lib/klaviyo/apis/campaigns.rb

Constant Summary collapse

CANCEL = 
'cancel'
CAMPAIGN = 
'campaign'
CAMPAIGNS = 
'campaigns'
SEND = 
'send'

Constants inherited from Client

Klaviyo::Client::ALL, Klaviyo::Client::BASE_API_URL, Klaviyo::Client::CONTENT_JSON, Klaviyo::Client::CONTENT_URL_FORM, Klaviyo::Client::DEFAULT_COUNT, Klaviyo::Client::DEFAULT_PAGE, Klaviyo::Client::DEFAULT_SORT_DESC, Klaviyo::Client::HTTP_DELETE, Klaviyo::Client::HTTP_GET, Klaviyo::Client::HTTP_POST, Klaviyo::Client::HTTP_PUT, Klaviyo::Client::KL_USER_AGENT, Klaviyo::Client::KL_VERSION, Klaviyo::Client::METRIC, Klaviyo::Client::METRICS, Klaviyo::Client::TIMELINE, Klaviyo::Client::V1_API, Klaviyo::Client::V2_API

Class Method Summary collapse

Class Method Details

.cancel_campaign(campaign_id, api_key: nil) ⇒ JSON

Cancels the campaign with specified campaign_id

Parameters:

  • campaign_id (String) —

    the id of campaign

Returns:

  • (JSON) —

    a JSON object containing the campaign details



39
40
41
42
43
 
# File 'lib/klaviyo/apis/campaigns.rb', line 39

def self.cancel_campaign(campaign_id, api_key: nil)
  path = "#{CAMPAIGN}/#{campaign_id}/#{CANCEL}"

  v1_request(HTTP_POST, path, api_key: api_key)
end

.get_campaign_details(campaign_id, api_key: nil) ⇒ JSON

Retrieves the details of the list

Parameters:

  • campaign_id —

    the if of campaign

Returns:

  • (JSON) —

    a JSON object containing information about the campaign



19
20
21
22
23
 
# File 'lib/klaviyo/apis/campaigns.rb', line 19

def self.get_campaign_details(campaign_id, api_key: nil)
  path = "#{CAMPAIGN}/#{campaign_id}"

  v1_request(HTTP_GET, path, api_key: api_key)
end

.get_campaigns(api_key: nil) ⇒ List

Retrieves all the campaigns from Klaviyo account

Returns:

  • (List) —

    of JSON formatted campaing objects



11
12
13
 
# File 'lib/klaviyo/apis/campaigns.rb', line 11

def self.get_campaigns(api_key: nil)
  v1_request(HTTP_GET, CAMPAIGNS, api_key: api_key)
end

.send_campaign(campaign_id, api_key: nil) ⇒ Object

Sends the campaign immediately

Parameters:

  • campaign_id (String) —

    the id of campaign

Returns:

  • will return with HTTP ok in case of success



29
30
31
32
33
 
# File 'lib/klaviyo/apis/campaigns.rb', line 29

def self.send_campaign(campaign_id, api_key: nil)
  path = "#{CAMPAIGN}/#{campaign_id}/#{SEND}"

  v1_request(HTTP_POST, path, api_key: api_key)
end