MailchimpMarketing 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/MailchimpMarketing.gemspec +45 -0
  4. data/README.md +369 -0
  5. data/lib/MailchimpMarketing.rb +163 -0
  6. data/lib/MailchimpMarketing/api/activity_feed_api.rb +113 -0
  7. data/lib/MailchimpMarketing/api/authorized_apps_api.rb +171 -0
  8. data/lib/MailchimpMarketing/api/automations_api.rb +906 -0
  9. data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +260 -0
  10. data/lib/MailchimpMarketing/api/batches_api.rb +214 -0
  11. data/lib/MailchimpMarketing/api/campaign_folders_api.rb +260 -0
  12. data/lib/MailchimpMarketing/api/campaigns_api.rb +1073 -0
  13. data/lib/MailchimpMarketing/api/connected_sites_api.rb +257 -0
  14. data/lib/MailchimpMarketing/api/conversations_api.rb +293 -0
  15. data/lib/MailchimpMarketing/api/dashboard_api.rb +317 -0
  16. data/lib/MailchimpMarketing/api/ecommerce_api.rb +3004 -0
  17. data/lib/MailchimpMarketing/api/external_auths_api.rb +171 -0
  18. data/lib/MailchimpMarketing/api/facebook_ads_api.rb +133 -0
  19. data/lib/MailchimpMarketing/api/file_manager_api.rb +566 -0
  20. data/lib/MailchimpMarketing/api/landing_pages_api.rb +399 -0
  21. data/lib/MailchimpMarketing/api/lists_api.rb +3457 -0
  22. data/lib/MailchimpMarketing/api/ping_api.rb +65 -0
  23. data/lib/MailchimpMarketing/api/postcards_api.rb +77 -0
  24. data/lib/MailchimpMarketing/api/reporting_api.rb +338 -0
  25. data/lib/MailchimpMarketing/api/reports_api.rb +1214 -0
  26. data/lib/MailchimpMarketing/api/root_api.rb +71 -0
  27. data/lib/MailchimpMarketing/api/search_campaigns_api.rb +74 -0
  28. data/lib/MailchimpMarketing/api/search_members_api.rb +77 -0
  29. data/lib/MailchimpMarketing/api/template_folders_api.rb +260 -0
  30. data/lib/MailchimpMarketing/api/templates_api.rb +331 -0
  31. data/lib/MailchimpMarketing/api/verified_domains_api.rb +242 -0
  32. data/lib/MailchimpMarketing/api_client.rb +192 -0
  33. data/lib/MailchimpMarketing/api_error.rb +38 -0
  34. data/lib/MailchimpMarketing/configuration.rb +209 -0
  35. data/lib/MailchimpMarketing/version.rb +15 -0
  36. metadata +257 -0
@@ -0,0 +1,113 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.1
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module MailchimpMarketing
16
+ class ActivityFeedApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client)
20
+ @api_client = api_client
21
+ end
22
+ # Get information about the activity feed endpoint's resources
23
+ # Get information about the activity feed endpoint's resources.
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [ActivityFeedRoot]
26
+ def get(opts = {})
27
+ data, _status_code, _headers = get_with_http_info(opts)
28
+ data
29
+ end
30
+
31
+ # Get information about the activity feed endpoint's resources
32
+ # Get information about the activity feed endpoint's resources.
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(ActivityFeedRoot, Fixnum, Hash)>] ActivityFeedRoot data, response status code and response headers
35
+ def get_with_http_info(opts = {})
36
+ # resource path
37
+ local_var_path = '/activity-feed'
38
+
39
+ # query parameters
40
+ query_params = {}
41
+
42
+ # header parameters
43
+ header_params = {}
44
+ # HTTP header 'Accept' (if needed)
45
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
46
+ # HTTP header 'Content-Type'
47
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
48
+
49
+ # form parameters
50
+ form_params = {}
51
+
52
+ # http body (model)
53
+ post_body = nil
54
+ auth_names = ['basicAuth']
55
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
56
+ :header_params => header_params,
57
+ :query_params => query_params,
58
+ :form_params => form_params,
59
+ :body => post_body,
60
+ :auth_names => auth_names,
61
+ :return_type => 'ActivityFeedRoot')
62
+ return data, status_code, headers
63
+ end
64
+ # Chimp Chatter activity
65
+ # Return the Chimp Chatter for this account ordered by most recent
66
+ # @param [Hash] opts the optional parameters
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
+ # @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)
69
+ # @return [InlineResponse200]
70
+ def get_chimp_chatter(opts = {})
71
+ data, _status_code, _headers = get_chimp_chatter_with_http_info(opts)
72
+ data
73
+ end
74
+
75
+ # Chimp Chatter activity
76
+ # Return the Chimp Chatter for this account ordered by most recent
77
+ # @param [Hash] opts the optional parameters
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
+ # @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**.
80
+ # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
81
+ def get_chimp_chatter_with_http_info(opts = {})
82
+ # resource path
83
+ local_var_path = '/activity-feed/chimp-chatter'
84
+
85
+ # query parameters
86
+ query_params = {}
87
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
88
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
89
+
90
+ # header parameters
91
+ header_params = {}
92
+ # HTTP header 'Accept' (if needed)
93
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
94
+ # HTTP header 'Content-Type'
95
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
96
+
97
+ # form parameters
98
+ form_params = {}
99
+
100
+ # http body (model)
101
+ post_body = nil
102
+ auth_names = ['basicAuth']
103
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
104
+ :header_params => header_params,
105
+ :query_params => query_params,
106
+ :form_params => form_params,
107
+ :body => post_body,
108
+ :auth_names => auth_names,
109
+ :return_type => 'InlineResponse200')
110
+ return data, status_code, headers
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,171 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.1
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module MailchimpMarketing
16
+ class AuthorizedAppsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client)
20
+ @api_client = api_client
21
+ end
22
+ # Get a list of authorized apps
23
+ # Get a list of an account's registered, connected applications.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
26
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
27
+ # @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)
28
+ # @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)
29
+ # @return [InlineResponse2001]
30
+ def list(opts = {})
31
+ data, _status_code, _headers = list_with_http_info(opts)
32
+ data
33
+ end
34
+
35
+ # Get a list of authorized apps
36
+ # Get a list of an account&#39;s registered, connected applications.
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
39
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
40
+ # @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**
41
+ # @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**.
42
+ # @return [Array<(InlineResponse2001, Fixnum, Hash)>] InlineResponse2001 data, response status code and response headers
43
+ def list_with_http_info(opts = {})
44
+ # resource path
45
+ local_var_path = '/authorized-apps'
46
+
47
+ # query parameters
48
+ query_params = {}
49
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
50
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
51
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
52
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
53
+
54
+ # header parameters
55
+ header_params = {}
56
+ # HTTP header 'Accept' (if needed)
57
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
58
+ # HTTP header 'Content-Type'
59
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
60
+
61
+ # form parameters
62
+ form_params = {}
63
+
64
+ # http body (model)
65
+ post_body = nil
66
+ auth_names = ['basicAuth']
67
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
68
+ :header_params => header_params,
69
+ :query_params => query_params,
70
+ :form_params => form_params,
71
+ :body => post_body,
72
+ :auth_names => auth_names,
73
+ :return_type => 'InlineResponse2001')
74
+ return data, status_code, headers
75
+ end
76
+ # Get information about a specific authorized app
77
+ # Get information about a specific authorized application.
78
+ # @param app_id The unique id for the connected authorized application.
79
+ # @param [Hash] opts the optional parameters
80
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
81
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
82
+ # @return [InlineResponse2001Apps]
83
+ def get(app_id = {}, opts = {})
84
+ data, _status_code, _headers = get_with_http_info(app_id, opts)
85
+ data
86
+ end
87
+
88
+ # Get information about a specific authorized app
89
+ # Get information about a specific authorized application.
90
+ # @param app_id The unique id for the connected authorized application.
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
93
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
94
+ # @return [Array<(InlineResponse2001Apps, Fixnum, Hash)>] InlineResponse2001Apps data, response status code and response headers
95
+ def get_with_http_info(app_id, opts = {})
96
+ # resource path
97
+ local_var_path = '/authorized-apps/{app_id}'.sub('{' + 'app_id' + '}', app_id.to_s)
98
+
99
+ # query parameters
100
+ query_params = {}
101
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
102
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
103
+
104
+ # header parameters
105
+ header_params = {}
106
+ # HTTP header 'Accept' (if needed)
107
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
108
+ # HTTP header 'Content-Type'
109
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
110
+
111
+ # form parameters
112
+ form_params = {}
113
+
114
+ # http body (model)
115
+ post_body = nil
116
+ auth_names = ['basicAuth']
117
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
118
+ :header_params => header_params,
119
+ :query_params => query_params,
120
+ :form_params => form_params,
121
+ :body => post_body,
122
+ :auth_names => auth_names,
123
+ :return_type => 'InlineResponse2001Apps')
124
+ return data, status_code, headers
125
+ end
126
+ # Link your application
127
+ # Retrieve OAuth2-based credentials to associate API calls with your application.
128
+ # @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can&#39;t implement the OAuth2 flow but still want to associate calls with your application.
129
+ # @param [Hash] opts the optional parameters
130
+ # @return [InlineResponse2002]
131
+ def link(client_details = {}, opts = {})
132
+ data, _status_code, _headers = link_with_http_info(client_details, opts)
133
+ data
134
+ end
135
+
136
+ # Link your application
137
+ # Retrieve OAuth2-based credentials to associate API calls with your application.
138
+ # @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can&#39;t implement the OAuth2 flow but still want to associate calls with your application.
139
+ # @param [Hash] opts the optional parameters
140
+ # @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
141
+ def link_with_http_info(client_details, opts = {})
142
+ # resource path
143
+ local_var_path = '/authorized-apps'
144
+
145
+ # query parameters
146
+ query_params = {}
147
+
148
+ # header parameters
149
+ header_params = {}
150
+ # HTTP header 'Accept' (if needed)
151
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
152
+ # HTTP header 'Content-Type'
153
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
154
+
155
+ # form parameters
156
+ form_params = {}
157
+
158
+ # http body (model)
159
+ post_body = @api_client.object_to_http_body(client_details)
160
+ auth_names = ['basicAuth']
161
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
162
+ :header_params => header_params,
163
+ :query_params => query_params,
164
+ :form_params => form_params,
165
+ :body => post_body,
166
+ :auth_names => auth_names,
167
+ :return_type => 'InlineResponse2002')
168
+ return data, status_code, headers
169
+ end
170
+ end
171
+ end
@@ -0,0 +1,906 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.1
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module MailchimpMarketing
16
+ class AutomationsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client)
20
+ @api_client = api_client
21
+ end
22
+ # Archive an automation workflow.
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
+ # @param workflow_id The unique id for the Automation workflow.
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [nil]
27
+ def archive(workflow_id = {}, opts = {})
28
+ archive_with_http_info(workflow_id, opts)
29
+ nil
30
+ end
31
+
32
+ # Archive an automation workflow.
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
+ # @param workflow_id The unique id for the Automation workflow.
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
37
+ def archive_with_http_info(workflow_id, opts = {})
38
+ # resource path
39
+ local_var_path = '/automations/{workflow_id}/actions/archive'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
40
+
41
+ # query parameters
42
+ query_params = {}
43
+
44
+ # header parameters
45
+ header_params = {}
46
+ # HTTP header 'Accept' (if needed)
47
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
48
+ # HTTP header 'Content-Type'
49
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
50
+
51
+ # form parameters
52
+ form_params = {}
53
+
54
+ # http body (model)
55
+ post_body = nil
56
+ auth_names = ['basicAuth']
57
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
58
+ :header_params => header_params,
59
+ :query_params => query_params,
60
+ :form_params => form_params,
61
+ :body => post_body,
62
+ :auth_names => auth_names)
63
+ return data, status_code, headers
64
+ end
65
+ # Delete a workflow email
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
+ # @param workflow_id The unique id for the Automation workflow.
68
+ # @param workflow_email_id The unique id for the Automation workflow email.
69
+ # @param [Hash] opts the optional parameters
70
+ # @return [nil]
71
+ def delete_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
72
+ delete_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
73
+ nil
74
+ end
75
+
76
+ # Delete a workflow email
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
+ # @param workflow_id The unique id for the Automation workflow.
79
+ # @param workflow_email_id The unique id for the Automation workflow email.
80
+ # @param [Hash] opts the optional parameters
81
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
82
+ def delete_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
83
+ # resource path
84
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
85
+
86
+ # query parameters
87
+ query_params = {}
88
+
89
+ # header parameters
90
+ header_params = {}
91
+ # HTTP header 'Accept' (if needed)
92
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
93
+ # HTTP header 'Content-Type'
94
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
95
+
96
+ # form parameters
97
+ form_params = {}
98
+
99
+ # http body (model)
100
+ post_body = nil
101
+ auth_names = ['basicAuth']
102
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
103
+ :header_params => header_params,
104
+ :query_params => query_params,
105
+ :form_params => form_params,
106
+ :body => post_body,
107
+ :auth_names => auth_names)
108
+ return data, status_code, headers
109
+ end
110
+ # Get a list of Automations
111
+ # Get a summary of an account's Automations.
112
+ # @param [Hash] opts the optional parameters
113
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
114
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
115
+ # @option opts [DateTime] :before_create_time Restrict the response to automations created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
116
+ # @option opts [DateTime] :since_create_time Restrict the response to automations created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
117
+ # @option opts [DateTime] :before_send_time Restrict the response to automations sent before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
118
+ # @option opts [DateTime] :since_send_time Restrict the response to automations sent after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
119
+ # @option opts [String] :status Restrict the results to automations with the specified status.
120
+ # @return [InlineResponse2003]
121
+ def list(opts = {})
122
+ data, _status_code, _headers = list_with_http_info(opts)
123
+ data
124
+ end
125
+
126
+ # Get a list of Automations
127
+ # Get a summary of an account&#39;s Automations.
128
+ # @param [Hash] opts the optional parameters
129
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
130
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
131
+ # @option opts [DateTime] :before_create_time Restrict the response to automations created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
132
+ # @option opts [DateTime] :since_create_time Restrict the response to automations created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
133
+ # @option opts [DateTime] :before_send_time Restrict the response to automations sent before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
134
+ # @option opts [DateTime] :since_send_time Restrict the response to automations sent after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
135
+ # @option opts [String] :status Restrict the results to automations with the specified status.
136
+ # @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
137
+ def list_with_http_info(opts = {})
138
+ # resource path
139
+ local_var_path = '/automations'
140
+
141
+ # query parameters
142
+ query_params = {}
143
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
144
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
145
+ query_params[:'before_create_time'] = opts[:'before_create_time'] if !opts[:'before_create_time'].nil?
146
+ query_params[:'since_create_time'] = opts[:'since_create_time'] if !opts[:'since_create_time'].nil?
147
+ query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
148
+ query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
149
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
150
+
151
+ # header parameters
152
+ header_params = {}
153
+ # HTTP header 'Accept' (if needed)
154
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
155
+ # HTTP header 'Content-Type'
156
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
157
+
158
+ # form parameters
159
+ form_params = {}
160
+
161
+ # http body (model)
162
+ post_body = nil
163
+ auth_names = ['basicAuth']
164
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
165
+ :header_params => header_params,
166
+ :query_params => query_params,
167
+ :form_params => form_params,
168
+ :body => post_body,
169
+ :auth_names => auth_names,
170
+ :return_type => 'InlineResponse2003')
171
+ return data, status_code, headers
172
+ end
173
+ # Get information about a specific Automation workflow
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
+ # @param workflow_id The unique id for the Automation workflow.
176
+ # @param [Hash] opts the optional parameters
177
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
178
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
179
+ # @return [AutomationWorkflow]
180
+ def get(workflow_id = {}, opts = {})
181
+ data, _status_code, _headers = get_with_http_info(workflow_id, opts)
182
+ data
183
+ end
184
+
185
+ # Get information about a specific Automation workflow
186
+ # Get a summary of an individual Automation workflow&#39;s settings and content. The &#x60;trigger_settings&#x60; object returns information for the first email in the workflow.
187
+ # @param workflow_id The unique id for the Automation workflow.
188
+ # @param [Hash] opts the optional parameters
189
+ # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
190
+ # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
191
+ # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
192
+ def get_with_http_info(workflow_id, opts = {})
193
+ # resource path
194
+ local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
195
+
196
+ # query parameters
197
+ query_params = {}
198
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
199
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
200
+
201
+ # header parameters
202
+ header_params = {}
203
+ # HTTP header 'Accept' (if needed)
204
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
205
+ # HTTP header 'Content-Type'
206
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
207
+
208
+ # form parameters
209
+ form_params = {}
210
+
211
+ # http body (model)
212
+ post_body = nil
213
+ auth_names = ['basicAuth']
214
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
215
+ :header_params => header_params,
216
+ :query_params => query_params,
217
+ :form_params => form_params,
218
+ :body => post_body,
219
+ :auth_names => auth_names,
220
+ :return_type => 'AutomationWorkflow')
221
+ return data, status_code, headers
222
+ end
223
+ # Get a list of automated emails in a workflow
224
+ # Get a summary of the emails in an Automation workflow.
225
+ # @param workflow_id The unique id for the Automation workflow.
226
+ # @param [Hash] opts the optional parameters
227
+ # @return [AutomationEmails]
228
+ def list_all_workflow_emails(workflow_id = {}, opts = {})
229
+ data, _status_code, _headers = list_all_workflow_emails_with_http_info(workflow_id, opts)
230
+ data
231
+ end
232
+
233
+ # Get a list of automated emails in a workflow
234
+ # Get a summary of the emails in an Automation workflow.
235
+ # @param workflow_id The unique id for the Automation workflow.
236
+ # @param [Hash] opts the optional parameters
237
+ # @return [Array<(AutomationEmails, Fixnum, Hash)>] AutomationEmails data, response status code and response headers
238
+ def list_all_workflow_emails_with_http_info(workflow_id, opts = {})
239
+ # resource path
240
+ local_var_path = '/automations/{workflow_id}/emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
241
+
242
+ # query parameters
243
+ query_params = {}
244
+
245
+ # header parameters
246
+ header_params = {}
247
+ # HTTP header 'Accept' (if needed)
248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
249
+ # HTTP header 'Content-Type'
250
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
251
+
252
+ # form parameters
253
+ form_params = {}
254
+
255
+ # http body (model)
256
+ post_body = nil
257
+ auth_names = ['basicAuth']
258
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
259
+ :header_params => header_params,
260
+ :query_params => query_params,
261
+ :form_params => form_params,
262
+ :body => post_body,
263
+ :auth_names => auth_names,
264
+ :return_type => 'AutomationEmails')
265
+ return data, status_code, headers
266
+ end
267
+ # Get information about a specific workflow email
268
+ # Get information about an individual Automation workflow email.
269
+ # @param workflow_id The unique id for the Automation workflow.
270
+ # @param workflow_email_id The unique id for the Automation workflow email.
271
+ # @param [Hash] opts the optional parameters
272
+ # @return [AutomationWorkflowEmail]
273
+ def get_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
274
+ data, _status_code, _headers = get_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
275
+ data
276
+ end
277
+
278
+ # Get information about a specific workflow email
279
+ # Get information about an individual Automation workflow email.
280
+ # @param workflow_id The unique id for the Automation workflow.
281
+ # @param workflow_email_id The unique id for the Automation workflow email.
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [Array<(AutomationWorkflowEmail, Fixnum, Hash)>] AutomationWorkflowEmail data, response status code and response headers
284
+ def get_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
285
+ # resource path
286
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
287
+
288
+ # query parameters
289
+ query_params = {}
290
+
291
+ # header parameters
292
+ header_params = {}
293
+ # HTTP header 'Accept' (if needed)
294
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
295
+ # HTTP header 'Content-Type'
296
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
297
+
298
+ # form parameters
299
+ form_params = {}
300
+
301
+ # http body (model)
302
+ post_body = nil
303
+ auth_names = ['basicAuth']
304
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
305
+ :header_params => header_params,
306
+ :query_params => query_params,
307
+ :form_params => form_params,
308
+ :body => post_body,
309
+ :auth_names => auth_names,
310
+ :return_type => 'AutomationWorkflowEmail')
311
+ return data, status_code, headers
312
+ end
313
+ # View queued subscribers for an automated email
314
+ # Get information about an Automation email queue.
315
+ # @param workflow_id The unique id for the Automation workflow.
316
+ # @param workflow_email_id The unique id for the Automation workflow email.
317
+ # @param [Hash] opts the optional parameters
318
+ # @return [InlineResponse2004]
319
+ def get_workflow_email_subscriber_queue(workflow_id = {}, workflow_email_id = {}, opts = {})
320
+ data, _status_code, _headers = get_workflow_email_subscriber_queue_with_http_info(workflow_id, workflow_email_id, opts)
321
+ data
322
+ end
323
+
324
+ # View queued subscribers for an automated email
325
+ # Get information about an Automation email queue.
326
+ # @param workflow_id The unique id for the Automation workflow.
327
+ # @param workflow_email_id The unique id for the Automation workflow email.
328
+ # @param [Hash] opts the optional parameters
329
+ # @return [Array<(InlineResponse2004, Fixnum, Hash)>] InlineResponse2004 data, response status code and response headers
330
+ def get_workflow_email_subscriber_queue_with_http_info(workflow_id, workflow_email_id, opts = {})
331
+ # resource path
332
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/queue'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
333
+
334
+ # query parameters
335
+ query_params = {}
336
+
337
+ # header parameters
338
+ header_params = {}
339
+ # HTTP header 'Accept' (if needed)
340
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
341
+ # HTTP header 'Content-Type'
342
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
343
+
344
+ # form parameters
345
+ form_params = {}
346
+
347
+ # http body (model)
348
+ post_body = nil
349
+ auth_names = ['basicAuth']
350
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
351
+ :header_params => header_params,
352
+ :query_params => query_params,
353
+ :form_params => form_params,
354
+ :body => post_body,
355
+ :auth_names => auth_names,
356
+ :return_type => 'InlineResponse2004')
357
+ return data, status_code, headers
358
+ end
359
+ # View specific subscriber in email queue
360
+ # Get information about a specific subscriber in an Automation email queue.
361
+ # @param workflow_id The unique id for the Automation workflow.
362
+ # @param workflow_email_id The unique id for the Automation workflow email.
363
+ # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
364
+ # @param [Hash] opts the optional parameters
365
+ # @return [SubscriberInAutomationQueue2]
366
+ def get_workflow_email_subscriber(workflow_id = {}, workflow_email_id = {}, subscriber_hash = {}, opts = {})
367
+ data, _status_code, _headers = get_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, subscriber_hash, opts)
368
+ data
369
+ end
370
+
371
+ # View specific subscriber in email queue
372
+ # Get information about a specific subscriber in an Automation email queue.
373
+ # @param workflow_id The unique id for the Automation workflow.
374
+ # @param workflow_email_id The unique id for the Automation workflow email.
375
+ # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
376
+ # @param [Hash] opts the optional parameters
377
+ # @return [Array<(SubscriberInAutomationQueue2, Fixnum, Hash)>] SubscriberInAutomationQueue2 data, response status code and response headers
378
+ def get_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, subscriber_hash, opts = {})
379
+ # resource path
380
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
381
+
382
+ # query parameters
383
+ query_params = {}
384
+
385
+ # header parameters
386
+ header_params = {}
387
+ # HTTP header 'Accept' (if needed)
388
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
389
+ # HTTP header 'Content-Type'
390
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
391
+
392
+ # form parameters
393
+ form_params = {}
394
+
395
+ # http body (model)
396
+ post_body = nil
397
+ auth_names = ['basicAuth']
398
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
399
+ :header_params => header_params,
400
+ :query_params => query_params,
401
+ :form_params => form_params,
402
+ :body => post_body,
403
+ :auth_names => auth_names,
404
+ :return_type => 'SubscriberInAutomationQueue2')
405
+ return data, status_code, headers
406
+ end
407
+ # View all subscribers removed from a workflow
408
+ # Get information about subscribers who were [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
409
+ # @param workflow_id The unique id for the Automation workflow.
410
+ # @param [Hash] opts the optional parameters
411
+ # @return [RemovedSubscribers]
412
+ def list_workflow_email_subscribers_removed(workflow_id = {}, opts = {})
413
+ data, _status_code, _headers = list_workflow_email_subscribers_removed_with_http_info(workflow_id, opts)
414
+ data
415
+ end
416
+
417
+ # View all subscribers removed from a workflow
418
+ # Get information about subscribers who were [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
419
+ # @param workflow_id The unique id for the Automation workflow.
420
+ # @param [Hash] opts the optional parameters
421
+ # @return [Array<(RemovedSubscribers, Fixnum, Hash)>] RemovedSubscribers data, response status code and response headers
422
+ def list_workflow_email_subscribers_removed_with_http_info(workflow_id, opts = {})
423
+ # resource path
424
+ local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
425
+
426
+ # query parameters
427
+ query_params = {}
428
+
429
+ # header parameters
430
+ header_params = {}
431
+ # HTTP header 'Accept' (if needed)
432
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
433
+ # HTTP header 'Content-Type'
434
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
435
+
436
+ # form parameters
437
+ form_params = {}
438
+
439
+ # http body (model)
440
+ post_body = nil
441
+ auth_names = ['basicAuth']
442
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
443
+ :header_params => header_params,
444
+ :query_params => query_params,
445
+ :form_params => form_params,
446
+ :body => post_body,
447
+ :auth_names => auth_names,
448
+ :return_type => 'RemovedSubscribers')
449
+ return data, status_code, headers
450
+ end
451
+ # View a specific subscriber who was removed from a workflow
452
+ # Get information about a specific subscriber who was [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
453
+ # @param workflow_id The unique id for the Automation workflow.
454
+ # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
455
+ # @param [Hash] opts the optional parameters
456
+ # @return [SubscriberRemovedFromAutomationWorkflow]
457
+ def get_removed_workflow_email_subscriber(workflow_id = {}, subscriber_hash = {}, opts = {})
458
+ data, _status_code, _headers = get_removed_workflow_email_subscriber_with_http_info(workflow_id, subscriber_hash, opts)
459
+ data
460
+ end
461
+
462
+ # View a specific subscriber who was removed from a workflow
463
+ # Get information about a specific subscriber who was [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
464
+ # @param workflow_id The unique id for the Automation workflow.
465
+ # @param subscriber_hash The MD5 hash of the lowercase version of the list member&#39;s email address.
466
+ # @param [Hash] opts the optional parameters
467
+ # @return [Array<(SubscriberRemovedFromAutomationWorkflow, Fixnum, Hash)>] SubscriberRemovedFromAutomationWorkflow data, response status code and response headers
468
+ def get_removed_workflow_email_subscriber_with_http_info(workflow_id, subscriber_hash, opts = {})
469
+ # resource path
470
+ local_var_path = '/automations/{workflow_id}/removed-subscribers/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
471
+
472
+ # query parameters
473
+ query_params = {}
474
+
475
+ # header parameters
476
+ header_params = {}
477
+ # HTTP header 'Accept' (if needed)
478
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
479
+ # HTTP header 'Content-Type'
480
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
481
+
482
+ # form parameters
483
+ form_params = {}
484
+
485
+ # http body (model)
486
+ post_body = nil
487
+ auth_names = ['basicAuth']
488
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
489
+ :header_params => header_params,
490
+ :query_params => query_params,
491
+ :form_params => form_params,
492
+ :body => post_body,
493
+ :auth_names => auth_names,
494
+ :return_type => 'SubscriberRemovedFromAutomationWorkflow')
495
+ return data, status_code, headers
496
+ end
497
+ # Update an Automation workflow email
498
+ # Update settings for a Automation workflow email
499
+ # @param workflow_id The unique id for the Automation workflow.
500
+ # @param workflow_email_id The unique id for the Automation workflow email.
501
+ # @param body
502
+ # @param [Hash] opts the optional parameters
503
+ # @return [AutomationWorkflowEmail]
504
+ def update_workflow_email(workflow_id = {}, workflow_email_id = {}, body = {}, opts = {})
505
+ data, _status_code, _headers = update_workflow_email_with_http_info(workflow_id, workflow_email_id, body, opts)
506
+ data
507
+ end
508
+
509
+ # Update an Automation workflow email
510
+ # Update settings for a Automation workflow email
511
+ # @param workflow_id The unique id for the Automation workflow.
512
+ # @param workflow_email_id The unique id for the Automation workflow email.
513
+ # @param body
514
+ # @param [Hash] opts the optional parameters
515
+ # @return [Array<(AutomationWorkflowEmail, Fixnum, Hash)>] AutomationWorkflowEmail data, response status code and response headers
516
+ def update_workflow_email_with_http_info(workflow_id, workflow_email_id, body, opts = {})
517
+ # resource path
518
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
519
+
520
+ # query parameters
521
+ query_params = {}
522
+
523
+ # header parameters
524
+ header_params = {}
525
+ # HTTP header 'Accept' (if needed)
526
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
527
+ # HTTP header 'Content-Type'
528
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
529
+
530
+ # form parameters
531
+ form_params = {}
532
+
533
+ # http body (model)
534
+ post_body = @api_client.object_to_http_body(body)
535
+ auth_names = ['basicAuth']
536
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
537
+ :header_params => header_params,
538
+ :query_params => query_params,
539
+ :form_params => form_params,
540
+ :body => post_body,
541
+ :auth_names => auth_names,
542
+ :return_type => 'AutomationWorkflowEmail')
543
+ return data, status_code, headers
544
+ end
545
+ # Update an Automation
546
+ # Update some or all of the settings for a Automation
547
+ # @param workflow_id The unique id for the Automation workflow.
548
+ # @param body
549
+ # @param [Hash] opts the optional parameters
550
+ # @return [AutomationWorkflow]
551
+ def update(workflow_id = {}, body = {}, opts = {})
552
+ data, _status_code, _headers = update_with_http_info(workflow_id, body, opts)
553
+ data
554
+ end
555
+
556
+ # Update an Automation
557
+ # Update some or all of the settings for a Automation
558
+ # @param workflow_id The unique id for the Automation workflow.
559
+ # @param body
560
+ # @param [Hash] opts the optional parameters
561
+ # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
562
+ def update_with_http_info(workflow_id, body, opts = {})
563
+ # resource path
564
+ local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
565
+
566
+ # query parameters
567
+ query_params = {}
568
+
569
+ # header parameters
570
+ header_params = {}
571
+ # HTTP header 'Accept' (if needed)
572
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
573
+ # HTTP header 'Content-Type'
574
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
575
+
576
+ # form parameters
577
+ form_params = {}
578
+
579
+ # http body (model)
580
+ post_body = @api_client.object_to_http_body(body)
581
+ auth_names = ['basicAuth']
582
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
583
+ :header_params => header_params,
584
+ :query_params => query_params,
585
+ :form_params => form_params,
586
+ :body => post_body,
587
+ :auth_names => auth_names,
588
+ :return_type => 'AutomationWorkflow')
589
+ return data, status_code, headers
590
+ end
591
+ # Create a new Automation
592
+ # Create a new Automation in your Mailchimp account.
593
+ # @param body
594
+ # @param [Hash] opts the optional parameters
595
+ # @return [AutomationWorkflow]
596
+ def create(body = {}, opts = {})
597
+ data, _status_code, _headers = create_with_http_info(body, opts)
598
+ data
599
+ end
600
+
601
+ # Create a new Automation
602
+ # Create a new Automation in your Mailchimp account.
603
+ # @param body
604
+ # @param [Hash] opts the optional parameters
605
+ # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
606
+ def create_with_http_info(body, opts = {})
607
+ # resource path
608
+ local_var_path = '/automations'
609
+
610
+ # query parameters
611
+ query_params = {}
612
+
613
+ # header parameters
614
+ header_params = {}
615
+ # HTTP header 'Accept' (if needed)
616
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
617
+ # HTTP header 'Content-Type'
618
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
619
+
620
+ # form parameters
621
+ form_params = {}
622
+
623
+ # http body (model)
624
+ post_body = @api_client.object_to_http_body(body)
625
+ auth_names = ['basicAuth']
626
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
627
+ :header_params => header_params,
628
+ :query_params => query_params,
629
+ :form_params => form_params,
630
+ :body => post_body,
631
+ :auth_names => auth_names,
632
+ :return_type => 'AutomationWorkflow')
633
+ return data, status_code, headers
634
+ end
635
+ # Pause all emails in an Automation workflow
636
+ # Pause all emails in a specific Automation workflow.
637
+ # @param workflow_id The unique id for the Automation workflow.
638
+ # @param [Hash] opts the optional parameters
639
+ # @return [nil]
640
+ def pause_all_emails(workflow_id = {}, opts = {})
641
+ pause_all_emails_with_http_info(workflow_id, opts)
642
+ nil
643
+ end
644
+
645
+ # Pause all emails in an Automation workflow
646
+ # Pause all emails in a specific Automation workflow.
647
+ # @param workflow_id The unique id for the Automation workflow.
648
+ # @param [Hash] opts the optional parameters
649
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
650
+ def pause_all_emails_with_http_info(workflow_id, opts = {})
651
+ # resource path
652
+ local_var_path = '/automations/{workflow_id}/actions/pause-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
653
+
654
+ # query parameters
655
+ query_params = {}
656
+
657
+ # header parameters
658
+ header_params = {}
659
+ # HTTP header 'Accept' (if needed)
660
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
661
+ # HTTP header 'Content-Type'
662
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
663
+
664
+ # form parameters
665
+ form_params = {}
666
+
667
+ # http body (model)
668
+ post_body = nil
669
+ auth_names = ['basicAuth']
670
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
671
+ :header_params => header_params,
672
+ :query_params => query_params,
673
+ :form_params => form_params,
674
+ :body => post_body,
675
+ :auth_names => auth_names)
676
+ return data, status_code, headers
677
+ end
678
+ # Start all emails in an Automation workflow
679
+ # Start all emails in an Automation workflow.
680
+ # @param workflow_id The unique id for the Automation workflow.
681
+ # @param [Hash] opts the optional parameters
682
+ # @return [nil]
683
+ def start_all_emails(workflow_id = {}, opts = {})
684
+ start_all_emails_with_http_info(workflow_id, opts)
685
+ nil
686
+ end
687
+
688
+ # Start all emails in an Automation workflow
689
+ # Start all emails in an Automation workflow.
690
+ # @param workflow_id The unique id for the Automation workflow.
691
+ # @param [Hash] opts the optional parameters
692
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
693
+ def start_all_emails_with_http_info(workflow_id, opts = {})
694
+ # resource path
695
+ local_var_path = '/automations/{workflow_id}/actions/start-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
696
+
697
+ # query parameters
698
+ query_params = {}
699
+
700
+ # header parameters
701
+ header_params = {}
702
+ # HTTP header 'Accept' (if needed)
703
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
704
+ # HTTP header 'Content-Type'
705
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
706
+
707
+ # form parameters
708
+ form_params = {}
709
+
710
+ # http body (model)
711
+ post_body = nil
712
+ auth_names = ['basicAuth']
713
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
714
+ :header_params => header_params,
715
+ :query_params => query_params,
716
+ :form_params => form_params,
717
+ :body => post_body,
718
+ :auth_names => auth_names)
719
+ return data, status_code, headers
720
+ end
721
+ # Pause an automated email
722
+ # Pause an automated email.
723
+ # @param workflow_id The unique id for the Automation workflow.
724
+ # @param workflow_email_id The unique id for the Automation workflow email.
725
+ # @param [Hash] opts the optional parameters
726
+ # @return [nil]
727
+ def pause_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
728
+ pause_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
729
+ nil
730
+ end
731
+
732
+ # Pause an automated email
733
+ # Pause an automated email.
734
+ # @param workflow_id The unique id for the Automation workflow.
735
+ # @param workflow_email_id The unique id for the Automation workflow email.
736
+ # @param [Hash] opts the optional parameters
737
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
738
+ def pause_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
739
+ # resource path
740
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
741
+
742
+ # query parameters
743
+ query_params = {}
744
+
745
+ # header parameters
746
+ header_params = {}
747
+ # HTTP header 'Accept' (if needed)
748
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
749
+ # HTTP header 'Content-Type'
750
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
751
+
752
+ # form parameters
753
+ form_params = {}
754
+
755
+ # http body (model)
756
+ post_body = nil
757
+ auth_names = ['basicAuth']
758
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
759
+ :header_params => header_params,
760
+ :query_params => query_params,
761
+ :form_params => form_params,
762
+ :body => post_body,
763
+ :auth_names => auth_names)
764
+ return data, status_code, headers
765
+ end
766
+ # Start an automated email
767
+ # Start an automated email.
768
+ # @param workflow_id The unique id for the Automation workflow.
769
+ # @param workflow_email_id The unique id for the Automation workflow email.
770
+ # @param [Hash] opts the optional parameters
771
+ # @return [nil]
772
+ def start_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
773
+ start_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
774
+ nil
775
+ end
776
+
777
+ # Start an automated email
778
+ # Start an automated email.
779
+ # @param workflow_id The unique id for the Automation workflow.
780
+ # @param workflow_email_id The unique id for the Automation workflow email.
781
+ # @param [Hash] opts the optional parameters
782
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
783
+ def start_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
784
+ # resource path
785
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/actions/start'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
786
+
787
+ # query parameters
788
+ query_params = {}
789
+
790
+ # header parameters
791
+ header_params = {}
792
+ # HTTP header 'Accept' (if needed)
793
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
794
+ # HTTP header 'Content-Type'
795
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
796
+
797
+ # form parameters
798
+ form_params = {}
799
+
800
+ # http body (model)
801
+ post_body = nil
802
+ auth_names = ['basicAuth']
803
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
804
+ :header_params => header_params,
805
+ :query_params => query_params,
806
+ :form_params => form_params,
807
+ :body => post_body,
808
+ :auth_names => auth_names)
809
+ return data, status_code, headers
810
+ end
811
+ # Add a subscriber to a 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](https://mailchimp.com/help/automation-types/) or add subscribers to an automated email queue that uses the [API request delay type](https://mailchimp.com/help/automation-types/).
813
+ # @param workflow_id The unique id for the Automation workflow.
814
+ # @param workflow_email_id The unique id for the Automation workflow email.
815
+ # @param body
816
+ # @param [Hash] opts the optional parameters
817
+ # @return [SubscriberInAutomationQueue2]
818
+ def add_workflow_email_subscriber(workflow_id = {}, workflow_email_id = {}, body = {}, opts = {})
819
+ data, _status_code, _headers = add_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, body, opts)
820
+ data
821
+ end
822
+
823
+ # Add a subscriber to a 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](https://mailchimp.com/help/automation-types/) or add subscribers to an automated email queue that uses the [API request delay type](https://mailchimp.com/help/automation-types/).
825
+ # @param workflow_id The unique id for the Automation workflow.
826
+ # @param workflow_email_id The unique id for the Automation workflow email.
827
+ # @param body
828
+ # @param [Hash] opts the optional parameters
829
+ # @return [Array<(SubscriberInAutomationQueue2, Fixnum, Hash)>] SubscriberInAutomationQueue2 data, response status code and response headers
830
+ def add_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, body, opts = {})
831
+ # resource path
832
+ local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/queue'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s)
833
+
834
+ # query parameters
835
+ query_params = {}
836
+
837
+ # header parameters
838
+ header_params = {}
839
+ # HTTP header 'Accept' (if needed)
840
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
841
+ # HTTP header 'Content-Type'
842
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
843
+
844
+ # form parameters
845
+ form_params = {}
846
+
847
+ # http body (model)
848
+ post_body = @api_client.object_to_http_body(body)
849
+ auth_names = ['basicAuth']
850
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
851
+ :header_params => header_params,
852
+ :query_params => query_params,
853
+ :form_params => form_params,
854
+ :body => post_body,
855
+ :auth_names => auth_names,
856
+ :return_type => 'SubscriberInAutomationQueue2')
857
+ return data, status_code, headers
858
+ end
859
+ # Remove subscriber from a workflow
860
+ # [Remove a subscriber](https://mailchimp.com/help/manage-subscribers-in-an-automation/) 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
+ # @param workflow_id The unique id for the Automation workflow.
862
+ # @param body
863
+ # @param [Hash] opts the optional parameters
864
+ # @return [SubscriberRemovedFromAutomationWorkflow]
865
+ def remove_workflow_email_subscriber(workflow_id = {}, body = {}, opts = {})
866
+ data, _status_code, _headers = remove_workflow_email_subscriber_with_http_info(workflow_id, body, opts)
867
+ data
868
+ end
869
+
870
+ # Remove subscriber from a workflow
871
+ # [Remove a subscriber](https://mailchimp.com/help/manage-subscribers-in-an-automation/) from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they&#39;ve been sent from that workflow. Once they&#39;re removed, they can never be added back to the same workflow.
872
+ # @param workflow_id The unique id for the Automation workflow.
873
+ # @param body
874
+ # @param [Hash] opts the optional parameters
875
+ # @return [Array<(SubscriberRemovedFromAutomationWorkflow, Fixnum, Hash)>] SubscriberRemovedFromAutomationWorkflow data, response status code and response headers
876
+ def remove_workflow_email_subscriber_with_http_info(workflow_id, body, opts = {})
877
+ # resource path
878
+ local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
879
+
880
+ # query parameters
881
+ query_params = {}
882
+
883
+ # header parameters
884
+ header_params = {}
885
+ # HTTP header 'Accept' (if needed)
886
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
887
+ # HTTP header 'Content-Type'
888
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
889
+
890
+ # form parameters
891
+ form_params = {}
892
+
893
+ # http body (model)
894
+ post_body = @api_client.object_to_http_body(body)
895
+ auth_names = ['basicAuth']
896
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
897
+ :header_params => header_params,
898
+ :query_params => query_params,
899
+ :form_params => form_params,
900
+ :body => post_body,
901
+ :auth_names => auth_names,
902
+ :return_type => 'SubscriberRemovedFromAutomationWorkflow')
903
+ return data, status_code, headers
904
+ end
905
+ end
906
+ end