MailchimpMarketing 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/MailchimpMarketing.gemspec +45 -0
  4. data/README.md +369 -0
  5. data/lib/MailchimpMarketing.rb +163 -0
  6. data/lib/MailchimpMarketing/api/activity_feed_api.rb +113 -0
  7. data/lib/MailchimpMarketing/api/authorized_apps_api.rb +171 -0
  8. data/lib/MailchimpMarketing/api/automations_api.rb +906 -0
  9. data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +260 -0
  10. data/lib/MailchimpMarketing/api/batches_api.rb +214 -0
  11. data/lib/MailchimpMarketing/api/campaign_folders_api.rb +260 -0
  12. data/lib/MailchimpMarketing/api/campaigns_api.rb +1073 -0
  13. data/lib/MailchimpMarketing/api/connected_sites_api.rb +257 -0
  14. data/lib/MailchimpMarketing/api/conversations_api.rb +293 -0
  15. data/lib/MailchimpMarketing/api/dashboard_api.rb +317 -0
  16. data/lib/MailchimpMarketing/api/ecommerce_api.rb +3004 -0
  17. data/lib/MailchimpMarketing/api/external_auths_api.rb +171 -0
  18. data/lib/MailchimpMarketing/api/facebook_ads_api.rb +133 -0
  19. data/lib/MailchimpMarketing/api/file_manager_api.rb +566 -0
  20. data/lib/MailchimpMarketing/api/landing_pages_api.rb +399 -0
  21. data/lib/MailchimpMarketing/api/lists_api.rb +3457 -0
  22. data/lib/MailchimpMarketing/api/ping_api.rb +65 -0
  23. data/lib/MailchimpMarketing/api/postcards_api.rb +77 -0
  24. data/lib/MailchimpMarketing/api/reporting_api.rb +338 -0
  25. data/lib/MailchimpMarketing/api/reports_api.rb +1214 -0
  26. data/lib/MailchimpMarketing/api/root_api.rb +71 -0
  27. data/lib/MailchimpMarketing/api/search_campaigns_api.rb +74 -0
  28. data/lib/MailchimpMarketing/api/search_members_api.rb +77 -0
  29. data/lib/MailchimpMarketing/api/template_folders_api.rb +260 -0
  30. data/lib/MailchimpMarketing/api/templates_api.rb +331 -0
  31. data/lib/MailchimpMarketing/api/verified_domains_api.rb +242 -0
  32. data/lib/MailchimpMarketing/api_client.rb +192 -0
  33. data/lib/MailchimpMarketing/api_error.rb +38 -0
  34. data/lib/MailchimpMarketing/configuration.rb +209 -0
  35. data/lib/MailchimpMarketing/version.rb +15 -0
  36. metadata +257 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 63bbaad5d213f6fc326818e55aad5b9dbc6a876c897356022fa89dab5fc1892a
4
+ data.tar.gz: 2caa4cc62ee310c69a4c9cd761ebc672f8421ec4d29823c6111fb45212d3e83a
5
+ SHA512:
6
+ metadata.gz: b23a23ee8bb7ed1d54ff09ea8cc92037c9793893547bc1417ec3113edac1415602349eb085bf6d14403ec3b64aaf38837c74b6b9bd4e8933b3470c6b88e814cf
7
+ data.tar.gz: 017db71b1790e113031cbf8ec1738a8b2c9c9d55e0fec487b19bb269e91ce0c7e36df8a42ae7ec9e76fa0e83eed61270490bd0506d2f6cb8461a0de7fade7ed7
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
data/MailchimpMarketing.gemspec ADDED
@@ -0,0 +1,45 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #Mailchimp Marketing API
5
+
6
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
7
+
8
+ OpenAPI spec version: 3.0.1
9
+ Contact: apihelp@mailchimp.com
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 2.4.12
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "MailchimpMarketing/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "MailchimpMarketing"
20
+ s.version = MailchimpMarketing::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Swagger-Codegen"]
23
+ s.email = ["apihelp@mailchimp.com"]
24
+ s.homepage = "https://github.com/swagger-api/swagger-codegen"
25
+ s.summary = "Mailchimp Marketing API Ruby Gem"
26
+ s.description = "Mailchimp Marketing Ruby SDK"
27
+ s.license = 'Apache-2.0'
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
35
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
36
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
37
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
38
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
+
41
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
42
+ s.test_files = `find spec/*`.split("\n")
43
+ s.executables = []
44
+ s.require_paths = ["lib"]
45
+ end
data/README.md ADDED
@@ -0,0 +1,369 @@
1
+ # Mailchimp Marketing SDK — Ruby
2
+
3
+ The official Ruby SDK for the Mailchimp Marketing API (v1)
4
+
5
+ ## Installation
6
+
7
+ ### Build a gem
8
+
9
+ To build the Ruby code into a gem:
10
+
11
+ ```shell
12
+ gem build MailchimpMarketing.gemspec
13
+ ```
14
+
15
+ Then either install the gem locally:
16
+
17
+ ```shell
18
+ gem install ./MailchimpMarketing-3.0.1.gem
19
+ ```
20
+ (for development, run `gem install --dev ./MailchimpMarketing-3.0.1.gem` to install the development dependencies)
21
+
22
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
23
+
24
+ Finally add this to the Gemfile:
25
+
26
+ gem 'MailchimpMarketing', '~> 3.0.1'
27
+
28
+ ### Install from Git
29
+
30
+ If the Ruby gem is hosted at a git repository: https://github.com/postlight/mailchimp-marketing-ruby, then add the following in the Gemfile:
31
+
32
+ gem 'MailchimpMarketing', :git => 'https://github.com/postlight/mailchimp-marketing-ruby.git'
33
+
34
+ ### Include the Ruby code directly
35
+
36
+ Include the Ruby code directly using `-I` as follows:
37
+
38
+ ```shell
39
+ ruby -Ilib script.rb
40
+ ```
41
+
42
+ ## Quick Start
43
+
44
+ ```ruby
45
+ require 'MailchimpMarketing'
46
+
47
+ begin
48
+ client = MailchimpMarketing::Client.new()
49
+ client.set_config(ENV['API_KEY'], ENV['API_SERVER'])
50
+ result = client.ping.get()
51
+ p result
52
+ rescue MailchimpMarketing::ApiError => e
53
+ puts "Error: #{e}"
54
+ end
55
+ ```
56
+
57
+ If your api key contains a server suffix (i.e. '-us19'), passing in the server key may be omitted, like so:
58
+
59
+ ```python
60
+ client.setConfig(ENV['API_KEY'])
61
+ ```
62
+
63
+ ## API Endpoints
64
+
65
+ All URIs are relative to *https://server.api.mailchimp.com/3.0*
66
+
67
+ | SDK Method | Endpoint |
68
+ | ---------- | -------- |
69
+ | **activityFeed.get** | /activity-feed |
70
+ | **activityFeed.get_chimp_chatter** | /activity-feed/chimp-chatter |
71
+ | **authorizedApps.list** | /authorized-apps |
72
+ | **authorizedApps.get** | /authorized-apps/{app_id} |
73
+ | **authorizedApps.link** | /authorized-apps |
74
+ | **automations.archive** | /automations/{workflow_id}/actions/archive |
75
+ | **automations.delete_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id} |
76
+ | **automations.list** | /automations |
77
+ | **automations.get** | /automations/{workflow_id} |
78
+ | **automations.list_all_workflow_emails** | /automations/{workflow_id}/emails |
79
+ | **automations.get_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id} |
80
+ | **automations.get_workflow_email_subscriber_queue** | /automations/{workflow_id}/emails/{workflow_email_id}/queue |
81
+ | **automations.get_workflow_email_subscriber** | /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} |
82
+ | **automations.list_workflow_email_subscribers_removed** | /automations/{workflow_id}/removed-subscribers |
83
+ | **automations.get_removed_workflow_email_subscriber** | /automations/{workflow_id}/removed-subscribers/{subscriber_hash} |
84
+ | **automations.update_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id} |
85
+ | **automations.update** | /automations/{workflow_id} |
86
+ | **automations.create** | /automations |
87
+ | **automations.pause_all_emails** | /automations/{workflow_id}/actions/pause-all-emails |
88
+ | **automations.start_all_emails** | /automations/{workflow_id}/actions/start-all-emails |
89
+ | **automations.pause_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause |
90
+ | **automations.start_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id}/actions/start |
91
+ | **automations.add_workflow_email_subscriber** | /automations/{workflow_id}/emails/{workflow_email_id}/queue |
92
+ | **automations.remove_workflow_email_subscriber** | /automations/{workflow_id}/removed-subscribers |
93
+ | **batchWebhooks.remove** | /batch-webhooks/{batch_webhook_id} |
94
+ | **batchWebhooks.get** | /batch-webhooks/{batch_webhook_id} |
95
+ | **batchWebhooks.list** | /batch-webhooks |
96
+ | **batchWebhooks.update** | /batch-webhooks/{batch_webhook_id} |
97
+ | **batchWebhooks.create** | /batch-webhooks |
98
+ | **batches.delete_request** | /batches/{batch_id} |
99
+ | **batches.list** | /batches |
100
+ | **batches.status** | /batches/{batch_id} |
101
+ | **batches.start** | /batches |
102
+ | **campaignFolders.remove** | /campaign-folders/{folder_id} |
103
+ | **campaignFolders.list** | /campaign-folders |
104
+ | **campaignFolders.get** | /campaign-folders/{folder_id} |
105
+ | **campaignFolders.update** | /campaign-folders/{folder_id} |
106
+ | **campaignFolders.create** | /campaign-folders |
107
+ | **campaigns.remove** | /campaigns/{campaign_id} |
108
+ | **campaigns.delete_feedback_message** | /campaigns/{campaign_id}/feedback/{feedback_id} |
109
+ | **campaigns.list** | /campaigns |
110
+ | **campaigns.get** | /campaigns/{campaign_id} |
111
+ | **campaigns.get_content** | /campaigns/{campaign_id}/content |
112
+ | **campaigns.get_feedback** | /campaigns/{campaign_id}/feedback |
113
+ | **campaigns.get_feedback_message** | /campaigns/{campaign_id}/feedback/{feedback_id} |
114
+ | **campaigns.get_send_checklist** | /campaigns/{campaign_id}/send-checklist |
115
+ | **campaigns.update** | /campaigns/{campaign_id} |
116
+ | **campaigns.update_feedback_message** | /campaigns/{campaign_id}/feedback/{feedback_id} |
117
+ | **campaigns.create** | /campaigns |
118
+ | **campaigns.cancel_send** | /campaigns/{campaign_id}/actions/cancel-send |
119
+ | **campaigns.create_resend** | /campaigns/{campaign_id}/actions/create-resend |
120
+ | **campaigns.pause** | /campaigns/{campaign_id}/actions/pause |
121
+ | **campaigns.replicate** | /campaigns/{campaign_id}/actions/replicate |
122
+ | **campaigns.resume** | /campaigns/{campaign_id}/actions/resume |
123
+ | **campaigns.schedule** | /campaigns/{campaign_id}/actions/schedule |
124
+ | **campaigns.send** | /campaigns/{campaign_id}/actions/send |
125
+ | **campaigns.send_test_email** | /campaigns/{campaign_id}/actions/test |
126
+ | **campaigns.unschedule** | /campaigns/{campaign_id}/actions/unschedule |
127
+ | **campaigns.add_feedback** | /campaigns/{campaign_id}/feedback |
128
+ | **campaigns.set_content** | /campaigns/{campaign_id}/content |
129
+ | **connectedSites.remove** | /connected-sites/{connected_site_id} |
130
+ | **connectedSites.list** | /connected-sites |
131
+ | **connectedSites.get** | /connected-sites/{connected_site_id} |
132
+ | **connectedSites.create** | /connected-sites |
133
+ | **connectedSites.verify_script_installation** | /connected-sites/{connected_site_id}/actions/verify-script-installation |
134
+ | **conversations.list** | /conversations |
135
+ | **conversations.get** | /conversations/{conversation_id} |
136
+ | **conversations.get_conversation_messages** | /conversations/{conversation_id}/messages |
137
+ | **conversations.get_conversation_message** | /conversations/{conversation_id}/messages/{message_id} |
138
+ | **conversations.create_conversation_message** | /conversations/{conversation_id}/messages |
139
+ | **dashboard.ads** | /dashboard/ads |
140
+ | **dashboard.audiences** | /dashboard/audiences |
141
+ | **dashboard.charts** | /dashboard/charts |
142
+ | **dashboard.ecommerce** | /dashboard/ecommerce |
143
+ | **dashboard.engagement** | /dashboard/engagement |
144
+ | **dashboard.homepage** | /dashboard/homepage |
145
+ | **ecommerce.delete_store** | /ecommerce/stores/{store_id} |
146
+ | **ecommerce.delete_store_cart** | /ecommerce/stores/{store_id}/carts/{cart_id} |
147
+ | **ecommerce.delete_cart_line_item** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |
148
+ | **ecommerce.delete_store_customer** | /ecommerce/stores/{store_id}/customers/{customer_id} |
149
+ | **ecommerce.delete_order** | /ecommerce/stores/{store_id}/orders/{order_id} |
150
+ | **ecommerce.delete_order_line_item** | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |
151
+ | **ecommerce.delete_store_product** | /ecommerce/stores/{store_id}/products/{product_id} |
152
+ | **ecommerce.delete_product_image** | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |
153
+ | **ecommerce.delete_product_variant** | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |
154
+ | **ecommerce.delete_promo_code** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |
155
+ | **ecommerce.delete_promo_rule** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |
156
+ | **ecommerce.info** | /ecommerce |
157
+ | **ecommerce.orders** | /ecommerce/orders |
158
+ | **ecommerce.stores** | /ecommerce/stores |
159
+ | **ecommerce.get_store** | /ecommerce/stores/{store_id} |
160
+ | **ecommerce.get_store_carts** | /ecommerce/stores/{store_id}/carts |
161
+ | **ecommerce.get_store_cart** | /ecommerce/stores/{store_id}/carts/{cart_id} |
162
+ | **ecommerce.get_all_cart_line_items** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines |
163
+ | **ecommerce.get_cart_line_item** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |
164
+ | **ecommerce.get_all_store_customers** | /ecommerce/stores/{store_id}/customers |
165
+ | **ecommerce.get_store_customer** | /ecommerce/stores/{store_id}/customers/{customer_id} |
166
+ | **ecommerce.get_store_orders** | /ecommerce/stores/{store_id}/orders |
167
+ | **ecommerce.get_order** | /ecommerce/stores/{store_id}/orders/{order_id} |
168
+ | **ecommerce.get_all_order_line_items** | /ecommerce/stores/{store_id}/orders/{order_id}/lines |
169
+ | **ecommerce.get_order_line_item** | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |
170
+ | **ecommerce.get_all_store_products** | /ecommerce/stores/{store_id}/products |
171
+ | **ecommerce.get_store_product** | /ecommerce/stores/{store_id}/products/{product_id} |
172
+ | **ecommerce.get_product_images** | /ecommerce/stores/{store_id}/products/{product_id}/images |
173
+ | **ecommerce.get_product_image** | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |
174
+ | **ecommerce.get_product_variants** | /ecommerce/stores/{store_id}/products/{product_id}/variants |
175
+ | **ecommerce.get_product_variant** | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |
176
+ | **ecommerce.get_promo_codes** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes |
177
+ | **ecommerce.get_promo_code** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |
178
+ | **ecommerce.list_promo_rules** | /ecommerce/stores/{store_id}/promo-rules |
179
+ | **ecommerce.get_promo_rule** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |
180
+ | **ecommerce.update_store** | /ecommerce/stores/{store_id} |
181
+ | **ecommerce.update_store_cart** | /ecommerce/stores/{store_id}/carts/{cart_id} |
182
+ | **ecommerce.update_cart_line_item** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |
183
+ | **ecommerce.update_store_customer** | /ecommerce/stores/{store_id}/customers/{customer_id} |
184
+ | **ecommerce.update_order** | /ecommerce/stores/{store_id}/orders/{order_id} |
185
+ | **ecommerce.update_order_line_item** | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |
186
+ | **ecommerce.update_store_product** | /ecommerce/stores/{store_id}/products/{product_id} |
187
+ | **ecommerce.update_product_image** | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |
188
+ | **ecommerce.update_product_variant** | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |
189
+ | **ecommerce.update_promo_code** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |
190
+ | **ecommerce.update_promo_rule** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |
191
+ | **ecommerce.add_store** | /ecommerce/stores |
192
+ | **ecommerce.add_store_cart** | /ecommerce/stores/{store_id}/carts |
193
+ | **ecommerce.add_cart_line_item** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines |
194
+ | **ecommerce.add_store_customer** | /ecommerce/stores/{store_id}/customers |
195
+ | **ecommerce.add_store_order** | /ecommerce/stores/{store_id}/orders |
196
+ | **ecommerce.add_order_line_item** | /ecommerce/stores/{store_id}/orders/{order_id}/lines |
197
+ | **ecommerce.add_store_product** | /ecommerce/stores/{store_id}/products |
198
+ | **ecommerce.add_product_image** | /ecommerce/stores/{store_id}/products/{product_id}/images |
199
+ | **ecommerce.add_product_variants** | /ecommerce/stores/{store_id}/products/{product_id}/variants |
200
+ | **ecommerce.add_promo_code** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes |
201
+ | **ecommerce.add_promo_rules** | /ecommerce/stores/{store_id}/promo-rules |
202
+ | **ecommerce.set_store_customer** | /ecommerce/stores/{store_id}/customers/{customer_id} |
203
+ | **ecommerce.add_product_variant** | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |
204
+ | **externalAuths.get** | /external-auths/{system_id} |
205
+ | **externalAuths.get_collection** | /external-auths |
206
+ | **externalAuths.create** | /external-auths |
207
+ | **facebookAds.list** | /facebook-ads |
208
+ | **facebookAds.get_ad** | /facebook-ads/{outreach_id} |
209
+ | **fileManager.delete_file** | /file-manager/files/{file_id} |
210
+ | **fileManager.delete_folder** | /file-manager/folders/{folder_id} |
211
+ | **fileManager.get** | /file-manager |
212
+ | **fileManager.files** | /file-manager/files |
213
+ | **fileManager.get_file** | /file-manager/files/{file_id} |
214
+ | **fileManager.list_folders** | /file-manager/folders |
215
+ | **fileManager.get_folder** | /file-manager/folders/{folder_id} |
216
+ | **fileManager.update_file** | /file-manager/files/{file_id} |
217
+ | **fileManager.update_folder** | /file-manager/folders/{folder_id} |
218
+ | **fileManager.upload** | /file-manager/files |
219
+ | **fileManager.create_folder** | /file-manager/folders |
220
+ | **landingPages.delete_page** | /landing-pages/{page_id} |
221
+ | **landingPages.get_all** | /landing-pages |
222
+ | **landingPages.get_page** | /landing-pages/{page_id} |
223
+ | **landingPages.get_page_content** | /landing-pages/{page_id}/content |
224
+ | **landingPages.update_page** | /landing-pages/{page_id} |
225
+ | **landingPages.create** | /landing-pages |
226
+ | **landingPages.publish_page** | /landing-pages/{page_id}/actions/publish |
227
+ | **landingPages.unpublish_page** | /landing-pages/{page_id}/actions/unpublish |
228
+ | **lists.delete_list** | /lists/{list_id} |
229
+ | **lists.delete_interest_category** | /lists/{list_id}/interest-categories/{interest_category_id} |
230
+ | **lists.delete_interest_category_interest** | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} |
231
+ | **lists.delete_list_member** | /lists/{list_id}/members/{subscriber_hash} |
232
+ | **lists.delete_list_member_note** | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} |
233
+ | **lists.delete_list_merge_field** | /lists/{list_id}/merge-fields/{merge_id} |
234
+ | **lists.delete_segment** | /lists/{list_id}/segments/{segment_id} |
235
+ | **lists.remove_segment_member** | /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} |
236
+ | **lists.delete_list_webhook** | /lists/{list_id}/webhooks/{webhook_id} |
237
+ | **lists.get_list_member_tags** | /lists/{list_id}/members/{subscriber_hash}/tags |
238
+ | **lists.get_all_lists** | /lists |
239
+ | **lists.get_list** | /lists/{list_id} |
240
+ | **lists.get_list_abuse_reports** | /lists/{list_id}/abuse-reports |
241
+ | **lists.get_list_abuse_report_details** | /lists/{list_id}/abuse-reports/{report_id} |
242
+ | **lists.get_list_recent_activity** | /lists/{list_id}/activity |
243
+ | **lists.get_list_clients** | /lists/{list_id}/clients |
244
+ | **lists.get_list_external_ids** | /lists/{list_id}/external-ids |
245
+ | **lists.get_list_growth_history** | /lists/{list_id}/growth-history |
246
+ | **lists.get_list_growth_history_by_month** | /lists/{list_id}/growth-history/{month} |
247
+ | **lists.get_list_interest_categories** | /lists/{list_id}/interest-categories |
248
+ | **lists.get_interest_category** | /lists/{list_id}/interest-categories/{interest_category_id} |
249
+ | **lists.list_interest_category_interests** | /lists/{list_id}/interest-categories/{interest_category_id}/interests |
250
+ | **lists.get_interest_category_interest** | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} |
251
+ | **lists.get_list_locations** | /lists/{list_id}/locations |
252
+ | **lists.get_list_members_info** | /lists/{list_id}/members |
253
+ | **lists.get_list_member** | /lists/{list_id}/members/{subscriber_hash} |
254
+ | **lists.get_list_member_activity** | /lists/{list_id}/members/{subscriber_hash}/activity |
255
+ | **lists.get_list_member_activity_feed** | /lists/{list_id}/members/{subscriber_hash}/activity-feed |
256
+ | **lists.get_list_member_events** | /lists/{list_id}/members/{subscriber_hash}/events |
257
+ | **lists.getListMemberGoals** | /lists/{list_id}/members/{subscriber_hash}/goals |
258
+ | **lists.get_list_member_notes** | /lists/{list_id}/members/{subscriber_hash}/notes |
259
+ | **lists.get_list_member_note** | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} |
260
+ | **lists.get_list_merge_fields** | /lists/{list_id}/merge-fields |
261
+ | **lists.get_list_merge_field** | /lists/{list_id}/merge-fields/{merge_id} |
262
+ | **lists.get_segment** | /lists/{list_id}/segments/{segment_id} |
263
+ | **lists.get_segment_members_list** | /lists/{list_id}/segments/{segment_id}/members |
264
+ | **lists.get_list_signup_forms** | /lists/{list_id}/signup-forms |
265
+ | **lists.get_list_webhooks** | /lists/{list_id}/webhooks |
266
+ | **lists.get_list_webhook** | /lists/{list_id}/webhooks/{webhook_id} |
267
+ | **lists.update_list** | /lists/{list_id} |
268
+ | **lists.update_interest_category** | /lists/{list_id}/interest-categories/{interest_category_id} |
269
+ | **lists.update_interest_category_interest** | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} |
270
+ | **lists.update_list_member** | /lists/{list_id}/members/{subscriber_hash} |
271
+ | **lists.update_list_member_note** | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} |
272
+ | **lists.update_list_merge_field** | /lists/{list_id}/merge-fields/{merge_id} |
273
+ | **lists.update_segment** | /lists/{list_id}/segments/{segment_id} |
274
+ | **lists.update_list_webhook** | /lists/{list_id}/webhooks/{webhook_id} |
275
+ | **lists.create_list_member_event** | /lists/{list_id}/members/{subscriber_hash}/events |
276
+ | **lists.update_list_member_tags** | /lists/{list_id}/members/{subscriber_hash}/tags |
277
+ | **lists.create_list** | /lists |
278
+ | **lists.batch_list_members** | /lists/{list_id} |
279
+ | **lists.create_list_external_id** | /lists/{list_id}/external-ids |
280
+ | **lists.create_list_interest_category** | /lists/{list_id}/interest-categories |
281
+ | **lists.create_interest_category_interest** | /lists/{list_id}/interest-categories/{interest_category_id}/interests |
282
+ | **lists.add_list_member** | /lists/{list_id}/members |
283
+ | **lists.delete_list_member_permanent** | /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent |
284
+ | **lists.create_list_member_note** | /lists/{list_id}/members/{subscriber_hash}/notes |
285
+ | **lists.add_list_merge_field** | /lists/{list_id}/merge-fields |
286
+ | **lists.create_segment** | /lists/{list_id}/segments |
287
+ | **lists.batch_segment_members** | /lists/{list_id}/segments/{segment_id} |
288
+ | **lists.create_segment_member** | /lists/{list_id}/segments/{segment_id}/members |
289
+ | **lists.update_list_signup_form** | /lists/{list_id}/signup-forms |
290
+ | **lists.create_list_webhook** | /lists/{list_id}/webhooks |
291
+ | **lists.list_segments** | /lists/{list_id}/segments |
292
+ | **lists.preview_segment** | /lists/{list_id}/preview-segment |
293
+ | **lists.set_list_member** | /lists/{list_id}/members/{subscriber_hash} |
294
+ | **ping.get** | /ping |
295
+ | **postcards.get_all** | /postcards |
296
+ | **reporting.info** | /reporting |
297
+ | **reporting.get_facebook_ads_report_all** | /reporting/facebook-ads |
298
+ | **reporting.get_facebook_ad_report** | /reporting/facebook-ads/{outreach_id} |
299
+ | **reporting.get_facebook_ad_product_activity_report** | /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity |
300
+ | **reporting.get_landing_page_reports_all** | /reporting/landing-pages |
301
+ | **reporting.get_landing_page_report** | /reporting/landing-pages/{outreach_id} |
302
+ | **reports.get_all_campaign_reports** | /reports |
303
+ | **reports.get_campaign_report** | /reports/{campaign_id} |
304
+ | **reports.get_campaign_abuse_reports** | /reports/{campaign_id}/abuse-reports |
305
+ | **reports.get_campaign_abuse_report** | /reports/{campaign_id}/abuse-reports/{report_id} |
306
+ | **reports.get_campaign_advice** | /reports/{campaign_id}/advice |
307
+ | **reports.get_campaign_click_details** | /reports/{campaign_id}/click-details |
308
+ | **reports.get_campaign_click_details_for_link** | /reports/{campaign_id}/click-details/{link_id} |
309
+ | **reports.get_subscribers_info** | /reports/{campaign_id}/click-details/{link_id}/members |
310
+ | **reports.get_subscriber_info** | /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} |
311
+ | **reports.get_domain_performance_for_campaign** | /reports/{campaign_id}/domain-performance |
312
+ | **reports.get_ecommerce_product_activity_for_campaign** | /reports/{campaign_id}/ecommerce-product-activity |
313
+ | **reports.get_eepurl_activity_for_campaign** | /reports/{campaign_id}/eepurl |
314
+ | **reports.get_email_activity_for_campaign** | /reports/{campaign_id}/email-activity |
315
+ | **reports.get_email_activity_for_subscriber** | /reports/{campaign_id}/email-activity/{subscriber_hash} |
316
+ | **reports.get_locations_for_campaign** | /reports/{campaign_id}/locations |
317
+ | **reports.get_campaign_open_details** | /reports/{campaign_id}/open-details |
318
+ | **reports.get_subscriber_info_for_opened_campaign** | /reports/{campaign_id}/open-details/{subscriber_hash} |
319
+ | **reports.get_campaign_recipients** | /reports/{campaign_id}/sent-to |
320
+ | **reports.get_campaign_recipient** | /reports/{campaign_id}/sent-to/{subscriber_hash} |
321
+ | **reports.get_sub_reports_for_campaign** | /reports/{campaign_id}/sub-reports |
322
+ | **reports.get_unsubscribed_list_for_campaign** | /reports/{campaign_id}/unsubscribed |
323
+ | **reports.get_unsubscribed_list_member** | /reports/{campaign_id}/unsubscribed/{subscriber_hash} |
324
+ | **root.get_root** | / |
325
+ | **searchCampaigns.search** | /search-campaigns |
326
+ | **searchMembers.search** | /search-members |
327
+ | **templateFolders.remove** | /template-folders/{folder_id} |
328
+ | **templateFolders.list** | /template-folders |
329
+ | **templateFolders.get** | /template-folders/{folder_id} |
330
+ | **templateFolders.update** | /template-folders/{folder_id} |
331
+ | **templateFolders.create** | /template-folders |
332
+ | **templates.delete_template** | /templates/{template_id} |
333
+ | **templates.list** | /templates |
334
+ | **templates.get_template** | /templates/{template_id} |
335
+ | **templates.get_default_content_for_template** | /templates/{template_id}/default-content |
336
+ | **templates.update_template** | /templates/{template_id} |
337
+ | **templates.create** | /templates |
338
+ | **verifiedDomains.create_verified_domain** | /verified-domains |
339
+ | **verifiedDomains.delete_domain** | /verified-domains/{domain_name} |
340
+ | **verifiedDomains.get_domain** | /verified-domains/{domain_name} |
341
+ | **verifiedDomains.get_verified_domains_all** | /verified-domains |
342
+ | **verifiedDomains.submit_domain_verification** | /verified-domains/{domain_name}/actions/verify |
343
+
344
+
345
+ ## Additional SDKs
346
+
347
+ Mailchimp Marketing SDKs are available in a number of additional languages.
348
+
349
+ <div>
350
+ <a href="https://github.com/postlight/mailchimp-marketing-node">
351
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_node.png?raw=true" width="44" height="44">
352
+ </a>
353
+ <a href="https://github.com/postlight/mailchimp-marketing-php">
354
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_php.png?raw=true" width="44" height="44">
355
+ </a>
356
+ <a href="https://github.com/postlight/mailchimp-marketing-ruby">
357
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_ruby.png?raw=true" width="44" height="44">
358
+ </a>
359
+ <a href="https://github.com/postlight/mailchimp-marketing-python">
360
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_python.png?raw=true" width="44" height="44">
361
+ </a>
362
+ <a href="https://github.com/postlight/mailchimp-marketing-java">
363
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_java.png?raw=true" width="44" height="44">
364
+ </a>
365
+ <a href="https://github.com/postlight/mailchimp-marketing-csharp">
366
+ <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_csharp.png?raw=true" width="44" height="44">
367
+ </a>
368
+ </div>
369
+
data/lib/MailchimpMarketing.rb ADDED
@@ -0,0 +1,163 @@
1
+ =begin
2
+ #Mailchimp Marketing API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 3.0.1
7
+ Contact: apihelp@mailchimp.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'MailchimpMarketing/api_client'
15
+ require 'MailchimpMarketing/api_error'
16
+ require 'MailchimpMarketing/version'
17
+
18
+
19
+ # APIs
20
+ require 'MailchimpMarketing/api/activity_feed_api'
21
+ require 'MailchimpMarketing/api/authorized_apps_api'
22
+ require 'MailchimpMarketing/api/automations_api'
23
+ require 'MailchimpMarketing/api/batch_webhooks_api'
24
+ require 'MailchimpMarketing/api/batches_api'
25
+ require 'MailchimpMarketing/api/campaign_folders_api'
26
+ require 'MailchimpMarketing/api/campaigns_api'
27
+ require 'MailchimpMarketing/api/connected_sites_api'
28
+ require 'MailchimpMarketing/api/conversations_api'
29
+ require 'MailchimpMarketing/api/dashboard_api'
30
+ require 'MailchimpMarketing/api/ecommerce_api'
31
+ require 'MailchimpMarketing/api/external_auths_api'
32
+ require 'MailchimpMarketing/api/facebook_ads_api'
33
+ require 'MailchimpMarketing/api/file_manager_api'
34
+ require 'MailchimpMarketing/api/landing_pages_api'
35
+ require 'MailchimpMarketing/api/lists_api'
36
+ require 'MailchimpMarketing/api/ping_api'
37
+ require 'MailchimpMarketing/api/postcards_api'
38
+ require 'MailchimpMarketing/api/reporting_api'
39
+ require 'MailchimpMarketing/api/reports_api'
40
+ require 'MailchimpMarketing/api/root_api'
41
+ require 'MailchimpMarketing/api/search_campaigns_api'
42
+ require 'MailchimpMarketing/api/search_members_api'
43
+ require 'MailchimpMarketing/api/template_folders_api'
44
+ require 'MailchimpMarketing/api/templates_api'
45
+ require 'MailchimpMarketing/api/verified_domains_api'
46
+
47
+ module MailchimpMarketing
48
+ class Client
49
+ def initialize(api_key = '', server = '')
50
+ @api_client = ApiClient.new(api_key, server)
51
+
52
+ @ActivityFeed = ActivityFeedApi.new(@api_client)
53
+ @AuthorizedApps = AuthorizedAppsApi.new(@api_client)
54
+ @Automations = AutomationsApi.new(@api_client)
55
+ @BatchWebhooks = BatchWebhooksApi.new(@api_client)
56
+ @Batches = BatchesApi.new(@api_client)
57
+ @CampaignFolders = CampaignFoldersApi.new(@api_client)
58
+ @Campaigns = CampaignsApi.new(@api_client)
59
+ @ConnectedSites = ConnectedSitesApi.new(@api_client)
60
+ @Conversations = ConversationsApi.new(@api_client)
61
+ @Dashboard = DashboardApi.new(@api_client)
62
+ @Ecommerce = EcommerceApi.new(@api_client)
63
+ @ExternalAuths = ExternalAuthsApi.new(@api_client)
64
+ @FacebookAds = FacebookAdsApi.new(@api_client)
65
+ @FileManager = FileManagerApi.new(@api_client)
66
+ @LandingPages = LandingPagesApi.new(@api_client)
67
+ @Lists = ListsApi.new(@api_client)
68
+ @Ping = PingApi.new(@api_client)
69
+ @Postcards = PostcardsApi.new(@api_client)
70
+ @Reporting = ReportingApi.new(@api_client)
71
+ @Reports = ReportsApi.new(@api_client)
72
+ @Root = RootApi.new(@api_client)
73
+ @SearchCampaigns = SearchCampaignsApi.new(@api_client)
74
+ @SearchMembers = SearchMembersApi.new(@api_client)
75
+ @TemplateFolders = TemplateFoldersApi.new(@api_client)
76
+ @Templates = TemplatesApi.new(@api_client)
77
+ @VerifiedDomains = VerifiedDomainsApi.new(@api_client)
78
+ end
79
+
80
+ def set_config(api_key = '', server = '')
81
+ @api_client.set_config(api_key, server)
82
+ end
83
+
84
+ def activityFeed
85
+ @ActivityFeed
86
+ end
87
+ def authorizedApps
88
+ @AuthorizedApps
89
+ end
90
+ def automations
91
+ @Automations
92
+ end
93
+ def batchWebhooks
94
+ @BatchWebhooks
95
+ end
96
+ def batches
97
+ @Batches
98
+ end
99
+ def campaignFolders
100
+ @CampaignFolders
101
+ end
102
+ def campaigns
103
+ @Campaigns
104
+ end
105
+ def connectedSites
106
+ @ConnectedSites
107
+ end
108
+ def conversations
109
+ @Conversations
110
+ end
111
+ def dashboard
112
+ @Dashboard
113
+ end
114
+ def ecommerce
115
+ @Ecommerce
116
+ end
117
+ def externalAuths
118
+ @ExternalAuths
119
+ end
120
+ def facebookAds
121
+ @FacebookAds
122
+ end
123
+ def fileManager
124
+ @FileManager
125
+ end
126
+ def landingPages
127
+ @LandingPages
128
+ end
129
+ def lists
130
+ @Lists
131
+ end
132
+ def ping
133
+ @Ping
134
+ end
135
+ def postcards
136
+ @Postcards
137
+ end
138
+ def reporting
139
+ @Reporting
140
+ end
141
+ def reports
142
+ @Reports
143
+ end
144
+ def root
145
+ @Root
146
+ end
147
+ def searchCampaigns
148
+ @SearchCampaigns
149
+ end
150
+ def searchMembers
151
+ @SearchMembers
152
+ end
153
+ def templateFolders
154
+ @TemplateFolders
155
+ end
156
+ def templates
157
+ @Templates
158
+ end
159
+ def verifiedDomains
160
+ @VerifiedDomains
161
+ end
162
+ end
163
+ end