MailchimpMarketing 3.0.5 → 3.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/MailchimpMarketing.gemspec +2 -2
- data/README.md +22 -26
- data/lib/MailchimpMarketing.rb +1 -1
- data/lib/MailchimpMarketing/api/activity_feed_api.rb +10 -71
- data/lib/MailchimpMarketing/api/authorized_apps_api.rb +16 -116
- data/lib/MailchimpMarketing/api/automations_api.rb +110 -704
- data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +27 -187
- data/lib/MailchimpMarketing/api/batches_api.rb +21 -150
- data/lib/MailchimpMarketing/api/campaign_folders_api.rb +27 -187
- data/lib/MailchimpMarketing/api/campaigns_api.rb +124 -828
- data/lib/MailchimpMarketing/api/connected_sites_api.rb +26 -184
- data/lib/MailchimpMarketing/api/conversations_api.rb +30 -210
- data/lib/MailchimpMarketing/api/dashboard_api.rb +25 -227
- data/lib/MailchimpMarketing/api/ecommerce_api.rb +387 -2371
- data/lib/MailchimpMarketing/api/external_auths_api.rb +16 -116
- data/lib/MailchimpMarketing/api/facebook_ads_api.rb +13 -85
- data/lib/MailchimpMarketing/api/file_manager_api.rb +59 -424
- data/lib/MailchimpMarketing/api/landing_pages_api.rb +44 -296
- data/lib/MailchimpMarketing/api/lists_api.rb +420 -2707
- data/lib/MailchimpMarketing/api/ping_api.rb +5 -34
- data/lib/MailchimpMarketing/api/postcards_api.rb +7 -42
- data/lib/MailchimpMarketing/api/reporting_api.rb +34 -243
- data/lib/MailchimpMarketing/api/reports_api.rb +130 -925
- data/lib/MailchimpMarketing/api/root_api.rb +5 -38
- data/lib/MailchimpMarketing/api/search_campaigns_api.rb +6 -40
- data/lib/MailchimpMarketing/api/search_members_api.rb +6 -42
- data/lib/MailchimpMarketing/api/template_folders_api.rb +27 -187
- data/lib/MailchimpMarketing/api/templates_api.rb +33 -240
- data/lib/MailchimpMarketing/api/verified_domains_api.rb +26 -175
- data/lib/MailchimpMarketing/api_client.rb +15 -161
- data/lib/MailchimpMarketing/api_error.rb +1 -1
- data/lib/MailchimpMarketing/configuration.rb +1 -1
- data/lib/MailchimpMarketing/version.rb +2 -2
- metadata +5 -11
@@ -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.10
|
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,38 +19,12 @@ module MailchimpMarketing
|
|
19
19
|
def initialize(api_client)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# List campaign reports
|
23
|
-
# Get campaign reports.
|
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
|
-
# @option opts [String] :type The campaign type.
|
30
|
-
# @option opts [DateTime] :before_send_time Restrict the response to campaigns 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.
|
31
|
-
# @option opts [DateTime] :since_send_time Restrict the response to campaigns 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.
|
32
|
-
# @return [CampaignReports1]
|
33
|
-
def get_all_campaign_reports(opts = {})
|
34
|
-
data, _status_code, _headers = get_all_campaign_reports_with_http_info(opts)
|
35
|
-
data
|
36
|
-
end
|
37
22
|
|
38
23
|
# List campaign reports
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
43
|
-
# @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**
|
44
|
-
# @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**.
|
45
|
-
# @option opts [String] :type The campaign type.
|
46
|
-
# @option opts [DateTime] :before_send_time Restrict the response to campaigns 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.
|
47
|
-
# @option opts [DateTime] :since_send_time Restrict the response to campaigns 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.
|
48
|
-
# @return [Array<(CampaignReports1, Fixnum, Hash)>] CampaignReports1 data, response status code and response headers
|
49
|
-
def get_all_campaign_reports_with_http_info(opts = {})
|
50
|
-
# resource path
|
51
|
-
local_var_path = '/reports'
|
24
|
+
def get_all_campaign_reports(opts = {})
|
25
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
26
|
+
fail ArgumentError, 'invalid value for "type", must be one of regular, plaintext, absplit, rss, variate' if opts[:'type'] && !['regular', 'plaintext', 'absplit', 'rss', 'variate'].include?(opts[:'type'])
|
52
27
|
|
53
|
-
# query parameters
|
54
28
|
query_params = {}
|
55
29
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
56
30
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
@@ -59,1155 +33,386 @@ module MailchimpMarketing
|
|
59
33
|
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
60
34
|
query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
|
61
35
|
query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
|
62
|
-
|
63
|
-
# header parameters
|
64
|
-
header_params = {}
|
65
|
-
# HTTP header 'Accept' (if needed)
|
66
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
67
|
-
# HTTP header 'Content-Type'
|
68
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
69
|
-
|
70
|
-
# form parameters
|
71
|
-
form_params = {}
|
72
|
-
|
73
|
-
# http body (model)
|
74
36
|
post_body = nil
|
75
|
-
|
37
|
+
|
38
|
+
local_var_path = '/reports'
|
76
39
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
77
|
-
:header_params => header_params,
|
78
40
|
:query_params => query_params,
|
79
|
-
:
|
80
|
-
:body => post_body,
|
81
|
-
:auth_names => auth_names,
|
82
|
-
:return_type => 'CampaignReports1')
|
41
|
+
:body => post_body)
|
83
42
|
return data, status_code, headers
|
84
43
|
end
|
85
|
-
# Get campaign report
|
86
|
-
# Get report details for a specific sent campaign.
|
87
|
-
# @param campaign_id The unique id for the campaign.
|
88
|
-
# @param [Hash] opts the optional parameters
|
89
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
90
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
91
|
-
# @return [CampaignReport]
|
92
|
-
def get_campaign_report(campaign_id = {}, opts = {})
|
93
|
-
data, _status_code, _headers = get_campaign_report_with_http_info(campaign_id, opts)
|
94
|
-
data
|
95
|
-
end
|
96
44
|
|
97
45
|
# Get campaign report
|
98
|
-
|
99
|
-
|
100
|
-
# @param [Hash] opts the optional parameters
|
101
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
102
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
103
|
-
# @return [Array<(CampaignReport, Fixnum, Hash)>] CampaignReport data, response status code and response headers
|
104
|
-
def get_campaign_report_with_http_info(campaign_id, opts = {})
|
105
|
-
# resource path
|
106
|
-
local_var_path = '/reports/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
46
|
+
def get_campaign_report(campaign_id, opts = {})
|
47
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
107
48
|
|
108
|
-
# query parameters
|
109
49
|
query_params = {}
|
110
50
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
111
51
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
112
|
-
|
113
|
-
# header parameters
|
114
|
-
header_params = {}
|
115
|
-
# HTTP header 'Accept' (if needed)
|
116
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
117
|
-
# HTTP header 'Content-Type'
|
118
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
119
|
-
|
120
|
-
# form parameters
|
121
|
-
form_params = {}
|
122
|
-
|
123
|
-
# http body (model)
|
124
52
|
post_body = nil
|
125
|
-
|
53
|
+
|
54
|
+
local_var_path = '/reports/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
126
55
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
127
|
-
:header_params => header_params,
|
128
56
|
:query_params => query_params,
|
129
|
-
:
|
130
|
-
:body => post_body,
|
131
|
-
:auth_names => auth_names,
|
132
|
-
:return_type => 'CampaignReport')
|
57
|
+
:body => post_body)
|
133
58
|
return data, status_code, headers
|
134
59
|
end
|
135
|
-
# List abuse reports
|
136
|
-
# Get a list of abuse complaints for a specific campaign.
|
137
|
-
# @param campaign_id The unique id for the campaign.
|
138
|
-
# @param [Hash] opts the optional parameters
|
139
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
140
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
141
|
-
# @return [AbuseComplaints1]
|
142
|
-
def get_campaign_abuse_reports(campaign_id = {}, opts = {})
|
143
|
-
data, _status_code, _headers = get_campaign_abuse_reports_with_http_info(campaign_id, opts)
|
144
|
-
data
|
145
|
-
end
|
146
60
|
|
147
61
|
# List abuse reports
|
148
|
-
|
149
|
-
|
150
|
-
# @param [Hash] opts the optional parameters
|
151
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
152
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
153
|
-
# @return [Array<(AbuseComplaints1, Fixnum, Hash)>] AbuseComplaints1 data, response status code and response headers
|
154
|
-
def get_campaign_abuse_reports_with_http_info(campaign_id, opts = {})
|
155
|
-
# resource path
|
156
|
-
local_var_path = '/reports/{campaign_id}/abuse-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
62
|
+
def get_campaign_abuse_reports(campaign_id, opts = {})
|
63
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
157
64
|
|
158
|
-
# query parameters
|
159
65
|
query_params = {}
|
160
66
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
161
67
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
162
|
-
|
163
|
-
# header parameters
|
164
|
-
header_params = {}
|
165
|
-
# HTTP header 'Accept' (if needed)
|
166
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
167
|
-
# HTTP header 'Content-Type'
|
168
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
169
|
-
|
170
|
-
# form parameters
|
171
|
-
form_params = {}
|
172
|
-
|
173
|
-
# http body (model)
|
174
68
|
post_body = nil
|
175
|
-
|
69
|
+
|
70
|
+
local_var_path = '/reports/{campaign_id}/abuse-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
176
71
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
177
|
-
:header_params => header_params,
|
178
72
|
:query_params => query_params,
|
179
|
-
:
|
180
|
-
:body => post_body,
|
181
|
-
:auth_names => auth_names,
|
182
|
-
:return_type => 'AbuseComplaints1')
|
73
|
+
:body => post_body)
|
183
74
|
return data, status_code, headers
|
184
75
|
end
|
185
|
-
# Get abuse report
|
186
|
-
# Get information about a specific abuse report for a campaign.
|
187
|
-
# @param campaign_id The unique id for the campaign.
|
188
|
-
# @param report_id The id for the abuse report.
|
189
|
-
# @param [Hash] opts the optional parameters
|
190
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
191
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
192
|
-
# @return [AbuseComplaint1]
|
193
|
-
def get_campaign_abuse_report(campaign_id = {}, report_id = {}, opts = {})
|
194
|
-
data, _status_code, _headers = get_campaign_abuse_report_with_http_info(campaign_id, report_id, opts)
|
195
|
-
data
|
196
|
-
end
|
197
76
|
|
198
77
|
# Get abuse report
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
# @param [Hash] opts the optional parameters
|
203
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
204
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
205
|
-
# @return [Array<(AbuseComplaint1, Fixnum, Hash)>] AbuseComplaint1 data, response status code and response headers
|
206
|
-
def get_campaign_abuse_report_with_http_info(campaign_id, report_id, opts = {})
|
207
|
-
# resource path
|
208
|
-
local_var_path = '/reports/{campaign_id}/abuse-reports/{report_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'report_id' + '}', report_id.to_s)
|
78
|
+
def get_campaign_abuse_report(campaign_id, report_id, opts = {})
|
79
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
80
|
+
fail ArgumentError, "Missing required param: 'report_id'" if report_id.nil?
|
209
81
|
|
210
|
-
# query parameters
|
211
82
|
query_params = {}
|
212
83
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
213
84
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
214
|
-
|
215
|
-
# header parameters
|
216
|
-
header_params = {}
|
217
|
-
# HTTP header 'Accept' (if needed)
|
218
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
219
|
-
# HTTP header 'Content-Type'
|
220
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
221
|
-
|
222
|
-
# form parameters
|
223
|
-
form_params = {}
|
224
|
-
|
225
|
-
# http body (model)
|
226
85
|
post_body = nil
|
227
|
-
|
86
|
+
|
87
|
+
local_var_path = '/reports/{campaign_id}/abuse-reports/{report_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'report_id' + '}', report_id.to_s)
|
228
88
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
229
|
-
:header_params => header_params,
|
230
89
|
:query_params => query_params,
|
231
|
-
:
|
232
|
-
:body => post_body,
|
233
|
-
:auth_names => auth_names,
|
234
|
-
:return_type => 'AbuseComplaint1')
|
90
|
+
:body => post_body)
|
235
91
|
return data, status_code, headers
|
236
92
|
end
|
237
|
-
# List campaign feedback
|
238
|
-
# Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
|
239
|
-
# @param campaign_id The unique id for the campaign.
|
240
|
-
# @param [Hash] opts the optional parameters
|
241
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
242
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
243
|
-
# @return [CampaignAdviceReport]
|
244
|
-
def get_campaign_advice(campaign_id = {}, opts = {})
|
245
|
-
data, _status_code, _headers = get_campaign_advice_with_http_info(campaign_id, opts)
|
246
|
-
data
|
247
|
-
end
|
248
93
|
|
249
94
|
# List campaign feedback
|
250
|
-
|
251
|
-
|
252
|
-
# @param [Hash] opts the optional parameters
|
253
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
254
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
255
|
-
# @return [Array<(CampaignAdviceReport, Fixnum, Hash)>] CampaignAdviceReport data, response status code and response headers
|
256
|
-
def get_campaign_advice_with_http_info(campaign_id, opts = {})
|
257
|
-
# resource path
|
258
|
-
local_var_path = '/reports/{campaign_id}/advice'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
95
|
+
def get_campaign_advice(campaign_id, opts = {})
|
96
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
259
97
|
|
260
|
-
# query parameters
|
261
98
|
query_params = {}
|
262
99
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
263
100
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
264
|
-
|
265
|
-
# header parameters
|
266
|
-
header_params = {}
|
267
|
-
# HTTP header 'Accept' (if needed)
|
268
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
269
|
-
# HTTP header 'Content-Type'
|
270
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
271
|
-
|
272
|
-
# form parameters
|
273
|
-
form_params = {}
|
274
|
-
|
275
|
-
# http body (model)
|
276
101
|
post_body = nil
|
277
|
-
|
102
|
+
|
103
|
+
local_var_path = '/reports/{campaign_id}/advice'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
278
104
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
279
|
-
:header_params => header_params,
|
280
105
|
:query_params => query_params,
|
281
|
-
:
|
282
|
-
:body => post_body,
|
283
|
-
:auth_names => auth_names,
|
284
|
-
:return_type => 'CampaignAdviceReport')
|
106
|
+
:body => post_body)
|
285
107
|
return data, status_code, headers
|
286
108
|
end
|
287
|
-
# List campaign details
|
288
|
-
# Get information about clicks on specific links in your Mailchimp campaigns.
|
289
|
-
# @param campaign_id The unique id for the campaign.
|
290
|
-
# @param [Hash] opts the optional parameters
|
291
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
292
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
293
|
-
# @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)
|
294
|
-
# @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)
|
295
|
-
# @return [ClickDetailReport]
|
296
|
-
def get_campaign_click_details(campaign_id = {}, opts = {})
|
297
|
-
data, _status_code, _headers = get_campaign_click_details_with_http_info(campaign_id, opts)
|
298
|
-
data
|
299
|
-
end
|
300
109
|
|
301
110
|
# List campaign details
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
306
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
307
|
-
# @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**
|
308
|
-
# @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**.
|
309
|
-
# @return [Array<(ClickDetailReport, Fixnum, Hash)>] ClickDetailReport data, response status code and response headers
|
310
|
-
def get_campaign_click_details_with_http_info(campaign_id, opts = {})
|
311
|
-
# resource path
|
312
|
-
local_var_path = '/reports/{campaign_id}/click-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
111
|
+
def get_campaign_click_details(campaign_id, opts = {})
|
112
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
113
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
313
114
|
|
314
|
-
# query parameters
|
315
115
|
query_params = {}
|
316
116
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
317
117
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
318
118
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
319
119
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
320
|
-
|
321
|
-
# header parameters
|
322
|
-
header_params = {}
|
323
|
-
# HTTP header 'Accept' (if needed)
|
324
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
325
|
-
# HTTP header 'Content-Type'
|
326
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
327
|
-
|
328
|
-
# form parameters
|
329
|
-
form_params = {}
|
330
|
-
|
331
|
-
# http body (model)
|
332
120
|
post_body = nil
|
333
|
-
|
121
|
+
|
122
|
+
local_var_path = '/reports/{campaign_id}/click-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
334
123
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
335
|
-
:header_params => header_params,
|
336
124
|
:query_params => query_params,
|
337
|
-
:
|
338
|
-
:body => post_body,
|
339
|
-
:auth_names => auth_names,
|
340
|
-
:return_type => 'ClickDetailReport')
|
125
|
+
:body => post_body)
|
341
126
|
return data, status_code, headers
|
342
127
|
end
|
343
|
-
# Get campaign link details
|
344
|
-
# Get click details for a specific link in a campaign.
|
345
|
-
# @param campaign_id The unique id for the campaign.
|
346
|
-
# @param link_id The id for the link.
|
347
|
-
# @param [Hash] opts the optional parameters
|
348
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
349
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
350
|
-
# @return [ClickDetailReport]
|
351
|
-
def get_campaign_click_details_for_link(campaign_id = {}, link_id = {}, opts = {})
|
352
|
-
data, _status_code, _headers = get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, opts)
|
353
|
-
data
|
354
|
-
end
|
355
128
|
|
356
129
|
# Get campaign link details
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
# @param [Hash] opts the optional parameters
|
361
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
362
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
363
|
-
# @return [Array<(ClickDetailReport, Fixnum, Hash)>] ClickDetailReport data, response status code and response headers
|
364
|
-
def get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, opts = {})
|
365
|
-
# resource path
|
366
|
-
local_var_path = '/reports/{campaign_id}/click-details/{link_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
|
130
|
+
def get_campaign_click_details_for_link(campaign_id, link_id, opts = {})
|
131
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
132
|
+
fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?
|
367
133
|
|
368
|
-
# query parameters
|
369
134
|
query_params = {}
|
370
135
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
371
136
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
372
|
-
|
373
|
-
# header parameters
|
374
|
-
header_params = {}
|
375
|
-
# HTTP header 'Accept' (if needed)
|
376
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
377
|
-
# HTTP header 'Content-Type'
|
378
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
379
|
-
|
380
|
-
# form parameters
|
381
|
-
form_params = {}
|
382
|
-
|
383
|
-
# http body (model)
|
384
137
|
post_body = nil
|
385
|
-
|
138
|
+
|
139
|
+
local_var_path = '/reports/{campaign_id}/click-details/{link_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
|
386
140
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
387
|
-
:header_params => header_params,
|
388
141
|
:query_params => query_params,
|
389
|
-
:
|
390
|
-
:body => post_body,
|
391
|
-
:auth_names => auth_names,
|
392
|
-
:return_type => 'ClickDetailReport')
|
142
|
+
:body => post_body)
|
393
143
|
return data, status_code, headers
|
394
144
|
end
|
395
|
-
# List clicked link subscribers
|
396
|
-
# Get information about list members who clicked on a specific link in a campaign.
|
397
|
-
# @param campaign_id The unique id for the campaign.
|
398
|
-
# @param link_id The id for the link.
|
399
|
-
# @param [Hash] opts the optional parameters
|
400
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
401
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
402
|
-
# @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)
|
403
|
-
# @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)
|
404
|
-
# @return [ClickDetailMembers]
|
405
|
-
def get_subscribers_info(campaign_id = {}, link_id = {}, opts = {})
|
406
|
-
data, _status_code, _headers = get_subscribers_info_with_http_info(campaign_id, link_id, opts)
|
407
|
-
data
|
408
|
-
end
|
409
145
|
|
410
146
|
# List clicked link subscribers
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
416
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
417
|
-
# @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**
|
418
|
-
# @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**.
|
419
|
-
# @return [Array<(ClickDetailMembers, Fixnum, Hash)>] ClickDetailMembers data, response status code and response headers
|
420
|
-
def get_subscribers_info_with_http_info(campaign_id, link_id, opts = {})
|
421
|
-
# resource path
|
422
|
-
local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
|
147
|
+
def get_subscribers_info(campaign_id, link_id, opts = {})
|
148
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
149
|
+
fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?
|
150
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
423
151
|
|
424
|
-
# query parameters
|
425
152
|
query_params = {}
|
426
153
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
427
154
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
428
155
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
429
156
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
430
|
-
|
431
|
-
# header parameters
|
432
|
-
header_params = {}
|
433
|
-
# HTTP header 'Accept' (if needed)
|
434
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
435
|
-
# HTTP header 'Content-Type'
|
436
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
437
|
-
|
438
|
-
# form parameters
|
439
|
-
form_params = {}
|
440
|
-
|
441
|
-
# http body (model)
|
442
157
|
post_body = nil
|
443
|
-
|
158
|
+
|
159
|
+
local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
|
444
160
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
445
|
-
:header_params => header_params,
|
446
161
|
:query_params => query_params,
|
447
|
-
:
|
448
|
-
:body => post_body,
|
449
|
-
:auth_names => auth_names,
|
450
|
-
:return_type => 'ClickDetailMembers')
|
162
|
+
:body => post_body)
|
451
163
|
return data, status_code, headers
|
452
164
|
end
|
453
|
-
# Get clicked link subscriber
|
454
|
-
# Get information about a specific subscriber who clicked a link in a specific campaign.
|
455
|
-
# @param campaign_id The unique id for the campaign.
|
456
|
-
# @param link_id The id for the link.
|
457
|
-
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
458
|
-
# @param [Hash] opts the optional parameters
|
459
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
460
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
461
|
-
# @return [ClickDetailMember]
|
462
|
-
def get_subscriber_info(campaign_id = {}, link_id = {}, subscriber_hash = {}, opts = {})
|
463
|
-
data, _status_code, _headers = get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, opts)
|
464
|
-
data
|
465
|
-
end
|
466
165
|
|
467
166
|
# Get clicked link subscriber
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
# @param [Hash] opts the optional parameters
|
473
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
474
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
475
|
-
# @return [Array<(ClickDetailMember, Fixnum, Hash)>] ClickDetailMember data, response status code and response headers
|
476
|
-
def get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, opts = {})
|
477
|
-
# resource path
|
478
|
-
local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
167
|
+
def get_subscriber_info(campaign_id, link_id, subscriber_hash, opts = {})
|
168
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
169
|
+
fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?
|
170
|
+
fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
|
479
171
|
|
480
|
-
# query parameters
|
481
172
|
query_params = {}
|
482
173
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
483
174
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
484
|
-
|
485
|
-
# header parameters
|
486
|
-
header_params = {}
|
487
|
-
# HTTP header 'Accept' (if needed)
|
488
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
489
|
-
# HTTP header 'Content-Type'
|
490
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
491
|
-
|
492
|
-
# form parameters
|
493
|
-
form_params = {}
|
494
|
-
|
495
|
-
# http body (model)
|
496
175
|
post_body = nil
|
497
|
-
|
176
|
+
|
177
|
+
local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
498
178
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
499
|
-
:header_params => header_params,
|
500
179
|
:query_params => query_params,
|
501
|
-
:
|
502
|
-
:body => post_body,
|
503
|
-
:auth_names => auth_names,
|
504
|
-
:return_type => 'ClickDetailMember')
|
180
|
+
:body => post_body)
|
505
181
|
return data, status_code, headers
|
506
182
|
end
|
507
|
-
# List domain performance stats
|
508
|
-
# Get statistics for the top-performing email domains in a campaign.
|
509
|
-
# @param campaign_id The unique id for the campaign.
|
510
|
-
# @param [Hash] opts the optional parameters
|
511
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
512
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
513
|
-
# @return [DomainPerformance]
|
514
|
-
def get_domain_performance_for_campaign(campaign_id = {}, opts = {})
|
515
|
-
data, _status_code, _headers = get_domain_performance_for_campaign_with_http_info(campaign_id, opts)
|
516
|
-
data
|
517
|
-
end
|
518
183
|
|
519
184
|
# List domain performance stats
|
520
|
-
|
521
|
-
|
522
|
-
# @param [Hash] opts the optional parameters
|
523
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
524
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
525
|
-
# @return [Array<(DomainPerformance, Fixnum, Hash)>] DomainPerformance data, response status code and response headers
|
526
|
-
def get_domain_performance_for_campaign_with_http_info(campaign_id, opts = {})
|
527
|
-
# resource path
|
528
|
-
local_var_path = '/reports/{campaign_id}/domain-performance'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
185
|
+
def get_domain_performance_for_campaign(campaign_id, opts = {})
|
186
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
529
187
|
|
530
|
-
# query parameters
|
531
188
|
query_params = {}
|
532
189
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
533
190
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
534
|
-
|
535
|
-
# header parameters
|
536
|
-
header_params = {}
|
537
|
-
# HTTP header 'Accept' (if needed)
|
538
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
539
|
-
# HTTP header 'Content-Type'
|
540
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
541
|
-
|
542
|
-
# form parameters
|
543
|
-
form_params = {}
|
544
|
-
|
545
|
-
# http body (model)
|
546
191
|
post_body = nil
|
547
|
-
|
192
|
+
|
193
|
+
local_var_path = '/reports/{campaign_id}/domain-performance'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
548
194
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
549
|
-
:header_params => header_params,
|
550
195
|
:query_params => query_params,
|
551
|
-
:
|
552
|
-
:body => post_body,
|
553
|
-
:auth_names => auth_names,
|
554
|
-
:return_type => 'DomainPerformance')
|
196
|
+
:body => post_body)
|
555
197
|
return data, status_code, headers
|
556
198
|
end
|
557
|
-
# List campaign product activity
|
558
|
-
# Get breakdown of product activity for a campaign
|
559
|
-
# @param campaign_id The unique id for the campaign.
|
560
|
-
# @param [Hash] opts the optional parameters
|
561
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
562
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
563
|
-
# @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)
|
564
|
-
# @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)
|
565
|
-
# @option opts [String] :sort_field Returns files sorted by the specified field.
|
566
|
-
# @return [InlineResponse2008]
|
567
|
-
def get_ecommerce_product_activity_for_campaign(campaign_id = {}, opts = {})
|
568
|
-
data, _status_code, _headers = get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, opts)
|
569
|
-
data
|
570
|
-
end
|
571
199
|
|
572
200
|
# List campaign product activity
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
578
|
-
# @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**
|
579
|
-
# @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**.
|
580
|
-
# @option opts [String] :sort_field Returns files sorted by the specified field.
|
581
|
-
# @return [Array<(InlineResponse2008, Fixnum, Hash)>] InlineResponse2008 data, response status code and response headers
|
582
|
-
def get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, opts = {})
|
583
|
-
# resource path
|
584
|
-
local_var_path = '/reports/{campaign_id}/ecommerce-product-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
201
|
+
def get_ecommerce_product_activity_for_campaign(campaign_id, opts = {})
|
202
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
203
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
204
|
+
fail ArgumentError, 'invalid value for "sort_field", must be one of title, total_revenue, total_purchased' if opts[:'sort_field'] && !['title', 'total_revenue', 'total_purchased'].include?(opts[:'sort_field'])
|
585
205
|
|
586
|
-
# query parameters
|
587
206
|
query_params = {}
|
588
207
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
589
208
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
590
209
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
591
210
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
592
211
|
query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
|
593
|
-
|
594
|
-
# header parameters
|
595
|
-
header_params = {}
|
596
|
-
# HTTP header 'Accept' (if needed)
|
597
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
598
|
-
# HTTP header 'Content-Type'
|
599
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
600
|
-
|
601
|
-
# form parameters
|
602
|
-
form_params = {}
|
603
|
-
|
604
|
-
# http body (model)
|
605
212
|
post_body = nil
|
606
|
-
|
213
|
+
|
214
|
+
local_var_path = '/reports/{campaign_id}/ecommerce-product-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
607
215
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
608
|
-
:header_params => header_params,
|
609
216
|
:query_params => query_params,
|
610
|
-
:
|
611
|
-
:body => post_body,
|
612
|
-
:auth_names => auth_names,
|
613
|
-
:return_type => 'InlineResponse2008')
|
217
|
+
:body => post_body)
|
614
218
|
return data, status_code, headers
|
615
219
|
end
|
616
|
-
# List eep url activity
|
617
|
-
# Get a summary of social activity for the campaign, tracked by EepURL.
|
618
|
-
# @param campaign_id The unique id for the campaign.
|
619
|
-
# @param [Hash] opts the optional parameters
|
620
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
621
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
622
|
-
# @return [EepurlActivity]
|
623
|
-
def get_eepurl_activity_for_campaign(campaign_id = {}, opts = {})
|
624
|
-
data, _status_code, _headers = get_eepurl_activity_for_campaign_with_http_info(campaign_id, opts)
|
625
|
-
data
|
626
|
-
end
|
627
220
|
|
628
221
|
# List eep url activity
|
629
|
-
|
630
|
-
|
631
|
-
# @param [Hash] opts the optional parameters
|
632
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
633
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
634
|
-
# @return [Array<(EepurlActivity, Fixnum, Hash)>] EepurlActivity data, response status code and response headers
|
635
|
-
def get_eepurl_activity_for_campaign_with_http_info(campaign_id, opts = {})
|
636
|
-
# resource path
|
637
|
-
local_var_path = '/reports/{campaign_id}/eepurl'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
222
|
+
def get_eepurl_activity_for_campaign(campaign_id, opts = {})
|
223
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
638
224
|
|
639
|
-
# query parameters
|
640
225
|
query_params = {}
|
641
226
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
642
227
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
643
|
-
|
644
|
-
# header parameters
|
645
|
-
header_params = {}
|
646
|
-
# HTTP header 'Accept' (if needed)
|
647
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
648
|
-
# HTTP header 'Content-Type'
|
649
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
650
|
-
|
651
|
-
# form parameters
|
652
|
-
form_params = {}
|
653
|
-
|
654
|
-
# http body (model)
|
655
228
|
post_body = nil
|
656
|
-
|
229
|
+
|
230
|
+
local_var_path = '/reports/{campaign_id}/eepurl'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
657
231
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
658
|
-
:header_params => header_params,
|
659
232
|
:query_params => query_params,
|
660
|
-
:
|
661
|
-
:body => post_body,
|
662
|
-
:auth_names => auth_names,
|
663
|
-
:return_type => 'EepurlActivity')
|
233
|
+
:body => post_body)
|
664
234
|
return data, status_code, headers
|
665
235
|
end
|
666
|
-
# List email activity
|
667
|
-
# Get a list of member's subscriber activity in a specific campaign.
|
668
|
-
# @param campaign_id The unique id for the campaign.
|
669
|
-
# @param [Hash] opts the optional parameters
|
670
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
671
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
672
|
-
# @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)
|
673
|
-
# @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)
|
674
|
-
# @option opts [String] :since Restrict results to email activity events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
675
|
-
# @return [EmailActivity]
|
676
|
-
def get_email_activity_for_campaign(campaign_id = {}, opts = {})
|
677
|
-
data, _status_code, _headers = get_email_activity_for_campaign_with_http_info(campaign_id, opts)
|
678
|
-
data
|
679
|
-
end
|
680
236
|
|
681
237
|
# List email activity
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
686
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
687
|
-
# @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**
|
688
|
-
# @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**.
|
689
|
-
# @option opts [String] :since Restrict results to email activity events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
690
|
-
# @return [Array<(EmailActivity, Fixnum, Hash)>] EmailActivity data, response status code and response headers
|
691
|
-
def get_email_activity_for_campaign_with_http_info(campaign_id, opts = {})
|
692
|
-
# resource path
|
693
|
-
local_var_path = '/reports/{campaign_id}/email-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
238
|
+
def get_email_activity_for_campaign(campaign_id, opts = {})
|
239
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
240
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
694
241
|
|
695
|
-
# query parameters
|
696
242
|
query_params = {}
|
697
243
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
698
244
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
699
245
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
700
246
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
701
247
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
702
|
-
|
703
|
-
# header parameters
|
704
|
-
header_params = {}
|
705
|
-
# HTTP header 'Accept' (if needed)
|
706
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
707
|
-
# HTTP header 'Content-Type'
|
708
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
709
|
-
|
710
|
-
# form parameters
|
711
|
-
form_params = {}
|
712
|
-
|
713
|
-
# http body (model)
|
714
248
|
post_body = nil
|
715
|
-
|
249
|
+
|
250
|
+
local_var_path = '/reports/{campaign_id}/email-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
716
251
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
717
|
-
:header_params => header_params,
|
718
252
|
:query_params => query_params,
|
719
|
-
:
|
720
|
-
:body => post_body,
|
721
|
-
:auth_names => auth_names,
|
722
|
-
:return_type => 'EmailActivity')
|
253
|
+
:body => post_body)
|
723
254
|
return data, status_code, headers
|
724
255
|
end
|
725
|
-
# Get subscriber email activity
|
726
|
-
# Get a specific list member's activity in a campaign including opens, clicks, and bounces.
|
727
|
-
# @param campaign_id The unique id for the campaign.
|
728
|
-
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
729
|
-
# @param [Hash] opts the optional parameters
|
730
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
731
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
732
|
-
# @option opts [String] :since Restrict results to email activity events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
733
|
-
# @return [EmailActivity]
|
734
|
-
def get_email_activity_for_subscriber(campaign_id = {}, subscriber_hash = {}, opts = {})
|
735
|
-
data, _status_code, _headers = get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, opts)
|
736
|
-
data
|
737
|
-
end
|
738
256
|
|
739
257
|
# Get subscriber email activity
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
# @param [Hash] opts the optional parameters
|
744
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
745
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
746
|
-
# @option opts [String] :since Restrict results to email activity events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
747
|
-
# @return [Array<(EmailActivity, Fixnum, Hash)>] EmailActivity data, response status code and response headers
|
748
|
-
def get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, opts = {})
|
749
|
-
# resource path
|
750
|
-
local_var_path = '/reports/{campaign_id}/email-activity/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
258
|
+
def get_email_activity_for_subscriber(campaign_id, subscriber_hash, opts = {})
|
259
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
260
|
+
fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
|
751
261
|
|
752
|
-
# query parameters
|
753
262
|
query_params = {}
|
754
263
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
755
264
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
756
265
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
757
|
-
|
758
|
-
# header parameters
|
759
|
-
header_params = {}
|
760
|
-
# HTTP header 'Accept' (if needed)
|
761
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
762
|
-
# HTTP header 'Content-Type'
|
763
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
764
|
-
|
765
|
-
# form parameters
|
766
|
-
form_params = {}
|
767
|
-
|
768
|
-
# http body (model)
|
769
266
|
post_body = nil
|
770
|
-
|
267
|
+
|
268
|
+
local_var_path = '/reports/{campaign_id}/email-activity/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
771
269
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
772
|
-
:header_params => header_params,
|
773
270
|
:query_params => query_params,
|
774
|
-
:
|
775
|
-
:body => post_body,
|
776
|
-
:auth_names => auth_names,
|
777
|
-
:return_type => 'EmailActivity')
|
271
|
+
:body => post_body)
|
778
272
|
return data, status_code, headers
|
779
273
|
end
|
780
|
-
# List top open activities
|
781
|
-
# Get top open locations for a specific campaign.
|
782
|
-
# @param campaign_id The unique id for the campaign.
|
783
|
-
# @param [Hash] opts the optional parameters
|
784
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
785
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
786
|
-
# @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)
|
787
|
-
# @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)
|
788
|
-
# @return [OpenLocations]
|
789
|
-
def get_locations_for_campaign(campaign_id = {}, opts = {})
|
790
|
-
data, _status_code, _headers = get_locations_for_campaign_with_http_info(campaign_id, opts)
|
791
|
-
data
|
792
|
-
end
|
793
274
|
|
794
275
|
# List top open activities
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
799
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
800
|
-
# @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**
|
801
|
-
# @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**.
|
802
|
-
# @return [Array<(OpenLocations, Fixnum, Hash)>] OpenLocations data, response status code and response headers
|
803
|
-
def get_locations_for_campaign_with_http_info(campaign_id, opts = {})
|
804
|
-
# resource path
|
805
|
-
local_var_path = '/reports/{campaign_id}/locations'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
276
|
+
def get_locations_for_campaign(campaign_id, opts = {})
|
277
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
278
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
806
279
|
|
807
|
-
# query parameters
|
808
280
|
query_params = {}
|
809
281
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
810
282
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
811
283
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
812
284
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
813
|
-
|
814
|
-
# header parameters
|
815
|
-
header_params = {}
|
816
|
-
# HTTP header 'Accept' (if needed)
|
817
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
818
|
-
# HTTP header 'Content-Type'
|
819
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
820
|
-
|
821
|
-
# form parameters
|
822
|
-
form_params = {}
|
823
|
-
|
824
|
-
# http body (model)
|
825
285
|
post_body = nil
|
826
|
-
|
286
|
+
|
287
|
+
local_var_path = '/reports/{campaign_id}/locations'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
827
288
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
828
|
-
:header_params => header_params,
|
829
289
|
:query_params => query_params,
|
830
|
-
:
|
831
|
-
:body => post_body,
|
832
|
-
:auth_names => auth_names,
|
833
|
-
:return_type => 'OpenLocations')
|
290
|
+
:body => post_body)
|
834
291
|
return data, status_code, headers
|
835
292
|
end
|
836
|
-
# List campaign open details
|
837
|
-
# Get detailed information about any campaign emails that were opened by a list member.
|
838
|
-
# @param campaign_id The unique id for the campaign.
|
839
|
-
# @param [Hash] opts the optional parameters
|
840
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
841
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
842
|
-
# @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)
|
843
|
-
# @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)
|
844
|
-
# @option opts [String] :since Restrict results to campaign open events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
845
|
-
# @return [OpenDetailReport]
|
846
|
-
def get_campaign_open_details(campaign_id = {}, opts = {})
|
847
|
-
data, _status_code, _headers = get_campaign_open_details_with_http_info(campaign_id, opts)
|
848
|
-
data
|
849
|
-
end
|
850
293
|
|
851
294
|
# List campaign open details
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
856
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
857
|
-
# @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**
|
858
|
-
# @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**.
|
859
|
-
# @option opts [String] :since Restrict results to campaign open events that occur after a specific time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
860
|
-
# @return [Array<(OpenDetailReport, Fixnum, Hash)>] OpenDetailReport data, response status code and response headers
|
861
|
-
def get_campaign_open_details_with_http_info(campaign_id, opts = {})
|
862
|
-
# resource path
|
863
|
-
local_var_path = '/reports/{campaign_id}/open-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
295
|
+
def get_campaign_open_details(campaign_id, opts = {})
|
296
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
297
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
864
298
|
|
865
|
-
# query parameters
|
866
299
|
query_params = {}
|
867
300
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
868
301
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
869
302
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
870
303
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
871
304
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
872
|
-
|
873
|
-
# header parameters
|
874
|
-
header_params = {}
|
875
|
-
# HTTP header 'Accept' (if needed)
|
876
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
877
|
-
# HTTP header 'Content-Type'
|
878
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
879
|
-
|
880
|
-
# form parameters
|
881
|
-
form_params = {}
|
882
|
-
|
883
|
-
# http body (model)
|
884
305
|
post_body = nil
|
885
|
-
|
306
|
+
|
307
|
+
local_var_path = '/reports/{campaign_id}/open-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
886
308
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
887
|
-
:header_params => header_params,
|
888
309
|
:query_params => query_params,
|
889
|
-
:
|
890
|
-
:body => post_body,
|
891
|
-
:auth_names => auth_names,
|
892
|
-
:return_type => 'OpenDetailReport')
|
310
|
+
:body => post_body)
|
893
311
|
return data, status_code, headers
|
894
312
|
end
|
895
|
-
# Get opened campaign subscriber
|
896
|
-
# Get information about a specific subscriber who opened a campaign.
|
897
|
-
# @param campaign_id The unique id for the campaign.
|
898
|
-
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
899
|
-
# @param [Hash] opts the optional parameters
|
900
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
901
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
902
|
-
# @return [OpenActivity]
|
903
|
-
def get_subscriber_info_for_opened_campaign(campaign_id = {}, subscriber_hash = {}, opts = {})
|
904
|
-
data, _status_code, _headers = get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, opts)
|
905
|
-
data
|
906
|
-
end
|
907
313
|
|
908
314
|
# Get opened campaign subscriber
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
# @param [Hash] opts the optional parameters
|
913
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
914
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
915
|
-
# @return [Array<(OpenActivity, Fixnum, Hash)>] OpenActivity data, response status code and response headers
|
916
|
-
def get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, opts = {})
|
917
|
-
# resource path
|
918
|
-
local_var_path = '/reports/{campaign_id}/open-details/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
315
|
+
def get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, opts = {})
|
316
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
317
|
+
fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
|
919
318
|
|
920
|
-
# query parameters
|
921
319
|
query_params = {}
|
922
320
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
923
321
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
924
|
-
|
925
|
-
# header parameters
|
926
|
-
header_params = {}
|
927
|
-
# HTTP header 'Accept' (if needed)
|
928
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
929
|
-
# HTTP header 'Content-Type'
|
930
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
931
|
-
|
932
|
-
# form parameters
|
933
|
-
form_params = {}
|
934
|
-
|
935
|
-
# http body (model)
|
936
322
|
post_body = nil
|
937
|
-
|
323
|
+
|
324
|
+
local_var_path = '/reports/{campaign_id}/open-details/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
938
325
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
939
|
-
:header_params => header_params,
|
940
326
|
:query_params => query_params,
|
941
|
-
:
|
942
|
-
:body => post_body,
|
943
|
-
:auth_names => auth_names,
|
944
|
-
:return_type => 'OpenActivity')
|
327
|
+
:body => post_body)
|
945
328
|
return data, status_code, headers
|
946
329
|
end
|
947
|
-
# List campaign recipients
|
948
|
-
# Get information about campaign recipients.
|
949
|
-
# @param campaign_id The unique id for the campaign.
|
950
|
-
# @param [Hash] opts the optional parameters
|
951
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
952
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
953
|
-
# @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)
|
954
|
-
# @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)
|
955
|
-
# @return [SentTo]
|
956
|
-
def get_campaign_recipients(campaign_id = {}, opts = {})
|
957
|
-
data, _status_code, _headers = get_campaign_recipients_with_http_info(campaign_id, opts)
|
958
|
-
data
|
959
|
-
end
|
960
330
|
|
961
331
|
# List campaign recipients
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
966
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
967
|
-
# @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**
|
968
|
-
# @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**.
|
969
|
-
# @return [Array<(SentTo, Fixnum, Hash)>] SentTo data, response status code and response headers
|
970
|
-
def get_campaign_recipients_with_http_info(campaign_id, opts = {})
|
971
|
-
# resource path
|
972
|
-
local_var_path = '/reports/{campaign_id}/sent-to'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
332
|
+
def get_campaign_recipients(campaign_id, opts = {})
|
333
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
334
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
973
335
|
|
974
|
-
# query parameters
|
975
336
|
query_params = {}
|
976
337
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
977
338
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
978
339
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
979
340
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
980
|
-
|
981
|
-
# header parameters
|
982
|
-
header_params = {}
|
983
|
-
# HTTP header 'Accept' (if needed)
|
984
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
985
|
-
# HTTP header 'Content-Type'
|
986
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
987
|
-
|
988
|
-
# form parameters
|
989
|
-
form_params = {}
|
990
|
-
|
991
|
-
# http body (model)
|
992
341
|
post_body = nil
|
993
|
-
|
342
|
+
|
343
|
+
local_var_path = '/reports/{campaign_id}/sent-to'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
994
344
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
995
|
-
:header_params => header_params,
|
996
345
|
:query_params => query_params,
|
997
|
-
:
|
998
|
-
:body => post_body,
|
999
|
-
:auth_names => auth_names,
|
1000
|
-
:return_type => 'SentTo')
|
346
|
+
:body => post_body)
|
1001
347
|
return data, status_code, headers
|
1002
348
|
end
|
1003
|
-
# Get campaign recipient info
|
1004
|
-
# Get information about a specific campaign recipient.
|
1005
|
-
# @param campaign_id The unique id for the campaign.
|
1006
|
-
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
1007
|
-
# @param [Hash] opts the optional parameters
|
1008
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1009
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1010
|
-
# @return [SentTo]
|
1011
|
-
def get_campaign_recipient(campaign_id = {}, subscriber_hash = {}, opts = {})
|
1012
|
-
data, _status_code, _headers = get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, opts)
|
1013
|
-
data
|
1014
|
-
end
|
1015
349
|
|
1016
350
|
# Get campaign recipient info
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
# @param [Hash] opts the optional parameters
|
1021
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1022
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1023
|
-
# @return [Array<(SentTo, Fixnum, Hash)>] SentTo data, response status code and response headers
|
1024
|
-
def get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, opts = {})
|
1025
|
-
# resource path
|
1026
|
-
local_var_path = '/reports/{campaign_id}/sent-to/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
351
|
+
def get_campaign_recipient(campaign_id, subscriber_hash, opts = {})
|
352
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
353
|
+
fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
|
1027
354
|
|
1028
|
-
# query parameters
|
1029
355
|
query_params = {}
|
1030
356
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
1031
357
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
1032
|
-
|
1033
|
-
# header parameters
|
1034
|
-
header_params = {}
|
1035
|
-
# HTTP header 'Accept' (if needed)
|
1036
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
1037
|
-
# HTTP header 'Content-Type'
|
1038
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1039
|
-
|
1040
|
-
# form parameters
|
1041
|
-
form_params = {}
|
1042
|
-
|
1043
|
-
# http body (model)
|
1044
358
|
post_body = nil
|
1045
|
-
|
359
|
+
|
360
|
+
local_var_path = '/reports/{campaign_id}/sent-to/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
1046
361
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1047
|
-
:header_params => header_params,
|
1048
362
|
:query_params => query_params,
|
1049
|
-
:
|
1050
|
-
:body => post_body,
|
1051
|
-
:auth_names => auth_names,
|
1052
|
-
:return_type => 'SentTo')
|
363
|
+
:body => post_body)
|
1053
364
|
return data, status_code, headers
|
1054
365
|
end
|
1055
|
-
# List child campaign reports
|
1056
|
-
# Get a list of reports with child campaigns for a specific parent campaign.
|
1057
|
-
# @param campaign_id The unique id for the campaign.
|
1058
|
-
# @param [Hash] opts the optional parameters
|
1059
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1060
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1061
|
-
# @return [CampaignSubReports]
|
1062
|
-
def get_sub_reports_for_campaign(campaign_id = {}, opts = {})
|
1063
|
-
data, _status_code, _headers = get_sub_reports_for_campaign_with_http_info(campaign_id, opts)
|
1064
|
-
data
|
1065
|
-
end
|
1066
366
|
|
1067
367
|
# List child campaign reports
|
1068
|
-
|
1069
|
-
|
1070
|
-
# @param [Hash] opts the optional parameters
|
1071
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1072
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1073
|
-
# @return [Array<(CampaignSubReports, Fixnum, Hash)>] CampaignSubReports data, response status code and response headers
|
1074
|
-
def get_sub_reports_for_campaign_with_http_info(campaign_id, opts = {})
|
1075
|
-
# resource path
|
1076
|
-
local_var_path = '/reports/{campaign_id}/sub-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
368
|
+
def get_sub_reports_for_campaign(campaign_id, opts = {})
|
369
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
1077
370
|
|
1078
|
-
# query parameters
|
1079
371
|
query_params = {}
|
1080
372
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
1081
373
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
1082
|
-
|
1083
|
-
# header parameters
|
1084
|
-
header_params = {}
|
1085
|
-
# HTTP header 'Accept' (if needed)
|
1086
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
1087
|
-
# HTTP header 'Content-Type'
|
1088
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1089
|
-
|
1090
|
-
# form parameters
|
1091
|
-
form_params = {}
|
1092
|
-
|
1093
|
-
# http body (model)
|
1094
374
|
post_body = nil
|
1095
|
-
|
375
|
+
|
376
|
+
local_var_path = '/reports/{campaign_id}/sub-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
1096
377
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1097
|
-
:header_params => header_params,
|
1098
378
|
:query_params => query_params,
|
1099
|
-
:
|
1100
|
-
:body => post_body,
|
1101
|
-
:auth_names => auth_names,
|
1102
|
-
:return_type => 'CampaignSubReports')
|
379
|
+
:body => post_body)
|
1103
380
|
return data, status_code, headers
|
1104
381
|
end
|
1105
|
-
# List unsubscribed members
|
1106
|
-
# Get information about members who have unsubscribed from a specific campaign.
|
1107
|
-
# @param campaign_id The unique id for the campaign.
|
1108
|
-
# @param [Hash] opts the optional parameters
|
1109
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1110
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1111
|
-
# @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)
|
1112
|
-
# @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)
|
1113
|
-
# @return [Unsubscribes]
|
1114
|
-
def get_unsubscribed_list_for_campaign(campaign_id = {}, opts = {})
|
1115
|
-
data, _status_code, _headers = get_unsubscribed_list_for_campaign_with_http_info(campaign_id, opts)
|
1116
|
-
data
|
1117
|
-
end
|
1118
382
|
|
1119
383
|
# List unsubscribed members
|
1120
|
-
|
1121
|
-
|
1122
|
-
|
1123
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1124
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1125
|
-
# @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**
|
1126
|
-
# @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**.
|
1127
|
-
# @return [Array<(Unsubscribes, Fixnum, Hash)>] Unsubscribes data, response status code and response headers
|
1128
|
-
def get_unsubscribed_list_for_campaign_with_http_info(campaign_id, opts = {})
|
1129
|
-
# resource path
|
1130
|
-
local_var_path = '/reports/{campaign_id}/unsubscribed'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
384
|
+
def get_unsubscribed_list_for_campaign(campaign_id, opts = {})
|
385
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
386
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
1131
387
|
|
1132
|
-
# query parameters
|
1133
388
|
query_params = {}
|
1134
389
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
1135
390
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
1136
391
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
1137
392
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
1138
|
-
|
1139
|
-
# header parameters
|
1140
|
-
header_params = {}
|
1141
|
-
# HTTP header 'Accept' (if needed)
|
1142
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
1143
|
-
# HTTP header 'Content-Type'
|
1144
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1145
|
-
|
1146
|
-
# form parameters
|
1147
|
-
form_params = {}
|
1148
|
-
|
1149
|
-
# http body (model)
|
1150
393
|
post_body = nil
|
1151
|
-
|
394
|
+
|
395
|
+
local_var_path = '/reports/{campaign_id}/unsubscribed'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
|
1152
396
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1153
|
-
:header_params => header_params,
|
1154
397
|
:query_params => query_params,
|
1155
|
-
:
|
1156
|
-
:body => post_body,
|
1157
|
-
:auth_names => auth_names,
|
1158
|
-
:return_type => 'Unsubscribes')
|
398
|
+
:body => post_body)
|
1159
399
|
return data, status_code, headers
|
1160
400
|
end
|
1161
|
-
# Get unsubscribed member
|
1162
|
-
# Get information about a specific list member who unsubscribed from a campaign.
|
1163
|
-
# @param campaign_id The unique id for the campaign.
|
1164
|
-
# @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
|
1165
|
-
# @param [Hash] opts the optional parameters
|
1166
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1167
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1168
|
-
# @return [Unsubscribes]
|
1169
|
-
def get_unsubscribed_list_member(campaign_id = {}, subscriber_hash = {}, opts = {})
|
1170
|
-
data, _status_code, _headers = get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, opts)
|
1171
|
-
data
|
1172
|
-
end
|
1173
401
|
|
1174
402
|
# Get unsubscribed member
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
# @param [Hash] opts the optional parameters
|
1179
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
1180
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
1181
|
-
# @return [Array<(Unsubscribes, Fixnum, Hash)>] Unsubscribes data, response status code and response headers
|
1182
|
-
def get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, opts = {})
|
1183
|
-
# resource path
|
1184
|
-
local_var_path = '/reports/{campaign_id}/unsubscribed/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
403
|
+
def get_unsubscribed_list_member(campaign_id, subscriber_hash, opts = {})
|
404
|
+
fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
|
405
|
+
fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
|
1185
406
|
|
1186
|
-
# query parameters
|
1187
407
|
query_params = {}
|
1188
408
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
1189
409
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
1190
|
-
|
1191
|
-
# header parameters
|
1192
|
-
header_params = {}
|
1193
|
-
# HTTP header 'Accept' (if needed)
|
1194
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
1195
|
-
# HTTP header 'Content-Type'
|
1196
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1197
|
-
|
1198
|
-
# form parameters
|
1199
|
-
form_params = {}
|
1200
|
-
|
1201
|
-
# http body (model)
|
1202
410
|
post_body = nil
|
1203
|
-
|
411
|
+
|
412
|
+
local_var_path = '/reports/{campaign_id}/unsubscribed/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
|
1204
413
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1205
|
-
:header_params => header_params,
|
1206
414
|
:query_params => query_params,
|
1207
|
-
:
|
1208
|
-
:body => post_body,
|
1209
|
-
:auth_names => auth_names,
|
1210
|
-
:return_type => 'Unsubscribes')
|
415
|
+
:body => post_body)
|
1211
416
|
return data, status_code, headers
|
1212
417
|
end
|
1213
418
|
end
|