MailchimpMarketing 3.0.2 → 3.0.5
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1f29e4b1eb861fa93e58b96cc4f61104d466def6932db05eb51e478a201857b6
|
4
|
+
data.tar.gz: bbda28ca9ca21fa8392b058e06126b4b7f99a2603f1885ccf577005c39ee6c47
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 849c0aed5b39aff52d16b2c3f0ad9d94293b818e8daa71b9b57879f9eb34bce357bbbe48c5146ae33910f758b1ea04c148811436fc088fc2b74ce69f098105d7
|
7
|
+
data.tar.gz: 7ff083a02e8607f15feecf96b40b8273422b093023e57445908a1dd3170b103cb5705c6774f6e6ca92a5d9924b6d2df2e9f73f2775c911194a0607630c9f8701
|
data/MailchimpMarketing.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
7
7
|
|
8
|
-
OpenAPI spec version: 3.0.
|
8
|
+
OpenAPI spec version: 3.0.5
|
9
9
|
Contact: apihelp@mailchimp.com
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
11
|
Swagger Codegen version: 2.4.12
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
# Mailchimp Marketing
|
1
|
+
# Mailchimp Marketing — Ruby
|
2
2
|
|
3
|
-
The official Ruby
|
3
|
+
The official Ruby client library for the Mailchimp Marketing API (v1)
|
4
4
|
|
5
5
|
## Installation
|
6
6
|
|
@@ -15,21 +15,21 @@ gem build MailchimpMarketing.gemspec
|
|
15
15
|
Then either install the gem locally:
|
16
16
|
|
17
17
|
```shell
|
18
|
-
gem install ./MailchimpMarketing-3.0.
|
18
|
+
gem install ./MailchimpMarketing-3.0.5.gem
|
19
19
|
```
|
20
|
-
(for development, run `gem install --dev ./MailchimpMarketing-3.0.
|
20
|
+
(for development, run `gem install --dev ./MailchimpMarketing-3.0.5.gem` to install the development dependencies)
|
21
21
|
|
22
22
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
23
23
|
|
24
24
|
Finally add this to the Gemfile:
|
25
25
|
|
26
|
-
gem 'MailchimpMarketing', '~> 3.0.
|
26
|
+
gem 'MailchimpMarketing', '~> 3.0.5'
|
27
27
|
|
28
28
|
### Install from Git
|
29
29
|
|
30
|
-
If the Ruby gem is hosted at a git repository: https://github.com/
|
30
|
+
If the Ruby gem is hosted at a git repository: https://github.com/mailchimp/mailchimp-marketing-ruby, then add the following in the Gemfile:
|
31
31
|
|
32
|
-
gem 'MailchimpMarketing', :git => 'https://github.com/
|
32
|
+
gem 'MailchimpMarketing', :git => 'https://github.com/mailchimp/mailchimp-marketing-ruby.git'
|
33
33
|
|
34
34
|
### Include the Ruby code directly
|
35
35
|
|
@@ -46,7 +46,10 @@ require 'MailchimpMarketing'
|
|
46
46
|
|
47
47
|
begin
|
48
48
|
client = MailchimpMarketing::Client.new()
|
49
|
-
client.set_config(
|
49
|
+
client.set_config({
|
50
|
+
:api_key => 'YOUR_API_KEY',
|
51
|
+
:server => 'YOUR_SERVER_PREFIX'
|
52
|
+
})
|
50
53
|
result = client.ping.get()
|
51
54
|
p result
|
52
55
|
rescue MailchimpMarketing::ApiError => e
|
@@ -54,17 +57,33 @@ rescue MailchimpMarketing::ApiError => e
|
|
54
57
|
end
|
55
58
|
```
|
56
59
|
|
57
|
-
|
60
|
+
## Authentication Methods
|
58
61
|
|
59
|
-
|
60
|
-
|
62
|
+
The client library can be configured to use either **Basic Auth** or **OAuth2**.
|
63
|
+
|
64
|
+
For either method, a server prefix should be passed in i.e. `us19`, in order for the client to determine to appropriate host url.
|
65
|
+
|
66
|
+
### Basic Auth
|
67
|
+
```ruby
|
68
|
+
client.set_config({
|
69
|
+
:api_key => 'YOUR_API_KEY',
|
70
|
+
:server => 'YOUR_SERVER_PREFIX'
|
71
|
+
})
|
72
|
+
```
|
73
|
+
|
74
|
+
### OAuth2
|
75
|
+
```ruby
|
76
|
+
client.set_config({
|
77
|
+
:access_token => 'YOUR_ACCESS_TOKEN',
|
78
|
+
:server => 'YOUR_SERVER_PREFIX'
|
79
|
+
})
|
61
80
|
```
|
62
81
|
|
63
82
|
## API Endpoints
|
64
83
|
|
65
84
|
All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
66
85
|
|
67
|
-
|
|
86
|
+
| Method | Endpoint |
|
68
87
|
| ---------- | -------- |
|
69
88
|
| **activityFeed.get** | /activity-feed |
|
70
89
|
| **activityFeed.get_chimp_chatter** | /activity-feed/chimp-chatter |
|
@@ -342,28 +361,22 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
342
361
|
| **verifiedDomains.submit_domain_verification** | /verified-domains/{domain_name}/actions/verify |
|
343
362
|
|
344
363
|
|
345
|
-
## Additional
|
364
|
+
## Additional Client Libraries
|
346
365
|
|
347
|
-
Mailchimp Marketing
|
366
|
+
Mailchimp Marketing libraries are available in the following languages:
|
348
367
|
|
349
368
|
<div>
|
350
|
-
<a href="https://github.com/
|
351
|
-
<img src="https://github.com/
|
352
|
-
</a>
|
353
|
-
<a href="https://github.com/postlight/mailchimp-marketing-php">
|
354
|
-
<img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_php.png?raw=true" width="44" height="44">
|
355
|
-
</a>
|
356
|
-
<a href="https://github.com/postlight/mailchimp-marketing-ruby">
|
357
|
-
<img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_ruby.png?raw=true" width="44" height="44">
|
369
|
+
<a href="https://github.com/mailchimp/mailchimp-marketing-node">
|
370
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_node.png?raw=true" width="44" height="44">
|
358
371
|
</a>
|
359
|
-
<a href="https://github.com/
|
360
|
-
<img src="https://github.com/
|
372
|
+
<a href="https://github.com/mailchimp/mailchimp-marketing-php">
|
373
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_php.png?raw=true" width="44" height="44">
|
361
374
|
</a>
|
362
|
-
<a href="https://github.com/
|
363
|
-
<img src="https://github.com/
|
375
|
+
<a href="https://github.com/mailchimp/mailchimp-marketing-ruby">
|
376
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_ruby.png?raw=true" width="44" height="44">
|
364
377
|
</a>
|
365
|
-
|
366
|
-
<img src="https://github.com/
|
378
|
+
<a href="https://github.com/mailchimp/mailchimp-marketing-python">
|
379
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_python.png?raw=true" width="44" height="44">
|
367
380
|
</a>
|
368
381
|
</div>
|
369
382
|
|
data/lib/MailchimpMarketing.rb
CHANGED
@@ -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
|
@@ -15,7 +15,6 @@ require 'MailchimpMarketing/api_client'
|
|
15
15
|
require 'MailchimpMarketing/api_error'
|
16
16
|
require 'MailchimpMarketing/version'
|
17
17
|
|
18
|
-
|
19
18
|
# APIs
|
20
19
|
require 'MailchimpMarketing/api/activity_feed_api'
|
21
20
|
require 'MailchimpMarketing/api/authorized_apps_api'
|
@@ -46,8 +45,8 @@ require 'MailchimpMarketing/api/verified_domains_api'
|
|
46
45
|
|
47
46
|
module MailchimpMarketing
|
48
47
|
class Client
|
49
|
-
def initialize(
|
50
|
-
@api_client = ApiClient.new(
|
48
|
+
def initialize(config = {})
|
49
|
+
@api_client = ApiClient.new(config)
|
51
50
|
|
52
51
|
@ActivityFeed = ActivityFeedApi.new(@api_client)
|
53
52
|
@AuthorizedApps = AuthorizedAppsApi.new(@api_client)
|
@@ -77,8 +76,8 @@ module MailchimpMarketing
|
|
77
76
|
@VerifiedDomains = VerifiedDomainsApi.new(@api_client)
|
78
77
|
end
|
79
78
|
|
80
|
-
def set_config(
|
81
|
-
@api_client.set_config(
|
79
|
+
def set_config(config = {})
|
80
|
+
@api_client.set_config(config)
|
82
81
|
end
|
83
82
|
|
84
83
|
def activityFeed
|
@@ -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
|
+
# List activity feed resources
|
23
23
|
# Get information about the activity feed endpoint's resources.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [ActivityFeedRoot]
|
@@ -28,7 +28,7 @@ module MailchimpMarketing
|
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
31
|
-
#
|
31
|
+
# List activity feed resources
|
32
32
|
# Get information about the activity feed endpoint's resources.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(ActivityFeedRoot, Fixnum, Hash)>] ActivityFeedRoot data, response status code and response headers
|
@@ -61,8 +61,8 @@ module MailchimpMarketing
|
|
61
61
|
:return_type => 'ActivityFeedRoot')
|
62
62
|
return data, status_code, headers
|
63
63
|
end
|
64
|
-
#
|
65
|
-
# Return the Chimp Chatter for this account ordered by most recent
|
64
|
+
# Get latest chimp chatter
|
65
|
+
# Return the Chimp Chatter for this account ordered by most recent.
|
66
66
|
# @param [Hash] opts the optional parameters
|
67
67
|
# @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)
|
68
68
|
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
|
@@ -72,8 +72,8 @@ module MailchimpMarketing
|
|
72
72
|
data
|
73
73
|
end
|
74
74
|
|
75
|
-
#
|
76
|
-
# Return the Chimp Chatter for this account ordered by most recent
|
75
|
+
# Get latest chimp chatter
|
76
|
+
# Return the Chimp Chatter for this account ordered by most recent.
|
77
77
|
# @param [Hash] opts the optional parameters
|
78
78
|
# @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**
|
79
79
|
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
|
@@ -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
|
+
# List authorized apps
|
23
23
|
# Get a list of an account's registered, connected applications.
|
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.
|
@@ -32,7 +32,7 @@ module MailchimpMarketing
|
|
32
32
|
data
|
33
33
|
end
|
34
34
|
|
35
|
-
#
|
35
|
+
# List authorized apps
|
36
36
|
# Get a list of an account's registered, connected applications.
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -73,7 +73,7 @@ module MailchimpMarketing
|
|
73
73
|
:return_type => 'InlineResponse2001')
|
74
74
|
return data, status_code, headers
|
75
75
|
end
|
76
|
-
# Get
|
76
|
+
# Get authorized app info
|
77
77
|
# Get information about a specific authorized application.
|
78
78
|
# @param app_id The unique id for the connected authorized application.
|
79
79
|
# @param [Hash] opts the optional parameters
|
@@ -85,7 +85,7 @@ module MailchimpMarketing
|
|
85
85
|
data
|
86
86
|
end
|
87
87
|
|
88
|
-
# Get
|
88
|
+
# Get authorized app info
|
89
89
|
# Get information about a specific authorized application.
|
90
90
|
# @param app_id The unique id for the connected authorized application.
|
91
91
|
# @param [Hash] opts the optional parameters
|
@@ -123,8 +123,8 @@ module MailchimpMarketing
|
|
123
123
|
:return_type => 'InlineResponse2001Apps')
|
124
124
|
return data, status_code, headers
|
125
125
|
end
|
126
|
-
# Link
|
127
|
-
#
|
126
|
+
# Link application
|
127
|
+
# Get Batch Operation Status
|
128
128
|
# @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can't implement the OAuth2 flow but still want to associate calls with your application.
|
129
129
|
# @param [Hash] opts the optional parameters
|
130
130
|
# @return [InlineResponse2002]
|
@@ -133,8 +133,8 @@ module MailchimpMarketing
|
|
133
133
|
data
|
134
134
|
end
|
135
135
|
|
136
|
-
# Link
|
137
|
-
#
|
136
|
+
# Link application
|
137
|
+
# Get Batch Operation Status
|
138
138
|
# @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can't implement the OAuth2 flow but still want to associate calls with your application.
|
139
139
|
# @param [Hash] opts the optional parameters
|
140
140
|
# @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
|
@@ -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
|
-
# Archive
|
22
|
+
# Archive automation
|
23
23
|
# Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.
|
24
24
|
# @param workflow_id The unique id for the Automation workflow.
|
25
25
|
# @param [Hash] opts the optional parameters
|
@@ -29,7 +29,7 @@ module MailchimpMarketing
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
# Archive
|
32
|
+
# Archive automation
|
33
33
|
# Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.
|
34
34
|
# @param workflow_id The unique id for the Automation workflow.
|
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
|
65
|
+
# Delete workflow email
|
66
66
|
# Removes an individual Automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.
|
67
67
|
# @param workflow_id The unique id for the Automation workflow.
|
68
68
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -73,7 +73,7 @@ module MailchimpMarketing
|
|
73
73
|
nil
|
74
74
|
end
|
75
75
|
|
76
|
-
# Delete
|
76
|
+
# Delete workflow email
|
77
77
|
# Removes an individual Automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.
|
78
78
|
# @param workflow_id The unique id for the Automation workflow.
|
79
79
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -107,7 +107,7 @@ module MailchimpMarketing
|
|
107
107
|
:auth_names => auth_names)
|
108
108
|
return data, status_code, headers
|
109
109
|
end
|
110
|
-
#
|
110
|
+
# List automations
|
111
111
|
# Get a summary of an account's Automations.
|
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.
|
@@ -123,7 +123,7 @@ module MailchimpMarketing
|
|
123
123
|
data
|
124
124
|
end
|
125
125
|
|
126
|
-
#
|
126
|
+
# List automations
|
127
127
|
# Get a summary of an account's Automations.
|
128
128
|
# @param [Hash] opts the optional parameters
|
129
129
|
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
@@ -170,7 +170,7 @@ module MailchimpMarketing
|
|
170
170
|
:return_type => 'InlineResponse2003')
|
171
171
|
return data, status_code, headers
|
172
172
|
end
|
173
|
-
# Get
|
173
|
+
# Get automation info
|
174
174
|
# Get a summary of an individual Automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.
|
175
175
|
# @param workflow_id The unique id for the Automation workflow.
|
176
176
|
# @param [Hash] opts the optional parameters
|
@@ -182,7 +182,7 @@ module MailchimpMarketing
|
|
182
182
|
data
|
183
183
|
end
|
184
184
|
|
185
|
-
# Get
|
185
|
+
# Get automation info
|
186
186
|
# Get a summary of an individual Automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.
|
187
187
|
# @param workflow_id The unique id for the Automation workflow.
|
188
188
|
# @param [Hash] opts the optional parameters
|
@@ -220,7 +220,7 @@ module MailchimpMarketing
|
|
220
220
|
:return_type => 'AutomationWorkflow')
|
221
221
|
return data, status_code, headers
|
222
222
|
end
|
223
|
-
#
|
223
|
+
# List automated emails
|
224
224
|
# Get a summary of the emails in an Automation workflow.
|
225
225
|
# @param workflow_id The unique id for the Automation workflow.
|
226
226
|
# @param [Hash] opts the optional parameters
|
@@ -230,7 +230,7 @@ module MailchimpMarketing
|
|
230
230
|
data
|
231
231
|
end
|
232
232
|
|
233
|
-
#
|
233
|
+
# List automated emails
|
234
234
|
# Get a summary of the emails in an Automation workflow.
|
235
235
|
# @param workflow_id The unique id for the Automation workflow.
|
236
236
|
# @param [Hash] opts the optional parameters
|
@@ -264,7 +264,7 @@ module MailchimpMarketing
|
|
264
264
|
:return_type => 'AutomationEmails')
|
265
265
|
return data, status_code, headers
|
266
266
|
end
|
267
|
-
# Get
|
267
|
+
# Get workflow email info
|
268
268
|
# Get information about an individual Automation workflow email.
|
269
269
|
# @param workflow_id The unique id for the Automation workflow.
|
270
270
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -275,7 +275,7 @@ module MailchimpMarketing
|
|
275
275
|
data
|
276
276
|
end
|
277
277
|
|
278
|
-
# Get
|
278
|
+
# Get workflow email info
|
279
279
|
# Get information about an individual Automation workflow email.
|
280
280
|
# @param workflow_id The unique id for the Automation workflow.
|
281
281
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -310,7 +310,7 @@ module MailchimpMarketing
|
|
310
310
|
:return_type => 'AutomationWorkflowEmail')
|
311
311
|
return data, status_code, headers
|
312
312
|
end
|
313
|
-
#
|
313
|
+
# List automated email subscribers
|
314
314
|
# Get information about an Automation email queue.
|
315
315
|
# @param workflow_id The unique id for the Automation workflow.
|
316
316
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -321,7 +321,7 @@ module MailchimpMarketing
|
|
321
321
|
data
|
322
322
|
end
|
323
323
|
|
324
|
-
#
|
324
|
+
# List automated email subscribers
|
325
325
|
# Get information about an Automation email queue.
|
326
326
|
# @param workflow_id The unique id for the Automation workflow.
|
327
327
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -356,7 +356,7 @@ module MailchimpMarketing
|
|
356
356
|
:return_type => 'InlineResponse2004')
|
357
357
|
return data, status_code, headers
|
358
358
|
end
|
359
|
-
#
|
359
|
+
# Get automated email subscriber
|
360
360
|
# Get information about a specific subscriber in an Automation email queue.
|
361
361
|
# @param workflow_id The unique id for the Automation workflow.
|
362
362
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -368,7 +368,7 @@ module MailchimpMarketing
|
|
368
368
|
data
|
369
369
|
end
|
370
370
|
|
371
|
-
#
|
371
|
+
# Get automated email subscriber
|
372
372
|
# Get information about a specific subscriber in an Automation email queue.
|
373
373
|
# @param workflow_id The unique id for the Automation workflow.
|
374
374
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -404,8 +404,8 @@ module MailchimpMarketing
|
|
404
404
|
:return_type => 'SubscriberInAutomationQueue2')
|
405
405
|
return data, status_code, headers
|
406
406
|
end
|
407
|
-
#
|
408
|
-
# Get information about subscribers who were
|
407
|
+
# List subscribers removed from workflow
|
408
|
+
# Get information about subscribers who were removed from an Automation workflow.
|
409
409
|
# @param workflow_id The unique id for the Automation workflow.
|
410
410
|
# @param [Hash] opts the optional parameters
|
411
411
|
# @return [RemovedSubscribers]
|
@@ -414,8 +414,8 @@ module MailchimpMarketing
|
|
414
414
|
data
|
415
415
|
end
|
416
416
|
|
417
|
-
#
|
418
|
-
# Get information about subscribers who were
|
417
|
+
# List subscribers removed from workflow
|
418
|
+
# Get information about subscribers who were removed from an Automation workflow.
|
419
419
|
# @param workflow_id The unique id for the Automation workflow.
|
420
420
|
# @param [Hash] opts the optional parameters
|
421
421
|
# @return [Array<(RemovedSubscribers, Fixnum, Hash)>] RemovedSubscribers data, response status code and response headers
|
@@ -448,8 +448,8 @@ module MailchimpMarketing
|
|
448
448
|
:return_type => 'RemovedSubscribers')
|
449
449
|
return data, status_code, headers
|
450
450
|
end
|
451
|
-
#
|
452
|
-
# Get information about a specific subscriber who was
|
451
|
+
# Get subscriber removed from workflow
|
452
|
+
# Get information about a specific subscriber who was removed from an Automation workflow.
|
453
453
|
# @param workflow_id The unique id for the Automation workflow.
|
454
454
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
455
455
|
# @param [Hash] opts the optional parameters
|
@@ -459,8 +459,8 @@ module MailchimpMarketing
|
|
459
459
|
data
|
460
460
|
end
|
461
461
|
|
462
|
-
#
|
463
|
-
# Get information about a specific subscriber who was
|
462
|
+
# Get subscriber removed from workflow
|
463
|
+
# Get information about a specific subscriber who was removed from an Automation workflow.
|
464
464
|
# @param workflow_id The unique id for the Automation workflow.
|
465
465
|
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
466
466
|
# @param [Hash] opts the optional parameters
|
@@ -494,7 +494,7 @@ module MailchimpMarketing
|
|
494
494
|
:return_type => 'SubscriberRemovedFromAutomationWorkflow')
|
495
495
|
return data, status_code, headers
|
496
496
|
end
|
497
|
-
# Update
|
497
|
+
# Update workflow email
|
498
498
|
# Update settings for a Automation workflow email
|
499
499
|
# @param workflow_id The unique id for the Automation workflow.
|
500
500
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -506,7 +506,7 @@ module MailchimpMarketing
|
|
506
506
|
data
|
507
507
|
end
|
508
508
|
|
509
|
-
# Update
|
509
|
+
# Update workflow email
|
510
510
|
# Update settings for a Automation workflow email
|
511
511
|
# @param workflow_id The unique id for the Automation workflow.
|
512
512
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -542,7 +542,7 @@ module MailchimpMarketing
|
|
542
542
|
:return_type => 'AutomationWorkflowEmail')
|
543
543
|
return data, status_code, headers
|
544
544
|
end
|
545
|
-
# Update
|
545
|
+
# Update automation
|
546
546
|
# Update some or all of the settings for a Automation
|
547
547
|
# @param workflow_id The unique id for the Automation workflow.
|
548
548
|
# @param body
|
@@ -553,7 +553,7 @@ module MailchimpMarketing
|
|
553
553
|
data
|
554
554
|
end
|
555
555
|
|
556
|
-
# Update
|
556
|
+
# Update automation
|
557
557
|
# Update some or all of the settings for a Automation
|
558
558
|
# @param workflow_id The unique id for the Automation workflow.
|
559
559
|
# @param body
|
@@ -588,7 +588,7 @@ module MailchimpMarketing
|
|
588
588
|
:return_type => 'AutomationWorkflow')
|
589
589
|
return data, status_code, headers
|
590
590
|
end
|
591
|
-
#
|
591
|
+
# Add automation
|
592
592
|
# Create a new Automation in your Mailchimp account.
|
593
593
|
# @param body
|
594
594
|
# @param [Hash] opts the optional parameters
|
@@ -598,7 +598,7 @@ module MailchimpMarketing
|
|
598
598
|
data
|
599
599
|
end
|
600
600
|
|
601
|
-
#
|
601
|
+
# Add automation
|
602
602
|
# Create a new Automation in your Mailchimp account.
|
603
603
|
# @param body
|
604
604
|
# @param [Hash] opts the optional parameters
|
@@ -632,7 +632,7 @@ module MailchimpMarketing
|
|
632
632
|
:return_type => 'AutomationWorkflow')
|
633
633
|
return data, status_code, headers
|
634
634
|
end
|
635
|
-
# Pause
|
635
|
+
# Pause automation emails
|
636
636
|
# Pause all emails in a specific Automation workflow.
|
637
637
|
# @param workflow_id The unique id for the Automation workflow.
|
638
638
|
# @param [Hash] opts the optional parameters
|
@@ -642,7 +642,7 @@ module MailchimpMarketing
|
|
642
642
|
nil
|
643
643
|
end
|
644
644
|
|
645
|
-
# Pause
|
645
|
+
# Pause automation emails
|
646
646
|
# Pause all emails in a specific Automation workflow.
|
647
647
|
# @param workflow_id The unique id for the Automation workflow.
|
648
648
|
# @param [Hash] opts the optional parameters
|
@@ -675,7 +675,7 @@ module MailchimpMarketing
|
|
675
675
|
:auth_names => auth_names)
|
676
676
|
return data, status_code, headers
|
677
677
|
end
|
678
|
-
# Start
|
678
|
+
# Start automation emails
|
679
679
|
# Start all emails in an Automation workflow.
|
680
680
|
# @param workflow_id The unique id for the Automation workflow.
|
681
681
|
# @param [Hash] opts the optional parameters
|
@@ -685,7 +685,7 @@ module MailchimpMarketing
|
|
685
685
|
nil
|
686
686
|
end
|
687
687
|
|
688
|
-
# Start
|
688
|
+
# Start automation emails
|
689
689
|
# Start all emails in an Automation workflow.
|
690
690
|
# @param workflow_id The unique id for the Automation workflow.
|
691
691
|
# @param [Hash] opts the optional parameters
|
@@ -718,7 +718,7 @@ module MailchimpMarketing
|
|
718
718
|
:auth_names => auth_names)
|
719
719
|
return data, status_code, headers
|
720
720
|
end
|
721
|
-
# Pause
|
721
|
+
# Pause automated email
|
722
722
|
# Pause an automated email.
|
723
723
|
# @param workflow_id The unique id for the Automation workflow.
|
724
724
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -729,7 +729,7 @@ module MailchimpMarketing
|
|
729
729
|
nil
|
730
730
|
end
|
731
731
|
|
732
|
-
# Pause
|
732
|
+
# Pause automated email
|
733
733
|
# Pause an automated email.
|
734
734
|
# @param workflow_id The unique id for the Automation workflow.
|
735
735
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -763,7 +763,7 @@ module MailchimpMarketing
|
|
763
763
|
:auth_names => auth_names)
|
764
764
|
return data, status_code, headers
|
765
765
|
end
|
766
|
-
# Start
|
766
|
+
# Start automated email
|
767
767
|
# Start an automated email.
|
768
768
|
# @param workflow_id The unique id for the Automation workflow.
|
769
769
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -774,7 +774,7 @@ module MailchimpMarketing
|
|
774
774
|
nil
|
775
775
|
end
|
776
776
|
|
777
|
-
# Start
|
777
|
+
# Start automated email
|
778
778
|
# Start an automated email.
|
779
779
|
# @param workflow_id The unique id for the Automation workflow.
|
780
780
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
@@ -808,8 +808,8 @@ module MailchimpMarketing
|
|
808
808
|
:auth_names => auth_names)
|
809
809
|
return data, status_code, headers
|
810
810
|
end
|
811
|
-
# Add
|
812
|
-
# Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an
|
811
|
+
# Add subscriber to workflow email
|
812
|
+
# Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.
|
813
813
|
# @param workflow_id The unique id for the Automation workflow.
|
814
814
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
815
815
|
# @param body
|
@@ -820,8 +820,8 @@ module MailchimpMarketing
|
|
820
820
|
data
|
821
821
|
end
|
822
822
|
|
823
|
-
# Add
|
824
|
-
# Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an
|
823
|
+
# Add subscriber to workflow email
|
824
|
+
# Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.
|
825
825
|
# @param workflow_id The unique id for the Automation workflow.
|
826
826
|
# @param workflow_email_id The unique id for the Automation workflow email.
|
827
827
|
# @param body
|
@@ -856,8 +856,8 @@ module MailchimpMarketing
|
|
856
856
|
:return_type => 'SubscriberInAutomationQueue2')
|
857
857
|
return data, status_code, headers
|
858
858
|
end
|
859
|
-
# Remove subscriber from
|
860
|
-
#
|
859
|
+
# Remove subscriber from workflow
|
860
|
+
# Remove a subscriber from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.
|
861
861
|
# @param workflow_id The unique id for the Automation workflow.
|
862
862
|
# @param body
|
863
863
|
# @param [Hash] opts the optional parameters
|
@@ -867,8 +867,8 @@ module MailchimpMarketing
|
|
867
867
|
data
|
868
868
|
end
|
869
869
|
|
870
|
-
# Remove subscriber from
|
871
|
-
#
|
870
|
+
# Remove subscriber from workflow
|
871
|
+
# Remove a subscriber from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.
|
872
872
|
# @param workflow_id The unique id for the Automation workflow.
|
873
873
|
# @param body
|
874
874
|
# @param [Hash] opts the optional parameters
|