Merge pull request campaignmonitor#73 from campaignmonitor/ConsentToSendSmsSupport

ConsentToSendSmsSupport

Author: henrys-cm

HISTORY.md

@@ -1,5 +1,18 @@
 # createsend-ruby history
 
+## v6.1.0 - 27 Oct 2023
+* Added support for add/update subscribers specifying mobile_number and/or consent_to_send_sms (optional parameters)
+  * Subscriber.Add 
+  * Subscriber.Update()
+* Added support for lists endpoints to be able to return the ConsentToSendSms (keyword parameter, is optional)
+  * List.Active(include_sms_preference:true)
+  * List.Bounced(include_sms_preference:true)
+  * List.Unsubscribed(include_sms_preference:true)
+  * List.Unconfirmed(include_sms_preference:true)
+  * List.Deleted(include_sms_preference:true)
+* Clean-up various warnings associated with this package (excluding dependency package warning)
+* Add more samples
+
 ## 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)

README.md

@@ -194,7 +194,7 @@ should "add a subscriber with custom fields" do
   stub_post(@auth, "subscribers/#{@list_id}.json", "add_subscriber.json")
   custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
   email_address = CreateSend::Subscriber.add @auth, @list_id, "[email protected]", "Subscriber", custom_fields, true, "Yes"
-  email_address.should == "[email protected]"
+  email_address.should be == "[email protected]"
 end
 ```
 

lib/createsend/list.rb

@@ -116,37 +116,37 @@ def stats
 
     # Gets the active subscribers for this list.
     def active(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc", include_tracking_preference=false)
+      order_direction="asc", include_tracking_preference=false, include_sms_preference:false)
       paged_result_by_date("active", date, page, page_size, order_field,
-        order_direction, include_tracking_preference)
+        order_direction, include_tracking_preference, include_sms_preference)
     end
 
     # Gets the unconfirmed subscribers for this list.
     def unconfirmed(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc", include_tracking_preference=false)
+      order_direction="asc", include_tracking_preference=false, include_sms_preference:false)
       paged_result_by_date("unconfirmed", date, page, page_size, order_field,
-        order_direction, include_tracking_preference)
+        order_direction, include_tracking_preference, include_sms_preference)
     end
 
     # Gets the bounced subscribers for this list.
     def bounced(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc", include_tracking_preference=false)
+      order_direction="asc", include_tracking_preference=false, include_sms_preference:false)
       paged_result_by_date("bounced", date, page, page_size, order_field,
-        order_direction, include_tracking_preference)
+        order_direction, include_tracking_preference, include_sms_preference)
     end
 
     # Gets the unsubscribed subscribers for this list.
     def unsubscribed(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc", include_tracking_preference=false)
+      order_direction="asc", include_tracking_preference=false, include_sms_preference:false)
       paged_result_by_date("unsubscribed", date, page, page_size, order_field,
-        order_direction, include_tracking_preference)
+        order_direction, include_tracking_preference, include_sms_preference)
     end
 
     # Gets the deleted subscribers for this list.
     def deleted(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc", include_tracking_preference=false)
+      order_direction="asc", include_tracking_preference=false, include_sms_preference:false)
       paged_result_by_date("deleted", date, page, page_size, order_field,
-        order_direction, include_tracking_preference)
+        order_direction, include_tracking_preference, include_sms_preference)
     end
 
     # Updates this list.
@@ -225,14 +225,15 @@ def deactivate_webhook(webhook_id)
     private
 
     def paged_result_by_date(resource, date, page, page_size, order_field,
-      order_direction, include_tracking_preference)
+      order_direction, include_tracking_preference, include_sms_preference)
       options = { :query => {
         :date => date,
         :page => page,
         :pagesize => page_size,
         :orderfield => order_field,
         :orderdirection => order_direction,
-        :includetrackingpreference => include_tracking_preference } }
+        :includetrackingpreference => include_tracking_preference,
+        :includesmspreference => include_sms_preference} }
       response = get resource, options
       Hashie::Mash.new(response)
     end

lib/createsend/subscriber.rb

@@ -23,15 +23,17 @@ def self.get(auth, list_id, email_address, include_tracking_preference=false)
 
     # Adds a subscriber to a subscriber list.
     def self.add(auth, list_id, email_address, name, custom_fields, resubscribe, 
-      consent_to_track, restart_subscription_based_autoresponders=false)
+      consent_to_track, restart_subscription_based_autoresponders=false, mobile_number=nil, consent_to_send_sms=nil)
       options = { :body => {
         :EmailAddress => email_address,
         :Name => name,
+        :MobileNumber => mobile_number,
         :CustomFields => custom_fields,
         :Resubscribe => resubscribe,
         :RestartSubscriptionBasedAutoresponders => 
           restart_subscription_based_autoresponders,
-        :ConsentToTrack => consent_to_track }.to_json }
+        :ConsentToTrack => consent_to_track,
+        :ConsentToSendSms => consent_to_send_sms }.to_json }
       cs = CreateSend.new auth
       response = cs.post "/subscribers/#{list_id}.json", options
       response.parsed_response
@@ -70,17 +72,19 @@ def self.import(auth, list_id, subscribers, resubscribe,
     # Updates any aspect of a subscriber, including email address, name, and
     # custom field data if supplied.
     def update(new_email_address, name, custom_fields, resubscribe, 
-      consent_to_track, restart_subscription_based_autoresponders=false)
+      consent_to_track, restart_subscription_based_autoresponders=false, mobile_number=nil, consent_to_send_sms=nil)
       options = {
         :query => { :email => @email_address },
         :body => {
           :EmailAddress => new_email_address,
           :Name => name,
+          :MobileNumber => mobile_number,
           :CustomFields => custom_fields,
           :Resubscribe => resubscribe,
           :RestartSubscriptionBasedAutoresponders => 
             restart_subscription_based_autoresponders,
-          :ConsentToTrack => consent_to_track }.to_json }
+          :ConsentToTrack => consent_to_track,
+          :ConsentToSendSms => consent_to_send_sms }.to_json }
       put "/subscribers/#{@list_id}.json", options
       # Update @email_address, so this object can continue to be used reliably
       @email_address = new_email_address

lib/createsend/version.rb

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

samples/lists_sample.rb

@@ -12,7 +12,11 @@ def initialize
     end
 
     def get_active_subscribers
-        @list.active
+        @list.active()
+    end
+
+    def get_active_with_sms_preference_subscribers
+        @list.active(include_sms_preference:true)
     end
 
     def get_bounced_subscribers
@@ -23,6 +27,10 @@ def get_unsubscribed_subscribers
         @list.unsubscribed
     end
 
+    def get_unsubscribed_with_sms_preference_subscribers
+        @list.unsubscribed(include_sms_preference:true)
+    end
+
     def get_unconfirmed_subscribers
         @list.unconfirmed
     end
@@ -35,7 +43,9 @@ def get_deleted_subscribers
 sample = ListsSample.new
 
 puts "All active subscribers: #{sample.get_active_subscribers.to_json}\n\n"
+puts "All active subscribers with sms preference: #{sample.get_active_with_sms_preference_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 unsubscribed subscribers: #{sample.get_unsubscribed_subscribers.to_json}\n\n"
+puts "All unsubscribed subscribers with sms preference: #{sample.get_unsubscribed_with_sms_preference_subscribers.to_json}\n\n"
 puts "All deleted subscribers: #{sample.get_deleted_subscribers.to_json}\n\n"

samples/subscribers_sample.rb

@@ -0,0 +1,51 @@
+$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?
+
+        @auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+    end
+
+    def add_subscriber_without_mobile
+        @subscriberAdded = CreateSend::Subscriber.add @auth, ENV['CREATESEND_LIST_ID'], "[email protected]", "Subscriber", [], true, "Yes", false
+    end
+
+    def add_subscriber_with_mobile
+        @subscriberAdded = CreateSend::Subscriber.add @auth, ENV['CREATESEND_LIST_ID'], "[email protected]", "SubscriberWithMobile", [], true, "Yes", false, "+61423152523"
+    end
+
+    def add_subscriber_with_mobile_and_consent
+        @subscriberAdded = CreateSend::Subscriber.add @auth, ENV['CREATESEND_LIST_ID'], "[email protected]", "SubscriberWithMobileAndConsent", [], true, "Yes", false, "+61423152523", "Yes"
+    end
+
+    def get_subscriber
+        @subscriber = CreateSend::Subscriber.get @auth, ENV['CREATESEND_LIST_ID'], "[email protected]"
+    end
+
+    def import_subscribers
+        subscribers = [
+            {"EmailAddress":"[email protected]","Name":"subscriberImport11", "ConsentToTrack":"Yes"},
+            {"EmailAddress":"[email protected]","Name":"subscriberImport12", "ConsentToTrack":"No", "MobileNumber":"+1612105111", "ConsentToSendSms":"Yes"},
+            {"EmailAddress":"[email protected]","Name":"subscriberImport13", "ConsentToTrack":"Yes", "MobileNumber":"+1612105112"}
+        ]
+        @subscribersImported = CreateSend::Subscriber.import(@auth, ENV['CREATESEND_LIST_ID'], subscribers, true, false, false)
+    end        
+
+    def update_subscribers
+        @subscriber = CreateSend::Subscriber.new(@auth, ENV['CREATESEND_LIST_ID'], '[email protected]')
+        @subscriberUpdated = @subscriber.update("[email protected]", "Subscriber With Mobile And Consent", [], true, "Yes", false, "+16175551218")
+    end
+end
+
+sample = SubscribersSample.new
+
+puts "add_subscriber_without_mobile: #{sample.add_subscriber_without_mobile.to_json}\n\n"
+puts "add_subscriber_with_mobile: #{sample.add_subscriber_with_mobile.to_json}\n\n"
+puts "add_subscriber_with_mobile_and_consent: #{sample.add_subscriber_with_mobile_and_consent.to_json}\n\n"
+puts "get subscribers: #{sample.get_subscriber.to_json}\n\n"
+puts "import_subscribers: #{sample.import_subscribers.to_json}\n\n"
+puts "update_subscribers: #{sample.update_subscribers.to_json}\n\n"

samples/subscribes_sample.rb

@@ -10,23 +10,23 @@ class AdministratorTest < Test::Unit::TestCase
       email = "[email protected]"
       stub_get(@auth, "admins.json?email=#{ERB::Util.url_encode(email)}", "admin_details.json")
       admin = CreateSend::Administrator.get @auth, email
-      admin.EmailAddress.should == email
-      admin.Name.should == "Admin One"
-      admin.Status.should == "Active"
+      admin.EmailAddress.should be == email
+      admin.Name.should be == "Admin One"
+      admin.Status.should be == "Active"
     end
 
     should "add an administrator" do
       stub_post(@auth, "admins.json", "add_admin.json")
       result = CreateSend::Administrator.add @auth, "[email protected]", "Admin"
-      result.EmailAddress.should == "[email protected]"
+      result.EmailAddress.should be == "[email protected]"
     end
 
     should "update an administrator" do
       email = "[email protected]"
       new_email = "[email protected]"
       stub_put(@auth, "admins.json?email=#{ERB::Util.url_encode(email)}", nil)
       @admin.update new_email, "Admin Name"
-      @admin.email_address.should == new_email
+      @admin.email_address.should be == new_email
     end
 
     should "delete an admin" do