agentmail 0.5.3 → 0.5.4

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "agentmail",
-        "X-Fern-SDK-Version": "0.5.3",
-        "User-Agent": "agentmail/0.5.3",
+        "X-Fern-SDK-Version": "0.5.4",
+        "User-Agent": "agentmail/0.5.4",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -42,7 +42,7 @@ export declare class AgentClient {
      *
      * On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
      *
-     * The OTP expires after 24 hours and allows a maximum of 10 attempts.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
      *
      * **CLI:**
      * ```bash

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

@@ -144,7 +144,7 @@ class AgentClient {
      *
      * On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
      *
-     * The OTP expires after 24 hours and allows a maximum of 10 attempts.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
      *
      * **CLI:**
      * ```bash

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

@@ -88,11 +88,10 @@ export declare class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.inboxes.update("inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.inboxes.update("inbox_id", {})
      */
     update(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
     private __update;

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

@@ -302,11 +302,10 @@ class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.inboxes.update("inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.inboxes.update("inbox_id", {})
      */
     update(inbox_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__update(inbox_id, request, requestOptions));
@@ -356,6 +355,14 @@ class InboxesClient {
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }), _response.rawResponse);
+                    case 400:
+                        throw new AgentMail.ValidationError(serializers.ValidationErrorResponse.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/types/CreateInboxRequest.d.ts

@@ -6,4 +6,6 @@ export interface CreateInboxRequest {
     domain?: string;
     displayName?: AgentMail.inboxes.DisplayName;
     clientId?: AgentMail.inboxes.ClientId;
+    /** Custom metadata to attach to the inbox. */
+    metadata?: AgentMail.inboxes.Metadata;
 }

package/dist/cjs/api/resources/inboxes/types/Inbox.d.ts

@@ -5,6 +5,8 @@ export interface Inbox {
     email: AgentMail.inboxes.Email;
     displayName?: AgentMail.inboxes.DisplayName;
     clientId?: AgentMail.inboxes.ClientId;
+    /** Custom metadata attached to the inbox. */
+    metadata?: AgentMail.inboxes.Metadata;
     /** Time at which inbox was last updated. */
     updatedAt: Date;
     /** Time at which inbox was created. */

package/dist/cjs/api/resources/inboxes/types/Metadata.d.ts

@@ -0,0 +1,6 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+ * string values are each limited to 256 characters.
+ */
+export type Metadata = Record<string, AgentMail.inboxes.MetadataValue>;

package/dist/cjs/api/resources/inboxes/types/Metadata.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/inboxes/types/MetadataValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A metadata value. May be a string, number, or boolean.
+ */
+export type MetadataValue = string | number | boolean;

package/dist/cjs/api/resources/inboxes/types/MetadataValue.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/inboxes/types/UpdateInboxRequest.d.ts

@@ -1,4 +1,11 @@
 import type * as AgentMail from "../../../index.js";
 export interface UpdateInboxRequest {
-    displayName: AgentMail.inboxes.DisplayName;
+    displayName?: AgentMail.inboxes.DisplayName;
+    /**
+     * Metadata to merge into the inbox's existing metadata. Keys you include
+     * are added or overwritten; keys you omit are left unchanged. To remove a
+     * single key, send it with a null value. To clear all metadata, send
+     * `metadata` as null. Provide at least one of `display_name` or `metadata`.
+     */
+    metadata?: AgentMail.inboxes.Metadata;
 }

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

@@ -5,4 +5,6 @@ export * from "./Email.js";
 export * from "./Inbox.js";
 export * from "./InboxId.js";
 export * from "./ListInboxesResponse.js";
+export * from "./Metadata.js";
+export * from "./MetadataValue.js";
 export * from "./UpdateInboxRequest.js";

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

@@ -21,4 +21,6 @@ __exportStar(require("./Email.js"), exports);
 __exportStar(require("./Inbox.js"), exports);
 __exportStar(require("./InboxId.js"), exports);
 __exportStar(require("./ListInboxesResponse.js"), exports);
+__exportStar(require("./Metadata.js"), exports);
+__exportStar(require("./MetadataValue.js"), exports);
 __exportStar(require("./UpdateInboxRequest.js"), exports);

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

@@ -75,9 +75,7 @@ export declare class InboxesClient {
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.pods.inboxes.update("pod_id", "inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.pods.inboxes.update("pod_id", "inbox_id", {})
      */
     update(pod_id: AgentMail.pods.PodId, inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
     private __update;

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

@@ -286,9 +286,7 @@ class InboxesClient {
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.pods.inboxes.update("pod_id", "inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.pods.inboxes.update("pod_id", "inbox_id", {})
      */
     update(pod_id, inbox_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__update(pod_id, inbox_id, request, requestOptions));

package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.d.ts

@@ -3,6 +3,7 @@ import * as core from "../../../../core/index.js";
 import type * as serializers from "../../../index.js";
 import { ClientId } from "./ClientId.js";
 import { DisplayName } from "./DisplayName.js";
+import { Metadata } from "./Metadata.js";
 export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
 export declare namespace CreateInboxRequest {
     interface Raw {
@@ -10,5 +11,6 @@ export declare namespace CreateInboxRequest {
         domain?: string | null;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        metadata?: Metadata.Raw | null;
     }
 }

package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.js

@@ -38,9 +38,11 @@ exports.CreateInboxRequest = void 0;
 const core = __importStar(require("../../../../core/index.js"));
 const ClientId_js_1 = require("./ClientId.js");
 const DisplayName_js_1 = require("./DisplayName.js");
+const Metadata_js_1 = require("./Metadata.js");
 exports.CreateInboxRequest = core.serialization.object({
     username: core.serialization.string().optional(),
     domain: core.serialization.string().optional(),
     displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
+    metadata: Metadata_js_1.Metadata.optional(),
 });

package/dist/cjs/serialization/resources/inboxes/types/Inbox.d.ts

@@ -6,6 +6,7 @@ import { ClientId } from "./ClientId.js";
 import { DisplayName } from "./DisplayName.js";
 import { Email } from "./Email.js";
 import { InboxId } from "./InboxId.js";
+import { Metadata } from "./Metadata.js";
 export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
 export declare namespace Inbox {
     interface Raw {
@@ -14,6 +15,7 @@ export declare namespace Inbox {
         email: Email.Raw;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        metadata?: Metadata.Raw | null;
         updated_at: string;
         created_at: string;
     }

package/dist/cjs/serialization/resources/inboxes/types/Inbox.js

@@ -41,12 +41,14 @@ const ClientId_js_1 = require("./ClientId.js");
 const DisplayName_js_1 = require("./DisplayName.js");
 const Email_js_1 = require("./Email.js");
 const InboxId_js_1 = require("./InboxId.js");
+const Metadata_js_1 = require("./Metadata.js");
 exports.Inbox = core.serialization.object({
     podId: core.serialization.property("pod_id", PodId_js_1.PodId),
     inboxId: core.serialization.property("inbox_id", InboxId_js_1.InboxId),
     email: Email_js_1.Email,
     displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
+    metadata: Metadata_js_1.Metadata.optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
 });

package/dist/cjs/serialization/resources/inboxes/types/Metadata.d.ts

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+import { MetadataValue } from "./MetadataValue.js";
+export declare const Metadata: core.serialization.Schema<serializers.inboxes.Metadata.Raw, AgentMail.inboxes.Metadata>;
+export declare namespace Metadata {
+    type Raw = Record<string, MetadataValue.Raw>;
+}

package/dist/cjs/serialization/resources/inboxes/types/Metadata.js

@@ -0,0 +1,40 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metadata = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+const MetadataValue_js_1 = require("./MetadataValue.js");
+exports.Metadata = core.serialization.record(core.serialization.string(), MetadataValue_js_1.MetadataValue);

package/dist/cjs/serialization/resources/inboxes/types/MetadataValue.d.ts

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+export declare const MetadataValue: core.serialization.Schema<serializers.inboxes.MetadataValue.Raw, AgentMail.inboxes.MetadataValue>;
+export declare namespace MetadataValue {
+    type Raw = string | number | boolean;
+}

package/dist/cjs/serialization/resources/inboxes/types/MetadataValue.js

@@ -0,0 +1,43 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataValue = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+exports.MetadataValue = core.serialization.undiscriminatedUnion([
+    core.serialization.string(),
+    core.serialization.number(),
+    core.serialization.boolean(),
+]);

package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.d.ts

@@ -2,9 +2,11 @@ import type * as AgentMail from "../../../../api/index.js";
 import * as core from "../../../../core/index.js";
 import type * as serializers from "../../../index.js";
 import { DisplayName } from "./DisplayName.js";
+import { Metadata } from "./Metadata.js";
 export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
 export declare namespace UpdateInboxRequest {
     interface Raw {
-        display_name: DisplayName.Raw;
+        display_name?: DisplayName.Raw | null;
+        metadata?: Metadata.Raw | null;
     }
 }

package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.js

@@ -37,6 +37,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateInboxRequest = void 0;
 const core = __importStar(require("../../../../core/index.js"));
 const DisplayName_js_1 = require("./DisplayName.js");
+const Metadata_js_1 = require("./Metadata.js");
 exports.UpdateInboxRequest = core.serialization.object({
-    displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName),
+    displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
+    metadata: Metadata_js_1.Metadata.optional(),
 });

package/dist/cjs/serialization/resources/inboxes/types/index.d.ts

@@ -5,4 +5,6 @@ export * from "./Email.js";
 export * from "./Inbox.js";
 export * from "./InboxId.js";
 export * from "./ListInboxesResponse.js";
+export * from "./Metadata.js";
+export * from "./MetadataValue.js";
 export * from "./UpdateInboxRequest.js";

package/dist/cjs/serialization/resources/inboxes/types/index.js

@@ -21,4 +21,6 @@ __exportStar(require("./Email.js"), exports);
 __exportStar(require("./Inbox.js"), exports);
 __exportStar(require("./InboxId.js"), exports);
 __exportStar(require("./ListInboxesResponse.js"), exports);
+__exportStar(require("./Metadata.js"), exports);
+__exportStar(require("./MetadataValue.js"), exports);
 __exportStar(require("./UpdateInboxRequest.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.5.3";
+export declare const SDK_VERSION = "0.5.4";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.5.3";
+exports.SDK_VERSION = "0.5.4";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "agentmail",
-        "X-Fern-SDK-Version": "0.5.3",
-        "User-Agent": "agentmail/0.5.3",
+        "X-Fern-SDK-Version": "0.5.4",
+        "User-Agent": "agentmail/0.5.4",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -42,7 +42,7 @@ export declare class AgentClient {
      *
      * On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
      *
-     * The OTP expires after 24 hours and allows a maximum of 10 attempts.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
      *
      * **CLI:**
      * ```bash

package/dist/esm/api/resources/agent/client/Client.mjs

@@ -108,7 +108,7 @@ export class AgentClient {
      *
      * On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
      *
-     * The OTP expires after 24 hours and allows a maximum of 10 attempts.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
      *
      * **CLI:**
      * ```bash

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

@@ -88,11 +88,10 @@ export declare class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.inboxes.update("inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.inboxes.update("inbox_id", {})
      */
     update(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
     private __update;

package/dist/esm/api/resources/inboxes/client/Client.mjs

@@ -266,11 +266,10 @@ export class InboxesClient {
      * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.inboxes.update("inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.inboxes.update("inbox_id", {})
      */
     update(inbox_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__update(inbox_id, request, requestOptions));
@@ -320,6 +319,14 @@ export class InboxesClient {
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }), _response.rawResponse);
+                    case 400:
+                        throw new AgentMail.ValidationError(serializers.ValidationErrorResponse.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/types/CreateInboxRequest.d.mts

@@ -6,4 +6,6 @@ export interface CreateInboxRequest {
     domain?: string;
     displayName?: AgentMail.inboxes.DisplayName;
     clientId?: AgentMail.inboxes.ClientId;
+    /** Custom metadata to attach to the inbox. */
+    metadata?: AgentMail.inboxes.Metadata;
 }

package/dist/esm/api/resources/inboxes/types/Inbox.d.mts

@@ -5,6 +5,8 @@ export interface Inbox {
     email: AgentMail.inboxes.Email;
     displayName?: AgentMail.inboxes.DisplayName;
     clientId?: AgentMail.inboxes.ClientId;
+    /** Custom metadata attached to the inbox. */
+    metadata?: AgentMail.inboxes.Metadata;
     /** Time at which inbox was last updated. */
     updatedAt: Date;
     /** Time at which inbox was created. */

package/dist/esm/api/resources/inboxes/types/Metadata.d.mts

@@ -0,0 +1,6 @@
+import type * as AgentMail from "../../../index.mjs";
+/**
+ * Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+ * string values are each limited to 256 characters.
+ */
+export type Metadata = Record<string, AgentMail.inboxes.MetadataValue>;

package/dist/esm/api/resources/inboxes/types/Metadata.mjs

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

package/dist/esm/api/resources/inboxes/types/MetadataValue.d.mts

@@ -0,0 +1,4 @@
+/**
+ * A metadata value. May be a string, number, or boolean.
+ */
+export type MetadataValue = string | number | boolean;

package/dist/esm/api/resources/inboxes/types/MetadataValue.mjs

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

package/dist/esm/api/resources/inboxes/types/UpdateInboxRequest.d.mts

@@ -1,4 +1,11 @@
 import type * as AgentMail from "../../../index.mjs";
 export interface UpdateInboxRequest {
-    displayName: AgentMail.inboxes.DisplayName;
+    displayName?: AgentMail.inboxes.DisplayName;
+    /**
+     * Metadata to merge into the inbox's existing metadata. Keys you include
+     * are added or overwritten; keys you omit are left unchanged. To remove a
+     * single key, send it with a null value. To clear all metadata, send
+     * `metadata` as null. Provide at least one of `display_name` or `metadata`.
+     */
+    metadata?: AgentMail.inboxes.Metadata;
 }

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

@@ -5,4 +5,6 @@ export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
 export * from "./ListInboxesResponse.mjs";
+export * from "./Metadata.mjs";
+export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";

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

@@ -5,4 +5,6 @@ export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
 export * from "./ListInboxesResponse.mjs";
+export * from "./Metadata.mjs";
+export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";

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

@@ -75,9 +75,7 @@ export declare class InboxesClient {
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.pods.inboxes.update("pod_id", "inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.pods.inboxes.update("pod_id", "inbox_id", {})
      */
     update(pod_id: AgentMail.pods.PodId, inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
     private __update;

package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs

@@ -250,9 +250,7 @@ export class InboxesClient {
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.pods.inboxes.update("pod_id", "inbox_id", {
-     *         displayName: "display_name"
-     *     })
+     *     await client.pods.inboxes.update("pod_id", "inbox_id", {})
      */
     update(pod_id, inbox_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__update(pod_id, inbox_id, request, requestOptions));

package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts

@@ -3,6 +3,7 @@ import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { Metadata } from "./Metadata.mjs";
 export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
 export declare namespace CreateInboxRequest {
     interface Raw {
@@ -10,5 +11,6 @@ export declare namespace CreateInboxRequest {
         domain?: string | null;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        metadata?: Metadata.Raw | null;
     }
 }

package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs

@@ -2,9 +2,11 @@
 import * as core from "../../../../core/index.mjs";
 import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { Metadata } from "./Metadata.mjs";
 export const CreateInboxRequest = core.serialization.object({
     username: core.serialization.string().optional(),
     domain: core.serialization.string().optional(),
     displayName: core.serialization.property("display_name", DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId.optional()),
+    metadata: Metadata.optional(),
 });

package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts

@@ -6,6 +6,7 @@ import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
 import { Email } from "./Email.mjs";
 import { InboxId } from "./InboxId.mjs";
+import { Metadata } from "./Metadata.mjs";
 export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
 export declare namespace Inbox {
     interface Raw {
@@ -14,6 +15,7 @@ export declare namespace Inbox {
         email: Email.Raw;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        metadata?: Metadata.Raw | null;
         updated_at: string;
         created_at: string;
     }