shipmail-cli 0.4.2 → 0.4.5

package/README.md

@@ -50,6 +50,7 @@ shipmail messages send \
   --source-rfc-message-id '<crm-123@example.com>'
 
 shipmail messages list --client-reference crm-123
+shipmail messages analytics --updated-after 2026-07-01T00:00:00Z --limit 100
 shipmail messages reply msg_123 --to user@example.com --text "Thanks"
 
 # Stage a raw file, then pass the returned sat_... ID when sending
@@ -97,11 +98,11 @@ shipmail reply-scans create --mailbox-id 550e8400-e29b-41d4-a716-446655440000 --
 shipmail reply-scans status rsc_123
 shipmail reply-scans results rsc_123 --limit 100
 
-# Find newsletter sending domain IDs, then create a draft with blocks
-shipmail newsletter-domains list
+# Find reusable sender identity IDs, then create a draft with blocks
+shipmail newsletter-sender-identities list
 shipmail newsletters create \
   --audience-id aud_123 \
-  --newsletter-domain-id nwsdom_456 \
+  --sender-identity-id nwsid_456 \
   --name "July changelog" \
   --subject "What shipped in July" \
   --blocks @blocks.json
@@ -154,7 +155,7 @@ Use repeatable `--header "Name: value"` flags for request headers. Use `--output
 - `mailboxes list|create|get|suspend|resume|forwarding|forwarding-add|forwarding-remove|app-passwords|folders|identities|stage-attachment|prepare-attachment-upload`
 - `inbox list|message|threads|thread|thread-state|draft|send-draft|reply-message|reply-thread|update|move`
 - `reply-scans create|status|results`
-- `messages send|list|get|reply` (test keys also support `--sandbox-outcome`)
+- `messages send|list|analytics|get|reply` (test keys also support `--sandbox-outcome`)
 - `scheduled-messages list|get|update|cancel`
 - `mailboxes sandbox-inbound`
 - `webhooks list|create|test|deliveries|replay-delivery`
@@ -162,6 +163,7 @@ Use repeatable `--header "Name: value"` flags for request headers. Use `--output
 - `audiences list|create|get|update|delete`
 - `audiences feed get|update|rotate|revoke`
 - `audiences subscribers add|list|get|by-email|update|unsubscribe|resubscribe|remove`
+- `newsletter-sender-identities list`
 - `newsletter-domains list`
 - `newsletters create|update|preview|preflight|test-send|schedule|cancel|resume`
 - `newsletter-assets list|upload|register-url`
@@ -169,4 +171,12 @@ Use repeatable `--header "Name: value"` flags for request headers. Use `--output
 - `partner credential-grants list|consume`
 - `partner usage`
 
+Configure a publisher-owned Atom self URL and the number of recent issues:
+
+```bash
+shipmail audiences feed update aud_123 \
+  --canonical-url https://example.com/feed.xml \
+  --entry-limit 25
+```
+
 Run `shipmail --help` for flags and examples.

package/dist/cli.js

@@ -14,7 +14,7 @@ import {
 } from "shipmail";
 
 // src/version.ts
-var VERSION = "0.4.2";
+var VERSION = "0.4.5";
 
 // src/cli.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -187,7 +187,7 @@ function parseStylingMode(options) {
 }
 async function newsletterCreateParams(options) {
   const audience_id = getRequiredString(options, "audience-id");
-  const newsletter_domain_id = getRequiredString(options, "newsletter-domain-id");
+  const sender_identity_id = getRequiredString(options, "sender-identity-id");
   const name = getRequiredString(options, "name");
   const subject = getRequiredString(options, "subject");
   const blocksInput = getString(options, "blocks");
@@ -203,14 +203,12 @@ async function newsletterCreateParams(options) {
   const archive_visibility = parseArchiveVisibility(options);
   const styling_mode = parseStylingMode(options);
   const preview_text = getString(options, "preview-text");
-  const from_name = getString(options, "from-name");
   return {
     audience_id,
-    newsletter_domain_id,
+    sender_identity_id,
     name,
     subject,
     ...preview_text !== void 0 ? { preview_text } : {},
-    ...from_name !== void 0 ? { from_name } : {},
     ...blocks ? { blocks } : {},
     ...body_html !== void 0 ? { body_html } : {},
     ...body_text !== void 0 ? { body_text } : {},
@@ -221,11 +219,10 @@ async function newsletterCreateParams(options) {
 }
 async function newsletterUpdateParams(options) {
   const audience_id = getString(options, "audience-id");
-  const newsletter_domain_id = getString(options, "newsletter-domain-id");
+  const sender_identity_id = getString(options, "sender-identity-id");
   const name = getString(options, "name");
   const subject = getString(options, "subject");
   const preview_text = getString(options, "preview-text");
-  const from_name = getString(options, "from-name");
   const send_window_hours = getNumber(options, "send-window-hours");
   const archive_visibility = parseArchiveVisibility(options);
   const styling_mode = parseStylingMode(options);
@@ -237,11 +234,10 @@ async function newsletterUpdateParams(options) {
   const body_text = bodyTextInput ? await readTextInput(bodyTextInput) : void 0;
   const params = {
     ...audience_id ? { audience_id } : {},
-    ...newsletter_domain_id ? { newsletter_domain_id } : {},
+    ...sender_identity_id ? { sender_identity_id } : {},
     ...name ? { name } : {},
     ...subject ? { subject } : {},
     ...preview_text !== void 0 ? { preview_text } : {},
-    ...from_name !== void 0 ? { from_name } : {},
     ...blocks ? { blocks } : {},
     ...body_html !== void 0 ? { body_html } : {},
     ...body_text !== void 0 ? { body_text } : {},
@@ -367,6 +363,7 @@ Usage:
   shipmail inbox move <mailbox-id> <message-id> (--target-role archive | --target-folder-id fld)
   shipmail messages send --mailbox-id mbx --to user@example.com --subject "Hi" --text "Hello" [--sandbox-outcome delivered|bounced|complained] [--client-reference crm-123] [--metadata JSON|@file] [--source-rfc-message-id '<crm-123@example.com>'] [--header 'X-CRM-ID: 123']
   shipmail messages list (--mailbox-id mbx | --client-reference crm-123) [--limit 25] [--cursor cur]
+  shipmail messages analytics [--updated-after ISO] [--updated-before ISO] [--limit 100] [--cursor cur]
   shipmail messages get <message-id>
   shipmail messages reply <message-id> --to user@example.com (--text "Hello" | --html "<p>Hello</p>") [--client-reference crm-reply-123]
   shipmail scheduled-messages list [--include-held] [--search text] [--limit 100]
@@ -383,7 +380,7 @@ Usage:
   shipmail suppressions remove <email>
   shipmail newsletters create \\
     --audience-id aud_123 \\
-    --newsletter-domain-id nwsdom_456 \\
+    --sender-identity-id nwsid_456 \\
     --name "July changelog" \\
     --subject "What shipped in July" \\
     --blocks @blocks.json \\
@@ -398,6 +395,7 @@ Usage:
   shipmail newsletter-assets list [--kind image|video] [--q text] [--limit 25] [--cursor cur]
   shipmail newsletter-assets upload <file> [--filename name] [--content-type type]
   shipmail newsletter-assets register-url <url> [--filename name] [--thumbnail-url url]
+  shipmail newsletter-sender-identities list [--limit 25] [--cursor cur]
   shipmail newsletter-domains list [--limit 25] [--cursor cur]
   shipmail audiences list [--limit 25] [--cursor cur]
   shipmail audiences create <name> --consent-source "Signup form" [--description "..."]
@@ -405,7 +403,7 @@ Usage:
   shipmail audiences update <id> [--name "..."] [--description "..."]
   shipmail audiences delete <id>
   shipmail audiences feed get <audience-id>
-  shipmail audiences feed update <audience-id> [--enabled true|false] [--title "..."] [--subtitle "..."] [--site-url https://...] [--author-name "..."] [--icon-url https://...] [--idempotency-key key]
+  shipmail audiences feed update <audience-id> [--enabled true|false] [--title "..."] [--subtitle "..."] [--site-url https://...] [--canonical-url https://...] [--author-name "..."] [--icon-url https://...] [--entry-limit 10..100] [--idempotency-key key]
   shipmail audiences feed rotate <audience-id> [--idempotency-key key]
   shipmail audiences feed revoke <audience-id> [--idempotency-key key]
   shipmail audiences subscribers add <audience-id> <email> [--name "Jane"] [--consent-source "..."]
@@ -1082,6 +1080,18 @@ async function runMessages(client, parsed, out) {
     );
     return;
   }
+  if (subcommand === "analytics") {
+    writeJson(
+      out,
+      await client.messages.listAnalytics({
+        updated_after: getString(parsed.options, "updated-after"),
+        updated_before: getString(parsed.options, "updated-before"),
+        cursor: getString(parsed.options, "cursor"),
+        limit: getNumber(parsed.options, "limit")
+      })
+    );
+    return;
+  }
   if (subcommand === "reply") {
     writeJson(
       out,
@@ -1335,9 +1345,14 @@ function audienceFeedUpdateParams(options) {
   const title = getString(options, "title");
   const subtitle = getString(options, "subtitle");
   const siteUrl = getString(options, "site-url");
+  const canonicalUrl = getString(options, "canonical-url");
   const authorName = getString(options, "author-name");
   const iconUrl = getString(options, "icon-url");
-  if (enabled === void 0 && title === void 0 && subtitle === void 0 && siteUrl === void 0 && authorName === void 0 && iconUrl === void 0) {
+  const entryLimit = getNumber(options, "entry-limit");
+  if (entryLimit !== void 0 && (entryLimit < 10 || entryLimit > 100)) {
+    throw new CliUsageError("--entry-limit must be between 10 and 100.");
+  }
+  if (enabled === void 0 && title === void 0 && subtitle === void 0 && siteUrl === void 0 && canonicalUrl === void 0 && authorName === void 0 && iconUrl === void 0 && entryLimit === void 0) {
     throw new CliUsageError("Provide at least one feed setting to update.");
   }
   return {
@@ -1345,8 +1360,10 @@ function audienceFeedUpdateParams(options) {
     ...title !== void 0 ? { title } : {},
     ...subtitle !== void 0 ? { subtitle } : {},
     ...siteUrl !== void 0 ? { site_url: siteUrl } : {},
+    ...canonicalUrl !== void 0 ? { canonical_url: canonicalUrl } : {},
     ...authorName !== void 0 ? { author_name: authorName } : {},
-    ...iconUrl !== void 0 ? { icon_url: iconUrl } : {}
+    ...iconUrl !== void 0 ? { icon_url: iconUrl } : {},
+    ...entryLimit !== void 0 ? { entry_limit: entryLimit } : {}
   };
 }
 async function runAudienceFeed(client, parsed, out) {
@@ -1453,6 +1470,20 @@ async function runNewsletterDomains(client, parsed, out) {
   }
   throw new CliUsageError("Unknown newsletter-domains command.");
 }
+async function runNewsletterSenderIdentities(client, parsed, out) {
+  const subcommand = parsed.positional[1];
+  if (subcommand === "list") {
+    writeJson(
+      out,
+      await client.newsletters.senderIdentities.list({
+        cursor: getString(parsed.options, "cursor"),
+        limit: getNumber(parsed.options, "limit")
+      })
+    );
+    return;
+  }
+  throw new CliUsageError("Unknown newsletter-sender-identities command.");
+}
 async function runNewsletters(client, parsed, out) {
   const subcommand = parsed.positional[1];
   if (subcommand === "create") {
@@ -1973,6 +2004,8 @@ async function runCli(argv, options = {}) {
     else if (command === "suppressions") await runSuppressions(client, parsed, out);
     else if (command === "newsletters") await runNewsletters(client, parsed, out);
     else if (command === "newsletter-assets") await runNewsletterAssets(client, parsed, out);
+    else if (command === "newsletter-sender-identities")
+      await runNewsletterSenderIdentities(client, parsed, out);
     else if (command === "newsletter-domains") await runNewsletterDomains(client, parsed, out);
     else if (command === "audiences") await runAudiences(client, parsed, out);
     else if (command === "calendar") await runCalendar(client, parsed, out);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipmail-cli",
-  "version": "0.4.2",
+  "version": "0.4.5",
   "description": "Official CLI for the ShipMail API",
   "type": "module",
   "bin": {
@@ -31,7 +31,7 @@
   "homepage": "https://shipmail.to/docs/cli",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jcoulaud/ShipMail.git",
+    "url": "git+https://github.com/shipmail-to/Shipmail.git",
     "directory": "packages/shipmail-cli"
   },
   "engines": {
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "shipmail": "0.4.6"
+    "shipmail": "0.4.10"
   },
   "devDependencies": {
     "tsup": "^8.4.0",