carlyemail 0.6.3 → 0.6.5

package/carlyemail.js

@@ -18,7 +18,7 @@ import { basename, extname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { randomBytes } from "node:crypto";
 
-export const VERSION = "0.6.3";
+export const VERSION = "0.6.5";
 
 const DEFAULT_API = "https://api.carlyemail.com";
 const CONFIG_DIR = join(homedir(), ".carlyemail");
@@ -275,7 +275,7 @@ const FLAGS = {
   signin: ["human-email"],
   verify: ["code"],
   create: ["username", "domain", "display-name"],
-  delete: ["yes"],
+  delete: ["yes", "force"],
   send: ["from", "to", "cc", "bcc", "reply-to", "subject", "text", "html", "attach"],
   search: ["query"],
   reply: ["last", "text", "html", "all"],
@@ -524,7 +524,7 @@ define(
   }
 );
 
-define("delete", "Delete an inbox and its mail", "carlyemail delete support@carlyemail.com", async (ctx) => {
+define("delete", "Delete an inbox and its mail", "carlyemail delete support@carlyemail.com --yes", async (ctx) => {
   const inbox = ctx.positional[0];
   if (!inbox) throw new UsageError("which inbox? carlyemail delete <inbox>");
   if (!ctx.flags.yes) {
@@ -532,7 +532,19 @@ define("delete", "Delete an inbox and its mail", "carlyemail delete support@carl
       `this deletes ${inbox} and every message in it. Re-run with --yes to confirm.`
     );
   }
-  await request(ctx.config, "DELETE", `/v0/inboxes/${encodeURIComponent(inbox)}`);
+  // An inbox that sent mail or whose key was used in the last 30 days is
+  // refused with `inbox_in_use`, and the API's fix names its own parameter.
+  // Here the answer is a flag, so say that instead.
+  const force = ctx.flags.force === true;
+  const path = `/v0/inboxes/${encodeURIComponent(inbox)}${force ? "?force=true" : ""}`;
+  try {
+    await request(ctx.config, "DELETE", path);
+  } catch (error) {
+    if (error instanceof ApiError && error.code === "inbox_in_use") {
+      error.fix = "Check nothing still sends from it. To delete it anyway, re-run with --force.";
+    }
+    throw error;
+  }
   ctx.print(ok(`deleted ${inbox}`));
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carlyemail",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Real email inboxes your agent can send, receive and reply from. SDK and CLI.",
   "keywords": [
     "email",

package/sdk.d.ts

@@ -11,6 +11,7 @@ export interface AgentSigninResponse {
 export interface AgentSigninVerifyRequest {
   human_email: string;
   otp_code: string;
+  organization_id?: string | null;
 }
 
 export interface AgentSigninVerifyResponse {
@@ -18,6 +19,8 @@ export interface AgentSigninVerifyResponse {
   api_key: string;
   inbox_domain?: string | null;
   inboxes_on_signup_domain?: Array<string>;
+  member?: MemberOut | null;
+  organizations?: Array<OrganizationChoice>;
 }
 
 export interface AgentSignupRequest {
@@ -255,6 +258,8 @@ export interface Identity {
   pod_id?: string | null;
   inbox_id?: string | null;
   api_key_id?: string | null;
+  member?: MemberOut | null;
+  organizations?: Array<OrganizationChoice>;
 }
 
 export interface InboxEventOut {
@@ -280,6 +285,13 @@ export interface InboxOut {
   created_at: string;
 }
 
+export interface InviteMemberRequest {
+  email: string;
+  role?: string | null;
+  inbox_ids?: Array<string> | null;
+  name?: string | null;
+}
+
 export interface ListApiKeysResponse {
   count: number;
   next_page_token?: string | null;
@@ -341,6 +353,11 @@ export interface ListListEntriesResponse {
   entries: Array<ListEntryOut>;
 }
 
+export interface ListMembersResponse {
+  count: number;
+  members: Array<MemberOut>;
+}
+
 export interface ListMessagesResponse {
   count: number;
   limit?: number | null;
@@ -374,6 +391,18 @@ export interface ListWebhooksResponse {
   webhooks: Array<WebhookOut>;
 }
 
+export interface MemberOut {
+  member_id: string;
+  email: string;
+  name?: string | null;
+  role: string;
+  inbox_ids?: Array<string>;
+  status: string;
+  joined_at?: string | null;
+  last_signed_in_at?: string | null;
+  created_at?: string | null;
+}
+
 export interface MessageItem {
   inbox_id: string;
   thread_id: string;
@@ -420,17 +449,28 @@ export interface MessageOut {
   authentication?: Record<string, string>;
 }
 
+export interface OrganizationChoice {
+  organization_id: string;
+  name?: string | null;
+  role: string;
+  status: string;
+}
+
 export interface OrganizationOut {
   organization_id: string;
+  human_email?: string | null;
+  name?: string | null;
   inbox_count: number;
   domain_count: number;
   pod_count?: number;
   webhook_count?: number;
+  member_count?: number;
   storage_bytes?: number;
   inbox_limit?: number | null;
   domain_limit?: number | null;
   pod_limit?: number | null;
   webhook_limit?: number | null;
+  member_limit?: number | null;
   storage_limit_bytes?: number | null;
   plan?: string | null;
   billing_id?: string | null;
@@ -510,6 +550,16 @@ export interface SendMessageResponse {
   thread_id: string;
 }
 
+export interface SwitchRequest {
+  organization_id: string;
+}
+
+export interface SwitchResponse {
+  organization_id: string;
+  api_key: string;
+  member: MemberOut;
+}
+
 export interface ThreadItem {
   inbox_id: string;
   thread_id: string;
@@ -576,6 +626,13 @@ export interface UpdateInboxRequest {
 
 export interface UpdateInboxWebhookRequest {
   event_types?: Array<string> | null;
+  enabled?: boolean | null;
+}
+
+export interface UpdateMemberRequest {
+  role?: string | null;
+  inbox_ids?: Array<string> | null;
+  name?: string | null;
 }
 
 export interface UpdateMessageRequest {
@@ -605,6 +662,7 @@ export interface UpdateWebhookHeadersRequest {
 
 export interface UpdateWebhookRequest {
   event_types?: Array<string> | null;
+  enabled?: boolean | null;
   add_inbox_ids?: Array<string> | null;
   remove_inbox_ids?: Array<string> | null;
   add_pod_ids?: Array<string> | null;
@@ -652,6 +710,9 @@ export interface WebhookOut {
   inbox_ids?: Array<string>;
   secret?: string | null;
   enabled?: boolean;
+  disabled_reason?: string | null;
+  disabled_at?: string | null;
+  failing_since?: string | null;
   client_id?: string | null;
   updated_at: string;
   created_at: string;
@@ -680,6 +741,7 @@ export declare class Agent {
 
 export declare class Auth {
   whoami(): Promise<Identity>;
+  switchOrganization(body: SwitchRequest): Promise<SwitchResponse>;
 }
 
 export declare class Billing {
@@ -697,7 +759,7 @@ export declare class Inboxes {
   create(body: CreateInboxRequest): Promise<InboxOut>;
   get(inboxId: string): Promise<InboxOut>;
   update(inboxId: string, body: UpdateInboxRequest): Promise<InboxOut>;
-  delete(inboxId: string): Promise<void>;
+  delete(inboxId: string, query?: { force?: boolean }): Promise<void>;
 }
 
 export declare class Messages {
@@ -774,6 +836,14 @@ export declare class ApiKeys {
   deleteInbox(inboxId: string, apiKeyId: string): Promise<void>;
 }
 
+export declare class Members {
+  list(): Promise<ListMembersResponse>;
+  invite(body: InviteMemberRequest): Promise<MemberOut>;
+  get(memberId: string): Promise<MemberOut>;
+  update(memberId: string, body: UpdateMemberRequest): Promise<MemberOut>;
+  remove(memberId: string): Promise<void>;
+}
+
 export declare class Events {
   list(query?: { eventTypes?: Array<string> | null; inboxId?: string | null; start?: string | null; end?: string | null; limit?: number | null; pageToken?: string | null }): Promise<ListEventsResponse>;
 }
@@ -794,7 +864,7 @@ export declare class Pods {
   createInbox(podId: string, body: CreateInboxRequest): Promise<InboxOut>;
   getInbox(inboxId: string, podId: string): Promise<InboxOut>;
   updateInbox(inboxId: string, podId: string, body: UpdateInboxRequest): Promise<InboxOut>;
-  deleteInbox(inboxId: string, podId: string): Promise<void>;
+  deleteInbox(inboxId: string, podId: string, query?: { force?: boolean }): Promise<void>;
   listThreads(podId: string, query?: { limit?: number | null; pageToken?: string | null; labels?: Array<string> | null; before?: string | null; after?: string | null; ascending?: boolean; includeSpam?: boolean; includeBlocked?: boolean; includeUnauthenticated?: boolean; includeTrash?: boolean; senders?: Array<string> | null; recipients?: Array<string> | null; subject?: string | null }): Promise<ListThreadsResponse>;
   searchThreads(podId: string, query?: { q?: string; limit?: number | null; pageToken?: string | null; before?: string | null; after?: string | null }): Promise<ListThreadsResponse>;
   getThread(threadId: string, podId: string): Promise<ThreadOut>;
@@ -869,6 +939,7 @@ export declare class CarlyEmail {
   lists: Lists;
   domains: Domains;
   apiKeys: ApiKeys;
+  members: Members;
   events: Events;
   metrics: Metrics;
   pods: Pods;

package/sdk.js

@@ -103,6 +103,11 @@ class Auth {
   whoami() {
     return this.$.request("GET", `/v0/auth/me`);
   }
+
+  /** Switch Organization */
+  switchOrganization(body) {
+    return this.$.request("POST", `/v0/auth/switch`, { body });
+  }
 }
 
 class Billing {
@@ -163,8 +168,8 @@ class Inboxes {
   }
 
   /** Delete Inbox */
-  delete(inboxId) {
-    return this.$.request("DELETE", `/v0/inboxes/${encode(inboxId)}`);
+  delete(inboxId, query = {}) {
+    return this.$.request("DELETE", `/v0/inboxes/${encode(inboxId)}`, { query: { "force": query.force } });
   }
 }
 
@@ -484,6 +489,37 @@ class ApiKeys {
   }
 }
 
+class Members {
+  constructor(transport) {
+    this.$ = transport;
+  }
+
+  /** List Members */
+  list() {
+    return this.$.request("GET", `/v0/members`);
+  }
+
+  /** Invite Member */
+  invite(body) {
+    return this.$.request("POST", `/v0/members`, { body });
+  }
+
+  /** Get Member */
+  get(memberId) {
+    return this.$.request("GET", `/v0/members/${encode(memberId)}`);
+  }
+
+  /** Update Member */
+  update(memberId, body) {
+    return this.$.request("PATCH", `/v0/members/${encode(memberId)}`, { body });
+  }
+
+  /** Remove Member */
+  remove(memberId) {
+    return this.$.request("DELETE", `/v0/members/${encode(memberId)}`);
+  }
+}
+
 class Events {
   constructor(transport) {
     this.$ = transport;
@@ -567,8 +603,8 @@ class Pods {
   }
 
   /** Delete Inbox */
-  deleteInbox(inboxId, podId) {
-    return this.$.request("DELETE", `/v0/pods/${encode(podId)}/inboxes/${encode(inboxId)}`);
+  deleteInbox(inboxId, podId, query = {}) {
+    return this.$.request("DELETE", `/v0/pods/${encode(podId)}/inboxes/${encode(inboxId)}`, { query: { "force": query.force } });
   }
 
   /** List Threads */
@@ -854,6 +890,7 @@ export class CarlyEmail {
     this.lists = new Lists(transport);
     this.domains = new Domains(transport);
     this.apiKeys = new ApiKeys(transport);
+    this.members = new Members(transport);
     this.events = new Events(transport);
     this.metrics = new Metrics(transport);
     this.pods = new Pods(transport);