@marlinjai/mail-contract 0.13.0 → 0.15.0

package/dist/index.js

@@ -107,10 +107,13 @@ __export(index_exports, {
   BILLING_NOT_CONFIGURED_REASON: () => BILLING_NOT_CONFIGURED_REASON,
   BoundedAutomationFilter: () => BoundedAutomationFilter,
   BoundedSegmentFilter: () => BoundedSegmentFilter,
+  COMPANY_GRANT_ROLES: () => COMPANY_GRANT_ROLES,
+  COMPANY_ROLE_MAX_AGE_HOURS: () => COMPANY_ROLE_MAX_AGE_HOURS,
   CONTACT_PROPERTY_TYPES: () => CONTACT_PROPERTY_TYPES,
   CatalogPlan: () => CatalogPlan,
   CheckoutRequest: () => CheckoutRequest,
   CheckoutSession: () => CheckoutSession,
+  CompanyGrantRole: () => CompanyGrantRole,
   CompanyId: () => CompanyId,
   CompileMessage: () => CompileMessage,
   CompileRequest: () => CompileRequest,
@@ -249,6 +252,7 @@ __export(index_exports, {
   MAX_STEPS: () => MAX_STEPS,
   MAX_STEP_VISITS: () => MAX_STEP_VISITS,
   MAX_SUBJECT_LENGTH: () => MAX_SUBJECT_LENGTH,
+  MAX_SYNC_COMPANIES: () => MAX_SYNC_COMPANIES,
   MAX_TEMPLATE_INPUTS: () => MAX_TEMPLATE_INPUTS,
   MAX_TEMPLATE_INPUTS_APP_LENGTH: () => MAX_TEMPLATE_INPUTS_APP_LENGTH,
   MAX_TEMPLATE_INPUTS_SEEN: () => MAX_TEMPLATE_INPUTS_SEEN,
@@ -259,6 +263,7 @@ __export(index_exports, {
   MAX_TEMPLATE_TRANSLATIONS: () => MAX_TEMPLATE_TRANSLATIONS,
   MAX_TRIGGERS: () => MAX_TRIGGERS,
   MEMBER_ROLES: () => MEMBER_ROLES,
+  MEMBER_SOURCES: () => MEMBER_SOURCES,
   MERGE_FIELD_PATTERN: () => MERGE_FIELD_PATTERN,
   MESSAGE_OUTCOMES: () => MESSAGE_OUTCOMES,
   MIN_SPLIT_BRANCHES: () => MIN_SPLIT_BRANCHES,
@@ -294,8 +299,11 @@ __export(index_exports, {
   MailingTestResult: () => MailingTestResult,
   MailingUpdate: () => MailingUpdate,
   Member: () => Member,
+  MemberCompanySync: () => MemberCompanySync,
+  MemberCompanySyncResult: () => MemberCompanySyncResult,
   MemberCreate: () => MemberCreate,
   MemberRole: () => MemberRole,
+  MemberSource: () => MemberSource,
   MemberUpdate: () => MemberUpdate,
   MergeDefaultValue: () => MergeDefaultValue,
   MergeDefaults: () => MergeDefaults,
@@ -503,6 +511,7 @@ __export(index_exports, {
   billingRoutes: () => billingRoutes,
   buildPath: () => buildPath,
   buildTemplatePatch: () => buildTemplatePatch,
+  canDeleteMailing: () => canDeleteMailing,
   canTransition: () => canTransition,
   canonicalLocale: () => canonicalLocale,
   choiceKeyProblem: () => choiceKeyProblem,
@@ -1826,6 +1835,10 @@ var Mailing = import_zod8.z.object({
   updated_at: Timestamp
 });
 var MailingSummary = Mailing.omit({ document: true });
+function canDeleteMailing(mailing) {
+  if (mailing.kind !== "broadcast") return false;
+  return mailing.status === "draft" || mailing.status === "cancelled" && mailing.started_at === null;
+}
 var MailingContent = {
   name: import_zod8.z.string().max(200).optional(),
   subject: import_zod8.z.string().min(1).max(998),
@@ -3474,12 +3487,13 @@ var WorkspaceCreate = import_zod11.z.object({
     name: import_zod11.z.string().max(200).nullable().optional()
   }),
   /**
-   * The signed-in person's active auth-brain company. The dashboard always
-   * sends it, which is what links the workspace to auth-brain's company
-   * erasure; omitted, the workspace belongs to no company and no company
-   * erasure reaches it.
+   * The auth-brain company the workspace is created in. Required since 0.14.0:
+   * every new workspace belongs to a company, which is what links it to that
+   * company's erasure and lets the company's owners and admins in without an
+   * invitation (`members.syncCompanyRole`). A workspace created before, without
+   * one, keeps working and simply has no such inheritance.
    */
-  company_id: CompanyId.optional()
+  company_id: CompanyId
 });
 var WorkspaceUpdate = import_zod11.z.object({
   name: import_zod11.z.string().min(1).max(120),
@@ -3489,14 +3503,58 @@ var WorkspaceMove = import_zod11.z.object({ company_id: CompanyId });
 var MEMBER_ROLES = ["owner", "admin", "editor", "viewer"];
 var MemberRole = import_zod11.z.enum(MEMBER_ROLES);
 var WorkspaceMembership = Workspace.extend({ role: MemberRole });
+var MEMBER_SOURCES = ["invited", "company"];
+var MemberSource = import_zod11.z.enum(MEMBER_SOURCES);
+var COMPANY_GRANT_ROLES = ["owner", "admin"];
+var CompanyGrantRole = import_zod11.z.enum(COMPANY_GRANT_ROLES);
+var COMPANY_ROLE_MAX_AGE_HOURS = 24;
 var Member = import_zod11.z.object({
   id: Id,
   /** The person's auth-brain subject. */
   subject: import_zod11.z.string().min(1).max(255),
   email: Email,
   name: import_zod11.z.string().max(200).nullable(),
+  /**
+   * The role in force: the higher of the person's own role in the workspace
+   * and the one a confirmed company role carries. For a `company` row that is
+   * no longer confirmed, the role it would carry once confirmed again.
+   */
   role: MemberRole,
-  created_at: Timestamp
+  created_at: Timestamp,
+  /*
+   * The five fields below exist since 0.14.0 and are optional only so that a
+   * client built against this contract can still read a service that predates
+   * them: absent means an ordinary, invited member.
+   */
+  source: MemberSource.optional(),
+  /** The company role last reported for the person (`members.syncCompanyRole`), or null. */
+  company_role: CompanyGrantRole.nullable().optional(),
+  /** When the dashboard last confirmed `company_role`; null without one. */
+  company_checked_at: Timestamp.nullable().optional(),
+  /** The person's own role in the workspace; null for a `company` row. */
+  direct_role: MemberRole.nullable().optional(),
+  /**
+   * True while `role` is held only through a confirmed company role. Such a
+   * member cannot be changed or removed here (`inherited_from_company`): the
+   * role is managed in the shared login. A `company` row with `inherited`
+   * false is one whose company role has not been confirmed within
+   * `COMPANY_ROLE_MAX_AGE_HOURS`; it grants nothing and an admin may remove it.
+   */
+  inherited: import_zod11.z.boolean().optional()
+});
+var MAX_SYNC_COMPANIES = 100;
+var MemberCompanySync = import_zod11.z.object({
+  email: Email,
+  name: import_zod11.z.string().max(200).nullable().optional(),
+  companies: import_zod11.z.array(import_zod11.z.object({ company_id: CompanyId, role: CompanyGrantRole })).max(MAX_SYNC_COMPANIES).refine((list2) => new Set(list2.map((c) => c.company_id)).size === list2.length, "each company at most once")
+});
+var MemberCompanySyncResult = import_zod11.z.object({
+  /** Workspaces in which the person now holds a company role they did not hold, or held differently, before this call. */
+  granted: import_zod11.z.array(Id),
+  /** Workspaces in which a company role was taken away by this call. */
+  revoked: import_zod11.z.array(Id),
+  /** Workspaces in which the person's company role was already as stated. */
+  unchanged: import_zod11.z.array(Id)
 });
 var MemberCreate = import_zod11.z.object({
   subject: import_zod11.z.string().min(1).max(255),
@@ -3564,6 +3622,7 @@ var AUDIT_ACTIONS = [
   "mailing.paused",
   "mailing.resumed",
   "mailing.cancelled",
+  "mailing.deleted",
   "mailing.retried",
   "webhook.created",
   "webhook.updated",
@@ -5104,6 +5163,24 @@ var foundationRoutes = {
     access: "admin",
     phase: "S0"
   },
+  /**
+   * The dashboard states the signed-in person's owner and admin roles in
+   * companies, and the service brings the member lists in line (see
+   * `MemberCompanySync`). `dashboard` access: the dashboard's service token
+   * and the person's subject, no workspace. An API key is refused, and so is
+   * every trusted application: it is not in any `TRUSTED_APP_OPERATIONS` list
+   * and the handler refuses an application once more by itself.
+   */
+  "members.syncCompanyRole": {
+    method: "POST",
+    path: "/v1/members/company-sync",
+    body: MemberCompanySync,
+    response: MemberCompanySyncResult,
+    status: 200,
+    access: "dashboard",
+    phase: "S0",
+    statement: true
+  },
   "apiKeys.list": {
     method: "GET",
     path: "/v1/api-keys",
@@ -5675,6 +5752,25 @@ var sendingRoutes = {
     access: "write",
     phase: "S2"
   },
+  /**
+   * Deletes a mailing that never started: a broadcast in `draft`, or one
+   * `cancelled` before any send began (`canDeleteMailing`). Its recipients,
+   * A/B variants and compiled content go with it. Test sends made from it stay
+   * in the archive, with `mailing_id` null: they are mail that really went out.
+   * Anything else is `mailing_invalid_state` (409): a scheduled mailing is
+   * unscheduled first, and a mailing that started is the record of what was
+   * sent. An automation's mailing is `conflict`; a transactional letter is
+   * deleted only by a key that may write one (`forbidden`).
+   */
+  "mailings.delete": {
+    method: "DELETE",
+    path: "/v1/mailings/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "write",
+    phase: "S2"
+  },
   "mailings.retryFailed": {
     method: "POST",
     path: "/v1/mailings/:id/retry-failed",
@@ -6407,7 +6503,7 @@ function trustedAppMayCall(app, id) {
   return TRUSTED_APP_OPERATIONS[app].includes(id);
 }
 function acceptsIdempotencyKey(route) {
-  return route.method !== "GET";
+  return route.method !== "GET" && route.statement !== true;
 }
 function buildPath(path, params = {}) {
   return path.replace(/:([a-z_]+)/g, (_, name) => {
@@ -6528,10 +6624,13 @@ function matchRoute(method, pathname) {
   BILLING_NOT_CONFIGURED_REASON,
   BoundedAutomationFilter,
   BoundedSegmentFilter,
+  COMPANY_GRANT_ROLES,
+  COMPANY_ROLE_MAX_AGE_HOURS,
   CONTACT_PROPERTY_TYPES,
   CatalogPlan,
   CheckoutRequest,
   CheckoutSession,
+  CompanyGrantRole,
   CompanyId,
   CompileMessage,
   CompileRequest,
@@ -6670,6 +6769,7 @@ function matchRoute(method, pathname) {
   MAX_STEPS,
   MAX_STEP_VISITS,
   MAX_SUBJECT_LENGTH,
+  MAX_SYNC_COMPANIES,
   MAX_TEMPLATE_INPUTS,
   MAX_TEMPLATE_INPUTS_APP_LENGTH,
   MAX_TEMPLATE_INPUTS_SEEN,
@@ -6680,6 +6780,7 @@ function matchRoute(method, pathname) {
   MAX_TEMPLATE_TRANSLATIONS,
   MAX_TRIGGERS,
   MEMBER_ROLES,
+  MEMBER_SOURCES,
   MERGE_FIELD_PATTERN,
   MESSAGE_OUTCOMES,
   MIN_SPLIT_BRANCHES,
@@ -6715,8 +6816,11 @@ function matchRoute(method, pathname) {
   MailingTestResult,
   MailingUpdate,
   Member,
+  MemberCompanySync,
+  MemberCompanySyncResult,
   MemberCreate,
   MemberRole,
+  MemberSource,
   MemberUpdate,
   MergeDefaultValue,
   MergeDefaults,
@@ -6924,6 +7028,7 @@ function matchRoute(method, pathname) {
   billingRoutes,
   buildPath,
   buildTemplatePatch,
+  canDeleteMailing,
   canTransition,
   canonicalLocale,
   choiceKeyProblem,

package/dist/index.mjs

@@ -1195,6 +1195,10 @@ var Mailing = z8.object({
   updated_at: Timestamp
 });
 var MailingSummary = Mailing.omit({ document: true });
+function canDeleteMailing(mailing) {
+  if (mailing.kind !== "broadcast") return false;
+  return mailing.status === "draft" || mailing.status === "cancelled" && mailing.started_at === null;
+}
 var MailingContent = {
   name: z8.string().max(200).optional(),
   subject: z8.string().min(1).max(998),
@@ -2843,12 +2847,13 @@ var WorkspaceCreate = z11.object({
     name: z11.string().max(200).nullable().optional()
   }),
   /**
-   * The signed-in person's active auth-brain company. The dashboard always
-   * sends it, which is what links the workspace to auth-brain's company
-   * erasure; omitted, the workspace belongs to no company and no company
-   * erasure reaches it.
+   * The auth-brain company the workspace is created in. Required since 0.14.0:
+   * every new workspace belongs to a company, which is what links it to that
+   * company's erasure and lets the company's owners and admins in without an
+   * invitation (`members.syncCompanyRole`). A workspace created before, without
+   * one, keeps working and simply has no such inheritance.
    */
-  company_id: CompanyId.optional()
+  company_id: CompanyId
 });
 var WorkspaceUpdate = z11.object({
   name: z11.string().min(1).max(120),
@@ -2858,14 +2863,58 @@ var WorkspaceMove = z11.object({ company_id: CompanyId });
 var MEMBER_ROLES = ["owner", "admin", "editor", "viewer"];
 var MemberRole = z11.enum(MEMBER_ROLES);
 var WorkspaceMembership = Workspace.extend({ role: MemberRole });
+var MEMBER_SOURCES = ["invited", "company"];
+var MemberSource = z11.enum(MEMBER_SOURCES);
+var COMPANY_GRANT_ROLES = ["owner", "admin"];
+var CompanyGrantRole = z11.enum(COMPANY_GRANT_ROLES);
+var COMPANY_ROLE_MAX_AGE_HOURS = 24;
 var Member = z11.object({
   id: Id,
   /** The person's auth-brain subject. */
   subject: z11.string().min(1).max(255),
   email: Email,
   name: z11.string().max(200).nullable(),
+  /**
+   * The role in force: the higher of the person's own role in the workspace
+   * and the one a confirmed company role carries. For a `company` row that is
+   * no longer confirmed, the role it would carry once confirmed again.
+   */
   role: MemberRole,
-  created_at: Timestamp
+  created_at: Timestamp,
+  /*
+   * The five fields below exist since 0.14.0 and are optional only so that a
+   * client built against this contract can still read a service that predates
+   * them: absent means an ordinary, invited member.
+   */
+  source: MemberSource.optional(),
+  /** The company role last reported for the person (`members.syncCompanyRole`), or null. */
+  company_role: CompanyGrantRole.nullable().optional(),
+  /** When the dashboard last confirmed `company_role`; null without one. */
+  company_checked_at: Timestamp.nullable().optional(),
+  /** The person's own role in the workspace; null for a `company` row. */
+  direct_role: MemberRole.nullable().optional(),
+  /**
+   * True while `role` is held only through a confirmed company role. Such a
+   * member cannot be changed or removed here (`inherited_from_company`): the
+   * role is managed in the shared login. A `company` row with `inherited`
+   * false is one whose company role has not been confirmed within
+   * `COMPANY_ROLE_MAX_AGE_HOURS`; it grants nothing and an admin may remove it.
+   */
+  inherited: z11.boolean().optional()
+});
+var MAX_SYNC_COMPANIES = 100;
+var MemberCompanySync = z11.object({
+  email: Email,
+  name: z11.string().max(200).nullable().optional(),
+  companies: z11.array(z11.object({ company_id: CompanyId, role: CompanyGrantRole })).max(MAX_SYNC_COMPANIES).refine((list2) => new Set(list2.map((c) => c.company_id)).size === list2.length, "each company at most once")
+});
+var MemberCompanySyncResult = z11.object({
+  /** Workspaces in which the person now holds a company role they did not hold, or held differently, before this call. */
+  granted: z11.array(Id),
+  /** Workspaces in which a company role was taken away by this call. */
+  revoked: z11.array(Id),
+  /** Workspaces in which the person's company role was already as stated. */
+  unchanged: z11.array(Id)
 });
 var MemberCreate = z11.object({
   subject: z11.string().min(1).max(255),
@@ -2933,6 +2982,7 @@ var AUDIT_ACTIONS = [
   "mailing.paused",
   "mailing.resumed",
   "mailing.cancelled",
+  "mailing.deleted",
   "mailing.retried",
   "webhook.created",
   "webhook.updated",
@@ -4473,6 +4523,24 @@ var foundationRoutes = {
     access: "admin",
     phase: "S0"
   },
+  /**
+   * The dashboard states the signed-in person's owner and admin roles in
+   * companies, and the service brings the member lists in line (see
+   * `MemberCompanySync`). `dashboard` access: the dashboard's service token
+   * and the person's subject, no workspace. An API key is refused, and so is
+   * every trusted application: it is not in any `TRUSTED_APP_OPERATIONS` list
+   * and the handler refuses an application once more by itself.
+   */
+  "members.syncCompanyRole": {
+    method: "POST",
+    path: "/v1/members/company-sync",
+    body: MemberCompanySync,
+    response: MemberCompanySyncResult,
+    status: 200,
+    access: "dashboard",
+    phase: "S0",
+    statement: true
+  },
   "apiKeys.list": {
     method: "GET",
     path: "/v1/api-keys",
@@ -5044,6 +5112,25 @@ var sendingRoutes = {
     access: "write",
     phase: "S2"
   },
+  /**
+   * Deletes a mailing that never started: a broadcast in `draft`, or one
+   * `cancelled` before any send began (`canDeleteMailing`). Its recipients,
+   * A/B variants and compiled content go with it. Test sends made from it stay
+   * in the archive, with `mailing_id` null: they are mail that really went out.
+   * Anything else is `mailing_invalid_state` (409): a scheduled mailing is
+   * unscheduled first, and a mailing that started is the record of what was
+   * sent. An automation's mailing is `conflict`; a transactional letter is
+   * deleted only by a key that may write one (`forbidden`).
+   */
+  "mailings.delete": {
+    method: "DELETE",
+    path: "/v1/mailings/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "write",
+    phase: "S2"
+  },
   "mailings.retryFailed": {
     method: "POST",
     path: "/v1/mailings/:id/retry-failed",
@@ -5776,7 +5863,7 @@ function trustedAppMayCall(app, id) {
   return TRUSTED_APP_OPERATIONS[app].includes(id);
 }
 function acceptsIdempotencyKey(route) {
-  return route.method !== "GET";
+  return route.method !== "GET" && route.statement !== true;
 }
 function buildPath(path, params = {}) {
   return path.replace(/:([a-z_]+)/g, (_, name) => {
@@ -5896,10 +5983,13 @@ export {
   BILLING_NOT_CONFIGURED_REASON,
   BoundedAutomationFilter,
   BoundedSegmentFilter,
+  COMPANY_GRANT_ROLES,
+  COMPANY_ROLE_MAX_AGE_HOURS,
   CONTACT_PROPERTY_TYPES,
   CatalogPlan,
   CheckoutRequest,
   CheckoutSession,
+  CompanyGrantRole,
   CompanyId,
   CompileMessage,
   CompileRequest,
@@ -6038,6 +6128,7 @@ export {
   MAX_STEPS,
   MAX_STEP_VISITS,
   MAX_SUBJECT_LENGTH,
+  MAX_SYNC_COMPANIES,
   MAX_TEMPLATE_INPUTS,
   MAX_TEMPLATE_INPUTS_APP_LENGTH,
   MAX_TEMPLATE_INPUTS_SEEN,
@@ -6048,6 +6139,7 @@ export {
   MAX_TEMPLATE_TRANSLATIONS,
   MAX_TRIGGERS,
   MEMBER_ROLES,
+  MEMBER_SOURCES,
   MERGE_FIELD_PATTERN,
   MESSAGE_OUTCOMES,
   MIN_SPLIT_BRANCHES,
@@ -6083,8 +6175,11 @@ export {
   MailingTestResult,
   MailingUpdate,
   Member,
+  MemberCompanySync,
+  MemberCompanySyncResult,
   MemberCreate,
   MemberRole,
+  MemberSource,
   MemberUpdate,
   MergeDefaultValue,
   MergeDefaults,
@@ -6292,6 +6387,7 @@ export {
   billingRoutes,
   buildPath,
   buildTemplatePatch,
+  canDeleteMailing,
   canTransition,
   canonicalLocale,
   choiceKeyProblem,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "The v1 API contract of the mail service: zod schemas and types for every request, response, error and webhook, the route table, and webhook signing helpers",
   "license": "MIT",
   "repository": {