Module: Mailblastr::Campaigns

Defined in:
lib/mailblastr/campaigns.rb

Overview

Campaigns are DOMAIN-FIRST: domain (required on create) picks the contact pool the campaign targets; from may be any verified domain.

Class Method Summary collapse

Class Method Details

.ab(campaign_id) ⇒ Object

A/B winner evaluation for an A/B campaign. GET /campaigns/:id/ab



47
48
49
 
# File 'lib/mailblastr/campaigns.rb', line 47

def ab(campaign_id)
  Client.request(:get, "/campaigns/#{Client.path_escape(campaign_id)}/ab")
end

.cancel(campaign_id) ⇒ Object

Cancel a scheduled campaign (returns it to draft). POST /campaigns/:id/cancel



37
38
39
 
# File 'lib/mailblastr/campaigns.rb', line 37

def cancel(campaign_id)
  Client.request(:post, "/campaigns/#{Client.path_escape(campaign_id)}/cancel")
end

.create(params) ⇒ Object

POST /campaigns Mailblastr::Campaigns.create({ domain: "yourdomain.com", from: "you@yourdomain.com", subject: "Hello", html: "

Hi

", segment_id: "seg_1" })



11
12
13
14
 
# File 'lib/mailblastr/campaigns.rb', line 11

def create(params)
  Client.require_domain!(params, "Campaigns.create")
  Client.request(:post, "/campaigns", body: params)
end

.delete(campaign_id) ⇒ Object

DELETE /campaigns/:id



52
53
54
 
# File 'lib/mailblastr/campaigns.rb', line 52

def delete(campaign_id)
  Client.request(:delete, "/campaigns/#{Client.path_escape(campaign_id)}")
end

.get(campaign_id) ⇒ Object

GET /campaigns/:id



17
18
19
 
# File 'lib/mailblastr/campaigns.rb', line 17

def get(campaign_id)
  Client.request(:get, "/campaigns/#{Client.path_escape(campaign_id)}")
end

.list(params = {}) ⇒ Object

GET /campaigns



22
23
24
 
# File 'lib/mailblastr/campaigns.rb', line 22

def list(params = {})
  Client.request(:get, "/campaigns", query: Client.pagination(params))
end

.send(campaign_id, params = {}) ⇒ Object

Send now, or schedule with { scheduled_at: "..." }. POST /campaigns/:id/send



32
33
34
 
# File 'lib/mailblastr/campaigns.rb', line 32

def send(campaign_id, params = {})
  Client.request(:post, "/campaigns/#{Client.path_escape(campaign_id)}/send", body: params)
end

.stats(campaign_id) ⇒ Object

Per-campaign analytics (counts, engagement rates, top links). GET /campaigns/:id/stats



42
43
44
 
# File 'lib/mailblastr/campaigns.rb', line 42

def stats(campaign_id)
  Client.request(:get, "/campaigns/#{Client.path_escape(campaign_id)}/stats")
end

.update(campaign_id, params) ⇒ Object

PATCH /campaigns/:id



27
28
29
 
# File 'lib/mailblastr/campaigns.rb', line 27

def update(campaign_id, params)
  Client.request(:patch, "/campaigns/#{Client.path_escape(campaign_id)}", body: params)
end