shipmail 0.4.8 → 0.4.10
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 +8 -3
- package/dist/index.cjs +30 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +55 -5
- package/dist/index.d.ts +55 -5
- package/dist/index.js +30 -1
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -221,6 +221,11 @@ await shipmail.messages.send({
|
|
|
221
221
|
});
|
|
222
222
|
|
|
223
223
|
await shipmail.messages.list({ mailbox_id: "mbx_...", limit: 25 });
|
|
224
|
+
const analytics = await shipmail.messages.listAnalytics({
|
|
225
|
+
updated_after: "2026-07-01T00:00:00.000Z",
|
|
226
|
+
limit: 100,
|
|
227
|
+
});
|
|
228
|
+
// Follow analytics.pagination.next_cursor, then persist analytics.pagination.snapshot_at.
|
|
224
229
|
await shipmail.messages.get("msg_...");
|
|
225
230
|
|
|
226
231
|
await shipmail.messages.reply("msg_...", {
|
|
@@ -427,7 +432,7 @@ await shipmail.audiences.feeds.revoke(audience.id);
|
|
|
427
432
|
```ts
|
|
428
433
|
import { readFile } from "node:fs/promises";
|
|
429
434
|
|
|
430
|
-
const
|
|
435
|
+
const senderIdentities = await shipmail.newsletters.senderIdentities.list({ limit: 25 });
|
|
431
436
|
const assets = await shipmail.newsletters.assets.list({ kind: "image", limit: 25 });
|
|
432
437
|
const hero = await shipmail.newsletters.assets.upload({
|
|
433
438
|
filename: "hero.png",
|
|
@@ -443,7 +448,7 @@ console.log(assets.storage.used_bytes, assets.storage.limit_bytes);
|
|
|
443
448
|
|
|
444
449
|
const newsletter = await shipmail.newsletters.create({
|
|
445
450
|
audience_id: "aud_...",
|
|
446
|
-
|
|
451
|
+
sender_identity_id: senderIdentities.data[0].id,
|
|
447
452
|
name: "July changelog",
|
|
448
453
|
subject: "What shipped in July",
|
|
449
454
|
preview_text: "A quick product update",
|
|
@@ -769,4 +774,4 @@ This is the recommended pattern for unit tests. No HTTP interception or mocking
|
|
|
769
774
|
- [TypeScript SDK guide](https://shipmail.to/docs/sdks/typescript)
|
|
770
775
|
- [`shipmail-mcp` (MCP server)](https://www.npmjs.com/package/shipmail-mcp)
|
|
771
776
|
- [Changelog](./CHANGELOG.md)
|
|
772
|
-
- [Issues](https://github.com/
|
|
777
|
+
- [Issues](https://github.com/shipmail-to/Shipmail/issues)
|
package/dist/index.cjs
CHANGED
|
@@ -1042,6 +1042,19 @@ var Messages = class extends ApiResource {
|
|
|
1042
1042
|
limit: params.limit
|
|
1043
1043
|
});
|
|
1044
1044
|
}
|
|
1045
|
+
listAnalytics(params = {}, options) {
|
|
1046
|
+
return this.client.request({
|
|
1047
|
+
method: "GET",
|
|
1048
|
+
path: "/messages/analytics",
|
|
1049
|
+
query: {
|
|
1050
|
+
updated_after: params.updated_after,
|
|
1051
|
+
updated_before: params.updated_before,
|
|
1052
|
+
cursor: params.cursor,
|
|
1053
|
+
limit: params.limit
|
|
1054
|
+
},
|
|
1055
|
+
methodOptions: options
|
|
1056
|
+
});
|
|
1057
|
+
}
|
|
1045
1058
|
get(id, options) {
|
|
1046
1059
|
return this.client.request({
|
|
1047
1060
|
method: "GET",
|
|
@@ -1076,6 +1089,21 @@ var NewsletterDomains = class extends ApiResource {
|
|
|
1076
1089
|
return new Page(this.client, "/newsletter-domains", { limit: params?.limit });
|
|
1077
1090
|
}
|
|
1078
1091
|
};
|
|
1092
|
+
var NewsletterSenderIdentities = class extends ApiResource {
|
|
1093
|
+
list(params, options) {
|
|
1094
|
+
return this.client.request({
|
|
1095
|
+
method: "GET",
|
|
1096
|
+
path: "/newsletter-sender-identities",
|
|
1097
|
+
query: { cursor: params?.cursor, limit: params?.limit },
|
|
1098
|
+
methodOptions: options
|
|
1099
|
+
});
|
|
1100
|
+
}
|
|
1101
|
+
listAutoPaginating(params) {
|
|
1102
|
+
return new Page(this.client, "/newsletter-sender-identities", {
|
|
1103
|
+
limit: params?.limit
|
|
1104
|
+
});
|
|
1105
|
+
}
|
|
1106
|
+
};
|
|
1079
1107
|
var NewsletterAssets = class extends ApiResource {
|
|
1080
1108
|
list(params, options) {
|
|
1081
1109
|
return this.client.request({
|
|
@@ -1120,6 +1148,7 @@ var Newsletters = class extends ApiResource {
|
|
|
1120
1148
|
constructor(client) {
|
|
1121
1149
|
super(client);
|
|
1122
1150
|
this.domains = new NewsletterDomains(client);
|
|
1151
|
+
this.senderIdentities = new NewsletterSenderIdentities(client);
|
|
1123
1152
|
this.assets = new NewsletterAssets(client);
|
|
1124
1153
|
}
|
|
1125
1154
|
create(params, options) {
|
|
@@ -1539,7 +1568,7 @@ var Webhooks = class extends ApiResource {
|
|
|
1539
1568
|
};
|
|
1540
1569
|
|
|
1541
1570
|
// src/version.ts
|
|
1542
|
-
var VERSION = "0.4.
|
|
1571
|
+
var VERSION = "0.4.10";
|
|
1543
1572
|
|
|
1544
1573
|
// src/client.ts
|
|
1545
1574
|
var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
|