agentmail 0.5.50 → 0.5.51

package/dist/esm/api/resources/forwarding/errors/ForwardingForbiddenError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../../../errors/index.mjs";
+export class ForwardingForbiddenError extends errors.AgentMailError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForwardingForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/esm/api/resources/forwarding/errors/ForwardingRateLimitError.d.mts

@@ -0,0 +1,6 @@
+import type * as core from "../../../../core/index.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import type * as AgentMail from "../../../index.mjs";
+export declare class ForwardingRateLimitError extends errors.AgentMailError {
+    constructor(body: AgentMail.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/resources/forwarding/errors/ForwardingRateLimitError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../../../errors/index.mjs";
+export class ForwardingRateLimitError extends errors.AgentMailError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForwardingRateLimitError",
+            statusCode: 429,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/esm/api/resources/forwarding/errors/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./ForwardingForbiddenError.mjs";
+export * from "./ForwardingRateLimitError.mjs";

package/dist/esm/api/resources/forwarding/errors/index.mjs

@@ -0,0 +1,2 @@
+export * from "./ForwardingForbiddenError.mjs";
+export * from "./ForwardingRateLimitError.mjs";

package/dist/esm/api/resources/forwarding/exports.d.mts

@@ -0,0 +1,2 @@
+export { ForwardingClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/forwarding/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ForwardingClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/forwarding/index.d.mts

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

package/dist/esm/api/resources/forwarding/index.mjs

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

package/dist/esm/api/resources/forwarding/types/ConfirmForwardingVerificationRequest.d.mts

@@ -0,0 +1,10 @@
+import type * as AgentMail from "../../../index.mjs";
+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/esm/api/resources/forwarding/types/ConfirmForwardingVerificationRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/Forwarding.d.mts

@@ -0,0 +1,15 @@
+import type * as AgentMail from "../../../index.mjs";
+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/esm/api/resources/forwarding/types/Forwarding.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/ForwardingDestination.d.mts

@@ -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/esm/api/resources/forwarding/types/ForwardingDestination.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/ForwardingVerificationConfirmed.d.mts

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

package/dist/esm/api/resources/forwarding/types/ForwardingVerificationConfirmed.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/ForwardingVerificationStarted.d.mts

@@ -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/esm/api/resources/forwarding/types/ForwardingVerificationStarted.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/StartForwardingVerificationRequest.d.mts

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

package/dist/esm/api/resources/forwarding/types/StartForwardingVerificationRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/UpdateForwardingRequest.d.mts

@@ -0,0 +1,9 @@
+import type * as AgentMail from "../../../index.mjs";
+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/esm/api/resources/forwarding/types/UpdateForwardingRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/UpdateForwardingResponse.d.mts

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../index.mjs";
+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/esm/api/resources/forwarding/types/UpdateForwardingResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/forwarding/types/index.d.mts

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

package/dist/esm/api/resources/forwarding/types/index.mjs

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

package/dist/esm/api/resources/inboxes/client/Client.d.mts

@@ -8,6 +8,7 @@ import { CalendarClient } from "../resources/calendar/client/Client.mjs";
 import { DraftsClient } from "../resources/drafts/client/Client.mjs";
 import { EventsClient } from "../resources/events/client/Client.mjs";
 import { FilesClient } from "../resources/files/client/Client.mjs";
+import { ForwardingClient } from "../resources/forwarding/client/Client.mjs";
 import { ListsClient } from "../resources/lists/client/Client.mjs";
 import { MessagesClient } from "../resources/messages/client/Client.mjs";
 import { MetricsClient } from "../resources/metrics/client/Client.mjs";
@@ -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/esm/api/resources/inboxes/client/Client.mjs

@@ -22,6 +22,7 @@ import { CalendarClient } from "../resources/calendar/client/Client.mjs";
 import { DraftsClient } from "../resources/drafts/client/Client.mjs";
 import { EventsClient } from "../resources/events/client/Client.mjs";
 import { FilesClient } from "../resources/files/client/Client.mjs";
+import { ForwardingClient } from "../resources/forwarding/client/Client.mjs";
 import { ListsClient } from "../resources/lists/client/Client.mjs";
 import { MessagesClient } from "../resources/messages/client/Client.mjs";
 import { MetricsClient } from "../resources/metrics/client/Client.mjs";
@@ -51,6 +52,10 @@ export class InboxesClient {
         var _a;
         return ((_a = this._lists) !== null && _a !== void 0 ? _a : (this._lists = new ListsClient(this._options)));
     }
+    get forwarding() {
+        var _a;
+        return ((_a = this._forwarding) !== null && _a !== void 0 ? _a : (this._forwarding = new ForwardingClient(this._options)));
+    }
     get metrics() {
         var _a;
         return ((_a = this._metrics) !== null && _a !== void 0 ? _a : (this._metrics = new MetricsClient(this._options)));
@@ -458,6 +463,8 @@ export 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>
@@ -467,9 +474,10 @@ export 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));
@@ -504,6 +512,14 @@ export 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/esm/api/resources/inboxes/resources/forwarding/client/Client.d.mts

@@ -0,0 +1,79 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as AgentMail from "../../../../../index.mjs";
+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;
+}