agentmail 0.5.2 → 0.5.4

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/lists/types/ListEntryBase.d.mts

@@ -10,4 +10,6 @@ export interface ListEntryBase {
     entryType: AgentMail.EntryType;
     /** Time at which entry was created. */
     createdAt: Date;
+    /** Whether the entry is read-only and cannot be deleted via the API. */
+    readOnly?: boolean;
 }

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/api/resources/webhooks/client/Client.d.mts

@@ -60,6 +60,9 @@ export declare class WebhooksClient {
     create(request: AgentMail.webhooks.CreateWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
     private __create;
     /**
+     * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
+     * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
+     *
      * **CLI:**
      * ```bash
      * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>

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

@@ -224,6 +224,9 @@ export class WebhooksClient {
         });
     }
     /**
+     * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
+     * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
+     *
      * **CLI:**
      * ```bash
      * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>

package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts

@@ -1,6 +1,11 @@
 import type * as AgentMail from "../../../index.mjs";
 export interface CreateWebhookRequest {
     url: AgentMail.webhooks.Url;
+    /**
+     * Full list of event types this webhook should receive. At least one type is required. Send every type you
+     * want in this array (not incremental). See [Webhooks overview](https://docs.agentmail.to/webhooks-overview)
+     * for spam, blocked, and unauthenticated events and required permissions.
+     */
     eventTypes: AgentMail.EventTypes;
     podIds?: AgentMail.PodIds;
     inboxIds?: AgentMail.InboxIds;

package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts

@@ -8,4 +8,13 @@ export interface UpdateWebhookRequest {
     addPodIds?: AgentMail.PodIds;
     /** Pod IDs to unsubscribe from the webhook. */
     removePodIds?: AgentMail.PodIds;
+    /**
+     * When you send a non-empty list, it replaces the webhook's subscribed event types in full (the same
+     * "set the list" behavior as create). It is not a merge or diff: include every event type you want after
+     * the update. Sending a one-element array means the webhook will only receive that one type afterward.
+     * Omit this field or send an empty array to leave event types unchanged. Clearing all types with an empty
+     * list is not supported. Subscribing to `message.received.spam`, `message.received.blocked`, or
+     * `message.received.unauthenticated` requires the matching label permission on the API key.
+     */
+    eventTypes?: AgentMail.EventTypes;
 }

package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.d.mts

@@ -6,5 +6,7 @@ export declare namespace AgentSignupRequest {
     interface Raw {
         human_email: string;
         username: string;
+        source?: string | null;
+        referrer?: string | null;
     }
 }

package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.mjs

@@ -3,4 +3,6 @@ import * as core from "../../../../core/index.mjs";
 export const AgentSignupRequest = core.serialization.object({
     humanEmail: core.serialization.property("human_email", core.serialization.string()),
     username: core.serialization.string(),
+    source: core.serialization.string().optional(),
+    referrer: core.serialization.string().optional(),
 });

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;
     }

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

@@ -5,12 +5,14 @@ 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 const Inbox = core.serialization.object({
     podId: core.serialization.property("pod_id", PodId),
     inboxId: core.serialization.property("inbox_id", InboxId),
     email: Email,
     displayName: core.serialization.property("display_name", DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId.optional()),
+    metadata: Metadata.optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
 });

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

package/dist/esm/serialization/resources/inboxes/types/Metadata.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 Metadata = core.serialization.record(core.serialization.string(), MetadataValue);

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

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+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/esm/serialization/resources/inboxes/types/MetadataValue.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const MetadataValue = core.serialization.undiscriminatedUnion([
+    core.serialization.string(),
+    core.serialization.number(),
+    core.serialization.boolean(),
+]);

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

@@ -2,9 +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";
 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/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs

@@ -1,6 +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";
 export const UpdateInboxRequest = core.serialization.object({
-    displayName: core.serialization.property("display_name", DisplayName),
+    displayName: core.serialization.property("display_name", DisplayName.optional()),
+    metadata: Metadata.optional(),
 });

package/dist/esm/serialization/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/serialization/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/serialization/resources/lists/types/ListEntryBase.d.mts

@@ -15,5 +15,6 @@ export declare namespace ListEntryBase {
         list_type: ListType.Raw;
         entry_type: EntryType.Raw;
         created_at: string;
+        read_only?: boolean | null;
     }
 }

package/dist/esm/serialization/resources/lists/types/ListEntryBase.mjs

@@ -12,4 +12,5 @@ export const ListEntryBase = core.serialization.object({
     listType: core.serialization.property("list_type", ListType),
     entryType: core.serialization.property("entry_type", EntryType),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
+    readOnly: core.serialization.property("read_only", core.serialization.boolean().optional()),
 });

package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.d.mts

@@ -1,6 +1,7 @@
 import type * as AgentMail from "../../../../api/index.mjs";
 import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
+import { EventTypes } from "../../events/types/EventTypes.mjs";
 import { InboxIds } from "../../events/types/InboxIds.mjs";
 import { PodIds } from "../../events/types/PodIds.mjs";
 export declare const UpdateWebhookRequest: core.serialization.ObjectSchema<serializers.webhooks.UpdateWebhookRequest.Raw, AgentMail.webhooks.UpdateWebhookRequest>;
@@ -10,5 +11,6 @@ export declare namespace UpdateWebhookRequest {
         remove_inbox_ids?: InboxIds.Raw | null;
         add_pod_ids?: PodIds.Raw | null;
         remove_pod_ids?: PodIds.Raw | null;
+        event_types?: EventTypes.Raw | null;
     }
 }

package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.mjs

@@ -1,5 +1,6 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
+import { EventTypes } from "../../events/types/EventTypes.mjs";
 import { InboxIds } from "../../events/types/InboxIds.mjs";
 import { PodIds } from "../../events/types/PodIds.mjs";
 export const UpdateWebhookRequest = core.serialization.object({
@@ -7,4 +8,5 @@ export const UpdateWebhookRequest = core.serialization.object({
     removeInboxIds: core.serialization.property("remove_inbox_ids", InboxIds.optional()),
     addPodIds: core.serialization.property("add_pod_ids", PodIds.optional()),
     removePodIds: core.serialization.property("remove_pod_ids", PodIds.optional()),
+    eventTypes: core.serialization.property("event_types", EventTypes.optional()),
 });

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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