mandrill-rb 1.0.52 → 1.0.53

data/lib/mandrill/senders.rb

@@ -0,0 +1,198 @@
+module Mandrill
+  class Senders
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Return the senders that have tried to use this account.
+    # @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 list()
+      _params = {}
+      return @master.call 'senders/list', _params
+    end
+
+    # Returns the sender domains that have been added to this account.
+    # @return [Array] an array of sender domain data, one for each sending domain used by the account
+    #     - [Hash] return[] the information on each sending domain for the account
+    #         - [String] domain the sender domain name
+    #         - [String] created_at the date and time that the sending domain was first seen 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] spf details about the domain's SPF record
+    #             - [Boolean] valid whether the domain's SPF record is valid for use with Mandrill
+    #             - [String] valid_after when the domain's SPF 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 spf record, or null if the record is correct
+    #         - [Hash] dkim details about the domain's DKIM record
+    #             - [Boolean] valid whether the domain's DKIM record is valid for use with Mandrill
+    #             - [String] valid_after when the domain's DKIM 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 DKIM record, or null if the record is correct
+    #         - [String] verified_at if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [Boolean] valid_signing whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
+    def domains()
+      _params = {}
+      return @master.call 'senders/domains', _params
+    end
+
+    # Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
+    # @param [String] domain a domain name
+    # @return [Hash] information about the domain
+    #     - [String] domain the sender domain name
+    #     - [String] created_at the date and time that the sending domain was first seen 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] spf details about the domain's SPF record
+    #         - [Boolean] valid whether the domain's SPF record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's SPF 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 spf record, or null if the record is correct
+    #     - [Hash] dkim details about the domain's DKIM record
+    #         - [Boolean] valid whether the domain's DKIM record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's DKIM 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 DKIM record, or null if the record is correct
+    #     - [String] verified_at if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Boolean] valid_signing whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
+    def add_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'senders/add-domain', _params
+    end
+
+    # Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
+    # @param [String] domain a domain name
+    # @return [Hash] information about the sender domain
+    #     - [String] domain the sender domain name
+    #     - [String] created_at the date and time that the sending domain was first seen 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] spf details about the domain's SPF record
+    #         - [Boolean] valid whether the domain's SPF record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's SPF 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 spf record, or null if the record is correct
+    #     - [Hash] dkim details about the domain's DKIM record
+    #         - [Boolean] valid whether the domain's DKIM record is valid for use with Mandrill
+    #         - [String] valid_after when the domain's DKIM 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 DKIM record, or null if the record is correct
+    #     - [String] verified_at if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Boolean] valid_signing whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
+    def check_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'senders/check-domain', _params
+    end
+
+    # Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
+    # @param [String] domain a domain name at which you can receive email
+    # @param [String] mailbox a mailbox at the domain where the verification email should be sent
+    # @return [Hash] information about the verification that was sent
+    #     - [String] status "sent" indicates that the verification has been sent, "already_verified" indicates that the domain has already been verified with your account
+    #     - [String] domain the domain name you provided
+    #     - [String] email the email address the verification email was sent to
+    def verify_domain(domain, mailbox)
+      _params = {:domain => domain, :mailbox => mailbox}
+      return @master.call 'senders/verify-domain', _params
+    end
+
+    # Return more detailed information about a single sender, including aggregates of recent stats
+    # @param [String] address the email address of the sender
+    # @return [Hash] the detailed information on the sender
+    #     - [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
+    #     - [Hash] stats an aggregate summary of the sender's sending stats
+    #         - [Hash] today stats for this sender so far today
+    #             - [Integer] sent the number of emails sent for this sender so far today
+    #             - [Integer] hard_bounces the number of emails hard bounced for this sender so far today
+    #             - [Integer] soft_bounces the number of emails soft bounced for this sender so far today
+    #             - [Integer] rejects the number of emails rejected for sending this sender so far today
+    #             - [Integer] complaints the number of spam complaints for this sender so far today
+    #             - [Integer] unsubs the number of unsubscribes for this sender so far today
+    #             - [Integer] opens the number of times emails have been opened for this sender so far today
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this sender so far today
+    #             - [Integer] clicks the number of URLs that have been clicked for this sender so far today
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this sender so far today
+    #         - [Hash] last_7_days stats for this sender in the last 7 days
+    #             - [Integer] sent the number of emails sent for this sender in the last 7 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this sender in the last 7 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this sender in the last 7 days
+    #             - [Integer] rejects the number of emails rejected for sending this sender in the last 7 days
+    #             - [Integer] complaints the number of spam complaints for this sender in the last 7 days
+    #             - [Integer] unsubs the number of unsubscribes for this sender in the last 7 days
+    #             - [Integer] opens the number of times emails have been opened for this sender in the last 7 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this sender in the last 7 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this sender in the last 7 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this sender in the last 7 days
+    #         - [Hash] last_30_days stats for this sender in the last 30 days
+    #             - [Integer] sent the number of emails sent for this sender in the last 30 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this sender in the last 30 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this sender in the last 30 days
+    #             - [Integer] rejects the number of emails rejected for sending this sender in the last 30 days
+    #             - [Integer] complaints the number of spam complaints for this sender in the last 30 days
+    #             - [Integer] unsubs the number of unsubscribes for this sender in the last 30 days
+    #             - [Integer] opens the number of times emails have been opened for this sender in the last 30 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this sender in the last 30 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this sender in the last 30 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this sender in the last 30 days
+    #         - [Hash] last_60_days stats for this sender in the last 60 days
+    #             - [Integer] sent the number of emails sent for this sender in the last 60 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this sender in the last 60 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this sender in the last 60 days
+    #             - [Integer] rejects the number of emails rejected for sending this sender in the last 60 days
+    #             - [Integer] complaints the number of spam complaints for this sender in the last 60 days
+    #             - [Integer] unsubs the number of unsubscribes for this sender in the last 60 days
+    #             - [Integer] opens the number of times emails have been opened for this sender in the last 60 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this sender in the last 60 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this sender in the last 60 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this sender in the last 60 days
+    #         - [Hash] last_90_days stats for this sender in the last 90 days
+    #             - [Integer] sent the number of emails sent for this sender in the last 90 days
+    #             - [Integer] hard_bounces the number of emails hard bounced for this sender in the last 90 days
+    #             - [Integer] soft_bounces the number of emails soft bounced for this sender in the last 90 days
+    #             - [Integer] rejects the number of emails rejected for sending this sender in the last 90 days
+    #             - [Integer] complaints the number of spam complaints for this sender in the last 90 days
+    #             - [Integer] unsubs the number of unsubscribes for this sender in the last 90 days
+    #             - [Integer] opens the number of times emails have been opened for this sender in the last 90 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent for this sender in the last 90 days
+    #             - [Integer] clicks the number of URLs that have been clicked for this sender in the last 90 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent for this sender in the last 90 days
+    def info(address)
+      _params = {:address => address}
+      return @master.call 'senders/info', _params
+    end
+
+    # Return the recent history (hourly stats for the last 30 days) for a sender
+    # @param [String] address the email address of the sender
+    # @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(address)
+      _params = {:address => address}
+      return @master.call 'senders/time-series', _params
+    end
+
+  end
+end

data/lib/mandrill/subaccounts.rb

@@ -0,0 +1,157 @@
+module Mandrill
+  class Subaccounts
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Get the list of subaccounts defined for the account, optionally filtered by a prefix
+    # @param [String] q an optional prefix to filter the subaccounts' ids and names
+    # @return [Array] the subaccounts for the account, up to a maximum of 1,000
+    #     - [Hash] return[] the individual subaccount info
+    #         - [String] id a unique indentifier for the subaccount
+    #         - [String] name an optional display name for the subaccount
+    #         - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #         - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #         - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #         - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #         - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #         - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def list(q=nil)
+      _params = {:q => q}
+      return @master.call 'subaccounts/list', _params
+    end
+
+    # Add a new subaccount
+    # @param [String] id a unique identifier for the subaccount to be used in sending calls
+    # @param [String] name an optional display name to further identify the subaccount
+    # @param [String] notes optional extra text to associate with the subaccount
+    # @param [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation
+    # @return [Hash] the information saved about the new subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def add(id, name=nil, notes=nil, custom_quota=nil)
+      _params = {:id => id, :name => name, :notes => notes, :custom_quota => custom_quota}
+      return @master.call 'subaccounts/add', _params
+    end
+
+    # Given the ID of an existing subaccount, return the data about it
+    # @param [String] id the unique identifier of the subaccount to query
+    # @return [Hash] the information about the subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [String] notes optional extra text to associate with the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    #     - [Integer] sent_hourly the number of emails the subaccount has sent in the last hour
+    #     - [Integer] hourly_quota the current hourly quota for the subaccount, either manual or reputation-based
+    #     - [Hash] last_30_days stats for this subaccount in the last 30 days
+    #         - [Integer] sent the number of emails sent for this subaccount in the last 30 days
+    #         - [Integer] hard_bounces the number of emails hard bounced for this subaccount in the last 30 days
+    #         - [Integer] soft_bounces the number of emails soft bounced for this subaccount in the last 30 days
+    #         - [Integer] rejects the number of emails rejected for sending this subaccount in the last 30 days
+    #         - [Integer] complaints the number of spam complaints for this subaccount in the last 30 days
+    #         - [Integer] unsubs the number of unsbuscribes for this subaccount in the last 30 days
+    #         - [Integer] opens the number of times emails have been opened for this subaccount in the last 30 days
+    #         - [Integer] unique_opens the number of unique opens for emails sent for this subaccount in the last 30 days
+    #         - [Integer] clicks the number of URLs that have been clicked for this subaccount in the last 30 days
+    #         - [Integer] unique_clicks the number of unique clicks for emails sent for this subaccount in the last 30 days
+    def info(id)
+      _params = {:id => id}
+      return @master.call 'subaccounts/info', _params
+    end
+
+    # Update an existing subaccount
+    # @param [String] id the unique identifier of the subaccount to update
+    # @param [String] name an optional display name to further identify the subaccount
+    # @param [String] notes optional extra text to associate with the subaccount
+    # @param [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation
+    # @return [Hash] the information for the updated subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def update(id, name=nil, notes=nil, custom_quota=nil)
+      _params = {:id => id, :name => name, :notes => notes, :custom_quota => custom_quota}
+      return @master.call 'subaccounts/update', _params
+    end
+
+    # Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
+    # @param [String] id the unique identifier of the subaccount to delete
+    # @return [Hash] the information for the deleted subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def delete(id)
+      _params = {:id => id}
+      return @master.call 'subaccounts/delete', _params
+    end
+
+    # Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
+    # @param [String] id the unique identifier of the subaccount to pause
+    # @return [Hash] the information for the paused subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def pause(id)
+      _params = {:id => id}
+      return @master.call 'subaccounts/pause', _params
+    end
+
+    # Resume a paused subaccount's sending
+    # @param [String] id the unique identifier of the subaccount to resume
+    # @return [Hash] the information for the resumed subaccount
+    #     - [String] id a unique indentifier for the subaccount
+    #     - [String] name an optional display name for the subaccount
+    #     - [Integer] custom_quota an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
+    #     - [String] status the current sending status of the subaccount, one of "active" or "paused"
+    #     - [Integer] reputation the subaccount's current reputation on a scale from 0 to 100
+    #     - [String] created_at the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [String] first_sent_at the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Integer] sent_weekly the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
+    #     - [Integer] sent_monthly the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
+    #     - [Integer] sent_total the number of emails the subaccount has sent since it was created
+    def resume(id)
+      _params = {:id => id}
+      return @master.call 'subaccounts/resume', _params
+    end
+
+  end
+end

data/lib/mandrill/tags.rb

@@ -0,0 +1,162 @@
+module Mandrill
+  class Tags
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # Return all of the user-defined tag information
+    # @return [Array] a list of user-defined tags
+    #     - [Hash] return[] a user-defined tag
+    #         - [String] tag the actual tag as a string
+    #         - [Integer] reputation the tag's current reputation on a scale from 0 to 100.
+    #         - [Integer] sent the total number of messages sent with this tag
+    #         - [Integer] hard_bounces the total number of hard bounces by messages with this tag
+    #         - [Integer] soft_bounces the total number of soft bounces by messages with this tag
+    #         - [Integer] rejects the total number of rejected messages with this tag
+    #         - [Integer] complaints the total number of spam complaints received for messages with this tag
+    #         - [Integer] unsubs the total number of unsubscribe requests received for messages with this tag
+    #         - [Integer] opens the total number of times messages with this tag have been opened
+    #         - [Integer] clicks the total number of times tracked URLs in messages with this tag have been clicked
+    #         - [Integer] unique_opens the number of unique opens for emails sent with this tag
+    #         - [Integer] unique_clicks the number of unique clicks for emails sent with this tag
+    def list()
+      _params = {}
+      return @master.call 'tags/list', _params
+    end
+
+    # Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
+    # @param [String] tag a tag name
+    # @return [Hash] the tag that was deleted
+    #     - [String] tag the actual tag as a string
+    #     - [Integer] reputation the tag's current reputation on a scale from 0 to 100.
+    #     - [Integer] sent the total number of messages sent with this tag
+    #     - [Integer] hard_bounces the total number of hard bounces by messages with this tag
+    #     - [Integer] soft_bounces the total number of soft bounces by messages with this tag
+    #     - [Integer] rejects the total number of rejected messages with this tag
+    #     - [Integer] complaints the total number of spam complaints received for messages with this tag
+    #     - [Integer] unsubs the total number of unsubscribe requests received for messages with this tag
+    #     - [Integer] opens the total number of times messages with this tag have been opened
+    #     - [Integer] clicks the total number of times tracked URLs in messages with this tag have been clicked
+    #     - [Integer] unique_opens the number of unique opens for emails sent with this tag
+    #     - [Integer] unique_clicks the number of unique clicks for emails sent with this tag
+    def delete(tag)
+      _params = {:tag => tag}
+      return @master.call 'tags/delete', _params
+    end
+
+    # Return more detailed information about a single tag, including aggregates of recent stats
+    # @param [String] tag an existing tag name
+    # @return [Hash] the detailed information on the tag
+    #     - [String] tag the actual tag as a string
+    #     - [Integer] sent the total number of messages sent with this tag
+    #     - [Integer] hard_bounces the total number of hard bounces by messages with this tag
+    #     - [Integer] soft_bounces the total number of soft bounces by messages with this tag
+    #     - [Integer] rejects the total number of rejected messages with this tag
+    #     - [Integer] complaints the total number of spam complaints received for messages with this tag
+    #     - [Integer] unsubs the total number of unsubscribe requests received for messages with this tag
+    #     - [Integer] opens the total number of times messages with this tag have been opened
+    #     - [Integer] clicks the total number of times tracked URLs in messages with this tag have been clicked
+    #     - [Hash] stats an aggregate summary of the tag's sending stats
+    #         - [Hash] today stats with this tag so far today
+    #             - [Integer] sent the number of emails sent with this tag so far today
+    #             - [Integer] hard_bounces the number of emails hard bounced with this tag so far today
+    #             - [Integer] soft_bounces the number of emails soft bounced with this tag so far today
+    #             - [Integer] rejects the number of emails rejected for sending this tag so far today
+    #             - [Integer] complaints the number of spam complaints with this tag so far today
+    #             - [Integer] unsubs the number of unsubscribes with this tag so far today
+    #             - [Integer] opens the number of times emails have been opened with this tag so far today
+    #             - [Integer] unique_opens the number of unique opens for emails sent with this tag so far today
+    #             - [Integer] clicks the number of URLs that have been clicked with this tag so far today
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent with this tag so far today
+    #         - [Hash] last_7_days stats with this tag in the last 7 days
+    #             - [Integer] sent the number of emails sent with this tag in the last 7 days
+    #             - [Integer] hard_bounces the number of emails hard bounced with this tag in the last 7 days
+    #             - [Integer] soft_bounces the number of emails soft bounced with this tag in the last 7 days
+    #             - [Integer] rejects the number of emails rejected for sending this tag in the last 7 days
+    #             - [Integer] complaints the number of spam complaints with this tag in the last 7 days
+    #             - [Integer] unsubs the number of unsubscribes with this tag in the last 7 days
+    #             - [Integer] opens the number of times emails have been opened with this tag in the last 7 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent with this tag in the last 7 days
+    #             - [Integer] clicks the number of URLs that have been clicked with this tag in the last 7 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent with this tag in the last 7 days
+    #         - [Hash] last_30_days stats with this tag in the last 30 days
+    #             - [Integer] sent the number of emails sent with this tag in the last 30 days
+    #             - [Integer] hard_bounces the number of emails hard bounced with this tag in the last 30 days
+    #             - [Integer] soft_bounces the number of emails soft bounced with this tag in the last 30 days
+    #             - [Integer] rejects the number of emails rejected for sending this tag in the last 30 days
+    #             - [Integer] complaints the number of spam complaints with this tag in the last 30 days
+    #             - [Integer] unsubs the number of unsubscribes with this tag in the last 30 days
+    #             - [Integer] opens the number of times emails have been opened with this tag in the last 30 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent with this tag in the last 30 days
+    #             - [Integer] clicks the number of URLs that have been clicked with this tag in the last 30 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent with this tag in the last 30 days
+    #         - [Hash] last_60_days stats with this tag in the last 60 days
+    #             - [Integer] sent the number of emails sent with this tag in the last 60 days
+    #             - [Integer] hard_bounces the number of emails hard bounced with this tag in the last 60 days
+    #             - [Integer] soft_bounces the number of emails soft bounced with this tag in the last 60 days
+    #             - [Integer] rejects the number of emails rejected for sending this tag in the last 60 days
+    #             - [Integer] complaints the number of spam complaints with this tag in the last 60 days
+    #             - [Integer] unsubs the number of unsubscribes with this tag in the last 60 days
+    #             - [Integer] opens the number of times emails have been opened with this tag in the last 60 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent with this tag in the last 60 days
+    #             - [Integer] clicks the number of URLs that have been clicked with this tag in the last 60 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent with this tag in the last 60 days
+    #         - [Hash] last_90_days stats with this tag in the last 90 days
+    #             - [Integer] sent the number of emails sent with this tag in the last 90 days
+    #             - [Integer] hard_bounces the number of emails hard bounced with this tag in the last 90 days
+    #             - [Integer] soft_bounces the number of emails soft bounced with this tag in the last 90 days
+    #             - [Integer] rejects the number of emails rejected for sending this tag in the last 90 days
+    #             - [Integer] complaints the number of spam complaints with this tag in the last 90 days
+    #             - [Integer] unsubs the number of unsubscribes with this tag in the last 90 days
+    #             - [Integer] opens the number of times emails have been opened with this tag in the last 90 days
+    #             - [Integer] unique_opens the number of unique opens for emails sent with this tag in the last 90 days
+    #             - [Integer] clicks the number of URLs that have been clicked with this tag in the last 90 days
+    #             - [Integer] unique_clicks the number of unique clicks for emails sent with this tag in the last 90 days
+    def info(tag)
+      _params = {:tag => tag}
+      return @master.call 'tags/info', _params
+    end
+
+    # Return the recent history (hourly stats for the last 30 days) for a tag
+    # @param [String] tag an existing tag name
+    # @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] unsubs the number of unsubscribes 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(tag)
+      _params = {:tag => tag}
+      return @master.call 'tags/time-series', _params
+    end
+
+    # Return the recent history (hourly stats for the last 30 days) for all tags
+    # @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] unsubs the number of unsubscribes 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 all_time_series()
+      _params = {}
+      return @master.call 'tags/all-time-series', _params
+    end
+
+  end
+end