hominid 2.0.2 → 2.0.3

data/.gitignore

@@ -2,3 +2,4 @@
 pkg/*
 pkg/*.*
 .svn
+rdoc

data/README.rdoc

@@ -0,0 +1,118 @@
+= Hominid
+
+Hominid is a Ruby gem that provides a wrapper for interacting with the Mailchimp[http://eepurl.com/ew8J] email marketing service API ({version 1.2}[http://www.mailchimp.com/api/1.2/]).
+
+== Installation
+
+  sudo gem install hominid
+
+Hominid is hosted at Gemcutter[http://gemcutter.org]. Be sure that you have the Gemcutter gem installed if you are having trouble installing Hominid:
+
+  sudo gem install gemcutter
+
+== Requirements
+
+You will need a Mailchimp[http://eepurl.com/ew8J] account. Once you have your Mailchimp account set up, you will need to {generate an API key}[http://admin.mailchimp.com/account/api/] in order to get started using Hominid.
+
+== Usage
+
+Hominid is intended to be a complete Ruby wrapper for working with the Mailchimp API. As of release 2.0.2, all methods available from the Mailchimp API (Version 1.2) are available. Please note in order to use some methods you will need to have {A.I.M. Reports}[https://admin.mailchimp.com/account/addons] installed on your Mailchimp account.
+
+You will need to pass your Mailchimp API key to get started:
+
+  h = Hominid::Base.new({:api_key => API_KEY})
+
+You can also pass in any other config options that you would like to change from the defaults. Take a look at Hominid::Base to see what the default values are.
+
+Once you have created a Hominid object, you can begin interacting with the Mailchimp account that your API key is associated with.
+
+=== Working with Lists
+
+We have provided some finder methods to make working with your mailing lists easier:
+
+  lists = h.lists
+  list = h.find_list_by_name("Mailing List Name")
+  list = h.find_list_by_id("List ID")
+  list = h.find_list_by_web_id("List Web ID")</code></pre>
+
+There are also finders for easily getting at List ID's, which are required for nearly all the list methods:
+
+  list_id = h.find_list_id_by_name("Mailing List Name")
+  list_id_ = h.find_list_id_by_web_id("List Web ID")
+
+This means that you can _(for example)_ subscribe someone to a particular mailing list:
+
+  h.subscribe(h.find_list_id_by_name("Mailing List Name"), "email@domain.com", {:FNAME => "Bob", :LNAME => "Smith"}, {:email_type => 'html'})
+
+Or to update a subscriber to a particular list:
+
+  h.update_member(h.find_list_id_by_name("Mailing List Name"), "old_email@domain.com", {:EMAIL => "new_email_@domain.com"}, 'html')
+
+Take a look at Hominid::List to see the methods that are available for interacting with your lists.
+
+=== Working with Campaigns
+
+We have provided some finder methods to make working with your campaigns easier:
+
+  campaigns = h.campaigns
+  campaigns = h.find_campaigns_by_list_name("Mailing List Name")
+  campaigns = h.find_campaigns_by_list_id("Mailing List ID")
+  campaigns = h.find_campaigns_by_type("regular")
+  campaign = h.find_campaign_by_id("Campaign ID")
+  campaign = h.find_campaign_by_title("Campaign Title")
+
+To create a new campaign, use the +create_campaign+ method:
+
+  new_campaign = h.create_campaign(...)
+
+Take a look at Hominid::Campaign to see the methods that are available for interacting with your campaigns.
+
+=== Mailchimp Helper Methods
+
+There are a series of helper methods that are also made available with the Hominid gem. For example, to retrieve information about the Mailchimp account associated with your API key, simply:
+
+  account_details_ = h.account_details
+
+In this case, the +account_details+ object can be accessed like:
+
+  account_details.contact.company
+  account_details.orders
+
+Take a look at Hominid::Helper to see the helper methods that are available.
+
+=== Mailchimp Security Methods
+
+There are a couple of security methods that are also made available with the Hominid gem. These are primarily used for dealing with API keys, and require your Mailchimp account username and password:
+
+  h.api_keys('username', 'password')
+
+Take a look at Hominid::Security to see the security methods that are available.
+
+== Contributors
+
+Hominid is maintained by {Brian Getting}[http://terra-firma-design.com]. A very special thank-you to {Michael Strüder}[http://github.com/mikezter] for all of his hard work. Also, Hominid wouldn't be anywhere near as awesome as it is today without fantastic contributions and inspiration from:
+
+* {Alan Harper}[http://github.com/aussiegeek]
+* {Will}[http://github.com/willinfront]
+* {Ben Woosley}[http://github.com/Empact]
+* {banker}[http://github.com/banker]
+* {Kristoffer Renholm}[http://github.com/renholm]
+* {Wiktor Schmidt}[http://github.com/netguru]
+* {ron}[http://github.com/ron]
+* {Matthew Carlson}[http://mandarinsoda.com/]
+* {Kelly Mahan}[http://digimedia.com/]
+* {C.G. Brown}[http://www.projectlocker.com/]
+* {Bill Abney}[http://github.com/babney]
+* {David Rice}[http://github.com/davidjrice]
+
+== Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Brian Getting. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.0.3

data/hominid.gemspec

@@ -5,21 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hominid}
-  s.version = "2.0.2"
+  s.version = "2.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Getting", "Michael Str\303\274der"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2010-02-06}
   s.description = %q{Hominid is a Ruby gem that provides a wrapper for interacting with the Mailchimp email marketing service API.}
   s.email = %q{brian@terra-firma-design.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.textile"
+     "README.rdoc"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README.textile",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "hominid.gemspec",

data/lib/hominid/base.rb

@@ -29,15 +29,11 @@ module Hominid
       end
     end
     
-    # --------------------------------
-    # Used internally by Hominid
-    # --------------------------------
-
-    def apply_defaults_to(options)
+    def apply_defaults_to(options) # :nodoc:
       @config.merge(options)
     end
     
-    def call(method, *args)
+    def call(method, *args) # :nodoc:
       @chimpApi.call(method, @config[:api_key], *args)
     rescue XMLRPC::FaultException => error
       # Handle common cases for which the Mailchimp API would raise Exceptions
@@ -65,7 +61,7 @@ module Hominid
       raise CommunicationError.new(error.message)
     end
     
-    def clean_merge_tags(merge_tags)
+    def clean_merge_tags(merge_tags) # :nodoc:
       return {} unless merge_tags.is_a? Hash
       merge_tags.each do |key, value|
         if merge_tags[key].is_a? String
@@ -76,7 +72,7 @@ module Hominid
       end
     end
     
-    def hash_to_object(object)
+    def hash_to_object(object) # :nodoc:
       return case object
       when Hash
         object = object.clone

data/lib/hominid/campaign.rb

@@ -1,660 +1,645 @@
 module Hominid
   module Campaign
     
-    # CAMPAIGN RELATED METHODS
-    
+    # Get all the campaigns for this account.
+    #
+    # Parameters:
+    # * filters (Hash)    = A hash of filters to apply to query. See the Mailchimp API documentation for more info.
+    # * start   (Integer) = Control paging of results.
+    # * limit   (Integer) = Number of campaigns to return. Upper limit set at 1000.
+    #
+    # Returns:
+    # An array of campaigns.
+    #
     def campaigns(filters = {}, start = 0, limit = 25)
-      # Get all the campaigns for this account.
-      #
-      # Parameters:
-      # filters (Hash)    = A hash of filters to apply to query. See the Mailchimp API documentation for more info.
-      # start   (Integer) = Control paging of results.
-      # limit   (Integer) = Number of campaigns to return. Upper limit set at 1000.
-      #
-      # Returns:
-      # An array of campaigns.
-      #
       call("campaigns", filters, start, limit)
     end
-    
+
+    # Find a campaign by id
+    #
+    # Parameters:
+    # * campaign_id (String) = The unique ID of the campaign to return.
+    #
+    # Returns:
+    # A single campaign.
+    #    
     def find_campaign_by_id(campaign_id)
-      # Find a campaign by id
-      #
-      # Parameters:
-      # campaign_id (String) = The unique ID of the campaign to return.
-      #
-      # Returns:
-      # A single campaign.
-      #
       call("campaigns", {:campaign_id => campaign_id}).first
     end
 
+    # Find a campaign by web_id
+    #
+    # Parameters:
+    # * campaign_web_id (Integer) = The unique ID of the campaign to return.
+    #
+    # Returns:
+    # A single campaign.
+    #
     def find_campaign_by_web_id(campaign_web_id)
-      # Find a campaign by web_id
-      #
-      # Parameters:
-      # campaign_web_id (Integer) = The unique ID of the campaign to return.
-      #
-      # Returns:
-      # A single campaign.
-      #
       call("campaigns").find {|campaign| campaign["web_id"] == campaign_web_id}
     end
-        
+
+    # Find a campaign by name
+    #
+    # Parameters:
+    # * title (String) = The title of the campaign to return.
+    #
+    # Returns:
+    # An array of campaigns.
+    #
     def find_campaigns_by_title(title)
-      # Find a campaign by name
-      #
-      # Parameters:
-      # title (String) = The title of the campaign to return.
-      #
-      # Returns:
-      # An array of campaigns.
-      #
       call("campaigns", {:title => title})
     end
-    
+
+    # Find campaigns by list name
+    #
+    # Parameters:
+    # * list_name (String)  = The name of the mailing list to return campaigns for.
+    # * start     (Integer) = Control paging of results.
+    # * limit     (Integer) = Number of campaigns to return. Upper limit set at 1000.
+    #
+    # Returns:
+    # An array of campaigns.
+    #    
     def find_campaigns_by_list_name(list_name, start = 0, limit = 25)
-      # Find campaigns by list name
-      #
-      # Parameters:
-      # list_name (String)  = The name of the mailing list to return campaigns for.
-      # start     (Integer) = Control paging of results.
-      # limit     (Integer) = Number of campaigns to return. Upper limit set at 1000.
-      #
-      # Returns:
-      # An array of campaigns.
-      #
       call("campaigns", {:list_id => find_list_id_by_name(list_name)}, start, limit)
     end
-    
+
+    # Find campaigns by list id
+    #
+    # Parameters:
+    # * list_id (String)  = The ID of the mailing list to return campaigns for.
+    # * start   (Integer) = Control paging of results.
+    # * limit   (Integer) = Number of campaigns to return. Upper limit set at 1000.
+    #
+    # Returns:
+    # An array of campaigns.
+    #    
     def find_campaigns_by_list_id(list_id, start = 0, limit = 25)
-      # Find campaigns by list id
-      #
-      # Parameters:
-      # list_id (String)  = The ID of the mailing list to return campaigns for.
-      # start   (Integer) = Control paging of results.
-      # limit   (Integer) = Number of campaigns to return. Upper limit set at 1000.
-      #
-      # Returns:
-      # An array of campaigns.
-      #
       call("campaigns", {:list_id => list_id}, start, limit)
     end
-    
+
+    # Find campaigns by type
+    #
+    # Parameters:
+    # * type   (String)  = One of: 'regular', 'plaintext', 'absplit', 'rss', 'inspection', 'trans', 'auto'
+    # * start  (Integer) = Control paging of results.
+    # * limit  (Integer) = Number of campaigns to return. Upper limit set at 1000.
+    #
+    # Returns:
+    # An array of campaigns.
+    #    
     def find_campaigns_by_type(type, start = 0, limit = 25)
-      # Find campaigns by type
-      #
-      # Parameters:
-      # type   (String)  = One of: 'regular', 'plaintext', 'absplit', 'rss', 'inspection', 'trans', 'auto'
-      # start  (Integer) = Control paging of results.
-      # limit  (Integer) = Number of campaigns to return. Upper limit set at 1000.
-      #
-      # Returns:
-      # An array of campaigns.
-      #
       call("campaigns", {:type => type}, start, limit)
     end
     
-    def create_campaign(type = 'regular', options = {}, content = {}, segment_options = {}, type_opts = {})
-      # Create a new draft campaign to send.
-      #
-      # Parameters:
-      # type            (String)  = One of "regular", "plaintext", "absplit", "rss", "trans" or "auto".
-      # options         (Hash)    = A hash of options for creating this campaign including:
-      #   :list_id        = (String)  The ID of the list to send this campaign to.
-      #   :subject        = (String)  The subject of the campaign.
-      #   :from_email     = (String)  The email address this campaign will come from.
-      #   :from_name      = (String)  The name that this campaign will come from.
-      #   :to_email       = (String)  The To: name recipients will see.
-      #   :template_id    = (Integer) The ID of the template to use for this campaign (optional).
-      #   :folder_id      = (Integer) The ID of the folder to file this campaign in (optional).
-      #   :tracking       = (Array)   What to track for this campaign (optional).
-      #   :title          = (String)  Internal title for this campaign (optional).
-      #   :authenticate   = (Boolean) Set to true to authenticate campaign (optional).
-      #   :analytics      = (Array)   Google analytics tags (optional).
-      #   :auto_footer    = (Boolean) Auto-generate the footer (optional)?
-      #   :inline_css     = (Boolean) Inline the CSS styles (optional)?
-      #   :generate_text  = (Boolean) Auto-generate text from HTML email (optional)?
-      # content         (Hash)    = The content for this campaign - use a struct with the following keys:
-      #   :html         (String)  = The HTML content of the campaign.
-      #   :text         (String)  = The text content of the campaign.
-      #   :url          (String)  = A URL to pull content from. This will override other content settings.
-      #   :archive      (String)  = To send a Base64 encoded archive file for Mailchimp to import all media from.
-      #   :archive_type (String)  = Only necessary for the "archive" option. Supported formats are: zip, tar.gz,
-      #                             tar.bz2, tar, tgz, tbz. Defaults to zip. (optional)
-      # segment_options (Hash)    = Segmentation options. See the Mailchimp API documentation for more information.
-      # type_opts       (Hash)    = An array of options for this campaign type. See the Mailchimp API documentation for
-      #                             for more information.
-      #
-      # Returns:
-      # The ID for the created campaign. (String)
-      #
-      call("campaignCreate", type, options, content, segment_options, type_opts)
+    # Create a new draft campaign to send.
+    #
+    # Parameters:
+    # * options         (Hash)    = A hash of options for creating this campaign including:
+    #   * :list_id        = (String)  The ID of the list to send this campaign to.
+    #   * :subject        = (String)  The subject of the campaign.
+    #   * :from_email     = (String)  The email address this campaign will come from.
+    #   * :from_name      = (String)  The name that this campaign will come from.
+    #   * :to_email       = (String)  The To: name recipients will see.
+    #   * :template_id    = (Integer) The ID of the template to use for this campaign (optional).
+    #   * :folder_id      = (Integer) The ID of the folder to file this campaign in (optional).
+    #   * :tracking       = (Array)   What to track for this campaign (optional).
+    #   * :title          = (String)  Internal title for this campaign (optional).
+    #   * :authenticate   = (Boolean) Set to true to authenticate campaign (optional).
+    #   * :analytics      = (Array)   Google analytics tags (optional).
+    #   * :auto_footer    = (Boolean) Auto-generate the footer (optional)?
+    #   * :inline_css     = (Boolean) Inline the CSS styles (optional)?
+    #   * :generate_text  = (Boolean) Auto-generate text from HTML email (optional)?
+    # * content         (Hash)    = The content for this campaign - use a struct with the following keys:
+    #   * :html         (String)  = The HTML content of the campaign.
+    #   * :text         (String)  = The text content of the campaign.
+    #   * :url          (String)  = A URL to pull content from. This will override other content settings.
+    #   * :archive      (String)  = To send a Base64 encoded archive file for Mailchimp to import all media from.
+    #   * :archive_type (String)  = Only necessary for the "archive" option. Supported formats are: zip, tar.gz, tar.bz2, tar, tgz, tbz. Defaults to zip. (optional)
+    # * segment_options (Hash)    = Segmentation options. See the Mailchimp API documentation for more information.
+    # * type            (String)  = One of "regular", "plaintext", "absplit", "rss", "trans" or "auto".
+    # * type_opts       (Hash)    = An array of options for this campaign type. See the Mailchimp API documentation for for more information.
+    #
+    # Returns:
+    # The ID for the created campaign. (String)
+    #
+    def create_campaign(options = {}, content = {}, campaign_type = 'regular', segment_options = {}, type_opts = {})
+      call("campaignCreate", campaign_type, options, content, segment_options, type_opts)
       # TODO: Should we return the new campaign instead of the ID returned from the API?
     end
-    
+
+    # List all the folders for a user account.
+    #
+    # Returns:
+    # An array of templates for this campaign including:
+    # * folder_id (Integer) = Folder Id for the given folder, this can be used in the campaigns() function to filter on.
+    # * name      (String)  = Name of the given folder.
+    #    
     def folders
-      # List all the folders for a user account.
-      #
-      # Returns:
-      # An array of templates for this campaign including:
-      #   folder_id (Integer) = Folder Id for the given folder, this can be used in the campaigns() function to filter on.
-      #   name      (String)  = Name of the given folder.
-      #
       call("campaignFolders")
     end
-    
+
+    # Retrieve all templates defined for your user account.
+    #
+    # Returns:
+    # An array of templates for this campaign including:
+    # * id        (Integer) = The ID of the template.
+    # * name      (String)  = The name of the template.
+    # * layout    (String)  = The layout of the template - "basic", "left_column", "right_column", or "postcard".
+    # * sections  (Array)   = An associative array of editable sections in the template that can accept custom HTML when sending a campaign.
+    #
     def templates
-      # Retrieve all templates defined for your user account.
-      #
-      # Returns:
-      # An array of templates for this campaign including:
-      #   id        (Integer) = The ID of the template.
-      #   name      (String)  = The name of the template.
-      #   layout    (String)  = The layout of the template - "basic", "left_column", "right_column", or "postcard".
-      #   sections  (Array)   = An associative array of editable sections in the template that can accept custom HTML
-      #                         when sending a campaign.
-      #
       call("campaignTemplates")
     end
-    
-    def campaign_abuse_reports(campaign_id, start = 0, limit = 500, since = "2000-01-01 00:00:00")
-      # Get all email addresses that complained about a given campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer)   = Page number to start at. Defaults to 0.
-      # limit (Integer)   = Number of results to return. Defaults to 500. Upper limit is 1000.
-      # since (DateTime)  = Only return email reports since this date. Must be in YYYY-MM-DD HH:II:SS format (GMT).
-      #
-      # Returns:
-      # An array of abuse reports for this list in the format:
-      # 
+
+    # Get all email addresses that complained about a given campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer)   = Page number to start at. Defaults to 0.
+    # * limit (Integer)   = Number of results to return. Defaults to 500. Upper limit is 1000.
+    # * since (DateTime)  = Only return email reports since this date. Must be in YYYY-MM-DD HH:II:SS format (GMT).
+    #
+    # Returns:
+    # An array of abuse reports for this list in the format:
+    #
+    def campaign_abuse_reports(campaign_id, start = 0, limit = 500, since = "2000-01-01 00:00:00") 
       call("campaignAbuseReports", campaign_id, start, limit, since)
     end
     
+    # Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best
+    # suited for display in customized reports pages. Note: some messages will contain HTML - clean tags as necessary.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of advice on the campaign's performance including:
+    # * msg   (String) = Advice message.
+    # * type  (String) = One of: negative, positive, or neutral.
+    #
     def advice(campaign_id)
-      # Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best
-      # suited for display in customized reports pages. Note: some messages will contain HTML - clean tags as necessary.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # An array of advice on the campaign's performance including:
-      #   msg   (String) = Advice message.
-      #   type  (String) = One of: negative, positive, or neutral.
-      #
       call("campaignAdvice", campaign_id)
     end
     
+    # Attach Ecommerce Order Information to a Campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * order (Hash) = A hash of order information including:
+    #   * id          (String)  = The order id
+    #   * email_id    (String)  = Email id of the subscriber (mc_eid query string)
+    #   * total       (Double)  = Show only campaigns with this from_name.
+    #   * shipping    (String)  = The total paid for shipping fees. (optional)
+    #   * tax         (String)  = The total tax paid. (optional)
+    #   * store_id    (String)  = A unique id for the store sending the order in
+    #   * store_name  (String)  = A readable name for the store, typicaly the hostname. (optional)
+    #   * plugin_id   (String)  = The MailChimp-assigned Plugin Id. Using 1214 for the moment.
+    #   * items       (Array)   = The individual line items for an order, using the following keys:
+    #   * line_num       (Integer) = The line number of the item on the order. (optional)
+    #   * product_id     (Integer) = Internal product id.
+    #   * product_name   (String)  = The name for the product_id associated with the item.
+    #   * category_id    (Integer) = Internal id for the (main) category associated with product.
+    #   * category_name  (String)  = The category name for the category id.
+    #   * qty            (Double)  = The quantity of items ordered.
+    #   * cost           (Double)  = The cost of a single item (Ex. Not the extended cost of the line).
+    #
+    # Returns:
+    # True if successful, error code if not.
+    #
     def add_order(campaign_id, order)
-      # Attach Ecommerce Order Information to a Campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # order (Hash) = A hash of order information including:
-      #   id          (String)  = The order id
-      #   email_id    (String)  = Email id of the subscriber (mc_eid query string)
-      #   total       (Double)  = Show only campaigns with this from_name.
-      #   shipping    (String)  = The total paid for shipping fees. (optional)
-      #   tax         (String)  = The total tax paid. (optional)
-      #   store_id    (String)  = A unique id for the store sending the order in
-      #   store_name  (String)  = A readable name for the store, typicaly the hostname. (optional)
-      #   plugin_id   (String)  = The MailChimp-assigned Plugin Id. Using 1214 for the moment.
-      #   items       (Array)   = The individual line items for an order, using the following keys:
-      #     line_num       (Integer) = The line number of the item on the order. (optional)
-      #     product_id     (Integer) = Internal product id.
-      #     product_name   (String)  = The name for the product_id associated with the item.
-      #     category_id    (Integer) = Internal id for the (main) category associated with product.
-      #     category_name  (String)  = The category name for the category id.
-      #     qty            (Double)  = The quantity of items ordered.
-      #     cost           (Double)  = The cost of a single item (Ex. Not the extended cost of the line).
-      #
-      # Returns:
-      # True if successful, error code if not.
-      #
       order = order.merge(:campaign_id => campaign_id)
       call("campaignEcommAddOrder", order)
     end
     alias :ecomm_add_order :add_order
     
+    # Retrieve the Google Analytics data we've collected for this campaign. Note, requires Google
+    # Analytics Add-on to be installed and configured.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of analytics for the passed campaign including:
+    # * visits            (Integer) = Number of visits.
+    # * pages             (Integer) = Number of page views.
+    # * new_visits        (Integer) = New visits recorded.
+    # * bounces           (Integer) = Vistors who "bounced" from your site.
+    # * time_on_site      (Double)  = 
+    # * goal_conversions  (Integer) = Number of goals converted.
+    # * goal_value        (Double)  = Value of conversion in dollars.
+    # * revenue           (Double)  = Revenue generated by campaign.
+    # * transactions      (Integer) = Number of transactions tracked.
+    # * ecomm_conversions (Integer) = Number Ecommerce transactions tracked.
+    # * goals             (Array)   = An array containing goal names and number of conversions.
+    #
     def analytics(campaign_id)
-      # Retrieve the Google Analytics data we've collected for this campaign. Note, requires Google
-      # Analytics Add-on to be installed and configured.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # An array of analytics for the passed campaign including:
-      #   visits            (Integer) = Number of visits.
-      #   pages             (Integer) = Number of page views.
-      #   new_visits        (Integer) = New visits recorded.
-      #   bounces           (Integer) = Vistors who "bounced" from your site.
-      #   time_on_site      (Double)  = 
-      #   goal_conversions  (Integer) = Number of goals converted.
-      #   goal_value        (Double)  = Value of conversion in dollars.
-      #   revenue           (Double)  = Revenue generated by campaign.
-      #   transactions      (Integer) = Number of transactions tracked.
-      #   ecomm_conversions (Integer) = Number Ecommerce transactions tracked.
-      #   goals             (Array)   = An array containing goal names and number of conversions.
-      #
       call("campaignAnalytics", campaign_id)
     end
     
+    # Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts
+    # of data depending on how large the campaign was and how much cruft the bounce provider returned. Also,
+    # messages over 30 days old are subject to being removed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 50.
+    # * since (Date)    = Pull only messages since this time - use YYYY-MM-DD format in GMT.
+    #
+    # Returns:
+    # An array of full bounce messages for this campaign including:
+    # * date    (String) = Date/time the bounce was received and processed.
+    # * email   (String) = The email address that bounced.
+    # * message (String) = The entire bounce message received.
+    #
     def bounce_messages(campaign_id, start = 0, limit = 25, since = "2000-01-01")
-      # Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts
-      # of data depending on how large the campaign was and how much cruft the bounce provider returned. Also,
-      # messages over 30 days old are subject to being removed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 50.
-      # since (Date)    = Pull only messages since this time - use YYYY-MM-DD format in GMT.
-      #
-      # Returns:
-      # An array of full bounce messages for this campaign including:
-      #   date    (String) = Date/time the bounce was received and processed.
-      #   email   (String) = The email address that bounced.
-      #   message (String) = The entire bounce message received.
-      #
       call("campaignBounceMessages", campaign_id, start, limit, since)
     end
     
+    # Return the list of email addresses that clicked on a given url, and how many times they clicked.
+    # Note: Requires the AIM module to be installed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * url   (String)  = The URL of the link that was clicked on.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    #
+    # Returns:
+    # An array of structs containing email addresses and click counts including:
+    # * email   (String)  = Email address that opened the campaign.
+    # * clicks  (Integer) = Total number of times the URL was clicked on by this email address.
+    #
     def click_details(campaign_id, url, start = 0, limit = 1000)
-      # Return the list of email addresses that clicked on a given url, and how many times they clicked.
-      # Note: Requires the AIM module to be installed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # url   (String)  = The URL of the link that was clicked on.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # An array of structs containing email addresses and click counts including:
-      #   email   (String)  = Email address that opened the campaign.
-      #   clicks  (Integer) = Total number of times the URL was clicked on by this email address.
-      #
       call("campaignClickDetailAIM", campaign_id, url, start, limit)
     end
     alias :click_detail_aim :click_details
     
+    # Get an array of the urls being tracked, and their click counts for a given campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # A struct of URLs and associated statistics including:
+    # * clicks (Integer) = Number of times the specific link was clicked.
+    # * unique (Integer) = Number of unique people who clicked on the specific link.
+    #
     def click_stats(campaign_id)
-      # Get an array of the urls being tracked, and their click counts for a given campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # A struct of URLs and associated statistics including:
-      #   clicks (Integer) = Number of times the specific link was clicked.
-      #   unique (Integer) = Number of unique people who clicked on the specific link.
-      #
       call("campaignClickStats", campaign_id)
     end
     
+    # Get the content (both html and text) for a campaign either as it would appear in the campaign archive
+    # or as the raw, original content.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * for_archive (Boolean) = Controls whether we return the Archive version (true) or the Raw version (false), defaults to true.
+    #
+    # Returns:
+    # A struct containing all content for the campaign including:
+    # * html (String) = The HTML content used for the campgain with merge tags intact.
+    # * text (String) = The Text content used for the campgain with merge tags intact.
+    #
     def content(campaign_id, for_archive = true)
-      # Get the content (both html and text) for a campaign either as it would appear in the campaign archive
-      # or as the raw, original content.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # for_archive (Boolean) = Controls whether we return the Archive version (true) or the Raw version (false),
-      #                         defaults to true.
-      #
-      # Returns:
-      # A struct containing all content for the campaign including:
-      #   html (String) = The HTML content used for the campgain with merge tags intact.
-      #   text (String) = The Text content used for the campgain with merge tags intact.
-      #
       call("campaignContent", campaign_id, for_archive)
     end
     alias :campaign_content :content
     
+    # Delete a campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # True if successful, error code if not.
+    #
     def delete(campaign_id)
-      # Delete a campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # True if successful, error code if not.
-      #
       call("campaignDelete", campaign_id)
     end
     alias :delete_campaign :delete
     
+    # Get the top 5 performing email domains for this campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of email domains and their associated stats including:
+    # * domain      (String)  = Domain name or special "Other" to roll-up stats past 5 domains.
+    # * total_sent  (Integer) = Total Email across all domains - this will be the same in every row.
+    # * emails      (Integer) = Number of emails sent to this domain.
+    # * bounces     (Integer) = Number of bounces.
+    # * opens       (Integer) = Number of opens.
+    # * clicks      (Integer) = Number of clicks.
+    # * unsubs      (Integer) = Number of unsubscribes.
+    # * delivered   (Integer) = Number of deliveries.
+    # * emails_pct  (Integer) = Percentage of emails that went to this domain (whole number).
+    # * bounces_pct (Integer) = Percentage of bounces from this domain (whole number).
+    # * opens_pct   (Integer) = Percentage of opens from this domain (whole number).
+    # * clicks_pct  (Integer) = Percentage of clicks from this domain (whole number).
+    # * unsubs_pct  (Integer) = Percentage of unsubs from this domain (whole number).
+    #
     def email_domain_performance(campaign_id)
-      # Get the top 5 performing email domains for this campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # An array of email domains and their associated stats including:
-      #   domain      (String)  = Domain name or special "Other" to roll-up stats past 5 domains.
-      #   total_sent  (Integer) = Total Email across all domains - this will be the same in every row.
-      #   emails      (Integer) = Number of emails sent to this domain.
-      #   bounces     (Integer) = Number of bounces.
-      #   opens       (Integer) = Number of opens.
-      #   clicks      (Integer) = Number of clicks.
-      #   unsubs      (Integer) = Number of unsubscribes.
-      #   delivered   (Integer) = Number of deliveries.
-      #   emails_pct  (Integer) = Percentage of emails that went to this domain (whole number).
-      #   bounces_pct (Integer) = Percentage of bounces from this domain (whole number).
-      #   opens_pct   (Integer) = Percentage of opens from this domain (whole number).
-      #   clicks_pct  (Integer) = Percentage of clicks from this domain (whole number).
-      #   unsubs_pct  (Integer) = Percentage of unsubs from this domain (whole number).
-      #
       call("campaignEmailDomainPerformance", campaign_id)
     end
     alias :email_performance :email_domain_performance
     
+    # Given a campaign and email address, return the entire click and open history with timestamps, ordered by time.
+    # Note: Requires the AIM module to be installed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * email (String) = The email address to check OR the email "id" returned from listMemberInfo, Webhooks, and Campaigns.
+    #
+    # Returns:
+    # An array of structs containing the actions including:
+    # * action    (String)    = The action taken (open or click).
+    # * timestamp (DateTime)  = Time the action occurred.
+    # * url       (String)    = For clicks, the URL that was clicked.
+    #
     def email_stats(campaign_id, email)
-      # Given a campaign and email address, return the entire click and open history with timestamps, ordered by time.
-      # Note: Requires the AIM module to be installed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # email (String) = The email address to check OR the email "id" returned from listMemberInfo, Webhooks, and Campaigns.
-      #
-      # Returns:
-      # An array of structs containing the actions including:
-      #   action    (String)    = The action taken (open or click).
-      #   timestamp (DateTime)  = Time the action occurred.
-      #   url       (String)    = For clicks, the URL that was clicked.
-      #
       call("campaignEmailStatsAIM", campaign_id, email)
     end
     alias :email_stats_aim :email_stats
     
+    # Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time,
+    # for every user a campaign was delivered to.
+    # Note: Requires the AIM module to be installed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 1000.
+    #
+    # Returns:
+    # An array of structs containing actions (opens and clicks) for each email, with timestamps including:
+    # * action    (String)    = The action taken (open or click).
+    # * timestamp (DateTime)  = Time the action occurred.
+    # * url       (String)    = For clicks, the URL that was clicked.
+    #
     def email_stats_all(campaign_id, start = 0, limit = 100)
-      # Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time,
-      # for every user a campaign was delivered to.
-      # Note: Requires the AIM module to be installed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 1000.
-      #
-      # Returns:
-      # An array of structs containing actions (opens and clicks) for each email, with timestamps including:
-      #   action    (String)    = The action taken (open or click).
-      #   timestamp (DateTime)  = Time the action occurred.
-      #   url       (String)    = For clicks, the URL that was clicked.
-      #
       call("campaignEmailStatsAIMAll", campaign_id, start, limit)
     end
     alias :email_stats_aim_all :email_stats_all
     
+    # Get all email addresses with Hard Bounces for a given campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    #
+    # Returns:
+    # An array of email addresses with Hard Bounces.
+    #
     def hard_bounces(campaign_id, start = 0, limit = 1000)
-      # Get all email addresses with Hard Bounces for a given campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # An array of email addresses with Hard Bounces.
-      #
       call("campaignHardBounces", campaign_id, start, limit)
     end
     
+    # Retrieve the list of email addresses that did not open a given campaign.
+    # Note: Requires the AIM module to be installed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    #
+    # Returns:
+    # A list of email addresses that did not open a campaign.
+    #
     def not_opened(campaign_id, start = 0, limit = 1000)
-      # Retrieve the list of email addresses that did not open a given campaign.
-      # Note: Requires the AIM module to be installed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # A list of email addresses that did not open a campaign.
-      #
       call("campaignNotOpenedAIM", campaign_id, start, limit)
     end
     alias :not_opened_aim :not_opened
     
+    # Retrieve the list of email addresses that opened a given campaign with how many times they opened.
+    # Note: this AIM function is free and does not actually require the AIM module to be installed.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    #
+    # Returns:
+    # An array of structs containing email addresses and open counts including:
+    # * email       (String)  = Email address that opened the campaign.
+    # * open_count  (Integer) = Total number of times the campaign was opened by this email address.
+    #
     def opened(campaign_id, start = 0, limit = 1000)
-      # Retrieve the list of email addresses that opened a given campaign with how many times they opened.
-      # Note: this AIM function is free and does not actually require the AIM module to be installed.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # An array of structs containing email addresses and open counts including:
-      #   email       (String)  = Email address that opened the campaign.
-      #   open_count  (Integer) = Total number of times the campaign was opened by this email address.
-      #
       call("campaignOpenedAIM", campaign_id, start, limit)
     end
     alias :opened_aim :opened
     
+    # Retrieve the Ecommerce Orders.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer)   = For large data sets, the page number to start at.
+    # * limit (Integer)   = For large data sets, the number of results to return. Upper limit set at 500.
+    # * since (DateTime)  = Pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT.
+    #
+    # Returns:
+    # An array of orders and their details for this campaign, including:
+    # * store_id    (String)  = The store id generated by the plugin used to uniquely identify a store.
+    # * store_name  (String)  = The store name collected by the plugin - often the domain name.
+    # * order_id    (Integer) = The internal order id the store tracked this order by.
+    # * email       (String)  = The email address that received this campaign and is associated with this order.
+    # * order_total (Double)  = The order total.
+    # * tax_total   (Double)  = The total tax for the order (if collected).
+    # * ship_total  (Double)  = The shipping total for the order (if collected).
+    # * order_date  (String)  = The date the order was tracked - from the store if possible, otherwise the GMT time received.
+    # * lines       (Array)   = Containing details of the order - product, category, quantity, item cost.
+    #
     def orders(campaign_id, start = 0, limit = 100, since = "2001-01-01 00:00:00")
-      # Retrieve the Ecommerce Orders.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer)   = For large data sets, the page number to start at.
-      # limit (Integer)   = For large data sets, the number of results to return. Upper limit set at 500.
-      # since (DateTime)  = Pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT.
-      #
-      # Returns:
-      # An array of orders and their details for this campaign, including:
-      #   store_id    (String)  = The store id generated by the plugin used to uniquely identify a store.
-      #   store_name  (String)  = The store name collected by the plugin - often the domain name.
-      #   order_id    (Integer) = The internal order id the store tracked this order by.
-      #   email       (String)  = The email address that received this campaign and is associated with this order.
-      #   order_total (Double)  = The order total.
-      #   tax_total   (Double)  = The total tax for the order (if collected).
-      #   ship_total  (Double)  = The shipping total for the order (if collected).
-      #   order_date  (String)  = The date the order was tracked - from the store if possible, otherwise the GMT time received.
-      #   lines       (Array)   = Containing details of the order - product, category, quantity, item cost.
-      #
       call("campaignEcommOrders", campaign_id, start, limit, since)
     end
     alias :ecomm_orders :orders
     
+    # Pause an AutoResponder orRSS campaign from sending.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # True if successful.
     def pause(campaign_id)
-      # Pause an AutoResponder orRSS campaign from sending.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # True if successful.
       call("campaignPause", campaign_id)
     end
     
+    # Replicate a campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # The ID of the newly created replicated campaign. (String)
+    #
     def replicate(campaign_id)
-      # Replicate a campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # The ID of the newly created replicated campaign. (String)
-      #
       call("campaignReplicate", campaign_id)
     end
     alias :replicate_campaign :replicate
     
+    # Resume sending an AutoResponder or RSS campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # True if successful.
+    #
     def resume(campaign_id)
-      # Resume sending an AutoResponder or RSS campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # True if successful.
-      #
       call("campaignResume", campaign_id)
     end
     
+    # Schedule a campaign to be sent in the future.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * time    (DateTime) =  The time to schedule the campaign. For A/B Split "schedule" campaigns, the time for Group A - in YYYY-MM-DD HH:II:SS format in GMT.
+    # * time_b  (DateTime) =  The time to schedule Group B of an A/B Split "schedule" campaign - in YYYY-MM-DD HH:II:SS format in GMT. (optional)
+    #
+    # Returns:
+    # True if successful.
+    #
     def schedule(campaign_id, time = "#{1.day.from_now}", time_b = "")
-      # Schedule a campaign to be sent in the future.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # time    (DateTime) =  The time to schedule the campaign. For A/B Split "schedule" campaigns, the time
-      #                       for Group A - in YYYY-MM-DD HH:II:SS format in GMT.
-      # time_b  (DateTime) =  The time to schedule Group B of an A/B Split "schedule" campaign - in
-      #                       YYYY-MM-DD HH:II:SS format in GMT. (optional)
-      #
-      # Returns:
-      # True if successful.
-      #
       call("campaignSchedule", campaign_id, time, time_b)
     end
     alias :schedule_campaign :schedule
     
+    # Send this campaign immediately.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign to send.
+    #
+    # Returns:
+    # True if successful.
     def send(campaign_id)
-      # Send this campaign immediately.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign to send.
-      #
-      # Returns:
-      # True if successful.
       call("campaignSendNow", campaign_id)
     end
     alias :send_now :send
     
+    # Send a test of this campaign to the provided email address(es).
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * emails    (Hash)    = A hash of email addresses to receive the test message.
+    # * send_type (String)  = One of 'html', 'text' or nil (send both). Defaults to nil.
+    #
+    # Returns:
+    # True if successful.
+    #
     def send_test(campaign_id, emails = {}, send_type = nil)
-      # Send a test of this campaign to the provided email address(es).
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # emails    (Hash)    = A hash of email addresses to receive the test message.
-      # send_type (String)  = One of 'html', 'text' or nil (send both). Defaults to nil.
-      #
-      # Returns:
-      # True if successful.
-      #
       call("campaignSendTest", campaign_id, emails, send_type)
     end
     
+    # Get the URL to a customized VIP Report for the specified campaign and optionally send an email
+    # to someone with links to it. Note subsequent calls will overwrite anything already set for the
+    # same campign (eg, the password).
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * options (Hash) = A hash of parameters which can be used to configure the shared report, including: (optional)
+    #   * header_type (String)  = One of "text" or "image". Defaults to 'text'. (optional)
+    #   * header_data (String)  = If "header_type" is text, the text to display. If "header_type" is "image" a valid URL to an image file. Note that images will be resized to be no more than 500x150. Defaults to the Accounts Company Name. (optional)
+    #   * secure      (Boolean) = Whether to require a password for the shared report. Defaults to "true". (optional)
+    #   * password    (String)  = If secure is true and a password is not included, we will generate one. It is always returned. (optional)
+    #   * to_email    (String)  = Email address to share the report with - no value means an email will not be sent. (optional)
+    #   * theme       (Array)   = An array containing either 3 or 6 character color code values for: "bg_color", "header_color", "current_tab", "current_tab_text", "normal_tab", "normal_tab_text", "hover_tab", "hover_tab_text". (optional)
+    #   * css_url     (String)  = A link to an external CSS file to be included after our default CSS (http://vip-reports.net/css/vip.css) only if loaded via the "secure_url" - max 255 characters. (optional)
+    #
+    # Returns:
+    # A struct containing details for the shared report including:
+    # * title       (String) = The Title of the Campaign being shared.
+    # * url         (String) = The URL to the shared report.
+    # * secure_url  (String) = The URL to the shared report, including the password (good for loading in an IFRAME). For non-secure reports, this will not be returned.
+    # * password    (String) = If secured, the password for the report, otherwise this field will not be returned.
+    #
     def share_report(campaign_id, options = {})
-      # Get the URL to a customized VIP Report for the specified campaign and optionally send an email
-      # to someone with links to it. Note subsequent calls will overwrite anything already set for the
-      # same campign (eg, the password).
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # options (Hash) = A hash of parameters which can be used to configure the shared report, including: (optional)
-      #   header_type (String)  = One of "text" or "image". Defaults to 'text'. (optional)
-      #   header_data (String)  = If "header_type" is text, the text to display. If "header_type" is "image"
-      #                           a valid URL to an image file. Note that images will be resized to be no more
-      #                           than 500x150. Defaults to the Accounts Company Name. (optional)
-      #   secure      (Boolean) = Whether to require a password for the shared report. Defaults to "true". (optional)
-      #   password    (String)  = If secure is true and a password is not included, we will generate one. It is always returned. (optional)
-      #   to_email    (String)  = Email address to share the report with - no value means an email will not be sent. (optional)
-      #   theme       (Array)   = An array containing either 3 or 6 character color code values for: "bg_color",
-      #                           "header_color", "current_tab", "current_tab_text", "normal_tab", "normal_tab_text",
-      #                           "hover_tab", "hover_tab_text". (optional)
-      #   css_url     (String)  = A link to an external CSS file to be included after our default CSS
-      #                           (http://vip-reports.net/css/vip.css) only if loaded via the "secure_url"
-      #                           - max 255 characters. (optional)
-      #
-      # Returns:
-      # A struct containing details for the shared report including:
-      #   title       (String) = The Title of the Campaign being shared.
-      #   url         (String) = The URL to the shared report.
-      #   secure_url  (String) = The URL to the shared report, including the password (good for loading in an IFRAME).
-      #                          For non-secure reports, this will not be returned.
-      #   password    (String) = If secured, the password for the report, otherwise this field will not be returned.
-      #
       call("campaignShareReport", campaign_id, options)
     end
     
+    # Get all email addresses with Soft Bounces for a given campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    #
+    # Returns:
+    # An array of email addresses with Soft Bounces.
+    #
     def soft_bounces(campaign_id, start = 0, limit = 1000)
-      # Get all email addresses with Soft Bounces for a given campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # An array of email addresses with Soft Bounces.
-      #
       call("campaignSoftBounces", campaign_id, start, limit)
     end
     
+    # Get all the relevant campaign statistics for this campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of statistics for this campaign including:
+    # * syntax_error      (Integer) = Number of email addresses in campaign that had syntactical errors.
+    # * hard_bounces      (Integer) = Number of email addresses in campaign that hard bounced.
+    # * soft_bounces      (Integer) = Number of email addresses in campaign that soft bounced.
+    # * unsubscribes      (Integer) = Number of email addresses in campaign that unsubscribed.
+    # * abuse_reports     (Integer) = Number of email addresses in campaign that reported campaign for abuse.
+    # * forwards          (Integer) = Number of times email was forwarded to a friend.
+    # * forwards_opens    (Integer) = Number of times a forwarded email was opened.
+    # * opens             (Integer) = Number of times the campaign was opened.
+    # * last_open         (Date)    = Date of the last time the email was opened.
+    # * unique_opens      (Integer) = Number of people who opened the campaign.
+    # * clicks            (Integer) = Number of times a link in the campaign was clicked.
+    # * unique_clicks     (Integer) = Number of unique recipient/click pairs for the campaign.
+    # * last_click        (Date)    = Date of the last time a link in the email was clicked.
+    # * users_who_clicked (Integer) = Number of unique recipients who clicked on a link in the campaign.
+    # * emails_sent       (Integer) = Number of email addresses campaign was sent to.
+    #
     def stats(campaign_id)
-      # Get all the relevant campaign statistics for this campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # An array of statistics for this campaign including:
-      #   syntax_error      (Integer) = Number of email addresses in campaign that had syntactical errors.
-      #   hard_bounces      (Integer) = Number of email addresses in campaign that hard bounced.
-      #   soft_bounces      (Integer) = Number of email addresses in campaign that soft bounced.
-      #   unsubscribes      (Integer) = Number of email addresses in campaign that unsubscribed.
-      #   abuse_reports     (Integer) = Number of email addresses in campaign that reported campaign for abuse.
-      #   forwards          (Integer) = Number of times email was forwarded to a friend.
-      #   forwards_opens    (Integer) = Number of times a forwarded email was opened.
-      #   opens             (Integer) = Number of times the campaign was opened.
-      #   last_open         (Date)    = Date of the last time the email was opened.
-      #   unique_opens      (Integer) = Number of people who opened the campaign.
-      #   clicks            (Integer) = Number of times a link in the campaign was clicked.
-      #   unique_clicks     (Integer) = Number of unique recipient/click pairs for the campaign.
-      #   last_click        (Date)    = Date of the last time a link in the email was clicked.
-      #   users_who_clicked (Integer) = Number of unique recipients who clicked on a link in the campaign.
-      #   emails_sent       (Integer) = Number of email addresses campaign was sent to.
-      #
       call("campaignStats", campaign_id)
     end
     alias :campaign_stats :stats
     
+    # Update just about any setting for a campaign that has not been sent.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * name  (String)    = The parameter name.
+    # * value (Variable)  = An appropriate value for the parameter.
+    #
+    # Returns:
+    # True if successful, error code if not.
+    #
     def update(campaign_id, name, value)
-      # Update just about any setting for a campaign that has not been sent.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # name  (String)    = The parameter name.
-      # value (Variable)  = An appropriate value for the parameter.
-      #
-      # Returns:
-      # True if successful, error code if not.
-      #
       call("campaignUpdate", campaign_id, name, value)
     end
     
+    # Unschedule a campaign that is scheduled to be sent in the future.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # True if successful.
+    #
     def unschedule(campaign_id)
-      # Unschedule a campaign that is scheduled to be sent in the future.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      #
-      # Returns:
-      # True if successful.
-      #
       call("campaignUnschedule", campaign_id)
     end
     
+    # Get all unsubscribed email addresses for a given campaign.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * start (Integer) = For large data sets, the page number to start at.
+    # * limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
+    # 
+    # Returns:
+    # An array of email addresses that unsubscribed from this campaign.
+    #
     def unsubsribes(campaign_id, start = 0, limit = 1000)
-      # Get all unsubscribed email addresses for a given campaign.
-      #
-      # Parameters:
-      # campaign_id (String) = The ID of the campaign.
-      # start (Integer) = For large data sets, the page number to start at.
-      # limit (Integer) = For large data sets, the number of results to return. Upper limit set at 15000.
-      #
-      # Returns:
-      # An array of email addresses that unsubscribed from this campaign.
-      #
       call("campaignUnsubscribes", campaign_id, start, limit)
     end