@brandedmail/node 1.0.1 → 1.0.2
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 +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,13 +10,13 @@ Use this package to send branded transactional emails from Node.js / TypeScript
|
|
|
10
10
|
### Installation
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
npm install @brandedmail
|
|
13
|
+
npm install @brandedmail
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
### Quick start
|
|
17
17
|
|
|
18
18
|
```ts
|
|
19
|
-
import Brandedmail from "@brandedmail
|
|
19
|
+
import Brandedmail from "@brandedmail/node";
|
|
20
20
|
|
|
21
21
|
const client = new Brandedmail(process.env.BRANDEDMAIL_API_KEY!);
|
|
22
22
|
|
|
@@ -46,7 +46,7 @@ The SDK exposes two main methods on the `Brandedmail` client:
|
|
|
46
46
|
### Template emails
|
|
47
47
|
|
|
48
48
|
```ts
|
|
49
|
-
import Brandedmail, { TEMPLATES, type SendEmailOptions } from "@brandedmail
|
|
49
|
+
import Brandedmail, { TEMPLATES, type SendEmailOptions } from "@brandedmail/node";
|
|
50
50
|
|
|
51
51
|
const client = new Brandedmail(process.env.BRANDEDMAIL_API_KEY!);
|
|
52
52
|
|
|
@@ -72,7 +72,7 @@ Supported templates are exposed via `TEMPLATES` and validated with [`zod`](https
|
|
|
72
72
|
### Custom HTML emails
|
|
73
73
|
|
|
74
74
|
```ts
|
|
75
|
-
import Brandedmail, { type SendHtmlOptions } from "@brandedmail
|
|
75
|
+
import Brandedmail, { type SendHtmlOptions } from "@brandedmail/node";
|
|
76
76
|
|
|
77
77
|
const client = new Brandedmail(process.env.BRANDEDMAIL_API_KEY!);
|
|
78
78
|
|
|
@@ -98,7 +98,7 @@ import Brandedmail, {
|
|
|
98
98
|
BrandedMailForbiddenError,
|
|
99
99
|
BrandedMailNotFoundError,
|
|
100
100
|
BrandedMailServerError,
|
|
101
|
-
} from "@brandedmail
|
|
101
|
+
} from "@brandedmail/node";
|
|
102
102
|
|
|
103
103
|
const client = new Brandedmail(process.env.BRANDEDMAIL_API_KEY!);
|
|
104
104
|
|
|
@@ -144,7 +144,7 @@ import {
|
|
|
144
144
|
type SendEmailOptions,
|
|
145
145
|
type SendHtmlOptions,
|
|
146
146
|
type BrandedMailResponse,
|
|
147
|
-
} from "@brandedmail
|
|
147
|
+
} from "@brandedmail/node";
|
|
148
148
|
```
|
|
149
149
|
|
|
150
150
|
---
|