@marlinjai/mail-sdk 0.14.0 → 0.15.0

package/dist/index.d.mts

@@ -382,7 +382,7 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 details: Record<string, unknown>;
                 created_at: string;
-                action: "workspace.created" | "workspace.updated" | "workspace.company_changed" | "member.added" | "member.role_changed" | "member.removed" | "member.invited" | "invite.revoked" | "api_key.created" | "api_key.revoked" | "provider.created" | "provider.updated" | "provider.deleted" | "provider.events_registered" | "provider.events_secret_set" | "provider.bounces_halted" | "provider.anomaly_cleared" | "topic.created" | "topic.updated" | "topic.deleted" | "template.created" | "template.updated" | "template.deleted" | "template.inputs_declared" | "saved_section.created" | "saved_section.updated" | "saved_section.deleted" | "asset.uploaded" | "asset.imported" | "contact.erased" | "suppression.created" | "suppression.deleted" | "mailing.created" | "mailing.sent" | "mailing.paused" | "mailing.resumed" | "mailing.cancelled" | "mailing.retried" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.secret_rotated" | "webhook.redelivered" | "contact.unsubscribed" | "tag.created" | "tag.deleted" | "tag.assigned" | "tag.unassigned" | "contact_property.created" | "contact_property.deleted" | "segment.created" | "segment.updated" | "segment.deleted" | "signup_form.created" | "signup_form.updated" | "signup_form.deleted" | "contact.subscribed" | "import.created" | "import.mapped" | "import.committed" | "import.cancelled" | "import.finished" | "mailing.scheduled" | "mailing.unscheduled" | "mailing.schedule_failed" | "mailing.ab_test_updated" | "mailing.ab_winner_selected" | "tracking.updated" | "billing.checkout_started" | "billing.subscription_changed" | "billing.exemption_changed" | "automation.created" | "automation.updated" | "automation.published" | "automation.paused" | "automation.resumed" | "automation.archived" | "automation.deleted" | "automation.duplicated" | "automation.enrolled" | "automation.run_ended" | "event.recorded";
+                action: "workspace.created" | "workspace.updated" | "workspace.company_changed" | "member.added" | "member.role_changed" | "member.removed" | "member.invited" | "invite.revoked" | "api_key.created" | "api_key.revoked" | "provider.created" | "provider.updated" | "provider.deleted" | "provider.events_registered" | "provider.events_secret_set" | "provider.bounces_halted" | "provider.anomaly_cleared" | "topic.created" | "topic.updated" | "topic.deleted" | "template.created" | "template.updated" | "template.deleted" | "template.inputs_declared" | "saved_section.created" | "saved_section.updated" | "saved_section.deleted" | "asset.uploaded" | "asset.imported" | "contact.erased" | "suppression.created" | "suppression.deleted" | "mailing.created" | "mailing.sent" | "mailing.paused" | "mailing.resumed" | "mailing.cancelled" | "mailing.deleted" | "mailing.retried" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.secret_rotated" | "webhook.redelivered" | "contact.unsubscribed" | "tag.created" | "tag.deleted" | "tag.assigned" | "tag.unassigned" | "contact_property.created" | "contact_property.deleted" | "segment.created" | "segment.updated" | "segment.deleted" | "signup_form.created" | "signup_form.updated" | "signup_form.deleted" | "contact.subscribed" | "import.created" | "import.mapped" | "import.committed" | "import.cancelled" | "import.finished" | "mailing.scheduled" | "mailing.unscheduled" | "mailing.schedule_failed" | "mailing.ab_test_updated" | "mailing.ab_winner_selected" | "tracking.updated" | "billing.checkout_started" | "billing.subscription_changed" | "billing.exemption_changed" | "automation.created" | "automation.updated" | "automation.published" | "automation.paused" | "automation.resumed" | "automation.archived" | "automation.deleted" | "automation.duplicated" | "automation.enrolled" | "automation.run_ended" | "event.recorded";
                 actor: {
                     type: "member";
                     subject: string;
@@ -2371,6 +2371,16 @@ declare function createNamespaces(config: CoreConfig): {
             finished_at: string | null;
             pause_reason: string | null;
         }>;
+        /**
+         * Deletes a mailing that never started: a draft, or one cancelled before
+         * any send began (`canDeleteMailing` answers for a mailing in hand).
+         * Anything else is `mailing_invalid_state` (409) and nothing is deleted:
+         * unschedule a scheduled mailing first; a mailing that started stays.
+         * Test sends made from it stay in the archive, with `mailing_id` null.
+         */
+        delete: (id: string, opts?: RequestOpts) => Promise<{
+            ok: true;
+        }>;
         retryFailed: (id: string, body?: RouteBody<"mailings.retryFailed">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;

package/dist/index.d.ts

@@ -382,7 +382,7 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 details: Record<string, unknown>;
                 created_at: string;
-                action: "workspace.created" | "workspace.updated" | "workspace.company_changed" | "member.added" | "member.role_changed" | "member.removed" | "member.invited" | "invite.revoked" | "api_key.created" | "api_key.revoked" | "provider.created" | "provider.updated" | "provider.deleted" | "provider.events_registered" | "provider.events_secret_set" | "provider.bounces_halted" | "provider.anomaly_cleared" | "topic.created" | "topic.updated" | "topic.deleted" | "template.created" | "template.updated" | "template.deleted" | "template.inputs_declared" | "saved_section.created" | "saved_section.updated" | "saved_section.deleted" | "asset.uploaded" | "asset.imported" | "contact.erased" | "suppression.created" | "suppression.deleted" | "mailing.created" | "mailing.sent" | "mailing.paused" | "mailing.resumed" | "mailing.cancelled" | "mailing.retried" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.secret_rotated" | "webhook.redelivered" | "contact.unsubscribed" | "tag.created" | "tag.deleted" | "tag.assigned" | "tag.unassigned" | "contact_property.created" | "contact_property.deleted" | "segment.created" | "segment.updated" | "segment.deleted" | "signup_form.created" | "signup_form.updated" | "signup_form.deleted" | "contact.subscribed" | "import.created" | "import.mapped" | "import.committed" | "import.cancelled" | "import.finished" | "mailing.scheduled" | "mailing.unscheduled" | "mailing.schedule_failed" | "mailing.ab_test_updated" | "mailing.ab_winner_selected" | "tracking.updated" | "billing.checkout_started" | "billing.subscription_changed" | "billing.exemption_changed" | "automation.created" | "automation.updated" | "automation.published" | "automation.paused" | "automation.resumed" | "automation.archived" | "automation.deleted" | "automation.duplicated" | "automation.enrolled" | "automation.run_ended" | "event.recorded";
+                action: "workspace.created" | "workspace.updated" | "workspace.company_changed" | "member.added" | "member.role_changed" | "member.removed" | "member.invited" | "invite.revoked" | "api_key.created" | "api_key.revoked" | "provider.created" | "provider.updated" | "provider.deleted" | "provider.events_registered" | "provider.events_secret_set" | "provider.bounces_halted" | "provider.anomaly_cleared" | "topic.created" | "topic.updated" | "topic.deleted" | "template.created" | "template.updated" | "template.deleted" | "template.inputs_declared" | "saved_section.created" | "saved_section.updated" | "saved_section.deleted" | "asset.uploaded" | "asset.imported" | "contact.erased" | "suppression.created" | "suppression.deleted" | "mailing.created" | "mailing.sent" | "mailing.paused" | "mailing.resumed" | "mailing.cancelled" | "mailing.deleted" | "mailing.retried" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.secret_rotated" | "webhook.redelivered" | "contact.unsubscribed" | "tag.created" | "tag.deleted" | "tag.assigned" | "tag.unassigned" | "contact_property.created" | "contact_property.deleted" | "segment.created" | "segment.updated" | "segment.deleted" | "signup_form.created" | "signup_form.updated" | "signup_form.deleted" | "contact.subscribed" | "import.created" | "import.mapped" | "import.committed" | "import.cancelled" | "import.finished" | "mailing.scheduled" | "mailing.unscheduled" | "mailing.schedule_failed" | "mailing.ab_test_updated" | "mailing.ab_winner_selected" | "tracking.updated" | "billing.checkout_started" | "billing.subscription_changed" | "billing.exemption_changed" | "automation.created" | "automation.updated" | "automation.published" | "automation.paused" | "automation.resumed" | "automation.archived" | "automation.deleted" | "automation.duplicated" | "automation.enrolled" | "automation.run_ended" | "event.recorded";
                 actor: {
                     type: "member";
                     subject: string;
@@ -2371,6 +2371,16 @@ declare function createNamespaces(config: CoreConfig): {
             finished_at: string | null;
             pause_reason: string | null;
         }>;
+        /**
+         * Deletes a mailing that never started: a draft, or one cancelled before
+         * any send began (`canDeleteMailing` answers for a mailing in hand).
+         * Anything else is `mailing_invalid_state` (409) and nothing is deleted:
+         * unschedule a scheduled mailing first; a mailing that started stays.
+         * Test sends made from it stay in the archive, with `mailing_id` null.
+         */
+        delete: (id: string, opts?: RequestOpts) => Promise<{
+            ok: true;
+        }>;
         retryFailed: (id: string, body?: RouteBody<"mailings.retryFailed">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;

package/dist/index.js

@@ -579,6 +579,14 @@ function createNamespaces(config) {
       pause: (id, opts) => execute(config, "mailings.pause", { params: { id }, body: {} }, opts),
       resume: (id, opts) => execute(config, "mailings.resume", { params: { id }, body: {} }, opts),
       cancel: (id, opts) => execute(config, "mailings.cancel", { params: { id }, body: {} }, opts),
+      /**
+       * Deletes a mailing that never started: a draft, or one cancelled before
+       * any send began (`canDeleteMailing` answers for a mailing in hand).
+       * Anything else is `mailing_invalid_state` (409) and nothing is deleted:
+       * unschedule a scheduled mailing first; a mailing that started stays.
+       * Test sends made from it stay in the archive, with `mailing_id` null.
+       */
+      delete: (id, opts) => execute(config, "mailings.delete", { params: { id } }, opts),
       retryFailed: (id, body = {}, opts) => execute(config, "mailings.retryFailed", { params: { id }, body }, opts),
       duplicate: (id, opts) => execute(config, "mailings.duplicate", { params: { id }, body: {} }, opts),
       // S4: scheduling, segments and A/B testing

package/dist/index.mjs

@@ -563,6 +563,14 @@ function createNamespaces(config) {
       pause: (id, opts) => execute(config, "mailings.pause", { params: { id }, body: {} }, opts),
       resume: (id, opts) => execute(config, "mailings.resume", { params: { id }, body: {} }, opts),
       cancel: (id, opts) => execute(config, "mailings.cancel", { params: { id }, body: {} }, opts),
+      /**
+       * Deletes a mailing that never started: a draft, or one cancelled before
+       * any send began (`canDeleteMailing` answers for a mailing in hand).
+       * Anything else is `mailing_invalid_state` (409) and nothing is deleted:
+       * unschedule a scheduled mailing first; a mailing that started stays.
+       * Test sends made from it stay in the archive, with `mailing_id` null.
+       */
+      delete: (id, opts) => execute(config, "mailings.delete", { params: { id } }, opts),
       retryFailed: (id, body = {}, opts) => execute(config, "mailings.retryFailed", { params: { id }, body }, opts),
       duplicate: (id, opts) => execute(config, "mailings.duplicate", { params: { id }, body: {} }, opts),
       // S4: scheduling, segments and A/B testing

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Typed client for the Lumitra Mail v1 API: Node and edge runtimes, retries with idempotency, cursor pagination, webhook verification",
   "license": "MIT",
   "repository": {
@@ -32,7 +32,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@marlinjai/mail-contract": "^0.14.0"
+    "@marlinjai/mail-contract": "^0.15.0"
   },
   "peerDependencies": {
     "zod": "^3.25.0"