agentmail 0.5.50 → 0.5.51

package/dist/cjs/api/resources/forwarding/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForwardingClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "ForwardingClient", { enumerable: true, get: function () { return Client_js_1.ForwardingClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/forwarding/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client/index.js";
+export * from "./errors/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/forwarding/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./errors/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/forwarding/types/ConfirmForwardingVerificationRequest.d.ts

@@ -0,0 +1,10 @@
+import type * as AgentMail from "../../../index.js";
+export interface ConfirmForwardingVerificationRequest {
+    /** Address the code was sent to. */
+    destination: AgentMail.ForwardingDestination;
+    /**
+     * The 10-character code from the email, shown as `XXXXX-XXXXX`. Case, spaces and the dash are
+     * ignored.
+     */
+    code: string;
+}

package/dist/cjs/api/resources/forwarding/types/ConfirmForwardingVerificationRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/Forwarding.d.ts

@@ -0,0 +1,15 @@
+import type * as AgentMail from "../../../index.js";
+export interface Forwarding {
+    /**
+     * Addresses this level forwards to. `null` when the level sets nothing and uses the forwarding
+     * of the level above. An empty list means forwarding is turned off at this level, even when a
+     * level above forwards.
+     */
+    destinations: AgentMail.ForwardingDestination[] | null;
+    /**
+     * Addresses in `destinations` that receive nothing yet because they are not verified, or because
+     * the address now reaches a different AgentMail inbox than the one it was verified for. Verify
+     * them with Start Verification and Confirm Verification. Empty when `destinations` is `null`.
+     */
+    unverified: AgentMail.ForwardingDestination[];
+}

package/dist/cjs/api/resources/forwarding/types/Forwarding.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/ForwardingDestination.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Email address that receives a copy of each email. Stored trimmed and lowercased, at most 320
+ * characters.
+ */
+export type ForwardingDestination = string;

package/dist/cjs/api/resources/forwarding/types/ForwardingDestination.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/ForwardingVerificationConfirmed.d.ts

@@ -0,0 +1,4 @@
+export interface ForwardingVerificationConfirmed {
+    /** Time at which the address was verified. */
+    verifiedAt: Date;
+}

package/dist/cjs/api/resources/forwarding/types/ForwardingVerificationConfirmed.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/ForwardingVerificationStarted.d.ts

@@ -0,0 +1,4 @@
+export interface ForwardingVerificationStarted {
+    /** Time at which the emailed code stops working, 24 hours after it was sent. */
+    expiresAt: Date;
+}

package/dist/cjs/api/resources/forwarding/types/ForwardingVerificationStarted.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/StartForwardingVerificationRequest.d.ts

@@ -0,0 +1,5 @@
+import type * as AgentMail from "../../../index.js";
+export interface StartForwardingVerificationRequest {
+    /** Address to verify. AgentMail emails it a confirmation code. */
+    destination: AgentMail.ForwardingDestination;
+}

package/dist/cjs/api/resources/forwarding/types/StartForwardingVerificationRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/UpdateForwardingRequest.d.ts

@@ -0,0 +1,9 @@
+import type * as AgentMail from "../../../index.js";
+export interface UpdateForwardingRequest {
+    /**
+     * The full list of addresses this level forwards to. It replaces the level's current list. At
+     * most 5, with no repeats. Send an empty list to turn forwarding off at this level, even when a
+     * level above forwards.
+     */
+    destinations: AgentMail.ForwardingDestination[];
+}

package/dist/cjs/api/resources/forwarding/types/UpdateForwardingRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/UpdateForwardingResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../index.js";
+export interface UpdateForwardingResponse {
+    /**
+     * The list now set on this level. It does not say which addresses are verified; Get Forwarding
+     * does.
+     */
+    destinations: AgentMail.ForwardingDestination[];
+}

package/dist/cjs/api/resources/forwarding/types/UpdateForwardingResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/forwarding/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./ConfirmForwardingVerificationRequest.js";
+export * from "./Forwarding.js";
+export * from "./ForwardingDestination.js";
+export * from "./ForwardingVerificationConfirmed.js";
+export * from "./ForwardingVerificationStarted.js";
+export * from "./StartForwardingVerificationRequest.js";
+export * from "./UpdateForwardingRequest.js";
+export * from "./UpdateForwardingResponse.js";

package/dist/cjs/api/resources/forwarding/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ConfirmForwardingVerificationRequest.js"), exports);
+__exportStar(require("./Forwarding.js"), exports);
+__exportStar(require("./ForwardingDestination.js"), exports);
+__exportStar(require("./ForwardingVerificationConfirmed.js"), exports);
+__exportStar(require("./ForwardingVerificationStarted.js"), exports);
+__exportStar(require("./StartForwardingVerificationRequest.js"), exports);
+__exportStar(require("./UpdateForwardingRequest.js"), exports);
+__exportStar(require("./UpdateForwardingResponse.js"), exports);

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

@@ -8,6 +8,7 @@ import { CalendarClient } from "../resources/calendar/client/Client.js";
 import { DraftsClient } from "../resources/drafts/client/Client.js";
 import { EventsClient } from "../resources/events/client/Client.js";
 import { FilesClient } from "../resources/files/client/Client.js";
+import { ForwardingClient } from "../resources/forwarding/client/Client.js";
 import { ListsClient } from "../resources/lists/client/Client.js";
 import { MessagesClient } from "../resources/messages/client/Client.js";
 import { MetricsClient } from "../resources/metrics/client/Client.js";
@@ -25,6 +26,7 @@ export declare class InboxesClient {
     protected _drafts: DraftsClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     protected _lists: ListsClient | undefined;
+    protected _forwarding: ForwardingClient | undefined;
     protected _metrics: MetricsClient | undefined;
     protected _events: EventsClient | undefined;
     protected _apiKeys: ApiKeysClient | undefined;
@@ -37,6 +39,7 @@ export declare class InboxesClient {
     get drafts(): DraftsClient;
     get webhooks(): WebhooksClient;
     get lists(): ListsClient;
+    get forwarding(): ForwardingClient;
     get metrics(): MetricsClient;
     get events(): EventsClient;
     get apiKeys(): ApiKeysClient;
@@ -134,6 +137,8 @@ export declare class InboxesClient {
     update(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
     private __update;
     /**
+     * Deletion is asynchronous. A `202` means it has started. While it runs, requests for this inbox return `409` `resource_deleting`. Poll `GET /v0/inboxes/{inbox_id}` until it returns `404`, then the address is free. If the inbox still has its own API keys, delete returns `409` `cannot_delete`: revoke those keys first.
+     *
      * **CLI:**
      * ```bash
      * agentmail inboxes delete --inbox-id <inbox_id>
@@ -143,9 +148,10 @@ export declare class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ConflictError}
      *
      * @example
-     *     await client.inboxes.delete("inbox_id")
+     *     await client.inboxes.delete("my-agent@agentmail.to")
      */
     delete(inbox_id: AgentMail.inboxes.InboxId, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;

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

@@ -58,22 +58,23 @@ const Client_js_3 = require("../resources/calendar/client/Client.js");
 const Client_js_4 = require("../resources/drafts/client/Client.js");
 const Client_js_5 = require("../resources/events/client/Client.js");
 const Client_js_6 = require("../resources/files/client/Client.js");
-const Client_js_7 = require("../resources/lists/client/Client.js");
-const Client_js_8 = require("../resources/messages/client/Client.js");
-const Client_js_9 = require("../resources/metrics/client/Client.js");
-const Client_js_10 = require("../resources/threads/client/Client.js");
-const Client_js_11 = require("../resources/webhooks/client/Client.js");
+const Client_js_7 = require("../resources/forwarding/client/Client.js");
+const Client_js_8 = require("../resources/lists/client/Client.js");
+const Client_js_9 = require("../resources/messages/client/Client.js");
+const Client_js_10 = require("../resources/metrics/client/Client.js");
+const Client_js_11 = require("../resources/threads/client/Client.js");
+const Client_js_12 = require("../resources/webhooks/client/Client.js");
 class InboxesClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     get threads() {
         var _a;
-        return ((_a = this._threads) !== null && _a !== void 0 ? _a : (this._threads = new Client_js_10.ThreadsClient(this._options)));
+        return ((_a = this._threads) !== null && _a !== void 0 ? _a : (this._threads = new Client_js_11.ThreadsClient(this._options)));
     }
     get messages() {
         var _a;
-        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_8.MessagesClient(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_9.MessagesClient(this._options)));
     }
     get drafts() {
         var _a;
@@ -81,15 +82,19 @@ class InboxesClient {
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_11.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_12.WebhooksClient(this._options)));
     }
     get lists() {
         var _a;
-        return ((_a = this._lists) !== null && _a !== void 0 ? _a : (this._lists = new Client_js_7.ListsClient(this._options)));
+        return ((_a = this._lists) !== null && _a !== void 0 ? _a : (this._lists = new Client_js_8.ListsClient(this._options)));
+    }
+    get forwarding() {
+        var _a;
+        return ((_a = this._forwarding) !== null && _a !== void 0 ? _a : (this._forwarding = new Client_js_7.ForwardingClient(this._options)));
     }
     get metrics() {
         var _a;
-        return ((_a = this._metrics) !== null && _a !== void 0 ? _a : (this._metrics = new Client_js_9.MetricsClient(this._options)));
+        return ((_a = this._metrics) !== null && _a !== void 0 ? _a : (this._metrics = new Client_js_10.MetricsClient(this._options)));
     }
     get events() {
         var _a;
@@ -494,6 +499,8 @@ class InboxesClient {
         });
     }
     /**
+     * Deletion is asynchronous. A `202` means it has started. While it runs, requests for this inbox return `409` `resource_deleting`. Poll `GET /v0/inboxes/{inbox_id}` until it returns `404`, then the address is free. If the inbox still has its own API keys, delete returns `409` `cannot_delete`: revoke those keys first.
+     *
      * **CLI:**
      * ```bash
      * agentmail inboxes delete --inbox-id <inbox_id>
@@ -503,9 +510,10 @@ class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ConflictError}
      *
      * @example
-     *     await client.inboxes.delete("inbox_id")
+     *     await client.inboxes.delete("my-agent@agentmail.to")
      */
     delete(inbox_id, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__delete(inbox_id, requestOptions));
@@ -540,6 +548,14 @@ class InboxesClient {
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }), _response.rawResponse);
+                    case 409:
+                        throw new AgentMail.ConflictError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     default:
                         throw new errors.AgentMailError({
                             statusCode: _response.error.statusCode,

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

@@ -0,0 +1,79 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as AgentMail from "../../../../../index.js";
+export declare namespace ForwardingClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ForwardingClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ForwardingClient.Options>;
+    constructor(options?: ForwardingClient.Options);
+    /**
+     * Get the forwarding this inbox sets. When the inbox sets nothing, `destinations` is `null` and
+     * the inbox uses its pod's forwarding, or the organization's when the pod sets none.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes forwarding get --inbox-id <inbox_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {ForwardingClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ForwardingForbiddenError}
+     *
+     * @example
+     *     await client.inboxes.forwarding.get("inbox_id")
+     */
+    get(inbox_id: AgentMail.inboxes.InboxId, requestOptions?: ForwardingClient.RequestOptions): core.HttpResponsePromise<AgentMail.Forwarding>;
+    private __get;
+    /**
+     * Set the addresses this inbox forwards to. The list replaces the inbox's current one and any pod
+     * or organization list for this inbox; lists are never combined. Send an empty list to stop this
+     * inbox forwarding even when its pod or the organization forwards. An address that is not
+     * verified is saved but receives nothing until it is verified.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes forwarding update --inbox-id <inbox_id> --destinations ops@example.com
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.UpdateForwardingRequest} request
+     * @param {ForwardingClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ForwardingForbiddenError}
+     *
+     * @example
+     *     await client.inboxes.forwarding.update("inbox_id", {
+     *         destinations: ["destinations", "destinations"]
+     *     })
+     */
+    update(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.UpdateForwardingRequest, requestOptions?: ForwardingClient.RequestOptions): core.HttpResponsePromise<AgentMail.UpdateForwardingResponse>;
+    private __update;
+    /**
+     * Remove this inbox's own forwarding, so the inbox uses its pod's or the organization's forwarding
+     * again. Verified addresses stay verified. Returns `not_found` when the inbox sets no forwarding.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes forwarding delete --inbox-id <inbox_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {ForwardingClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ForwardingForbiddenError}
+     *
+     * @example
+     *     await client.inboxes.forwarding.delete("inbox_id")
+     */
+    delete(inbox_id: AgentMail.inboxes.InboxId, requestOptions?: ForwardingClient.RequestOptions): core.HttpResponsePromise<AgentMail.Forwarding>;
+    private __delete;
+}