mandrill-api 1.0.27 → 1.0.28

data/lib/mandrill.rb

@@ -61,7 +61,8 @@ module Mandrill
                 'Unknown_Url' => UnknownUrlError,
                 'Invalid_Template' => InvalidTemplateError,
                 'Unknown_Webhook' => UnknownWebhookError,
-                'Unknown_InboundDomain' => UnknownInboundDomainError
+                'Unknown_InboundDomain' => UnknownInboundDomainError,
+                'Unknown_Export' => UnknownExportError
             }
 
             begin
@@ -82,6 +83,9 @@ module Mandrill
         def templates()
             Templates.new self
         end
+        def exports()
+            Exports.new self
+        end
         def users()
             Users.new self
         end

data/lib/mandrill/api.rb

@@ -200,6 +200,92 @@ module Mandrill
             return @master.call 'templates/render', _params
         end
 
+    end
+    class Exports
+        attr_accessor :master
+
+        def initialize(master)
+            @master = master
+        end
+
+        # Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
+        # @param [String] id an export job identifier
+        # @return [Hash] the information about the export
+        #     - [String] id the unique identifier for this Export. Use this identifier when checking the export job's status
+        #     - [String] created_at the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] type the type of the export job - activity, reject, or whitelist
+        #     - [String] finished_at the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] state the export job's state - waiting, working, complete, error, or expired.
+        #     - [String] result_url the url for the export job's results, if the job is completed.
+        def info(id)
+            _params = {:id => id}
+            return @master.call 'exports/info', _params
+        end
+
+        # Returns a list of your exports.
+        # @return [Array] the account's exports
+        #     - [Hash] return[] the individual export info
+        #         - [String] id the unique identifier for this Export. Use this identifier when checking the export job's status
+        #         - [String] created_at the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] type the type of the export job - activity, reject, or whitelist
+        #         - [String] finished_at the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] state the export job's state - waiting, working, complete, error, or expired.
+        #         - [String] result_url the url for the export job's results, if the job is completed.
+        def list()
+            _params = {}
+            return @master.call 'exports/list', _params
+        end
+
+        # Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
+        # @param [String] notify_email an optional email address to notify when the export job has finished.
+        # @return [Hash] information about the rejects export job that was started
+        #     - [String] id the unique identifier for this Export. Use this identifier when checking the export job's status
+        #     - [String] created_at the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] type the type of the export job
+        #     - [String] finished_at the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
+        #     - [String] state the export job's state
+        #     - [String] result_url the url for the export job's results, if the job is complete
+        def rejects(notify_email=nil)
+            _params = {:notify_email => notify_email}
+            return @master.call 'exports/rejects', _params
+        end
+
+        # Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
+        # @param [String] notify_email an optional email address to notify when the export job has finished.
+        # @return [Hash] information about the whitelist export job that was started
+        #     - [String] id the unique identifier for this Export. Use this identifier when checking the export job's status
+        #     - [String] created_at the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] type the type of the export job
+        #     - [String] finished_at the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
+        #     - [String] state the export job's state
+        #     - [String] result_url the url for the export job's results, if the job is complete
+        def whitelist(notify_email=nil)
+            _params = {:notify_email => notify_email}
+            return @master.call 'exports/whitelist', _params
+        end
+
+        # Begins an export of your activity history. The activity will be exported to a zaip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
+        # @param [String] notify_email an optional email address to notify when the export job has finished
+        # @param [String] date_from start date as a UTC string in YYYY-MM-DD HH:MM:SS format
+        # @param [String] date_to end date as a UTC string in YYYY-MM-DD HH:MM:SS format
+        # @param [Array] tags an array of tag names to narrow the export to; will match messages that contain ANY of the tags
+        #     - [String] tags[] a tag name
+        # @param [Array] senders an array of senders to narrow the export to
+        #     - [String] senders[] a sender address
+        # @param [Array] states an array of states to narrow the export to; messages with ANY of the states will be included
+        #     - [String] states[] a message state
+        # @return [Hash] information about the activity export job that was started
+        #     - [String] id the unique identifier for this Export. Use this identifier when checking the export job's status
+        #     - [String] created_at the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] type the type of the export job
+        #     - [String] finished_at the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
+        #     - [String] state the export job's state
+        #     - [String] result_url the url for the export job's results, if the job is complete
+        def activity(notify_email=nil, date_from=nil, date_to=nil, tags=nil, senders=nil, states=nil)
+            _params = {:notify_email => notify_email, :date_from => date_from, :date_to => date_to, :tags => tags, :senders => senders, :states => states}
+            return @master.call 'exports/activity', _params
+        end
+
     end
     class Users
         attr_accessor :master
@@ -888,7 +974,7 @@ module Mandrill
 
         # Get the list of all webhooks defined on the account
         # @return [Array] the webhooks associated with the account
-        #     - [Hash] return[] the inidividual webhook info
+        #     - [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

data/lib/mandrill/errors.rb

@@ -21,5 +21,7 @@ module Mandrill
     end
     class UnknownInboundDomainError < Error
     end
+    class UnknownExportError < Error
+    end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mandrill-api
 version: !ruby/object:Gem::Version 
-  hash: 33
+  hash: 47
   prerelease: 
   segments: 
   - 1
   - 0
-  - 27
-  version: 1.0.27
+  - 28
+  version: 1.0.28
 platform: ruby
 authors: 
 - Mandrill Devs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-03 00:00:00 Z
+date: 2013-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json