mandrill-api 1.0.37 → 1.0.38

data/lib/mandrill/api.rb

@@ -518,6 +518,7 @@ module Mandrill
         # @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
@@ -537,6 +538,7 @@ module Mandrill
         # @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
@@ -683,7 +685,7 @@ module Mandrill
         #         - [Hash] to[] a single recipient's information.
         #             - [String] email the email address of the recipient
         #             - [String] name the optional display name to use for the recipient
-        #     - [Hash] headers optional extra headers to add to the message (currently only Reply-To and X-* headers are allowed)
+        #     - [Hash] headers optional extra headers to add to the message (most headers are allowed)
         #     - [Boolean] important whether or not this message is important, and should be delivered ahead of non-important messages
         #     - [Boolean] track_opens whether or not to turn on open tracking for the message
         #     - [Boolean] track_clicks whether or not to turn on click tracking for the message
@@ -756,7 +758,7 @@ module Mandrill
         #         - [Hash] to[] a single recipient's information.
         #             - [String] email the email address of the recipient
         #             - [String] name the optional display name to use for the recipient
-        #     - [Hash] headers optional extra headers to add to the message (currently only Reply-To and X-* headers are allowed)
+        #     - [Hash] headers optional extra headers to add to the message (most headers are allowed)
         #     - [Boolean] important whether or not this message is important, and should be delivered ahead of non-important messages
         #     - [Boolean] track_opens whether or not to turn on open tracking for the message
         #     - [Boolean] track_clicks whether or not to turn on click tracking for the message
@@ -852,6 +854,30 @@ module Mandrill
             return @master.call 'messages/search', _params
         end
 
+        # Search the content of recently sent messages and return the aggregated hourly stats for matching messages
+        # @param [String] query the search terms to find matching messages for
+        # @param [String] date_from start date
+        # @param [String] date_to end date
+        # @param [Array] tags an array of tag names to narrow the search to, will return messages that contain ANY of the tags
+        # @param [Array] senders an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders
+        # @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 search_time_series(query='*', date_from=nil, date_to=nil, tags=nil, senders=nil)
+            _params = {:query => query, :date_from => date_from, :date_to => date_to, :tags => tags, :senders => senders}
+            return @master.call 'messages/search-time-series', _params
+        end
+
         # Get the information for a single recently sent message
         # @param [String] id the unique id of the message to get - passed as the "_id" field in webhooks, send calls, or search calls
         # @return [Hash] the information for the message
@@ -919,7 +945,7 @@ module Mandrill
         # @param [String, nil] from_email optionally define the sender address - otherwise we'll use the address found in the provided headers
         # @param [String, nil] from_name optionally define the sender alias
         # @param [Array, nil] to optionally define the recipients to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document
-        #     - [String] to[] the email address of the recipint
+        #     - [String] to[] the email address of the recipient
         # @param [Boolean] async enable a background sending mode that is optimized for bulk sending. In async mode, messages/sendRaw will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
         # @param [String] ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
         # @param [String] send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mandrill-api
 version: !ruby/object:Gem::Version 
-  hash: 93
+  hash: 91
   prerelease: 
   segments: 
   - 1
   - 0
-  - 37
-  version: 1.0.37
+  - 38
+  version: 1.0.38
 platform: ruby
 authors: 
 - Mandrill Devs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-05 00:00:00 Z
+date: 2013-07-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json