MailchimpMarketing 3.0.12 → 3.0.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +62 -0
- data/MailchimpMarketing.gemspec +6 -6
- data/README.md +33 -29
- data/lib/MailchimpMarketing/api/account_export_api.rb +39 -0
- data/lib/MailchimpMarketing/api/{postcards_api.rb → account_exports_api.rb} +20 -7
- data/lib/MailchimpMarketing/api/activity_feed_api.rb +1 -14
- data/lib/MailchimpMarketing/api/authorized_apps_api.rb +1 -15
- data/lib/MailchimpMarketing/api/automations_api.rb +6 -18
- data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +1 -1
- data/lib/MailchimpMarketing/api/batches_api.rb +1 -1
- data/lib/MailchimpMarketing/api/campaign_folders_api.rb +1 -1
- data/lib/MailchimpMarketing/api/campaigns_api.rb +1 -1
- data/lib/MailchimpMarketing/api/connected_sites_api.rb +1 -1
- data/lib/MailchimpMarketing/api/conversations_api.rb +1 -16
- data/lib/MailchimpMarketing/api/customer_journeys_api.rb +39 -0
- data/lib/MailchimpMarketing/api/ecommerce_api.rb +1 -16
- data/lib/MailchimpMarketing/api/facebook_ads_api.rb +1 -1
- data/lib/MailchimpMarketing/api/file_manager_api.rb +1 -14
- data/lib/MailchimpMarketing/api/landing_pages_api.rb +2 -1
- data/lib/MailchimpMarketing/api/lists_api.rb +64 -55
- data/lib/MailchimpMarketing/api/ping_api.rb +1 -1
- data/lib/MailchimpMarketing/api/reporting_api.rb +122 -14
- data/lib/MailchimpMarketing/api/reports_api.rb +2 -2
- data/lib/MailchimpMarketing/api/root_api.rb +1 -1
- data/lib/MailchimpMarketing/api/search_campaigns_api.rb +1 -1
- data/lib/MailchimpMarketing/api/search_members_api.rb +1 -1
- data/lib/MailchimpMarketing/api/surveys_api.rb +53 -0
- data/lib/MailchimpMarketing/api/template_folders_api.rb +1 -1
- data/lib/MailchimpMarketing/api/templates_api.rb +6 -4
- data/lib/MailchimpMarketing/api/verified_domains_api.rb +1 -1
- data/lib/MailchimpMarketing/api_client.rb +18 -5
- data/lib/MailchimpMarketing/api_error.rb +1 -1
- data/lib/MailchimpMarketing/configuration.rb +1 -1
- data/lib/MailchimpMarketing/version.rb +2 -2
- data/lib/MailchimpMarketing.rb +20 -15
- metadata +19 -11
- data/lib/MailchimpMarketing/api/dashboard_api.rb +0 -115
- data/lib/MailchimpMarketing/api/external_auths_api.rb +0 -71
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 90fbd3c15dc9ae03ccfb124ed7e42cced8b7e1290386bb15dc5712c5d58799ca
|
|
4
|
+
data.tar.gz: 2b1ccab99320cc5a2fe654289c77319d1f8755f09d6015c1d7c2b6b34a3608a1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 10724fbbfcb64415ae515fcd9a6aff5d556c6e53f72e38e6497087c09d6c1ada8ea9255ed91581d9d9794f3fb92844bef384279988fc3c132bbda5210e877643
|
|
7
|
+
data.tar.gz: ec5e39a9f067d6eabb2d2643896fe3e37eb1fd317b74d77092f0148c7ce66d2ce9fdc9a131f57f754b9972ac16f95979dffd93632ed1c4b3b310057553b34e3d
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## Transactional
|
|
4
|
+
|
|
5
|
+
### 1.0.48
|
|
6
|
+
* Allowing users to schedule messages (using messages/send, messages/send-template, messages/send-raw and messages/reschedule APIs) within a year from the date of scheduling.
|
|
7
|
+
|
|
8
|
+
### 1.0.46
|
|
9
|
+
* Added a little more granularity to the `set_timeout` method to the Client class in the Ruby SDK; now supports `read`, `write` and `connect` parameters, which will default to the `timeout` param if unspecified, or 300 seconds if `timeout` is unspecified.
|
|
10
|
+
|
|
11
|
+
### 1.0.45
|
|
12
|
+
* Added a `set_timeout` method to the Client class in the Ruby SDK
|
|
13
|
+
|
|
14
|
+
### 1.0.44
|
|
15
|
+
* Added a `set_timeout` method to the Client class in the Python SDK
|
|
16
|
+
|
|
17
|
+
### 1.0.43
|
|
18
|
+
* Added a `setTimeout` method to the Configuration class in the PHP SDK.
|
|
19
|
+
|
|
20
|
+
### 1.0.42
|
|
21
|
+
* Added a `setDefaultTimeoutMs` method to the node client. This allows users to override the default timeout for API requests, which is set to 5 minutes by default.
|
|
22
|
+
|
|
23
|
+
### 1.0.41
|
|
24
|
+
* Updated the "reject_reasons" response for /messages/send and /messages/send-template to correctly use "hard-bounce" and "soft-bounce" instead of the previously stated "hard_bounce" and "soft_bounce".
|
|
25
|
+
|
|
26
|
+
### 1.0.40
|
|
27
|
+
* Added the new /allowlists/ series of endpoints and the /exports/allowlist endpoint to the API reference
|
|
28
|
+
|
|
29
|
+
### 1.0.39
|
|
30
|
+
* Fixes the output directory for the Changelog for the php client library
|
|
31
|
+
|
|
32
|
+
### 1.0.38
|
|
33
|
+
* A change was made to `mailchimp-transactional-php` - the API client will now always return an `Exception`, instead of an `Exception` or a string, when the API returns an error. Having to parse the response as a string was found to be a bit clunky.
|
|
34
|
+
|
|
35
|
+
### 1.0.37
|
|
36
|
+
* Added a changelog, which will be used to describe changes to both transactional and marketing client libraries.
|
|
37
|
+
|
|
38
|
+
## Marketing
|
|
39
|
+
|
|
40
|
+
### 3.0.72
|
|
41
|
+
* Updated the `PATCH /automations/.../emails/.../` documentation to state the required `workflow_type`
|
|
42
|
+
|
|
43
|
+
### 3.0.70
|
|
44
|
+
* Added more granularity for the `timeout` field in the Ruby Marketing SDK; now supports `read_timeout`, `write_timeout` and `connect_timeout` fields which will default to the `timeout` value.
|
|
45
|
+
|
|
46
|
+
### 3.0.69
|
|
47
|
+
* Added handling for a `timeout` field in the config block passed to the client constructor in the Ruby Marketing SDK.
|
|
48
|
+
|
|
49
|
+
### 3.0.68
|
|
50
|
+
* Added handling for a `'timeout'` field in `set_config()` in the Python Marketing SDK.
|
|
51
|
+
|
|
52
|
+
### 3.0.67
|
|
53
|
+
* Added a `setTimeout()` method to the configuration class in the PHP Marketing SDK, to allow manually setting the timeout for Guzzle requests.
|
|
54
|
+
|
|
55
|
+
### 3.0.65
|
|
56
|
+
* Added a new API endpoint, `/3.0/account-exports`, allowing users to programatically export their account information
|
|
57
|
+
|
|
58
|
+
### 3.0.64
|
|
59
|
+
* Fixes the output directory for the Changelog for the php client library
|
|
60
|
+
|
|
61
|
+
### 3.0.63
|
|
62
|
+
* Added a changelog, which will be used to describe changes to both transactional and marketing client libraries.
|
data/MailchimpMarketing.gemspec
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
7
7
|
|
|
8
|
-
OpenAPI spec version: 3.0.
|
|
8
|
+
OpenAPI spec version: 3.0.80
|
|
9
9
|
Contact: apihelp@mailchimp.com
|
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
11
|
Swagger Codegen version: 2.4.12
|
|
@@ -19,15 +19,15 @@ Gem::Specification.new do |s|
|
|
|
19
19
|
s.name = "MailchimpMarketing"
|
|
20
20
|
s.version = MailchimpMarketing::VERSION
|
|
21
21
|
s.platform = Gem::Platform::RUBY
|
|
22
|
-
s.authors = ["
|
|
22
|
+
s.authors = ["Mailchimp"]
|
|
23
23
|
s.email = ["apihelp@mailchimp.com"]
|
|
24
|
-
s.homepage = "https://github.com/
|
|
24
|
+
s.homepage = "https://github.com/mailchimp/mailchimp-client-lib-codegen"
|
|
25
25
|
s.summary = "Mailchimp Marketing API Ruby Gem"
|
|
26
|
-
s.description = "Mailchimp Marketing
|
|
26
|
+
s.description = "The official Ruby client library for the Mailchimp Marketing API"
|
|
27
27
|
s.license = 'Apache-2.0'
|
|
28
28
|
s.required_ruby_version = ">= 1.9"
|
|
29
29
|
|
|
30
|
-
s.add_runtime_dependency 'excon', '
|
|
30
|
+
s.add_runtime_dependency 'excon', '>= 0.76.0', '<1'
|
|
31
31
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
|
32
32
|
|
|
33
33
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
|
|
|
39
39
|
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
|
40
40
|
|
|
41
41
|
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
|
42
|
-
s.test_files =
|
|
42
|
+
s.test_files = []
|
|
43
43
|
s.executables = []
|
|
44
44
|
s.require_paths = ["lib"]
|
|
45
45
|
end
|
data/README.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://mailchimp.com/developer/">
|
|
3
|
+
<img src="https://raw.githubusercontent.com/mailchimp/mailchimp-client-lib-codegen/main/resources/images/mcdev-banner.png" alt="Mailchimp Developer" width="100%" height="auto">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
1
7
|
# Mailchimp Marketing — Ruby
|
|
2
8
|
|
|
3
|
-
The official Ruby client library for the Mailchimp Marketing API
|
|
9
|
+
The official Ruby client library for the Mailchimp Marketing API
|
|
4
10
|
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
@@ -20,8 +26,8 @@ gem 'MailchimpMarketing', :git => 'https://github.com/mailchimp/mailchimp-market
|
|
|
20
26
|
|
|
21
27
|
```shell
|
|
22
28
|
gem build MailchimpMarketing.gemspec
|
|
23
|
-
gem install ./MailchimpMarketing-3.0.
|
|
24
|
-
gem 'MailchimpMarketing', '~> 3.0.
|
|
29
|
+
gem install ./MailchimpMarketing-3.0.80.gem
|
|
30
|
+
gem 'MailchimpMarketing', '~> 3.0.80'
|
|
25
31
|
```
|
|
26
32
|
|
|
27
33
|
## Quick Start
|
|
@@ -75,17 +81,21 @@ client = MailchimpMarketing::Client.new({
|
|
|
75
81
|
})
|
|
76
82
|
```
|
|
77
83
|
|
|
84
|
+
## PRs and Issues
|
|
85
|
+
This repo is autogenerated from https://github.com/mailchimp/mailchimp-client-lib-codegen -- please submit PRs or issues there!
|
|
86
|
+
|
|
78
87
|
## API Endpoints
|
|
79
88
|
|
|
80
89
|
All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
81
90
|
|
|
82
91
|
| Method | Endpoint |
|
|
83
92
|
| ---------- | -------- |
|
|
84
|
-
| **
|
|
93
|
+
| **accountExport.get_account_exports** | /account-exports/{export_id} |
|
|
94
|
+
| **accountExports.list_account_exports** | /account-exports |
|
|
95
|
+
| **accountExports.create_account_export** | /account-exports |
|
|
85
96
|
| **activityFeed.get_chimp_chatter** | /activity-feed/chimp-chatter |
|
|
86
97
|
| **authorizedApps.list** | /authorized-apps |
|
|
87
98
|
| **authorizedApps.get** | /authorized-apps/{app_id} |
|
|
88
|
-
| **authorizedApps.link** | /authorized-apps |
|
|
89
99
|
| **automations.archive** | /automations/{workflow_id}/actions/archive |
|
|
90
100
|
| **automations.delete_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id} |
|
|
91
101
|
| **automations.list** | /automations |
|
|
@@ -97,7 +107,6 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
97
107
|
| **automations.list_workflow_email_subscribers_removed** | /automations/{workflow_id}/removed-subscribers |
|
|
98
108
|
| **automations.get_removed_workflow_email_subscriber** | /automations/{workflow_id}/removed-subscribers/{subscriber_hash} |
|
|
99
109
|
| **automations.update_workflow_email** | /automations/{workflow_id}/emails/{workflow_email_id} |
|
|
100
|
-
| **automations.update** | /automations/{workflow_id} |
|
|
101
110
|
| **automations.create** | /automations |
|
|
102
111
|
| **automations.pause_all_emails** | /automations/{workflow_id}/actions/pause-all-emails |
|
|
103
112
|
| **automations.start_all_emails** | /automations/{workflow_id}/actions/start-all-emails |
|
|
@@ -150,13 +159,7 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
150
159
|
| **conversations.get** | /conversations/{conversation_id} |
|
|
151
160
|
| **conversations.get_conversation_messages** | /conversations/{conversation_id}/messages |
|
|
152
161
|
| **conversations.get_conversation_message** | /conversations/{conversation_id}/messages/{message_id} |
|
|
153
|
-
| **
|
|
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 |
|
|
162
|
+
| **customerJourneys.trigger** | /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger |
|
|
160
163
|
| **ecommerce.delete_store** | /ecommerce/stores/{store_id} |
|
|
161
164
|
| **ecommerce.delete_store_cart** | /ecommerce/stores/{store_id}/carts/{cart_id} |
|
|
162
165
|
| **ecommerce.delete_cart_line_item** | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |
|
|
@@ -168,7 +171,6 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
168
171
|
| **ecommerce.delete_product_variant** | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |
|
|
169
172
|
| **ecommerce.delete_promo_code** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |
|
|
170
173
|
| **ecommerce.delete_promo_rule** | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |
|
|
171
|
-
| **ecommerce.info** | /ecommerce |
|
|
172
174
|
| **ecommerce.orders** | /ecommerce/orders |
|
|
173
175
|
| **ecommerce.stores** | /ecommerce/stores |
|
|
174
176
|
| **ecommerce.get_store** | /ecommerce/stores/{store_id} |
|
|
@@ -216,14 +218,10 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
216
218
|
| **ecommerce.add_promo_rules** | /ecommerce/stores/{store_id}/promo-rules |
|
|
217
219
|
| **ecommerce.set_store_customer** | /ecommerce/stores/{store_id}/customers/{customer_id} |
|
|
218
220
|
| **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
221
|
| **facebookAds.list** | /facebook-ads |
|
|
223
222
|
| **facebookAds.get_ad** | /facebook-ads/{outreach_id} |
|
|
224
223
|
| **fileManager.delete_file** | /file-manager/files/{file_id} |
|
|
225
224
|
| **fileManager.delete_folder** | /file-manager/folders/{folder_id} |
|
|
226
|
-
| **fileManager.get** | /file-manager |
|
|
227
225
|
| **fileManager.files** | /file-manager/files |
|
|
228
226
|
| **fileManager.get_file** | /file-manager/files/{file_id} |
|
|
229
227
|
| **fileManager.list_folders** | /file-manager/folders |
|
|
@@ -256,7 +254,6 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
256
254
|
| **lists.get_list_abuse_report_details** | /lists/{list_id}/abuse-reports/{report_id} |
|
|
257
255
|
| **lists.get_list_recent_activity** | /lists/{list_id}/activity |
|
|
258
256
|
| **lists.get_list_clients** | /lists/{list_id}/clients |
|
|
259
|
-
| **lists.get_list_external_ids** | /lists/{list_id}/external-ids |
|
|
260
257
|
| **lists.get_list_growth_history** | /lists/{list_id}/growth-history |
|
|
261
258
|
| **lists.get_list_growth_history_by_month** | /lists/{list_id}/growth-history/{month} |
|
|
262
259
|
| **lists.get_list_interest_categories** | /lists/{list_id}/interest-categories |
|
|
@@ -277,6 +274,8 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
277
274
|
| **lists.get_segment** | /lists/{list_id}/segments/{segment_id} |
|
|
278
275
|
| **lists.get_segment_members_list** | /lists/{list_id}/segments/{segment_id}/members |
|
|
279
276
|
| **lists.get_list_signup_forms** | /lists/{list_id}/signup-forms |
|
|
277
|
+
| **lists.get_all_surveys_for_list** | /lists/{list_id}/surveys |
|
|
278
|
+
| **lists.get_survey** | /lists/{list_id}/surveys/{survey_id} |
|
|
280
279
|
| **lists.get_list_webhooks** | /lists/{list_id}/webhooks |
|
|
281
280
|
| **lists.get_list_webhook** | /lists/{list_id}/webhooks/{webhook_id} |
|
|
282
281
|
| **lists.update_list** | /lists/{list_id} |
|
|
@@ -291,7 +290,6 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
291
290
|
| **lists.update_list_member_tags** | /lists/{list_id}/members/{subscriber_hash}/tags |
|
|
292
291
|
| **lists.create_list** | /lists |
|
|
293
292
|
| **lists.batch_list_members** | /lists/{list_id} |
|
|
294
|
-
| **lists.create_list_external_id** | /lists/{list_id}/external-ids |
|
|
295
293
|
| **lists.create_list_interest_category** | /lists/{list_id}/interest-categories |
|
|
296
294
|
| **lists.create_interest_category_interest** | /lists/{list_id}/interest-categories/{interest_category_id}/interests |
|
|
297
295
|
| **lists.add_list_member** | /lists/{list_id}/members |
|
|
@@ -304,16 +302,21 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
304
302
|
| **lists.update_list_signup_form** | /lists/{list_id}/signup-forms |
|
|
305
303
|
| **lists.create_list_webhook** | /lists/{list_id}/webhooks |
|
|
306
304
|
| **lists.list_segments** | /lists/{list_id}/segments |
|
|
307
|
-
| **lists.preview_segment** | /lists/{list_id}/preview-segment |
|
|
308
305
|
| **lists.set_list_member** | /lists/{list_id}/members/{subscriber_hash} |
|
|
306
|
+
| **lists.tag_search** | /lists/{list_id}/tag-search |
|
|
309
307
|
| **ping.get** | /ping |
|
|
310
|
-
| **postcards.get_all** | /postcards |
|
|
311
|
-
| **reporting.info** | /reporting |
|
|
312
308
|
| **reporting.get_facebook_ads_report_all** | /reporting/facebook-ads |
|
|
313
309
|
| **reporting.get_facebook_ad_report** | /reporting/facebook-ads/{outreach_id} |
|
|
314
310
|
| **reporting.get_facebook_ad_product_activity_report** | /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity |
|
|
315
311
|
| **reporting.get_landing_page_reports_all** | /reporting/landing-pages |
|
|
316
312
|
| **reporting.get_landing_page_report** | /reporting/landing-pages/{outreach_id} |
|
|
313
|
+
| **reporting.get_survey_reports_all** | /reporting/surveys |
|
|
314
|
+
| **reporting.get_survey_report** | /reporting/surveys/{outreach_id} |
|
|
315
|
+
| **reporting.get_survey_question_reports_all** | /reporting/surveys/{outreach_id}/questions |
|
|
316
|
+
| **reporting.get_survey_question_report** | /reporting/surveys/{outreach_id}/questions/{question_id} |
|
|
317
|
+
| **reporting.get_survey_question_answers** | /reporting/surveys/{outreach_id}/questions/{question_id}/answers |
|
|
318
|
+
| **reporting.get_survey_responses_all** | /reporting/surveys/{outreach_id}/responses |
|
|
319
|
+
| **reporting.get_survey_response** | /reporting/surveys/{outreach_id}/responses/{response_id} |
|
|
317
320
|
| **reports.get_all_campaign_reports** | /reports |
|
|
318
321
|
| **reports.get_campaign_report** | /reports/{campaign_id} |
|
|
319
322
|
| **reports.get_campaign_abuse_reports** | /reports/{campaign_id}/abuse-reports |
|
|
@@ -339,6 +342,8 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
339
342
|
| **root.get_root** | / |
|
|
340
343
|
| **searchCampaigns.search** | /search-campaigns |
|
|
341
344
|
| **searchMembers.search** | /search-members |
|
|
345
|
+
| **Surveys.publish_survey** | /lists/{list_id}/surveys/{survey_id}/actions/publish |
|
|
346
|
+
| **Surveys.unpublish_survey** | /lists/{list_id}/surveys/{survey_id}/actions/unpublish |
|
|
342
347
|
| **templateFolders.remove** | /template-folders/{folder_id} |
|
|
343
348
|
| **templateFolders.list** | /template-folders |
|
|
344
349
|
| **templateFolders.get** | /template-folders/{folder_id} |
|
|
@@ -357,22 +362,21 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
|
|
|
357
362
|
| **verifiedDomains.submit_domain_verification** | /verified-domains/{domain_name}/actions/verify |
|
|
358
363
|
|
|
359
364
|
|
|
360
|
-
## Additional
|
|
365
|
+
## Additional Libraries
|
|
361
366
|
|
|
362
367
|
Mailchimp Marketing libraries are available in the following languages:
|
|
363
368
|
|
|
364
369
|
<div>
|
|
365
370
|
<a href="https://github.com/mailchimp/mailchimp-marketing-node">
|
|
366
|
-
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/
|
|
371
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_node.png?raw=true" width="44" height="44">
|
|
367
372
|
</a>
|
|
368
373
|
<a href="https://github.com/mailchimp/mailchimp-marketing-php">
|
|
369
|
-
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/
|
|
374
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_php.png?raw=true" width="44" height="44">
|
|
370
375
|
</a>
|
|
371
376
|
<a href="https://github.com/mailchimp/mailchimp-marketing-ruby">
|
|
372
|
-
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/
|
|
377
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_ruby.png?raw=true" width="44" height="44">
|
|
373
378
|
</a>
|
|
374
379
|
<a href="https://github.com/mailchimp/mailchimp-marketing-python">
|
|
375
|
-
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/
|
|
380
|
+
<img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_python.png?raw=true" width="44" height="44">
|
|
376
381
|
</a>
|
|
377
382
|
</div>
|
|
378
|
-
|
|
@@ -0,0 +1,39 @@
|
|
|
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.80
|
|
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
|
+
|
|
15
|
+
module MailchimpMarketing
|
|
16
|
+
class AccountExportApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Get account export info
|
|
24
|
+
def get_account_exports(export_id, opts = {})
|
|
25
|
+
fail ArgumentError, "Missing required param: 'export_id'" if export_id.nil?
|
|
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
|
+
post_body = nil
|
|
31
|
+
|
|
32
|
+
local_var_path = '/account-exports/{export_id}'.sub('{' + 'export_id' + '}', export_id.to_s)
|
|
33
|
+
data = @api_client.call_api(:GET, local_var_path,
|
|
34
|
+
:query_params => query_params,
|
|
35
|
+
:body => post_body)
|
|
36
|
+
return data
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
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.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -13,30 +13,43 @@ Swagger Codegen version: 2.4.12
|
|
|
13
13
|
require 'uri'
|
|
14
14
|
|
|
15
15
|
module MailchimpMarketing
|
|
16
|
-
class
|
|
16
|
+
class AccountExportsApi
|
|
17
17
|
attr_accessor :api_client
|
|
18
18
|
|
|
19
19
|
def initialize(api_client)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
|
|
23
|
-
# List
|
|
24
|
-
def
|
|
25
|
-
fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])
|
|
23
|
+
# List account exports
|
|
24
|
+
def list_account_exports(opts = {})
|
|
26
25
|
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
|
27
26
|
|
|
28
27
|
query_params = {}
|
|
29
|
-
query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
|
|
30
28
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
|
31
29
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
|
32
30
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
31
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
33
32
|
post_body = nil
|
|
34
33
|
|
|
35
|
-
local_var_path = '/
|
|
34
|
+
local_var_path = '/account-exports'
|
|
36
35
|
data = @api_client.call_api(:GET, local_var_path,
|
|
37
36
|
:query_params => query_params,
|
|
38
37
|
:body => post_body)
|
|
39
38
|
return data
|
|
40
39
|
end
|
|
40
|
+
|
|
41
|
+
# Add export
|
|
42
|
+
def create_account_export(body, opts = {})
|
|
43
|
+
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
|
44
|
+
|
|
45
|
+
query_params = {}
|
|
46
|
+
post_body = @api_client.object_to_http_body(body)
|
|
47
|
+
|
|
48
|
+
local_var_path = '/account-exports'
|
|
49
|
+
data = @api_client.call_api(:POST, local_var_path,
|
|
50
|
+
:query_params => query_params,
|
|
51
|
+
:body => post_body)
|
|
52
|
+
return data
|
|
53
|
+
end
|
|
41
54
|
end
|
|
42
55
|
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.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -20,19 +20,6 @@ module MailchimpMarketing
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
|
|
23
|
-
# List activity feed resources
|
|
24
|
-
def get(opts = {})
|
|
25
|
-
|
|
26
|
-
query_params = {}
|
|
27
|
-
post_body = nil
|
|
28
|
-
|
|
29
|
-
local_var_path = '/activity-feed'
|
|
30
|
-
data = @api_client.call_api(:GET, local_var_path,
|
|
31
|
-
:query_params => query_params,
|
|
32
|
-
:body => post_body)
|
|
33
|
-
return data
|
|
34
|
-
end
|
|
35
|
-
|
|
36
23
|
# Get latest chimp chatter
|
|
37
24
|
def get_chimp_chatter(opts = {})
|
|
38
25
|
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -53,19 +53,5 @@ module MailchimpMarketing
|
|
|
53
53
|
:body => post_body)
|
|
54
54
|
return data
|
|
55
55
|
end
|
|
56
|
-
|
|
57
|
-
# Link application
|
|
58
|
-
def link(client_details, opts = {})
|
|
59
|
-
fail ArgumentError, "Missing required param: 'client_details'" if client_details.nil?
|
|
60
|
-
|
|
61
|
-
query_params = {}
|
|
62
|
-
post_body = @api_client.object_to_http_body(client_details)
|
|
63
|
-
|
|
64
|
-
local_var_path = '/authorized-apps'
|
|
65
|
-
data = @api_client.call_api(:POST, local_var_path,
|
|
66
|
-
:query_params => query_params,
|
|
67
|
-
:body => post_body)
|
|
68
|
-
return data
|
|
69
|
-
end
|
|
70
56
|
end
|
|
71
57
|
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.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -51,15 +51,18 @@ module MailchimpMarketing
|
|
|
51
51
|
|
|
52
52
|
# List automations
|
|
53
53
|
def list(opts = {})
|
|
54
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
|
54
55
|
fail ArgumentError, 'invalid value for "status", must be one of save, paused, sending' if opts[:'status'] && !['save', 'paused', 'sending'].include?(opts[:'status'])
|
|
55
56
|
|
|
56
57
|
query_params = {}
|
|
58
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
59
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
57
60
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
|
58
61
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
|
59
62
|
query_params[:'before_create_time'] = opts[:'before_create_time'] if !opts[:'before_create_time'].nil?
|
|
60
63
|
query_params[:'since_create_time'] = opts[:'since_create_time'] if !opts[:'since_create_time'].nil?
|
|
61
|
-
query_params[:'
|
|
62
|
-
query_params[:'
|
|
64
|
+
query_params[:'before_start_time'] = opts[:'before_start_time'] if !opts[:'before_start_time'].nil?
|
|
65
|
+
query_params[:'since_start_time'] = opts[:'since_start_time'] if !opts[:'since_start_time'].nil?
|
|
63
66
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
64
67
|
post_body = nil
|
|
65
68
|
|
|
@@ -191,21 +194,6 @@ module MailchimpMarketing
|
|
|
191
194
|
return data
|
|
192
195
|
end
|
|
193
196
|
|
|
194
|
-
# Update automation
|
|
195
|
-
def update(workflow_id, body, opts = {})
|
|
196
|
-
fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
|
|
197
|
-
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
|
198
|
-
|
|
199
|
-
query_params = {}
|
|
200
|
-
post_body = @api_client.object_to_http_body(body)
|
|
201
|
-
|
|
202
|
-
local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
|
|
203
|
-
data = @api_client.call_api(:PATCH, local_var_path,
|
|
204
|
-
:query_params => query_params,
|
|
205
|
-
:body => post_body)
|
|
206
|
-
return data
|
|
207
|
-
end
|
|
208
|
-
|
|
209
197
|
# Add automation
|
|
210
198
|
def create(body, opts = {})
|
|
211
199
|
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.0.
|
|
6
|
+
OpenAPI spec version: 3.0.80
|
|
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
|
|
@@ -94,20 +94,5 @@ module MailchimpMarketing
|
|
|
94
94
|
:body => post_body)
|
|
95
95
|
return data
|
|
96
96
|
end
|
|
97
|
-
|
|
98
|
-
# Post message
|
|
99
|
-
def create_conversation_message(conversation_id, body, opts = {})
|
|
100
|
-
fail ArgumentError, "Missing required param: 'conversation_id'" if conversation_id.nil?
|
|
101
|
-
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
|
102
|
-
|
|
103
|
-
query_params = {}
|
|
104
|
-
post_body = @api_client.object_to_http_body(body)
|
|
105
|
-
|
|
106
|
-
local_var_path = '/conversations/{conversation_id}/messages'.sub('{' + 'conversation_id' + '}', conversation_id.to_s)
|
|
107
|
-
data = @api_client.call_api(:POST, local_var_path,
|
|
108
|
-
:query_params => query_params,
|
|
109
|
-
:body => post_body)
|
|
110
|
-
return data
|
|
111
|
-
end
|
|
112
97
|
end
|
|
113
98
|
end
|
|
@@ -0,0 +1,39 @@
|
|
|
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.80
|
|
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
|
+
|
|
15
|
+
module MailchimpMarketing
|
|
16
|
+
class CustomerJourneysApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Customer Journeys API trigger for a contact
|
|
24
|
+
def trigger(journey_id, step_id, body, opts = {})
|
|
25
|
+
fail ArgumentError, "Missing required param: 'journey_id'" if journey_id.nil?
|
|
26
|
+
fail ArgumentError, "Missing required param: 'step_id'" if step_id.nil?
|
|
27
|
+
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
|
28
|
+
|
|
29
|
+
query_params = {}
|
|
30
|
+
post_body = @api_client.object_to_http_body(body)
|
|
31
|
+
|
|
32
|
+
local_var_path = '/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger'.sub('{' + 'journey_id' + '}', journey_id.to_s).sub('{' + 'step_id' + '}', step_id.to_s)
|
|
33
|
+
data = @api_client.call_api(:POST, local_var_path,
|
|
34
|
+
:query_params => query_params,
|
|
35
|
+
:body => post_body)
|
|
36
|
+
return data
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|