Module: Drip::Client::Subscribers

Included in:

Drip::Client

Defined in:

lib/drip/client/subscribers.rb

Instance Method Summary

• #create_or_update_subscriber(email, options = {}) ⇒ Object

  Public: Create or update a subscriber.

• #create_or_update_subscribers(subscribers) ⇒ Object

  Public: Create or update a collection of subscribers.

• #subscribe(email, campaign_id, options = {}) ⇒ Object

  Public: Subscribe to a campaign.

• #subscriber(id_or_email) ⇒ Object

  Public: Fetch a subscriber.

• #unsubscribe(id_or_email, options = {}) ⇒ Object

  Public: Unsubscribe a subscriber globally or from a specific campaign.

Instance Method Details

#create_or_update_subscriber(email, options = {}) ⇒ Object

Public: Create or update a subscriber.

options - A Hash of options.

- email         - Required. The String subscriber email address.
- new_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.
- time_zone     - Optional. The subscriber's time zone (in Olsen
                  format). Defaults to Etc/UTC.
- custom_fields - Optional. A Hash of custom field data.
- tags          - Optional. An Array of tags.

Returns a Drip::Response. See www.getdrip.com/docs/rest-api#create_or_update_subscriber

# File 'lib/drip/client/subscribers.rb', line 31

def create_or_update_subscriber(email, options = {})
  data = options.merge(:email => email)
  post "#{account_id}/subscribers", generate_resource("subscribers", data)
end

#create_or_update_subscribers(subscribers) ⇒ Object

Public: Create or update a collection of subscribers.

subscribers - Required. An Array of between 1 and 1000 Hashes of subscriber data.

- email         - Required. The String subscriber email address.
- new_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.
- time_zone     - Optional. The subscriber's time zone (in Olsen
                  format). Defaults to Etc/UTC.
- custom_fields - Optional. A Hash of custom field data.
- tags          - Optional. An Array of tags.

Returns a Drip::Response See www.getdrip.com/docs/rest-api#subscriber_batches

# File 'lib/drip/client/subscribers.rb', line 51

def create_or_update_subscribers(subscribers)
  url = "#{account_id}/subscribers/batches"
  post url, generate_resource("batches", { "subscribers" => subscribers })
end

#subscribe(email, campaign_id, options = {}) ⇒ Object

Public: Subscribe to a campaign.

email - Required. The String email address of the subscriber. campaign_id - Required. The String campaign id. options - Optional. A Hash of options.

- double_optin  - Optional. If true, the double opt-in confirmation
                  email is sent; if false, the confirmation
                  email is skipped. Defaults to the value set
                  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
                  format). Defaults to Etc/UTC.
- custom_fields - Optional. A Hash of custom field data.
- tags          - Optional. An Array of tags.
- reactivate_if_removed - Optional. If true, re-subscribe
                  the subscriber to the campaign if there
                  is a removed subscriber in Drip with the same
                  email address; otherwise, respond with
                  422 Unprocessable Entity. Defaults to true.

Returns a Drip::Response. See www.getdrip.com/docs/rest-api#subscribe

# File 'lib/drip/client/subscribers.rb', line 94

def subscribe(email, campaign_id, options = {})
  data = options.merge("email" => email)
  url = "#{account_id}/campaigns/#{campaign_id}/subscribers"
  post url, generate_resource("subscribers", data)
end

#subscriber(id_or_email) ⇒ Object

Public: Fetch a subscriber.

id_or_email - Required. The String id or email address of the subscriber.

Returns a Drip::Response. See www.getdrip.com/docs/rest-api#fetch_subscriber

# File 'lib/drip/client/subscribers.rb', line 12

def subscriber(id_or_email)
  get "#{account_id}/subscribers/#{CGI.escape id_or_email}"
end

#unsubscribe(id_or_email, options = {}) ⇒ Object

Public: Unsubscribe a subscriber globally or from a specific campaign.

id_or_email - Required. The String id or email address of the subscriber. options - A Hash of options.

- campaign_id - Optional. The campaign from which to
                unsubscribe the subscriber. Defaults to all.

Returns a Drip::Response. See www.getdrip.com/docs/rest-api#unsubscribe

# File 'lib/drip/client/subscribers.rb', line 65

def unsubscribe(id_or_email, options = {})
  url = "#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe"
  url += options[:campaign_id] ? "?campaign_id=#{options[:campaign_id]}" : ""
  post url
end