createsend-sendowlfork 6.1.0.pre.hashie5

data/lib/createsend/segment.rb

@@ -0,0 +1,81 @@
+module CreateSend
+  # Represents a subscriber list segment and associated functionality.
+  class Segment < CreateSend
+    attr_reader :segment_id
+
+    def initialize(auth, segment_id)
+      @segment_id = segment_id
+      super
+    end
+
+    # Creates a new segment.
+    def self.create(auth, list_id, title, rule_groups)
+      options = { :body => {
+        :Title => title,
+        :RuleGroups => rule_groups }.to_json }
+      cs = CreateSend.new auth
+      response = cs.post "/segments/#{list_id}.json", options
+      response.parsed_response
+    end
+
+    # Updates this segment.
+    def update(title, rule_groups)
+      options = { :body => {
+        :Title => title,
+        :RuleGroups => rule_groups }.to_json }
+      cs_put "/segments/#{segment_id}.json", options
+    end
+
+    # Adds a rule to this segment.
+    def add_rule_group(rule_group)
+      options = { :body => {
+        :Rules => rule_group }.to_json }
+      post "rules", options
+    end
+
+    # Gets the active subscribers in this segment.
+    def subscribers(date="", page=1, page_size=1000, order_field="email",
+      order_direction="asc", include_tracking_preference=false)
+      options = { :query => {
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction,
+        :includetrackingpreference => include_tracking_preference } }
+      response = get "active", options
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the details of this segment
+    def details
+      response = cs_get "/segments/#{segment_id}.json", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Clears all rules of this segment.
+    def clear_rules
+      cs_delete "/segments/#{segment_id}/rules.json", {}
+    end
+
+    # Deletes this segment.
+    def delete
+      super "/segments/#{segment_id}.json", {}
+    end
+
+    private
+
+    def get(action, options = {})
+      super uri_for(action), options
+    end
+
+    def post(action, options = {})
+      super uri_for(action), options
+    end
+
+    def uri_for(action)
+      "/segments/#{segment_id}/#{action}.json"
+    end
+
+  end
+end

data/lib/createsend/subscriber.rb

@@ -0,0 +1,113 @@
+module CreateSend
+  # Represents a subscriber and associated functionality.
+  class Subscriber < CreateSend
+    attr_reader :list_id
+    attr_reader :email_address
+
+    def initialize(auth, list_id, email_address)
+      @list_id = list_id
+      @email_address = email_address
+      super
+    end
+
+    # Gets a subscriber by list ID and email address.
+    def self.get(auth, list_id, email_address, include_tracking_preference=false)
+      options = { :query => { 
+        :email => email_address, 
+        :includetrackingpreference => include_tracking_preference } 
+      }
+      cs = CreateSend.new auth
+      response = cs.get "/subscribers/#{list_id}.json", options
+      Hashie::Mash.new(response)
+    end
+
+    # 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, 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,
+        :ConsentToSendSms => consent_to_send_sms }.to_json }
+      cs = CreateSend.new auth
+      response = cs.post "/subscribers/#{list_id}.json", options
+      response.parsed_response
+    end
+
+    # Imports subscribers into a subscriber list.
+    def self.import(auth, list_id, subscribers, resubscribe,
+      queue_subscription_based_autoresponders=false,
+      restart_subscription_based_autoresponders=false)
+      options = { :body => {
+        :Subscribers => subscribers,
+        :Resubscribe => resubscribe,
+        :QueueSubscriptionBasedAutoresponders =>
+          queue_subscription_based_autoresponders,
+        :RestartSubscriptionBasedAutoresponders =>
+          restart_subscription_based_autoresponders }.to_json }
+      begin
+        cs = CreateSend.new auth
+        response = cs.post(
+          "/subscribers/#{list_id}/import.json", options)
+      rescue BadRequest => br
+        # Subscriber import will throw BadRequest if some subscribers are not
+        # imported successfully. If this occurs, we want to return the
+        # ResultData property of the BadRequest exception (which is of the
+        # same "form" as the response we would receive upon a completely
+        # successful import).
+        if br.data.ResultData
+          return br.data.ResultData
+        else
+          raise br # Just raise other Bad Request errors
+        end
+      end
+      Hashie::Mash.new(response)
+    end
+
+    # 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, 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,
+          :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
+    end
+
+    # Unsubscribes this subscriber from the associated list.
+    def unsubscribe
+      options = { :body => {
+        :EmailAddress => @email_address }.to_json }
+      post "/subscribers/#{@list_id}/unsubscribe.json", options
+    end
+
+    # Gets the historical record of this subscriber's trackable actions.
+    def history
+      options = { :query => { :email => @email_address } }
+      response = cs_get "/subscribers/#{@list_id}/history.json", options
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Moves this subscriber to the Deleted state in the associated list.
+    def delete
+      options = { :query => { :email => @email_address } }
+      super "/subscribers/#{@list_id}.json", options
+    end
+  end
+end

data/lib/createsend/template.rb

@@ -0,0 +1,42 @@
+module CreateSend
+  # Represents an email template and associated functionality.
+  class Template < CreateSend
+    attr_reader :template_id
+
+    def initialize(auth, template_id)
+      @template_id = template_id
+      super
+    end
+
+    # Creates a new email template.
+    def self.create(auth, client_id, name, html_url, zip_url)
+      options = { :body => {
+        :Name => name,
+        :HtmlPageURL => html_url,
+        :ZipFileURL => zip_url }.to_json }
+      cs = CreateSend.new auth
+      response = cs.post "/templates/#{client_id}.json", options
+      response.parsed_response
+    end
+
+    # Gets the details of this email template.
+    def details
+      response = get "/templates/#{template_id}.json", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Updates this email template.
+    def update(name, html_url, zip_url)
+      options = { :body => {
+        :Name => name,
+        :HtmlPageURL => html_url,
+        :ZipFileURL => zip_url }.to_json }
+      put "/templates/#{template_id}.json", options
+    end
+
+    # Deletes this email template.
+    def delete
+      super "/templates/#{template_id}.json", {}
+    end
+  end
+end

data/lib/createsend/transactional_classic_email.rb

@@ -0,0 +1,32 @@
+module CreateSend
+  module Transactional
+    class ClassicEmail < CreateSend
+      attr_accessor :options
+
+      def initialize(auth, client_id = nil)
+        @auth = auth
+        @client_id = client_id
+        super
+      end
+
+      def send(options)
+        response = post "/transactional/classicemail/send", { :body => options.to_json , :query => client_id }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def groups
+        response = get "/transactional/classicemail/groups", :query => client_id
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      private
+
+      def client_id
+        {:clientID => @client_id} if @client_id
+      end
+
+    end
+  end
+end
+
+

data/lib/createsend/transactional_smart_email.rb

@@ -0,0 +1,31 @@
+module CreateSend
+  module Transactional
+    class SmartEmail < CreateSend
+      attr_reader :smart_email_id
+
+      def self.list(auth, options = nil)
+        cs = CreateSend.new auth
+        response = cs.get "/transactional/smartemail", :query => options
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def initialize(auth, smart_email_id)
+        @auth = auth
+        @smart_email_id = smart_email_id
+        super
+      end
+
+      def details
+        response = get "/transactional/smartemail/#{@smart_email_id}"
+        Hashie::Mash.new(response)
+      end
+
+      def send(options)
+        response = post "/transactional/smartemail/#{@smart_email_id}/send", { :body => options.to_json }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+    end
+  end
+end
+

data/lib/createsend/transactional_timeline.rb

@@ -0,0 +1,45 @@
+module CreateSend
+  module Transactional
+    class Timeline < CreateSend
+      attr_reader :client_id
+
+      def initialize(auth, client_id = nil)
+        @auth      = auth
+        @client_id = client_id
+        super
+      end
+
+      def messages(options = {})
+        options = add_client_id(options)
+        response = get "/transactional/messages", { :query => options }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def statistics(options = {})
+        options = add_client_id(options)
+        response = get "/transactional/statistics", { :query => options }
+        Hashie::Mash.new(response)
+      end
+
+      def details(message_id, options = {})
+        options = add_client_id(options)
+        response = get "/transactional/messages/#{message_id}", { :query => options }
+        Hashie::Mash.new(response)
+      end
+
+      def resend(message_id)
+        response = post "/transactional/messages/#{message_id}/resend"
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      private
+
+      def add_client_id(options)
+        options['clientID'] = @client_id if @client_id
+        options
+      end
+
+    end
+  end
+end
+

data/lib/createsend/version.rb

@@ -0,0 +1,3 @@
+module CreateSend
+  VERSION = "6.1.0-hashie5" unless defined?(CreateSend::VERSION)
+end

data/lib/createsend.rb

@@ -0,0 +1,17 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'createsend/version'
+require 'createsend/createsend'
+require 'createsend/client'
+require 'createsend/campaign'
+require 'createsend/list'
+require 'createsend/segment'
+require 'createsend/subscriber'
+require 'createsend/template'
+require 'createsend/person'
+require 'createsend/administrator'
+require 'createsend/transactional_classic_email'
+require 'createsend/transactional_smart_email'
+require 'createsend/transactional_timeline'
+require 'createsend/journey'

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

@@ -0,0 +1,87 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class JourneySample
+  @date = "2019-01-01 00:00"
+
+  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?
+    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 = {: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
+
+  def get_all_journeys
+    @client.journeys
+  end
+
+  def get_journey_summary
+    @journey.summary
+  end
+
+  def get_recipients_for_email
+    @journey.email_recipients ENV['CREATESEND_EMAIL_ID']
+  end
+
+  def get_email_opens
+    opens = []
+    loop do
+      page = @journey.email_opens email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      opens.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    opens
+  end
+
+  def get_email_clicks
+    clicks = []
+    loop do
+      page = @journey.email_clicks email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      clicks.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    clicks
+  end
+
+  def get_email_unsubscribes
+    unsubscribes = []
+    loop do
+      page = @journey.email_unsubscribes email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      unsubscribes.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    unsubscribes
+  end
+
+  def get_email_bounces
+    bounces = []
+    loop do
+      page = @journey.email_bounces email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'asc'
+      bounces.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    bounces
+  end
+end
+
+sample = JourneySample.new
+puts "All journeys: #{sample.get_all_journeys.to_json}\n\n"
+puts "Journey Summary: #{sample.get_journey_summary.to_json}\n\n"
+puts "Email recipients : #{sample.get_recipients_for_email.to_json}\n\n"
+puts "Email Opens : #{sample.get_email_opens.to_json}\n\n"
+puts "Email Clicks : #{sample.get_email_clicks.to_json}\n\n"
+puts "Email Unsubscribes : #{sample.get_email_unsubscribes.to_json}\n\n"
+puts "Email Bounces : #{sample.get_email_bounces.to_json}\n\n"

data/samples/lists_sample.rb

@@ -0,0 +1,51 @@
+$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_active_with_sms_preference_subscribers
+        @list.active(include_sms_preference:true)
+    end
+
+    def get_bounced_subscribers
+        @list.bounced
+    end
+
+    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
+
+    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 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 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"

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"