Class: Blueticks::Resources::CampaignsResource

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/blueticks/resources/campaigns.rb

Instance Attribute Summary

Attributes inherited from BaseResource

#client

Instance Method Summary collapse

Methods inherited from BaseResource

#initialize

Constructor Details

This class inherits a constructor from Blueticks::BaseResource

Instance Method Details

#cancel(campaign_id) ⇒ Object 



46
47
48
49
 
# File 'lib/blueticks/resources/campaigns.rb', line 46

def cancel(campaign_id)
  data = client.request("POST", "/v1/campaigns/#{campaign_id}/cancel")
  Types::Campaign.from_hash(data)
end

#create(name:, audience_id:, text: nil, media_url: nil, media_caption: nil, from: nil, on_missing_variable: nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/blueticks/resources/campaigns.rb', line 10

def create(name:, audience_id:, text: nil, media_url: nil, media_caption: nil,
           from: nil, on_missing_variable: nil)
  body = { "name" => name, "audience_id" => audience_id }
  body["text"] = text unless text.nil?
  body["media_url"] = media_url unless media_url.nil?
  body["media_caption"] = media_caption unless media_caption.nil?
  body["from"] = from unless from.nil?
  body["on_missing_variable"] = on_missing_variable unless on_missing_variable.nil?
  data = client.request("POST", "/v1/campaigns", body: body)
  Types::Campaign.from_hash(data)
end

#get(campaign_id) ⇒ Object 



31
32
33
34
 
# File 'lib/blueticks/resources/campaigns.rb', line 31

def get(campaign_id)
  data = client.request("GET", "/v1/campaigns/#{campaign_id}")
  Types::Campaign.from_hash(data)
end

#list(limit: nil, cursor: nil) ⇒ Object

List campaigns, newest first. Cursor-paginated.



23
24
25
26
27
28
29
 
# File 'lib/blueticks/resources/campaigns.rb', line 23

def list(limit: nil, cursor: nil)
  params = {}
  params["limit"] = limit unless limit.nil?
  params["cursor"] = cursor unless cursor.nil?
  data = client.request("GET", "/v1/campaigns", params: params.empty? ? nil : params)
  Types::Page.from_hash(data, item_type: Types::Campaign)
end

#pause(campaign_id) ⇒ Object 



36
37
38
39
 
# File 'lib/blueticks/resources/campaigns.rb', line 36

def pause(campaign_id)
  data = client.request("POST", "/v1/campaigns/#{campaign_id}/pause")
  Types::Campaign.from_hash(data)
end

#resume(campaign_id) ⇒ Object 



41
42
43
44
 
# File 'lib/blueticks/resources/campaigns.rb', line 41

def resume(campaign_id)
  data = client.request("POST", "/v1/campaigns/#{campaign_id}/resume")
  Types::Campaign.from_hash(data)
end