@marlinjai/mail-sdk 0.13.0 → 0.15.0

package/README.md

@@ -350,11 +350,38 @@ const client = dashboardMail.forUser({ subject: session.subject }); // no worksp
 const workspace = await client.workspaces.create({
   slug: 'opuntia',
   name: 'ŌPUNTIA',
+  // Required since 0.14.0: every workspace belongs to a company of the shared login.
+  company_id: session.companyId,
   owner: { email: session.email, name: session.name },
 });
 // From here on, calls for this workspace pass its id: forUser({ subject, workspaceId: workspace.id }).
 ```
 
+### Company roles: who is in without an invitation (0.14.0)
+
+An owner or admin of a workspace's company is in the workspace without being
+invited. The service never talks to the shared login, so the dashboard tells
+it: before acting for a person, it states that person's owner and admin roles
+in companies, complete, exactly as the verified session reports them.
+
+```ts
+const result = await dashboardMail.forUser({ subject: session.subject }).members.syncCompanyRole({
+  email: session.email,
+  name: session.name,
+  // Every company where the session says owner or admin, and nothing else.
+  companies: [{ company_id: 'tenant_opuntia', role: 'owner' }],
+});
+// { granted: [...workspace ids], revoked: [...], unchanged: [...] }
+```
+
+The service gives the person a member row in every workspace of those
+companies and takes away every company role the statement does not name, so an
+empty list is how a lost role is reported. Only the dashboard's service token
+may make this call (an API key and every trusted application are refused), it
+takes no `Idempotency-Key`, and the roles must never come from anywhere but
+the verified session: this call is believed because of who sends it. A role
+not confirmed again within `COMPANY_ROLE_MAX_AGE_HOURS` (24) counts as absent.
+
 Adding a person to an existing workspace binds them by their auth-brain
 subject, not an email invite (the service never sees a login, so the caller
 resolves the person first):

package/dist/index.d.mts

@@ -209,6 +209,11 @@ declare function createNamespaces(config: CoreConfig): {
                 subject: string;
                 created_at: string;
                 role: "owner" | "admin" | "editor" | "viewer";
+                source?: "invited" | "company" | undefined;
+                company_role?: "owner" | "admin" | null | undefined;
+                company_checked_at?: string | null | undefined;
+                direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+                inherited?: boolean | undefined;
             }[];
             next_cursor: string | null;
         }>;
@@ -224,6 +229,11 @@ declare function createNamespaces(config: CoreConfig): {
             subject: string;
             created_at: string;
             role: "owner" | "admin" | "editor" | "viewer";
+            source?: "invited" | "company" | undefined;
+            company_role?: "owner" | "admin" | null | undefined;
+            company_checked_at?: string | null | undefined;
+            direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+            inherited?: boolean | undefined;
         }>;
         update: (id: string, body: RouteBody<"members.update">, opts?: RequestOpts) => Promise<{
             id: string;
@@ -232,10 +242,28 @@ declare function createNamespaces(config: CoreConfig): {
             subject: string;
             created_at: string;
             role: "owner" | "admin" | "editor" | "viewer";
+            source?: "invited" | "company" | undefined;
+            company_role?: "owner" | "admin" | null | undefined;
+            company_checked_at?: string | null | undefined;
+            direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+            inherited?: boolean | undefined;
         }>;
         remove: (id: string, opts?: RequestOpts) => Promise<{
             ok: true;
         }>;
+        /**
+         * The dashboard only: states the signed-in person's owner and admin
+         * roles in companies, complete, as the shared login's verified session
+         * reports them. The service gives the person a member row in every
+         * workspace of those companies and takes away every company role not
+         * stated. Never send a role that came from anywhere but the verified
+         * session.
+         */
+        syncCompanyRole: (body: RouteBody<"members.syncCompanyRole">, opts?: RequestOpts) => Promise<{
+            unchanged: string[];
+            granted: string[];
+            revoked: string[];
+        }>;
     };
     /**
      * Invitations: an admin invites an address with a role (the token is in
@@ -245,7 +273,7 @@ declare function createNamespaces(config: CoreConfig): {
     invites: {
         create: (body: RouteBody<"invites.create">, opts?: RequestOpts) => Promise<{
             invite: {
-                status: "pending" | "accepted" | "revoked" | "expired";
+                status: "pending" | "revoked" | "accepted" | "expired";
                 id: string;
                 email: string;
                 created_at: string;
@@ -262,7 +290,7 @@ declare function createNamespaces(config: CoreConfig): {
         }>;
         list: (query?: RouteQuery<"invites.list">, opts?: RequestOpts) => Promise<{
             data: {
-                status: "pending" | "accepted" | "revoked" | "expired";
+                status: "pending" | "revoked" | "accepted" | "expired";
                 id: string;
                 email: string;
                 created_at: string;
@@ -278,7 +306,7 @@ declare function createNamespaces(config: CoreConfig): {
             next_cursor: string | null;
         }>;
         revoke: (id: string, opts?: RequestOpts) => Promise<{
-            status: "pending" | "accepted" | "revoked" | "expired";
+            status: "pending" | "revoked" | "accepted" | "expired";
             id: string;
             email: string;
             created_at: string;
@@ -354,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;
@@ -2343,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

@@ -209,6 +209,11 @@ declare function createNamespaces(config: CoreConfig): {
                 subject: string;
                 created_at: string;
                 role: "owner" | "admin" | "editor" | "viewer";
+                source?: "invited" | "company" | undefined;
+                company_role?: "owner" | "admin" | null | undefined;
+                company_checked_at?: string | null | undefined;
+                direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+                inherited?: boolean | undefined;
             }[];
             next_cursor: string | null;
         }>;
@@ -224,6 +229,11 @@ declare function createNamespaces(config: CoreConfig): {
             subject: string;
             created_at: string;
             role: "owner" | "admin" | "editor" | "viewer";
+            source?: "invited" | "company" | undefined;
+            company_role?: "owner" | "admin" | null | undefined;
+            company_checked_at?: string | null | undefined;
+            direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+            inherited?: boolean | undefined;
         }>;
         update: (id: string, body: RouteBody<"members.update">, opts?: RequestOpts) => Promise<{
             id: string;
@@ -232,10 +242,28 @@ declare function createNamespaces(config: CoreConfig): {
             subject: string;
             created_at: string;
             role: "owner" | "admin" | "editor" | "viewer";
+            source?: "invited" | "company" | undefined;
+            company_role?: "owner" | "admin" | null | undefined;
+            company_checked_at?: string | null | undefined;
+            direct_role?: "owner" | "admin" | "editor" | "viewer" | null | undefined;
+            inherited?: boolean | undefined;
         }>;
         remove: (id: string, opts?: RequestOpts) => Promise<{
             ok: true;
         }>;
+        /**
+         * The dashboard only: states the signed-in person's owner and admin
+         * roles in companies, complete, as the shared login's verified session
+         * reports them. The service gives the person a member row in every
+         * workspace of those companies and takes away every company role not
+         * stated. Never send a role that came from anywhere but the verified
+         * session.
+         */
+        syncCompanyRole: (body: RouteBody<"members.syncCompanyRole">, opts?: RequestOpts) => Promise<{
+            unchanged: string[];
+            granted: string[];
+            revoked: string[];
+        }>;
     };
     /**
      * Invitations: an admin invites an address with a role (the token is in
@@ -245,7 +273,7 @@ declare function createNamespaces(config: CoreConfig): {
     invites: {
         create: (body: RouteBody<"invites.create">, opts?: RequestOpts) => Promise<{
             invite: {
-                status: "pending" | "accepted" | "revoked" | "expired";
+                status: "pending" | "revoked" | "accepted" | "expired";
                 id: string;
                 email: string;
                 created_at: string;
@@ -262,7 +290,7 @@ declare function createNamespaces(config: CoreConfig): {
         }>;
         list: (query?: RouteQuery<"invites.list">, opts?: RequestOpts) => Promise<{
             data: {
-                status: "pending" | "accepted" | "revoked" | "expired";
+                status: "pending" | "revoked" | "accepted" | "expired";
                 id: string;
                 email: string;
                 created_at: string;
@@ -278,7 +306,7 @@ declare function createNamespaces(config: CoreConfig): {
             next_cursor: string | null;
         }>;
         revoke: (id: string, opts?: RequestOpts) => Promise<{
-            status: "pending" | "accepted" | "revoked" | "expired";
+            status: "pending" | "revoked" | "accepted" | "expired";
             id: string;
             email: string;
             created_at: string;
@@ -354,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;
@@ -2343,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

@@ -414,7 +414,16 @@ function createNamespaces(config) {
        */
       add: (body, opts) => execute(config, "members.add", { body }, opts),
       update: (id, body, opts) => execute(config, "members.update", { params: { id }, body }, opts),
-      remove: (id, opts) => execute(config, "members.remove", { params: { id } }, opts)
+      remove: (id, opts) => execute(config, "members.remove", { params: { id } }, opts),
+      /**
+       * The dashboard only: states the signed-in person's owner and admin
+       * roles in companies, complete, as the shared login's verified session
+       * reports them. The service gives the person a member row in every
+       * workspace of those companies and takes away every company role not
+       * stated. Never send a role that came from anywhere but the verified
+       * session.
+       */
+      syncCompanyRole: (body, opts) => execute(config, "members.syncCompanyRole", { body }, opts)
     },
     /**
      * Invitations: an admin invites an address with a role (the token is in
@@ -570,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

@@ -398,7 +398,16 @@ function createNamespaces(config) {
        */
       add: (body, opts) => execute(config, "members.add", { body }, opts),
       update: (id, body, opts) => execute(config, "members.update", { params: { id }, body }, opts),
-      remove: (id, opts) => execute(config, "members.remove", { params: { id } }, opts)
+      remove: (id, opts) => execute(config, "members.remove", { params: { id } }, opts),
+      /**
+       * The dashboard only: states the signed-in person's owner and admin
+       * roles in companies, complete, as the shared login's verified session
+       * reports them. The service gives the person a member row in every
+       * workspace of those companies and takes away every company role not
+       * stated. Never send a role that came from anywhere but the verified
+       * session.
+       */
+      syncCompanyRole: (body, opts) => execute(config, "members.syncCompanyRole", { body }, opts)
     },
     /**
      * Invitations: an admin invites an address with a role (the token is in
@@ -554,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.13.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.13.0"
+    "@marlinjai/mail-contract": "^0.15.0"
   },
   "peerDependencies": {
     "zod": "^3.25.0"