klaviyo 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b799e59210fdba2f42e88c903a4194f826590309e50650cbf360016bb0fd14e
-  data.tar.gz: df417c927034075c4894d2c186bc4f5a50ca2e26ed3e825a659adbd73f6524e6
+  metadata.gz: 438fe72ddfdd5e636f8026c8e0b02daf22586e58c4a2628065db088b633bb1be
+  data.tar.gz: c586d57114a208aa6843fa6dd218d2e2ceae454282c8b4b297a7ab122cd89dd3
 SHA512:
-  metadata.gz: 1ef1843515b936f2fd60b91dbd3d3cdaea780b56b49379134c04211c4609ad12ad1a296225fe576418bd93f0a437d88ec212c8b3f02fc6aa5289b5e39db7d5b1
-  data.tar.gz: e77f951331a55720f0f8f38a01d7ce51707f4cf316cd3eeeabc64739090ef1a41e5387e84b831bf703f3e19004bf35ec91d3b5e3e624bc94cec23fb4b1b6646f
+  metadata.gz: bce5653e39bc762647ee52f29a3c0b2d8ea672b782a5192e9ca3d3da11a41e388f67a5c11f7eb28ce7f274f691a445677ee345eb3855ba2fa422ed30407a282f
+  data.tar.gz: 5f831ad7a264a16b697435e1cafe6c942f7c58572bdf67041d74b3f65f398fd4ba948e0c70edbccb6d5839d16f0831553ce2868fe43b6b6fe796d9dfef2e2103

data/klaviyo.gemspec

@@ -2,8 +2,8 @@ files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
 
 Gem::Specification.new do |s|
   s.name        = 'klaviyo'
-  s.version     = '2.0.2'
-  s.date        = '2020-12-28'
+  s.version     = '2.0.3'
+  s.date        = '2021-01-11'
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
   s.description = 'Ruby wrapper for the Klaviyo API'
   s.authors     = ['Klaviyo Team']

data/lib/klaviyo/apis/campaigns.rb

@@ -0,0 +1,41 @@
+module Klaviyo
+  class Campaigns < Client
+    CANCEL = 'cancel'
+    CAMPAIGN = 'campaign'
+    CAMPAIGNS = 'campaigns'
+    SEND = 'send'
+
+     # Retrieves all the campaigns from Klaviyo account
+     # @return [List] of JSON formatted campaing objects
+    def self.get_campaigns()
+      v1_request(HTTP_GET, CAMPAIGNS)
+    end
+
+    # Retrieves the details of the list
+    # @param campaign_id the if of campaign
+    # @return [JSON] a JSON object containing information about the campaign
+    def self.get_campaign_details(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}"
+
+      v1_request(HTTP_GET, path)
+    end
+
+    # Sends the campaign immediately
+    # @param campaign_id [String] the id of campaign
+    # @return will return with HTTP ok in case of success
+    def self.send_campaign(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}/#{SEND}"
+
+      v1_request(HTTP_POST, path)
+    end
+
+    # Cancels the campaign with specified campaign_id
+    # @param campaign_id [String] the id of campaign
+    # @return [JSON] a JSON object containing the campaign details
+    def self.cancel_campaign(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}/#{CANCEL}"
+
+      v1_request(HTTP_POST, path)
+    end
+  end
+end

data/lib/klaviyo/klaviyo_module.rb

@@ -8,6 +8,7 @@ require_relative 'apis/public'
 require_relative 'apis/lists'
 require_relative 'apis/metrics'
 require_relative 'apis/profiles'
+require_relative 'apis/campaigns'
 
 module Klaviyo
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 files:
 - klaviyo.gemspec
 - lib/klaviyo.rb
+- lib/klaviyo/apis/campaigns.rb
 - lib/klaviyo/apis/lists.rb
 - lib/klaviyo/apis/metrics.rb
 - lib/klaviyo/apis/profiles.rb