carlyemail 0.6.4 → 0.6.6

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.4";
+export const VERSION = "0.6.6";
 
 const DEFAULT_API = "https://api.carlyemail.com";
 const CONFIG_DIR = join(homedir(), ".carlyemail");

package/package.json

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

package/sdk.d.ts

@@ -1,5 +1,13 @@
 // Generated by scripts/build_sdk.py from the OpenAPI spec. Do not edit.
 
+export interface Actor {
+  type: string;
+  member_id?: string | null;
+  api_key_id?: string | null;
+  name?: string | null;
+  email?: string | null;
+}
+
 export interface AgentSigninRequest {
   human_email: string;
 }
@@ -11,6 +19,7 @@ export interface AgentSigninResponse {
 export interface AgentSigninVerifyRequest {
   human_email: string;
   otp_code: string;
+  organization_id?: string | null;
 }
 
 export interface AgentSigninVerifyResponse {
@@ -18,6 +27,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 {
@@ -161,6 +172,10 @@ export interface CreateListEntryRequest {
   reason?: string | null;
 }
 
+export interface CreateNoteRequest {
+  text: string;
+}
+
 export interface CreatePodRequest {
   name?: string | null;
   client_id?: string | null;
@@ -188,6 +203,14 @@ export interface DomainOut {
   created_at: string;
 }
 
+export interface DraftInProgress {
+  draft_id: string;
+  created_by?: Actor | null;
+  updated_by?: Actor | null;
+  send_at?: string | null;
+  updated_at: string;
+}
+
 export interface DraftOut {
   inbox_id: string;
   draft_id: string;
@@ -207,6 +230,8 @@ export interface DraftOut {
   references?: Array<string>;
   send_status?: string | null;
   send_at?: string | null;
+  created_by?: Actor | null;
+  updated_by?: Actor | null;
   updated_at: string;
   created_at: string;
 }
@@ -255,6 +280,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 {
@@ -265,6 +292,7 @@ export interface InboxEventOut {
   event_type: "label.added" | "label.removed";
   message_id?: string | null;
   label?: string | null;
+  actor?: Actor | null;
   event_at: string;
   created_at: string;
 }
@@ -280,6 +308,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 +376,11 @@ export interface ListListEntriesResponse {
   entries: Array<ListEntryOut>;
 }
 
+export interface ListMembersResponse {
+  count: number;
+  members: Array<MemberOut>;
+}
+
 export interface ListMessagesResponse {
   count: number;
   limit?: number | null;
@@ -348,6 +388,11 @@ export interface ListMessagesResponse {
   messages: Array<MessageItem>;
 }
 
+export interface ListNotesResponse {
+  count: number;
+  notes: Array<NoteOut>;
+}
+
 export interface ListPodsResponse {
   count: number;
   limit?: number | null;
@@ -374,6 +419,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;
@@ -389,6 +446,7 @@ export interface MessageItem {
   preview?: string | null;
   attachments?: Array<AttachmentOut>;
   size?: number;
+  sent_by?: Actor | null;
   updated_at: string;
   created_at: string;
 }
@@ -408,6 +466,7 @@ export interface MessageOut {
   preview?: string | null;
   attachments?: Array<AttachmentOut>;
   size?: number;
+  sent_by?: Actor | null;
   updated_at: string;
   created_at: string;
   text?: string | null;
@@ -420,17 +479,37 @@ export interface MessageOut {
   authentication?: Record<string, string>;
 }
 
+export interface NoteOut {
+  note_id: string;
+  thread_id: string;
+  inbox_id: string;
+  text: string;
+  author?: Actor | null;
+  created_at: 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 +589,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;
@@ -525,6 +614,7 @@ export interface ThreadItem {
   last_message_id?: string | null;
   message_count?: number;
   size?: number;
+  assignee?: Actor | null;
   updated_at: string;
   created_at: string;
 }
@@ -544,9 +634,12 @@ export interface ThreadOut {
   last_message_id?: string | null;
   message_count?: number;
   size?: number;
+  assignee?: Actor | null;
   updated_at: string;
   created_at: string;
   messages?: Array<MessageOut>;
+  notes?: Array<NoteOut>;
+  drafts?: Array<DraftInProgress>;
 }
 
 export interface UpdateDomainRequest {
@@ -579,6 +672,12 @@ export interface UpdateInboxWebhookRequest {
   enabled?: boolean | null;
 }
 
+export interface UpdateMemberRequest {
+  role?: string | null;
+  inbox_ids?: Array<string> | null;
+  name?: string | null;
+}
+
 export interface UpdateMessageRequest {
   add_labels?: Array<string> | null;
   remove_labels?: Array<string> | null;
@@ -592,11 +691,13 @@ export interface UpdateMessageResponse {
 export interface UpdateThreadRequest {
   add_labels?: Array<string> | null;
   remove_labels?: Array<string> | null;
+  assignee_id?: string | null;
 }
 
 export interface UpdateThreadResponse {
   thread_id: string;
   labels: Array<string>;
+  assignee?: Actor | null;
 }
 
 export interface UpdateWebhookHeadersRequest {
@@ -685,6 +786,7 @@ export declare class Agent {
 
 export declare class Auth {
   whoami(): Promise<Identity>;
+  switchOrganization(body: SwitchRequest): Promise<SwitchResponse>;
 }
 
 export declare class Billing {
@@ -722,13 +824,16 @@ export declare class Messages {
 }
 
 export declare class Threads {
-  list(inboxId: string, query?: { limit?: number | null; pageToken?: string | null; labels?: Array<string> | null; before?: string | null; after?: string | null; ascending?: boolean; senders?: Array<string> | null; recipients?: Array<string> | null; subject?: string | null }): Promise<ListThreadsResponse>;
+  list(inboxId: string, query?: { limit?: number | null; pageToken?: string | null; labels?: Array<string> | null; before?: string | null; after?: string | null; ascending?: boolean; senders?: Array<string> | null; recipients?: Array<string> | null; subject?: string | null; assignee?: string | null }): Promise<ListThreadsResponse>;
   search(inboxId: string, query?: { q?: string; limit?: number | null; pageToken?: string | null; before?: string | null; after?: string | null }): Promise<ListThreadsResponse>;
   getAttachment(inboxId: string, threadId: string, attachmentId: string): Promise<AttachmentResponse>;
   get(inboxId: string, threadId: string): Promise<ThreadOut>;
   update(inboxId: string, threadId: string, body: UpdateThreadRequest): Promise<UpdateThreadResponse>;
   delete(inboxId: string, threadId: string): Promise<void>;
-  listOrg(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>;
+  listNotes(inboxId: string, threadId: string): Promise<ListNotesResponse>;
+  addNote(inboxId: string, threadId: string, body: CreateNoteRequest): Promise<NoteOut>;
+  deleteNote(inboxId: string, threadId: string, noteId: string): Promise<void>;
+  listOrg(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; assignee?: string | null }): Promise<ListThreadsResponse>;
   searchOrg(query?: { q?: string; limit?: number | null; pageToken?: string | null; before?: string | null; after?: string | null }): Promise<ListThreadsResponse>;
   getOrg(threadId: string): Promise<ThreadOut>;
   updateOrg(threadId: string, body: UpdateThreadRequest): Promise<UpdateThreadResponse>;
@@ -779,6 +884,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>;
 }
@@ -800,7 +913,7 @@ export declare class Pods {
   getInbox(inboxId: string, podId: string): Promise<InboxOut>;
   updateInbox(inboxId: string, podId: string, body: UpdateInboxRequest): Promise<InboxOut>;
   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>;
+  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; assignee?: 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>;
   updateThread(threadId: string, podId: string, body: UpdateThreadRequest): Promise<UpdateThreadResponse>;
@@ -874,6 +987,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 {
@@ -246,7 +251,7 @@ class Threads {
 
   /** List Threads */
   list(inboxId, query = {}) {
-    return this.$.request("GET", `/v0/inboxes/${encode(inboxId)}/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "senders": query.senders, "recipients": query.recipients, "subject": query.subject } });
+    return this.$.request("GET", `/v0/inboxes/${encode(inboxId)}/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "senders": query.senders, "recipients": query.recipients, "subject": query.subject, "assignee": query.assignee } });
   }
 
   /** Search Threads */
@@ -274,9 +279,24 @@ class Threads {
     return this.$.request("DELETE", `/v0/inboxes/${encode(inboxId)}/threads/${encode(threadId)}`);
   }
 
+  /** List Notes */
+  listNotes(inboxId, threadId) {
+    return this.$.request("GET", `/v0/inboxes/${encode(inboxId)}/threads/${encode(threadId)}/notes`);
+  }
+
+  /** Add Note */
+  addNote(inboxId, threadId, body) {
+    return this.$.request("POST", `/v0/inboxes/${encode(inboxId)}/threads/${encode(threadId)}/notes`, { body });
+  }
+
+  /** Delete Note */
+  deleteNote(inboxId, threadId, noteId) {
+    return this.$.request("DELETE", `/v0/inboxes/${encode(inboxId)}/threads/${encode(threadId)}/notes/${encode(noteId)}`);
+  }
+
   /** List Threads */
   listOrg(query = {}) {
-    return this.$.request("GET", `/v0/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "include_spam": query.includeSpam, "include_blocked": query.includeBlocked, "include_unauthenticated": query.includeUnauthenticated, "include_trash": query.includeTrash, "senders": query.senders, "recipients": query.recipients, "subject": query.subject } });
+    return this.$.request("GET", `/v0/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "include_spam": query.includeSpam, "include_blocked": query.includeBlocked, "include_unauthenticated": query.includeUnauthenticated, "include_trash": query.includeTrash, "senders": query.senders, "recipients": query.recipients, "subject": query.subject, "assignee": query.assignee } });
   }
 
   /** Search Threads */
@@ -484,6 +504,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;
@@ -573,7 +624,7 @@ class Pods {
 
   /** List Threads */
   listThreads(podId, query = {}) {
-    return this.$.request("GET", `/v0/pods/${encode(podId)}/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "include_spam": query.includeSpam, "include_blocked": query.includeBlocked, "include_unauthenticated": query.includeUnauthenticated, "include_trash": query.includeTrash, "senders": query.senders, "recipients": query.recipients, "subject": query.subject } });
+    return this.$.request("GET", `/v0/pods/${encode(podId)}/threads`, { query: { "limit": query.limit, "page_token": query.pageToken, "labels": query.labels, "before": query.before, "after": query.after, "ascending": query.ascending, "include_spam": query.includeSpam, "include_blocked": query.includeBlocked, "include_unauthenticated": query.includeUnauthenticated, "include_trash": query.includeTrash, "senders": query.senders, "recipients": query.recipients, "subject": query.subject, "assignee": query.assignee } });
   }
 
   /** Search Threads */
@@ -854,6 +905,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);