mandrill-rb 1.0.52 → 1.0.53

data/lib/mandrill/templates.rb

@@ -0,0 +1,219 @@
+module Mandrill
+  class Templates
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Add a new template
+    # @param [String] name the name for the new template - must be unique
+    # @param [String] from_email a default sending address for emails sent using this template
+    # @param [String] from_name a default from name to be used
+    # @param [String] subject a default subject line to be used
+    # @param [String] code the HTML code for the template with mc:edit attributes for the editable elements
+    # @param [String] text a default text part to be used when sending with this template
+    # @param [Boolean] publish set to false to add a draft template without publishing
+    # @param [Array] labels an optional array of up to 10 labels to use for filtering templates
+    #     - [String] labels[] a single label
+    # @return [Hash] the information saved about the new template
+    #     - [String] slug the immutable unique code name of the template
+    #     - [String] name the name of the template
+    #     - [Array] labels the list of labels applied to the template
+    #         - [String] labels[] a single label
+    #     - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #     - [String] subject the subject line of the template, if provided - draft version
+    #     - [String] from_email the default sender address for the template, if provided - draft version
+    #     - [String] from_name the default sender from name for the template, if provided - draft version
+    #     - [String] text the default text part of messages sent with the template, if provided - draft version
+    #     - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #     - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #     - [String] publish_subject the subject line of the template, if provided
+    #     - [String] publish_from_email the default sender address for the template, if provided
+    #     - [String] publish_from_name the default sender from name for the template, if provided
+    #     - [String] publish_text the default text part of messages sent with the template, if provided
+    #     - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #     - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def add(name, from_email=nil, from_name=nil, subject=nil, code=nil, text=nil, publish=true, labels=[])
+      _params = {:name => name, :from_email => from_email, :from_name => from_name, :subject => subject, :code => code, :text => text, :publish => publish, :labels => labels}
+      return @master.call 'templates/add', _params
+    end
+
+    # Get the information for an existing template
+    # @param [String] name the immutable name of an existing template
+    # @return [Hash] the requested template information
+    #     - [String] slug the immutable unique code name of the template
+    #     - [String] name the name of the template
+    #     - [Array] labels the list of labels applied to the template
+    #         - [String] labels[] a single label
+    #     - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #     - [String] subject the subject line of the template, if provided - draft version
+    #     - [String] from_email the default sender address for the template, if provided - draft version
+    #     - [String] from_name the default sender from name for the template, if provided - draft version
+    #     - [String] text the default text part of messages sent with the template, if provided - draft version
+    #     - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #     - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #     - [String] publish_subject the subject line of the template, if provided
+    #     - [String] publish_from_email the default sender address for the template, if provided
+    #     - [String] publish_from_name the default sender from name for the template, if provided
+    #     - [String] publish_text the default text part of messages sent with the template, if provided
+    #     - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #     - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def info(name)
+      _params = {:name => name}
+      return @master.call 'templates/info', _params
+    end
+
+    # Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
+    # @param [String] name the immutable name of an existing template
+    # @param [String] from_email the new default sending address
+    # @param [String] from_name the new default from name
+    # @param [String] subject the new default subject line
+    # @param [String] code the new code for the template
+    # @param [String] text the new default text part to be used
+    # @param [Boolean] publish set to false to update the draft version of the template without publishing
+    # @param [Array] labels an optional array of up to 10 labels to use for filtering templates
+    #     - [String] labels[] a single label
+    # @return [Hash] the template that was updated
+    #     - [String] slug the immutable unique code name of the template
+    #     - [String] name the name of the template
+    #     - [Array] labels the list of labels applied to the template
+    #         - [String] labels[] a single label
+    #     - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #     - [String] subject the subject line of the template, if provided - draft version
+    #     - [String] from_email the default sender address for the template, if provided - draft version
+    #     - [String] from_name the default sender from name for the template, if provided - draft version
+    #     - [String] text the default text part of messages sent with the template, if provided - draft version
+    #     - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #     - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #     - [String] publish_subject the subject line of the template, if provided
+    #     - [String] publish_from_email the default sender address for the template, if provided
+    #     - [String] publish_from_name the default sender from name for the template, if provided
+    #     - [String] publish_text the default text part of messages sent with the template, if provided
+    #     - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #     - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def update(name, from_email=nil, from_name=nil, subject=nil, code=nil, text=nil, publish=true, labels=nil)
+      _params = {:name => name, :from_email => from_email, :from_name => from_name, :subject => subject, :code => code, :text => text, :publish => publish, :labels => labels}
+      return @master.call 'templates/update', _params
+    end
+
+    # Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
+    # @param [String] name the immutable name of an existing template
+    # @return [Hash] the template that was published
+    #     - [String] slug the immutable unique code name of the template
+    #     - [String] name the name of the template
+    #     - [Array] labels the list of labels applied to the template
+    #         - [String] labels[] a single label
+    #     - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #     - [String] subject the subject line of the template, if provided - draft version
+    #     - [String] from_email the default sender address for the template, if provided - draft version
+    #     - [String] from_name the default sender from name for the template, if provided - draft version
+    #     - [String] text the default text part of messages sent with the template, if provided - draft version
+    #     - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #     - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #     - [String] publish_subject the subject line of the template, if provided
+    #     - [String] publish_from_email the default sender address for the template, if provided
+    #     - [String] publish_from_name the default sender from name for the template, if provided
+    #     - [String] publish_text the default text part of messages sent with the template, if provided
+    #     - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #     - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def publish(name)
+      _params = {:name => name}
+      return @master.call 'templates/publish', _params
+    end
+
+    # Delete a template
+    # @param [String] name the immutable name of an existing template
+    # @return [Hash] the template that was deleted
+    #     - [String] slug the immutable unique code name of the template
+    #     - [String] name the name of the template
+    #     - [Array] labels the list of labels applied to the template
+    #         - [String] labels[] a single label
+    #     - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #     - [String] subject the subject line of the template, if provided - draft version
+    #     - [String] from_email the default sender address for the template, if provided - draft version
+    #     - [String] from_name the default sender from name for the template, if provided - draft version
+    #     - [String] text the default text part of messages sent with the template, if provided - draft version
+    #     - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #     - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #     - [String] publish_subject the subject line of the template, if provided
+    #     - [String] publish_from_email the default sender address for the template, if provided
+    #     - [String] publish_from_name the default sender from name for the template, if provided
+    #     - [String] publish_text the default text part of messages sent with the template, if provided
+    #     - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #     - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def delete(name)
+      _params = {:name => name}
+      return @master.call 'templates/delete', _params
+    end
+
+    # Return a list of all the templates available to this user
+    # @param [String] label an optional label to filter the templates
+    # @return [Array] an array of structs with information about each template
+    #     - [Hash] return[] the information on each template in the account
+    #         - [String] slug the immutable unique code name of the template
+    #         - [String] name the name of the template
+    #         - [Array] labels the list of labels applied to the template
+    #             - [String] labels[] a single label
+    #         - [String] code the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
+    #         - [String] subject the subject line of the template, if provided - draft version
+    #         - [String] from_email the default sender address for the template, if provided - draft version
+    #         - [String] from_name the default sender from name for the template, if provided - draft version
+    #         - [String] text the default text part of messages sent with the template, if provided - draft version
+    #         - [String] publish_name the same as the template name - kept as a separate field for backwards compatibility
+    #         - [String] publish_code the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
+    #         - [String] publish_subject the subject line of the template, if provided
+    #         - [String] publish_from_email the default sender address for the template, if provided
+    #         - [String] publish_from_name the default sender from name for the template, if provided
+    #         - [String] publish_text the default text part of messages sent with the template, if provided
+    #         - [String] published_at the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
+    #         - [String] created_at the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [String] updated_at the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
+    def list(label=nil)
+      _params = {:label => label}
+      return @master.call 'templates/list', _params
+    end
+
+    # Return the recent history (hourly stats for the last 30 days) for a template
+    # @param [String] name the name of an existing template
+    # @return [Array] the array of history information
+    #     - [Hash] return[] the stats for a single hour
+    #         - [String] time the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
+    #         - [Integer] sent the number of emails that were sent during the hour
+    #         - [Integer] hard_bounces the number of emails that hard bounced during the hour
+    #         - [Integer] soft_bounces the number of emails that soft bounced during the hour
+    #         - [Integer] rejects the number of emails that were rejected during the hour
+    #         - [Integer] complaints the number of spam complaints received during the hour
+    #         - [Integer] opens the number of emails opened during the hour
+    #         - [Integer] unique_opens the number of unique opens generated by messages sent during the hour
+    #         - [Integer] clicks the number of tracked URLs clicked during the hour
+    #         - [Integer] unique_clicks the number of unique clicks generated by messages sent during the hour
+    def time_series(name)
+      _params = {:name => name}
+      return @master.call 'templates/time-series', _params
+    end
+
+    # Inject content and optionally merge fields into a template, returning the HTML that results
+    # @param [String] template_name the immutable name of a template that exists in the user's account
+    # @param [Array] template_content an array of template content to render.  Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
+    #     - [Hash] template_content[] the injection of a single piece of content into a single editable region
+    #         - [String] name the name of the mc:edit editable region to inject into
+    #         - [String] content the content to inject
+    # @param [Array] merge_vars optional merge variables to use for injecting merge field content.  If this is not provided, no merge fields will be replaced.
+    #     - [Hash] merge_vars[] a single merge variable
+    #         - [String] name the merge variable's name. Merge variable names are case-insensitive and may not start with _
+    #         - [String] content the merge variable's content
+    # @return [Hash] the result of rendering the given template with the content and merge field values injected
+    #     - [String] html the rendered HTML as a string
+    def render(template_name, template_content, merge_vars=nil)
+      _params = {:template_name => template_name, :template_content => template_content, :merge_vars => merge_vars}
+      return @master.call 'templates/render', _params
+    end
+
+  end
+end

data/lib/mandrill/urls.rb

@@ -0,0 +1,96 @@
+module Mandrill
+  class Urls
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Get the 100 most clicked URLs
+    # @return [Array] the 100 most clicked URLs and their stats
+    #     - [Hash] return[] the individual URL stats
+    #         - [String] url the URL to be tracked
+    #         - [Integer] sent the number of emails that contained the URL
+    #         - [Integer] clicks the number of times the URL has been clicked from a tracked email
+    #         - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL
+    def list()
+      _params = {}
+      return @master.call 'urls/list', _params
+    end
+
+    # Return the 100 most clicked URLs that match the search query given
+    # @param [String] q a search query
+    # @return [Array] the 100 most clicked URLs matching the search query
+    #     - [Hash] return[] the URL matching the query
+    #         - [String] url the URL to be tracked
+    #         - [Integer] sent the number of emails that contained the URL
+    #         - [Integer] clicks the number of times the URL has been clicked from a tracked email
+    #         - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL
+    def search(q)
+      _params = {:q => q}
+      return @master.call 'urls/search', _params
+    end
+
+    # Return the recent history (hourly stats for the last 30 days) for a url
+    # @param [String] url an existing URL
+    # @return [Array] the array of history information
+    #     - [Hash] return[] the information for a single hour
+    #         - [String] time the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
+    #         - [Integer] sent the number of emails that were sent with the URL during the hour
+    #         - [Integer] clicks the number of times the URL was clicked during the hour
+    #         - [Integer] unique_clicks the number of unique clicks generated for emails sent with this URL during the hour
+    def time_series(url)
+      _params = {:url => url}
+      return @master.call 'urls/time-series', _params
+    end
+
+    # Get the list of tracking domains set up for this account
+    # @return [Array] the tracking domains and their status
+    #     - [Hash] return[] the individual tracking domain
+    #         - [String] domain the tracking domain name
+    #         - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [String] last_tested_at when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [Hash] cname details about the domain's CNAME record
+    #             - [Boolean] valid whether the domain's CNAME record is valid for use with Mandrill
+    #             - [String] valid_after when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
+    #             - [String] error an error describing the CNAME record, or null if the record is correct
+    #         - [Boolean] valid_tracking whether this domain can be used as a tracking domain for email.
+    def tracking_domains()
+      _params = {}
+      return @master.call 'urls/tracking-domains', _params
+    end
+
+    # Add a tracking domain to your account
+    # @param [String] domain a domain name
+    # @return [Hash] information about the domain
+    #     - [String] domain the tracking domain name
+    #     - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_tested_at when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Hash] cname details about the domain's CNAME record
+    #         - [Boolean] valid whether the domain's CNAME record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
+    #         - [String] error an error describing the CNAME record, or null if the record is correct
+    #     - [Boolean] valid_tracking whether this domain can be used as a tracking domain for email.
+    def add_tracking_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'urls/add-tracking-domain', _params
+    end
+
+    # Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
+    # @param [String] domain an existing tracking domain name
+    # @return [Hash] information about the tracking domain
+    #     - [String] domain the tracking domain name
+    #     - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_tested_at when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Hash] cname details about the domain's CNAME record
+    #         - [Boolean] valid whether the domain's CNAME record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
+    #         - [String] error an error describing the CNAME record, or null if the record is correct
+    #     - [Boolean] valid_tracking whether this domain can be used as a tracking domain for email.
+    def check_tracking_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'urls/check-tracking-domain', _params
+    end
+
+  end
+end

data/lib/mandrill/users.rb

@@ -0,0 +1,117 @@
+module Mandrill
+  class Users
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Return the information about the API-connected user
+    # @return [Hash] the user information including username, key, reputation, quota, and historical sending stats
+    #     - [String] username the username of the user (used for SMTP authentication)
+    #     - [String] created_at the date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] public_id a unique, permanent identifier for this user
+    #     - [Integer] reputation the reputation of the user on a scale from 0 to 100, with 75 generally being a "good" reputation
+    #     - [Integer] hourly_quota the maximum number of emails Mandrill will deliver for this user each hour.  Any emails beyond that will be accepted and queued for later delivery.  Users with higher reputations will have higher hourly quotas
+    #     - [Integer] backlog the number of emails that are queued for delivery due to exceeding your monthly or hourly quotas
+    #     - [Hash] stats an aggregate summary of the account's sending stats
+    #         - [Hash] today stats for this user so far today
+    #             - [Integer] sent the number of emails sent for this user so far today
+    #             - [Integer] hard_bounces the number of emails hard bounced for this user so far today
+    #             - [Integer] soft_bounces the number of emails soft bounced for this user so far today
+    #             - [Integer] rejects the number of emails rejected for sending this user so far today
+    #             - [Integer] complaints the number of spam complaints for this user so far today
+    #             - [Integer] unsubs the number of unsubscribes for this user so far today
+    #             - [Integer] opens the number of times emails have been opened for this user so far today
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this user so far today
+    #             - [Integer] clicks the number of URLs that have been clicked for this user so far today
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this user so far today
+    #         - [Hash] last_7_days stats for this user in the last 7 days
+    #             - [Integer] sent the number of emails sent for this user in the last 7 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this user in the last 7 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this user in the last 7 days
+    #             - [Integer] rejects the number of emails rejected for sending this user in the last 7 days
+    #             - [Integer] complaints the number of spam complaints for this user in the last 7 days
+    #             - [Integer] unsubs the number of unsubscribes for this user in the last 7 days
+    #             - [Integer] opens the number of times emails have been opened for this user in the last 7 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this user in the last 7 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this user in the last 7 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this user in the last 7 days
+    #         - [Hash] last_30_days stats for this user in the last 30 days
+    #             - [Integer] sent the number of emails sent for this user in the last 30 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this user in the last 30 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this user in the last 30 days
+    #             - [Integer] rejects the number of emails rejected for sending this user in the last 30 days
+    #             - [Integer] complaints the number of spam complaints for this user in the last 30 days
+    #             - [Integer] unsubs the number of unsubscribes for this user in the last 30 days
+    #             - [Integer] opens the number of times emails have been opened for this user in the last 30 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this user in the last 30 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this user in the last 30 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this user in the last 30 days
+    #         - [Hash] last_60_days stats for this user in the last 60 days
+    #             - [Integer] sent the number of emails sent for this user in the last 60 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this user in the last 60 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this user in the last 60 days
+    #             - [Integer] rejects the number of emails rejected for sending this user in the last 60 days
+    #             - [Integer] complaints the number of spam complaints for this user in the last 60 days
+    #             - [Integer] unsubs the number of unsubscribes for this user in the last 60 days
+    #             - [Integer] opens the number of times emails have been opened for this user in the last 60 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this user in the last 60 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this user in the last 60 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this user in the last 60 days
+    #         - [Hash] last_90_days stats for this user in the last 90 days
+    #             - [Integer] sent the number of emails sent for this user in the last 90 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this user in the last 90 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this user in the last 90 days
+    #             - [Integer] rejects the number of emails rejected for sending this user in the last 90 days
+    #             - [Integer] complaints the number of spam complaints for this user in the last 90 days
+    #             - [Integer] unsubs the number of unsubscribes for this user in the last 90 days
+    #             - [Integer] opens the number of times emails have been opened for this user in the last 90 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this user in the last 90 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this user in the last 90 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this user in the last 90 days
+    #         - [Hash] all_time stats for the lifetime of the user's account
+    #             - [Integer] sent the number of emails sent in the lifetime of the user's account
+    #             - [Integer] hard_bounces the number of emails hard bounced in the lifetime of the user's account
+    #             - [Integer] soft_bounces the number of emails soft bounced in the lifetime of the user's account
+    #             - [Integer] rejects the number of emails rejected for sending this user so far today
+    #             - [Integer] complaints the number of spam complaints in the lifetime of the user's account
+    #             - [Integer] unsubs the number of unsubscribes in the lifetime of the user's account
+    #             - [Integer] opens the number of times emails have been opened in the lifetime of the user's account
+    #             - [Integer] unique_opens the number of unique opens for emails sent in the lifetime of the user's account
+    #             - [Integer] clicks the number of URLs that have been clicked in the lifetime of the user's account
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent in the lifetime of the user's account
+    def info()
+      _params = {}
+      return @master.call 'users/info', _params
+    end
+
+    # Validate an API key and respond to a ping (anal JSON parser version)
+    # @return [Hash] a struct with one key "PING" with a static value "PONG!"
+    def ping()
+      _params = {}
+      return @master.call 'users/ping2', _params
+    end
+
+    # Return the senders that have tried to use this account, both verified and unverified
+    # @return [Array] an array of sender data, one for each sending addresses used by the account
+    #     - [Hash] return[] the information on each sending address in the account
+    #         - [String] address the sender's email address
+    #         - [String] created_at the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
+    #         - [Integer] sent the total number of messages sent by this sender
+    #         - [Integer] hard_bounces the total number of hard bounces by messages by this sender
+    #         - [Integer] soft_bounces the total number of soft bounces by messages by this sender
+    #         - [Integer] rejects the total number of rejected messages by this sender
+    #         - [Integer] complaints the total number of spam complaints received for messages by this sender
+    #         - [Integer] unsubs the total number of unsubscribe requests received for messages by this sender
+    #         - [Integer] opens the total number of times messages by this sender have been opened
+    #         - [Integer] clicks the total number of times tracked URLs in messages by this sender have been clicked
+    #         - [Integer] unique_opens the number of unique opens for emails sent for this sender
+    #         - [Integer] unique_clicks the number of unique clicks for emails sent for this sender
+    def senders()
+      _params = {}
+      return @master.call 'users/senders', _params
+    end
+
+  end
+end

data/lib/mandrill/version.rb

@@ -0,0 +1,3 @@
+module Mandrill
+  VERSION = "1.0.53"
+end

data/lib/mandrill/webhooks.rb

@@ -0,0 +1,112 @@
+module Mandrill
+  class Webhooks
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Get the list of all webhooks defined on the account
+    # @return [Array] the webhooks associated with the account
+    #     - [Hash] return[] the individual webhook info
+    #         - [Integer] id a unique integer indentifier for the webhook
+    #         - [String] url The URL that the event data will be posted to
+    #         - [String] description a description of the webhook
+    #         - [String] auth_key the key used to requests for this webhook
+    #         - [Array] events The message events that will be posted to the hook
+    #             - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
+    #         - [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [Integer] batches_sent the number of event batches that have ever been sent to this webhook
+    #         - [Integer] events_sent the total number of events that have ever been sent to this webhook
+    #         - [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen
+    def list()
+      _params = {}
+      return @master.call 'webhooks/list', _params
+    end
+
+    # Add a new webhook
+    # @param [String] url the URL to POST batches of events
+    # @param [String] description an optional description of the webhook
+    # @param [Array] events an optional list of events that will be posted to the webhook
+    #     - [String] events[] the individual event to listen for
+    # @return [Hash] the information saved about the new webhook
+    #     - [Integer] id a unique integer indentifier for the webhook
+    #     - [String] url The URL that the event data will be posted to
+    #     - [String] description a description of the webhook
+    #     - [String] auth_key the key used to requests for this webhook
+    #     - [Array] events The message events that will be posted to the hook
+    #         - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
+    #     - [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] batches_sent the number of event batches that have ever been sent to this webhook
+    #     - [Integer] events_sent the total number of events that have ever been sent to this webhook
+    #     - [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen
+    def add(url, description=nil, events=[])
+      _params = {:url => url, :description => description, :events => events}
+      return @master.call 'webhooks/add', _params
+    end
+
+    # Given the ID of an existing webhook, return the data about it
+    # @param [Integer] id the unique identifier of a webhook belonging to this account
+    # @return [Hash] the information about the webhook
+    #     - [Integer] id a unique integer indentifier for the webhook
+    #     - [String] url The URL that the event data will be posted to
+    #     - [String] description a description of the webhook
+    #     - [String] auth_key the key used to requests for this webhook
+    #     - [Array] events The message events that will be posted to the hook
+    #         - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
+    #     - [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] batches_sent the number of event batches that have ever been sent to this webhook
+    #     - [Integer] events_sent the total number of events that have ever been sent to this webhook
+    #     - [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen
+    def info(id)
+      _params = {:id => id}
+      return @master.call 'webhooks/info', _params
+    end
+
+    # Update an existing webhook
+    # @param [Integer] id the unique identifier of a webhook belonging to this account
+    # @param [String] url the URL to POST batches of events
+    # @param [String] description an optional description of the webhook
+    # @param [Array] events an optional list of events that will be posted to the webhook
+    #     - [String] events[] the individual event to listen for
+    # @return [Hash] the information for the updated webhook
+    #     - [Integer] id a unique integer indentifier for the webhook
+    #     - [String] url The URL that the event data will be posted to
+    #     - [String] description a description of the webhook
+    #     - [String] auth_key the key used to requests for this webhook
+    #     - [Array] events The message events that will be posted to the hook
+    #         - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
+    #     - [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] batches_sent the number of event batches that have ever been sent to this webhook
+    #     - [Integer] events_sent the total number of events that have ever been sent to this webhook
+    #     - [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen
+    def update(id, url, description=nil, events=[])
+      _params = {:id => id, :url => url, :description => description, :events => events}
+      return @master.call 'webhooks/update', _params
+    end
+
+    # Delete an existing webhook
+    # @param [Integer] id the unique identifier of a webhook belonging to this account
+    # @return [Hash] the information for the deleted webhook
+    #     - [Integer] id a unique integer indentifier for the webhook
+    #     - [String] url The URL that the event data will be posted to
+    #     - [String] description a description of the webhook
+    #     - [String] auth_key the key used to requests for this webhook
+    #     - [Array] events The message events that will be posted to the hook
+    #         - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
+    #     - [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] batches_sent the number of event batches that have ever been sent to this webhook
+    #     - [Integer] events_sent the total number of events that have ever been sent to this webhook
+    #     - [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen
+    def delete(id)
+      _params = {:id => id}
+      return @master.call 'webhooks/delete', _params
+    end
+
+  end
+end