@primitivedotdev/sdk 0.11.0 → 0.13.0

package/oclif.manifest.json

@@ -136,6 +136,42 @@
       "summary": "Send an email (simplified, agent-friendly)",
       "enableJsonFlag": false
     },
+    "whoami": {
+      "aliases": [],
+      "args": {},
+      "description": "Print the account currently authenticated by the API key. Useful as a credentials smoke test: confirms the key is live and shows which account it belongs to.",
+      "examples": [
+        "<%= config.bin %> whoami",
+        "<%= config.bin %> whoami --api-key prim_..."
+      ],
+      "flags": {
+        "api-key": {
+          "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
+          "env": "PRIMITIVE_API_KEY",
+          "name": "api-key",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "base-url": {
+          "description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
+          "env": "PRIMITIVE_API_URL",
+          "name": "base-url",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "whoami",
+      "pluginAlias": "@primitivedotdev/sdk",
+      "pluginName": "@primitivedotdev/sdk",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Print the authenticated account (credentials smoke test)",
+      "enableJsonFlag": false
+    },
     "account:get-account": {
       "aliases": [],
       "args": {},
@@ -285,15 +321,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -306,7 +342,7 @@
           "type": "boolean"
         },
         "spam-threshold": {
-          "description": "Global spam score threshold (0-15). Emails scoring above this are rejected. S...",
+          "description": "Global spam score threshold (0-15). Emails scoring above this are rejected. Set to null to disable.",
           "name": "spam-threshold",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -344,15 +380,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -477,15 +513,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -748,7 +784,7 @@
     "emails:list-emails": {
       "aliases": [],
       "args": {},
-      "description": "Returns a paginated list of received emails. Supports filtering by\ndomain, status, date range, and free-text search across subject,\nsender, and recipient fields.\n",
+      "description": "Returns a paginated list of INBOUND emails received at your\nverified domains. Outbound messages sent via /send-mail are not\nincluded; this endpoint is the inbox view, not a unified\nsend/receive history.\n\nSupports filtering by domain, status, date range, and free-text\nsearch across subject, sender, and recipient fields.\n",
       "flags": {
         "api-key": {
           "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
@@ -836,7 +872,7 @@
       "pluginName": "@primitivedotdev/sdk",
       "pluginType": "core",
       "strict": true,
-      "summary": "List emails",
+      "summary": "List inbound emails",
       "enableJsonFlag": false
     },
     "emails:replay-email-webhooks": {
@@ -882,7 +918,7 @@
     "endpoints:create-endpoint": {
       "aliases": [],
       "args": {},
-      "description": "Creates a new webhook endpoint. If a deactivated endpoint with the\nsame URL and domain exists, it is reactivated instead.\nSubject to plan limits on the number of active endpoints.\n\n\nBody fields requiring --body JSON (these are not exposed as flags):\n   rules  object  Endpoint-specific filtering rules\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
+      "description": "Creates a new webhook endpoint. If a deactivated endpoint with the\nsame URL and domain exists, it is reactivated instead.\nSubject to plan limits on the number of active endpoints.\n\n\nBody fields requiring --raw-body JSON (these are not exposed as flags):\n   rules  object  Endpoint-specific filtering rules\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
       "flags": {
         "api-key": {
           "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
@@ -900,15 +936,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1060,7 +1096,7 @@
     "endpoints:update-endpoint": {
       "aliases": [],
       "args": {},
-      "description": "Updates an active webhook endpoint. If the URL is changed, the old\nendpoint is deactivated and a new one is created (or an existing\ndeactivated endpoint with the new URL is reactivated).\n\n\nBody fields requiring --body JSON (these are not exposed as flags):\n   rules  object\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
+      "description": "Updates an active webhook endpoint. If the URL is changed, the old\nendpoint is deactivated and a new one is created (or an existing\ndeactivated endpoint with the new URL is reactivated).\n\n\nBody fields requiring --raw-body JSON (these are not exposed as flags):\n   rules  object\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
       "flags": {
         "api-key": {
           "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
@@ -1086,15 +1122,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1152,15 +1188,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1303,15 +1339,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1334,6 +1370,38 @@
       "summary": "Update a filter rule",
       "enableJsonFlag": false
     },
+    "sending:get-send-permissions": {
+      "aliases": [],
+      "args": {},
+      "description": "Returns a flat list of rules describing every recipient the\ncaller may send to. Each rule has a `type`, a kind-specific\npayload, and a human-readable `description`. If any rule\nmatches the recipient, /send-mail will accept the send under\nthe recipient-scope check.\n\nThe endpoint is the answer to \"where can I send\" without\nexposing internal entitlement names. Agents that don't\nrecognize a `type` can still read the `description` prose\nand act on it.\n\nRule kinds, ordered broadest-first so an agent can stop\nscanning at the first match:\n\n  1. `any_recipient` (one entry, only when the org can send\n     anywhere): every other rule below it is redundant.\n  2. `managed_zone` (always emitted, one per Primitive-managed\n     zone): sends to any address at *.primitive.email or\n     *.email.works always succeed; no entitlement required.\n  3. `your_domain` (one per active verified outbound domain\n     owned by the org): sends to that domain are approved.\n  4. `address` (one per address that has authenticated\n     inbound mail to the org, capped at `meta.address_cap`):\n     sends to that exact address are approved.\n\nThe list is informational, not an authorization check.\n/send-mail remains the source of truth on whether an\nindividual send will succeed (it also enforces the\nfrom-address and the `send_mail` entitlement, which are\nnot recipient-scope concerns and are not represented here).\n",
+      "flags": {
+        "api-key": {
+          "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
+          "env": "PRIMITIVE_API_KEY",
+          "name": "api-key",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "base-url": {
+          "description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
+          "env": "PRIMITIVE_API_URL",
+          "name": "base-url",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "sending:get-send-permissions",
+      "pluginAlias": "@primitivedotdev/sdk",
+      "pluginName": "@primitivedotdev/sdk",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "List send-permission rules",
+      "enableJsonFlag": false
+    },
     "sending:reply-to-email": {
       "aliases": [],
       "args": {},
@@ -1363,15 +1431,15 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1385,21 +1453,21 @@
           "type": "option"
         },
         "body-text": {
-          "description": "Plain-text reply body. At least one of body_text or body_html is required. Th...",
+          "description": "Plain-text reply body. At least one of body_text or body_html is required. The combined UTF-8 byte length of body_text and body_html must be at most 262144 bytes (same cap as send-mail).",
           "name": "body-text",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "from": {
-          "description": "Optional override for the reply's From header. Defaults to",
+          "description": "Optional override for the reply's From header. Defaults to the inbound's recipient. Use to add a display name (`\"Acme Support\" <agent@company.com>`) or to reply from a different verified outbound address (e.g. multi-team routing where support@ triages to billing@). The from-domain must be a verified outbound domain for your org, same as send-mail.",
           "name": "from",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "wait": {
-          "description": "When true, wait for the first downstream SMTP delivery outcome before returni...",
+          "description": "When true, wait for the first downstream SMTP delivery outcome before returning, mirroring the send-mail `wait` semantics.",
           "name": "wait",
           "allowNo": false,
           "type": "boolean"
@@ -1418,7 +1486,7 @@
     "sending:send-email": {
       "aliases": [],
       "args": {},
-      "description": "Sends an outbound email through Primitive's outbound relay. By default\nthe request returns once the relay accepts the message for delivery.\nSet `wait: true` to wait for the first downstream SMTP delivery outcome.\n\n\nBody fields requiring --body JSON (these are not exposed as flags):\n   references  array<string>  Full ordered message-id chain for the thread.\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
+      "description": "Sends an outbound email through Primitive's outbound relay. By default\nthe request returns once the relay accepts the message for delivery.\nSet `wait: true` to wait for the first downstream SMTP delivery outcome.\n\n\nBody fields requiring --raw-body JSON (these are not exposed as flags):\n   references  array<string>  Full ordered message-id chain for the thread.\n(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)",
       "flags": {
         "api-key": {
           "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
@@ -1436,22 +1504,22 @@
           "multiple": false,
           "type": "option"
         },
-        "body": {
-          "description": "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
-          "name": "body",
+        "raw-body": {
+          "description": "Full request body as raw JSON. Escape hatch for nested or complex fields (e.g. arrays); prefer per-field flags (e.g. --to, --from, --body-text) when available.",
+          "name": "raw-body",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-file": {
-          "description": "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
+          "description": "Path to a JSON file used as the request body. Same role as --raw-body for callers passing a saved payload.",
           "name": "body-file",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "from": {
-          "description": "RFC 5322 From header. The sender domain must be a verified outbound domain fo...",
+          "description": "RFC 5322 From header. The sender domain must be a verified outbound domain for your organization.",
           "name": "from",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1465,21 +1533,21 @@
           "type": "option"
         },
         "to": {
-          "description": "Recipient address. Recipient eligibility depends on your account's outbound e...",
+          "description": "Recipient address. Recipient eligibility depends on your account's outbound entitlements.",
           "name": "to",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-html": {
-          "description": "HTML message body. At least one of body_text or body_html is required. The co...",
+          "description": "HTML message body. At least one of body_text or body_html is required. The combined UTF-8 byte length of body_text and body_html must be at most 262144 bytes.",
           "name": "body-html",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "body-text": {
-          "description": "Plain-text message body. At least one of body_text or body_html is required. ...",
+          "description": "Plain-text message body. At least one of body_text or body_html is required. The combined UTF-8 byte length of body_text and body_html must be at most 262144 bytes.",
           "name": "body-text",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1499,7 +1567,7 @@
           "type": "boolean"
         },
         "wait-timeout-ms": {
-          "description": "Maximum time to wait for a delivery outcome when wait is true. Defaults to 30...",
+          "description": "Maximum time to wait for a delivery outcome when wait is true. Defaults to 30000.",
           "name": "wait-timeout-ms",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1643,5 +1711,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "0.11.0"
+  "version": "0.13.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primitivedotdev/sdk",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Official Primitive Node.js SDK — webhook, api, openapi, contract, and parser modules",
   "type": "module",
   "module": "./dist/index.js",