MailchimpMarketing 3.0.2 → 3.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/MailchimpMarketing.gemspec +1 -1
- data/README.md +41 -28
- data/lib/MailchimpMarketing.rb +5 -6
- data/lib/MailchimpMarketing/api/activity_feed_api.rb +7 -7
- data/lib/MailchimpMarketing/api/authorized_apps_api.rb +9 -9
- data/lib/MailchimpMarketing/api/automations_api.rb +47 -47
- data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +11 -11
- data/lib/MailchimpMarketing/api/batches_api.rb +9 -9
- data/lib/MailchimpMarketing/api/campaign_folders_api.rb +11 -11
- data/lib/MailchimpMarketing/api/campaigns_api.rb +57 -57
- data/lib/MailchimpMarketing/api/connected_sites_api.rb +11 -11
- data/lib/MailchimpMarketing/api/conversations_api.rb +11 -11
- data/lib/MailchimpMarketing/api/dashboard_api.rb +13 -13
- data/lib/MailchimpMarketing/api/ecommerce_api.rb +119 -119
- data/lib/MailchimpMarketing/api/external_auths_api.rb +7 -7
- data/lib/MailchimpMarketing/api/facebook_ads_api.rb +9 -9
- data/lib/MailchimpMarketing/api/file_manager_api.rb +25 -25
- data/lib/MailchimpMarketing/api/landing_pages_api.rb +13 -13
- data/lib/MailchimpMarketing/api/lists_api.rb +145 -145
- data/lib/MailchimpMarketing/api/ping_api.rb +3 -3
- data/lib/MailchimpMarketing/api/postcards_api.rb +3 -3
- data/lib/MailchimpMarketing/api/reporting_api.rb +25 -25
- data/lib/MailchimpMarketing/api/reports_api.rb +49 -49
- data/lib/MailchimpMarketing/api/root_api.rb +3 -3
- data/lib/MailchimpMarketing/api/search_campaigns_api.rb +3 -3
- data/lib/MailchimpMarketing/api/search_members_api.rb +3 -3
- data/lib/MailchimpMarketing/api/template_folders_api.rb +11 -11
- data/lib/MailchimpMarketing/api/templates_api.rb +15 -15
- data/lib/MailchimpMarketing/api/verified_domains_api.rb +11 -11
- data/lib/MailchimpMarketing/api_client.rb +35 -12
- data/lib/MailchimpMarketing/api_error.rb +1 -1
- data/lib/MailchimpMarketing/configuration.rb +1 -1
- data/lib/MailchimpMarketing/version.rb +2 -2
- 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.
|
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
|
-
# Get
|
22
|
+
# Get external authentication
|
23
23
|
# Get information about a specific partners External Authentication for a user.
|
24
24
|
# @param system_id The System name for external partner.
|
25
25
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module MailchimpMarketing
|
|
31
31
|
data
|
32
32
|
end
|
33
33
|
|
34
|
-
# Get
|
34
|
+
# Get external authentication
|
35
35
|
# Get information about a specific partners External Authentication for a user.
|
36
36
|
# @param system_id The System name for external partner.
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -69,7 +69,7 @@ module MailchimpMarketing
|
|
69
69
|
:return_type => 'ExternalAuthenticationsExternalAuths')
|
70
70
|
return data, status_code, headers
|
71
71
|
end
|
72
|
-
#
|
72
|
+
# List external authentications
|
73
73
|
# Get a collection of External Authentications
|
74
74
|
# @param [Hash] opts the optional parameters
|
75
75
|
# @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
|
|
82
82
|
data
|
83
83
|
end
|
84
84
|
|
85
|
-
#
|
85
|
+
# List external authentications
|
86
86
|
# Get a collection of External Authentications
|
87
87
|
# @param [Hash] opts the optional parameters
|
88
88
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -123,7 +123,7 @@ module MailchimpMarketing
|
|
123
123
|
:return_type => 'ExternalAuthentications')
|
124
124
|
return data, status_code, headers
|
125
125
|
end
|
126
|
-
#
|
126
|
+
# Add external authentication
|
127
127
|
# Create a new external auth if one does not exist.
|
128
128
|
# @param body
|
129
129
|
# @param [Hash] opts the optional parameters
|
@@ -133,7 +133,7 @@ module MailchimpMarketing
|
|
133
133
|
data
|
134
134
|
end
|
135
135
|
|
136
|
-
#
|
136
|
+
# Add external authentication
|
137
137
|
# Create a new external auth if one does not exist.
|
138
138
|
# @param body
|
139
139
|
# @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.
|
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,8 +19,8 @@ module MailchimpMarketing
|
|
19
19
|
def initialize(api_client)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
# Get list of Facebook
|
22
|
+
# List facebook ads
|
23
|
+
# Get list of Facebook ads.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
26
26
|
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
@@ -34,8 +34,8 @@ module MailchimpMarketing
|
|
34
34
|
data
|
35
35
|
end
|
36
36
|
|
37
|
-
#
|
38
|
-
# Get list of Facebook
|
37
|
+
# List facebook ads
|
38
|
+
# Get list of Facebook ads.
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
40
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
41
41
|
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
@@ -79,8 +79,8 @@ module MailchimpMarketing
|
|
79
79
|
:return_type => 'InlineResponse2009')
|
80
80
|
return data, status_code, headers
|
81
81
|
end
|
82
|
-
#
|
83
|
-
# Get details of a
|
82
|
+
# Get facebook ad info
|
83
|
+
# Get details of a Facebook ad.
|
84
84
|
# @param outreach_id The outreach id.
|
85
85
|
# @param [Hash] opts the optional parameters
|
86
86
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -91,8 +91,8 @@ module MailchimpMarketing
|
|
91
91
|
data
|
92
92
|
end
|
93
93
|
|
94
|
-
#
|
95
|
-
# Get details of a
|
94
|
+
# Get facebook ad info
|
95
|
+
# Get details of a Facebook ad.
|
96
96
|
# @param outreach_id The outreach id.
|
97
97
|
# @param [Hash] opts the optional parameters
|
98
98
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -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.
|
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
|
-
#
|
22
|
+
# Delete file
|
23
23
|
# Remove a specific file from the File Manager.
|
24
24
|
# @param file_id The unique id for the File Manager file.
|
25
25
|
# @param [Hash] opts the optional parameters
|
@@ -29,7 +29,7 @@ module MailchimpMarketing
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
32
|
+
# Delete file
|
33
33
|
# Remove a specific file from the File Manager.
|
34
34
|
# @param file_id The unique id for the File Manager file.
|
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
|
-
#
|
65
|
+
# Delete folder
|
66
66
|
# Delete a specific folder in the File Manager.
|
67
67
|
# @param folder_id The unique id for the File Manager folder.
|
68
68
|
# @param [Hash] opts the optional parameters
|
@@ -72,7 +72,7 @@ module MailchimpMarketing
|
|
72
72
|
nil
|
73
73
|
end
|
74
74
|
|
75
|
-
#
|
75
|
+
# Delete folder
|
76
76
|
# Delete a specific folder in the File Manager.
|
77
77
|
# @param folder_id The unique id for the File Manager folder.
|
78
78
|
# @param [Hash] opts the optional parameters
|
@@ -105,7 +105,7 @@ module MailchimpMarketing
|
|
105
105
|
:auth_names => auth_names)
|
106
106
|
return data, status_code, headers
|
107
107
|
end
|
108
|
-
#
|
108
|
+
# List file manager resources
|
109
109
|
# Get information about the file-manager endpoint's resources
|
110
110
|
# @param [Hash] opts the optional parameters
|
111
111
|
# @return [FileManager]
|
@@ -114,7 +114,7 @@ module MailchimpMarketing
|
|
114
114
|
data
|
115
115
|
end
|
116
116
|
|
117
|
-
#
|
117
|
+
# List file manager resources
|
118
118
|
# Get information about the file-manager endpoint's resources
|
119
119
|
# @param [Hash] opts the optional parameters
|
120
120
|
# @return [Array<(FileManager, Fixnum, Hash)>] FileManager data, response status code and response headers
|
@@ -147,7 +147,7 @@ module MailchimpMarketing
|
|
147
147
|
:return_type => 'FileManager')
|
148
148
|
return data, status_code, headers
|
149
149
|
end
|
150
|
-
#
|
150
|
+
# List stored files
|
151
151
|
# Get a list of available images and files stored in the File Manager for the account.
|
152
152
|
# @param [Hash] opts the optional parameters
|
153
153
|
# @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
|
data
|
167
167
|
end
|
168
168
|
|
169
|
-
#
|
169
|
+
# List stored files
|
170
170
|
# Get a list of available images and files stored in the File Manager for the account.
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -219,7 +219,7 @@ module MailchimpMarketing
|
|
219
219
|
:return_type => 'FileManager1')
|
220
220
|
return data, status_code, headers
|
221
221
|
end
|
222
|
-
# Get
|
222
|
+
# Get file
|
223
223
|
# Get information about a specific file in the File Manager.
|
224
224
|
# @param file_id The unique id for the File Manager file.
|
225
225
|
# @param [Hash] opts the optional parameters
|
@@ -231,7 +231,7 @@ module MailchimpMarketing
|
|
231
231
|
data
|
232
232
|
end
|
233
233
|
|
234
|
-
# Get
|
234
|
+
# Get file
|
235
235
|
# Get information about a specific file in the File Manager.
|
236
236
|
# @param file_id The unique id for the File Manager file.
|
237
237
|
# @param [Hash] opts the optional parameters
|
@@ -269,7 +269,7 @@ module MailchimpMarketing
|
|
269
269
|
:return_type => 'GalleryFile')
|
270
270
|
return data, status_code, headers
|
271
271
|
end
|
272
|
-
#
|
272
|
+
# List folders
|
273
273
|
# Get a list of all folders in the File Manager.
|
274
274
|
# @param [Hash] opts the optional parameters
|
275
275
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -285,7 +285,7 @@ module MailchimpMarketing
|
|
285
285
|
data
|
286
286
|
end
|
287
287
|
|
288
|
-
#
|
288
|
+
# List folders
|
289
289
|
# Get a list of all folders in the File Manager.
|
290
290
|
# @param [Hash] opts the optional parameters
|
291
291
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -332,7 +332,7 @@ module MailchimpMarketing
|
|
332
332
|
:return_type => 'FileManagerFolders')
|
333
333
|
return data, status_code, headers
|
334
334
|
end
|
335
|
-
# Get
|
335
|
+
# Get folder
|
336
336
|
# Get information about a specific folder in the File Manager.
|
337
337
|
# @param folder_id The unique id for the File Manager folder.
|
338
338
|
# @param [Hash] opts the optional parameters
|
@@ -344,7 +344,7 @@ module MailchimpMarketing
|
|
344
344
|
data
|
345
345
|
end
|
346
346
|
|
347
|
-
# Get
|
347
|
+
# Get folder
|
348
348
|
# Get information about a specific folder in the File Manager.
|
349
349
|
# @param folder_id The unique id for the File Manager folder.
|
350
350
|
# @param [Hash] opts the optional parameters
|
@@ -382,7 +382,7 @@ module MailchimpMarketing
|
|
382
382
|
:return_type => 'GalleryFolder')
|
383
383
|
return data, status_code, headers
|
384
384
|
end
|
385
|
-
# Update
|
385
|
+
# Update file
|
386
386
|
# Update a file in the File Manager.
|
387
387
|
# @param file_id The unique id for the File Manager file.
|
388
388
|
# @param body
|
@@ -393,7 +393,7 @@ module MailchimpMarketing
|
|
393
393
|
data
|
394
394
|
end
|
395
395
|
|
396
|
-
# Update
|
396
|
+
# Update file
|
397
397
|
# Update a file in the File Manager.
|
398
398
|
# @param file_id The unique id for the File Manager file.
|
399
399
|
# @param body
|
@@ -428,7 +428,7 @@ module MailchimpMarketing
|
|
428
428
|
:return_type => 'GalleryFile')
|
429
429
|
return data, status_code, headers
|
430
430
|
end
|
431
|
-
# Update
|
431
|
+
# Update folder
|
432
432
|
# Update a specific File Manager folder.
|
433
433
|
# @param folder_id The unique id for the File Manager folder.
|
434
434
|
# @param body
|
@@ -439,7 +439,7 @@ module MailchimpMarketing
|
|
439
439
|
data
|
440
440
|
end
|
441
441
|
|
442
|
-
# Update
|
442
|
+
# Update folder
|
443
443
|
# Update a specific File Manager folder.
|
444
444
|
# @param folder_id The unique id for the File Manager folder.
|
445
445
|
# @param body
|
@@ -474,8 +474,8 @@ module MailchimpMarketing
|
|
474
474
|
:return_type => 'GalleryFolder')
|
475
475
|
return data, status_code, headers
|
476
476
|
end
|
477
|
-
#
|
478
|
-
#
|
477
|
+
# Add file
|
478
|
+
# Upload a new image or file to the File Manager.
|
479
479
|
# @param body
|
480
480
|
# @param [Hash] opts the optional parameters
|
481
481
|
# @return [GalleryFile]
|
@@ -484,8 +484,8 @@ module MailchimpMarketing
|
|
484
484
|
data
|
485
485
|
end
|
486
486
|
|
487
|
-
#
|
488
|
-
#
|
487
|
+
# Add file
|
488
|
+
# Upload a new image or file to the File Manager.
|
489
489
|
# @param body
|
490
490
|
# @param [Hash] opts the optional parameters
|
491
491
|
# @return [Array<(GalleryFile, Fixnum, Hash)>] GalleryFile data, response status code and response headers
|
@@ -518,7 +518,7 @@ module MailchimpMarketing
|
|
518
518
|
:return_type => 'GalleryFile')
|
519
519
|
return data, status_code, headers
|
520
520
|
end
|
521
|
-
#
|
521
|
+
# Add folder
|
522
522
|
# Create a new folder in the File Manager.
|
523
523
|
# @param body
|
524
524
|
# @param [Hash] opts the optional parameters
|
@@ -528,7 +528,7 @@ module MailchimpMarketing
|
|
528
528
|
data
|
529
529
|
end
|
530
530
|
|
531
|
-
#
|
531
|
+
# Add folder
|
532
532
|
# Create a new folder in the File Manager.
|
533
533
|
# @param body
|
534
534
|
# @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.
|
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
|
22
|
+
# Delete landing page
|
23
23
|
# Delete a landing page.
|
24
24
|
# @param page_id The unique id for the page.
|
25
25
|
# @param [Hash] opts the optional parameters
|
@@ -29,7 +29,7 @@ module MailchimpMarketing
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
# Delete
|
32
|
+
# Delete landing page
|
33
33
|
# Delete a landing page.
|
34
34
|
# @param page_id The unique id for the page.
|
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
|
-
#
|
65
|
+
# List landing pages
|
66
66
|
# Get all landing pages.
|
67
67
|
# @param [Hash] opts the optional parameters
|
68
68
|
# @option opts [String] :sort_dir Determines the order direction for sorted results.
|
@@ -76,7 +76,7 @@ module MailchimpMarketing
|
|
76
76
|
data
|
77
77
|
end
|
78
78
|
|
79
|
-
#
|
79
|
+
# List landing pages
|
80
80
|
# Get all landing pages.
|
81
81
|
# @param [Hash] opts the optional parameters
|
82
82
|
# @option opts [String] :sort_dir Determines the order direction for sorted results.
|
@@ -119,7 +119,7 @@ module MailchimpMarketing
|
|
119
119
|
:return_type => 'InlineResponse2006')
|
120
120
|
return data, status_code, headers
|
121
121
|
end
|
122
|
-
# Get
|
122
|
+
# Get landing page info
|
123
123
|
# Get information about a specific page.
|
124
124
|
# @param page_id The unique id for the page.
|
125
125
|
# @param [Hash] opts the optional parameters
|
@@ -131,7 +131,7 @@ module MailchimpMarketing
|
|
131
131
|
data
|
132
132
|
end
|
133
133
|
|
134
|
-
# Get
|
134
|
+
# Get landing page info
|
135
135
|
# Get information about a specific page.
|
136
136
|
# @param page_id The unique id for the page.
|
137
137
|
# @param [Hash] opts the optional parameters
|
@@ -265,7 +265,7 @@ module MailchimpMarketing
|
|
265
265
|
:return_type => 'LandingPage')
|
266
266
|
return data, status_code, headers
|
267
267
|
end
|
268
|
-
#
|
268
|
+
# Add landing page
|
269
269
|
# Create a new Mailchimp landing page.
|
270
270
|
# @param body
|
271
271
|
# @param [Hash] opts the optional parameters
|
@@ -275,7 +275,7 @@ module MailchimpMarketing
|
|
275
275
|
data
|
276
276
|
end
|
277
277
|
|
278
|
-
#
|
278
|
+
# Add landing page
|
279
279
|
# Create a new Mailchimp landing page.
|
280
280
|
# @param body
|
281
281
|
# @param [Hash] opts the optional parameters
|
@@ -309,7 +309,7 @@ module MailchimpMarketing
|
|
309
309
|
:return_type => 'LandingPage')
|
310
310
|
return data, status_code, headers
|
311
311
|
end
|
312
|
-
# Publish
|
312
|
+
# Publish landing page
|
313
313
|
# Publish a landing page that is in draft, unpublished, or has been previously published and edited.
|
314
314
|
# @param page_id The unique id for the page.
|
315
315
|
# @param [Hash] opts the optional parameters
|
@@ -319,7 +319,7 @@ module MailchimpMarketing
|
|
319
319
|
nil
|
320
320
|
end
|
321
321
|
|
322
|
-
# Publish
|
322
|
+
# Publish landing page
|
323
323
|
# Publish a landing page that is in draft, unpublished, or has been previously published and edited.
|
324
324
|
# @param page_id The unique id for the page.
|
325
325
|
# @param [Hash] opts the optional parameters
|
@@ -352,7 +352,7 @@ module MailchimpMarketing
|
|
352
352
|
:auth_names => auth_names)
|
353
353
|
return data, status_code, headers
|
354
354
|
end
|
355
|
-
# Unpublish
|
355
|
+
# Unpublish landing page
|
356
356
|
# Unpublish a landing page that is in draft or has been published.
|
357
357
|
# @param page_id The unique id for the page.
|
358
358
|
# @param [Hash] opts the optional parameters
|
@@ -362,7 +362,7 @@ module MailchimpMarketing
|
|
362
362
|
nil
|
363
363
|
end
|
364
364
|
|
365
|
-
# Unpublish
|
365
|
+
# Unpublish landing page
|
366
366
|
# Unpublish a landing page that is in draft or has been published.
|
367
367
|
# @param page_id The unique id for the page.
|
368
368
|
# @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.
|
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,8 +19,8 @@ module MailchimpMarketing
|
|
19
19
|
def initialize(api_client)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Delete
|
23
|
-
# Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you
|
22
|
+
# Delete list
|
23
|
+
# Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.
|
24
24
|
# @param list_id The unique ID for the list.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
@@ -29,8 +29,8 @@ module MailchimpMarketing
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
# Delete
|
33
|
-
# Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you
|
32
|
+
# Delete list
|
33
|
+
# Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.
|
34
34
|
# @param list_id The unique ID for the list.
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -62,7 +62,7 @@ module MailchimpMarketing
|
|
62
62
|
:auth_names => auth_names)
|
63
63
|
return data, status_code, headers
|
64
64
|
end
|
65
|
-
# Delete
|
65
|
+
# Delete interest category
|
66
66
|
# Delete a specific interest category.
|
67
67
|
# @param list_id The unique ID for the list.
|
68
68
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -73,7 +73,7 @@ module MailchimpMarketing
|
|
73
73
|
nil
|
74
74
|
end
|
75
75
|
|
76
|
-
# Delete
|
76
|
+
# Delete interest category
|
77
77
|
# Delete a specific interest category.
|
78
78
|
# @param list_id The unique ID for the list.
|
79
79
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -107,7 +107,7 @@ module MailchimpMarketing
|
|
107
107
|
:auth_names => auth_names)
|
108
108
|
return data, status_code, headers
|
109
109
|
end
|
110
|
-
# Delete
|
110
|
+
# Delete interest in category
|
111
111
|
# Delete interests or group names in a specific category.
|
112
112
|
# @param list_id The unique ID for the list.
|
113
113
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -119,7 +119,7 @@ module MailchimpMarketing
|
|
119
119
|
nil
|
120
120
|
end
|
121
121
|
|
122
|
-
# Delete
|
122
|
+
# Delete interest in category
|
123
123
|
# Delete interests or group names in a specific category.
|
124
124
|
# @param list_id The unique ID for the list.
|
125
125
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -154,8 +154,8 @@ module MailchimpMarketing
|
|
154
154
|
:auth_names => auth_names)
|
155
155
|
return data, status_code, headers
|
156
156
|
end
|
157
|
-
# Archive
|
158
|
-
#
|
157
|
+
# Archive list member
|
158
|
+
# Archive a list member. To permanently delete, use the delete-permanent action.
|
159
159
|
# @param list_id The unique ID for the list.
|
160
160
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
161
161
|
# @param [Hash] opts the optional parameters
|
@@ -165,8 +165,8 @@ module MailchimpMarketing
|
|
165
165
|
nil
|
166
166
|
end
|
167
167
|
|
168
|
-
# Archive
|
169
|
-
#
|
168
|
+
# Archive list member
|
169
|
+
# Archive a list member. To permanently delete, use the delete-permanent action.
|
170
170
|
# @param list_id The unique ID for the list.
|
171
171
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
172
172
|
# @param [Hash] opts the optional parameters
|
@@ -199,7 +199,7 @@ module MailchimpMarketing
|
|
199
199
|
:auth_names => auth_names)
|
200
200
|
return data, status_code, headers
|
201
201
|
end
|
202
|
-
# Delete
|
202
|
+
# Delete note
|
203
203
|
# Delete a specific note for a specific list member.
|
204
204
|
# @param list_id The unique ID for the list.
|
205
205
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -211,7 +211,7 @@ module MailchimpMarketing
|
|
211
211
|
nil
|
212
212
|
end
|
213
213
|
|
214
|
-
# Delete
|
214
|
+
# Delete note
|
215
215
|
# Delete a specific note for a specific list member.
|
216
216
|
# @param list_id The unique ID for the list.
|
217
217
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -246,7 +246,7 @@ module MailchimpMarketing
|
|
246
246
|
:auth_names => auth_names)
|
247
247
|
return data, status_code, headers
|
248
248
|
end
|
249
|
-
# Delete
|
249
|
+
# Delete merge field
|
250
250
|
# Delete a specific merge field in a list.
|
251
251
|
# @param list_id The unique ID for the list.
|
252
252
|
# @param merge_id The id for the merge field.
|
@@ -257,7 +257,7 @@ module MailchimpMarketing
|
|
257
257
|
nil
|
258
258
|
end
|
259
259
|
|
260
|
-
# Delete
|
260
|
+
# Delete merge field
|
261
261
|
# Delete a specific merge field in a list.
|
262
262
|
# @param list_id The unique ID for the list.
|
263
263
|
# @param merge_id The id for the merge field.
|
@@ -291,7 +291,7 @@ module MailchimpMarketing
|
|
291
291
|
:auth_names => auth_names)
|
292
292
|
return data, status_code, headers
|
293
293
|
end
|
294
|
-
# Delete
|
294
|
+
# Delete segment
|
295
295
|
# Delete a specific segment in a list.
|
296
296
|
# @param list_id The unique ID for the list.
|
297
297
|
# @param segment_id The unique id for the segment.
|
@@ -302,7 +302,7 @@ module MailchimpMarketing
|
|
302
302
|
nil
|
303
303
|
end
|
304
304
|
|
305
|
-
# Delete
|
305
|
+
# Delete segment
|
306
306
|
# Delete a specific segment in a list.
|
307
307
|
# @param list_id The unique ID for the list.
|
308
308
|
# @param segment_id The unique id for the segment.
|
@@ -336,7 +336,7 @@ module MailchimpMarketing
|
|
336
336
|
:auth_names => auth_names)
|
337
337
|
return data, status_code, headers
|
338
338
|
end
|
339
|
-
# Remove
|
339
|
+
# Remove list member from segment
|
340
340
|
# Remove a member from the specified static segment.
|
341
341
|
# @param list_id The unique ID for the list.
|
342
342
|
# @param segment_id The unique id for the segment.
|
@@ -348,7 +348,7 @@ module MailchimpMarketing
|
|
348
348
|
nil
|
349
349
|
end
|
350
350
|
|
351
|
-
# Remove
|
351
|
+
# Remove list member from segment
|
352
352
|
# Remove a member from the specified static segment.
|
353
353
|
# @param list_id The unique ID for the list.
|
354
354
|
# @param segment_id The unique id for the segment.
|
@@ -383,7 +383,7 @@ module MailchimpMarketing
|
|
383
383
|
:auth_names => auth_names)
|
384
384
|
return data, status_code, headers
|
385
385
|
end
|
386
|
-
# Delete
|
386
|
+
# Delete webhook
|
387
387
|
# Delete a specific webhook in a list.
|
388
388
|
# @param list_id The unique ID for the list.
|
389
389
|
# @param webhook_id The webhook's id.
|
@@ -394,7 +394,7 @@ module MailchimpMarketing
|
|
394
394
|
nil
|
395
395
|
end
|
396
396
|
|
397
|
-
# Delete
|
397
|
+
# Delete webhook
|
398
398
|
# Delete a specific webhook in a list.
|
399
399
|
# @param list_id The unique ID for the list.
|
400
400
|
# @param webhook_id The webhook's id.
|
@@ -428,7 +428,7 @@ module MailchimpMarketing
|
|
428
428
|
:auth_names => auth_names)
|
429
429
|
return data, status_code, headers
|
430
430
|
end
|
431
|
-
#
|
431
|
+
# List member tags
|
432
432
|
# Get the tags on a list member.
|
433
433
|
# @param list_id The unique ID for the list.
|
434
434
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -443,7 +443,7 @@ module MailchimpMarketing
|
|
443
443
|
data
|
444
444
|
end
|
445
445
|
|
446
|
-
#
|
446
|
+
# List member tags
|
447
447
|
# Get the tags on a list member.
|
448
448
|
# @param list_id The unique ID for the list.
|
449
449
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -486,7 +486,7 @@ module MailchimpMarketing
|
|
486
486
|
:return_type => 'CollectionOfTags')
|
487
487
|
return data, status_code, headers
|
488
488
|
end
|
489
|
-
# Get
|
489
|
+
# Get lists info
|
490
490
|
# Get information about all lists in the account.
|
491
491
|
# @param [Hash] opts the optional parameters
|
492
492
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -506,7 +506,7 @@ module MailchimpMarketing
|
|
506
506
|
data
|
507
507
|
end
|
508
508
|
|
509
|
-
# Get
|
509
|
+
# Get lists info
|
510
510
|
# Get information about all lists in the account.
|
511
511
|
# @param [Hash] opts the optional parameters
|
512
512
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -561,8 +561,8 @@ module MailchimpMarketing
|
|
561
561
|
:return_type => 'SubscriberLists')
|
562
562
|
return data, status_code, headers
|
563
563
|
end
|
564
|
-
# Get
|
565
|
-
# Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and
|
564
|
+
# Get list info
|
565
|
+
# Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.
|
566
566
|
# @param list_id The unique ID for the list.
|
567
567
|
# @param [Hash] opts the optional parameters
|
568
568
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -573,8 +573,8 @@ module MailchimpMarketing
|
|
573
573
|
data
|
574
574
|
end
|
575
575
|
|
576
|
-
# Get
|
577
|
-
# Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and
|
576
|
+
# Get list info
|
577
|
+
# Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.
|
578
578
|
# @param list_id The unique ID for the list.
|
579
579
|
# @param [Hash] opts the optional parameters
|
580
580
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -611,7 +611,7 @@ module MailchimpMarketing
|
|
611
611
|
:return_type => 'SubscriberList')
|
612
612
|
return data, status_code, headers
|
613
613
|
end
|
614
|
-
#
|
614
|
+
# List abuse reports
|
615
615
|
# Get all abuse reports for a specific list.
|
616
616
|
# @param list_id The unique ID for the list.
|
617
617
|
# @param [Hash] opts the optional parameters
|
@@ -625,7 +625,7 @@ module MailchimpMarketing
|
|
625
625
|
data
|
626
626
|
end
|
627
627
|
|
628
|
-
#
|
628
|
+
# List abuse reports
|
629
629
|
# Get all abuse reports for a specific list.
|
630
630
|
# @param list_id The unique ID for the list.
|
631
631
|
# @param [Hash] opts the optional parameters
|
@@ -667,7 +667,7 @@ module MailchimpMarketing
|
|
667
667
|
:return_type => 'AbuseComplaints')
|
668
668
|
return data, status_code, headers
|
669
669
|
end
|
670
|
-
# Get
|
670
|
+
# Get abuse report
|
671
671
|
# Get details about a specific abuse report.
|
672
672
|
# @param list_id The unique ID for the list.
|
673
673
|
# @param report_id The id for the abuse report.
|
@@ -682,7 +682,7 @@ module MailchimpMarketing
|
|
682
682
|
data
|
683
683
|
end
|
684
684
|
|
685
|
-
# Get
|
685
|
+
# Get abuse report
|
686
686
|
# Get details about a specific abuse report.
|
687
687
|
# @param list_id The unique ID for the list.
|
688
688
|
# @param report_id The id for the abuse report.
|
@@ -725,7 +725,7 @@ module MailchimpMarketing
|
|
725
725
|
:return_type => 'AbuseComplaint')
|
726
726
|
return data, status_code, headers
|
727
727
|
end
|
728
|
-
#
|
728
|
+
# List recent activity
|
729
729
|
# Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.
|
730
730
|
# @param list_id The unique ID for the list.
|
731
731
|
# @param [Hash] opts the optional parameters
|
@@ -737,7 +737,7 @@ module MailchimpMarketing
|
|
737
737
|
data
|
738
738
|
end
|
739
739
|
|
740
|
-
#
|
740
|
+
# List recent activity
|
741
741
|
# Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.
|
742
742
|
# @param list_id The unique ID for the list.
|
743
743
|
# @param [Hash] opts the optional parameters
|
@@ -775,7 +775,7 @@ module MailchimpMarketing
|
|
775
775
|
:return_type => 'ListActivity')
|
776
776
|
return data, status_code, headers
|
777
777
|
end
|
778
|
-
#
|
778
|
+
# List top email clients
|
779
779
|
# Get a list of the top email clients based on user-agent strings.
|
780
780
|
# @param list_id The unique ID for the list.
|
781
781
|
# @param [Hash] opts the optional parameters
|
@@ -787,7 +787,7 @@ module MailchimpMarketing
|
|
787
787
|
data
|
788
788
|
end
|
789
789
|
|
790
|
-
#
|
790
|
+
# List top email clients
|
791
791
|
# Get a list of the top email clients based on user-agent strings.
|
792
792
|
# @param list_id The unique ID for the list.
|
793
793
|
# @param [Hash] opts the optional parameters
|
@@ -825,8 +825,8 @@ module MailchimpMarketing
|
|
825
825
|
:return_type => 'EmailClients')
|
826
826
|
return data, status_code, headers
|
827
827
|
end
|
828
|
-
#
|
829
|
-
# Get external identifiers created for a Mailchimp list
|
828
|
+
# List external i ds
|
829
|
+
# Get external identifiers created for a Mailchimp list.
|
830
830
|
# @param list_id The unique ID for the list.
|
831
831
|
# @param [Hash] opts the optional parameters
|
832
832
|
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
|
@@ -837,8 +837,8 @@ module MailchimpMarketing
|
|
837
837
|
data
|
838
838
|
end
|
839
839
|
|
840
|
-
#
|
841
|
-
# Get external identifiers created for a Mailchimp list
|
840
|
+
# List external i ds
|
841
|
+
# Get external identifiers created for a Mailchimp list.
|
842
842
|
# @param list_id The unique ID for the list.
|
843
843
|
# @param [Hash] opts the optional parameters
|
844
844
|
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
|
@@ -875,7 +875,7 @@ module MailchimpMarketing
|
|
875
875
|
:return_type => 'CollectionOfExternalIdentifiers')
|
876
876
|
return data, status_code, headers
|
877
877
|
end
|
878
|
-
#
|
878
|
+
# List growth history data
|
879
879
|
# Get a month-by-month summary of a specific list's growth activity.
|
880
880
|
# @param list_id The unique ID for the list.
|
881
881
|
# @param [Hash] opts the optional parameters
|
@@ -891,7 +891,7 @@ module MailchimpMarketing
|
|
891
891
|
data
|
892
892
|
end
|
893
893
|
|
894
|
-
#
|
894
|
+
# List growth history data
|
895
895
|
# Get a month-by-month summary of a specific list's growth activity.
|
896
896
|
# @param list_id The unique ID for the list.
|
897
897
|
# @param [Hash] opts the optional parameters
|
@@ -937,7 +937,7 @@ module MailchimpMarketing
|
|
937
937
|
:return_type => 'GrowthHistory')
|
938
938
|
return data, status_code, headers
|
939
939
|
end
|
940
|
-
# Get
|
940
|
+
# Get growth history by month
|
941
941
|
# Get a summary of a specific list's growth activity for a specific month and year.
|
942
942
|
# @param list_id The unique ID for the list.
|
943
943
|
# @param month A specific month of list growth history.
|
@@ -950,7 +950,7 @@ module MailchimpMarketing
|
|
950
950
|
data
|
951
951
|
end
|
952
952
|
|
953
|
-
# Get
|
953
|
+
# Get growth history by month
|
954
954
|
# Get a summary of a specific list's growth activity for a specific month and year.
|
955
955
|
# @param list_id The unique ID for the list.
|
956
956
|
# @param month A specific month of list growth history.
|
@@ -989,7 +989,7 @@ module MailchimpMarketing
|
|
989
989
|
:return_type => 'GrowthHistory')
|
990
990
|
return data, status_code, headers
|
991
991
|
end
|
992
|
-
#
|
992
|
+
# List interest categories
|
993
993
|
# Get information about a list's interest categories.
|
994
994
|
# @param list_id The unique ID for the list.
|
995
995
|
# @param [Hash] opts the optional parameters
|
@@ -1004,7 +1004,7 @@ module MailchimpMarketing
|
|
1004
1004
|
data
|
1005
1005
|
end
|
1006
1006
|
|
1007
|
-
#
|
1007
|
+
# List interest categories
|
1008
1008
|
# Get information about a list's interest categories.
|
1009
1009
|
# @param list_id The unique ID for the list.
|
1010
1010
|
# @param [Hash] opts the optional parameters
|
@@ -1048,7 +1048,7 @@ module MailchimpMarketing
|
|
1048
1048
|
:return_type => 'InterestGroupings')
|
1049
1049
|
return data, status_code, headers
|
1050
1050
|
end
|
1051
|
-
# Get
|
1051
|
+
# Get interest category info
|
1052
1052
|
# Get information about a specific interest category.
|
1053
1053
|
# @param list_id The unique ID for the list.
|
1054
1054
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1061,7 +1061,7 @@ module MailchimpMarketing
|
|
1061
1061
|
data
|
1062
1062
|
end
|
1063
1063
|
|
1064
|
-
# Get
|
1064
|
+
# Get interest category info
|
1065
1065
|
# Get information about a specific interest category.
|
1066
1066
|
# @param list_id The unique ID for the list.
|
1067
1067
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1100,7 +1100,7 @@ module MailchimpMarketing
|
|
1100
1100
|
:return_type => 'InterestCategory')
|
1101
1101
|
return data, status_code, headers
|
1102
1102
|
end
|
1103
|
-
#
|
1103
|
+
# List interests in category
|
1104
1104
|
# Get a list of this category's interests.
|
1105
1105
|
# @param list_id The unique ID for the list.
|
1106
1106
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1115,7 +1115,7 @@ module MailchimpMarketing
|
|
1115
1115
|
data
|
1116
1116
|
end
|
1117
1117
|
|
1118
|
-
#
|
1118
|
+
# List interests in category
|
1119
1119
|
# Get a list of this category's interests.
|
1120
1120
|
# @param list_id The unique ID for the list.
|
1121
1121
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1158,7 +1158,7 @@ module MailchimpMarketing
|
|
1158
1158
|
:return_type => 'Interests')
|
1159
1159
|
return data, status_code, headers
|
1160
1160
|
end
|
1161
|
-
# Get
|
1161
|
+
# Get interest in category
|
1162
1162
|
# Get interests or 'group names' for a specific category.
|
1163
1163
|
# @param list_id The unique ID for the list.
|
1164
1164
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1172,7 +1172,7 @@ module MailchimpMarketing
|
|
1172
1172
|
data
|
1173
1173
|
end
|
1174
1174
|
|
1175
|
-
# Get
|
1175
|
+
# Get interest in category
|
1176
1176
|
# Get interests or 'group names' for a specific category.
|
1177
1177
|
# @param list_id The unique ID for the list.
|
1178
1178
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -1212,7 +1212,7 @@ module MailchimpMarketing
|
|
1212
1212
|
:return_type => 'Interest')
|
1213
1213
|
return data, status_code, headers
|
1214
1214
|
end
|
1215
|
-
#
|
1215
|
+
# List locations
|
1216
1216
|
# Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
|
1217
1217
|
# @param list_id The unique ID for the list.
|
1218
1218
|
# @param [Hash] opts the optional parameters
|
@@ -1224,7 +1224,7 @@ module MailchimpMarketing
|
|
1224
1224
|
data
|
1225
1225
|
end
|
1226
1226
|
|
1227
|
-
#
|
1227
|
+
# List locations
|
1228
1228
|
# Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
|
1229
1229
|
# @param list_id The unique ID for the list.
|
1230
1230
|
# @param [Hash] opts the optional parameters
|
@@ -1262,7 +1262,7 @@ module MailchimpMarketing
|
|
1262
1262
|
:return_type => 'ListLocations')
|
1263
1263
|
return data, status_code, headers
|
1264
1264
|
end
|
1265
|
-
#
|
1265
|
+
# List members info
|
1266
1266
|
# Get information about members in a specific Mailchimp list.
|
1267
1267
|
# @param list_id The unique ID for the list.
|
1268
1268
|
# @param [Hash] opts the optional parameters
|
@@ -1291,7 +1291,7 @@ module MailchimpMarketing
|
|
1291
1291
|
data
|
1292
1292
|
end
|
1293
1293
|
|
1294
|
-
#
|
1294
|
+
# List members info
|
1295
1295
|
# Get information about members in a specific Mailchimp list.
|
1296
1296
|
# @param list_id The unique ID for the list.
|
1297
1297
|
# @param [Hash] opts the optional parameters
|
@@ -1363,7 +1363,7 @@ module MailchimpMarketing
|
|
1363
1363
|
:return_type => 'ListMembers2')
|
1364
1364
|
return data, status_code, headers
|
1365
1365
|
end
|
1366
|
-
# Get
|
1366
|
+
# Get member info
|
1367
1367
|
# Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.
|
1368
1368
|
# @param list_id The unique ID for the list.
|
1369
1369
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1376,7 +1376,7 @@ module MailchimpMarketing
|
|
1376
1376
|
data
|
1377
1377
|
end
|
1378
1378
|
|
1379
|
-
# Get
|
1379
|
+
# Get member info
|
1380
1380
|
# Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.
|
1381
1381
|
# @param list_id The unique ID for the list.
|
1382
1382
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1415,7 +1415,7 @@ module MailchimpMarketing
|
|
1415
1415
|
:return_type => 'ListMembers2')
|
1416
1416
|
return data, status_code, headers
|
1417
1417
|
end
|
1418
|
-
#
|
1418
|
+
# View recent activity 50
|
1419
1419
|
# Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
|
1420
1420
|
# @param list_id The unique ID for the list.
|
1421
1421
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1429,7 +1429,7 @@ module MailchimpMarketing
|
|
1429
1429
|
data
|
1430
1430
|
end
|
1431
1431
|
|
1432
|
-
#
|
1432
|
+
# View recent activity 50
|
1433
1433
|
# Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
|
1434
1434
|
# @param list_id The unique ID for the list.
|
1435
1435
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1470,7 +1470,7 @@ module MailchimpMarketing
|
|
1470
1470
|
:return_type => 'MemberActivityEvents')
|
1471
1471
|
return data, status_code, headers
|
1472
1472
|
end
|
1473
|
-
#
|
1473
|
+
# View recent activity 10
|
1474
1474
|
# Get the last 10 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
|
1475
1475
|
# @param list_id The unique ID for the list.
|
1476
1476
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1486,7 +1486,7 @@ module MailchimpMarketing
|
|
1486
1486
|
data
|
1487
1487
|
end
|
1488
1488
|
|
1489
|
-
#
|
1489
|
+
# View recent activity 10
|
1490
1490
|
# Get the last 10 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
|
1491
1491
|
# @param list_id The unique ID for the list.
|
1492
1492
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1531,7 +1531,7 @@ module MailchimpMarketing
|
|
1531
1531
|
:return_type => 'MemberActivityEvents1')
|
1532
1532
|
return data, status_code, headers
|
1533
1533
|
end
|
1534
|
-
#
|
1534
|
+
# List member events
|
1535
1535
|
# Get events for a contact.
|
1536
1536
|
# @param list_id The unique ID for the list.
|
1537
1537
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
|
@@ -1546,7 +1546,7 @@ module MailchimpMarketing
|
|
1546
1546
|
data
|
1547
1547
|
end
|
1548
1548
|
|
1549
|
-
#
|
1549
|
+
# List member events
|
1550
1550
|
# Get events for a contact.
|
1551
1551
|
# @param list_id The unique ID for the list.
|
1552
1552
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
|
@@ -1589,7 +1589,7 @@ module MailchimpMarketing
|
|
1589
1589
|
:return_type => 'CollectionOfEvents')
|
1590
1590
|
return data, status_code, headers
|
1591
1591
|
end
|
1592
|
-
#
|
1592
|
+
# List member goal events
|
1593
1593
|
# Get the last 50 Goal events for a member on a specific list.
|
1594
1594
|
# @param list_id The unique ID for the list.
|
1595
1595
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1602,7 +1602,7 @@ module MailchimpMarketing
|
|
1602
1602
|
data
|
1603
1603
|
end
|
1604
1604
|
|
1605
|
-
#
|
1605
|
+
# List member goal events
|
1606
1606
|
# Get the last 50 Goal events for a member on a specific list.
|
1607
1607
|
# @param list_id The unique ID for the list.
|
1608
1608
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1641,7 +1641,7 @@ module MailchimpMarketing
|
|
1641
1641
|
:return_type => 'CollectionOfMemberActivityEvents')
|
1642
1642
|
return data, status_code, headers
|
1643
1643
|
end
|
1644
|
-
#
|
1644
|
+
# List recent member notes
|
1645
1645
|
# Get recent notes for a specific list member.
|
1646
1646
|
# @param list_id The unique ID for the list.
|
1647
1647
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1658,7 +1658,7 @@ module MailchimpMarketing
|
|
1658
1658
|
data
|
1659
1659
|
end
|
1660
1660
|
|
1661
|
-
#
|
1661
|
+
# List recent member notes
|
1662
1662
|
# Get recent notes for a specific list member.
|
1663
1663
|
# @param list_id The unique ID for the list.
|
1664
1664
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1705,7 +1705,7 @@ module MailchimpMarketing
|
|
1705
1705
|
:return_type => 'CollectionOfNotes')
|
1706
1706
|
return data, status_code, headers
|
1707
1707
|
end
|
1708
|
-
# Get
|
1708
|
+
# Get member note
|
1709
1709
|
# Get a specific note for a specific list member.
|
1710
1710
|
# @param list_id The unique ID for the list.
|
1711
1711
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1719,7 +1719,7 @@ module MailchimpMarketing
|
|
1719
1719
|
data
|
1720
1720
|
end
|
1721
1721
|
|
1722
|
-
# Get
|
1722
|
+
# Get member note
|
1723
1723
|
# Get a specific note for a specific list member.
|
1724
1724
|
# @param list_id The unique ID for the list.
|
1725
1725
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -1759,7 +1759,7 @@ module MailchimpMarketing
|
|
1759
1759
|
:return_type => 'MemberNotes')
|
1760
1760
|
return data, status_code, headers
|
1761
1761
|
end
|
1762
|
-
#
|
1762
|
+
# List merge fields
|
1763
1763
|
# Get a list of all merge fields (formerly merge vars) for a list.
|
1764
1764
|
# @param list_id The unique ID for the list.
|
1765
1765
|
# @param [Hash] opts the optional parameters
|
@@ -1775,7 +1775,7 @@ module MailchimpMarketing
|
|
1775
1775
|
data
|
1776
1776
|
end
|
1777
1777
|
|
1778
|
-
#
|
1778
|
+
# List merge fields
|
1779
1779
|
# Get a list of all merge fields (formerly merge vars) for a list.
|
1780
1780
|
# @param list_id The unique ID for the list.
|
1781
1781
|
# @param [Hash] opts the optional parameters
|
@@ -1821,7 +1821,7 @@ module MailchimpMarketing
|
|
1821
1821
|
:return_type => 'CollectionOfMergeFields')
|
1822
1822
|
return data, status_code, headers
|
1823
1823
|
end
|
1824
|
-
# Get
|
1824
|
+
# Get merge field
|
1825
1825
|
# Get information about a specific merge field in a list.
|
1826
1826
|
# @param list_id The unique ID for the list.
|
1827
1827
|
# @param merge_id The id for the merge field.
|
@@ -1834,7 +1834,7 @@ module MailchimpMarketing
|
|
1834
1834
|
data
|
1835
1835
|
end
|
1836
1836
|
|
1837
|
-
# Get
|
1837
|
+
# Get merge field
|
1838
1838
|
# Get information about a specific merge field in a list.
|
1839
1839
|
# @param list_id The unique ID for the list.
|
1840
1840
|
# @param merge_id The id for the merge field.
|
@@ -1873,7 +1873,7 @@ module MailchimpMarketing
|
|
1873
1873
|
:return_type => 'MergeField')
|
1874
1874
|
return data, status_code, headers
|
1875
1875
|
end
|
1876
|
-
# Get
|
1876
|
+
# Get segment info
|
1877
1877
|
# Get information about a specific segment.
|
1878
1878
|
# @param list_id The unique ID for the list.
|
1879
1879
|
# @param segment_id The unique id for the segment.
|
@@ -1889,7 +1889,7 @@ module MailchimpMarketing
|
|
1889
1889
|
data
|
1890
1890
|
end
|
1891
1891
|
|
1892
|
-
# Get
|
1892
|
+
# Get segment info
|
1893
1893
|
# Get information about a specific segment.
|
1894
1894
|
# @param list_id The unique ID for the list.
|
1895
1895
|
# @param segment_id The unique id for the segment.
|
@@ -1934,8 +1934,8 @@ module MailchimpMarketing
|
|
1934
1934
|
:return_type => 'List6')
|
1935
1935
|
return data, status_code, headers
|
1936
1936
|
end
|
1937
|
-
#
|
1938
|
-
# Get information about members in a
|
1937
|
+
# List members in segment
|
1938
|
+
# Get information about members in a saved segment.
|
1939
1939
|
# @param list_id The unique ID for the list.
|
1940
1940
|
# @param segment_id The unique id for the segment.
|
1941
1941
|
# @param [Hash] opts the optional parameters
|
@@ -1952,8 +1952,8 @@ module MailchimpMarketing
|
|
1952
1952
|
data
|
1953
1953
|
end
|
1954
1954
|
|
1955
|
-
#
|
1956
|
-
# Get information about members in a
|
1955
|
+
# List members in segment
|
1956
|
+
# Get information about members in a saved segment.
|
1957
1957
|
# @param list_id The unique ID for the list.
|
1958
1958
|
# @param segment_id The unique id for the segment.
|
1959
1959
|
# @param [Hash] opts the optional parameters
|
@@ -2001,7 +2001,7 @@ module MailchimpMarketing
|
|
2001
2001
|
:return_type => 'SegmentMembers')
|
2002
2002
|
return data, status_code, headers
|
2003
2003
|
end
|
2004
|
-
#
|
2004
|
+
# List signup forms
|
2005
2005
|
# Get signup forms for a specific list.
|
2006
2006
|
# @param list_id The unique ID for the list.
|
2007
2007
|
# @param [Hash] opts the optional parameters
|
@@ -2011,7 +2011,7 @@ module MailchimpMarketing
|
|
2011
2011
|
data
|
2012
2012
|
end
|
2013
2013
|
|
2014
|
-
#
|
2014
|
+
# List signup forms
|
2015
2015
|
# Get signup forms for a specific list.
|
2016
2016
|
# @param list_id The unique ID for the list.
|
2017
2017
|
# @param [Hash] opts the optional parameters
|
@@ -2045,7 +2045,7 @@ module MailchimpMarketing
|
|
2045
2045
|
:return_type => 'ListSignupForms')
|
2046
2046
|
return data, status_code, headers
|
2047
2047
|
end
|
2048
|
-
#
|
2048
|
+
# List webhooks
|
2049
2049
|
# Get information about all webhooks for a specific list.
|
2050
2050
|
# @param list_id The unique ID for the list.
|
2051
2051
|
# @param [Hash] opts the optional parameters
|
@@ -2055,7 +2055,7 @@ module MailchimpMarketing
|
|
2055
2055
|
data
|
2056
2056
|
end
|
2057
2057
|
|
2058
|
-
#
|
2058
|
+
# List webhooks
|
2059
2059
|
# Get information about all webhooks for a specific list.
|
2060
2060
|
# @param list_id The unique ID for the list.
|
2061
2061
|
# @param [Hash] opts the optional parameters
|
@@ -2089,7 +2089,7 @@ module MailchimpMarketing
|
|
2089
2089
|
:return_type => 'ListWebhooks')
|
2090
2090
|
return data, status_code, headers
|
2091
2091
|
end
|
2092
|
-
# Get
|
2092
|
+
# Get webhook info
|
2093
2093
|
# Get information about a specific webhook.
|
2094
2094
|
# @param list_id The unique ID for the list.
|
2095
2095
|
# @param webhook_id The webhook's id.
|
@@ -2100,7 +2100,7 @@ module MailchimpMarketing
|
|
2100
2100
|
data
|
2101
2101
|
end
|
2102
2102
|
|
2103
|
-
# Get
|
2103
|
+
# Get webhook info
|
2104
2104
|
# Get information about a specific webhook.
|
2105
2105
|
# @param list_id The unique ID for the list.
|
2106
2106
|
# @param webhook_id The webhook's id.
|
@@ -2135,7 +2135,7 @@ module MailchimpMarketing
|
|
2135
2135
|
:return_type => 'ListWebhooks')
|
2136
2136
|
return data, status_code, headers
|
2137
2137
|
end
|
2138
|
-
# Update
|
2138
|
+
# Update lists
|
2139
2139
|
# Update the settings for a specific list.
|
2140
2140
|
# @param list_id The unique ID for the list.
|
2141
2141
|
# @param body
|
@@ -2146,7 +2146,7 @@ module MailchimpMarketing
|
|
2146
2146
|
data
|
2147
2147
|
end
|
2148
2148
|
|
2149
|
-
# Update
|
2149
|
+
# Update lists
|
2150
2150
|
# Update the settings for a specific list.
|
2151
2151
|
# @param list_id The unique ID for the list.
|
2152
2152
|
# @param body
|
@@ -2181,7 +2181,7 @@ module MailchimpMarketing
|
|
2181
2181
|
:return_type => 'SubscriberList')
|
2182
2182
|
return data, status_code, headers
|
2183
2183
|
end
|
2184
|
-
# Update
|
2184
|
+
# Update interest category
|
2185
2185
|
# Update a specific interest category.
|
2186
2186
|
# @param list_id The unique ID for the list.
|
2187
2187
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2193,7 +2193,7 @@ module MailchimpMarketing
|
|
2193
2193
|
data
|
2194
2194
|
end
|
2195
2195
|
|
2196
|
-
# Update
|
2196
|
+
# Update interest category
|
2197
2197
|
# Update a specific interest category.
|
2198
2198
|
# @param list_id The unique ID for the list.
|
2199
2199
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2229,7 +2229,7 @@ module MailchimpMarketing
|
|
2229
2229
|
:return_type => 'InterestCategory')
|
2230
2230
|
return data, status_code, headers
|
2231
2231
|
end
|
2232
|
-
# Update
|
2232
|
+
# Update interest in category
|
2233
2233
|
# Update interests or 'group names' for a specific category.
|
2234
2234
|
# @param list_id The unique ID for the list.
|
2235
2235
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2242,7 +2242,7 @@ module MailchimpMarketing
|
|
2242
2242
|
data
|
2243
2243
|
end
|
2244
2244
|
|
2245
|
-
# Update
|
2245
|
+
# Update interest in category
|
2246
2246
|
# Update interests or 'group names' for a specific category.
|
2247
2247
|
# @param list_id The unique ID for the list.
|
2248
2248
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2279,7 +2279,7 @@ module MailchimpMarketing
|
|
2279
2279
|
:return_type => 'Interest')
|
2280
2280
|
return data, status_code, headers
|
2281
2281
|
end
|
2282
|
-
# Update
|
2282
|
+
# Update list member
|
2283
2283
|
# Update information for a specific list member.
|
2284
2284
|
# @param list_id The unique ID for the list.
|
2285
2285
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2292,7 +2292,7 @@ module MailchimpMarketing
|
|
2292
2292
|
data
|
2293
2293
|
end
|
2294
2294
|
|
2295
|
-
# Update
|
2295
|
+
# Update list member
|
2296
2296
|
# Update information for a specific list member.
|
2297
2297
|
# @param list_id The unique ID for the list.
|
2298
2298
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2330,7 +2330,7 @@ module MailchimpMarketing
|
|
2330
2330
|
:return_type => 'ListMembers2')
|
2331
2331
|
return data, status_code, headers
|
2332
2332
|
end
|
2333
|
-
# Update
|
2333
|
+
# Update note
|
2334
2334
|
# Update a specific note for a specific list member.
|
2335
2335
|
# @param list_id The unique ID for the list.
|
2336
2336
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2343,7 +2343,7 @@ module MailchimpMarketing
|
|
2343
2343
|
data
|
2344
2344
|
end
|
2345
2345
|
|
2346
|
-
# Update
|
2346
|
+
# Update note
|
2347
2347
|
# Update a specific note for a specific list member.
|
2348
2348
|
# @param list_id The unique ID for the list.
|
2349
2349
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2380,7 +2380,7 @@ module MailchimpMarketing
|
|
2380
2380
|
:return_type => 'MemberNotes')
|
2381
2381
|
return data, status_code, headers
|
2382
2382
|
end
|
2383
|
-
# Update
|
2383
|
+
# Update merge field
|
2384
2384
|
# Update a specific merge field in a list.
|
2385
2385
|
# @param list_id The unique ID for the list.
|
2386
2386
|
# @param merge_id The id for the merge field.
|
@@ -2392,7 +2392,7 @@ module MailchimpMarketing
|
|
2392
2392
|
data
|
2393
2393
|
end
|
2394
2394
|
|
2395
|
-
# Update
|
2395
|
+
# Update merge field
|
2396
2396
|
# Update a specific merge field in a list.
|
2397
2397
|
# @param list_id The unique ID for the list.
|
2398
2398
|
# @param merge_id The id for the merge field.
|
@@ -2428,7 +2428,7 @@ module MailchimpMarketing
|
|
2428
2428
|
:return_type => 'MergeField')
|
2429
2429
|
return data, status_code, headers
|
2430
2430
|
end
|
2431
|
-
# Update
|
2431
|
+
# Update segment
|
2432
2432
|
# Update a specific segment in a list.
|
2433
2433
|
# @param list_id The unique ID for the list.
|
2434
2434
|
# @param segment_id The unique id for the segment.
|
@@ -2440,7 +2440,7 @@ module MailchimpMarketing
|
|
2440
2440
|
data
|
2441
2441
|
end
|
2442
2442
|
|
2443
|
-
# Update
|
2443
|
+
# Update segment
|
2444
2444
|
# Update a specific segment in a list.
|
2445
2445
|
# @param list_id The unique ID for the list.
|
2446
2446
|
# @param segment_id The unique id for the segment.
|
@@ -2476,7 +2476,7 @@ module MailchimpMarketing
|
|
2476
2476
|
:return_type => 'List6')
|
2477
2477
|
return data, status_code, headers
|
2478
2478
|
end
|
2479
|
-
# Update
|
2479
|
+
# Update webhook
|
2480
2480
|
# Update the settings for an existing webhook.
|
2481
2481
|
# @param list_id The unique ID for the list.
|
2482
2482
|
# @param webhook_id The webhook's id.
|
@@ -2488,7 +2488,7 @@ module MailchimpMarketing
|
|
2488
2488
|
data
|
2489
2489
|
end
|
2490
2490
|
|
2491
|
-
# Update
|
2491
|
+
# Update webhook
|
2492
2492
|
# Update the settings for an existing webhook.
|
2493
2493
|
# @param list_id The unique ID for the list.
|
2494
2494
|
# @param webhook_id The webhook's id.
|
@@ -2524,7 +2524,7 @@ module MailchimpMarketing
|
|
2524
2524
|
:return_type => 'ListWebhooks')
|
2525
2525
|
return data, status_code, headers
|
2526
2526
|
end
|
2527
|
-
#
|
2527
|
+
# Add event
|
2528
2528
|
# Add an event for a list member.
|
2529
2529
|
# @param list_id The unique ID for the list.
|
2530
2530
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
|
@@ -2536,7 +2536,7 @@ module MailchimpMarketing
|
|
2536
2536
|
nil
|
2537
2537
|
end
|
2538
2538
|
|
2539
|
-
#
|
2539
|
+
# Add event
|
2540
2540
|
# Add an event for a list member.
|
2541
2541
|
# @param list_id The unique ID for the list.
|
2542
2542
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
|
@@ -2571,7 +2571,7 @@ module MailchimpMarketing
|
|
2571
2571
|
:auth_names => auth_names)
|
2572
2572
|
return data, status_code, headers
|
2573
2573
|
end
|
2574
|
-
#
|
2574
|
+
# Add or remove member tags
|
2575
2575
|
# Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.
|
2576
2576
|
# @param list_id The unique ID for the list.
|
2577
2577
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2583,7 +2583,7 @@ module MailchimpMarketing
|
|
2583
2583
|
nil
|
2584
2584
|
end
|
2585
2585
|
|
2586
|
-
#
|
2586
|
+
# Add or remove member tags
|
2587
2587
|
# Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.
|
2588
2588
|
# @param list_id The unique ID for the list.
|
2589
2589
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2618,7 +2618,7 @@ module MailchimpMarketing
|
|
2618
2618
|
:auth_names => auth_names)
|
2619
2619
|
return data, status_code, headers
|
2620
2620
|
end
|
2621
|
-
#
|
2621
|
+
# Add list
|
2622
2622
|
# Create a new list in your Mailchimp account.
|
2623
2623
|
# @param body
|
2624
2624
|
# @param [Hash] opts the optional parameters
|
@@ -2628,7 +2628,7 @@ module MailchimpMarketing
|
|
2628
2628
|
data
|
2629
2629
|
end
|
2630
2630
|
|
2631
|
-
#
|
2631
|
+
# Add list
|
2632
2632
|
# Create a new list in your Mailchimp account.
|
2633
2633
|
# @param body
|
2634
2634
|
# @param [Hash] opts the optional parameters
|
@@ -2662,7 +2662,7 @@ module MailchimpMarketing
|
|
2662
2662
|
:return_type => 'SubscriberList')
|
2663
2663
|
return data, status_code, headers
|
2664
2664
|
end
|
2665
|
-
# Batch
|
2665
|
+
# Batch subscribe or unsubscibe
|
2666
2666
|
# Batch subscribe or unsubscribe list members.
|
2667
2667
|
# @param list_id The unique ID for the list.
|
2668
2668
|
# @param body
|
@@ -2675,7 +2675,7 @@ module MailchimpMarketing
|
|
2675
2675
|
data
|
2676
2676
|
end
|
2677
2677
|
|
2678
|
-
# Batch
|
2678
|
+
# Batch subscribe or unsubscibe
|
2679
2679
|
# Batch subscribe or unsubscribe list members.
|
2680
2680
|
# @param list_id The unique ID for the list.
|
2681
2681
|
# @param body
|
@@ -2714,8 +2714,8 @@ module MailchimpMarketing
|
|
2714
2714
|
:return_type => 'BatchUpdateListMembers')
|
2715
2715
|
return data, status_code, headers
|
2716
2716
|
end
|
2717
|
-
#
|
2718
|
-
# Create a new external identifier for a Mailchimp list
|
2717
|
+
# Add external id
|
2718
|
+
# Create a new external identifier for a Mailchimp list.
|
2719
2719
|
# @param list_id The unique ID for the list.
|
2720
2720
|
# @param [Hash] opts the optional parameters
|
2721
2721
|
# @option opts [ExternalIdentifier1] :body
|
@@ -2725,8 +2725,8 @@ module MailchimpMarketing
|
|
2725
2725
|
data
|
2726
2726
|
end
|
2727
2727
|
|
2728
|
-
#
|
2729
|
-
# Create a new external identifier for a Mailchimp list
|
2728
|
+
# Add external id
|
2729
|
+
# Create a new external identifier for a Mailchimp list.
|
2730
2730
|
# @param list_id The unique ID for the list.
|
2731
2731
|
# @param [Hash] opts the optional parameters
|
2732
2732
|
# @option opts [ExternalIdentifier1] :body
|
@@ -2760,7 +2760,7 @@ module MailchimpMarketing
|
|
2760
2760
|
:return_type => 'ExternalIdentifier')
|
2761
2761
|
return data, status_code, headers
|
2762
2762
|
end
|
2763
|
-
#
|
2763
|
+
# Add interest category
|
2764
2764
|
# Create a new interest category.
|
2765
2765
|
# @param list_id The unique ID for the list.
|
2766
2766
|
# @param body
|
@@ -2771,7 +2771,7 @@ module MailchimpMarketing
|
|
2771
2771
|
data
|
2772
2772
|
end
|
2773
2773
|
|
2774
|
-
#
|
2774
|
+
# Add interest category
|
2775
2775
|
# Create a new interest category.
|
2776
2776
|
# @param list_id The unique ID for the list.
|
2777
2777
|
# @param body
|
@@ -2806,7 +2806,7 @@ module MailchimpMarketing
|
|
2806
2806
|
:return_type => 'InterestCategory')
|
2807
2807
|
return data, status_code, headers
|
2808
2808
|
end
|
2809
|
-
#
|
2809
|
+
# Add interest in category
|
2810
2810
|
# Create a new interest or 'group name' for a specific category.
|
2811
2811
|
# @param list_id The unique ID for the list.
|
2812
2812
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2818,7 +2818,7 @@ module MailchimpMarketing
|
|
2818
2818
|
data
|
2819
2819
|
end
|
2820
2820
|
|
2821
|
-
#
|
2821
|
+
# Add interest in category
|
2822
2822
|
# Create a new interest or 'group name' for a specific category.
|
2823
2823
|
# @param list_id The unique ID for the list.
|
2824
2824
|
# @param interest_category_id The unique ID for the interest category.
|
@@ -2854,7 +2854,7 @@ module MailchimpMarketing
|
|
2854
2854
|
:return_type => 'Interest')
|
2855
2855
|
return data, status_code, headers
|
2856
2856
|
end
|
2857
|
-
# Add
|
2857
|
+
# Add member to list
|
2858
2858
|
# Add a new member to the list.
|
2859
2859
|
# @param list_id The unique ID for the list.
|
2860
2860
|
# @param body
|
@@ -2866,7 +2866,7 @@ module MailchimpMarketing
|
|
2866
2866
|
data
|
2867
2867
|
end
|
2868
2868
|
|
2869
|
-
# Add
|
2869
|
+
# Add member to list
|
2870
2870
|
# Add a new member to the list.
|
2871
2871
|
# @param list_id The unique ID for the list.
|
2872
2872
|
# @param body
|
@@ -2903,7 +2903,7 @@ module MailchimpMarketing
|
|
2903
2903
|
:return_type => 'ListMembers2')
|
2904
2904
|
return data, status_code, headers
|
2905
2905
|
end
|
2906
|
-
#
|
2906
|
+
# Delete list member
|
2907
2907
|
# Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.
|
2908
2908
|
# @param list_id The unique ID for the list.
|
2909
2909
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2914,7 +2914,7 @@ module MailchimpMarketing
|
|
2914
2914
|
nil
|
2915
2915
|
end
|
2916
2916
|
|
2917
|
-
#
|
2917
|
+
# Delete list member
|
2918
2918
|
# Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.
|
2919
2919
|
# @param list_id The unique ID for the list.
|
2920
2920
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2948,7 +2948,7 @@ module MailchimpMarketing
|
|
2948
2948
|
:auth_names => auth_names)
|
2949
2949
|
return data, status_code, headers
|
2950
2950
|
end
|
2951
|
-
# Add
|
2951
|
+
# Add member note
|
2952
2952
|
# Add a new note for a specific subscriber.
|
2953
2953
|
# @param list_id The unique ID for the list.
|
2954
2954
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2960,7 +2960,7 @@ module MailchimpMarketing
|
|
2960
2960
|
data
|
2961
2961
|
end
|
2962
2962
|
|
2963
|
-
# Add
|
2963
|
+
# Add member note
|
2964
2964
|
# Add a new note for a specific subscriber.
|
2965
2965
|
# @param list_id The unique ID for the list.
|
2966
2966
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -2996,7 +2996,7 @@ module MailchimpMarketing
|
|
2996
2996
|
:return_type => 'MemberNotes')
|
2997
2997
|
return data, status_code, headers
|
2998
2998
|
end
|
2999
|
-
# Add
|
2999
|
+
# Add merge field
|
3000
3000
|
# Add a new merge field for a specific list.
|
3001
3001
|
# @param list_id The unique ID for the list.
|
3002
3002
|
# @param body
|
@@ -3007,7 +3007,7 @@ module MailchimpMarketing
|
|
3007
3007
|
data
|
3008
3008
|
end
|
3009
3009
|
|
3010
|
-
# Add
|
3010
|
+
# Add merge field
|
3011
3011
|
# Add a new merge field for a specific list.
|
3012
3012
|
# @param list_id The unique ID for the list.
|
3013
3013
|
# @param body
|
@@ -3042,7 +3042,7 @@ module MailchimpMarketing
|
|
3042
3042
|
:return_type => 'MergeField')
|
3043
3043
|
return data, status_code, headers
|
3044
3044
|
end
|
3045
|
-
#
|
3045
|
+
# Add segment
|
3046
3046
|
# Create a new segment in a specific list.
|
3047
3047
|
# @param list_id The unique ID for the list.
|
3048
3048
|
# @param body
|
@@ -3053,7 +3053,7 @@ module MailchimpMarketing
|
|
3053
3053
|
data
|
3054
3054
|
end
|
3055
3055
|
|
3056
|
-
#
|
3056
|
+
# Add segment
|
3057
3057
|
# Create a new segment in a specific list.
|
3058
3058
|
# @param list_id The unique ID for the list.
|
3059
3059
|
# @param body
|
@@ -3088,7 +3088,7 @@ module MailchimpMarketing
|
|
3088
3088
|
:return_type => 'List6')
|
3089
3089
|
return data, status_code, headers
|
3090
3090
|
end
|
3091
|
-
# Batch add
|
3091
|
+
# Batch add or remove members
|
3092
3092
|
# Batch add/remove list members to static segment
|
3093
3093
|
# @param body
|
3094
3094
|
# @param list_id The unique ID for the list.
|
@@ -3100,7 +3100,7 @@ module MailchimpMarketing
|
|
3100
3100
|
data
|
3101
3101
|
end
|
3102
3102
|
|
3103
|
-
# Batch add
|
3103
|
+
# Batch add or remove members
|
3104
3104
|
# Batch add/remove list members to static segment
|
3105
3105
|
# @param body
|
3106
3106
|
# @param list_id The unique ID for the list.
|
@@ -3136,7 +3136,7 @@ module MailchimpMarketing
|
|
3136
3136
|
:return_type => 'BatchAddremoveListMembersTofromStaticSegment')
|
3137
3137
|
return data, status_code, headers
|
3138
3138
|
end
|
3139
|
-
# Add
|
3139
|
+
# Add member to segment
|
3140
3140
|
# Add a member to a static segment.
|
3141
3141
|
# @param list_id The unique ID for the list.
|
3142
3142
|
# @param segment_id The unique id for the segment.
|
@@ -3148,7 +3148,7 @@ module MailchimpMarketing
|
|
3148
3148
|
data
|
3149
3149
|
end
|
3150
3150
|
|
3151
|
-
# Add
|
3151
|
+
# Add member to segment
|
3152
3152
|
# Add a member to a static segment.
|
3153
3153
|
# @param list_id The unique ID for the list.
|
3154
3154
|
# @param segment_id The unique id for the segment.
|
@@ -3184,7 +3184,7 @@ module MailchimpMarketing
|
|
3184
3184
|
:return_type => 'ListMembers1')
|
3185
3185
|
return data, status_code, headers
|
3186
3186
|
end
|
3187
|
-
# Customize
|
3187
|
+
# Customize signup form
|
3188
3188
|
# Customize a list's default signup form.
|
3189
3189
|
# @param list_id The unique ID for the list.
|
3190
3190
|
# @param body
|
@@ -3195,7 +3195,7 @@ module MailchimpMarketing
|
|
3195
3195
|
data
|
3196
3196
|
end
|
3197
3197
|
|
3198
|
-
# Customize
|
3198
|
+
# Customize signup form
|
3199
3199
|
# Customize a list's default signup form.
|
3200
3200
|
# @param list_id The unique ID for the list.
|
3201
3201
|
# @param body
|
@@ -3230,7 +3230,7 @@ module MailchimpMarketing
|
|
3230
3230
|
:return_type => 'SignupForm')
|
3231
3231
|
return data, status_code, headers
|
3232
3232
|
end
|
3233
|
-
#
|
3233
|
+
# Add webhook
|
3234
3234
|
# Create a new webhook for a specific list.
|
3235
3235
|
# @param list_id The unique ID for the list.
|
3236
3236
|
# @param body
|
@@ -3241,7 +3241,7 @@ module MailchimpMarketing
|
|
3241
3241
|
data
|
3242
3242
|
end
|
3243
3243
|
|
3244
|
-
#
|
3244
|
+
# Add webhook
|
3245
3245
|
# Create a new webhook for a specific list.
|
3246
3246
|
# @param list_id The unique ID for the list.
|
3247
3247
|
# @param body
|
@@ -3276,7 +3276,7 @@ module MailchimpMarketing
|
|
3276
3276
|
:return_type => 'ListWebhooks')
|
3277
3277
|
return data, status_code, headers
|
3278
3278
|
end
|
3279
|
-
#
|
3279
|
+
# List segments
|
3280
3280
|
# Get information about all available segments for a specific list.
|
3281
3281
|
# @param list_id The unique ID for the list.
|
3282
3282
|
# @param [Hash] opts the optional parameters
|
@@ -3298,7 +3298,7 @@ module MailchimpMarketing
|
|
3298
3298
|
data
|
3299
3299
|
end
|
3300
3300
|
|
3301
|
-
#
|
3301
|
+
# List segments
|
3302
3302
|
# Get information about all available segments for a specific list.
|
3303
3303
|
# @param list_id The unique ID for the list.
|
3304
3304
|
# @param [Hash] opts the optional parameters
|
@@ -3356,7 +3356,7 @@ module MailchimpMarketing
|
|
3356
3356
|
:return_type => 'CollectionOfSegments')
|
3357
3357
|
return data, status_code, headers
|
3358
3358
|
end
|
3359
|
-
# Preview
|
3359
|
+
# Preview segment
|
3360
3360
|
# Preview a segment of users by sending conditions.
|
3361
3361
|
# @param list_id The unique ID for the list.
|
3362
3362
|
# @param [Hash] opts the optional parameters
|
@@ -3367,7 +3367,7 @@ module MailchimpMarketing
|
|
3367
3367
|
data
|
3368
3368
|
end
|
3369
3369
|
|
3370
|
-
# Preview
|
3370
|
+
# Preview segment
|
3371
3371
|
# Preview a segment of users by sending conditions.
|
3372
3372
|
# @param list_id The unique ID for the list.
|
3373
3373
|
# @param [Hash] opts the optional parameters
|
@@ -3402,7 +3402,7 @@ module MailchimpMarketing
|
|
3402
3402
|
:return_type => 'ListMembers2')
|
3403
3403
|
return data, status_code, headers
|
3404
3404
|
end
|
3405
|
-
# Add or update
|
3405
|
+
# Add or update list member
|
3406
3406
|
# Add or update a list member.
|
3407
3407
|
# @param list_id The unique ID for the list.
|
3408
3408
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
@@ -3415,7 +3415,7 @@ module MailchimpMarketing
|
|
3415
3415
|
data
|
3416
3416
|
end
|
3417
3417
|
|
3418
|
-
# Add or update
|
3418
|
+
# Add or update list member
|
3419
3419
|
# Add or update a list member.
|
3420
3420
|
# @param list_id The unique ID for the list.
|
3421
3421
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|