@productcraft/mail 0.2.3 → 0.3.0
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 +7 -7
- package/dist/index.d.cts +6237 -1262
- package/dist/index.d.ts +6237 -1262
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Server-side only. The SDK ships a Platform API Key in the `Authorization` header
|
|
|
10
10
|
|
|
11
11
|
## Quick start
|
|
12
12
|
|
|
13
|
-
```ts
|
|
13
|
+
```ts before
|
|
14
14
|
import { Mail } from "@productcraft/mail";
|
|
15
15
|
|
|
16
16
|
// Reads PRODUCTCRAFT_API_KEY from the environment
|
|
@@ -53,7 +53,7 @@ PRODUCTCRAFT_API_KEY=pcft_live_...
|
|
|
53
53
|
|
|
54
54
|
## Configuration
|
|
55
55
|
|
|
56
|
-
```ts
|
|
56
|
+
```ts before
|
|
57
57
|
new Mail({
|
|
58
58
|
// The auth credential the SDK presents to Mail
|
|
59
59
|
// Omit to use PRODUCTCRAFT_API_KEY from the environment
|
|
@@ -73,7 +73,7 @@ Every path is workspace-scoped — `{workspace_id}` is the UUID of the workspace
|
|
|
73
73
|
|
|
74
74
|
### Templates
|
|
75
75
|
|
|
76
|
-
```ts
|
|
76
|
+
```ts before
|
|
77
77
|
// List templates
|
|
78
78
|
await mail.client.GET(
|
|
79
79
|
"/v1/workspaces/{workspace_id}/templates",
|
|
@@ -115,7 +115,7 @@ await mail.client.POST(
|
|
|
115
115
|
|
|
116
116
|
### Domains + DKIM
|
|
117
117
|
|
|
118
|
-
```ts
|
|
118
|
+
```ts before
|
|
119
119
|
// List domains
|
|
120
120
|
await mail.client.GET("/v1/workspaces/{workspace_id}/domains", { ... });
|
|
121
121
|
|
|
@@ -134,7 +134,7 @@ await mail.client.POST(
|
|
|
134
134
|
|
|
135
135
|
### Messages
|
|
136
136
|
|
|
137
|
-
```ts
|
|
137
|
+
```ts before
|
|
138
138
|
// Workspace-wide message listing + filters
|
|
139
139
|
await mail.client.GET(
|
|
140
140
|
"/v1/workspaces/{workspace_id}/messages",
|
|
@@ -151,7 +151,7 @@ await mail.client.GET(
|
|
|
151
151
|
|
|
152
152
|
### Suppression list
|
|
153
153
|
|
|
154
|
-
```ts
|
|
154
|
+
```ts before
|
|
155
155
|
// Add an email to the workspace suppression list
|
|
156
156
|
await mail.client.POST(
|
|
157
157
|
"/v1/workspaces/{workspace_id}/suppression",
|
|
@@ -161,7 +161,7 @@ await mail.client.POST(
|
|
|
161
161
|
|
|
162
162
|
### Outbound webhooks
|
|
163
163
|
|
|
164
|
-
```ts
|
|
164
|
+
```ts before
|
|
165
165
|
// Configure the workspace's default webhook (delivery / open / bounce events)
|
|
166
166
|
await mail.client.PUT(
|
|
167
167
|
"/v1/workspaces/{workspace_id}/webhooks/default",
|