mandrill-api 1.0.44 → 1.0.45

data/lib/mandrill.rb

@@ -66,7 +66,13 @@ module Mandrill
                 'Invalid_Template' => InvalidTemplateError,
                 'Unknown_Webhook' => UnknownWebhookError,
                 'Unknown_InboundDomain' => UnknownInboundDomainError,
-                'Unknown_Export' => UnknownExportError
+                'Unknown_Export' => UnknownExportError,
+                'IP_ProvisionLimit' => IPProvisionLimitError,
+                'Unknown_Pool' => UnknownPoolError,
+                'Unknown_IP' => UnknownIPError,
+                'Invalid_EmptyDefaultPool' => InvalidEmptyDefaultPoolError,
+                'Invalid_DeleteDefaultPool' => InvalidDeleteDefaultPoolError,
+                'Invalid_DeleteNonEmptyPool' => InvalidDeleteNonEmptyPoolError
             }
 
             begin
@@ -108,6 +114,9 @@ module Mandrill
         def whitelists()
             Whitelists.new self
         end
+        def ips()
+            Ips.new self
+        end
         def internal()
             Internal.new self
         end

data/lib/mandrill/api.rb

@@ -1064,6 +1064,218 @@ module Mandrill
             return @master.call 'whitelists/delete', _params
         end
 
+    end
+    class Ips
+        attr_accessor :master
+
+        def initialize(master)
+            @master = master
+        end
+
+        # Lists your dedicated IPs.
+        # @return [Array] an array of structs for each dedicated IP
+        #     - [Hash] return[] information about a single dedicated IP
+        #         - [String] ip the ip address
+        #         - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] pool the name of the pool that this dedicated IP belongs to
+        #         - [String] domain the domain name (reverse dns) of this dedicated IP
+        #         - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #             - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #             - [Boolean] valid whether the ip's custom dns is currently valid
+        #             - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #         - [Hash] warmup information about the ip's warmup status
+        #             - [Boolean] warming_up whether the ip is currently in warmup mode
+        #             - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #             - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def list()
+            _params = {}
+            return @master.call 'ips/list', _params
+        end
+
+        # Retrieves information about a single dedicated ip.
+        # @param [String] ip a dedicated IP address
+        # @return [Hash] Information about the dedicated ip
+        #     - [String] ip the ip address
+        #     - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] pool the name of the pool that this dedicated IP belongs to
+        #     - [String] domain the domain name (reverse dns) of this dedicated IP
+        #     - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #         - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #         - [Boolean] valid whether the ip's custom dns is currently valid
+        #         - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #     - [Hash] warmup information about the ip's warmup status
+        #         - [Boolean] warming_up whether the ip is currently in warmup mode
+        #         - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def info(ip)
+            _params = {:ip => ip}
+            return @master.call 'ips/info', _params
+        end
+
+        # Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
+        # @param [Boolean] warmup whether to enable warmup mode for the ip
+        # @param [String] pool the id of the pool to add the dedicated ip to, or null to use your account's default pool
+        # @return [Hash] a description of the provisioning request that was created
+        #     - [String] requested_at the date and time that the request was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
+        def provision(warmup=false, pool=nil)
+            _params = {:warmup => warmup, :pool => pool}
+            return @master.call 'ips/provision', _params
+        end
+
+        # Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
+        # @param [String] ip a dedicated ip address
+        # @return [Hash] Information about the dedicated IP
+        #     - [String] ip the ip address
+        #     - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] pool the name of the pool that this dedicated IP belongs to
+        #     - [String] domain the domain name (reverse dns) of this dedicated IP
+        #     - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #         - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #         - [Boolean] valid whether the ip's custom dns is currently valid
+        #         - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #     - [Hash] warmup information about the ip's warmup status
+        #         - [Boolean] warming_up whether the ip is currently in warmup mode
+        #         - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def start_warmup(ip)
+            _params = {:ip => ip}
+            return @master.call 'ips/start-warmup', _params
+        end
+
+        # Cancels the warmup process for a dedicated IP.
+        # @param [String] ip a dedicated ip address
+        # @return [Hash] Information about the dedicated IP
+        #     - [String] ip the ip address
+        #     - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] pool the name of the pool that this dedicated IP belongs to
+        #     - [String] domain the domain name (reverse dns) of this dedicated IP
+        #     - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #         - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #         - [Boolean] valid whether the ip's custom dns is currently valid
+        #         - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #     - [Hash] warmup information about the ip's warmup status
+        #         - [Boolean] warming_up whether the ip is currently in warmup mode
+        #         - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def cancel_warmup(ip)
+            _params = {:ip => ip}
+            return @master.call 'ips/cancel-warmup', _params
+        end
+
+        # Moves a dedicated IP to a different pool.
+        # @param [String] ip a dedicated ip address
+        # @param [String] pool the name of the new pool to add the dedicated ip to
+        # @param [Boolean] create_pool whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown.
+        # @return [Hash] Information about the updated state of the dedicated IP
+        #     - [String] ip the ip address
+        #     - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #     - [String] pool the name of the pool that this dedicated IP belongs to
+        #     - [String] domain the domain name (reverse dns) of this dedicated IP
+        #     - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #         - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #         - [Boolean] valid whether the ip's custom dns is currently valid
+        #         - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #     - [Hash] warmup information about the ip's warmup status
+        #         - [Boolean] warming_up whether the ip is currently in warmup mode
+        #         - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #         - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def set_pool(ip, pool, create_pool=false)
+            _params = {:ip => ip, :pool => pool, :create_pool => create_pool}
+            return @master.call 'ips/set-pool', _params
+        end
+
+        # Deletes a dedicated IP. This is permanent and cannot be undone.
+        # @param [String] ip the dedicated ip to remove from your account
+        # @return [Hash] a description of the ip that was removed from your account.
+        #     - [String] ip the ip address
+        #     - [String] deleted a boolean indicating whether the ip was successfully deleted
+        def delete(ip)
+            _params = {:ip => ip}
+            return @master.call 'ips/delete', _params
+        end
+
+        # Lists your dedicated IP pools.
+        # @return [Array] the dedicated IP pools for your account, up to a maximum of 1,000
+        #     - [Hash] return[] information about each dedicated IP pool
+        #         - [String] name this pool's name
+        #         - [String] created_at the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
+        #         - [Array] ips the dedicated IPs in this pool
+        #             - [Hash] ips[] information about each dedicated IP
+        #                 - [String] ip the ip address
+        #                 - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #                 - [String] pool the name of the pool that this dedicated IP belongs to
+        #                 - [String] domain the domain name (reverse dns) of this dedicated IP
+        #                 - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #                     - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #                     - [Boolean] valid whether the ip's custom dns is currently valid
+        #                     - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #                 - [Hash] warmup information about the ip's warmup status
+        #                     - [Boolean] warming_up whether the ip is currently in warmup mode
+        #                     - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #                     - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def list_pools()
+            _params = {}
+            return @master.call 'ips/list-pools', _params
+        end
+
+        # Describes a single dedicated IP pool.
+        # @param [String] pool a pool name
+        # @return [Hash] Information about the dedicated ip pool
+        #     - [String] name this pool's name
+        #     - [String] created_at the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
+        #     - [Array] ips the dedicated IPs in this pool
+        #         - [Hash] ips[] information about each dedicated IP
+        #             - [String] ip the ip address
+        #             - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #             - [String] pool the name of the pool that this dedicated IP belongs to
+        #             - [String] domain the domain name (reverse dns) of this dedicated IP
+        #             - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #                 - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #                 - [Boolean] valid whether the ip's custom dns is currently valid
+        #                 - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #             - [Hash] warmup information about the ip's warmup status
+        #                 - [Boolean] warming_up whether the ip is currently in warmup mode
+        #                 - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #                 - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def pool_info(pool)
+            _params = {:pool => pool}
+            return @master.call 'ips/pool-info', _params
+        end
+
+        # Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
+        # @param [String] pool the name of a pool to create
+        # @return [Hash] Information about the dedicated ip pool
+        #     - [String] name this pool's name
+        #     - [String] created_at the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
+        #     - [Array] ips the dedicated IPs in this pool
+        #         - [Hash] ips[] information about each dedicated IP
+        #             - [String] ip the ip address
+        #             - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #             - [String] pool the name of the pool that this dedicated IP belongs to
+        #             - [String] domain the domain name (reverse dns) of this dedicated IP
+        #             - [Hash] custom_dns information about the ip's custom dns, if it has been configured
+        #                 - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
+        #                 - [Boolean] valid whether the ip's custom dns is currently valid
+        #                 - [String] error if the ip's custom dns is invalid, this will include details about the error
+        #             - [Hash] warmup information about the ip's warmup status
+        #                 - [Boolean] warming_up whether the ip is currently in warmup mode
+        #                 - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        #                 - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
+        def create_pool(pool)
+            _params = {:pool => pool}
+            return @master.call 'ips/create-pool', _params
+        end
+
+        # Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
+        # @param [String] pool the name of the pool to delete
+        # @return [Hash] information about the status of the pool that was deleted
+        #     - [String] pool the name of the pool
+        #     - [Boolean] deleted whether the pool was deleted
+        def delete_pool(pool)
+            _params = {:pool => pool}
+            return @master.call 'ips/delete-pool', _params
+        end
+
     end
     class Internal
         attr_accessor :master

data/lib/mandrill/errors.rb

@@ -31,5 +31,17 @@ module Mandrill
     end
     class UnknownExportError < Error
     end
+    class IPProvisionLimitError < Error
+    end
+    class UnknownPoolError < Error
+    end
+    class UnknownIPError < Error
+    end
+    class InvalidEmptyDefaultPoolError < Error
+    end
+    class InvalidDeleteDefaultPoolError < Error
+    end
+    class InvalidDeleteNonEmptyPoolError < Error
+    end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mandrill-api
 version: !ruby/object:Gem::Version 
-  hash: 79
+  hash: 77
   prerelease: 
   segments: 
   - 1
   - 0
-  - 44
-  version: 1.0.44
+  - 45
+  version: 1.0.45
 platform: ruby
 authors: 
 - Mandrill Devs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-30 00:00:00 Z
+date: 2013-09-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json