@primitivedotdev/sdk 0.14.0 → 0.15.0

package/oclif.manifest.json

@@ -51,7 +51,7 @@
           "required": true
         }
       },
-      "description": "Print the full operation manifest entry for a single API command, including the path, request schema, response schema, and per-field descriptions sourced from the OpenAPI spec.\n\n  Useful for clarifying response field meanings (e.g. on inbound EmailDetail, which of `sender`, `from_email`, `from_header`, and `smtp_mail_from` to read), confirming required body fields, or checking a path's parameter shape before composing a request.",
+      "description": "Print the full operation manifest entry for a single API command, including the path, request schema, response schema, and per-field descriptions sourced from the OpenAPI spec.\n\n  The manifest entry's `responseSchema` carries the inlined JSON Schema for the operation's 200/201 `data` envelope contents (`$ref`s resolved). Use it to look up what specific response fields mean. Examples:\n\n      # Which of EmailDetail's sender-shaped fields is canonical?\n      primitive describe emails:get-email | jq '.responseSchema.properties | keys'\n      primitive describe emails:get-email | jq -r '.responseSchema.properties.from_email.description'\n\n      # What does each value of SentEmailStatus mean?\n      primitive describe sending:get-sent-email | jq -r '.responseSchema.properties.status.description'\n\n  `requestSchema` is the same shape for the request body when one exists. For a single field across many operations at once, use `primitive list-operations | jq` instead.",
       "examples": [
         "<%= config.bin %> describe emails:get-email",
         "<%= config.bin %> describe sending:send-email"
@@ -75,7 +75,8 @@
         "<%= config.bin %> send --to alice@example.com --body 'Hi Alice!'",
         "<%= config.bin %> send --to alice@example.com --from support@yourcompany.com --subject 'Quick question' --body 'Are you free Thursday?'",
         "<%= config.bin %> send --to alice@example.com --html '<p>Hello!</p>'",
-        "<%= config.bin %> send --to alice@example.com --body 'Confirmed' --wait"
+        "<%= config.bin %> send --to alice@example.com --body 'Confirmed' --wait",
+        "<%= config.bin %> send --to inbox@your-managed-domain.primitive.email --body 'self-loop smoke test' --wait  # any *.primitive.email address routes back to the sending account; useful for proving outbound + inbound work end-to-end"
       ],
       "flags": {
         "api-key": {
@@ -200,10 +201,11 @@
     "emails:latest": {
       "aliases": [],
       "args": {},
-      "description": "Print the N most recent inbound emails as a one-line-per-row text table. Designed for quick triage and visual scanning. For programmatic access, use `primitive emails:list-emails` (full JSON envelope, cursor pagination, filters).\n\n  The displayed id is the first 8 characters of the email's UUID; pass the full UUID (from `emails:list-emails` or `emails:get-email`) to operations that need it.",
+      "description": "Print the N most recent inbound emails as a one-line-per-row text table. Designed for quick triage and visual scanning. For programmatic access, use `primitive emails:list-emails` (full JSON envelope, cursor pagination, filters) or pass `--json` here for the same raw shape without pagination/filters.\n\n  The default text table truncates each row's id to the first 8 characters for readability. Operations that take an id (`emails:get-email`, `emails:delete-email`, etc.) require the full UUID, so pass `--json` or use `emails:list-emails` when you need to feed an id back into another command.\n\n  Output streams: the column header line is written to STDERR so the row data on STDOUT stays grep/awk-friendly. `--json` writes everything (including the envelope) to STDOUT.",
       "examples": [
         "<%= config.bin %> emails:latest",
-        "<%= config.bin %> emails:latest --limit 25"
+        "<%= config.bin %> emails:latest --limit 25",
+        "<%= config.bin %> emails:latest --json | jq '.data[0].id'"
       ],
       "flags": {
         "api-key": {
@@ -229,6 +231,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "json": {
+          "description": "Print the raw response envelope (with full UUIDs and meta) as JSON on STDOUT instead of the text table. Useful for piping into `jq`, capturing ids for follow-up commands, or scripting.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -813,7 +821,7 @@
     "emails:get-email": {
       "aliases": [],
       "args": {},
-      "description": "GET /emails/{id}",
+      "description": "Returns the full record for an inbound email received at one\nof your verified domains, including the parsed text and HTML\nbodies, threading metadata, SMTP envelope detail, webhook\ndelivery state, and a `replies` array for any outbound sends\nrecorded as replies to this inbound.\n\nFor listing inbound emails (with cursor pagination, status\nand date filters, and free-text search), use\n`/emails`. Outbound (sent) email records are NOT returned\nhere; use `/sent-emails/{id}` for those.\n\nThe response carries four sender-shaped fields whose\nmeanings overlap. `from_email` is the canonical \"who sent\nthis\" field for most use cases (parsed bare address from\nthe `From:` header, with a `sender` fallback). `from_header`\nis the raw header including any display name. `sender` and\n`smtp_mail_from` both carry the SMTP envelope MAIL FROM\n(return-path) and are equal by construction; `sender` is\nthe older field name retained for compatibility. See\n`primitive describe emails:get-email | jq '.responseSchema.properties'`\nfor per-field detail.\n",
       "flags": {
         "api-key": {
           "description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
@@ -847,7 +855,7 @@
       "pluginName": "@primitivedotdev/sdk",
       "pluginType": "core",
       "strict": true,
-      "summary": "Get email details",
+      "summary": "Get inbound email by id",
       "enableJsonFlag": false
     },
     "emails:list-emails": {
@@ -896,17 +904,11 @@
           "type": "option"
         },
         "status": {
-          "description": "Filter by email status",
+          "description": "Filter inbound rows by lifecycle status. See `EmailStatus`\nfor what each value means. Note that the webhook delivery\nstate is a SEPARATE lifecycle on the same row; filter by\n`webhook_status` semantics is not currently supported on\nthis endpoint.\n",
           "name": "status",
           "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
-          "options": [
-            "pending",
-            "accepted",
-            "completed",
-            "rejected"
-          ],
           "type": "option"
         },
         "search": {
@@ -1908,5 +1910,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "0.14.0"
+  "version": "0.15.0"
 }

package/package.json

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