@productcraft/mail 0.2.3 → 0.2.4

package/README.md

@@ -10,7 +10,7 @@ Server-side only. The SDK ships a Platform API Key in the `Authorization` header
 
 ## Quick start
 
-```ts
+```ts before
 import { Mail } from "@productcraft/mail";
 
 // Reads PRODUCTCRAFT_API_KEY from the environment
@@ -53,7 +53,7 @@ PRODUCTCRAFT_API_KEY=pcft_live_...
 
 ## Configuration
 
-```ts
+```ts before
 new Mail({
   // The auth credential the SDK presents to Mail
   // Omit to use PRODUCTCRAFT_API_KEY from the environment
@@ -73,7 +73,7 @@ Every path is workspace-scoped — `{workspace_id}` is the UUID of the workspace
 
 ### Templates
 
-```ts
+```ts before
 // List templates
 await mail.client.GET(
   "/v1/workspaces/{workspace_id}/templates",
@@ -115,7 +115,7 @@ await mail.client.POST(
 
 ### Domains + DKIM
 
-```ts
+```ts before
 // List domains
 await mail.client.GET("/v1/workspaces/{workspace_id}/domains", { ... });
 
@@ -134,7 +134,7 @@ await mail.client.POST(
 
 ### Messages
 
-```ts
+```ts before
 // Workspace-wide message listing + filters
 await mail.client.GET(
   "/v1/workspaces/{workspace_id}/messages",
@@ -151,7 +151,7 @@ await mail.client.GET(
 
 ### Suppression list
 
-```ts
+```ts before
 // Add an email to the workspace suppression list
 await mail.client.POST(
   "/v1/workspaces/{workspace_id}/suppression",
@@ -161,7 +161,7 @@ await mail.client.POST(
 
 ### Outbound webhooks
 
-```ts
+```ts before
 // Configure the workspace's default webhook (delivery / open / bounce events)
 await mail.client.PUT(
   "/v1/workspaces/{workspace_id}/webhooks/default",

package/dist/index.d.cts

@@ -2001,7 +2001,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_mail_workspace_getEndpoint"];
         put?: never;
         post?: never;
@@ -2106,7 +2109,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_mail_workspace_getEvent"];
         put?: never;
         post?: never;
@@ -2764,8 +2770,9 @@ interface components {
              */
             domain_id?: string | null;
             /**
-             * @description Create it switched off.
+             * @description Send `false` to create it switched off.
              * @default true
+             * @example true
              */
             enabled: boolean;
             /**
@@ -5410,6 +5417,7 @@ interface components {
             /**
              * @description Hours the previous secret keeps signing too (0 ends it now).
              * @default 24
+             * @example 24
              */
             grace_hours: number;
         };
@@ -6040,16 +6048,28 @@ interface components {
             visibility?: "public" | "private";
         };
         UpdateWebhookEndpointDto: {
-            /** @description A new label; null clears it. */
+            /**
+             * @description A new label; null clears it.
+             * @example Production receiver
+             */
             description?: string | null;
             /**
              * Format: uuid
              * @description Domain filter; null removes it. Not allowed on a legacy slot (its domain is what makes it one).
              */
             domain_id?: string | null;
-            /** @description Switch it on or off. Switching on also clears an automatic disable. */
+            /**
+             * @description Switch it on or off. Switching on also clears an automatic disable.
+             * @example true
+             */
             enabled?: boolean;
-            /** @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. Older names (`message.sent`, `message.delivered`, `message.deferred`, `message.bounced`, `message.complained`, `message.failed`) are still accepted; an endpoint subscribed under one receives the event with that name as its `type`. */
+            /**
+             * @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. Older names (`message.sent`, `message.delivered`, `message.deferred`, `message.bounced`, `message.complained`, `message.failed`) are still accepted; an endpoint subscribed under one receives the event with that name as its `type`.
+             * @example [
+             *       "email.sent",
+             *       "email.delivered"
+             *     ]
+             */
             event_types?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted" | "message.sent" | "message.delivered" | "message.deferred" | "message.bounced" | "message.complained" | "message.failed")[];
             /** @description Replaces the subscription. Older name for `event_types`, accepted and returned until the legacy webhook routes are retired (Sunset: 2027-01-15). Send one of the two. */
             events?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted" | "message.sent" | "message.delivered" | "message.deferred" | "message.bounced" | "message.complained" | "message.failed")[];

package/dist/index.d.ts

@@ -2001,7 +2001,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_mail_workspace_getEndpoint"];
         put?: never;
         post?: never;
@@ -2106,7 +2109,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_mail_workspace_getEvent"];
         put?: never;
         post?: never;
@@ -2764,8 +2770,9 @@ interface components {
              */
             domain_id?: string | null;
             /**
-             * @description Create it switched off.
+             * @description Send `false` to create it switched off.
              * @default true
+             * @example true
              */
             enabled: boolean;
             /**
@@ -5410,6 +5417,7 @@ interface components {
             /**
              * @description Hours the previous secret keeps signing too (0 ends it now).
              * @default 24
+             * @example 24
              */
             grace_hours: number;
         };
@@ -6040,16 +6048,28 @@ interface components {
             visibility?: "public" | "private";
         };
         UpdateWebhookEndpointDto: {
-            /** @description A new label; null clears it. */
+            /**
+             * @description A new label; null clears it.
+             * @example Production receiver
+             */
             description?: string | null;
             /**
              * Format: uuid
              * @description Domain filter; null removes it. Not allowed on a legacy slot (its domain is what makes it one).
              */
             domain_id?: string | null;
-            /** @description Switch it on or off. Switching on also clears an automatic disable. */
+            /**
+             * @description Switch it on or off. Switching on also clears an automatic disable.
+             * @example true
+             */
             enabled?: boolean;
-            /** @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. Older names (`message.sent`, `message.delivered`, `message.deferred`, `message.bounced`, `message.complained`, `message.failed`) are still accepted; an endpoint subscribed under one receives the event with that name as its `type`. */
+            /**
+             * @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. Older names (`message.sent`, `message.delivered`, `message.deferred`, `message.bounced`, `message.complained`, `message.failed`) are still accepted; an endpoint subscribed under one receives the event with that name as its `type`.
+             * @example [
+             *       "email.sent",
+             *       "email.delivered"
+             *     ]
+             */
             event_types?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted" | "message.sent" | "message.delivered" | "message.deferred" | "message.bounced" | "message.complained" | "message.failed")[];
             /** @description Replaces the subscription. Older name for `event_types`, accepted and returned until the legacy webhook routes are retired (Sunset: 2027-01-15). Send one of the two. */
             events?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted" | "message.sent" | "message.delivered" | "message.deferred" | "message.bounced" | "message.complained" | "message.failed")[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productcraft/mail",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Receive-and-store mail platform — template-rendered sends, mailboxes + domains + DKIM, message timeline, suppression lists, outbound webhooks via ProductCraft Mail. Generated from the production OpenAPI spec.",
   "type": "module",
   "main": "./dist/index.cjs",