MailchimpMarketing 3.0.1 → 3.0.8

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 +4 -4
  2. data/Gemfile +1 -1
  3. data/MailchimpMarketing.gemspec +1 -1
  4. data/README.md +55 -46
  5. data/lib/MailchimpMarketing.rb +5 -6
  6. data/lib/MailchimpMarketing/api/activity_feed_api.rb +13 -69
  7. data/lib/MailchimpMarketing/api/authorized_apps_api.rb +20 -113
  8. data/lib/MailchimpMarketing/api/automations_api.rb +130 -685
  9. data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +33 -182
  10. data/lib/MailchimpMarketing/api/batches_api.rb +26 -146
  11. data/lib/MailchimpMarketing/api/campaign_folders_api.rb +33 -182
  12. data/lib/MailchimpMarketing/api/campaigns_api.rb +144 -803
  13. data/lib/MailchimpMarketing/api/connected_sites_api.rb +32 -179
  14. data/lib/MailchimpMarketing/api/conversations_api.rb +36 -205
  15. data/lib/MailchimpMarketing/api/dashboard_api.rb +32 -221
  16. data/lib/MailchimpMarketing/api/ecommerce_api.rb +447 -2312
  17. data/lib/MailchimpMarketing/api/external_auths_api.rb +20 -113
  18. data/lib/MailchimpMarketing/api/facebook_ads_api.rb +16 -83
  19. data/lib/MailchimpMarketing/api/file_manager_api.rb +71 -413
  20. data/lib/MailchimpMarketing/api/landing_pages_api.rb +51 -286
  21. data/lib/MailchimpMarketing/api/lists_api.rb +721 -2876
  22. data/lib/MailchimpMarketing/api/ping_api.rb +7 -33
  23. data/lib/MailchimpMarketing/api/postcards_api.rb +9 -41
  24. data/lib/MailchimpMarketing/api/reporting_api.rb +41 -237
  25. data/lib/MailchimpMarketing/api/reports_api.rb +153 -903
  26. data/lib/MailchimpMarketing/api/root_api.rb +7 -37
  27. data/lib/MailchimpMarketing/api/search_campaigns_api.rb +8 -39
  28. data/lib/MailchimpMarketing/api/search_members_api.rb +8 -41
  29. data/lib/MailchimpMarketing/api/template_folders_api.rb +33 -182
  30. data/lib/MailchimpMarketing/api/templates_api.rb +40 -234
  31. data/lib/MailchimpMarketing/api/verified_domains_api.rb +32 -170
  32. data/lib/MailchimpMarketing/api_client.rb +94 -64
  33. data/lib/MailchimpMarketing/api_error.rb +4 -4
  34. data/lib/MailchimpMarketing/configuration.rb +1 -1
  35. data/lib/MailchimpMarketing/version.rb +2 -2
  36. metadata +2 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 3.0.1
6
+ OpenAPI spec version: 3.0.8
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
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
11
11
  =end
12
12
 
13
13
  require 'uri'
14
+ require 'json'
14
15
 
15
16
  module MailchimpMarketing
16
17
  class PingApi
@@ -19,46 +20,19 @@ module MailchimpMarketing
19
20
  def initialize(api_client)
20
21
  @api_client = api_client
21
22
  end
22
- # Ping the API
23
- # A health check for the API that won't return any account-specific information.
24
- # @param [Hash] opts the optional parameters
25
- # @return [APIHealthStatus]
26
- def get(opts = {})
27
- data, _status_code, _headers = get_with_http_info(opts)
28
- data
29
- end
30
23
 
31
- # Ping the API
32
- # A health check for the API that won't return any account-specific information.
33
- # @param [Hash] opts the optional parameters
34
- # @return [Array<(APIHealthStatus, Fixnum, Hash)>] APIHealthStatus data, response status code and response headers
35
- def get_with_http_info(opts = {})
36
- # resource path
37
- local_var_path = '/ping'
24
+ # Ping
25
+ def get(opts = {})
38
26
 
39
- # query parameters
40
27
  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
28
  form_params = {}
51
-
52
- # http body (model)
53
29
  post_body = nil
54
- auth_names = ['basicAuth']
30
+
31
+ local_var_path = '/ping'
55
32
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
56
- :header_params => header_params,
57
33
  :query_params => query_params,
58
34
  :form_params => form_params,
59
- :body => post_body,
60
- :auth_names => auth_names,
61
- :return_type => 'APIHealthStatus')
35
+ :body => post_body)
62
36
  return data, status_code, headers
63
37
  end
64
38
  end
@@ -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.1
6
+ OpenAPI spec version: 3.0.8
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
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
11
11
  =end
12
12
 
13
13
  require 'uri'
14
+ require 'json'
14
15
 
15
16
  module MailchimpMarketing
16
17
  class PostcardsApi
@@ -19,58 +20,25 @@ module MailchimpMarketing
19
20
  def initialize(api_client)
20
21
  @api_client = api_client
21
22
  end
22
- # __summary__
23
- # Get all of a user's postcards.
24
- # @param [Hash] opts the optional parameters
25
- # @option opts [String] :sort_dir Determines the order direction for sorted results.
26
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
27
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
28
- # @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)
29
- # @return [InlineResponse2007]
30
- def get_all(opts = {})
31
- data, _status_code, _headers = get_all_with_http_info(opts)
32
- data
33
- end
34
23
 
35
- # __summary__
36
- # Get all of a user&#39;s postcards.
37
- # @param [Hash] opts the optional parameters
38
- # @option opts [String] :sort_dir Determines the order direction for sorted results.
39
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
40
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
41
- # @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**
42
- # @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers
43
- def get_all_with_http_info(opts = {})
44
- # resource path
45
- local_var_path = '/postcards'
24
+ # List postcards
25
+ def get_all(opts = {})
26
+ fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])
27
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
46
28
 
47
- # query parameters
48
29
  query_params = {}
49
30
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
50
31
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
51
32
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
52
33
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].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
34
  form_params = {}
63
-
64
- # http body (model)
65
35
  post_body = nil
66
- auth_names = ['basicAuth']
36
+
37
+ local_var_path = '/postcards'
67
38
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
68
- :header_params => header_params,
69
39
  :query_params => query_params,
70
40
  :form_params => form_params,
71
- :body => post_body,
72
- :auth_names => auth_names,
73
- :return_type => 'InlineResponse2007')
41
+ :body => post_body)
74
42
  return data, status_code, headers
75
43
  end
76
44
  end
@@ -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.1
6
+ OpenAPI spec version: 3.0.8
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
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
11
11
  =end
12
12
 
13
13
  require 'uri'
14
+ require 'json'
14
15
 
15
16
  module MailchimpMarketing
16
17
  class ReportingApi
@@ -19,78 +20,28 @@ module MailchimpMarketing
19
20
  def initialize(api_client)
20
21
  @api_client = api_client
21
22
  end
22
- # Get information about the reporting endpoint's resources
23
- # Get information about the reporting endpoint's resources
24
- # @param [Hash] opts the optional parameters
25
- # @return [Reporting]
26
- def info(opts = {})
27
- data, _status_code, _headers = info_with_http_info(opts)
28
- data
29
- end
30
23
 
31
- # Get information about the reporting endpoint&#39;s resources
32
- # Get information about the reporting endpoint&#39;s resources
33
- # @param [Hash] opts the optional parameters
34
- # @return [Array<(Reporting, Fixnum, Hash)>] Reporting data, response status code and response headers
35
- def info_with_http_info(opts = {})
36
- # resource path
37
- local_var_path = '/reporting'
24
+ # List reporting resources
25
+ def info(opts = {})
38
26
 
39
- # query parameters
40
27
  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
28
  form_params = {}
51
-
52
- # http body (model)
53
29
  post_body = nil
54
- auth_names = ['basicAuth']
30
+
31
+ local_var_path = '/reporting'
55
32
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
56
- :header_params => header_params,
57
33
  :query_params => query_params,
58
34
  :form_params => form_params,
59
- :body => post_body,
60
- :auth_names => auth_names,
61
- :return_type => 'Reporting')
35
+ :body => post_body)
62
36
  return data, status_code, headers
63
37
  end
64
- # __summary__
65
- # Get reports of Facebook Ads
66
- # @param [Hash] opts the optional parameters
67
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
68
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
69
- # @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)
70
- # @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)
71
- # @option opts [String] :sort_field Returns files sorted by the specified field.
72
- # @option opts [String] :sort_dir Determines the order direction for sorted results.
73
- # @return [InlineResponse20011]
74
- def get_facebook_ads_report_all(opts = {})
75
- data, _status_code, _headers = get_facebook_ads_report_all_with_http_info(opts)
76
- data
77
- end
78
38
 
79
- # __summary__
80
- # Get reports of Facebook Ads
81
- # @param [Hash] opts the optional parameters
82
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
83
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
84
- # @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**
85
- # @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**.
86
- # @option opts [String] :sort_field Returns files sorted by the specified field.
87
- # @option opts [String] :sort_dir Determines the order direction for sorted results.
88
- # @return [Array<(InlineResponse20011, Fixnum, Hash)>] InlineResponse20011 data, response status code and response headers
89
- def get_facebook_ads_report_all_with_http_info(opts = {})
90
- # resource path
91
- local_var_path = '/reporting/facebook-ads'
39
+ # List facebook ads reports
40
+ def get_facebook_ads_report_all(opts = {})
41
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
42
+ fail ArgumentError, 'invalid value for "sort_field", must be one of created_at, updated_at, end_time' if opts[:'sort_field'] && !['created_at', 'updated_at', 'end_time'].include?(opts[:'sort_field'])
43
+ fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])
92
44
 
93
- # query parameters
94
45
  query_params = {}
95
46
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
96
47
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
@@ -98,240 +49,93 @@ module MailchimpMarketing
98
49
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
99
50
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
100
51
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
101
-
102
- # header parameters
103
- header_params = {}
104
- # HTTP header 'Accept' (if needed)
105
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
106
- # HTTP header 'Content-Type'
107
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
108
-
109
- # form parameters
110
52
  form_params = {}
111
-
112
- # http body (model)
113
53
  post_body = nil
114
- auth_names = ['basicAuth']
54
+
55
+ local_var_path = '/reporting/facebook-ads'
115
56
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
116
- :header_params => header_params,
117
57
  :query_params => query_params,
118
58
  :form_params => form_params,
119
- :body => post_body,
120
- :auth_names => auth_names,
121
- :return_type => 'InlineResponse20011')
59
+ :body => post_body)
122
60
  return data, status_code, headers
123
61
  end
124
- # __summary__
125
- # Get report of a facebook ad
126
- # @param outreach_id The outreach id.
127
- # @param [Hash] opts the optional parameters
128
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
129
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
130
- # @return [InlineResponse20012]
131
- def get_facebook_ad_report(outreach_id = {}, opts = {})
132
- data, _status_code, _headers = get_facebook_ad_report_with_http_info(outreach_id, opts)
133
- data
134
- end
135
62
 
136
- # __summary__
137
- # Get report of a facebook ad
138
- # @param outreach_id The outreach id.
139
- # @param [Hash] opts the optional parameters
140
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
141
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
142
- # @return [Array<(InlineResponse20012, Fixnum, Hash)>] InlineResponse20012 data, response status code and response headers
143
- def get_facebook_ad_report_with_http_info(outreach_id, opts = {})
144
- # resource path
145
- local_var_path = '/reporting/facebook-ads/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
63
+ # Get facebook ad report
64
+ def get_facebook_ad_report(outreach_id, opts = {})
65
+ fail ArgumentError, "Missing required param: 'outreach_id'" if outreach_id.nil?
146
66
 
147
- # query parameters
148
67
  query_params = {}
149
68
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
150
69
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
151
-
152
- # header parameters
153
- header_params = {}
154
- # HTTP header 'Accept' (if needed)
155
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
156
- # HTTP header 'Content-Type'
157
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
158
-
159
- # form parameters
160
70
  form_params = {}
161
-
162
- # http body (model)
163
71
  post_body = nil
164
- auth_names = ['basicAuth']
72
+
73
+ local_var_path = '/reporting/facebook-ads/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
165
74
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
166
- :header_params => header_params,
167
75
  :query_params => query_params,
168
76
  :form_params => form_params,
169
- :body => post_body,
170
- :auth_names => auth_names,
171
- :return_type => 'InlineResponse20012')
77
+ :body => post_body)
172
78
  return data, status_code, headers
173
79
  end
174
- # __summary__
175
- # Get breakdown of product activity for an outreach
176
- # @param outreach_id The outreach id.
177
- # @param [Hash] opts the optional parameters
178
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
179
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
180
- # @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)
181
- # @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)
182
- # @option opts [String] :sort_field Returns files sorted by the specified field.
183
- # @return [InlineResponse2008]
184
- def get_facebook_ad_product_activity_report(outreach_id = {}, opts = {})
185
- data, _status_code, _headers = get_facebook_ad_product_activity_report_with_http_info(outreach_id, opts)
186
- data
187
- end
188
80
 
189
- # __summary__
190
- # Get breakdown of product activity for an outreach
191
- # @param outreach_id The outreach id.
192
- # @param [Hash] opts the optional parameters
193
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
194
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
195
- # @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**
196
- # @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**.
197
- # @option opts [String] :sort_field Returns files sorted by the specified field.
198
- # @return [Array<(InlineResponse2008, Fixnum, Hash)>] InlineResponse2008 data, response status code and response headers
199
- def get_facebook_ad_product_activity_report_with_http_info(outreach_id, opts = {})
200
- # resource path
201
- local_var_path = '/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
81
+ # List facebook ecommerce report
82
+ def get_facebook_ad_product_activity_report(outreach_id, opts = {})
83
+ fail ArgumentError, "Missing required param: 'outreach_id'" if outreach_id.nil?
84
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
85
+ 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'])
202
86
 
203
- # query parameters
204
87
  query_params = {}
205
88
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
206
89
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
207
90
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
208
91
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
209
92
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
210
-
211
- # header parameters
212
- header_params = {}
213
- # HTTP header 'Accept' (if needed)
214
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
215
- # HTTP header 'Content-Type'
216
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
217
-
218
- # form parameters
219
93
  form_params = {}
220
-
221
- # http body (model)
222
94
  post_body = nil
223
- auth_names = ['basicAuth']
95
+
96
+ local_var_path = '/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
224
97
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
225
- :header_params => header_params,
226
98
  :query_params => query_params,
227
99
  :form_params => form_params,
228
- :body => post_body,
229
- :auth_names => auth_names,
230
- :return_type => 'InlineResponse2008')
100
+ :body => post_body)
231
101
  return data, status_code, headers
232
102
  end
233
- # __summary__
234
- # Get reports of Landing Pages
235
- # @param [Hash] opts the optional parameters
236
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
237
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
238
- # @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)
239
- # @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)
240
- # @return [InlineResponse20013]
241
- def get_landing_page_reports_all(opts = {})
242
- data, _status_code, _headers = get_landing_page_reports_all_with_http_info(opts)
243
- data
244
- end
245
103
 
246
- # __summary__
247
- # Get reports of Landing Pages
248
- # @param [Hash] opts the optional parameters
249
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
250
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
251
- # @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**
252
- # @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**.
253
- # @return [Array<(InlineResponse20013, Fixnum, Hash)>] InlineResponse20013 data, response status code and response headers
254
- def get_landing_page_reports_all_with_http_info(opts = {})
255
- # resource path
256
- local_var_path = '/reporting/landing-pages'
104
+ # List landing pages reports
105
+ def get_landing_page_reports_all(opts = {})
106
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
257
107
 
258
- # query parameters
259
108
  query_params = {}
260
109
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
261
110
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
262
111
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
263
112
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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
113
  form_params = {}
274
-
275
- # http body (model)
276
114
  post_body = nil
277
- auth_names = ['basicAuth']
115
+
116
+ local_var_path = '/reporting/landing-pages'
278
117
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
279
- :header_params => header_params,
280
118
  :query_params => query_params,
281
119
  :form_params => form_params,
282
- :body => post_body,
283
- :auth_names => auth_names,
284
- :return_type => 'InlineResponse20013')
120
+ :body => post_body)
285
121
  return data, status_code, headers
286
122
  end
287
- # __summary__
288
- # Get report of a landing page
289
- # @param outreach_id The outreach id.
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
- # @return [LandingPageReport]
294
- def get_landing_page_report(outreach_id = {}, opts = {})
295
- data, _status_code, _headers = get_landing_page_report_with_http_info(outreach_id, opts)
296
- data
297
- end
298
123
 
299
- # __summary__
300
- # Get report of a landing page
301
- # @param outreach_id The outreach id.
302
- # @param [Hash] opts the optional parameters
303
- # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
304
- # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
305
- # @return [Array<(LandingPageReport, Fixnum, Hash)>] LandingPageReport data, response status code and response headers
306
- def get_landing_page_report_with_http_info(outreach_id, opts = {})
307
- # resource path
308
- local_var_path = '/reporting/landing-pages/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
124
+ # Get landing page report
125
+ def get_landing_page_report(outreach_id, opts = {})
126
+ fail ArgumentError, "Missing required param: 'outreach_id'" if outreach_id.nil?
309
127
 
310
- # query parameters
311
128
  query_params = {}
312
129
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
313
130
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
314
-
315
- # header parameters
316
- header_params = {}
317
- # HTTP header 'Accept' (if needed)
318
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
319
- # HTTP header 'Content-Type'
320
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
321
-
322
- # form parameters
323
131
  form_params = {}
324
-
325
- # http body (model)
326
132
  post_body = nil
327
- auth_names = ['basicAuth']
133
+
134
+ local_var_path = '/reporting/landing-pages/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
328
135
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
329
- :header_params => header_params,
330
136
  :query_params => query_params,
331
137
  :form_params => form_params,
332
- :body => post_body,
333
- :auth_names => auth_names,
334
- :return_type => 'LandingPageReport')
138
+ :body => post_body)
335
139
  return data, status_code, headers
336
140
  end
337
141
  end