createsend 5.1.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e3ed5e50f1be54bdb680b399675fef8e72fc1e09d41264ec35d85de005b0ea
-  data.tar.gz: 1b39dc69dcb31589101712316897771aa15ba48c8ddd5c6bd6255c2352337db3
+  metadata.gz: 1b2bb4cff071610599c8016946954e43a06069153feacda42c1ed0ec3f358e06
+  data.tar.gz: f3a2e2b67d20cc392b04b469a15b6d97ee1a7af65b9e5245a4d262047863164d
 SHA512:
-  metadata.gz: c9d44f747b5d4e64692686c47a0ca56f13d55fe97a0674cfc20659e05b8a518df3ac45f33ab8b575945b1ac9dd69fa503c0884cfb74abdbc3c0f306a0642f7a7
-  data.tar.gz: 68987336af46b08f9693bf65a1a6fc29af99ee81a044b1468b7a410084191a2e6973595ba1db86406be7c0c7cdace14a968e46e1f83754950bf3ef3a4c5e76a2
+  metadata.gz: 229d9c032d55f82c23fed36742e5186eb7e2e4c590e5b8acf9f9463aba53241b41ba31dd5be1ca342556876f0b5f1b69c52a54bff8b161c4018b1611e2145baa
+  data.tar.gz: 945dc9bc23760e17d1f4a47e155d3cb356e7539e61e0109f3c0324375cc2f05d2bc1224cfcdb382dfa745a2d667a2ead5b8897962de3e0f7504196baf92e065e

data/HISTORY.md

@@ -1,5 +1,22 @@
 # createsend-ruby history
 
+## v6.0.0 - 10 Feb, 2022
+* Upgrades to Createsend API v3.3 which includes new breaking changes
+* Breaking: 'client.campaigns' now returned an object to support pagination (use .Results to ge the array of campaigns)
+* Added 'Tags' as another field that is returned in 'client.scheduled', 'client.drafts' and 'client.campaigns'
+* Added 'Name' as another field that is returned in 'campaign.summary'
+* Add new support for 'client.tags' endpoint (ie: getting list of tags for the client)
+* Add support for pagination, filtering and sorting to 'client.campaigns' endpoint
+* Bump `rake` to `~> 12.3.3`
+* Adding support for returning ListJoinedDate for each subscriber. 
+  * List.Active()
+  * List.Bounced()
+  * List.Unsubscribed()
+  * List.Unconfirmed()
+  * List.Deleted()
+  * Segment.Subscribers()
+  * Subscriber.Get()
+
 ## v5.1.1 - 8 Oct, 2021
 * increased default timeout for HTTP requests to 120secs
 

data/README.md

@@ -133,7 +133,7 @@ clients.each do |cl|
   p "Client: #{cl.Name}"
   client = CreateSend::Client.new auth, cl.ClientID
   p "- Campaigns:"
-  client.campaigns.each do |cm|
+  client.drafts.each do |cm|
     p "  - #{cm.Subject}"
   end
 end

data/createsend.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '>= 1.0'
   s.add_runtime_dependency 'hashie', '~> 3.0'
   s.add_runtime_dependency 'httparty', '~> 0.14'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rake', '~> 12.3.3'
   s.add_development_dependency 'fakeweb', '~> 1.3'
   s.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
   s.add_development_dependency 'shoulda-context', '~> 1.2'

data/lib/createsend/client.rb

@@ -25,9 +25,19 @@ module CreateSend
     end
 
     # Gets the sent campaigns belonging to this client.
-    def campaigns
-      response = get 'campaigns'
-      response.map{|item| Hashie::Mash.new(item)}
+    def campaigns(page=1, page_size=1000, order_direction="desc",
+      sent_from_date='', sent_to_date='', tags='')
+      options = { :query => {
+        :page => page,
+        :pagesize => page_size,
+        :orderdirection => order_direction,
+        :sentfromdate => sent_from_date,
+        :senttodate => sent_to_date,
+        :tags => tags
+      }}
+
+      response = get 'campaigns', options
+      Hashie::Mash.new(response)
     end
 
     # Gets the currently scheduled campaigns belonging to this client.
@@ -42,6 +52,12 @@ module CreateSend
       response.map{|item| Hashie::Mash.new(item)}
     end
 
+    # Gets all the tags belonging to this client.
+    def tags
+      response = get 'tags'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
     # Gets the subscriber lists belonging to this client.
     def lists
       response = get 'lists'

data/lib/createsend/createsend.rb

@@ -111,7 +111,7 @@ module CreateSend
       end
     end
 
-    @@base_uri = "https://api.createsend.com/api/v3.2"
+    @@base_uri = "https://api.createsend.com/api/v3.3"
     @@oauth_base_uri = "https://api.createsend.com/oauth"
     @@oauth_token_uri = "#{@@oauth_base_uri}/token"
     headers({

data/lib/createsend/version.rb

@@ -1,3 +1,3 @@
 module CreateSend
-  VERSION = "5.1.1" unless defined?(CreateSend::VERSION)
+  VERSION = "6.0.0" unless defined?(CreateSend::VERSION)
 end

data/samples/authentication_sample.rb

@@ -0,0 +1,64 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class AuthorizationSample
+    def initialize
+        raise 'CREATESEND_API_KEY env var missing' if ENV['CREATESEND_API_KEY'].nil?
+        raise 'CREATESEND_CLIENT_ID env var missing' if ENV['CREATESEND_CLIENT_ID'].nil?
+        raise 'CREATESEND_OAUTH_CLIENT_ID env var missing' if ENV['CREATESEND_OAUTH_CLIENT_ID'].nil?
+        raise 'CREATESEND_OAUTH_CLIENT_SECRET env var missing' if ENV['CREATESEND_OAUTH_CLIENT_SECRET'].nil?
+        raise 'CREATESEND_OAUTH_REDIRECT_URL env var missing' if ENV['CREATESEND_OAUTH_REDIRECT_URL'].nil?
+        raise 'CREATESEND_OAUTH_SCOPE env var missing' if ENV['CREATESEND_OAUTH_SCOPE'].nil?
+       
+        @createsendApiKey = ENV['CREATESEND_API_KEY']
+        @oauthClientId = ENV['CREATESEND_OAUTH_CLIENT_ID']
+        @oauthClientSecret = ENV['CREATESEND_OAUTH_CLIENT_SECRET']
+        @oauthRedirectUrl = ENV['CREATESEND_OAUTH_REDIRECT_URL']
+        @oauthScope = ENV['CREATESEND_OAUTH_SCOPE']
+        )
+    end
+
+    def authentication_with_api_key
+        auth = {:api_key => @createsendApiKey}
+        @client = CreateSend::Client.new auth, @createsendClientId
+
+        @client.scheduled
+    end
+
+    def get_authorise_url
+        state = 'some state data'
+
+        @authorize_url = CreateSend::CreateSend.authorize_url(@oauthClientId, @oauthRedirectUrl, @oauthScope, state);
+    end
+
+    def exchange_token(code)
+        CreateSend::CreateSend.exchange_token(
+            client_id=@oauthClientId,
+            client_secret=@oauthClientSecret,
+            redirect_uri=@oauthRedirectUrl,
+            code=code # Get the code from the query string after hitting authorise url
+            )
+    end
+
+    def authentication_with_oauth(access_token, refresh_token)
+        auth = {:access_token => access_token, :refresh_token => refresh_token}
+        @client = CreateSend::Client.new auth, @createsendClientId
+
+        @client.scheduled
+    end
+end
+
+sample = AuthorizationSample.new
+authoriseUrl = sample.get_authorise_url
+# hit the authorise url, where you would be redirected and receive the code parameter in the query string
+access_token, expires_in, refresh_token = sample.exchange_token('code that you get once you hit authorize url')
+
+puts "Getting scheduled campaigns with api authentication: #{sample.authentication_with_api_key.to_json}\n\n"
+puts "Getting authorise url: #{authoriseUrl.to_json}\n\n"
+puts "Getting access_token: #{access_token.to_json}\n\n"
+puts "Getting scheduled campaigns with oauth authentication: #{sample.authentication_with_oauth(access_token, refresh_token).to_json}\n\n"
+
+
+        @client.scheduled
+    end
+end

data/samples/clients_sample.rb

@@ -0,0 +1,79 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class ClientsSample
+    def initialize
+        raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+        raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
+        raise 'CREATESEND_CLIENT_ID env var missing' if ENV['CREATESEND_CLIENT_ID'].nil?
+
+        auth = auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+        @client = CreateSend::Client.new auth, ENV['CREATESEND_CLIENT_ID']
+    end
+
+    def get_all_sent_campaigns
+        campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(page_number)
+            page_number += 1
+            campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        campaigns
+    end
+    
+    def get_sent_campaigns_with_tag_filter
+        filtered_campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(page_number, 1000, 'desc', '', '', 'tag_example, tag_example_2')
+            page_number += 1
+            filtered_campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        filtered_campaigns
+    end
+
+    def get_2021_sent_campaigns
+        2021_campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(1, 1000, 'desc', '2021-01-01', '2022-01-01', '')
+            page_number += 1
+            2021_campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        2021_campaigns
+    end
+
+    def get_all_scheduled_campaigns
+        @client.scheduled
+    end
+
+    def get_all_draft_campaigns
+        @client.drafts
+    end
+
+    def get_all_client_tags
+        @client.tags
+    end
+end
+
+sample = ClientsSample.new
+
+puts "All sent campaigns: #{sample.get_all_sent_campaigns.to_json}\n\n"
+puts "All sent campaigns with `tag_example` and `tag_example_2` tag: #{sample.get_sent_campaigns_with_tag_filter.to_json}\n\n"
+puts "All 2021 sent campaigns: #{sample.get_2021_sent_campaigns.to_json}\n\n"
+puts "All scheduled campaigns: #{sample.get_all_scheduled_campaigns.to_json}\n\n"
+puts "All draft campaigns: #{sample.get_all_draft_campaigns.to_json}\n\n"
+puts "All client tags: #{sample.get_all_client_tags.to_json}\n\n"

data/samples/journey_sample.rb

@@ -5,12 +5,13 @@ class JourneySample
   @date = "2019-01-01 00:00"
 
   def initialize
-    raise 'CREATESEND_API_KEY env var missing' if ENV['CREATESEND_API_KEY'].nil?
+    raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+    raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
     raise 'CREATESEND_CLIENT_ID env var missing' if ENV['CREATESEND_CLIENT_ID'].nil?
     raise 'CREATESEND_JOURNEY_ID env var missing' if ENV['CREATESEND_JOURNEY_ID'].nil?
     raise 'CREATESEND_EMAIL_ID env var missing' if ENV['CREATESEND_EMAIL_ID'].nil?
 
-    auth = {:api_key => ENV['CREATESEND_API_KEY']}
+    auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
     @client = CreateSend::Client.new auth, ENV['CREATESEND_CLIENT_ID']
     @journey = CreateSend::Journey.new auth, ENV['CREATESEND_JOURNEY_ID']
   end

data/samples/lists_sample.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class ListsSample
+    def initialize
+        raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+        raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
+        raise 'CREATESEND_LIST_ID env var missing' if ENV['CREATESEND_LIST_ID'].nil?
+
+        auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+        @list = CreateSend::List.new auth, ENV['CREATESEND_LIST_ID']
+    end
+
+    def get_active_subscribers
+        @list.active
+    end
+
+    def get_bounced_subscribers
+        @list.bounced
+    end
+
+    def get_unsubscribed_subscribers
+        @list.unsubscribed
+    end
+
+    def get_unconfirmed_subscribers
+        @list.unconfirmed
+    end
+
+    def get_deleted_subscribers
+        @list.deleted
+    end
+end
+
+sample = ListsSample.new
+
+puts "All active subscribers: #{sample.get_active_subscribers.to_json}\n\n"
+puts "All bounced subscribers: #{sample.get_bounced_subscribers.to_json}\n\n"
+puts "All unsubscribed subscribers: #{sample.get_unsubscribed_subscribers.to_json}\n\n"
+puts "All unconfirmed subscribers: #{sample.get_unconfirmed_subscribers.to_json}\n\n"
+puts "All deleted subscribers: #{sample.get_deleted_subscribers.to_json}\n\n"

data/samples/segments_sample.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class SegmentsSample
+    def initialize
+        raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+        raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
+        raise 'CREATESEND_SEGMENT_ID env var missing' if ENV['CREATESEND_SEGMENT_ID'].nil?
+
+        auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+        @segment = CreateSend::Segment.new auth, ENV['CREATESEND_SEGMENT_ID']
+    end
+
+    def get_active_subscribers
+        @segment.subscribers
+    end
+end
+
+sample = SegmentsSample.new
+
+puts "All active subscribers: #{sample.get_active_subscribers.to_json}\n\n"

data/samples/subscribes_sample.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class SubscribersSample
+    def initialize
+        raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+        raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
+        raise 'CREATESEND_LIST_ID env var missing' if ENV['CREATESEND_LIST_ID'].nil?
+        raise 'CREATESEND_EMAIL_ADDRESS env var missing' if ENV['CREATESEND_EMAIL_ADDRESS'].nil?
+
+        auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+        @subscriber = CreateSend::Subscriber.get auth, ENV['CREATESEND_LIST_ID'], ENV['CREATESEND_EMAIL_ADDRESS']
+    end
+
+    def get_subscriber
+        @subscriber
+    end
+end
+
+sample = SubscribersSample.new
+
+puts "detailed subscribers: #{sample.get_subscriber.to_json}\n\n"

data/test/campaign_test.rb

@@ -137,6 +137,7 @@ class CampaignTest < Test::Unit::TestCase
     should "get the summary for a campaign" do
       stub_get(@auth, "campaigns/#{@campaign.campaign_id}/summary.json", "campaign_summary.json")
       summary = @campaign.summary
+      summary.Name.should == "Campaign Name"
       summary.Recipients.should == 5
       summary.TotalOpened.should == 10
       summary.Clicks.should == 0

data/test/client_test.rb

@@ -26,51 +26,74 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all campaigns" do
-      stub_get(@auth, "clients/#{@client.client_id}/campaigns.json", "campaigns.json")
+      stub_get(@auth, "clients/#{@client.client_id}/campaigns.json?page=1&pagesize=1000&orderdirection=desc&sentfromdate=&senttodate=&tags=", "campaigns.json")
       campaigns = @client.campaigns
-      campaigns.size.should == 2
-      campaigns.first.CampaignID.should == 'fc0ce7105baeaf97f47c99be31d02a91'
-      campaigns.first.WebVersionURL.should == 'http://createsend.com/t/r-765E86829575EE2C'
-      campaigns.first.WebVersionTextURL.should == 'http://createsend.com/t/r-765E86829575EE2C/t'
-      campaigns.first.Subject.should == 'Campaign One'
-      campaigns.first.Name.should == 'Campaign One'
-      campaigns.first.SentDate.should == '2010-10-12 12:58:00'
-      campaigns.first.TotalRecipients.should == 2245
-      campaigns.first.FromName.should == 'My Name'
-      campaigns.first.FromEmail.should == 'myemail@example.com'
-      campaigns.first.ReplyTo.should == 'myemail@example.com'
+      campaigns.Results.size.should == 2
+      campaigns.ResultsOrderedBy == 'sentdate'
+      campaigns.OrderDirection = 'desc'
+      campaigns.PageNumber == 1
+      campaigns.PageSize == 1000
+      campaigns.RecordsOnThisPage == 2
+      campaigns.TotalNumberOfRecords == 2
+      campaigns.NumberOfPages == 1
+
+      campaign = campaigns.Results.first
+      campaign.CampaignID.should == 'fc0ce7105baeaf97f47c99be31d02a91'
+      campaign.WebVersionURL.should == 'http://createsend.com/t/r-765E86829575EE2C'
+      campaign.WebVersionTextURL.should == 'http://createsend.com/t/r-765E86829575EE2C/t'
+      campaign.Subject.should == 'Campaign One'
+      campaign.Name.should == 'Campaign One'
+      campaign.SentDate.should == '2010-10-12 12:58:00'
+      campaign.TotalRecipients.should == 2245
+      campaign.FromName.should == 'My Name'
+      campaign.FromEmail.should == 'myemail@example.com'
+      campaign.ReplyTo.should == 'myemail@example.com'
+      campaign.Tags.should == []
     end
 
     should "get scheduled campaigns" do
       stub_get(@auth, "clients/#{@client.client_id}/scheduled.json", "scheduled_campaigns.json")
       campaigns = @client.scheduled
       campaigns.size.should == 2
-      campaigns.first.DateScheduled.should == "2011-05-25 10:40:00"
-      campaigns.first.ScheduledTimeZone.should == "(GMT+10:00) Canberra, Melbourne, Sydney"
-      campaigns.first.CampaignID.should == "827dbbd2161ea9989fa11ad562c66937"
-      campaigns.first.Name.should == "Magic Issue One"
-      campaigns.first.Subject.should == "Magic Issue One"
-      campaigns.first.DateCreated.should == "2011-05-24 10:37:00"
-      campaigns.first.PreviewURL.should == "http://createsend.com/t/r-DD543521A87C9B8B"
-      campaigns.first.PreviewTextURL.should == "http://createsend.com/t/r-DD543521A87C9B8B/t"
-      campaigns.first.FromName.should == 'My Name'
-      campaigns.first.FromEmail.should == 'myemail@example.com'
-      campaigns.first.ReplyTo.should == 'myemail@example.com'
+      campaign = campaigns.first
+      campaign.DateScheduled.should == "2011-05-25 10:40:00"
+      campaign.ScheduledTimeZone.should == "(GMT+10:00) Canberra, Melbourne, Sydney"
+      campaign.CampaignID.should == "827dbbd2161ea9989fa11ad562c66937"
+      campaign.Name.should == "Magic Issue One"
+      campaign.Subject.should == "Magic Issue One"
+      campaign.DateCreated.should == "2011-05-24 10:37:00"
+      campaign.PreviewURL.should == "http://createsend.com/t/r-DD543521A87C9B8B"
+      campaign.PreviewTextURL.should == "http://createsend.com/t/r-DD543521A87C9B8B/t"
+      campaign.FromName.should == 'My Name'
+      campaign.FromEmail.should == 'myemail@example.com'
+      campaign.ReplyTo.should == 'myemail@example.com'
+      campaign.Tags.should == ['tagexample']
     end
 
     should "get all drafts" do
       stub_get(@auth, "clients/#{@client.client_id}/drafts.json", "drafts.json")
       drafts = @client.drafts
       drafts.size.should == 2
-      drafts.first.CampaignID.should == '7c7424792065d92627139208c8c01db1'
-      drafts.first.Name.should == 'Draft One'
-      drafts.first.Subject.should == 'Draft One'
-      drafts.first.DateCreated.should == '2010-08-19 16:08:00'
-      drafts.first.PreviewURL.should == 'http://createsend.com/t/r-E97A7BB2E6983DA1'
-      drafts.first.PreviewTextURL.should == 'http://createsend.com/t/r-E97A7BB2E6983DA1/t'
-      drafts.first.FromName.should == 'My Name'
-      drafts.first.FromEmail.should == 'myemail@example.com'
-      drafts.first.ReplyTo.should == 'myemail@example.com'
+      draft = drafts.first
+      draft.CampaignID.should == '7c7424792065d92627139208c8c01db1'
+      draft.Name.should == 'Draft One'
+      draft.Subject.should == 'Draft One'
+      draft.DateCreated.should == '2010-08-19 16:08:00'
+      draft.PreviewURL.should == 'http://createsend.com/t/r-E97A7BB2E6983DA1'
+      draft.PreviewTextURL.should == 'http://createsend.com/t/r-E97A7BB2E6983DA1/t'
+      draft.FromName.should == 'My Name'
+      draft.FromEmail.should == 'myemail@example.com'
+      draft.ReplyTo.should == 'myemail@example.com'
+      draft.Tags.should == ['tagexample']
+    end
+
+    should "get all client tags" do
+      stub_get(@auth, "clients/#{@client.client_id}/tags.json", "tags.json")
+      tags = @client.tags
+      tags.size.should == 2
+      tag = tags.first
+      tag.Name.should == 'Tag One'
+      tag.NumberOfCampaigns.should == '120'
     end
 
     should "get all lists" do

data/test/fixtures/active_subscribers.json

@@ -4,6 +4,7 @@
       "EmailAddress": "subs+7t8787Y@example.com",
       "Name": "Person One",
       "Date": "2010-10-25 10:28:00",
+      "ListJoinedDate": "2010-10-25 10:28:00",
       "State": "Active",
       "CustomFields": [
         {
@@ -33,6 +34,7 @@
       "EmailAddress": "subs+7878787y8ggg@example.com",
       "Name": "Person Two",
       "Date": "2010-10-25 12:17:00",
+      "ListJoinedDate": "2010-10-25 12:17:00",
       "State": "Active",
       "CustomFields": [
         {
@@ -46,6 +48,7 @@
       "EmailAddress": "subs+7890909i0ggg@example.com",
       "Name": "Person Three",
       "Date": "2010-10-25 12:52:00",
+      "ListJoinedDate": "2010-10-25 12:52:00",
       "State": "Active",
       "CustomFields": [
         {
@@ -59,6 +62,7 @@
       "EmailAddress": "subs@example.com",
       "Name": "Person Four",
       "Date": "2010-10-27 13:13:00",
+      "ListJoinedDate": "2010-10-27 13:13:00",
       "State": "Active",
       "CustomFields": [],
       "ReadsEmailWith": ""
@@ -67,6 +71,7 @@
       "EmailAddress": "joey@example.com",
       "Name": "Person Five",
       "Date": "2010-10-27 13:13:00",
+      "ListJoinedDate": "2010-10-27 13:13:00",
       "State": "Active",
       "CustomFields": [],
       "ReadsEmailWith": "Gmail"

data/test/fixtures/bounced_subscribers.json

@@ -4,6 +4,7 @@
       "EmailAddress": "bouncedsubscriber@example.com",
       "Name": "Bounced One",
       "Date": "2010-10-25 13:11:00",
+      "ListJoinedDate": "2010-10-25 13:11:00",
       "State": "Bounced",
       "CustomFields": [],
       "ReadsEmailWith": ""

data/test/fixtures/campaign_summary.json

@@ -11,5 +11,6 @@
   "WebVersionURL": "http://createsend.com/t/r-3A433FC72FFE3B8B",
   "WebVersionTextURL": "http://createsend.com/t/r-3A433FC72FFE3B8B/t",
   "WorldviewURL": "http://client.createsend.com/reports/wv/r/3A433FC72FFE3B8B",
-  "SpamComplaints": 23
+  "SpamComplaints": 23,
+  "Name": "Campaign Name"
 }

data/test/fixtures/campaigns.json

@@ -1,26 +1,37 @@
-[
-  {
-    "WebVersionURL": "http://createsend.com/t/r-765E86829575EE2C",
-    "WebVersionTextURL": "http://createsend.com/t/r-765E86829575EE2C/t",
-    "CampaignID": "fc0ce7105baeaf97f47c99be31d02a91",
-    "Subject": "Campaign One",
-    "Name": "Campaign One",
-    "FromName": "My Name",
-    "FromEmail": "myemail@example.com",
-    "ReplyTo": "myemail@example.com",
-    "SentDate": "2010-10-12 12:58:00",
-    "TotalRecipients": 2245
-  },
-  {
-    "WebVersionURL": "http://createsend.com/t/r-DD543566A87C9B8B",
-    "WebVersionTextURL": "http://createsend.com/t/r-DD543566A87C9B8B/t",
-    "CampaignID": "072472b88c853ae5dedaeaf549a8d607",
-    "Subject": "Campaign Two",
-    "Name": "Campaign Two",
-    "FromName": "My Name",
-    "FromEmail": "myemail@example.com",
-    "ReplyTo": "myemail@example.com",
-    "SentDate": "2010-10-06 16:20:00",
-    "TotalRecipients": 11222
-  }
-]
+{
+  "Results": [
+    {
+      "WebVersionURL": "http://createsend.com/t/r-765E86829575EE2C",
+      "WebVersionTextURL": "http://createsend.com/t/r-765E86829575EE2C/t",
+      "CampaignID": "fc0ce7105baeaf97f47c99be31d02a91",
+      "Subject": "Campaign One",
+      "Name": "Campaign One",
+      "FromName": "My Name",
+      "FromEmail": "myemail@example.com",
+      "ReplyTo": "myemail@example.com",
+      "SentDate": "2010-10-12 12:58:00",
+      "TotalRecipients": 2245,
+      "Tags": []
+    },
+    {
+      "WebVersionURL": "http://createsend.com/t/r-DD543566A87C9B8B",
+      "WebVersionTextURL": "http://createsend.com/t/r-DD543566A87C9B8B/t",
+      "CampaignID": "072472b88c853ae5dedaeaf549a8d607",
+      "Subject": "Campaign Two",
+      "Name": "Campaign Two",
+      "FromName": "My Name",
+      "FromEmail": "myemail@example.com",
+      "ReplyTo": "myemail@example.com",
+      "SentDate": "2010-10-06 16:20:00",
+      "TotalRecipients": 11222,
+      "Tags": ["tagexample"]
+    }
+  ],
+  "ResultsOrderedBy": "sentdate",
+  "OrderDirection": "desc",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 2,
+  "TotalNumberOfRecords": 2,
+  "NumberOfPages": 1
+}

data/test/fixtures/deleted_subscribers.json

@@ -4,6 +4,7 @@
       "EmailAddress": "subscriber@example.com",
       "Name": "Deleted One",
       "Date": "2010-10-25 13:11:00",
+      "ListJoinedDate": "2010-10-25 13:11:00",
       "State": "Deleted",
       "CustomFields": [],
       "ReadsEmailWith": "Gmail"
@@ -12,6 +13,7 @@
       "EmailAddress": "subscriberone@example.com",
       "Name": "Subscriber",
       "Date": "2010-10-25 13:04:00",
+      "ListJoinedDate": "2010-10-25 13:04:00",
       "State": "Deleted",
       "CustomFields": [
         {
@@ -25,6 +27,7 @@
       "EmailAddress": "example+1@example.com",
       "Name": "Example One",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Deleted",
       "CustomFields": [],
       "ReadsEmailWith": ""
@@ -33,6 +36,7 @@
       "EmailAddress": "example+2@example.com",
       "Name": "Example Two",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Deleted",
       "CustomFields": [],
       "ReadsEmailWith": ""
@@ -41,6 +45,7 @@
       "EmailAddress": "example+3@example.com",
       "Name": "Example Three",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Deleted",
       "CustomFields": [],
       "ReadsEmailWith": "Gmail"

data/test/fixtures/drafts.json

@@ -8,7 +8,8 @@
     "ReplyTo": "myemail@example.com",
     "DateCreated": "2010-08-19 16:08:00",
     "PreviewURL": "http://createsend.com/t/r-E97A7BB2E6983DA1",
-    "PreviewTextURL": "http://createsend.com/t/r-E97A7BB2E6983DA1/t"
+    "PreviewTextURL": "http://createsend.com/t/r-E97A7BB2E6983DA1/t",
+    "Tags": ["tagexample"]
   },
   {
     "CampaignID": "2e928e982065d92627139208c8c01db1",
@@ -19,6 +20,7 @@
     "ReplyTo": "myemail@example.com",
     "DateCreated": "2010-08-19 16:08:00",
     "PreviewURL": "http://createsend.com/t/r-E97A7BB2E6983DA1",
-    "PreviewTextURL": "http://createsend.com/t/r-E97A7BB2E6983DA1/t"
+    "PreviewTextURL": "http://createsend.com/t/r-E97A7BB2E6983DA1/t",
+    "Tags": []
   }
 ]

data/test/fixtures/scheduled_campaigns.json

@@ -10,7 +10,8 @@
     "ReplyTo": "myemail@example.com",
     "DateCreated": "2011-05-24 10:37:00",
     "PreviewURL": "http://createsend.com/t/r-DD543521A87C9B8B",
-    "PreviewTextURL": "http://createsend.com/t/r-DD543521A87C9B8B/t"
+    "PreviewTextURL": "http://createsend.com/t/r-DD543521A87C9B8B/t",
+    "Tags": ["tagexample"]
   },
   {
     "DateScheduled": "2011-05-29 11:20:00",
@@ -23,6 +24,7 @@
     "ReplyTo": "myemail@example.com",
     "DateCreated": "2011-05-24 10:39:00",
     "PreviewURL": "http://createsend.com/t/r-DD913521A87C9B8B",
-    "PreviewTextURL": "http://createsend.com/t/r-DD913521A87C9B8B/t"
+    "PreviewTextURL": "http://createsend.com/t/r-DD913521A87C9B8B/t",
+    "Tags": []
   }
 ]

data/test/fixtures/segment_subscribers.json

@@ -4,6 +4,7 @@
       "EmailAddress": "personone@example.com",
       "Name": "Person One",
       "Date": "2010-10-27 13:13:00",
+      "ListJoinedDate": "2010-10-27 13:13:00",
       "State": "Active",
       "CustomFields": []
     },
@@ -11,6 +12,7 @@
       "EmailAddress": "persontwo@example.com",
       "Name": "Person Two",
       "Date": "2010-10-27 13:13:00",
+      "ListJoinedDate": "2010-10-27 13:13:00",
       "State": "Active",
       "CustomFields": []
     }

data/test/fixtures/subscriber_details.json

@@ -2,6 +2,7 @@
   "EmailAddress": "subscriber@example.com",
   "Name": "Subscriber One",
   "Date": "2010-10-25 10:28:00",
+  "ListJoinedDate": "2010-10-25 10:28:00",
   "State": "Active",
   "CustomFields": [
     {

data/test/fixtures/subscriber_details_with_track_pref.json

@@ -2,6 +2,7 @@
   "EmailAddress": "subscriber@example.com",
   "Name": "Subscriber One",
   "Date": "2010-10-25 10:28:00",
+  "ListJoinedDate": "2010-10-25 10:28:00",
   "State": "Active",
   "CustomFields": [
     {

data/test/fixtures/tags.json

@@ -0,0 +1,10 @@
+[
+  {
+    "Name": "Tag One", 
+    "NumberOfCampaigns": "120"
+  },
+  {        
+    "Name": "Tag Two",
+    "NumberOfCampaigns": "62"
+  }
+]

data/test/fixtures/unconfirmed_subscribers.json

@@ -4,6 +4,7 @@
             "EmailAddress": "subs+7t8787Y@example.com",
             "Name": "Unconfirmed One",
             "Date": "2010-10-25 10:28:00",
+            "ListJoinedDate": "2010-10-25 10:28:00",
             "State": "Unconfirmed",
             "CustomFields": [
                 {
@@ -18,6 +19,7 @@
             "EmailAddress": "subs+7878787y8ggg@example.com",
             "Name": "Unconfirmed Two",
             "Date": "2010-10-25 12:17:00",
+            "ListJoinedDate": "2010-10-25 12:17:00",
             "State": "Unconfirmed",
             "CustomFields": [
                 {

data/test/fixtures/unsubscribed_subscribers.json

@@ -4,6 +4,7 @@
       "EmailAddress": "subscriber@example.com",
       "Name": "Unsub One",
       "Date": "2010-10-25 13:11:00",
+      "ListJoinedDate": "2010-10-25 13:11:00",
       "State": "Unsubscribed",
       "CustomFields": [],
       "ReadsEmailWith": "Gmail"
@@ -12,6 +13,7 @@
       "EmailAddress": "subscriberone@example.com",
       "Name": "Subscriber",
       "Date": "2010-10-25 13:04:00",
+      "ListJoinedDate": "2010-10-25 13:04:00",
       "State": "Unsubscribed",
       "CustomFields": [
         {
@@ -25,6 +27,7 @@
       "EmailAddress": "example+1@example.com",
       "Name": "Example One",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
       "CustomFields": [],
       "ReadsEmailWith": ""
@@ -33,6 +36,7 @@
       "EmailAddress": "example+2@example.com",
       "Name": "Example Two",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
       "CustomFields": [],
       "ReadsEmailWith": ""
@@ -41,6 +45,7 @@
       "EmailAddress": "example+3@example.com",
       "Name": "Example Three",
       "Date": "2010-10-26 10:56:00",
+      "ListJoinedDate": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
       "CustomFields": [],
       "ReadsEmailWith": "Gmail"
@@ -53,4 +58,4 @@
   "RecordsOnThisPage": 5,
   "TotalNumberOfRecords": 5,
   "NumberOfPages": 1
-}
+}

data/test/helper.rb

@@ -30,7 +30,7 @@ def createsend_url(auth, url)
   if not url =~ /^http/
     auth_section = ''
     auth_section = "#{auth[:api_key]}:x@" if auth and auth.has_key? :api_key
-    result = "https://#{auth_section}api.createsend.com/api/v3.2/#{url}"
+    result = "https://#{auth_section}api.createsend.com/api/v3.3/#{url}"
   else
     result = url
   end

data/test/list_test.rb

@@ -143,6 +143,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "subs+7t8787Y@example.com"
       res.Results.first.Name.should =="Person One"
       res.Results.first.Date.should == "2010-10-25 10:28:00"
+      res.Results.first.ListJoinedDate.should == "2010-10-25 10:28:00"
       res.Results.first.State.should == "Active"
       res.Results.first.CustomFields.size.should == 5
       res.Results.first.CustomFields[0].Key.should == "website"
@@ -169,6 +170,8 @@ class ListTest < Test::Unit::TestCase
       res.Results.size.should == 2
       res.Results.first.EmailAddress.should == "subs+7t8787Y@example.com"
       res.Results.first.Name.should =="Unconfirmed One"
+      res.Results.first.Date.should =="2010-10-25 10:28:00"
+      res.Results.first.ListJoinedDate.should =="2010-10-25 10:28:00"
       res.Results.first.State.should == "Unconfirmed"
       res.Results.first.ConsentToTrack.should == "Yes"
     end
@@ -189,6 +192,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "subscriber@example.com"
       res.Results.first.Name.should == "Unsub One"
       res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.ListJoinedDate.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Unsubscribed"
       res.Results.first.CustomFields.size.should == 0
       res.Results.first.ReadsEmailWith.should == "Gmail"
@@ -210,6 +214,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "subscriber@example.com"
       res.Results.first.Name.should == "Deleted One"
       res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.ListJoinedDate.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Deleted"
       res.Results.first.CustomFields.size.should == 0
       res.Results.first.ReadsEmailWith.should == "Gmail"
@@ -231,6 +236,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "bouncedsubscriber@example.com"
       res.Results.first.Name.should == "Bounced One"
       res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.ListJoinedDate.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Bounced"
       res.Results.first.CustomFields.size.should == 0
       res.Results.first.ReadsEmailWith.should == ""

data/test/segment_test.rb

@@ -42,6 +42,7 @@ class SegmentTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "personone@example.com"
       res.Results.first.Name.should == "Person One"
       res.Results.first.Date.should == "2010-10-27 13:13:00"
+      res.Results.first.ListJoinedDate.should == "2010-10-27 13:13:00"
       res.Results.first.State.should == "Active"
       res.Results.first.CustomFields.should == []
     end

data/test/subscriber_test.rb

@@ -14,6 +14,7 @@ class SubscriberTest < Test::Unit::TestCase
       subscriber.EmailAddress.should == email
       subscriber.Name.should == "Subscriber One"
       subscriber.Date.should == "2010-10-25 10:28:00"
+      subscriber.ListJoinedDate.should == "2010-10-25 10:28:00"
       subscriber.State.should == "Active"
       subscriber.CustomFields.size.should == 3
       subscriber.CustomFields.first.Key.should == 'website'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 6.0.0
 platform: ruby
 authors:
 - James Dennes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +184,12 @@ files:
 - lib/createsend/transactional_smart_email.rb
 - lib/createsend/transactional_timeline.rb
 - lib/createsend/version.rb
+- samples/authentication_sample.rb
+- samples/clients_sample.rb
 - samples/journey_sample.rb
+- samples/lists_sample.rb
+- samples/segments_sample.rb
+- samples/subscribes_sample.rb
 - test/administrator_test.rb
 - test/campaign_test.rb
 - test/client_test.rb
@@ -258,6 +263,7 @@ files:
 - test/fixtures/subscriber_history.json
 - test/fixtures/suppressionlist.json
 - test/fixtures/systemdate.json
+- test/fixtures/tags.json
 - test/fixtures/template_details.json
 - test/fixtures/templates.json
 - test/fixtures/timezones.json
@@ -292,7 +298,7 @@ homepage: http://campaignmonitor.github.io/createsend-ruby/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -307,112 +313,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A library which implements the complete functionality of the Campaign Monitor
   API.
-test_files:
-- test/administrator_test.rb
-- test/campaign_test.rb
-- test/client_test.rb
-- test/createsend_test.rb
-- test/fixtures/active_subscribers.json
-- test/fixtures/add_admin.json
-- test/fixtures/add_person.json
-- test/fixtures/add_subscriber.json
-- test/fixtures/admin_details.json
-- test/fixtures/admin_get_primary_contact.json
-- test/fixtures/admin_set_primary_contact.json
-- test/fixtures/administrators.json
-- test/fixtures/billingdetails.json
-- test/fixtures/bounced_subscribers.json
-- test/fixtures/campaign_bounces.json
-- test/fixtures/campaign_clicks.json
-- test/fixtures/campaign_listsandsegments.json
-- test/fixtures/campaign_opens.json
-- test/fixtures/campaign_recipients.json
-- test/fixtures/campaign_spam.json
-- test/fixtures/campaign_summary.json
-- test/fixtures/campaign_unsubscribes.json
-- test/fixtures/campaigns.json
-- test/fixtures/client_details.json
-- test/fixtures/client_get_primary_contact.json
-- test/fixtures/client_set_primary_contact.json
-- test/fixtures/clients.json
-- test/fixtures/countries.json
-- test/fixtures/create_campaign.json
-- test/fixtures/create_client.json
-- test/fixtures/create_custom_field.json
-- test/fixtures/create_list.json
-- test/fixtures/create_list_webhook.json
-- test/fixtures/create_segment.json
-- test/fixtures/create_template.json
-- test/fixtures/custom_api_error.json
-- test/fixtures/custom_fields.json
-- test/fixtures/deleted_subscribers.json
-- test/fixtures/drafts.json
-- test/fixtures/email_client_usage.json
-- test/fixtures/expired_oauth_token_api_error.json
-- test/fixtures/external_session.json
-- test/fixtures/import_subscribers.json
-- test/fixtures/import_subscribers_partial_success.json
-- test/fixtures/invalid_oauth_token_api_error.json
-- test/fixtures/journey_bounces.json
-- test/fixtures/journey_clicks.json
-- test/fixtures/journey_opens.json
-- test/fixtures/journey_recipients.json
-- test/fixtures/journey_summary.json
-- test/fixtures/journey_unsubscribes.json
-- test/fixtures/journeys.json
-- test/fixtures/list_details.json
-- test/fixtures/list_stats.json
-- test/fixtures/list_webhooks.json
-- test/fixtures/lists.json
-- test/fixtures/listsforemail.json
-- test/fixtures/oauth_exchange_token.json
-- test/fixtures/oauth_exchange_token_error.json
-- test/fixtures/oauth_refresh_token_error.json
-- test/fixtures/people.json
-- test/fixtures/person_details.json
-- test/fixtures/refresh_oauth_token.json
-- test/fixtures/revoked_oauth_token_api_error.json
-- test/fixtures/scheduled_campaigns.json
-- test/fixtures/segment_details.json
-- test/fixtures/segment_subscribers.json
-- test/fixtures/segments.json
-- test/fixtures/subscriber_details.json
-- test/fixtures/subscriber_details_with_track_pref.json
-- test/fixtures/subscriber_history.json
-- test/fixtures/suppressionlist.json
-- test/fixtures/systemdate.json
-- test/fixtures/template_details.json
-- test/fixtures/templates.json
-- test/fixtures/timezones.json
-- test/fixtures/transfer_credits.json
-- test/fixtures/tx_classicemail_groups.json
-- test/fixtures/tx_message_details.json
-- test/fixtures/tx_message_details_with_statistics.json
-- test/fixtures/tx_messages.json
-- test/fixtures/tx_messages_classic.json
-- test/fixtures/tx_messages_smart.json
-- test/fixtures/tx_resend_message.json
-- test/fixtures/tx_send_multiple.json
-- test/fixtures/tx_send_single.json
-- test/fixtures/tx_smartemail_details.json
-- test/fixtures/tx_smartemails.json
-- test/fixtures/tx_statistics_classic.json
-- test/fixtures/tx_statistics_smart.json
-- test/fixtures/unconfirmed_subscribers.json
-- test/fixtures/unsubscribed_subscribers.json
-- test/fixtures/update_custom_field.json
-- test/helper.rb
-- test/journey_test.rb
-- test/list_test.rb
-- test/person_test.rb
-- test/segment_test.rb
-- test/subscriber_test.rb
-- test/template_test.rb
-- test/transactional_classic_email_test.rb
-- test/transactional_smart_email_test.rb
-- test/transactional_timeline_test.rb
+test_files: []