createsend-sendowlfork 6.1.0.pre.hashie5

data/lib/createsend/campaign.rb

@@ -0,0 +1,202 @@
+module CreateSend
+  # Represents a campaign and provides associated functionality.
+  class Campaign < CreateSend
+    attr_reader :campaign_id
+
+    def initialize(auth, campaign_id)
+      @campaign_id = campaign_id
+      super
+    end
+
+    # Creates a new campaign for a client.
+    # client_id - String representing the ID of the client for whom the
+    #   campaign will be created.
+    # subject - String representing the subject of the campaign.
+    # name - String representing the name of the campaign.
+    # from_name - String representing the from name for the campaign.
+    # from_email - String representing the from address for the campaign.
+    # reply_to - String representing the reply-to address for the campaign.
+    # html_url - String representing the URL for the campaign HTML content.
+    # text_url - String representing the URL for the campaign text content.
+    #  Note that text_url is optional and if nil or an empty string, text
+    #  content will be automatically generated from the HTML content.
+    # list_ids - Array of Strings representing the IDs of the lists to
+    #   which the campaign will be sent.
+    # segment_ids - Array of Strings representing the IDs of the segments to
+    #   which the campaign will be sent.
+    def self.create(auth, client_id, subject, name, from_name, from_email,
+      reply_to, html_url, text_url, list_ids, segment_ids)
+      options = { :body => {
+        :Subject => subject,
+        :Name => name,
+        :FromName => from_name,
+        :FromEmail => from_email,
+        :ReplyTo => reply_to,
+        :HtmlUrl => html_url,
+        :TextUrl => text_url,
+        :ListIDs => list_ids,
+        :SegmentIDs => segment_ids }.to_json }
+      cs = CreateSend.new auth
+      response = cs.post "/campaigns/#{client_id}.json", options
+      response.parsed_response
+    end
+
+    # Creates a new campaign for a client, from a template.
+    # client_id - String representing the ID of the client for whom the
+    #   campaign will be created.
+    # subject - String representing the subject of the campaign.
+    # name - String representing the name of the campaign.
+    # from_name - String representing the from name for the campaign.
+    # from_email - String representing the from address for the campaign.
+    # reply_to - String representing the reply-to address for the campaign.
+    # list_ids - Array of Strings representing the IDs of the lists to
+    #   which the campaign will be sent.
+    # segment_ids - Array of Strings representing the IDs of the segments to
+    #   which the campaign will be sent.
+    # template_id - String representing the ID of the template on which
+    #   the campaign will be based.
+    # template_content - Hash representing the content to be used for the
+    #   editable areas of the template. See documentation at
+    #   campaignmonitor.com/api/campaigns/#creating_a_campaign_from_template
+    #   for full details of template content format.
+    def self.create_from_template(auth, client_id, subject, name, from_name,
+      from_email, reply_to, list_ids, segment_ids, template_id,
+      template_content)
+      options = { :body => {
+        :Subject => subject,
+        :Name => name,
+        :FromName => from_name,
+        :FromEmail => from_email,
+        :ReplyTo => reply_to,
+        :ListIDs => list_ids,
+        :SegmentIDs => segment_ids,
+        :TemplateID => template_id,
+        :TemplateContent => template_content }.to_json }
+      cs = CreateSend.new auth
+      response = cs.post(
+        "/campaigns/#{client_id}/fromtemplate.json", options)
+      response.parsed_response
+    end
+
+    # Sends a preview of this campaign.
+    def send_preview(recipients, personalize="fallback")
+      options = { :body => {
+        :PreviewRecipients => recipients.kind_of?(String) ?
+          [ recipients ] : recipients,
+        :Personalize => personalize }.to_json }
+      post "sendpreview", options
+    end
+
+    # Sends this campaign.
+    def send(confirmation_email, send_date="immediately")
+      options = { :body => {
+        :ConfirmationEmail => confirmation_email,
+        :SendDate => send_date }.to_json }
+      post "send", options
+    end
+
+    # Unschedules this campaign if it is currently scheduled.
+    def unschedule
+      options = { :body => "" }
+      post "unschedule", options
+    end
+
+    # Deletes this campaign.
+    def delete
+      super "/campaigns/#{campaign_id}.json", {}
+    end
+
+    # Gets a summary of this campaign
+    def summary
+      response = get "summary", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the email clients that subscribers used to open the campaign
+    def email_client_usage
+      response = get "emailclientusage", {}
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Retrieves the lists and segments to which this campaaign will
+    # be (or was) sent.
+    def lists_and_segments
+      response = get "listsandsegments", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the recipients of this campaign.
+    def recipients(page=1, page_size=1000, order_field="email",
+      order_direction="asc")
+      options = { :query => {
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get 'recipients', options
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the opens for this campaign.
+    def opens(date="", page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      paged_result_by_date("opens", date, page, page_size, order_field,
+        order_direction)
+    end
+
+    # Retrieves the subscriber clicks for this campaign.
+    def clicks(date="", page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      paged_result_by_date("clicks", date, page, page_size, order_field,
+        order_direction)
+    end
+
+    # Retrieves the unsubscribes for this campaign.
+    def unsubscribes(date="", page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      paged_result_by_date("unsubscribes", date, page, page_size, order_field,
+        order_direction)
+    end
+
+    # Retrieves the spam complaints for this campaign.
+    def spam(date="", page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      paged_result_by_date("spam", date, page, page_size, order_field,
+        order_direction)
+    end
+
+    # Retrieves the bounces for this campaign.
+    def bounces(date="", page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      paged_result_by_date("bounces", date, page, page_size, order_field,
+        order_direction)
+    end
+
+    private
+
+    def paged_result_by_date(resource, date, page, page_size, order_field,
+      order_direction)
+      options = { :query => {
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get resource, options
+      Hashie::Mash.new(response)
+    end
+
+    def get(action, options = {})
+      super uri_for(action), options
+    end
+
+    def post(action, options = {})
+      super uri_for(action), options
+    end
+
+    def uri_for(action)
+      "/campaigns/#{campaign_id}/#{action}.json"
+    end
+
+  end
+end

data/lib/createsend/client.rb

@@ -0,0 +1,224 @@
+module CreateSend
+  # Represents a client and associated functionality.
+  class Client < CreateSend
+    attr_reader :client_id
+
+    def initialize(auth, client_id)
+      @client_id = client_id
+      super
+    end
+
+    # Creates a client.
+    def self.create(auth, company, timezone, country)
+      options = { :body => {
+        :CompanyName => company,
+        :TimeZone => timezone,
+        :Country => country }.to_json }
+      cs = CreateSend.new auth
+      cs.post "/clients.json", options
+    end
+
+    # Gets the details of this client.
+    def details
+      response = cs_get "/clients/#{client_id}.json", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the sent campaigns belonging to this client.
+    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.
+    def scheduled
+      response = get 'scheduled'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the draft campaigns belonging to this client.
+    def drafts
+      response = get 'drafts'
+      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'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the lists across a client, to which a subscriber with a particular
+    # email address belongs.
+    # email_address - A String representing the subcriber's email address
+    def lists_for_email(email_address)
+      options = { :query => { :email => email_address } }
+      response = get 'listsforemail', options
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the segments belonging to this client.
+    def segments
+      response = get 'segments'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the people associated with this client
+    def people
+      response = get "people"
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    def get_primary_contact
+      response = get "primarycontact"
+      Hashie::Mash.new(response)
+    end
+
+    def set_primary_contact(email)
+      options = { :query => { :email => email } }
+      response = put "primarycontact", options
+      Hashie::Mash.new(response)
+    end
+
+    # Gets this client's suppression list.
+    def suppressionlist(page=1, page_size=1000, order_field="email",
+      order_direction="asc")
+      options = { :query => {
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get 'suppressionlist', options
+      Hashie::Mash.new(response)
+    end
+
+    # Adds email addresses to a client's suppression list
+    def suppress(emails)
+      options = { :body => {
+        :EmailAddresses => emails.kind_of?(String) ?
+          [ emails ] : emails }.to_json }
+      post "suppress", options
+    end
+
+    # Unsuppresses an email address by removing it from the the client's
+    # suppression list
+    def unsuppress(email)
+      options = { :query => { :email => email }, :body => '' }
+      put "unsuppress", options
+    end
+
+    # Gets the templates belonging to this client.
+    def templates
+      response = get 'templates'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Sets the basic details for this client.
+    def set_basics(company, timezone, country)
+      options = { :body => {
+        :CompanyName => company,
+        :TimeZone => timezone,
+        :Country => country }.to_json }
+      put 'setbasics', options
+    end
+
+    # Sets the PAYG billing settings for this client.
+    def set_payg_billing(currency, can_purchase_credits, client_pays,
+      markup_percentage, markup_on_delivery=0, markup_per_recipient=0,
+      markup_on_design_spam_test=0)
+      options = { :body => {
+        :Currency => currency,
+        :CanPurchaseCredits => can_purchase_credits,
+        :ClientPays => client_pays,
+        :MarkupPercentage => markup_percentage,
+        :MarkupOnDelivery => markup_on_delivery,
+        :MarkupPerRecipient => markup_per_recipient,
+        :MarkupOnDesignSpamTest => markup_on_design_spam_test }.to_json }
+      put 'setpaygbilling', options
+    end
+
+    # Sets the monthly billing settings for this client.
+    # monthly_scheme must be nil, Basic or Unlimited
+    def set_monthly_billing(currency, client_pays, markup_percentage,
+      monthly_scheme = nil)
+      options = { :body => {
+        :Currency => currency,
+        :ClientPays => client_pays,
+        :MarkupPercentage => markup_percentage,
+        :MonthlyScheme => monthly_scheme }.to_json }
+      put 'setmonthlybilling', options
+    end
+
+    # Transfer credits to or from this client.
+    #
+    # credits - An Integer representing the number of credits to transfer.
+    #   This value may be either positive if you want to allocate credits from
+    #   your account to the client, or negative if you want to deduct credits
+    #   from the client back into your account.
+    # can_use_my_credits_when_they_run_out - A Boolean value representing
+    #   which, if set to true, will allow the client to continue sending using
+    #   your credits or payment details once they run out of credits, and if
+    #   set to false, will prevent the client from using your credits to
+    #   continue sending until you allocate more credits to them.
+    #
+    # Returns an object of the following form representing the result:
+    # {
+    #   AccountCredits # Integer representing credits in your account now
+    #   ClientCredits # Integer representing credits in this client's
+    #     account now
+    # }
+    def transfer_credits(credits, can_use_my_credits_when_they_run_out)
+      options = { :body => {
+        :Credits => credits,
+        :CanUseMyCreditsWhenTheyRunOut => can_use_my_credits_when_they_run_out
+      }.to_json }
+      response = post 'credits', options
+      Hashie::Mash.new(response)
+    end
+
+    # Deletes this client.
+    def delete
+      super "/clients/#{client_id}.json", {}
+    end
+
+    # Gets the journeys belonging to this client.
+    def journeys
+      response = get 'journeys'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    private
+
+    def get(action, options = {})
+      super uri_for(action), options
+    end
+
+    def post(action, options = {})
+      super uri_for(action), options
+    end
+
+    def put(action, options = {})
+      super uri_for(action), options
+    end
+
+    def uri_for(action)
+      "/clients/#{client_id}/#{action}.json"
+    end
+  end
+end