mandrill-rb 1.0.52 → 1.0.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f71903132eb724ad3ee5ae75131ddec8d0c7812
-  data.tar.gz: 96ea4aacffd158e1e6152dba83666478a750a855
+  metadata.gz: 366b3f229c2a6e140a7ac244bbbf07fb133f3daf
+  data.tar.gz: edb22329aab201bc11296f72f51655853519478d
 SHA512:
-  metadata.gz: c720ebcd2efd63bc4c323b05e200929e26f9071b0752a41151d2a394f793651b7daa6c00547e2e0bb9d014891ad6a77a7b7aeeecdb0aab24b4dc116f3b7938eb
-  data.tar.gz: 2d26ae706e5b6d5338679c308fd2e36311dff624e16a4bc4db2bd4cc2ff172a39fa90099c8a3d18af82e33489cf437d5ac5f8f176a03008bcd36558e63ecbeb4
+  metadata.gz: af689525730815dfe6eb8d6628c23e53912fa994d3ffaf014dacb09690f8e6f8bca488a3c7a048083c2367ea5ed58f681bf6f6a7448a79ee6fada7f455a14607
+  data.tar.gz: 184850ffd007ff9bf7cad0541790c923bc38cfe07c46339109863cdff5ecb3a55002ae0ef5b43efb38dd27e046fe3d1fd92aef19caba42542ffa6ca64df525bc

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2013 The Rocket Science Group, LLC.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,30 @@
+# Mandrill-rb
+
+Stealing this from https://bitbucket.org/mailchimp/mandrill-api-ruby/ as of version 1.0.52, for multiple reasons.
+
+1) its on bitbucket
+2) it was broken in my application due mainly to some oddities caused by wonky file/class declaration (or lack thereof in the gem), i.e. specifically:
+
+``` ruby
+module API
+  class WhateverController
+
+  end
+end
+```
+
+Was making ::Mandrill::API or Mandrill::API or whatever, point to the API module, then break. Short version, didnt have ton of time to dig into it, but when I cloned source of mandrill gem off bitbucket I wasn't suprised it was breaking.
+
+So I broke everything into separate files, added some scope resolution operators for safety and speed, and thats the extent of it so far.
+
+I may end up refactoring to make it more resourceful, which is why I elected to release it under a separate gem name, that and the majority of devs will appreciate it being on github, and being able to dig through the source on GH, and it works for now.
+
+```ruby
+require 'mandrill'
+```
+
+or using bundler:
+
+```ruby
+gem 'mandrill-rb'
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mandrill/error.rb

@@ -0,0 +1,62 @@
+module Mandrill
+  class Error < Exception
+  end
+  class ValidationError < Error
+  end
+  class InvalidKeyError < Error
+  end
+  class PaymentRequiredError < Error
+  end
+  class UnknownSubaccountError < Error
+  end
+  class UnknownTemplateError < Error
+  end
+  class ServiceUnavailableError < Error
+  end
+  class UnknownMessageError < Error
+  end
+  class InvalidTagNameError < Error
+  end
+  class InvalidRejectError < Error
+  end
+  class UnknownSenderError < Error
+  end
+  class UnknownUrlError < Error
+  end
+  class UnknownTrackingDomainError < Error
+  end
+  class InvalidTemplateError < Error
+  end
+  class UnknownWebhookError < Error
+  end
+  class UnknownInboundDomainError < Error
+  end
+  class UnknownInboundRouteError < Error
+  end
+  class UnknownExportError < Error
+  end
+  class IPProvisionLimitError < Error
+  end
+  class UnknownPoolError < Error
+  end
+  class NoSendingHistoryError < Error
+  end
+  class PoorReputationError < Error
+  end
+  class UnknownIPError < Error
+  end
+  class InvalidEmptyDefaultPoolError < Error
+  end
+  class InvalidDeleteDefaultPoolError < Error
+  end
+  class InvalidDeleteNonEmptyPoolError < Error
+  end
+  class InvalidCustomDNSError < Error
+  end
+  class InvalidCustomDNSPendingError < Error
+  end
+  class MetadataFieldLimitError < Error
+  end
+  class UnknownMetadataFieldError < Error
+  end
+end

data/lib/mandrill/exports.rb

@@ -0,0 +1,89 @@
+module Mandrill
+  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 zip 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
+    # @param [Array] api_keys an array of api keys to narrow the export to; messsagse sent with ANY of the keys will be included
+    #     - [String] api_keys[] an API key associated with your account
+    # @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, api_keys=nil)
+      _params = {:notify_email => notify_email, :date_from => date_from, :date_to => date_to, :tags => tags, :senders => senders, :states => states, :api_keys => api_keys}
+      return @master.call 'exports/activity', _params
+    end
+  end
+end

data/lib/mandrill/inbound.rb

@@ -0,0 +1,120 @@
+module Mandrill
+  class Inbound
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+
+    # List the domains that have been configured for inbound delivery
+    # @return [Array] the inbound domains associated with the account
+    #     - [Hash] return[] the individual domain info
+    #         - [String] domain the domain name that is accepting mail
+    #         - [String] created_at the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #         - [Boolean] valid_mx true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
+    def domains()
+      _params = {}
+      return @master.call 'inbound/domains', _params
+    end
+
+    # Add an inbound domain to your account
+    # @param [String] domain a domain name
+    # @return [Hash] information about the domain
+    #     - [String] domain the domain name that is accepting mail
+    #     - [String] created_at the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Boolean] valid_mx true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
+    def add_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'inbound/add-domain', _params
+    end
+
+    # Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
+    # @param [String] domain an existing inbound domain
+    # @return [Hash] information about the inbound domain
+    #     - [String] domain the domain name that is accepting mail
+    #     - [String] created_at the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Boolean] valid_mx true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
+    def check_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'inbound/check-domain', _params
+    end
+
+    # Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
+    # @param [String] domain an existing inbound domain
+    # @return [Hash] information about the deleted domain
+    #     - [String] domain the domain name that is accepting mail
+    #     - [String] created_at the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
+    #     - [Boolean] valid_mx true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
+    def delete_domain(domain)
+      _params = {:domain => domain}
+      return @master.call 'inbound/delete-domain', _params
+    end
+
+    # List the mailbox routes defined for an inbound domain
+    # @param [String] domain the domain to check
+    # @return [Array] the routes associated with the domain
+    #     - [Hash] return[] the individual mailbox route
+    #         - [String] id the unique identifier of the route
+    #         - [String] pattern the search pattern that the mailbox name should match
+    #         - [String] url the webhook URL where inbound messages will be published
+    def routes(domain)
+      _params = {:domain => domain}
+      return @master.call 'inbound/routes', _params
+    end
+
+    # Add a new mailbox route to an inbound domain
+    # @param [String] domain an existing inbound domain
+    # @param [String] pattern the search pattern that the mailbox name should match
+    # @param [String] url the webhook URL where the inbound messages will be published
+    # @return [Hash] the added mailbox route information
+    #     - [String] id the unique identifier of the route
+    #     - [String] pattern the search pattern that the mailbox name should match
+    #     - [String] url the webhook URL where inbound messages will be published
+    def add_route(domain, pattern, url)
+      _params = {:domain => domain, :pattern => pattern, :url => url}
+      return @master.call 'inbound/add-route', _params
+    end
+
+    # Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
+    # @param [String] id the unique identifier of an existing mailbox route
+    # @param [String] pattern the search pattern that the mailbox name should match
+    # @param [String] url the webhook URL where the inbound messages will be published
+    # @return [Hash] the updated mailbox route information
+    #     - [String] id the unique identifier of the route
+    #     - [String] pattern the search pattern that the mailbox name should match
+    #     - [String] url the webhook URL where inbound messages will be published
+    def update_route(id, pattern=nil, url=nil)
+      _params = {:id => id, :pattern => pattern, :url => url}
+      return @master.call 'inbound/update-route', _params
+    end
+
+    # Delete an existing inbound mailbox route
+    # @param [String] id the unique identifier of an existing route
+    # @return [Hash] the deleted mailbox route information
+    #     - [String] id the unique identifier of the route
+    #     - [String] pattern the search pattern that the mailbox name should match
+    #     - [String] url the webhook URL where inbound messages will be published
+    def delete_route(id)
+      _params = {:id => id}
+      return @master.call 'inbound/delete-route', _params
+    end
+
+    # Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
+    # @param [String] raw_message the full MIME document of an email message
+    # @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 recipient
+    # @param [String] mail_from the address specified in the MAIL FROM stage of the SMTP conversation. Required for the SPF check.
+    # @param [String] helo the identification provided by the client mta in the MTA state of the SMTP conversation. Required for the SPF check.
+    # @param [String] client_address the remote MTA's ip address. Optional; required for the SPF check.
+    # @return [Array] an array of the information for each recipient in the message (usually one) that matched an inbound route
+    #     - [Hash] return[] the individual recipient information
+    #         - [String] email the email address of the matching recipient
+    #         - [String] pattern the mailbox route pattern that the recipient matched
+    #         - [String] url the webhook URL that the message was posted to
+    def send_raw(raw_message, to=nil, mail_from=nil, helo=nil, client_address=nil)
+      _params = {:raw_message => raw_message, :to => to, :mail_from => mail_from, :helo => helo, :client_address => client_address}
+      return @master.call 'inbound/send-raw', _params
+    end
+
+  end
+end

data/lib/mandrill/internal.rb

@@ -0,0 +1,9 @@
+module Mandrill
+  class Internal
+    attr_accessor :master
+
+    def initialize(master)
+      @master = master
+    end
+  end
+end

data/lib/mandrill/ips.rb

@@ -0,0 +1,246 @@
+module Mandrill
+  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
+
+    # Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
+    # @param [String] ip a dedicated ip address
+    # @param [String] domain the domain name to test
+    # @return [Hash] validation results for the domain
+    #     - [String] valid whether the domain name has a correctly-configured A record pointing to the ip address
+    #     - [String] error if valid is false, this will contain details about why the domain's A record is incorrect
+    def check_custom_dns(ip, domain)
+      _params = {:ip => ip, :domain => domain}
+      return @master.call 'ips/check-custom-dns', _params
+    end
+
+    # Configures the custom DNS name for a dedicated IP.
+    # @param [String] ip a dedicated ip address
+    # @param [String] domain a domain name to set as the dedicated IP's custom dns name.
+    # @return [Hash] information about the dedicated IP's new configuration
+    #     - [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_custom_dns(ip, domain)
+      _params = {:ip => ip, :domain => domain}
+      return @master.call 'ips/set-custom-dns', _params
+    end
+
+  end
+end