@iterable/api 0.0.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/LICENSE +21 -0
- package/README.md +74 -0
- package/dist/client/base.d.ts +33 -0
- package/dist/client/base.d.ts.map +1 -0
- package/dist/client/base.js +155 -0
- package/dist/client/base.js.map +1 -0
- package/dist/client/campaigns.d.ts +71 -0
- package/dist/client/campaigns.d.ts.map +1 -0
- package/dist/client/campaigns.js +125 -0
- package/dist/client/campaigns.js.map +1 -0
- package/dist/client/catalogs.d.ts +60 -0
- package/dist/client/catalogs.d.ts.map +1 -0
- package/dist/client/catalogs.js +138 -0
- package/dist/client/catalogs.js.map +1 -0
- package/dist/client/events.d.ts +38 -0
- package/dist/client/events.d.ts.map +1 -0
- package/dist/client/events.js +38 -0
- package/dist/client/events.js.map +1 -0
- package/dist/client/experiments.d.ts +24 -0
- package/dist/client/experiments.d.ts.map +1 -0
- package/dist/client/experiments.js +29 -0
- package/dist/client/experiments.js.map +1 -0
- package/dist/client/export.d.ts +27 -0
- package/dist/client/export.d.ts.map +1 -0
- package/dist/client/export.js +31 -0
- package/dist/client/export.js.map +1 -0
- package/dist/client/index.d.ts +315 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +25 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/journeys.d.ts +26 -0
- package/dist/client/journeys.d.ts.map +1 -0
- package/dist/client/journeys.js +32 -0
- package/dist/client/journeys.js.map +1 -0
- package/dist/client/lists.d.ts +39 -0
- package/dist/client/lists.d.ts.map +1 -0
- package/dist/client/lists.js +80 -0
- package/dist/client/lists.js.map +1 -0
- package/dist/client/messaging.d.ts +39 -0
- package/dist/client/messaging.d.ts.map +1 -0
- package/dist/client/messaging.js +110 -0
- package/dist/client/messaging.js.map +1 -0
- package/dist/client/snippets.d.ts +37 -0
- package/dist/client/snippets.d.ts.map +1 -0
- package/dist/client/snippets.js +29 -0
- package/dist/client/snippets.js.map +1 -0
- package/dist/client/subscriptions.d.ts +26 -0
- package/dist/client/subscriptions.d.ts.map +1 -0
- package/dist/client/subscriptions.js +31 -0
- package/dist/client/subscriptions.js.map +1 -0
- package/dist/client/templates.d.ts +52 -0
- package/dist/client/templates.d.ts.map +1 -0
- package/dist/client/templates.js +132 -0
- package/dist/client/templates.js.map +1 -0
- package/dist/client/users.d.ts +76 -0
- package/dist/client/users.d.ts.map +1 -0
- package/dist/client/users.js +115 -0
- package/dist/client/users.js.map +1 -0
- package/dist/client/webhooks.d.ts +25 -0
- package/dist/client/webhooks.d.ts.map +1 -0
- package/dist/client/webhooks.js +17 -0
- package/dist/client/webhooks.js.map +1 -0
- package/dist/config.d.ts +26 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +51 -0
- package/dist/config.js.map +1 -0
- package/dist/errors.d.ts +45 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +144 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +25 -0
- package/dist/index.js.map +1 -0
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -0
- package/dist/logger.js +32 -0
- package/dist/logger.js.map +1 -0
- package/dist/types/campaigns.d.ts +307 -0
- package/dist/types/campaigns.d.ts.map +1 -0
- package/dist/types/campaigns.js +226 -0
- package/dist/types/campaigns.js.map +1 -0
- package/dist/types/catalogs.d.ts +138 -0
- package/dist/types/catalogs.d.ts.map +1 -0
- package/dist/types/catalogs.js +139 -0
- package/dist/types/catalogs.js.map +1 -0
- package/dist/types/common.d.ts +145 -0
- package/dist/types/common.d.ts.map +1 -0
- package/dist/types/common.js +110 -0
- package/dist/types/common.js.map +1 -0
- package/dist/types/events.d.ts +124 -0
- package/dist/types/events.d.ts.map +1 -0
- package/dist/types/events.js +118 -0
- package/dist/types/events.js.map +1 -0
- package/dist/types/experiments.d.ts +14 -0
- package/dist/types/experiments.d.ts.map +1 -0
- package/dist/types/experiments.js +24 -0
- package/dist/types/experiments.js.map +1 -0
- package/dist/types/export.d.ts +121 -0
- package/dist/types/export.d.ts.map +1 -0
- package/dist/types/export.js +105 -0
- package/dist/types/export.js.map +1 -0
- package/dist/types/journeys.d.ts +72 -0
- package/dist/types/journeys.d.ts.map +1 -0
- package/dist/types/journeys.js +65 -0
- package/dist/types/journeys.js.map +1 -0
- package/dist/types/lists.d.ts +149 -0
- package/dist/types/lists.d.ts.map +1 -0
- package/dist/types/lists.js +140 -0
- package/dist/types/lists.js.map +1 -0
- package/dist/types/messaging.d.ts +246 -0
- package/dist/types/messaging.d.ts.map +1 -0
- package/dist/types/messaging.js +323 -0
- package/dist/types/messaging.js.map +1 -0
- package/dist/types/snippets.d.ts +89 -0
- package/dist/types/snippets.d.ts.map +1 -0
- package/dist/types/snippets.js +85 -0
- package/dist/types/snippets.js.map +1 -0
- package/dist/types/subscriptions.d.ts +63 -0
- package/dist/types/subscriptions.d.ts.map +1 -0
- package/dist/types/subscriptions.js +40 -0
- package/dist/types/subscriptions.js.map +1 -0
- package/dist/types/templates.d.ts +315 -0
- package/dist/types/templates.d.ts.map +1 -0
- package/dist/types/templates.js +357 -0
- package/dist/types/templates.js.map +1 -0
- package/dist/types/users.d.ts +144 -0
- package/dist/types/users.d.ts.map +1 -0
- package/dist/types/users.js +189 -0
- package/dist/types/users.js.map +1 -0
- package/dist/types/webhooks.d.ts +52 -0
- package/dist/types/webhooks.d.ts.map +1 -0
- package/dist/types/webhooks.js +32 -0
- package/dist/types/webhooks.js.map +1 -0
- package/package.json +73 -0
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { IterableSuccessResponseSchema } from "../types/common.js";
|
|
2
|
+
import { ChannelsResponseSchema, GetInAppMessagesResponseSchema, MessageTypesResponseSchema, } from "../types/messaging.js";
|
|
3
|
+
/**
|
|
4
|
+
* Messaging operations mixin
|
|
5
|
+
*/
|
|
6
|
+
export function Messaging(Base) {
|
|
7
|
+
return class extends Base {
|
|
8
|
+
// Email Sending
|
|
9
|
+
async sendEmail(request) {
|
|
10
|
+
const response = await this.client.post("/api/email/target", request);
|
|
11
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
12
|
+
}
|
|
13
|
+
async cancelEmail(options) {
|
|
14
|
+
const response = await this.client.post("/api/email/cancel", options);
|
|
15
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
16
|
+
}
|
|
17
|
+
// SMS
|
|
18
|
+
async sendSMS(options) {
|
|
19
|
+
const response = await this.client.post("/api/sms/target", options);
|
|
20
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
21
|
+
}
|
|
22
|
+
async cancelSMS(options) {
|
|
23
|
+
const response = await this.client.post("/api/sms/cancel", options);
|
|
24
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
25
|
+
}
|
|
26
|
+
// Push Notifications
|
|
27
|
+
async sendPush(options) {
|
|
28
|
+
const response = await this.client.post("/api/push/target", options);
|
|
29
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
30
|
+
}
|
|
31
|
+
async cancelPush(options) {
|
|
32
|
+
const response = await this.client.post("/api/push/cancel", options);
|
|
33
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
34
|
+
}
|
|
35
|
+
// Web Push Messages
|
|
36
|
+
async sendWebPush(request) {
|
|
37
|
+
const response = await this.client.post("/api/webPush/target", request);
|
|
38
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
39
|
+
}
|
|
40
|
+
async cancelWebPush(options) {
|
|
41
|
+
const response = await this.client.post("/api/webPush/cancel", options);
|
|
42
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
43
|
+
}
|
|
44
|
+
// WhatsApp Messages
|
|
45
|
+
async sendWhatsApp(request) {
|
|
46
|
+
const response = await this.client.post("/api/whatsApp/target", request);
|
|
47
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
48
|
+
}
|
|
49
|
+
async cancelWhatsApp(options) {
|
|
50
|
+
const response = await this.client.post("/api/whatsApp/cancel", options);
|
|
51
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
52
|
+
}
|
|
53
|
+
// In-App Messages
|
|
54
|
+
async getInAppMessages(options) {
|
|
55
|
+
const params = new URLSearchParams();
|
|
56
|
+
if (options.email)
|
|
57
|
+
params.append("email", options.email);
|
|
58
|
+
if (options.userId)
|
|
59
|
+
params.append("userId", options.userId);
|
|
60
|
+
if (options.count)
|
|
61
|
+
params.append("count", options.count.toString());
|
|
62
|
+
if (options.platform)
|
|
63
|
+
params.append("platform", options.platform);
|
|
64
|
+
const response = await this.client.get(`/api/inApp/getMessages?${params.toString()}`);
|
|
65
|
+
return this.validateResponse(response, GetInAppMessagesResponseSchema);
|
|
66
|
+
}
|
|
67
|
+
async sendInApp(options) {
|
|
68
|
+
const response = await this.client.post("/api/inApp/target", options);
|
|
69
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
70
|
+
}
|
|
71
|
+
async cancelInApp(params) {
|
|
72
|
+
const response = await this.client.post("/api/inApp/cancel", params);
|
|
73
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
74
|
+
}
|
|
75
|
+
// Embedded Messaging
|
|
76
|
+
async getEmbeddedMessages(params) {
|
|
77
|
+
const queryParams = new URLSearchParams();
|
|
78
|
+
if (params.email)
|
|
79
|
+
queryParams.append("email", params.email);
|
|
80
|
+
if (params.userId)
|
|
81
|
+
queryParams.append("userId", params.userId);
|
|
82
|
+
if (params.platform)
|
|
83
|
+
queryParams.append("platform", params.platform);
|
|
84
|
+
if (params.sdkVersion)
|
|
85
|
+
queryParams.append("sdkVersion", params.sdkVersion);
|
|
86
|
+
if (params.packageName)
|
|
87
|
+
queryParams.append("packageName", params.packageName);
|
|
88
|
+
// Handle array parameters
|
|
89
|
+
if (params.placementIds) {
|
|
90
|
+
params.placementIds.forEach((id) => queryParams.append("placementIds", String(id)));
|
|
91
|
+
}
|
|
92
|
+
if (params.currentMessageIds) {
|
|
93
|
+
params.currentMessageIds.forEach((id) => queryParams.append("currentMessageIds", id));
|
|
94
|
+
}
|
|
95
|
+
const response = await this.client.get(`/api/embedded-messaging/messages?${queryParams.toString()}`);
|
|
96
|
+
return response.data;
|
|
97
|
+
}
|
|
98
|
+
// get available message channels
|
|
99
|
+
async getChannels() {
|
|
100
|
+
const response = await this.client.get("/api/channels");
|
|
101
|
+
return this.validateResponse(response, ChannelsResponseSchema);
|
|
102
|
+
}
|
|
103
|
+
// get all message types within the project
|
|
104
|
+
async getMessageTypes() {
|
|
105
|
+
const response = await this.client.get("/api/messageTypes");
|
|
106
|
+
return this.validateResponse(response, MessageTypesResponseSchema);
|
|
107
|
+
}
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
//# sourceMappingURL=messaging.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/client/messaging.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAQL,sBAAsB,EAKtB,8BAA8B,EAE9B,0BAA0B,GAO3B,MAAM,uBAAuB,CAAC;AAG/B;;GAEG;AACH,MAAM,UAAU,SAAS,CAA4C,IAAO;IAC1E,OAAO,KAAM,SAAQ,IAAI;QACvB,gBAAgB;QAChB,KAAK,CAAC,SAAS,CACb,OAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACtE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,WAAW,CACf,OAA0B;YAE1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACtE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,MAAM;QACN,KAAK,CAAC,OAAO,CAAC,OAAsB;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;YACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,SAAS,CACb,OAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;YACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,qBAAqB;QACrB,KAAK,CAAC,QAAQ,CAAC,OAAuB;YACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,UAAU,CACd,OAAyB;YAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,oBAAoB;QACpB,KAAK,CAAC,WAAW,CACf,OAA0B;YAE1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YACxE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,aAAa,CACjB,OAA4B;YAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YACxE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,oBAAoB;QACpB,KAAK,CAAC,YAAY,CAChB,OAA2B;YAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,cAAc,CAClB,OAA6B;YAE7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,kBAAkB;QAClB,KAAK,CAAC,gBAAgB,CACpB,OAA+B;YAE/B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,KAAK;gBAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,OAAO,CAAC,MAAM;gBAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YAC5D,IAAI,OAAO,CAAC,KAAK;gBAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACpE,IAAI,OAAO,CAAC,QAAQ;gBAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,0BAA0B,MAAM,CAAC,QAAQ,EAAE,EAAE,CAC9C,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC;QACzE,CAAC;QAED,KAAK,CAAC,SAAS,CACb,OAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACtE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,WAAW,CACf,MAAyB;YAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,qBAAqB;QACrB,KAAK,CAAC,mBAAmB,CACvB,MAAiC;YAEjC,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAE1C,IAAI,MAAM,CAAC,KAAK;gBAAE,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5D,IAAI,MAAM,CAAC,MAAM;gBAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC/D,IAAI,MAAM,CAAC,QAAQ;gBAAE,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YACrE,IAAI,MAAM,CAAC,UAAU;gBACnB,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;YACtD,IAAI,MAAM,CAAC,WAAW;gBACpB,WAAW,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YAExD,0BAA0B;YAC1B,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;gBACxB,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACjC,WAAW,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAC/C,CAAC;YACJ,CAAC;YACD,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACtC,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAC5C,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,oCAAoC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAC7D,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,iCAAiC;QACjC,KAAK,CAAC,WAAW;YACf,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YACxD,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;QACjE,CAAC;QAED,2CAA2C;QAC3C,KAAK,CAAC,eAAe;YACnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAC5D,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,0BAA0B,CAAC,CAAC;QACrE,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { CreateSnippetRequest, CreateSnippetResponse, DeleteSnippetParams, DeleteSnippetResponse, GetSnippetParams, GetSnippetResponse, GetSnippetsResponse, UpdateSnippetParams, UpdateSnippetRequest, UpdateSnippetResponse } from "../types/snippets.js";
|
|
2
|
+
import type { BaseIterableClient, Constructor } from "./base.js";
|
|
3
|
+
/**
|
|
4
|
+
* Snippets operations mixin
|
|
5
|
+
*/
|
|
6
|
+
export declare function Snippets<T extends Constructor<BaseIterableClient>>(Base: T): {
|
|
7
|
+
new (...args: any[]): {
|
|
8
|
+
getSnippets(opts?: {
|
|
9
|
+
signal?: AbortSignal;
|
|
10
|
+
}): Promise<GetSnippetsResponse>;
|
|
11
|
+
createSnippet(params: CreateSnippetRequest, opts?: {
|
|
12
|
+
signal?: AbortSignal;
|
|
13
|
+
}): Promise<CreateSnippetResponse>;
|
|
14
|
+
getSnippet(params: GetSnippetParams, opts?: {
|
|
15
|
+
signal?: AbortSignal;
|
|
16
|
+
}): Promise<GetSnippetResponse>;
|
|
17
|
+
updateSnippet(params: UpdateSnippetParams, body: UpdateSnippetRequest, opts?: {
|
|
18
|
+
signal?: AbortSignal;
|
|
19
|
+
}): Promise<UpdateSnippetResponse>;
|
|
20
|
+
deleteSnippet(params: DeleteSnippetParams, opts?: {
|
|
21
|
+
signal?: AbortSignal;
|
|
22
|
+
}): Promise<DeleteSnippetResponse>;
|
|
23
|
+
client: import("axios").AxiosInstance;
|
|
24
|
+
"__#private@#httpAgent"?: import("http").Agent;
|
|
25
|
+
"__#private@#httpsAgent"?: import("https").Agent;
|
|
26
|
+
parseNdjson(data: string): any[];
|
|
27
|
+
parseCsv(data: string): any[];
|
|
28
|
+
validateResponse<T_1>(response: {
|
|
29
|
+
data: unknown;
|
|
30
|
+
config?: {
|
|
31
|
+
url?: string;
|
|
32
|
+
};
|
|
33
|
+
}, schema: import("zod").ZodType<T_1>): T_1;
|
|
34
|
+
destroy(): void;
|
|
35
|
+
};
|
|
36
|
+
} & T;
|
|
37
|
+
//# sourceMappingURL=snippets.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"snippets.d.ts","sourceRoot":"","sources":["../../src/client/snippets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EAErB,mBAAmB,EACnB,qBAAqB,EAErB,gBAAgB,EAChB,kBAAkB,EAElB,mBAAmB,EAEnB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EAEtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEjE;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC;;2BAE9C;YACvB,MAAM,CAAC,EAAE,WAAW,CAAC;SACtB,GAAG,OAAO,CAAC,mBAAmB,CAAC;8BAStB,oBAAoB,SACrB;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,qBAAqB,CAAC;2BAMvB,gBAAgB,SACjB;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,kBAAkB,CAAC;8BASpB,mBAAmB,QACrB,oBAAoB,SACnB;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,qBAAqB,CAAC;8BAUvB,mBAAmB,SACpB;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,qBAAqB,CAAC;;;;;;;;kBASyqF,CAAC;mBAAO,CAAC;;;;;MADttF"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { CreateSnippetResponseSchema, DeleteSnippetResponseSchema, GetSnippetResponseSchema, GetSnippetsResponseSchema, UpdateSnippetResponseSchema, } from "../types/snippets.js";
|
|
2
|
+
/**
|
|
3
|
+
* Snippets operations mixin
|
|
4
|
+
*/
|
|
5
|
+
export function Snippets(Base) {
|
|
6
|
+
return class extends Base {
|
|
7
|
+
async getSnippets(opts) {
|
|
8
|
+
const response = await this.client.get("/api/snippets", opts?.signal ? { signal: opts.signal } : {});
|
|
9
|
+
return this.validateResponse(response, GetSnippetsResponseSchema);
|
|
10
|
+
}
|
|
11
|
+
async createSnippet(params, opts) {
|
|
12
|
+
const response = await this.client.post("/api/snippets", params, opts);
|
|
13
|
+
return this.validateResponse(response, CreateSnippetResponseSchema);
|
|
14
|
+
}
|
|
15
|
+
async getSnippet(params, opts) {
|
|
16
|
+
const response = await this.client.get(`/api/snippets/${params.identifier}`, opts?.signal ? { signal: opts.signal } : {});
|
|
17
|
+
return this.validateResponse(response, GetSnippetResponseSchema);
|
|
18
|
+
}
|
|
19
|
+
async updateSnippet(params, body, opts) {
|
|
20
|
+
const response = await this.client.put(`/api/snippets/${params.identifier}`, body, opts);
|
|
21
|
+
return this.validateResponse(response, UpdateSnippetResponseSchema);
|
|
22
|
+
}
|
|
23
|
+
async deleteSnippet(params, opts) {
|
|
24
|
+
const response = await this.client.delete(`/api/snippets/${params.identifier}`, opts?.signal ? { signal: opts.signal } : {});
|
|
25
|
+
return this.validateResponse(response, DeleteSnippetResponseSchema);
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=snippets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"snippets.js","sourceRoot":"","sources":["../../src/client/snippets.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,2BAA2B,EAG3B,2BAA2B,EAG3B,wBAAwB,EAExB,yBAAyB,EAIzB,2BAA2B,GAC5B,MAAM,sBAAsB,CAAC;AAG9B;;GAEG;AACH,MAAM,UAAU,QAAQ,CAA4C,IAAO;IACzE,OAAO,KAAM,SAAQ,IAAI;QACvB,KAAK,CAAC,WAAW,CAAC,IAEjB;YACC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,eAAe,EACf,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAC5C,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;QACpE,CAAC;QAED,KAAK,CAAC,aAAa,CACjB,MAA4B,EAC5B,IAA+B;YAE/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QACtE,CAAC;QAED,KAAK,CAAC,UAAU,CACd,MAAwB,EACxB,IAA+B;YAE/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,iBAAiB,MAAM,CAAC,UAAU,EAAE,EACpC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAC5C,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACnE,CAAC;QAED,KAAK,CAAC,aAAa,CACjB,MAA2B,EAC3B,IAA0B,EAC1B,IAA+B;YAE/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,iBAAiB,MAAM,CAAC,UAAU,EAAE,EACpC,IAAI,EACJ,IAAI,CACL,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QACtE,CAAC;QAED,KAAK,CAAC,aAAa,CACjB,MAA2B,EAC3B,IAA+B;YAE/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACvC,iBAAiB,MAAM,CAAC,UAAU,EAAE,EACpC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAC5C,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QACtE,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { IterableSuccessResponse } from "../types/common.js";
|
|
2
|
+
import { BulkUpdateSubscriptionsParams, SubscribeUserByEmailParams, SubscribeUserByUserIdParams, UnsubscribeUserByEmailParams, UnsubscribeUserByUserIdParams } from "../types/subscriptions.js";
|
|
3
|
+
import type { Constructor } from "./base.js";
|
|
4
|
+
import type { BaseIterableClient } from "./base.js";
|
|
5
|
+
export declare function Subscriptions<T extends Constructor<BaseIterableClient>>(Base: T): {
|
|
6
|
+
new (...args: any[]): {
|
|
7
|
+
bulkUpdateSubscriptions(params: BulkUpdateSubscriptionsParams): Promise<IterableSuccessResponse>;
|
|
8
|
+
subscribeUserByEmail(params: SubscribeUserByEmailParams): Promise<IterableSuccessResponse>;
|
|
9
|
+
subscribeUserByUserId(params: SubscribeUserByUserIdParams): Promise<IterableSuccessResponse>;
|
|
10
|
+
unsubscribeUserByEmail(params: UnsubscribeUserByEmailParams): Promise<IterableSuccessResponse>;
|
|
11
|
+
unsubscribeUserByUserId(params: UnsubscribeUserByUserIdParams): Promise<IterableSuccessResponse>;
|
|
12
|
+
client: import("axios").AxiosInstance;
|
|
13
|
+
"__#private@#httpAgent"?: import("http").Agent;
|
|
14
|
+
"__#private@#httpsAgent"?: import("https").Agent;
|
|
15
|
+
parseNdjson(data: string): any[];
|
|
16
|
+
parseCsv(data: string): any[];
|
|
17
|
+
validateResponse<T_1>(response: {
|
|
18
|
+
data: unknown;
|
|
19
|
+
config?: {
|
|
20
|
+
url?: string;
|
|
21
|
+
};
|
|
22
|
+
}, schema: import("zod").ZodType<T_1>): T_1;
|
|
23
|
+
destroy(): void;
|
|
24
|
+
};
|
|
25
|
+
} & T;
|
|
26
|
+
//# sourceMappingURL=subscriptions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/client/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EACL,6BAA6B,EAC7B,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEpD,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,CAAC,kBAAkB,CAAC,EACrE,IAAI,EAAE,CAAC;;wCAIK,6BAA6B,GACpC,OAAO,CAAC,uBAAuB,CAAC;qCAmBzB,0BAA0B,GACjC,OAAO,CAAC,uBAAuB,CAAC;sCAUzB,2BAA2B,GAClC,OAAO,CAAC,uBAAuB,CAAC;uCAUzB,4BAA4B,GACnC,OAAO,CAAC,uBAAuB,CAAC;wCAUzB,6BAA6B,GACpC,OAAO,CAAC,uBAAuB,CAAC;;;;;;;;kBAUg2E,CAAC;mBAAO,CAAC;;;;;MAD/4E"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
export function Subscriptions(Base) {
|
|
2
|
+
return class extends Base {
|
|
3
|
+
async bulkUpdateSubscriptions(params) {
|
|
4
|
+
const { subscriptionGroup, subscriptionGroupId, action, users, usersByUserId, } = params;
|
|
5
|
+
const requestBody = { users, usersByUserId };
|
|
6
|
+
const response = await this.client.put(`/api/subscriptions/${encodeURIComponent(subscriptionGroup)}/${subscriptionGroupId}?action=${action}`, requestBody);
|
|
7
|
+
return response.data;
|
|
8
|
+
}
|
|
9
|
+
async subscribeUserByEmail(params) {
|
|
10
|
+
const { subscriptionGroup, subscriptionGroupId, userEmail } = params;
|
|
11
|
+
const response = await this.client.patch(`/api/subscriptions/${encodeURIComponent(subscriptionGroup)}/${subscriptionGroupId}/user/${encodeURIComponent(userEmail)}`);
|
|
12
|
+
return response.data;
|
|
13
|
+
}
|
|
14
|
+
async subscribeUserByUserId(params) {
|
|
15
|
+
const { subscriptionGroup, subscriptionGroupId, userId } = params;
|
|
16
|
+
const response = await this.client.patch(`/api/subscriptions/${encodeURIComponent(subscriptionGroup)}/${subscriptionGroupId}/byUserId/${encodeURIComponent(userId)}`);
|
|
17
|
+
return response.data;
|
|
18
|
+
}
|
|
19
|
+
async unsubscribeUserByEmail(params) {
|
|
20
|
+
const { subscriptionGroup, subscriptionGroupId, userEmail } = params;
|
|
21
|
+
const response = await this.client.delete(`/api/subscriptions/${encodeURIComponent(subscriptionGroup)}/${subscriptionGroupId}/user/${encodeURIComponent(userEmail)}`);
|
|
22
|
+
return response.data;
|
|
23
|
+
}
|
|
24
|
+
async unsubscribeUserByUserId(params) {
|
|
25
|
+
const { subscriptionGroup, subscriptionGroupId, userId } = params;
|
|
26
|
+
const response = await this.client.delete(`/api/subscriptions/${encodeURIComponent(subscriptionGroup)}/${subscriptionGroupId}/byUserId/${encodeURIComponent(userId)}`);
|
|
27
|
+
return response.data;
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=subscriptions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/client/subscriptions.ts"],"names":[],"mappings":"AAWA,MAAM,UAAU,aAAa,CAC3B,IAAO;IAEP,OAAO,KAAM,SAAQ,IAAI;QACvB,KAAK,CAAC,uBAAuB,CAC3B,MAAqC;YAErC,MAAM,EACJ,iBAAiB,EACjB,mBAAmB,EACnB,MAAM,EACN,KAAK,EACL,aAAa,GACd,GAAG,MAAM,CAAC;YAEX,MAAM,WAAW,GAAG,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;YAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,sBAAsB,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,WAAW,MAAM,EAAE,EACrG,WAAW,CACZ,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,oBAAoB,CACxB,MAAkC;YAElC,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAErE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACtC,sBAAsB,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,SAAS,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAC3H,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,qBAAqB,CACzB,MAAmC;YAEnC,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;YAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACtC,sBAAsB,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,aAAa,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAC5H,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,sBAAsB,CAC1B,MAAoC;YAEpC,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAErE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACvC,sBAAsB,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,SAAS,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAC3H,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,uBAAuB,CAC3B,MAAqC;YAErC,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;YAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACvC,sBAAsB,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,aAAa,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAC5H,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { IterableSuccessResponse } from "../types/common.js";
|
|
3
|
+
import { BulkDeleteTemplatesParams, BulkDeleteTemplatesResponse, EmailTemplate, GetTemplateByClientIdResponse, GetTemplateParams, GetTemplatesParams, GetTemplatesResponse, InAppTemplate, PreviewTemplateParams, PushTemplate, SMSTemplate, TemplateProofRequest, UpdateEmailTemplateParams, UpdateInAppTemplateParams, UpdatePushTemplateParams, UpdateSMSTemplateParams, UpsertEmailTemplateParams, UpsertInAppTemplateParams, UpsertPushTemplateParams, UpsertSMSTemplateParams } from "../types/templates.js";
|
|
4
|
+
import type { Constructor } from "./base.js";
|
|
5
|
+
import type { BaseIterableClient } from "./base.js";
|
|
6
|
+
/**
|
|
7
|
+
* Templates operations mixin
|
|
8
|
+
*/
|
|
9
|
+
export declare function Templates<T extends Constructor<BaseIterableClient>>(Base: T): {
|
|
10
|
+
new (...args: any[]): {
|
|
11
|
+
"__#private@#getTemplateByType"<T_1>(pathSegment: string, params: GetTemplateParams, schema: z.ZodSchema<T_1>): Promise<T_1>;
|
|
12
|
+
"__#private@#createTemplateByType"<T_1>(pathSegment: string, template: T_1): Promise<IterableSuccessResponse>;
|
|
13
|
+
"__#private@#updateTemplateByType"<T_1>(pathSegment: string, options: T_1): Promise<IterableSuccessResponse>;
|
|
14
|
+
deleteTemplates(templateIds: number[]): Promise<BulkDeleteTemplatesResponse>;
|
|
15
|
+
"__#private@#sendTemplateProof"(pathSegment: string, request: TemplateProofRequest): Promise<IterableSuccessResponse>;
|
|
16
|
+
"__#private@#previewTemplate"(pathSegment: string, params: PreviewTemplateParams): Promise<string>;
|
|
17
|
+
getTemplates(options?: GetTemplatesParams): Promise<GetTemplatesResponse>;
|
|
18
|
+
getTemplateByClientId(clientTemplateId: string): Promise<GetTemplateByClientIdResponse>;
|
|
19
|
+
bulkDeleteTemplates(params: BulkDeleteTemplatesParams): Promise<IterableSuccessResponse>;
|
|
20
|
+
getEmailTemplate(params: GetTemplateParams): Promise<EmailTemplate>;
|
|
21
|
+
upsertEmailTemplate(template: UpsertEmailTemplateParams): Promise<IterableSuccessResponse>;
|
|
22
|
+
updateEmailTemplate(options: UpdateEmailTemplateParams): Promise<IterableSuccessResponse>;
|
|
23
|
+
sendEmailTemplateProof(request: TemplateProofRequest): Promise<IterableSuccessResponse>;
|
|
24
|
+
previewEmailTemplate(params: PreviewTemplateParams): Promise<string>;
|
|
25
|
+
getSMSTemplate(params: GetTemplateParams): Promise<SMSTemplate>;
|
|
26
|
+
upsertSMSTemplate(template: UpsertSMSTemplateParams): Promise<IterableSuccessResponse>;
|
|
27
|
+
updateSMSTemplate(options: UpdateSMSTemplateParams): Promise<IterableSuccessResponse>;
|
|
28
|
+
sendSMSTemplateProof(request: TemplateProofRequest): Promise<IterableSuccessResponse>;
|
|
29
|
+
getPushTemplate(params: GetTemplateParams): Promise<PushTemplate>;
|
|
30
|
+
upsertPushTemplate(template: UpsertPushTemplateParams): Promise<IterableSuccessResponse>;
|
|
31
|
+
updatePushTemplate(options: UpdatePushTemplateParams): Promise<IterableSuccessResponse>;
|
|
32
|
+
sendPushTemplateProof(request: TemplateProofRequest): Promise<IterableSuccessResponse>;
|
|
33
|
+
getInAppTemplate(params: GetTemplateParams): Promise<InAppTemplate>;
|
|
34
|
+
upsertInAppTemplate(template: UpsertInAppTemplateParams): Promise<IterableSuccessResponse>;
|
|
35
|
+
updateInAppTemplate(options: UpdateInAppTemplateParams): Promise<IterableSuccessResponse>;
|
|
36
|
+
sendInAppTemplateProof(request: TemplateProofRequest): Promise<IterableSuccessResponse>;
|
|
37
|
+
previewInAppTemplate(params: PreviewTemplateParams): Promise<string>;
|
|
38
|
+
client: import("axios").AxiosInstance;
|
|
39
|
+
"__#private@#httpAgent"?: import("http").Agent;
|
|
40
|
+
"__#private@#httpsAgent"?: import("https").Agent;
|
|
41
|
+
parseNdjson(data: string): any[];
|
|
42
|
+
parseCsv(data: string): any[];
|
|
43
|
+
validateResponse<T_1>(response: {
|
|
44
|
+
data: unknown;
|
|
45
|
+
config?: {
|
|
46
|
+
url?: string;
|
|
47
|
+
};
|
|
48
|
+
}, schema: z.ZodSchema<T_1>): T_1;
|
|
49
|
+
destroy(): void;
|
|
50
|
+
};
|
|
51
|
+
} & T;
|
|
52
|
+
//# sourceMappingURL=templates.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/client/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAE3B,aAAa,EAEb,6BAA6B,EAE7B,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EAEpB,aAAa,EAEb,qBAAqB,EACrB,YAAY,EAEZ,WAAW,EAEX,oBAAoB,EACpB,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEpD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC;;0DAIzD,MAAM,UACX,iBAAiB,UACjB,CAAC,CAAC,SAAS,CAAC,GAAC,CAAC,GACrB,OAAO,CAAC,GAAC,CAAC;6DAcE,MAAM,YACT,GAAC,GACV,OAAO,CAAC,uBAAuB,CAAC;6DASpB,MAAM,WACV,GAAC,GACT,OAAO,CAAC,uBAAuB,CAAC;qCAUpB,MAAM,EAAE,GACpB,OAAO,CAAC,2BAA2B,CAAC;qDAQxB,MAAM,WACV,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;mDASpB,MAAM,UACX,qBAAqB,GAC5B,OAAO,CAAC,MAAM,CAAC;+BAiBN,kBAAkB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;gDAkBZ,MAAM,GACvB,OAAO,CAAC,6BAA6B,CAAC;oCAc/B,yBAAyB,GAChC,OAAO,CAAC,uBAAuB,CAAC;iCASJ,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;sCAK7D,yBAAyB,GAClC,OAAO,CAAC,uBAAuB,CAAC;qCAKxB,yBAAyB,GACjC,OAAO,CAAC,uBAAuB,CAAC;wCAKxB,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;qCAIA,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;+BAK7C,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;oCAKzD,uBAAuB,GAChC,OAAO,CAAC,uBAAuB,CAAC;mCAKxB,uBAAuB,GAC/B,OAAO,CAAC,uBAAuB,CAAC;sCAKxB,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;gCAKL,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;qCAK3D,wBAAwB,GACjC,OAAO,CAAC,uBAAuB,CAAC;oCAKxB,wBAAwB,GAChC,OAAO,CAAC,uBAAuB,CAAC;uCAKxB,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;iCAKJ,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;sCAK7D,yBAAyB,GAClC,OAAO,CAAC,uBAAuB,CAAC;qCAKxB,yBAAyB,GACjC,OAAO,CAAC,uBAAuB,CAAC;wCAKxB,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;qCAIA,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;;;;;;;;kBA/F/C,CAAC;mBAAO,CAAC;;;;;MAmGvC"}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { IterableSuccessResponseSchema } from "../types/common.js";
|
|
3
|
+
import { BulkDeleteTemplatesResponseSchema, EmailTemplateSchema, GetTemplateByClientIdResponseSchema, GetTemplatesResponseSchema, InAppTemplateSchema, PushTemplateSchema, SMSTemplateSchema, } from "../types/templates.js";
|
|
4
|
+
/**
|
|
5
|
+
* Templates operations mixin
|
|
6
|
+
*/
|
|
7
|
+
export function Templates(Base) {
|
|
8
|
+
return class extends Base {
|
|
9
|
+
// Helper methods
|
|
10
|
+
async #getTemplateByType(pathSegment, params, schema) {
|
|
11
|
+
const queryParams = new URLSearchParams();
|
|
12
|
+
queryParams.append("templateId", params.templateId.toString());
|
|
13
|
+
if (params.locale) {
|
|
14
|
+
queryParams.append("locale", params.locale);
|
|
15
|
+
}
|
|
16
|
+
const response = await this.client.get(`/api/templates/${pathSegment}/get?${queryParams.toString()}`);
|
|
17
|
+
return this.validateResponse(response, schema);
|
|
18
|
+
}
|
|
19
|
+
async #createTemplateByType(pathSegment, template) {
|
|
20
|
+
const response = await this.client.post(`/api/templates/${pathSegment}/upsert`, template);
|
|
21
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
22
|
+
}
|
|
23
|
+
async #updateTemplateByType(pathSegment, options) {
|
|
24
|
+
const response = await this.client.post(`/api/templates/${pathSegment}/update`, options);
|
|
25
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
26
|
+
}
|
|
27
|
+
// Template deletion - works for all template types
|
|
28
|
+
async deleteTemplates(templateIds) {
|
|
29
|
+
const response = await this.client.post(`/api/templates/bulkDelete`, {
|
|
30
|
+
ids: templateIds,
|
|
31
|
+
});
|
|
32
|
+
return this.validateResponse(response, BulkDeleteTemplatesResponseSchema);
|
|
33
|
+
}
|
|
34
|
+
async #sendTemplateProof(pathSegment, request) {
|
|
35
|
+
const response = await this.client.post(`/api/templates/${pathSegment}/proof`, request);
|
|
36
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
37
|
+
}
|
|
38
|
+
async #previewTemplate(pathSegment, params) {
|
|
39
|
+
const queryParams = new URLSearchParams();
|
|
40
|
+
queryParams.append("templateId", params.templateId.toString());
|
|
41
|
+
if (params.locale) {
|
|
42
|
+
queryParams.append("locale", params.locale);
|
|
43
|
+
}
|
|
44
|
+
const response = await this.client.post(`/api/templates/${pathSegment}/preview?${queryParams.toString()}`, params.data || {});
|
|
45
|
+
// The API returns raw HTML as a string
|
|
46
|
+
return this.validateResponse(response, z.string());
|
|
47
|
+
}
|
|
48
|
+
// General template operations
|
|
49
|
+
async getTemplates(options) {
|
|
50
|
+
const params = new URLSearchParams();
|
|
51
|
+
if (options?.templateType)
|
|
52
|
+
params.append("templateType", options.templateType);
|
|
53
|
+
if (options?.messageMedium)
|
|
54
|
+
params.append("messageMedium", options.messageMedium);
|
|
55
|
+
if (options?.startDateTime)
|
|
56
|
+
params.append("startDateTime", options.startDateTime);
|
|
57
|
+
if (options?.endDateTime)
|
|
58
|
+
params.append("endDateTime", options.endDateTime);
|
|
59
|
+
const response = await this.client.get(`/api/templates?${params.toString()}`);
|
|
60
|
+
return this.validateResponse(response, GetTemplatesResponseSchema);
|
|
61
|
+
}
|
|
62
|
+
async getTemplateByClientId(clientTemplateId) {
|
|
63
|
+
const response = await this.client.get("/api/templates/getByClientTemplateId", {
|
|
64
|
+
params: { clientTemplateId },
|
|
65
|
+
});
|
|
66
|
+
return this.validateResponse(response, GetTemplateByClientIdResponseSchema);
|
|
67
|
+
}
|
|
68
|
+
async bulkDeleteTemplates(params) {
|
|
69
|
+
const response = await this.client.post(`/api/templates/bulkDelete`, params);
|
|
70
|
+
return this.validateResponse(response, IterableSuccessResponseSchema);
|
|
71
|
+
}
|
|
72
|
+
// Email Template Management
|
|
73
|
+
async getEmailTemplate(params) {
|
|
74
|
+
return this.#getTemplateByType("email", params, EmailTemplateSchema);
|
|
75
|
+
}
|
|
76
|
+
async upsertEmailTemplate(template) {
|
|
77
|
+
return this.#createTemplateByType("email", template);
|
|
78
|
+
}
|
|
79
|
+
async updateEmailTemplate(options) {
|
|
80
|
+
return this.#updateTemplateByType("email", options);
|
|
81
|
+
}
|
|
82
|
+
async sendEmailTemplateProof(request) {
|
|
83
|
+
return this.#sendTemplateProof("email", request);
|
|
84
|
+
}
|
|
85
|
+
async previewEmailTemplate(params) {
|
|
86
|
+
return this.#previewTemplate("email", params);
|
|
87
|
+
}
|
|
88
|
+
// SMS Template Management
|
|
89
|
+
async getSMSTemplate(params) {
|
|
90
|
+
return this.#getTemplateByType("sms", params, SMSTemplateSchema);
|
|
91
|
+
}
|
|
92
|
+
async upsertSMSTemplate(template) {
|
|
93
|
+
return this.#createTemplateByType("sms", template);
|
|
94
|
+
}
|
|
95
|
+
async updateSMSTemplate(options) {
|
|
96
|
+
return this.#updateTemplateByType("sms", options);
|
|
97
|
+
}
|
|
98
|
+
async sendSMSTemplateProof(request) {
|
|
99
|
+
return this.#sendTemplateProof("sms", request);
|
|
100
|
+
}
|
|
101
|
+
// Push Template Management
|
|
102
|
+
async getPushTemplate(params) {
|
|
103
|
+
return this.#getTemplateByType("push", params, PushTemplateSchema);
|
|
104
|
+
}
|
|
105
|
+
async upsertPushTemplate(template) {
|
|
106
|
+
return this.#createTemplateByType("push", template);
|
|
107
|
+
}
|
|
108
|
+
async updatePushTemplate(options) {
|
|
109
|
+
return this.#updateTemplateByType("push", options);
|
|
110
|
+
}
|
|
111
|
+
async sendPushTemplateProof(request) {
|
|
112
|
+
return this.#sendTemplateProof("push", request);
|
|
113
|
+
}
|
|
114
|
+
// In-App Template Management
|
|
115
|
+
async getInAppTemplate(params) {
|
|
116
|
+
return this.#getTemplateByType("inapp", params, InAppTemplateSchema);
|
|
117
|
+
}
|
|
118
|
+
async upsertInAppTemplate(template) {
|
|
119
|
+
return this.#createTemplateByType("inapp", template);
|
|
120
|
+
}
|
|
121
|
+
async updateInAppTemplate(options) {
|
|
122
|
+
return this.#updateTemplateByType("inapp", options);
|
|
123
|
+
}
|
|
124
|
+
async sendInAppTemplateProof(request) {
|
|
125
|
+
return this.#sendTemplateProof("inapp", request);
|
|
126
|
+
}
|
|
127
|
+
async previewInAppTemplate(params) {
|
|
128
|
+
return this.#previewTemplate("inapp", params);
|
|
129
|
+
}
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
//# sourceMappingURL=templates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/client/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAGL,iCAAiC,EAEjC,mBAAmB,EAEnB,mCAAmC,EAInC,0BAA0B,EAE1B,mBAAmB,EAGnB,kBAAkB,EAElB,iBAAiB,GAUlB,MAAM,uBAAuB,CAAC;AAI/B;;GAEG;AACH,MAAM,UAAU,SAAS,CAA4C,IAAO;IAC1E,OAAO,KAAM,SAAQ,IAAI;QACvB,iBAAiB;QACjB,KAAK,CAAC,kBAAkB,CACtB,WAAmB,EACnB,MAAyB,EACzB,MAAsB;YAEtB,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC/D,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,kBAAkB,WAAW,QAAQ,WAAW,CAAC,QAAQ,EAAE,EAAE,CAC9D,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;QAED,KAAK,CAAC,qBAAqB,CACzB,WAAmB,EACnB,QAAW;YAEX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,kBAAkB,WAAW,SAAS,EACtC,QAAQ,CACT,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,qBAAqB,CACzB,WAAmB,EACnB,OAAU;YAEV,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,kBAAkB,WAAW,SAAS,EACtC,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,mDAAmD;QACnD,KAAK,CAAC,eAAe,CACnB,WAAqB;YAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;gBACnE,GAAG,EAAE,WAAW;aACjB,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,iCAAiC,CAAC,CAAC;QAC5E,CAAC;QAED,KAAK,CAAC,kBAAkB,CACtB,WAAmB,EACnB,OAA6B;YAE7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,kBAAkB,WAAW,QAAQ,EACrC,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,CAAC,gBAAgB,CACpB,WAAmB,EACnB,MAA6B;YAE7B,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC/D,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,kBAAkB,WAAW,YAAY,WAAW,CAAC,QAAQ,EAAE,EAAE,EACjE,MAAM,CAAC,IAAI,IAAI,EAAE,CAClB,CAAC;YACF,uCAAuC;YACvC,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,8BAA8B;QAC9B,KAAK,CAAC,YAAY,CAChB,OAA4B;YAE5B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,OAAO,EAAE,YAAY;gBACvB,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;YACtD,IAAI,OAAO,EAAE,aAAa;gBACxB,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YACxD,IAAI,OAAO,EAAE,aAAa;gBACxB,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YACxD,IAAI,OAAO,EAAE,WAAW;gBACtB,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YAEpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,kBAAkB,MAAM,CAAC,QAAQ,EAAE,EAAE,CACtC,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,0BAA0B,CAAC,CAAC;QACrE,CAAC;QAED,KAAK,CAAC,qBAAqB,CACzB,gBAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,sCAAsC,EACtC;gBACE,MAAM,EAAE,EAAE,gBAAgB,EAAE;aAC7B,CACF,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAC1B,QAAQ,EACR,mCAAmC,CACpC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,mBAAmB,CACvB,MAAiC;YAEjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,2BAA2B,EAC3B,MAAM,CACP,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;QACxE,CAAC;QAED,4BAA4B;QAC5B,KAAK,CAAC,gBAAgB,CAAC,MAAyB;YAC9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,mBAAmB,CACvB,QAAmC;YAEnC,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,KAAK,CAAC,mBAAmB,CACvB,OAAkC;YAElC,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,sBAAsB,CAC1B,OAA6B;YAE7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;QAED,KAAK,CAAC,oBAAoB,CAAC,MAA6B;YACtD,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;QAED,0BAA0B;QAC1B,KAAK,CAAC,cAAc,CAAC,MAAyB;YAC5C,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC;QACnE,CAAC;QAED,KAAK,CAAC,iBAAiB,CACrB,QAAiC;YAEjC,OAAO,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACrD,CAAC;QAED,KAAK,CAAC,iBAAiB,CACrB,OAAgC;YAEhC,OAAO,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QAED,KAAK,CAAC,oBAAoB,CACxB,OAA6B;YAE7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC;QAED,2BAA2B;QAC3B,KAAK,CAAC,eAAe,CAAC,MAAyB;YAC7C,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;QACrE,CAAC;QAED,KAAK,CAAC,kBAAkB,CACtB,QAAkC;YAElC,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,kBAAkB,CACtB,OAAiC;YAEjC,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,KAAK,CAAC,qBAAqB,CACzB,OAA6B;YAE7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,6BAA6B;QAC7B,KAAK,CAAC,gBAAgB,CAAC,MAAyB;YAC9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,mBAAmB,CACvB,QAAmC;YAEnC,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,KAAK,CAAC,mBAAmB,CACvB,OAAkC;YAElC,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,sBAAsB,CAC1B,OAA6B;YAE7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;QAED,KAAK,CAAC,oBAAoB,CAAC,MAA6B;YACtD,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { IterableSuccessResponse } from "../types/common.js";
|
|
2
|
+
import { UserBulkUpdateListResponse } from "../types/lists.js";
|
|
3
|
+
import { BulkUpdateUsersParams, GetSentMessagesParams, GetSentMessagesResponse, GetUserFieldsResponse, UpdateEmailParams, UpdateUserParams, UpdateUserSubscriptionsParams, UserResponse } from "../types/users.js";
|
|
4
|
+
import type { Constructor } from "./base.js";
|
|
5
|
+
import type { BaseIterableClient } from "./base.js";
|
|
6
|
+
/**
|
|
7
|
+
* User management operations mixin
|
|
8
|
+
*/
|
|
9
|
+
export declare function Users<T extends Constructor<BaseIterableClient>>(Base: T): {
|
|
10
|
+
new (...args: any[]): {
|
|
11
|
+
/**
|
|
12
|
+
* Get a user by email address
|
|
13
|
+
*/
|
|
14
|
+
getUserByEmail(email: string, opts?: {
|
|
15
|
+
signal?: AbortSignal;
|
|
16
|
+
}): Promise<UserResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* Get a user by userId
|
|
19
|
+
*/
|
|
20
|
+
getUserByUserId(userId: string, opts?: {
|
|
21
|
+
signal?: AbortSignal;
|
|
22
|
+
}): Promise<UserResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Update user data or add a user if none exists
|
|
25
|
+
* Accepts email OR userId in the userProfile parameter
|
|
26
|
+
*/
|
|
27
|
+
updateUser(userProfile: UpdateUserParams): Promise<IterableSuccessResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Delete a user by email address
|
|
30
|
+
* Asynchronous operation - does not prevent future data collection
|
|
31
|
+
*/
|
|
32
|
+
deleteUserByEmail(email: string): Promise<IterableSuccessResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Delete a user by userId
|
|
35
|
+
* Asynchronous operation - does not prevent future data collection
|
|
36
|
+
* If multiple users share the same userId, they'll all be deleted
|
|
37
|
+
*/
|
|
38
|
+
deleteUserByUserId(userId: string): Promise<IterableSuccessResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Update a user's email address
|
|
41
|
+
* Only use with email-based projects. For userId/hybrid projects, use updateUser instead.
|
|
42
|
+
* Returns an error if the new email already exists or has been forgotten via GDPR.
|
|
43
|
+
*/
|
|
44
|
+
updateEmail(params: UpdateEmailParams): Promise<IterableSuccessResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Update user subscriptions
|
|
47
|
+
* IMPORTANT: This endpoint overwrites (does not merge) existing data for any non-null fields specified.
|
|
48
|
+
*/
|
|
49
|
+
updateUserSubscriptions(params: UpdateUserSubscriptionsParams): Promise<IterableSuccessResponse>;
|
|
50
|
+
/**
|
|
51
|
+
* Bulk update user data
|
|
52
|
+
*/
|
|
53
|
+
bulkUpdateUsers(params: BulkUpdateUsersParams): Promise<UserBulkUpdateListResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Get messages sent to a user
|
|
56
|
+
*/
|
|
57
|
+
getSentMessages(params: GetSentMessagesParams): Promise<GetSentMessagesResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Get all user profile field definitions
|
|
60
|
+
*/
|
|
61
|
+
getUserFields(): Promise<GetUserFieldsResponse>;
|
|
62
|
+
client: import("axios").AxiosInstance;
|
|
63
|
+
"__#private@#httpAgent"?: import("http").Agent;
|
|
64
|
+
"__#private@#httpsAgent"?: import("https").Agent;
|
|
65
|
+
parseNdjson(data: string): any[];
|
|
66
|
+
parseCsv(data: string): any[];
|
|
67
|
+
validateResponse<T_1>(response: {
|
|
68
|
+
data: unknown;
|
|
69
|
+
config?: {
|
|
70
|
+
url?: string;
|
|
71
|
+
};
|
|
72
|
+
}, schema: import("zod").ZodType<T_1>): T_1;
|
|
73
|
+
destroy(): void;
|
|
74
|
+
};
|
|
75
|
+
} & T;
|
|
76
|
+
//# sourceMappingURL=users.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/client/users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EAErB,iBAAiB,EACjB,gBAAgB,EAChB,6BAA6B,EAC7B,YAAY,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEpD;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,WAAW,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC;;QAEpE;;WAEG;8BAEM,MAAM,SACN;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,YAAY,CAAC;QAQxB;;WAEG;gCAEO,MAAM,SACP;YAAE,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,GAC9B,OAAO,CAAC,YAAY,CAAC;QAOxB;;;WAGG;gCAEY,gBAAgB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;QAKnC;;;WAGG;iCAC4B,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;QAOxE;;;;WAIG;mCAC8B,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;QAO1E;;;;WAIG;4BAEO,iBAAiB,GACxB,OAAO,CAAC,uBAAuB,CAAC;QAKnC;;;WAGG;wCAEO,6BAA6B,GACpC,OAAO,CAAC,uBAAuB,CAAC;QAQnC;;WAEG;gCAEO,qBAAqB,GAC5B,OAAO,CAAC,0BAA0B,CAAC;QAKtC;;WAEG;gCAEO,qBAAqB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;QAuCnC;;WAEG;yBACoB,OAAO,CAAC,qBAAqB,CAAC;;;;;;;;kBAT5C,CAAC;mBAAO,CAAC;;;;;MAcrB"}
|