agentmail 0.5.4 → 0.5.6

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.4",
-        "User-Agent": "agentmail/0.5.4",
+        "X-Fern-SDK-Version": "0.5.6",
+        "User-Agent": "agentmail/0.5.6",
         "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/inboxes/types/Metadata.d.ts

@@ -1,6 +1,7 @@
 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.
+ * string values are each limited to 256 characters. When updating metadata,
+ * send a key with a null value to remove that key.
  */
 export type Metadata = Record<string, AgentMail.inboxes.MetadataValue>;

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

@@ -5,7 +5,9 @@ export interface UpdateInboxRequest {
      * 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` as null. Sending an empty object is rejected; use null to
+     * clear. Each update must include at least one of `display_name` or
+     * `metadata`.
      */
-    metadata?: AgentMail.inboxes.Metadata;
+    metadata?: AgentMail.inboxes.UpdateMetadata | null;
 }

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

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * Custom key-value pairs to merge into the inbox's existing metadata. A
+ * value may be a string, number, boolean, or null. Setting a key to null
+ * removes it. Up to 256 keys; keys and string values are each limited to
+ * 256 characters.
+ */
+export type UpdateMetadata = Record<string, AgentMail.inboxes.MetadataValue | null>;

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.js";
 export * from "./Metadata.js";
 export * from "./MetadataValue.js";
 export * from "./UpdateInboxRequest.js";
+export * from "./UpdateMetadata.js";

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

@@ -24,3 +24,4 @@ __exportStar(require("./ListInboxesResponse.js"), exports);
 __exportStar(require("./Metadata.js"), exports);
 __exportStar(require("./MetadataValue.js"), exports);
 __exportStar(require("./UpdateInboxRequest.js"), exports);
+__exportStar(require("./UpdateMetadata.js"), exports);

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

@@ -2,11 +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";
+import { UpdateMetadata } from "./UpdateMetadata.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 | null;
-        metadata?: Metadata.Raw | null;
+        metadata?: (UpdateMetadata.Raw | null | undefined) | null;
     }
 }

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

@@ -37,8 +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");
+const UpdateMetadata_js_1 = require("./UpdateMetadata.js");
 exports.UpdateInboxRequest = core.serialization.object({
     displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
-    metadata: Metadata_js_1.Metadata.optional(),
+    metadata: UpdateMetadata_js_1.UpdateMetadata.optionalNullable(),
 });

package/dist/cjs/serialization/resources/inboxes/types/UpdateMetadata.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 UpdateMetadata: core.serialization.Schema<serializers.inboxes.UpdateMetadata.Raw, AgentMail.inboxes.UpdateMetadata>;
+export declare namespace UpdateMetadata {
+    type Raw = Record<string, MetadataValue.Raw | null>;
+}

package/dist/cjs/serialization/resources/inboxes/types/UpdateMetadata.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.UpdateMetadata = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+const MetadataValue_js_1 = require("./MetadataValue.js");
+exports.UpdateMetadata = core.serialization.record(core.serialization.string(), MetadataValue_js_1.MetadataValue.nullable());

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.js";
 export * from "./Metadata.js";
 export * from "./MetadataValue.js";
 export * from "./UpdateInboxRequest.js";
+export * from "./UpdateMetadata.js";

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

@@ -24,3 +24,4 @@ __exportStar(require("./ListInboxesResponse.js"), exports);
 __exportStar(require("./Metadata.js"), exports);
 __exportStar(require("./MetadataValue.js"), exports);
 __exportStar(require("./UpdateInboxRequest.js"), exports);
+__exportStar(require("./UpdateMetadata.js"), exports);

package/dist/cjs/version.d.ts

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

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.4";
+exports.SDK_VERSION = "0.5.6";

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.4",
-        "User-Agent": "agentmail/0.5.4",
+        "X-Fern-SDK-Version": "0.5.6",
+        "User-Agent": "agentmail/0.5.6",
         "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/inboxes/types/Metadata.d.mts

@@ -1,6 +1,7 @@
 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.
+ * string values are each limited to 256 characters. When updating metadata,
+ * send a key with a null value to remove that key.
  */
 export type Metadata = Record<string, AgentMail.inboxes.MetadataValue>;

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

@@ -5,7 +5,9 @@ export interface UpdateInboxRequest {
      * 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` as null. Sending an empty object is rejected; use null to
+     * clear. Each update must include at least one of `display_name` or
+     * `metadata`.
      */
-    metadata?: AgentMail.inboxes.Metadata;
+    metadata?: AgentMail.inboxes.UpdateMetadata | null;
 }

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

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../index.mjs";
+/**
+ * Custom key-value pairs to merge into the inbox's existing metadata. A
+ * value may be a string, number, boolean, or null. Setting a key to null
+ * removes it. Up to 256 keys; keys and string values are each limited to
+ * 256 characters.
+ */
+export type UpdateMetadata = Record<string, AgentMail.inboxes.MetadataValue | null>;

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

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

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";
+export * from "./UpdateMetadata.mjs";

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";
+export * from "./UpdateMetadata.mjs";

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

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

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

@@ -1,8 +1,8 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
 import { DisplayName } from "./DisplayName.mjs";
-import { Metadata } from "./Metadata.mjs";
+import { UpdateMetadata } from "./UpdateMetadata.mjs";
 export const UpdateInboxRequest = core.serialization.object({
     displayName: core.serialization.property("display_name", DisplayName.optional()),
-    metadata: Metadata.optional(),
+    metadata: UpdateMetadata.optionalNullable(),
 });

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

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

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

@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { MetadataValue } from "./MetadataValue.mjs";
+export const UpdateMetadata = core.serialization.record(core.serialization.string(), MetadataValue.nullable());

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";
+export * from "./UpdateMetadata.mjs";

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

@@ -8,3 +8,4 @@ export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";
+export * from "./UpdateMetadata.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.5.4";
+export const SDK_VERSION = "0.5.6";

package/dist/llms-full.txt

@@ -538,6 +538,89 @@ don't provide them, AgentMail will generate a unique address for you using our
 default domain. Check out our [guide on managing
 domains](/guides/domains/managing-domains) to learn more.
 
+## Metadata
+
+Attach your own key-value data to any `Inbox` with the `metadata` field. Use it to link an inbox to records in your own system: a user ID, an agent name, or feature flags. Metadata is returned on every inbox response.
+
+Values may be a string, number, or boolean. An `Inbox` can hold up to 256 keys, and each key and string value is limited to 256 characters.
+
+```python title="Python"
+# Attach metadata when creating an inbox; values may be a string, int, float, or boolean
+inbox = client.inboxes.create(
+    username="support-agent",
+    metadata={
+        "tenant_id": "acme",       # string
+        "seat_count": 5,           # int
+        "monthly_spend": 19.99,    # float
+        "active": True,            # boolean
+    },
+)
+
+# Read it back from any inbox response
+print(inbox.metadata)
+```
+
+```typescript title="TypeScript"
+// Attach metadata when creating an inbox; values may be a string, int, float, or boolean
+const inbox = await client.inboxes.create({
+  username: "support-agent",
+  metadata: {
+    tenant_id: "acme", // string
+    seat_count: 5, // int
+    monthly_spend: 19.99, // float
+    active: true, // boolean
+  },
+});
+
+// Read it back from any inbox response
+console.log(inbox.metadata);
+```
+
+### Updating metadata
+
+Updates **merge** into the inbox's existing metadata — keys you include are added or overwritten, and keys you omit are preserved.
+
+To remove a single key, send it with a `null` value. To clear all metadata at
+once, send `metadata` as `null`. Every update must include either
+`display_name` or `metadata`.
+
+```python title="Python"
+# Add or overwrite keys; the keys you omit stay unchanged
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata={"tier": "enterprise"},
+)
+
+# Remove a single key
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata={"tier": None},
+)
+
+# Clear all metadata
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata=None,
+)
+```
+
+```typescript title="TypeScript"
+// Add or overwrite keys; the keys you omit stay unchanged
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: { tier: "enterprise" },
+});
+
+// Remove a single key
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: { tier: null },
+});
+
+// Clear all metadata
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: null,
+});
+```
+
 ## Inbox-scoped API keys
 
 You can create API keys that are restricted to a single inbox. An inbox-scoped key can only access that inbox's threads, messages, and drafts. This is useful when you want to give an agent or integration the minimum access it needs.
@@ -575,10 +658,10 @@ AgentMail Inboxes — copy into Cursor/Claude.
 Setup: pip install agentmail python-dotenv. Set AGENTMAIL_API_KEY in .env.
 
 API reference:
-- inboxes.create(username?, domain?, display_name?, client_id?) — client_id for idempotent retries
+- inboxes.create(username?, domain?, display_name?, client_id?, metadata?) — client_id for idempotent retries; metadata is custom key-value data
 - inboxes.get(inbox_id)
 - inboxes.list(limit?, page_token?)
-- inboxes.update(inbox_id, display_name)
+- inboxes.update(inbox_id, display_name?, metadata?) — at least one field required; metadata is merged, not replaced
 - inboxes.delete(inbox_id)
 - inboxes.api_keys.create(inbox_id, name) — inbox-scoped key
 - inboxes.api_keys.list(inbox_id)
@@ -609,10 +692,10 @@ print(f"Total: {all_inboxes.count}")
  * Setup: npm install agentmail dotenv. Set AGENTMAIL_API_KEY in .env.
  *
  * API reference:
- * - inboxes.create({ username?, domain?, displayName?, clientId? })
+ * - inboxes.create({ username?, domain?, displayName?, clientId?, metadata? }) — metadata is custom key-value data
  * - inboxes.get(inboxId)
  * - inboxes.list({ limit?, pageToken? })
- * - inboxes.update(inboxId, { displayName })
+ * - inboxes.update(inboxId, { displayName?, metadata? }) — at least one field required
  * - inboxes.delete(inboxId)
  * - inboxes.apiKeys.create(inboxId, { name }) — inbox-scoped key
  * - inboxes.apiKeys.list(inboxId)
@@ -11998,7 +12081,7 @@ Verify an agent organization using the 6-digit OTP sent to the human's email dur
 
 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
@@ -12029,7 +12112,11 @@ paths:
         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:**
@@ -12348,6 +12435,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -12361,6 +12468,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -12610,6 +12720,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -12623,6 +12753,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -12868,6 +13001,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:CreateInboxRequest:
       type: object
       properties:
@@ -12883,6 +13036,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata to attach to the inbox.
       title: CreateInboxRequest
     type_pods:PodId:
       type: string
@@ -12909,6 +13065,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -13135,6 +13294,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/type_inboxes:Inbox'
+        '400':
+          description: Error response with status 400
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/type_:ValidationErrorResponse'
         '404':
           description: Error response with status 404
           content:
@@ -13142,6 +13307,9 @@ paths:
               schema:
                 $ref: '#/components/schemas/type_:ErrorResponse'
       requestBody:
+        description: >-
+          Expects an object; provide at least one of `display_name` or
+          `metadata`.
         content:
           application/json:
             schema:
@@ -13161,13 +13329,49 @@ components:
       type: string
       description: 'Display name: `Display Name <username@domain.com>`.'
       title: DisplayName
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:UpdateMetadata:
+      type: object
+      additionalProperties:
+        oneOf:
+          - $ref: '#/components/schemas/type_inboxes:MetadataValue'
+          - type: 'null'
+      description: |-
+        Custom key-value pairs to merge into the inbox's existing metadata. A
+        value may be a string, number, boolean, or null. Setting a key to null
+        removes it. Up to 256 keys; keys and string values are each limited to
+        256 characters.
+      title: UpdateMetadata
     type_inboxes:UpdateInboxRequest:
       type: object
       properties:
         display_name:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
-      required:
-        - display_name
+        metadata:
+          oneOf:
+            - $ref: '#/components/schemas/type_inboxes:UpdateMetadata'
+            - type: 'null'
+          description: >-
+            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. Sending an empty object is rejected; use null to
+
+            clear. Each update must include at least one of `display_name` or
+
+            `metadata`.
       title: UpdateInboxRequest
     type_pods:PodId:
       type: string
@@ -13181,6 +13385,18 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -13194,6 +13410,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -13228,6 +13447,17 @@ components:
         - name
         - message
       title: ErrorResponse
+    type_:ValidationErrorResponse:
+      type: object
+      properties:
+        name:
+          $ref: '#/components/schemas/type_:ErrorName'
+        errors:
+          description: Validation errors.
+      required:
+        - name
+        - errors
+      title: ValidationErrorResponse
   securitySchemes:
     Bearer:
       type: http
@@ -13244,9 +13474,7 @@ async function main() {
     const client = new AgentMailClient({
         apiKey: "YOUR_TOKEN_HERE",
     });
-    await client.inboxes.update("inbox_id", {
-        displayName: "display_name",
-    });
+    await client.inboxes.update("inbox_id", {});
 }
 main();
 
@@ -13261,7 +13489,6 @@ client = AgentMail(
 
 client.inboxes.update(
     inbox_id="inbox_id",
-    display_name="display_name",
 )
 
 ```
@@ -13280,7 +13507,7 @@ func main() {
 
 	url := "https://api.agentmail.to/v0/inboxes/inbox_id"
 
-	payload := strings.NewReader("{\n  \"display_name\": \"display_name\"\n}")
+	payload := strings.NewReader("{}")
 
 	req, _ := http.NewRequest("PATCH", url, payload)
 
@@ -13310,7 +13537,7 @@ http.use_ssl = true
 request = Net::HTTP::Patch.new(url)
 request["Authorization"] = 'Bearer <api_key>'
 request["Content-Type"] = 'application/json'
-request.body = "{\n  \"display_name\": \"display_name\"\n}"
+request.body = "{}"
 
 response = http.request(request)
 puts response.read_body
@@ -13323,7 +13550,7 @@ import com.mashape.unirest.http.Unirest;
 HttpResponse<String> response = Unirest.patch("https://api.agentmail.to/v0/inboxes/inbox_id")
   .header("Authorization", "Bearer <api_key>")
   .header("Content-Type", "application/json")
-  .body("{\n  \"display_name\": \"display_name\"\n}")
+  .body("{}")
   .asString();
 ```
 
@@ -13334,9 +13561,7 @@ require_once('vendor/autoload.php');
 $client = new \GuzzleHttp\Client();
 
 $response = $client->request('PATCH', 'https://api.agentmail.to/v0/inboxes/inbox_id', [
-  'body' => '{
-  "display_name": "display_name"
-}',
+  'body' => '{}',
   'headers' => [
     'Authorization' => 'Bearer <api_key>',
     'Content-Type' => 'application/json',
@@ -13353,7 +13578,7 @@ var client = new RestClient("https://api.agentmail.to/v0/inboxes/inbox_id");
 var request = new RestRequest(Method.PATCH);
 request.AddHeader("Authorization", "Bearer <api_key>");
 request.AddHeader("Content-Type", "application/json");
-request.AddParameter("application/json", "{\n  \"display_name\": \"display_name\"\n}", ParameterType.RequestBody);
+request.AddParameter("application/json", "{}", ParameterType.RequestBody);
 IRestResponse response = client.Execute(request);
 ```
 
@@ -13364,7 +13589,7 @@ let headers = [
   "Authorization": "Bearer <api_key>",
   "Content-Type": "application/json"
 ]
-let parameters = ["display_name": "display_name"] as [String : Any]
+let parameters = [] as [String : Any]
 
 let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
 
@@ -37807,6 +38032,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -37820,6 +38065,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38095,6 +38343,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -38108,6 +38376,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38363,6 +38634,26 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:CreateInboxRequest:
       type: object
       properties:
@@ -38378,6 +38669,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata to attach to the inbox.
       title: CreateInboxRequest
     type_inboxes:InboxId:
       type: string
@@ -38400,6 +38694,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38670,13 +38967,49 @@ components:
       type: string
       description: 'Display name: `Display Name <username@domain.com>`.'
       title: DisplayName
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:UpdateMetadata:
+      type: object
+      additionalProperties:
+        oneOf:
+          - $ref: '#/components/schemas/type_inboxes:MetadataValue'
+          - type: 'null'
+      description: |-
+        Custom key-value pairs to merge into the inbox's existing metadata. A
+        value may be a string, number, boolean, or null. Setting a key to null
+        removes it. Up to 256 keys; keys and string values are each limited to
+        256 characters.
+      title: UpdateMetadata
     type_inboxes:UpdateInboxRequest:
       type: object
       properties:
         display_name:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
-      required:
-        - display_name
+        metadata:
+          oneOf:
+            - $ref: '#/components/schemas/type_inboxes:UpdateMetadata'
+            - type: 'null'
+          description: >-
+            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. Sending an empty object is rejected; use null to
+
+            clear. Each update must include at least one of `display_name` or
+
+            `metadata`.
       title: UpdateInboxRequest
     type_inboxes:Email:
       type: string
@@ -38686,6 +39019,18 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: >-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+
+        string values are each limited to 256 characters. When updating
+        metadata,
+
+        send a key with a null value to remove that key.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -38699,6 +39044,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38749,9 +39097,7 @@ async function main() {
     const client = new AgentMailClient({
         apiKey: "YOUR_TOKEN_HERE",
     });
-    await client.pods.inboxes.update("pod_id", "inbox_id", {
-        displayName: "display_name",
-    });
+    await client.pods.inboxes.update("pod_id", "inbox_id", {});
 }
 main();
 
@@ -38767,7 +39113,6 @@ client = AgentMail(
 client.pods.inboxes.update(
     pod_id="pod_id",
     inbox_id="inbox_id",
-    display_name="display_name",
 )
 
 ```
@@ -38786,7 +39131,7 @@ func main() {
 
 	url := "https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id"
 
-	payload := strings.NewReader("{\n  \"display_name\": \"display_name\"\n}")
+	payload := strings.NewReader("{}")
 
 	req, _ := http.NewRequest("PATCH", url, payload)
 
@@ -38816,7 +39161,7 @@ http.use_ssl = true
 request = Net::HTTP::Patch.new(url)
 request["Authorization"] = 'Bearer <api_key>'
 request["Content-Type"] = 'application/json'
-request.body = "{\n  \"display_name\": \"display_name\"\n}"
+request.body = "{}"
 
 response = http.request(request)
 puts response.read_body
@@ -38829,7 +39174,7 @@ import com.mashape.unirest.http.Unirest;
 HttpResponse<String> response = Unirest.patch("https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id")
   .header("Authorization", "Bearer <api_key>")
   .header("Content-Type", "application/json")
-  .body("{\n  \"display_name\": \"display_name\"\n}")
+  .body("{}")
   .asString();
 ```
 
@@ -38840,9 +39185,7 @@ require_once('vendor/autoload.php');
 $client = new \GuzzleHttp\Client();
 
 $response = $client->request('PATCH', 'https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id', [
-  'body' => '{
-  "display_name": "display_name"
-}',
+  'body' => '{}',
   'headers' => [
     'Authorization' => 'Bearer <api_key>',
     'Content-Type' => 'application/json',
@@ -38859,7 +39202,7 @@ var client = new RestClient("https://api.agentmail.to/v0/pods/pod_id/inboxes/inb
 var request = new RestRequest(Method.PATCH);
 request.AddHeader("Authorization", "Bearer <api_key>");
 request.AddHeader("Content-Type", "application/json");
-request.AddParameter("application/json", "{\n  \"display_name\": \"display_name\"\n}", ParameterType.RequestBody);
+request.AddParameter("application/json", "{}", ParameterType.RequestBody);
 IRestResponse response = client.Execute(request);
 ```
 
@@ -38870,7 +39213,7 @@ let headers = [
   "Authorization": "Bearer <api_key>",
   "Content-Type": "application/json"
 ]
-let parameters = ["display_name": "display_name"] as [String : Any]
+let parameters = [] as [String : Any]
 
 let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agentmail",
-    "version": "0.5.4",
+    "version": "0.5.6",
     "private": false,
     "repository": {
         "type": "git",