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