MailchimpMarketing 3.0.2 → 3.0.5

data/lib/MailchimpMarketing/api/ping_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.5
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # Ping the API
+    # Ping
     # A health check for the API that won't return any account-specific information.
     # @param [Hash] opts the optional parameters
     # @return [APIHealthStatus]
@@ -28,7 +28,7 @@ module MailchimpMarketing
       data
     end
 
-    # Ping the API
+    # Ping
     # A health check for the API that won't return any account-specific information.
     # @param [Hash] opts the optional parameters
     # @return [Array<(APIHealthStatus, Fixnum, Hash)>] APIHealthStatus data, response status code and response headers

data/lib/MailchimpMarketing/api/postcards_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.5
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # __summary__
+    # List postcards
     # Get all of a user's postcards.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :sort_dir Determines the order direction for sorted results.
@@ -32,7 +32,7 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
+    # List postcards
     # Get all of a user's postcards.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :sort_dir Determines the order direction for sorted results.

data/lib/MailchimpMarketing/api/reporting_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.5
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,8 +19,8 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # Get information about the reporting endpoint's resources
-    # Get information about the reporting endpoint's resources
+    # List reporting resources
+    # Get information about the reporting endpoint's resources.
     # @param [Hash] opts the optional parameters
     # @return [Reporting]
     def info(opts = {})
@@ -28,8 +28,8 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about the reporting endpoint's resources
-    # Get information about the reporting endpoint's resources
+    # List reporting resources
+    # Get information about the reporting endpoint's resources.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Reporting, Fixnum, Hash)>] Reporting data, response status code and response headers
     def info_with_http_info(opts = {})
@@ -61,8 +61,8 @@ module MailchimpMarketing
         :return_type => 'Reporting')
       return data, status_code, headers
     end
-    # __summary__
-    # Get reports of Facebook Ads
+    # List facebook ads reports
+    # Get reports of Facebook ads.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
     # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
@@ -76,8 +76,8 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
-    # Get reports of Facebook Ads
+    # List facebook ads reports
+    # Get reports of Facebook ads.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
     # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
@@ -121,8 +121,8 @@ module MailchimpMarketing
         :return_type => 'InlineResponse20011')
       return data, status_code, headers
     end
-    # __summary__
-    # Get report of a facebook ad
+    # Get facebook ad report
+    # Get report of a Facebook ad.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -133,8 +133,8 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
-    # Get report of a facebook ad
+    # Get facebook ad report
+    # Get report of a Facebook ad.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -171,8 +171,8 @@ module MailchimpMarketing
         :return_type => 'InlineResponse20012')
       return data, status_code, headers
     end
-    # __summary__
-    # Get breakdown of product activity for an outreach
+    # List facebook ecommerce report
+    # Get breakdown of product activity for an outreach.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -186,8 +186,8 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
-    # Get breakdown of product activity for an outreach
+    # List facebook ecommerce report
+    # Get breakdown of product activity for an outreach.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -230,8 +230,8 @@ module MailchimpMarketing
         :return_type => 'InlineResponse2008')
       return data, status_code, headers
     end
-    # __summary__
-    # Get reports of Landing Pages
+    # List landing pages reports
+    # Get reports of landing pages.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
     # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
@@ -243,8 +243,8 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
-    # Get reports of Landing Pages
+    # List landing pages reports
+    # Get reports of landing pages.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
     # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
@@ -284,8 +284,8 @@ module MailchimpMarketing
         :return_type => 'InlineResponse20013')
       return data, status_code, headers
     end
-    # __summary__
-    # Get report of a landing page
+    # Get landing page report
+    # Get report of a landing page.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -296,8 +296,8 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
-    # Get report of a landing page
+    # Get landing page report
+    # Get report of a landing page.
     # @param outreach_id The outreach id.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

data/lib/MailchimpMarketing/api/reports_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.5
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # Get campaign reports
+    # List campaign reports
     # Get campaign reports.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -35,7 +35,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get campaign reports
+    # List campaign reports
     # Get campaign reports.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -82,7 +82,7 @@ module MailchimpMarketing
         :return_type => 'CampaignReports1')
       return data, status_code, headers
     end
-    # Get a specific campaign report
+    # Get campaign report
     # Get report details for a specific sent campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -94,7 +94,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get a specific campaign report
+    # Get campaign report
     # Get report details for a specific sent campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -132,8 +132,8 @@ module MailchimpMarketing
         :return_type => 'CampaignReport')
       return data, status_code, headers
     end
-    # Get abuse complaints for a campaign
-    # Get a list of [abuse complaints](https://mailchimp.com/help/about-abuse-complaints/) for a specific campaign.
+    # List abuse reports
+    # Get a list of abuse complaints for a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -144,8 +144,8 @@ module MailchimpMarketing
       data
     end
 
-    # Get abuse complaints for a campaign
-    # Get a list of [abuse complaints](https://mailchimp.com/help/about-abuse-complaints/) for a specific campaign.
+    # List abuse reports
+    # Get a list of abuse complaints for a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -182,7 +182,7 @@ module MailchimpMarketing
         :return_type => 'AbuseComplaints1')
       return data, status_code, headers
     end
-    # Get information about a specific abuse report
+    # Get abuse report
     # Get information about a specific abuse report for a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param report_id The id for the abuse report.
@@ -195,7 +195,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about a specific abuse report
+    # Get abuse report
     # Get information about a specific abuse report for a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param report_id The id for the abuse report.
@@ -234,7 +234,7 @@ module MailchimpMarketing
         :return_type => 'AbuseComplaint1')
       return data, status_code, headers
     end
-    # Get campaign feedback
+    # List campaign feedback
     # Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -246,7 +246,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get campaign feedback
+    # List campaign feedback
     # Get feedback based on a campaign&#39;s statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -284,8 +284,8 @@ module MailchimpMarketing
         :return_type => 'CampaignAdviceReport')
       return data, status_code, headers
     end
-    # Get campaign click details
-    # Get information about [clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) on specific links in your Mailchimp campaigns.
+    # List campaign details
+    # Get information about clicks on specific links in your Mailchimp campaigns.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -298,8 +298,8 @@ module MailchimpMarketing
       data
     end
 
-    # Get campaign click details
-    # Get information about [clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) on specific links in your Mailchimp campaigns.
+    # List campaign details
+    # Get information about clicks on specific links in your Mailchimp campaigns.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -340,7 +340,7 @@ module MailchimpMarketing
         :return_type => 'ClickDetailReport')
       return data, status_code, headers
     end
-    # Get click details for a specific link
+    # Get campaign link details
     # Get click details for a specific link in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -353,7 +353,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get click details for a specific link
+    # Get campaign link details
     # Get click details for a specific link in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -392,7 +392,7 @@ module MailchimpMarketing
         :return_type => 'ClickDetailReport')
       return data, status_code, headers
     end
-    # Get information about subscribers who clicked a link
+    # List clicked link subscribers
     # Get information about list members who clicked on a specific link in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -407,7 +407,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about subscribers who clicked a link
+    # List clicked link subscribers
     # Get information about list members who clicked on a specific link in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -450,7 +450,7 @@ module MailchimpMarketing
         :return_type => 'ClickDetailMembers')
       return data, status_code, headers
     end
-    # Get information about a specific subscriber who clicked a link
+    # Get clicked link subscriber
     # Get information about a specific subscriber who clicked a link in a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -464,7 +464,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about a specific subscriber who clicked a link
+    # Get clicked link subscriber
     # Get information about a specific subscriber who clicked a link in a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param link_id The id for the link.
@@ -504,7 +504,7 @@ module MailchimpMarketing
         :return_type => 'ClickDetailMember')
       return data, status_code, headers
     end
-    # Get domain performance stats
+    # List domain performance stats
     # Get statistics for the top-performing email domains in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -516,7 +516,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get domain performance stats
+    # List domain performance stats
     # Get statistics for the top-performing email domains in a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -554,7 +554,7 @@ module MailchimpMarketing
         :return_type => 'DomainPerformance')
       return data, status_code, headers
     end
-    # __summary__
+    # List campaign product activity
     # Get breakdown of product activity for a campaign
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -569,7 +569,7 @@ module MailchimpMarketing
       data
     end
 
-    # __summary__
+    # List campaign product activity
     # Get breakdown of product activity for a campaign
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -613,7 +613,7 @@ module MailchimpMarketing
         :return_type => 'InlineResponse2008')
       return data, status_code, headers
     end
-    # Get Eepurl activity
+    # List eep url activity
     # Get a summary of social activity for the campaign, tracked by EepURL.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -625,7 +625,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get Eepurl activity
+    # List eep url activity
     # Get a summary of social activity for the campaign, tracked by EepURL.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -663,7 +663,7 @@ module MailchimpMarketing
         :return_type => 'EepurlActivity')
       return data, status_code, headers
     end
-    # Get email activity
+    # List email activity
     # Get a list of member's subscriber activity in a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -678,7 +678,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get email activity
+    # List email activity
     # Get a list of member&#39;s subscriber activity in a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -722,7 +722,7 @@ module MailchimpMarketing
         :return_type => 'EmailActivity')
       return data, status_code, headers
     end
-    # Get email activity for a specific subscriber
+    # Get subscriber email activity
     # Get a specific list member's activity in a campaign including opens, clicks, and bounces.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -736,7 +736,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get email activity for a specific subscriber
+    # Get subscriber email activity
     # Get a specific list member&#39;s activity in a campaign including opens, clicks, and bounces.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -777,7 +777,7 @@ module MailchimpMarketing
         :return_type => 'EmailActivity')
       return data, status_code, headers
     end
-    # Get top open locations
+    # List top open activities
     # Get top open locations for a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -791,7 +791,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get top open locations
+    # List top open activities
     # Get top open locations for a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -833,7 +833,7 @@ module MailchimpMarketing
         :return_type => 'OpenLocations')
       return data, status_code, headers
     end
-    # Get campaign Open details
+    # List campaign open details
     # Get detailed information about any campaign emails that were opened by a list member.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -848,7 +848,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get campaign Open details
+    # List campaign open details
     # Get detailed information about any campaign emails that were opened by a list member.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -892,7 +892,7 @@ module MailchimpMarketing
         :return_type => 'OpenDetailReport')
       return data, status_code, headers
     end
-    # Get information about a specific subscriber who opened a campaign
+    # Get opened campaign subscriber
     # Get information about a specific subscriber who opened a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -905,7 +905,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about a specific subscriber who opened a campaign
+    # Get opened campaign subscriber
     # Get information about a specific subscriber who opened a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -944,7 +944,7 @@ module MailchimpMarketing
         :return_type => 'OpenActivity')
       return data, status_code, headers
     end
-    # Get information about campaign recipients
+    # List campaign recipients
     # Get information about campaign recipients.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -958,7 +958,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about campaign recipients
+    # List campaign recipients
     # Get information about campaign recipients.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -1000,7 +1000,7 @@ module MailchimpMarketing
         :return_type => 'SentTo')
       return data, status_code, headers
     end
-    # Get information about a specific campaign recipient
+    # Get campaign recipient info
     # Get information about a specific campaign recipient.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -1013,7 +1013,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about a specific campaign recipient
+    # Get campaign recipient info
     # Get information about a specific campaign recipient.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -1052,7 +1052,7 @@ module MailchimpMarketing
         :return_type => 'SentTo')
       return data, status_code, headers
     end
-    # Get reports for child campaigns
+    # List child campaign reports
     # Get a list of reports with child campaigns for a specific parent campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -1064,7 +1064,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get reports for child campaigns
+    # List child campaign reports
     # Get a list of reports with child campaigns for a specific parent campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -1102,7 +1102,7 @@ module MailchimpMarketing
         :return_type => 'CampaignSubReports')
       return data, status_code, headers
     end
-    # Get unsubscribed list members
+    # List unsubscribed members
     # Get information about members who have unsubscribed from a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -1116,7 +1116,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get unsubscribed list members
+    # List unsubscribed members
     # Get information about members who have unsubscribed from a specific campaign.
     # @param campaign_id The unique id for the campaign.
     # @param [Hash] opts the optional parameters
@@ -1158,7 +1158,7 @@ module MailchimpMarketing
         :return_type => 'Unsubscribes')
       return data, status_code, headers
     end
-    # Get information about a specific list member who unsubscribed
+    # Get unsubscribed member
     # Get information about a specific list member who unsubscribed from a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
@@ -1171,7 +1171,7 @@ module MailchimpMarketing
       data
     end
 
-    # Get information about a specific list member who unsubscribed
+    # Get unsubscribed member
     # Get information about a specific list member who unsubscribed from a campaign.
     # @param campaign_id The unique id for the campaign.
     # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.