agentmail 0.4.15 → 0.4.16

package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class DraftsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<DraftsClient.Options>;
     constructor(options?: DraftsClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListDraftsRequest} request
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class DraftsClient {
     list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListDraftsRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDraftsResponse>;
     private __list;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class DraftsClient {
     get(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
     private __get;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -48,6 +63,11 @@ export declare class DraftsClient {
     getAttachment(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, attachment_id: AgentMail.AttachmentId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.AttachmentResponse>;
     private __getAttachment;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.CreateDraftRequest} request
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,6 +80,11 @@ export declare class DraftsClient {
     create(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.CreateDraftRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
     private __create;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.UpdateDraftRequest} request
@@ -73,6 +98,11 @@ export declare class DraftsClient {
     update(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, request: AgentMail.UpdateDraftRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
     private __update;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,6 +115,11 @@ export declare class DraftsClient {
     delete(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.UpdateMessageRequest} request

package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js

@@ -58,6 +58,11 @@ class DraftsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListDraftsRequest} request
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -139,6 +144,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -202,6 +212,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -266,6 +281,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.CreateDraftRequest} request
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -335,6 +355,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.UpdateDraftRequest} request
@@ -405,6 +430,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -459,6 +489,11 @@ class DraftsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.DraftId} draft_id
      * @param {AgentMail.UpdateMessageRequest} request

package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class ListsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ListsClient.Options>;
     constructor(options?: ListsClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -23,6 +28,11 @@ export declare class ListsClient {
     list(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, request?: AgentMail.inboxes.InboxListListEntriesRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListListEntriesResponse>;
     private __list;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -37,6 +47,11 @@ export declare class ListsClient {
     get(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, entry: string, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListEntry>;
     private __get;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -53,6 +68,11 @@ export declare class ListsClient {
     create(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, request: AgentMail.CreateListEntryRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListEntry>;
     private __create;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type

package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js

@@ -57,6 +57,11 @@ class ListsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -114,6 +119,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -179,6 +189,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
@@ -252,6 +267,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type

package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class MessagesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<MessagesClient.Options>;
     constructor(options?: MessagesClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListMessagesRequest} request
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class MessagesClient {
     list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListMessagesRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListMessagesResponse>;
     private __list;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class MessagesClient {
     get(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.Message>;
     private __get;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -48,6 +63,11 @@ export declare class MessagesClient {
     getAttachment(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, attachment_id: AgentMail.AttachmentId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.AttachmentResponse>;
     private __getAttachment;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,6 +80,11 @@ export declare class MessagesClient {
     getRaw(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.RawMessageResponse>;
     private __getRaw;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.UpdateMessageRequest} request
@@ -74,6 +99,11 @@ export declare class MessagesClient {
     update(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.UpdateMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.UpdateMessageResponse>;
     private __update;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.SendMessageRequest} request
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -88,6 +118,11 @@ export declare class MessagesClient {
     send(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.SendMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
     private __send;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.ReplyToMessageRequest} request
@@ -103,6 +138,11 @@ export declare class MessagesClient {
     reply(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.ReplyToMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
     private __reply;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.ReplyAllMessageRequest} request
@@ -118,6 +158,11 @@ export declare class MessagesClient {
     replyAll(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.ReplyAllMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
     private __replyAll;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.SendMessageRequest} request

package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js

@@ -58,6 +58,11 @@ class MessagesClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListMessagesRequest} request
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -142,6 +147,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -205,6 +215,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -269,6 +284,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -332,6 +352,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.UpdateMessageRequest} request
@@ -411,6 +436,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.SendMessageRequest} request
      * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -498,6 +528,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.ReplyToMessageRequest} request
@@ -586,6 +621,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.ReplyAllMessageRequest} request
@@ -674,6 +714,11 @@ class MessagesClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.MessageId} message_id
      * @param {AgentMail.SendMessageRequest} request

package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class MetricsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<MetricsClient.Options>;
     constructor(options?: MetricsClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:metrics query --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.QueryMetricsRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js

@@ -58,6 +58,11 @@ class MetricsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:metrics query --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.QueryMetricsRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class ThreadsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ThreadsClient.Options>;
     constructor(options?: ThreadsClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class ThreadsClient {
     list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListThreadsResponse>;
     private __list;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class ThreadsClient {
     get(inbox_id: AgentMail.inboxes.InboxId, thread_id: AgentMail.ThreadId, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Thread>;
     private __get;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -67,6 +82,11 @@ export declare class ThreadsClient {
     /**
      * Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
      *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {AgentMail.inboxes.DeleteThreadRequest} request

package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js

@@ -58,6 +58,11 @@ class ThreadsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads list --inbox-id <inbox_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.inboxes.ListThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -142,6 +147,11 @@ class ThreadsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -205,6 +215,11 @@ class ThreadsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {AgentMail.AttachmentId} attachment_id
@@ -361,6 +376,11 @@ class ThreadsClient {
     /**
      * Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
      *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
+     * ```
+     *
      * @param {AgentMail.inboxes.InboxId} inbox_id
      * @param {AgentMail.ThreadId} thread_id
      * @param {AgentMail.inboxes.DeleteThreadRequest} request

package/dist/cjs/api/resources/lists/client/Client.d.ts

@@ -11,6 +11,11 @@ export declare class ListsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ListsClient.Options>;
     constructor(options?: ListsClient.Options);
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists list --direction <direction> --type <type>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {AgentMail.ListListEntriesRequest} request
@@ -22,6 +27,11 @@ export declare class ListsClient {
     list(direction: AgentMail.Direction, type: AgentMail.ListType, request?: AgentMail.ListListEntriesRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListListEntriesResponse>;
     private __list;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {string} entry - Email address or domain.
@@ -35,6 +45,11 @@ export declare class ListsClient {
     get(direction: AgentMail.Direction, type: AgentMail.ListType, entry: string, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListEntry>;
     private __get;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists create --direction <direction> --type <type> --entry user@example.com
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {AgentMail.CreateListEntryRequest} request
@@ -50,6 +65,11 @@ export declare class ListsClient {
     create(direction: AgentMail.Direction, type: AgentMail.ListType, request: AgentMail.CreateListEntryRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListEntry>;
     private __create;
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists delete --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {string} entry - Email address or domain.

package/dist/cjs/api/resources/lists/client/Client.js

@@ -57,6 +57,11 @@ class ListsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists list --direction <direction> --type <type>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {AgentMail.ListListEntriesRequest} request
@@ -113,6 +118,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {string} entry - Email address or domain.
@@ -177,6 +187,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists create --direction <direction> --type <type> --entry user@example.com
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {AgentMail.CreateListEntryRequest} request
@@ -249,6 +264,11 @@ class ListsClient {
         });
     }
     /**
+     * **CLI:**
+     * ```bash
+     * agentmail lists delete --direction <direction> --type <type> --entry <entry>
+     * ```
+     *
      * @param {AgentMail.Direction} direction
      * @param {AgentMail.ListType} type
      * @param {string} entry - Email address or domain.