@marketing-sdk/mailchimp 0.1.1-experimental.0 → 0.1.1-experimental.1
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.
- package/README.md +37 -0
- package/package.json +28 -5
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @marketing-sdk/mailchimp
|
|
2
|
+
|
|
3
|
+
Mailchimp provider client for subscribers, audiences, campaigns, templates, reports, and automations.
|
|
4
|
+
|
|
5
|
+
> Status: experimental. APIs may change before a stable 1.0.0 release.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @marketing-sdk/core @marketing-sdk/mailchimp
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { MailchimpClient } from '@marketing-sdk/mailchimp';
|
|
17
|
+
|
|
18
|
+
const mailchimp = new MailchimpClient({
|
|
19
|
+
apiKey: process.env.MAILCHIMP_API_KEY!,
|
|
20
|
+
serverPrefix: process.env.MAILCHIMP_SERVER_PREFIX!,
|
|
21
|
+
audienceId: process.env.MAILCHIMP_AUDIENCE_ID!,
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
const { data, error } = await mailchimp.addSubscriber({
|
|
25
|
+
email: 'customer@example.com',
|
|
26
|
+
status: 'subscribed',
|
|
27
|
+
});
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Documentation
|
|
31
|
+
|
|
32
|
+
- [Provider docs](https://github.com/cody9swann/marketing-sdk/blob/main/docs/mailchimp.md)
|
|
33
|
+
- [Repository README](https://github.com/cody9swann/marketing-sdk#readme)
|
|
34
|
+
|
|
35
|
+
## License
|
|
36
|
+
|
|
37
|
+
MIT.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@marketing-sdk/mailchimp",
|
|
3
|
-
"version": "0.1.1-experimental.
|
|
4
|
-
"description": "Mailchimp provider for marketing-sdk",
|
|
3
|
+
"version": "0.1.1-experimental.1",
|
|
4
|
+
"description": "Mailchimp provider for @marketing-sdk",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"exports": {
|
|
@@ -18,10 +18,10 @@
|
|
|
18
18
|
"access": "public"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@marketing-sdk/core": "0.1.1-experimental.
|
|
21
|
+
"@marketing-sdk/core": "0.1.1-experimental.1"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
|
-
"@marketing-sdk/core": ">=0.1.
|
|
24
|
+
"@marketing-sdk/core": ">=0.1.1-experimental.1"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"typescript": "^5.3.0",
|
|
@@ -30,10 +30,33 @@
|
|
|
30
30
|
"@types/jest": "^29.5.0",
|
|
31
31
|
"@types/node": "^20.0.0"
|
|
32
32
|
},
|
|
33
|
+
"license": "MIT",
|
|
34
|
+
"repository": {
|
|
35
|
+
"type": "git",
|
|
36
|
+
"url": "git+https://github.com/cody9swann/marketing-sdk.git",
|
|
37
|
+
"directory": "packages/mailchimp"
|
|
38
|
+
},
|
|
39
|
+
"bugs": {
|
|
40
|
+
"url": "https://github.com/cody9swann/marketing-sdk/issues"
|
|
41
|
+
},
|
|
42
|
+
"homepage": "https://github.com/cody9swann/marketing-sdk#readme",
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=18"
|
|
45
|
+
},
|
|
46
|
+
"sideEffects": false,
|
|
47
|
+
"keywords": [
|
|
48
|
+
"marketing",
|
|
49
|
+
"sdk",
|
|
50
|
+
"typescript",
|
|
51
|
+
"mailchimp"
|
|
52
|
+
],
|
|
33
53
|
"scripts": {
|
|
34
54
|
"build": "tsc",
|
|
55
|
+
"dev": "tsc -w",
|
|
35
56
|
"test": "jest",
|
|
57
|
+
"test:watch": "jest --watch",
|
|
36
58
|
"test:coverage": "jest --coverage",
|
|
37
|
-
"typecheck": "tsc --noEmit"
|
|
59
|
+
"typecheck": "tsc --noEmit",
|
|
60
|
+
"clean": "rm -rf dist"
|
|
38
61
|
}
|
|
39
62
|
}
|