MailchimpMarketing 3.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/MailchimpMarketing.gemspec +45 -0
  4. data/README.md +378 -0
  5. data/lib/MailchimpMarketing.rb +162 -0
  6. data/lib/MailchimpMarketing/api/activity_feed_api.rb +57 -0
  7. data/lib/MailchimpMarketing/api/authorized_apps_api.rb +78 -0
  8. data/lib/MailchimpMarketing/api/automations_api.rb +351 -0
  9. data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +111 -0
  10. data/lib/MailchimpMarketing/api/batches_api.rb +94 -0
  11. data/lib/MailchimpMarketing/api/campaign_folders_api.rb +111 -0
  12. data/lib/MailchimpMarketing/api/campaigns_api.rb +414 -0
  13. data/lib/MailchimpMarketing/api/connected_sites_api.rb +110 -0
  14. data/lib/MailchimpMarketing/api/conversations_api.rb +124 -0
  15. data/lib/MailchimpMarketing/api/dashboard_api.rb +128 -0
  16. data/lib/MailchimpMarketing/api/ecommerce_api.rb +1139 -0
  17. data/lib/MailchimpMarketing/api/external_auths_api.rb +78 -0
  18. data/lib/MailchimpMarketing/api/facebook_ads_api.rb +66 -0
  19. data/lib/MailchimpMarketing/api/file_manager_api.rb +224 -0
  20. data/lib/MailchimpMarketing/api/landing_pages_api.rb +164 -0
  21. data/lib/MailchimpMarketing/api/lists_api.rb +1302 -0
  22. data/lib/MailchimpMarketing/api/ping_api.rb +39 -0
  23. data/lib/MailchimpMarketing/api/postcards_api.rb +45 -0
  24. data/lib/MailchimpMarketing/api/reporting_api.rb +142 -0
  25. data/lib/MailchimpMarketing/api/reports_api.rb +464 -0
  26. data/lib/MailchimpMarketing/api/root_api.rb +41 -0
  27. data/lib/MailchimpMarketing/api/search_campaigns_api.rb +43 -0
  28. data/lib/MailchimpMarketing/api/search_members_api.rb +44 -0
  29. data/lib/MailchimpMarketing/api/template_folders_api.rb +111 -0
  30. data/lib/MailchimpMarketing/api/templates_api.rb +137 -0
  31. data/lib/MailchimpMarketing/api/verified_domains_api.rb +104 -0
  32. data/lib/MailchimpMarketing/api_client.rb +214 -0
  33. data/lib/MailchimpMarketing/api_error.rb +38 -0
  34. data/lib/MailchimpMarketing/configuration.rb +209 -0
  35. data/lib/MailchimpMarketing/version.rb +15 -0
  36. metadata +257 -0
@@ -0,0 +1,41 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class RootApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # List api root resources
25
+ def get_root(opts = {})
26
+
27
+ query_params = {}
28
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
29
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
30
+ form_params = {}
31
+ post_body = nil
32
+
33
+ local_var_path = '/'
34
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
35
+ :query_params => query_params,
36
+ :form_params => form_params,
37
+ :body => post_body)
38
+ return data, status_code, headers
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,43 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class SearchCampaignsApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Search campaigns
25
+ def search(query, opts = {})
26
+ fail ArgumentError, "Missing required param: 'query'" if query.nil?
27
+
28
+ query_params = {}
29
+ query_params[:'query'] = query
30
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
31
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
32
+ form_params = {}
33
+ post_body = nil
34
+
35
+ local_var_path = '/search-campaigns'
36
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
37
+ :query_params => query_params,
38
+ :form_params => form_params,
39
+ :body => post_body)
40
+ return data, status_code, headers
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,44 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class SearchMembersApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Search members
25
+ def search(query, opts = {})
26
+ fail ArgumentError, "Missing required param: 'query'" if query.nil?
27
+
28
+ query_params = {}
29
+ query_params[:'query'] = query
30
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
31
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
32
+ query_params[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].nil?
33
+ form_params = {}
34
+ post_body = nil
35
+
36
+ local_var_path = '/search-members'
37
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
38
+ :query_params => query_params,
39
+ :form_params => form_params,
40
+ :body => post_body)
41
+ return data, status_code, headers
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,111 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class TemplateFoldersApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Delete template folder
25
+ def remove(folder_id, opts = {})
26
+ fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
27
+
28
+ query_params = {}
29
+ form_params = {}
30
+ post_body = nil
31
+
32
+ local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
33
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
34
+ :query_params => query_params,
35
+ :form_params => form_params,
36
+ :body => post_body)
37
+ return data, status_code, headers
38
+ end
39
+
40
+ # List template folders
41
+ def list(opts = {})
42
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
43
+
44
+ query_params = {}
45
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
46
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
47
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
48
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
49
+ form_params = {}
50
+ post_body = nil
51
+
52
+ local_var_path = '/template-folders'
53
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
54
+ :query_params => query_params,
55
+ :form_params => form_params,
56
+ :body => post_body)
57
+ return data, status_code, headers
58
+ end
59
+
60
+ # Get template folder
61
+ def get(folder_id, opts = {})
62
+ fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
63
+
64
+ query_params = {}
65
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
66
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
67
+ form_params = {}
68
+ post_body = nil
69
+
70
+ local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
71
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body)
75
+ return data, status_code, headers
76
+ end
77
+
78
+ # Update template folder
79
+ def update(folder_id, body, opts = {})
80
+ fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
81
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
82
+
83
+ query_params = {}
84
+ form_params = {}
85
+ post_body = @api_client.object_to_http_body(body)
86
+
87
+ local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
88
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
89
+ :query_params => query_params,
90
+ :form_params => form_params,
91
+ :body => post_body)
92
+ return data, status_code, headers
93
+ end
94
+
95
+ # Add template folder
96
+ def create(body, opts = {})
97
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
98
+
99
+ query_params = {}
100
+ form_params = {}
101
+ post_body = @api_client.object_to_http_body(body)
102
+
103
+ local_var_path = '/template-folders'
104
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
105
+ :query_params => query_params,
106
+ :form_params => form_params,
107
+ :body => post_body)
108
+ return data, status_code, headers
109
+ end
110
+ end
111
+ end
@@ -0,0 +1,137 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class TemplatesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Delete template
25
+ def delete_template(template_id, opts = {})
26
+ fail ArgumentError, "Missing required param: 'template_id'" if template_id.nil?
27
+
28
+ query_params = {}
29
+ form_params = {}
30
+ post_body = nil
31
+
32
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
33
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
34
+ :query_params => query_params,
35
+ :form_params => form_params,
36
+ :body => post_body)
37
+ return data, status_code, headers
38
+ end
39
+
40
+ # List templates
41
+ def list(opts = {})
42
+ fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
43
+ fail ArgumentError, 'invalid value for "sort_field", must be one of date_created, name' if opts[:'sort_field'] && !['date_created', 'name'].include?(opts[:'sort_field'])
44
+
45
+ query_params = {}
46
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
47
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
48
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
49
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
50
+ query_params[:'created_by'] = opts[:'created_by'] if !opts[:'created_by'].nil?
51
+ query_params[:'since_created_at'] = opts[:'since_created_at'] if !opts[:'since_created_at'].nil?
52
+ query_params[:'before_created_at'] = opts[:'before_created_at'] if !opts[:'before_created_at'].nil?
53
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
54
+ query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
55
+ query_params[:'folder_id'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
56
+ query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
57
+ form_params = {}
58
+ post_body = nil
59
+
60
+ local_var_path = '/templates'
61
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body)
65
+ return data, status_code, headers
66
+ end
67
+
68
+ # Get template info
69
+ def get_template(template_id, opts = {})
70
+ fail ArgumentError, "Missing required param: 'template_id'" if template_id.nil?
71
+
72
+ query_params = {}
73
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
74
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
75
+ form_params = {}
76
+ post_body = nil
77
+
78
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
79
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body)
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # View default content
87
+ def get_default_content_for_template(template_id, opts = {})
88
+ fail ArgumentError, "Missing required param: 'template_id'" if template_id.nil?
89
+
90
+ query_params = {}
91
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
92
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
93
+ form_params = {}
94
+ post_body = nil
95
+
96
+ local_var_path = '/templates/{template_id}/default-content'.sub('{' + 'template_id' + '}', template_id.to_s)
97
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
98
+ :query_params => query_params,
99
+ :form_params => form_params,
100
+ :body => post_body)
101
+ return data, status_code, headers
102
+ end
103
+
104
+ # Update template
105
+ def update_template(template_id, body, opts = {})
106
+ fail ArgumentError, "Missing required param: 'template_id'" if template_id.nil?
107
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
108
+
109
+ query_params = {}
110
+ form_params = {}
111
+ post_body = @api_client.object_to_http_body(body)
112
+
113
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
114
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
115
+ :query_params => query_params,
116
+ :form_params => form_params,
117
+ :body => post_body)
118
+ return data, status_code, headers
119
+ end
120
+
121
+ # Add template
122
+ def create(body, opts = {})
123
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
124
+
125
+ query_params = {}
126
+ form_params = {}
127
+ post_body = @api_client.object_to_http_body(body)
128
+
129
+ local_var_path = '/templates'
130
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
131
+ :query_params => query_params,
132
+ :form_params => form_params,
133
+ :body => post_body)
134
+ return data, status_code, headers
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,104 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.7
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+ require 'json'
15
+
16
+ module MailchimpMarketing
17
+ class VerifiedDomainsApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Add domain to account
25
+ def create_verified_domain(body, opts = {})
26
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
27
+
28
+ query_params = {}
29
+ form_params = {}
30
+ post_body = @api_client.object_to_http_body(body)
31
+
32
+ local_var_path = '/verified-domains'
33
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
34
+ :query_params => query_params,
35
+ :form_params => form_params,
36
+ :body => post_body)
37
+ return data, status_code, headers
38
+ end
39
+
40
+ # Delete domain
41
+ def delete_domain(domain_name, opts = {})
42
+ fail ArgumentError, "Missing required param: 'domain_name'" if domain_name.nil?
43
+
44
+ query_params = {}
45
+ form_params = {}
46
+ post_body = nil
47
+
48
+ local_var_path = '/verified-domains/{domain_name}'.sub('{' + 'domain_name' + '}', domain_name.to_s)
49
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
50
+ :query_params => query_params,
51
+ :form_params => form_params,
52
+ :body => post_body)
53
+ return data, status_code, headers
54
+ end
55
+
56
+ # Get domain info
57
+ def get_domain(domain_name, opts = {})
58
+ fail ArgumentError, "Missing required param: 'domain_name'" if domain_name.nil?
59
+
60
+ query_params = {}
61
+ form_params = {}
62
+ post_body = nil
63
+
64
+ local_var_path = '/verified-domains/{domain_name}'.sub('{' + 'domain_name' + '}', domain_name.to_s)
65
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body)
69
+ return data, status_code, headers
70
+ end
71
+
72
+ # List sending domains
73
+ def get_verified_domains_all(opts = {})
74
+
75
+ query_params = {}
76
+ form_params = {}
77
+ post_body = nil
78
+
79
+ local_var_path = '/verified-domains'
80
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body)
84
+ return data, status_code, headers
85
+ end
86
+
87
+ # Verify domain
88
+ def submit_domain_verification(domain_name, body, opts = {})
89
+ fail ArgumentError, "Missing required param: 'domain_name'" if domain_name.nil?
90
+ fail ArgumentError, "Missing required param: 'body'" if body.nil?
91
+
92
+ query_params = {}
93
+ form_params = {}
94
+ post_body = @api_client.object_to_http_body(body)
95
+
96
+ local_var_path = '/verified-domains/{domain_name}/actions/verify'.sub('{' + 'domain_name' + '}', domain_name.to_s)
97
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
98
+ :query_params => query_params,
99
+ :form_params => form_params,
100
+ :body => post_body)
101
+ return data, status_code, headers
102
+ end
103
+ end
104
+ end