drip-ruby 0.0.12 → 1.0.0

data/lib/drip/client/campaigns.rb

@@ -16,6 +16,60 @@ module Drip
       def campaigns(options = {})
         get "#{account_id}/campaigns", options
       end
+
+      # Public: Fetch a campaign.
+      #
+      # id - Required. The String id of the campaign.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#campaigns
+      def campaign(id)
+        get "#{account_id}/campaigns/#{id}"
+      end
+
+      # Public: Activate a campaign.
+      #
+      # id - Required. The String id of the campaign.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#campaigns
+      def activate_campaign(id)
+        post "#{account_id}/campaigns/#{id}/activate"
+      end
+
+      # Public: Pause a campaign.
+      #
+      # id - Required. The String id of the campaign.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#campaigns
+      def pause_campaign(id)
+        post "#{account_id}/campaigns/#{id}/pause"
+      end
+
+      # Public: List everyone subscribed to a campaign.
+      #
+      # id - Required. The String id of the campaign.
+      #
+      # options - A Hash of options
+      #           - status    - Optional. Filter by one of the following statuses:
+      #                         active, unsubscribed or removed. Defaults to active.
+      #           - page      - Optional. Use this parameter to paginate through
+      #                         your list of campaign subscribers. Each response contains a
+      #                         a `meta` object that includes `total_count` and
+      #                         `total_pages` attributes.
+      #           - sort      - Optional. Sort results by one of these fields:
+      #                         `id`, `created_at`. Default sorting is `created_at`
+      #           - direction - Optional. The direction to sort the results:
+      #                         `asc`, `desc`. Defaults to `desc`
+      #           - per_page  - Optional. The number of records to be returned
+      #                         on each page. Defaults to 100. Maximum 1000
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#campaigns
+      def campaign_subscribers(id, options = {})
+        get "#{account_id}/campaigns/#{id}/subscribers", options
+      end
     end
   end
 end

data/lib/drip/client/conversions.rb

@@ -0,0 +1,27 @@
+module Drip
+  class Client
+    module Conversions
+      # Public: Fetch all conversions.
+      #
+      # options - A Hash of options.
+      #           - status - Optional. Filter by one of the following statuses:
+      #                      active, disabled, or all. Defaults to all.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#conversions
+      def conversions(options = {})
+        get "#{account_id}/goals", options
+      end
+
+      # Public: Fetch a conversion.
+      #
+      # id - Required. The String id of the conversion
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#conversions
+      def conversion(id)
+        get "#{account_id}/goals/#{id}"
+      end
+    end
+  end
+end

data/lib/drip/client/custom_fields.rb

@@ -0,0 +1,13 @@
+module Drip
+  class Client
+    module CustomFields
+      # Public: List all custom field identifiers.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#custom_fields
+      def custom_fields
+        get "#{account_id}/custom_field_identifiers"
+      end
+    end
+  end
+end

data/lib/drip/client/events.rb

@@ -32,6 +32,19 @@ module Drip
         url = "#{account_id}/events/batches"
         post url, generate_resource("batches", { "events" => events })
       end
+
+      # Public: Fetch all custom event actions.
+      #
+      # options - Optional.  A Hash of options
+      #           - page   - Optional. The page number. Defaults to 1
+      #           - per_page - Optional. The number of records to be returned
+      #                        on each page. Defaults to 100. Maximum 1000.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#events
+      def event_actions(options = {})
+        get "#{account_id}/event_actions", options
+      end
     end
   end
 end

data/lib/drip/client/forms.rb

@@ -0,0 +1,23 @@
+module Drip
+  class Client
+    module Forms
+      # Public: Fetch all forms.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#forms
+      def forms
+        get "#{account_id}/forms"
+      end
+
+      # Public: Fetch a form.
+      #
+      # id - Required. The String id of the form
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#forms
+      def form(id)
+        get "#{account_id}/forms/#{id}"
+      end
+    end
+  end
+end

data/lib/drip/client/purchases.rb

@@ -37,7 +37,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#create_purchase
       def create_purchase(email, amount, options = {})
-        data = options.merge(:amount => amount)
+        data = options.merge(amount: amount)
         post "#{account_id}/subscribers/#{CGI.escape email}/purchases", generate_resource("purchases", data)
       end
 

data/lib/drip/client/subscribers.rb

@@ -3,7 +3,7 @@ require "cgi"
 module Drip
   class Client
     module Subscribers
-      # Public: Fetch a subscriber.
+      # Public: List all subscribers.
       #
       # options - A Hash of options.
       #           - status - Optional. Filter by one of the following statuses:
@@ -37,7 +37,7 @@ module Drip
       #                             If provided and a subscriber with the email above
       #                             does not exist, this address will be used to
       #                             create a new subscriber.
-      #           - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #           - time_zone     - Optional. The subscriber's time zone (in Olson
       #                             format). Defaults to Etc/UTC.
       #           - custom_fields - Optional. A Hash of custom field data.
       #           - tags          - Optional. An Array of tags.
@@ -45,7 +45,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#create_or_update_subscriber
       def create_or_update_subscriber(email, options = {})
-        data = options.merge(:email => email)
+        data = options.merge(email: email)
         post "#{account_id}/subscribers", generate_resource("subscribers", data)
       end
 
@@ -57,7 +57,7 @@ module Drip
       #                                 If provided and a subscriber with the email above
       #                                 does not exist, this address will be used to
       #                                 create a new subscriber.
-      #               - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #               - time_zone     - Optional. The subscriber's time zone (in Olson
       #                                 format). Defaults to Etc/UTC.
       #               - custom_fields - Optional. A Hash of custom field data.
       #               - tags          - Optional. An Array of tags.
@@ -69,6 +69,18 @@ module Drip
         post url, generate_resource("batches", { "subscribers" => subscribers })
       end
 
+      # Public: Unsubscribe a collection of subscribers.
+      #
+      # subscribers - Required. An Array of between 1 and 1000 Hashes of subscriber data.
+      #               - email - Required. The String subscriber email address.
+      #
+      # Returns a Drip::Response
+      # See https://www.getdrip.com/docs/rest-api#subscriber_batches
+      def unsubscribe_subscribers(subscribers)
+        url = "#{account_id}/unsubscribes/batches"
+        post url, generate_resource("batches", { "subscribers" => subscribers })
+      end
+
       # Public: Unsubscribe a subscriber globally or from a specific campaign.
       #
       # id_or_email - Required. The String id or email address of the subscriber.
@@ -79,7 +91,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#unsubscribe
       def unsubscribe(id_or_email, options = {})
-        url = "#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe"
+        url = "#{account_id}/subscribers/#{CGI.escape id_or_email}/remove"
         url += options[:campaign_id] ? "?campaign_id=#{options[:campaign_id]}" : ""
         post url
       end
@@ -95,7 +107,7 @@ module Drip
       #                                 on the campaign.
       #               - starting_email_index - Optional. The index (zero-based) of
       #                                 the email to send first. Defaults to 0.
-      #               - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #               - time_zone     - Optional. The subscriber's time zone (in Olson
       #                                 format). Defaults to Etc/UTC.
       #               - custom_fields - Optional. A Hash of custom field data.
       #               - tags          - Optional. An Array of tags.
@@ -122,6 +134,16 @@ module Drip
       def delete_subscriber(id_or_email)
         delete "#{account_id}/subscribers/#{CGI.escape id_or_email}"
       end
+
+      # Public: Unsubscribe a subscriber from all mailings.
+      #
+      # id_or_email - Required. The String id or email address of the subscriber.
+      #
+      # Returns No Content.
+      # See https://www.getdrip.com/docs/rest-api#fdelete_subscriber
+      def unsubscribe_from_all(id_or_email)
+        post "#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe_all"
+      end
     end
   end
 end

data/lib/drip/client/webhooks.rb

@@ -0,0 +1,59 @@
+module Drip
+  class Client
+    module Webhooks
+      # Public: List all webhooks.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#webhooks
+      def webhooks
+        get "#{account_id}/webhooks"
+      end
+
+      # Public: Fetch a webhook
+      # id - Required. The String id of the webhook
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#webhooks
+      def webhook(id)
+        get "#{account_id}/webhooks/#{id}"
+      end
+
+      # Public: Create a webhook.
+      #
+      # post_url               - Required. The String url that the webhook will post to.
+      # include_received_email - Optional. A Boolean specifying whether we should send a
+      #                             notification whenever a subscriber receives an email.
+      #                             Defaults to false.
+      # events                 - Optional. An Array of which events we should send
+      #                             notifications for. Eligible events can be found in the
+      #                             webhooks documentation here: https://www.getdrip.com/docs/webhooks#events.
+      #                             By default, we will send notifications for all events except
+      #                             `subscrber.received_email`.
+      #
+      # Returns a Drip::Response
+      # See https://www.getdrip.com/docs/rest-api#subscriber_batches
+      def create_webhook(post_url, include_received_email, events)
+        include_received_email = include_received_email ? true : false
+        url = "#{account_id}/webhooks"
+
+        post url, generate_resource(
+          "webhooks",
+          {
+            "post_url" => post_url,
+            "include_received_email" => include_received_email,
+            "events" => events
+          }
+        )
+      end
+
+      # Public: List all webhooks.
+      # id - Required. The String id of the webhook
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#webhooks
+      def delete_webhook(id)
+        delete "#{account_id}/webhooks/#{id}"
+      end
+    end
+  end
+end

data/lib/drip/client/workflow_triggers.rb

@@ -0,0 +1,44 @@
+module Drip
+  class Client
+    module WorkflowTriggers
+      # Public: List all workflow triggers.
+      # id - Required. The String id of the workflow
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflow_triggers
+      def workflow_triggers(id)
+        get "#{account_id}/workflows/#{id}/triggers"
+      end
+
+      # Public: Create a workflow trigger.
+      # id - Required. The String id of the workflow
+      #
+      # options - A Hash of options.
+      #           - provider      - Required. Required. A String indicating a provider.
+      #           - trigger_type  - Required. A String indicating the automation
+      #                             trigger type.
+      #           - properties    - Optional. An Object containing properties for the given trigger.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def create_workflow_trigger(id, options = {})
+        post "#{account_id}/workflows/#{id}/triggers", generate_resource("triggers", options)
+      end
+
+      # Public: Update a workflow trigger.
+      # id - Required. The String id of the workflow trigger
+      #
+      # options - A Hash of options.
+      #           - provider      - Required. Required. A String indicating a provider.
+      #           - trigger_type  - Required. A String indicating the automation
+      #                             trigger type.
+      #           - properties    - Optional. An Object containing properties for the given trigger.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def update_workflow_trigger(id, options = {})
+        put "#{account_id}/workflows/#{id}/triggers", generate_resource("triggers", options)
+      end
+    end
+  end
+end

data/lib/drip/client/workflows.rb

@@ -0,0 +1,80 @@
+require "cgi"
+
+module Drip
+  class Client
+    module Workflows
+      # Public: List all workflows.
+      #
+      # options - A Hash of options
+      #           - status - Optional. Filter by one of the following statuses:
+      #                      draft, active, or paused. Defaults to all.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def workflows(options = {})
+        get "#{account_id}/workflows", options
+      end
+
+      # Public: Fetch a workflow.
+      # id - Required. The String id of the workflow
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def workflow(id)
+        get "#{account_id}/workflows/#{id}"
+      end
+
+      # Public: Activate a workflow.
+      # id - Required. The String id of the workflow
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def activate_workflow(id)
+        post "#{account_id}/workflows/#{id}/activate"
+      end
+
+      # Public: Pause a workflow.
+      # id - Required. The String id of the workflow
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def pause_workflow(id)
+        post "#{account_id}/workflows/#{id}/pause"
+      end
+
+      # Public: Start someone on a workflow.
+      # id - Required. The String id of the workflow
+      #
+      # options - A Hash of options.
+      #           - email         - Optional. A new email address for the subscriber.
+      #                             If provided and a subscriber with the email above
+      #                             does not exist, this address will be used to
+      #                             create a new subscriber.
+      #           - id            - Optional. The subscriber's Drip id. Either email or id must be included.
+      #           - user_id       - Optional. A unique identifier for the user in your database,
+      #                             such as a primary key.
+      #           - time_zone     - Optional. The subscriber's time zone (in Olson
+      #                             format). Defaults to Etc/UTC.
+      #           - custom_fields - Optional. A Hash of custom field data.
+      #           - tags          - Optional. An Array of tags.
+      #           - prospect      - Optional. A Boolean specifiying whether we should attach a lead
+      #                             score to the subscriber (when lead scoring is enabled). Defaults to true
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def start_subscriber_workflow(id, options = {})
+        post "#{account_id}/workflows/#{id}/subscribers", generate_resource("subscribers", options)
+      end
+
+      # Public: Remove someone from a workflow.
+      # id          - Required. The String id of the workflow
+      # id_or_email - Required. The String id or email address of the subscriber.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#workflows
+      def remove_subscriber_workflow(workflow_id, id_or_email)
+        delete "#{account_id}/workflows/#{workflow_id}/subscribers/#{CGI.escape id_or_email}"
+      end
+    end
+  end
+end

data/lib/drip/collections.rb

@@ -1,23 +1,35 @@
 require "drip/collections/accounts"
-require "drip/collections/subscribers"
-require "drip/collections/tags"
+require "drip/collections/broadcasts"
+require "drip/collections/campaigns"
+require "drip/collections/campaign_subscriptions"
 require "drip/collections/errors"
 require "drip/collections/purchases"
+require "drip/collections/subscribers"
+require "drip/collections/tags"
+require "drip/collections/webhooks"
+require "drip/collections/workflows"
+require "drip/collections/workflow_triggers"
 
 module Drip
   module Collections
     def self.classes
       [
         Drip::Accounts,
-        Drip::Subscribers,
+        Drip::Broadcasts,
+        Drip::Campaigns,
+        Drip::CampaignSubscriptions,
         Drip::Errors,
+        Drip::Purchases,
+        Drip::Subscribers,
         Drip::Tags,
-        Drip::Purchases
+        Drip::Webhooks,
+        Drip::Workflows,
+        Drip::WorkflowTriggers
       ]
     end
 
     def self.find_class(name)
-      self.classes.find { |c| c.collection_name == name } || Drip::Collection
+      classes.find { |c| c.collection_name == name } || Drip::Collection
     end
   end
 end