Module: Foursquare2::Campaigns
- Included in:
- Client
- Defined in:
- lib/foursquare2/campaigns.rb
Instance Method Summary collapse
-
#add_campaign(options = {}) ⇒ Object
Add a campaign Details on param options can be found at developer.foursquare.com/docs/campaigns/add.
-
#campaign(campaign_id) ⇒ Object
Retrieve information about a campaign.
-
#end_campaign(campaign_id) ⇒ Object
End a campaign Details on param can be found at developer.foursquare.com/docs/campaigns/end.
-
#list_campaigns(options = {}) ⇒ Object
Get a list of campaigns Details on param options can be found at developer.foursquare.com/docs/campaigns/list.
Instance Method Details
#add_campaign(options = {}) ⇒ Object
Add a campaign Details on param options can be found at developer.foursquare.com/docs/campaigns/add
24 25 26 27 28 29 |
# File 'lib/foursquare2/campaigns.rb', line 24 def add_campaign(={}) response = connection.post do |req| req.url "campaigns/add", end return_error_or_body(response, response.body.response.campaign) end |
#campaign(campaign_id) ⇒ Object
Retrieve information about a campaign
param [String] campaign_id The ID of the venue
7 8 9 10 |
# File 'lib/foursquare2/campaigns.rb', line 7 def campaign(campaign_id) response = connection.get("campaigns/#{campaign_id}") return_error_or_body(response, response.body.response.campaign) end |
#end_campaign(campaign_id) ⇒ Object
End a campaign Details on param can be found at developer.foursquare.com/docs/campaigns/end
55 56 57 58 59 60 |
# File 'lib/foursquare2/campaigns.rb', line 55 def end_campaign(campaign_id) response = connection.post do |req| req.url "campaigns/#{campaign_id}/end" end return_error_or_body(response, response.body.code) end |
#list_campaigns(options = {}) ⇒ Object
Get a list of campaigns Details on param options can be found at developer.foursquare.com/docs/campaigns/list
41 42 43 44 45 46 |
# File 'lib/foursquare2/campaigns.rb', line 41 def list_campaigns(={}) response = connection.get do |req| req.url "campaigns/list", end return_error_or_body(response, response.body.response.campaigns.items) end |