MailchimpMarketing 3.0.2 → 3.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/MailchimpMarketing.gemspec +1 -1
  3. data/README.md +41 -28
  4. data/lib/MailchimpMarketing.rb +5 -6
  5. data/lib/MailchimpMarketing/api/activity_feed_api.rb +7 -7
  6. data/lib/MailchimpMarketing/api/authorized_apps_api.rb +9 -9
  7. data/lib/MailchimpMarketing/api/automations_api.rb +47 -47
  8. data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +11 -11
  9. data/lib/MailchimpMarketing/api/batches_api.rb +9 -9
  10. data/lib/MailchimpMarketing/api/campaign_folders_api.rb +11 -11
  11. data/lib/MailchimpMarketing/api/campaigns_api.rb +57 -57
  12. data/lib/MailchimpMarketing/api/connected_sites_api.rb +11 -11
  13. data/lib/MailchimpMarketing/api/conversations_api.rb +11 -11
  14. data/lib/MailchimpMarketing/api/dashboard_api.rb +13 -13
  15. data/lib/MailchimpMarketing/api/ecommerce_api.rb +119 -119
  16. data/lib/MailchimpMarketing/api/external_auths_api.rb +7 -7
  17. data/lib/MailchimpMarketing/api/facebook_ads_api.rb +9 -9
  18. data/lib/MailchimpMarketing/api/file_manager_api.rb +25 -25
  19. data/lib/MailchimpMarketing/api/landing_pages_api.rb +13 -13
  20. data/lib/MailchimpMarketing/api/lists_api.rb +145 -145
  21. data/lib/MailchimpMarketing/api/ping_api.rb +3 -3
  22. data/lib/MailchimpMarketing/api/postcards_api.rb +3 -3
  23. data/lib/MailchimpMarketing/api/reporting_api.rb +25 -25
  24. data/lib/MailchimpMarketing/api/reports_api.rb +49 -49
  25. data/lib/MailchimpMarketing/api/root_api.rb +3 -3
  26. data/lib/MailchimpMarketing/api/search_campaigns_api.rb +3 -3
  27. data/lib/MailchimpMarketing/api/search_members_api.rb +3 -3
  28. data/lib/MailchimpMarketing/api/template_folders_api.rb +11 -11
  29. data/lib/MailchimpMarketing/api/templates_api.rb +15 -15
  30. data/lib/MailchimpMarketing/api/verified_domains_api.rb +11 -11
  31. data/lib/MailchimpMarketing/api_client.rb +35 -12
  32. data/lib/MailchimpMarketing/api_error.rb +1 -1
  33. data/lib/MailchimpMarketing/configuration.rb +1 -1
  34. data/lib/MailchimpMarketing/version.rb +2 -2
  35. metadata +2 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 3.0.2
6
+ OpenAPI spec version: 3.0.5
7
7
  Contact: apihelp@mailchimp.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
19
19
  def initialize(api_client)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a batch webhook
22
+ # Delete batch webhook
23
23
  # Remove a batch webhook. Webhooks will no longer be sent to the given URL.
24
24
  # @param batch_webhook_id The unique id for the batch webhook.
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MailchimpMarketing
29
29
  nil
30
30
  end
31
31
 
32
- # Delete a batch webhook
32
+ # Delete batch webhook
33
33
  # Remove a batch webhook. Webhooks will no longer be sent to the given URL.
34
34
  # @param batch_webhook_id The unique id for the batch webhook.
35
35
  # @param [Hash] opts the optional parameters
@@ -62,7 +62,7 @@ module MailchimpMarketing
62
62
  :auth_names => auth_names)
63
63
  return data, status_code, headers
64
64
  end
65
- # Get a batch webook
65
+ # Get batch webhook info
66
66
  # Get information about a specific batch webhook.
67
67
  # @param batch_webhook_id The unique id for the batch webhook.
68
68
  # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ module MailchimpMarketing
74
74
  data
75
75
  end
76
76
 
77
- # Get a batch webook
77
+ # Get batch webhook info
78
78
  # Get information about a specific batch webhook.
79
79
  # @param batch_webhook_id The unique id for the batch webhook.
80
80
  # @param [Hash] opts the optional parameters
@@ -112,7 +112,7 @@ module MailchimpMarketing
112
112
  :return_type => 'BatchWebhook')
113
113
  return data, status_code, headers
114
114
  end
115
- # Get a list of all webhooks configured for batches
115
+ # List batch webhooks
116
116
  # Get all webhooks that have been configured for batches.
117
117
  # @param [Hash] opts the optional parameters
118
118
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -125,7 +125,7 @@ module MailchimpMarketing
125
125
  data
126
126
  end
127
127
 
128
- # Get a list of all webhooks configured for batches
128
+ # List batch webhooks
129
129
  # Get all webhooks that have been configured for batches.
130
130
  # @param [Hash] opts the optional parameters
131
131
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -166,7 +166,7 @@ module MailchimpMarketing
166
166
  :return_type => 'BatchWebhooks')
167
167
  return data, status_code, headers
168
168
  end
169
- # Update a webhook for batches
169
+ # Update batch webhook
170
170
  # Update a webhook that will fire whenever any batch request completes processing.
171
171
  # @param batch_webhook_id The unique id for the batch webhook.
172
172
  # @param body
@@ -177,7 +177,7 @@ module MailchimpMarketing
177
177
  data
178
178
  end
179
179
 
180
- # Update a webhook for batches
180
+ # Update batch webhook
181
181
  # Update a webhook that will fire whenever any batch request completes processing.
182
182
  # @param batch_webhook_id The unique id for the batch webhook.
183
183
  # @param body
@@ -212,7 +212,7 @@ module MailchimpMarketing
212
212
  :return_type => 'BatchWebhook')
213
213
  return data, status_code, headers
214
214
  end
215
- # Configure a webhook for batches
215
+ # Add batch webhook
216
216
  # Configure a webhook that will fire whenever any batch request completes processing.
217
217
  # @param body
218
218
  # @param [Hash] opts the optional parameters
@@ -222,7 +222,7 @@ module MailchimpMarketing
222
222
  data
223
223
  end
224
224
 
225
- # Configure a webhook for batches
225
+ # Add batch webhook
226
226
  # Configure a webhook that will fire whenever any batch request completes processing.
227
227
  # @param body
228
228
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 3.0.2
6
+ OpenAPI spec version: 3.0.5
7
7
  Contact: apihelp@mailchimp.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
19
19
  def initialize(api_client)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a batch request and stop if from processing further.
22
+ # Delete batch request
23
23
  # Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.
24
24
  # @param batch_id The unique id for the batch operation.
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MailchimpMarketing
29
29
  nil
30
30
  end
31
31
 
32
- # Delete a batch request and stop if from processing further.
32
+ # Delete batch request
33
33
  # Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.
34
34
  # @param batch_id The unique id for the batch operation.
35
35
  # @param [Hash] opts the optional parameters
@@ -62,7 +62,7 @@ module MailchimpMarketing
62
62
  :auth_names => auth_names)
63
63
  return data, status_code, headers
64
64
  end
65
- # Get a list of batch requests
65
+ # List batch requests
66
66
  # Get a summary of batch requests that have been made.
67
67
  # @param [Hash] opts the optional parameters
68
68
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -75,7 +75,7 @@ module MailchimpMarketing
75
75
  data
76
76
  end
77
77
 
78
- # Get a list of batch requests
78
+ # List batch requests
79
79
  # Get a summary of batch requests that have been made.
80
80
  # @param [Hash] opts the optional parameters
81
81
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -116,7 +116,7 @@ module MailchimpMarketing
116
116
  :return_type => 'BatchOperations')
117
117
  return data, status_code, headers
118
118
  end
119
- # Get the status of a batch operation request
119
+ # Get batch operation status
120
120
  # Get the status of a batch request.
121
121
  # @param batch_id The unique id for the batch operation.
122
122
  # @param [Hash] opts the optional parameters
@@ -128,7 +128,7 @@ module MailchimpMarketing
128
128
  data
129
129
  end
130
130
 
131
- # Get the status of a batch operation request
131
+ # Get batch operation status
132
132
  # Get the status of a batch request.
133
133
  # @param batch_id The unique id for the batch operation.
134
134
  # @param [Hash] opts the optional parameters
@@ -166,7 +166,7 @@ module MailchimpMarketing
166
166
  :return_type => 'Batch')
167
167
  return data, status_code, headers
168
168
  end
169
- # Start a batch operation
169
+ # Start batch operation
170
170
  # Begin processing a batch operations request.
171
171
  # @param body
172
172
  # @param [Hash] opts the optional parameters
@@ -176,7 +176,7 @@ module MailchimpMarketing
176
176
  data
177
177
  end
178
178
 
179
- # Start a batch operation
179
+ # Start batch operation
180
180
  # Begin processing a batch operations request.
181
181
  # @param body
182
182
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 3.0.2
6
+ OpenAPI spec version: 3.0.5
7
7
  Contact: apihelp@mailchimp.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
19
19
  def initialize(api_client)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a campaign folder
22
+ # Delete campaign folder
23
23
  # Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.
24
24
  # @param folder_id The unique id for the campaign folder.
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MailchimpMarketing
29
29
  nil
30
30
  end
31
31
 
32
- # Delete a campaign folder
32
+ # Delete campaign folder
33
33
  # Delete a specific campaign folder, and mark all the campaigns in the folder as &#39;unfiled&#39;.
34
34
  # @param folder_id The unique id for the campaign folder.
35
35
  # @param [Hash] opts the optional parameters
@@ -62,7 +62,7 @@ module MailchimpMarketing
62
62
  :auth_names => auth_names)
63
63
  return data, status_code, headers
64
64
  end
65
- # Get all campaign folders
65
+ # List campaign folders
66
66
  # Get all folders used to organize campaigns.
67
67
  # @param [Hash] opts the optional parameters
68
68
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -75,7 +75,7 @@ module MailchimpMarketing
75
75
  data
76
76
  end
77
77
 
78
- # Get all campaign folders
78
+ # List campaign folders
79
79
  # Get all folders used to organize campaigns.
80
80
  # @param [Hash] opts the optional parameters
81
81
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -116,7 +116,7 @@ module MailchimpMarketing
116
116
  :return_type => 'CampaignFolders')
117
117
  return data, status_code, headers
118
118
  end
119
- # Get a specific campaign folder
119
+ # Get campaign folder
120
120
  # Get information about a specific folder used to organize campaigns.
121
121
  # @param folder_id The unique id for the campaign folder.
122
122
  # @param [Hash] opts the optional parameters
@@ -128,7 +128,7 @@ module MailchimpMarketing
128
128
  data
129
129
  end
130
130
 
131
- # Get a specific campaign folder
131
+ # Get campaign folder
132
132
  # Get information about a specific folder used to organize campaigns.
133
133
  # @param folder_id The unique id for the campaign folder.
134
134
  # @param [Hash] opts the optional parameters
@@ -166,7 +166,7 @@ module MailchimpMarketing
166
166
  :return_type => 'CampaignFolder')
167
167
  return data, status_code, headers
168
168
  end
169
- # Update a campaign folder
169
+ # Update campaign folder
170
170
  # Update a specific folder used to organize campaigns.
171
171
  # @param folder_id The unique id for the campaign folder.
172
172
  # @param body
@@ -177,7 +177,7 @@ module MailchimpMarketing
177
177
  data
178
178
  end
179
179
 
180
- # Update a campaign folder
180
+ # Update campaign folder
181
181
  # Update a specific folder used to organize campaigns.
182
182
  # @param folder_id The unique id for the campaign folder.
183
183
  # @param body
@@ -212,7 +212,7 @@ module MailchimpMarketing
212
212
  :return_type => 'CampaignFolder')
213
213
  return data, status_code, headers
214
214
  end
215
- # Create campaign folder
215
+ # Add campaign folder
216
216
  # Create a new campaign folder.
217
217
  # @param body
218
218
  # @param [Hash] opts the optional parameters
@@ -222,7 +222,7 @@ module MailchimpMarketing
222
222
  data
223
223
  end
224
224
 
225
- # Create campaign folder
225
+ # Add campaign folder
226
226
  # Create a new campaign folder.
227
227
  # @param body
228
228
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 3.0.2
6
+ OpenAPI spec version: 3.0.5
7
7
  Contact: apihelp@mailchimp.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -19,7 +19,7 @@ module MailchimpMarketing
19
19
  def initialize(api_client)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a campaign
22
+ # Delete campaign
23
23
  # Remove a campaign from your Mailchimp account.
24
24
  # @param campaign_id The unique id for the campaign.
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MailchimpMarketing
29
29
  nil
30
30
  end
31
31
 
32
- # Delete a campaign
32
+ # Delete campaign
33
33
  # Remove a campaign from your Mailchimp account.
34
34
  # @param campaign_id The unique id for the campaign.
35
35
  # @param [Hash] opts the optional parameters
@@ -62,7 +62,7 @@ module MailchimpMarketing
62
62
  :auth_names => auth_names)
63
63
  return data, status_code, headers
64
64
  end
65
- # Delete a campaign feedback message
65
+ # Delete campaign feedback message
66
66
  # Remove a specific feedback message for a campaign.
67
67
  # @param campaign_id The unique id for the campaign.
68
68
  # @param feedback_id The unique id for the feedback message.
@@ -73,7 +73,7 @@ module MailchimpMarketing
73
73
  nil
74
74
  end
75
75
 
76
- # Delete a campaign feedback message
76
+ # Delete campaign feedback message
77
77
  # Remove a specific feedback message for a campaign.
78
78
  # @param campaign_id The unique id for the campaign.
79
79
  # @param feedback_id The unique id for the feedback message.
@@ -107,7 +107,7 @@ module MailchimpMarketing
107
107
  :auth_names => auth_names)
108
108
  return data, status_code, headers
109
109
  end
110
- # Get all campaigns
110
+ # List campaigns
111
111
  # Get all campaigns in an account.
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -131,7 +131,7 @@ module MailchimpMarketing
131
131
  data
132
132
  end
133
133
 
134
- # Get all campaigns
134
+ # List campaigns
135
135
  # Get all campaigns in an account.
136
136
  # @param [Hash] opts the optional parameters
137
137
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -194,7 +194,7 @@ module MailchimpMarketing
194
194
  :return_type => 'InlineResponse2005')
195
195
  return data, status_code, headers
196
196
  end
197
- # Get information about a specific campaign
197
+ # Get campaign info
198
198
  # Get information about a specific campaign.
199
199
  # @param campaign_id The unique id for the campaign.
200
200
  # @param [Hash] opts the optional parameters
@@ -206,7 +206,7 @@ module MailchimpMarketing
206
206
  data
207
207
  end
208
208
 
209
- # Get information about a specific campaign
209
+ # Get campaign info
210
210
  # Get information about a specific campaign.
211
211
  # @param campaign_id The unique id for the campaign.
212
212
  # @param [Hash] opts the optional parameters
@@ -294,8 +294,8 @@ module MailchimpMarketing
294
294
  :return_type => 'CampaignContent')
295
295
  return data, status_code, headers
296
296
  end
297
- # Get feedback about a campaign
298
- # Get team feedback while you're [working together on a Mailchimp campaign](https://mailchimp.com/help/collaborate-on-campaigns/).
297
+ # List campaign feedback
298
+ # Get team feedback while you're working together on a Mailchimp campaign.
299
299
  # @param campaign_id The unique id for the campaign.
300
300
  # @param [Hash] opts the optional parameters
301
301
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -306,8 +306,8 @@ module MailchimpMarketing
306
306
  data
307
307
  end
308
308
 
309
- # Get feedback about a campaign
310
- # Get team feedback while you&#39;re [working together on a Mailchimp campaign](https://mailchimp.com/help/collaborate-on-campaigns/).
309
+ # List campaign feedback
310
+ # Get team feedback while you&#39;re working together on a Mailchimp campaign.
311
311
  # @param campaign_id The unique id for the campaign.
312
312
  # @param [Hash] opts the optional parameters
313
313
  # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
@@ -344,7 +344,7 @@ module MailchimpMarketing
344
344
  :return_type => 'CampaignReports')
345
345
  return data, status_code, headers
346
346
  end
347
- # Get a specific feedback message
347
+ # Get campaign feedback message
348
348
  # Get a specific feedback message from a campaign.
349
349
  # @param campaign_id The unique id for the campaign.
350
350
  # @param feedback_id The unique id for the feedback message.
@@ -357,7 +357,7 @@ module MailchimpMarketing
357
357
  data
358
358
  end
359
359
 
360
- # Get a specific feedback message
360
+ # Get campaign feedback message
361
361
  # Get a specific feedback message from a campaign.
362
362
  # @param campaign_id The unique id for the campaign.
363
363
  # @param feedback_id The unique id for the feedback message.
@@ -396,7 +396,7 @@ module MailchimpMarketing
396
396
  :return_type => 'CampaignFeedback2')
397
397
  return data, status_code, headers
398
398
  end
399
- # Get the send checklist for a campaign
399
+ # Get campaign send checklist
400
400
  # Review the send checklist for a campaign, and resolve any issues before sending.
401
401
  # @param campaign_id The unique id for the campaign.
402
402
  # @param [Hash] opts the optional parameters
@@ -408,7 +408,7 @@ module MailchimpMarketing
408
408
  data
409
409
  end
410
410
 
411
- # Get the send checklist for a campaign
411
+ # Get campaign send checklist
412
412
  # Review the send checklist for a campaign, and resolve any issues before sending.
413
413
  # @param campaign_id The unique id for the campaign.
414
414
  # @param [Hash] opts the optional parameters
@@ -446,7 +446,7 @@ module MailchimpMarketing
446
446
  :return_type => 'SendChecklist')
447
447
  return data, status_code, headers
448
448
  end
449
- # Update the settings for a campaign
449
+ # Update campaign settings
450
450
  # Update some or all of the settings for a specific campaign.
451
451
  # @param campaign_id The unique id for the campaign.
452
452
  # @param body
@@ -457,7 +457,7 @@ module MailchimpMarketing
457
457
  data
458
458
  end
459
459
 
460
- # Update the settings for a campaign
460
+ # Update campaign settings
461
461
  # Update some or all of the settings for a specific campaign.
462
462
  # @param campaign_id The unique id for the campaign.
463
463
  # @param body
@@ -492,7 +492,7 @@ module MailchimpMarketing
492
492
  :return_type => 'Campaign')
493
493
  return data, status_code, headers
494
494
  end
495
- # Update a campaign feedback message
495
+ # Update campaign feedback message
496
496
  # Update a specific feedback message for a campaign.
497
497
  # @param campaign_id The unique id for the campaign.
498
498
  # @param feedback_id The unique id for the feedback message.
@@ -504,7 +504,7 @@ module MailchimpMarketing
504
504
  data
505
505
  end
506
506
 
507
- # Update a campaign feedback message
507
+ # Update campaign feedback message
508
508
  # Update a specific feedback message for a campaign.
509
509
  # @param campaign_id The unique id for the campaign.
510
510
  # @param feedback_id The unique id for the feedback message.
@@ -540,7 +540,7 @@ module MailchimpMarketing
540
540
  :return_type => 'CampaignFeedback2')
541
541
  return data, status_code, headers
542
542
  end
543
- # Create a new campaign
543
+ # Add campaign
544
544
  # Create a new Mailchimp campaign.
545
545
  # @param body
546
546
  # @param [Hash] opts the optional parameters
@@ -550,7 +550,7 @@ module MailchimpMarketing
550
550
  data
551
551
  end
552
552
 
553
- # Create a new campaign
553
+ # Add campaign
554
554
  # Create a new Mailchimp campaign.
555
555
  # @param body
556
556
  # @param [Hash] opts the optional parameters
@@ -584,8 +584,8 @@ module MailchimpMarketing
584
584
  :return_type => 'Campaign')
585
585
  return data, status_code, headers
586
586
  end
587
- # Cancel a campaign
588
- # Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with [Mailchimp Pro](https://mailchimp.com/pro?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).
587
+ # Cancel campaign
588
+ # Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.
589
589
  # @param campaign_id The unique id for the campaign.
590
590
  # @param [Hash] opts the optional parameters
591
591
  # @return [nil]
@@ -594,8 +594,8 @@ module MailchimpMarketing
594
594
  nil
595
595
  end
596
596
 
597
- # Cancel a campaign
598
- # Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with [Mailchimp Pro](https://mailchimp.com/pro?utm_source&#x3D;mc-api&amp;utm_medium&#x3D;docs&amp;utm_campaign&#x3D;apidocs).
597
+ # Cancel campaign
598
+ # Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.
599
599
  # @param campaign_id The unique id for the campaign.
600
600
  # @param [Hash] opts the optional parameters
601
601
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -627,7 +627,7 @@ module MailchimpMarketing
627
627
  :auth_names => auth_names)
628
628
  return data, status_code, headers
629
629
  end
630
- # Resend a campaign
630
+ # Resend campaign
631
631
  # Creates a Resend to Non-Openers version of this campaign. We will also check if this campaign meets the criteria for Resend to Non-Openers campaigns.
632
632
  # @param campaign_id The unique id for the campaign.
633
633
  # @param [Hash] opts the optional parameters
@@ -637,7 +637,7 @@ module MailchimpMarketing
637
637
  data
638
638
  end
639
639
 
640
- # Resend a campaign
640
+ # Resend campaign
641
641
  # Creates a Resend to Non-Openers version of this campaign. We will also check if this campaign meets the criteria for Resend to Non-Openers campaigns.
642
642
  # @param campaign_id The unique id for the campaign.
643
643
  # @param [Hash] opts the optional parameters
@@ -671,8 +671,8 @@ module MailchimpMarketing
671
671
  :return_type => 'Campaign3')
672
672
  return data, status_code, headers
673
673
  end
674
- # Pause an RSS-Driven campaign
675
- # [Pause an RSS-Driven campaign](https://mailchimp.com/help/pause-or-reactivate-an-rss-campaign/).
674
+ # Pause rss campaign
675
+ # Pause an RSS-Driven campaign.
676
676
  # @param campaign_id The unique id for the campaign.
677
677
  # @param [Hash] opts the optional parameters
678
678
  # @return [nil]
@@ -681,8 +681,8 @@ module MailchimpMarketing
681
681
  nil
682
682
  end
683
683
 
684
- # Pause an RSS-Driven campaign
685
- # [Pause an RSS-Driven campaign](https://mailchimp.com/help/pause-or-reactivate-an-rss-campaign/).
684
+ # Pause rss campaign
685
+ # Pause an RSS-Driven campaign.
686
686
  # @param campaign_id The unique id for the campaign.
687
687
  # @param [Hash] opts the optional parameters
688
688
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -714,8 +714,8 @@ module MailchimpMarketing
714
714
  :auth_names => auth_names)
715
715
  return data, status_code, headers
716
716
  end
717
- # Replicate a campaign
718
- # [Replicate a campaign](https://mailchimp.com/help/replicate-a-campaign/) in saved or send status.
717
+ # Replicate campaign
718
+ # Replicate a campaign in saved or send status.
719
719
  # @param campaign_id The unique id for the campaign.
720
720
  # @param [Hash] opts the optional parameters
721
721
  # @return [Campaign3]
@@ -724,8 +724,8 @@ module MailchimpMarketing
724
724
  data
725
725
  end
726
726
 
727
- # Replicate a campaign
728
- # [Replicate a campaign](https://mailchimp.com/help/replicate-a-campaign/) in saved or send status.
727
+ # Replicate campaign
728
+ # Replicate a campaign in saved or send status.
729
729
  # @param campaign_id The unique id for the campaign.
730
730
  # @param [Hash] opts the optional parameters
731
731
  # @return [Array<(Campaign3, Fixnum, Hash)>] Campaign3 data, response status code and response headers
@@ -758,8 +758,8 @@ module MailchimpMarketing
758
758
  :return_type => 'Campaign3')
759
759
  return data, status_code, headers
760
760
  end
761
- # Resume an RSS-Driven campaign
762
- # [Resume an RSS-Driven campaign](https://mailchimp.com/help/pause-or-reactivate-an-rss-campaign/).
761
+ # Resume rss campaign
762
+ # Resume an RSS-Driven campaign.
763
763
  # @param campaign_id The unique id for the campaign.
764
764
  # @param [Hash] opts the optional parameters
765
765
  # @return [nil]
@@ -768,8 +768,8 @@ module MailchimpMarketing
768
768
  nil
769
769
  end
770
770
 
771
- # Resume an RSS-Driven campaign
772
- # [Resume an RSS-Driven campaign](https://mailchimp.com/help/pause-or-reactivate-an-rss-campaign/).
771
+ # Resume rss campaign
772
+ # Resume an RSS-Driven campaign.
773
773
  # @param campaign_id The unique id for the campaign.
774
774
  # @param [Hash] opts the optional parameters
775
775
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -801,8 +801,8 @@ module MailchimpMarketing
801
801
  :auth_names => auth_names)
802
802
  return data, status_code, headers
803
803
  end
804
- # Schedule a campaign
805
- # [Schedule a campaign](https://mailchimp.com/help/schedule-or-pause-a-regular-email-campaign/) for delivery. If you're using [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/) to test send times or sending [RSS Campaigns](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/), use the [send](/developer/reference/campaigns/#action-post_campaigns_campaign_id_actions_send) action instead.
804
+ # Schedule campaign
805
+ # Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.
806
806
  # @param campaign_id The unique id for the campaign.
807
807
  # @param body
808
808
  # @param [Hash] opts the optional parameters
@@ -812,8 +812,8 @@ module MailchimpMarketing
812
812
  nil
813
813
  end
814
814
 
815
- # Schedule a campaign
816
- # [Schedule a campaign](https://mailchimp.com/help/schedule-or-pause-a-regular-email-campaign/) for delivery. If you&#39;re using [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/) to test send times or sending [RSS Campaigns](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/), use the [send](/developer/reference/campaigns/#action-post_campaigns_campaign_id_actions_send) action instead.
815
+ # Schedule campaign
816
+ # Schedule a campaign for delivery. If you&#39;re using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.
817
817
  # @param campaign_id The unique id for the campaign.
818
818
  # @param body
819
819
  # @param [Hash] opts the optional parameters
@@ -846,8 +846,8 @@ module MailchimpMarketing
846
846
  :auth_names => auth_names)
847
847
  return data, status_code, headers
848
848
  end
849
- # Send a campaign
850
- # Send a Mailchimp campaign. For [RSS Campaigns](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/), the campaign will send according to its schedule. All other campaigns will send immediately.
849
+ # Send campaign
850
+ # Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.
851
851
  # @param campaign_id The unique id for the campaign.
852
852
  # @param [Hash] opts the optional parameters
853
853
  # @return [nil]
@@ -856,8 +856,8 @@ module MailchimpMarketing
856
856
  nil
857
857
  end
858
858
 
859
- # Send a campaign
860
- # Send a Mailchimp campaign. For [RSS Campaigns](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/), the campaign will send according to its schedule. All other campaigns will send immediately.
859
+ # Send campaign
860
+ # Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.
861
861
  # @param campaign_id The unique id for the campaign.
862
862
  # @param [Hash] opts the optional parameters
863
863
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -889,8 +889,8 @@ module MailchimpMarketing
889
889
  :auth_names => auth_names)
890
890
  return data, status_code, headers
891
891
  end
892
- # Send a test email
893
- # Send a [test email](https://mailchimp.com/help/preview-and-test-your-email-campaign/).
892
+ # Send test email
893
+ # Send a test email.
894
894
  # @param campaign_id The unique id for the campaign.
895
895
  # @param body
896
896
  # @param [Hash] opts the optional parameters
@@ -900,8 +900,8 @@ module MailchimpMarketing
900
900
  nil
901
901
  end
902
902
 
903
- # Send a test email
904
- # Send a [test email](https://mailchimp.com/help/preview-and-test-your-email-campaign/).
903
+ # Send test email
904
+ # Send a test email.
905
905
  # @param campaign_id The unique id for the campaign.
906
906
  # @param body
907
907
  # @param [Hash] opts the optional parameters
@@ -934,8 +934,8 @@ module MailchimpMarketing
934
934
  :auth_names => auth_names)
935
935
  return data, status_code, headers
936
936
  end
937
- # Unschedule a campaign
938
- # [Unschedule](https://mailchimp.com/help/schedule-or-pause-a-regular-email-campaign/) a scheduled campaign that hasn't started sending.
937
+ # Unschedule campaign
938
+ # Unschedule a scheduled campaign that hasn't started sending.
939
939
  # @param campaign_id The unique id for the campaign.
940
940
  # @param [Hash] opts the optional parameters
941
941
  # @return [nil]
@@ -944,8 +944,8 @@ module MailchimpMarketing
944
944
  nil
945
945
  end
946
946
 
947
- # Unschedule a campaign
948
- # [Unschedule](https://mailchimp.com/help/schedule-or-pause-a-regular-email-campaign/) a scheduled campaign that hasn&#39;t started sending.
947
+ # Unschedule campaign
948
+ # Unschedule a scheduled campaign that hasn&#39;t started sending.
949
949
  # @param campaign_id The unique id for the campaign.
950
950
  # @param [Hash] opts the optional parameters
951
951
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers