@kumbify/sdk 1.0.5 → 1.0.8
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 +51 -17
- package/dist/kmail/KMailClient.js +2 -2
- package/dist/kmail/KMailClient.js.map +1 -1
- package/dist/utils/types.d.ts +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This SDK makes it easy to integrate messaging (email + SMS) into your apps with
|
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
###
|
|
11
|
+
### Installation
|
|
12
12
|
|
|
13
13
|
Install using npm:
|
|
14
14
|
|
|
@@ -22,13 +22,12 @@ or using Yarn:
|
|
|
22
22
|
yarn add @kumbify/sdk
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
###
|
|
25
|
+
### Importing
|
|
26
26
|
|
|
27
27
|
```ts
|
|
28
28
|
import { KMailClient, KSMSClient } from "@kumbify/sdk";
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
|
|
32
31
|
### Email — KMailClient
|
|
33
32
|
|
|
34
33
|
#### 📍 Create an Email Client
|
|
@@ -42,25 +41,58 @@ const mailClient = new KMailClient({
|
|
|
42
41
|
```ts
|
|
43
42
|
// 📤 Send a Simple Email
|
|
44
43
|
const sendMail = await mailClient.sendSimpleMail({
|
|
45
|
-
|
|
46
|
-
body_text: "Hello from Kumbify — this is a test email.",
|
|
47
|
-
from_address: "no-reply@kumbify.app",
|
|
44
|
+
from: "no-reply@kumbify.com",
|
|
48
45
|
subject: "Welcome Email",
|
|
49
|
-
|
|
46
|
+
to: ["user1@example.com"],
|
|
47
|
+
body: {
|
|
48
|
+
html: "<h1>Hello from Kumbify</h1><p>This is a test email</p>",
|
|
49
|
+
text: "Hello from Kumbify — this is a test email.",
|
|
50
|
+
},
|
|
50
51
|
});
|
|
51
52
|
|
|
52
|
-
console.log("Email Response:", sendMail);
|
|
53
|
+
console.log("Email Response: ", sendMail);
|
|
53
54
|
```
|
|
54
55
|
|
|
55
56
|
**Parameters explained:**
|
|
56
57
|
|
|
57
58
|
| Property | Type | Description |
|
|
58
59
|
| -------------- | -------- | --------------------------------- |
|
|
59
|
-
| `
|
|
60
|
-
| `
|
|
61
|
-
| `
|
|
60
|
+
| `body.html` | string | HTML email content |
|
|
61
|
+
| `body.text` | string | Plain text email content |
|
|
62
|
+
| `from` | string | Sender email address |
|
|
62
63
|
| `subject` | string | Email subject |
|
|
63
|
-
| `
|
|
64
|
+
| `to` | string[] | List of recipient email addresses |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
// 📤 Send a Template Email
|
|
70
|
+
const sendMail = await mailClient.sendTemplateMail({
|
|
71
|
+
from: "app@example.com",
|
|
72
|
+
to: ["user@example.com"],
|
|
73
|
+
template: {
|
|
74
|
+
name: "my-template-name",
|
|
75
|
+
data: {
|
|
76
|
+
customer: {
|
|
77
|
+
name: "Ricardo Castle",
|
|
78
|
+
email: "doe@gmail.com"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
},
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
console.log("Email Response: ", sendMail);
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**Parameters explained:**
|
|
89
|
+
|
|
90
|
+
| Property | Type | Description |
|
|
91
|
+
| --------------- | -------- | ------------------------------------------------------------------------ |
|
|
92
|
+
| `from` | string | Sender email address. Must be a verified domain in your Kumbify account. |
|
|
93
|
+
| `to` | string[] | List of recipient email addresses. |
|
|
94
|
+
| `template.name` | string | Name of the template created in your Kumbify dashboard. |
|
|
95
|
+
| `template.data` | object | Dynamic data that will be injected into the template. |
|
|
64
96
|
|
|
65
97
|
---
|
|
66
98
|
|
|
@@ -96,7 +128,7 @@ console.log("SMS sent successfully!");
|
|
|
96
128
|
|
|
97
129
|
---
|
|
98
130
|
|
|
99
|
-
###
|
|
131
|
+
### Example Usage All Together
|
|
100
132
|
|
|
101
133
|
```ts
|
|
102
134
|
import { KMailClient, KSMSClient } from "@kumbify/sdk";
|
|
@@ -106,11 +138,13 @@ const smsClient = new KSMSClient({ apiKey: "SMS_KEY" });
|
|
|
106
138
|
|
|
107
139
|
// Send Email
|
|
108
140
|
await mailClient.sendSimpleMail({
|
|
109
|
-
|
|
110
|
-
body_text: "Hello!",
|
|
111
|
-
from_address: "no-reply@kumbify.com",
|
|
141
|
+
from: "no-reply@kumbify.com",
|
|
112
142
|
subject: "Test Email",
|
|
113
|
-
|
|
143
|
+
to: ["user1@example.com"],
|
|
144
|
+
body: {
|
|
145
|
+
html: "<p>Hello!</p>",
|
|
146
|
+
text: "Hello!",
|
|
147
|
+
},
|
|
114
148
|
});
|
|
115
149
|
|
|
116
150
|
// Send SMS
|
|
@@ -17,8 +17,8 @@ class KMailClient {
|
|
|
17
17
|
from_address: data.from,
|
|
18
18
|
to_address: data.to,
|
|
19
19
|
subject: data.subject,
|
|
20
|
-
body_html: data.
|
|
21
|
-
body_text: data.
|
|
20
|
+
body_html: data.body.html,
|
|
21
|
+
body_text: data.body.text,
|
|
22
22
|
}, { headers: { "kumbi-api-key": "Bearer " + this.apiKey } });
|
|
23
23
|
return response.data;
|
|
24
24
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KMailClient.js","sourceRoot":"","sources":["../../src/kmail/KMailClient.ts"],"names":[],"mappings":";;;;;;AAKA,8CAA8C;AAE9C,kDAA0B;AAE1B,MAAa,WAAW;IACd,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,EAAsB;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,IAAI,EAA+B;QAC3D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,oBAAU,CAAC,SAAS,GAAG,OAAO,EAC9B;gBACE,YAAY,EAAE,IAAI,CAAC,IAAI;gBACvB,UAAU,EAAE,IAAI,CAAC,EAAE;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,SAAS,EAAE,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"KMailClient.js","sourceRoot":"","sources":["../../src/kmail/KMailClient.ts"],"names":[],"mappings":";;;;;;AAKA,8CAA8C;AAE9C,kDAA0B;AAE1B,MAAa,WAAW;IACd,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,EAAsB;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,IAAI,EAA+B;QAC3D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,oBAAU,CAAC,SAAS,GAAG,OAAO,EAC9B;gBACE,YAAY,EAAE,IAAI,CAAC,IAAI;gBACvB,UAAU,EAAE,IAAI,CAAC,EAAE;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;gBACzB,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;aAC1B,EACD,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAC1D,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;gBAClC,MAAM,IAAI,KAAK,CACb,wBAAwB,MAAM,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAC3D,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,EAAE,GAAG,IAAI,EAAiC;QAC/D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,oBAAU,CAAC,SAAS,GAAG,OAAO,EAC9B;gBACE,YAAY,EAAE,IAAI,CAAC,IAAI;gBACvB,UAAU,EAAE,IAAI,CAAC,EAAE;gBACnB,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;gBACjC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;aAClC,EACD,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAC1D,CAAC;YAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;gBAClC,MAAM,IAAI,KAAK,CACb,wBAAwB,MAAM,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAC3D,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AA3DD,kCA2DC"}
|
package/dist/utils/types.d.ts
CHANGED
package/package.json
CHANGED