Class: Listmonk::Resources::Campaigns

Inherits:
Listmonk::Resource show all
Defined in:
lib/listmonk/resources/campaigns.rb

Instance Method Summary collapse

Methods inherited from Listmonk::Resource

#initialize

Constructor Details

This class inherits a constructor from Listmonk::Resource

Instance Method Details

#analytics(type, **params) ⇒ Object



13
14
15
# File 'lib/listmonk/resources/campaigns.rb', line 13

def analytics(type, **params)
  get("campaigns/analytics/#{segment(type)}", params)
end

#cancel(id) ⇒ Object



23
# File 'lib/listmonk/resources/campaigns.rb', line 23

def cancel(id) = update_status(id, status: "cancelled")

#create(**attributes) ⇒ Object



7
# File 'lib/listmonk/resources/campaigns.rb', line 7

def create(**attributes) = post("campaigns", attributes)

#create_content(id, **attributes) ⇒ Object



29
# File 'lib/listmonk/resources/campaigns.rb', line 29

def create_content(id, **attributes) = post("campaigns/#{segment(id)}/content", attributes)

#delete(id) ⇒ Object



10
# File 'lib/listmonk/resources/campaigns.rb', line 10

def delete(id) = delete_request("campaigns/#{segment(id)}")

#list(**params) ⇒ Object



6
# File 'lib/listmonk/resources/campaigns.rb', line 6

def list(**params) = get("campaigns", params)

#pause(id) ⇒ Object



22
# File 'lib/listmonk/resources/campaigns.rb', line 22

def pause(id) = update_status(id, status: "paused")

#preview(id) ⇒ Object



17
# File 'lib/listmonk/resources/campaigns.rb', line 17

def preview(id) = get("campaigns/#{segment(id)}/preview")

#preview_text(id, **attributes) ⇒ Object



19
# File 'lib/listmonk/resources/campaigns.rb', line 19

def preview_text(id, **attributes) = post("campaigns/#{segment(id)}/text", attributes)

#retrieve(id) ⇒ Object



8
# File 'lib/listmonk/resources/campaigns.rb', line 8

def retrieve(id) = get("campaigns/#{segment(id)}")

#running_statsObject



11
# File 'lib/listmonk/resources/campaigns.rb', line 11

def running_stats = get("campaigns/running/stats")

#start(id) ⇒ Object



21
# File 'lib/listmonk/resources/campaigns.rb', line 21

def start(id) = update_status(id, status: "running")

#test(id, **attributes) ⇒ Object



30
# File 'lib/listmonk/resources/campaigns.rb', line 30

def test(id, **attributes) = post("campaigns/#{segment(id)}/test", attributes)

#update(id, **attributes) ⇒ Object



9
# File 'lib/listmonk/resources/campaigns.rb', line 9

def update(id, **attributes) = put("campaigns/#{segment(id)}", attributes)

#update_archive(id, archive:, **attributes) ⇒ Object



25
26
27
# File 'lib/listmonk/resources/campaigns.rb', line 25

def update_archive(id, archive:, **attributes)
  put("campaigns/#{segment(id)}/archive", attributes.merge(archive: archive))
end

#update_preview(id, **attributes) ⇒ Object



18
# File 'lib/listmonk/resources/campaigns.rb', line 18

def update_preview(id, **attributes) = post("campaigns/#{segment(id)}/preview", attributes)

#update_status(id, status:) ⇒ Object



20
# File 'lib/listmonk/resources/campaigns.rb', line 20

def update_status(id, status:) = put("campaigns/#{segment(id)}/status", status: status)