agentmail 0.5.29 → 0.5.31

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.29",
-        "User-Agent": "agentmail/0.5.29",
+        "X-Fern-SDK-Version": "0.5.31",
+        "User-Agent": "agentmail/0.5.31",
         "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

@@ -15,6 +15,8 @@ export declare class AgentClient {
      *
      * A 6-digit OTP is sent to the human's email for verification.
      *
+     * `human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint. There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
+     *
      * This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
      *
      * The returned API key has limited permissions until the organization is verified via the verify endpoint.
@@ -31,18 +33,46 @@ export declare class AgentClient {
      *
      * @example
      *     await client.agent.signUp({
-     *         humanEmail: "human_email",
      *         username: "username"
      *     })
      */
     signUp(request: AgentMail.AgentSignupRequest, requestOptions?: AgentClient.RequestOptions): core.HttpResponsePromise<AgentMail.AgentSignupResponse>;
     private __signUp;
+    /**
+     * Attach a human to an unverified agent organization. A 6-digit OTP is sent to the human's email, which you then submit to the verify endpoint.
+     *
+     * Use it after signing up without a `human_email`. Once the human is attached, the organization can send email to that human only, and verification lifts the remaining restrictions. For up to 5 minutes after attaching, sends to the human can still be rejected with a `429` daily send limit error while the API key's cached limits catch up. Wait and retry.
+     *
+     * Calling it again with the same `human_email` does not rotate the API key. It resends the OTP if it was never delivered, or issues a new one if it expired. While the current OTP is still valid, calling it again keeps that OTP and its attempt count. If all 10 attempts are used up, wait until the OTP expires, 24 hours after it was issued, then call it again for a new one.
+     *
+     * Calling it with a different `human_email` replaces the attached human and sends the new human an OTP. An organization can replace its human at most 2 times.
+     *
+     * Only available until the organization is verified.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail agent attach-human --human-email user@example.com
+     * ```
+     *
+     * @param {AgentMail.AgentAttachHumanRequest} request
+     * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.ConflictError}
+     *
+     * @example
+     *     await client.agent.attachHuman({
+     *         humanEmail: "human_email"
+     *     })
+     */
+    attachHuman(request: AgentMail.AgentAttachHumanRequest, requestOptions?: AgentClient.RequestOptions): core.HttpResponsePromise<AgentMail.AgentAttachHumanResponse>;
+    private __attachHuman;
     /**
      * Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
      *
      * 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. 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.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If the OTP expired, call the attach human endpoint with the same `human_email` to get a new one without rotating the API key. Once all 10 attempts are used, even the correct OTP is rejected, and attach human keeps returning the same OTP until it expires, so wait for it to expire before asking for a new one. An organization that signed up without a `human_email` has no OTP until a human is attached. 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

@@ -61,6 +61,8 @@ class AgentClient {
      *
      * A 6-digit OTP is sent to the human's email for verification.
      *
+     * `human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint. There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
+     *
      * This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
      *
      * The returned API key has limited permissions until the organization is verified via the verify endpoint.
@@ -77,7 +79,6 @@ class AgentClient {
      *
      * @example
      *     await client.agent.signUp({
-     *         humanEmail: "human_email",
      *         username: "username"
      *     })
      */
@@ -139,12 +140,106 @@ class AgentClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/agent/sign-up");
         });
     }
+    /**
+     * Attach a human to an unverified agent organization. A 6-digit OTP is sent to the human's email, which you then submit to the verify endpoint.
+     *
+     * Use it after signing up without a `human_email`. Once the human is attached, the organization can send email to that human only, and verification lifts the remaining restrictions. For up to 5 minutes after attaching, sends to the human can still be rejected with a `429` daily send limit error while the API key's cached limits catch up. Wait and retry.
+     *
+     * Calling it again with the same `human_email` does not rotate the API key. It resends the OTP if it was never delivered, or issues a new one if it expired. While the current OTP is still valid, calling it again keeps that OTP and its attempt count. If all 10 attempts are used up, wait until the OTP expires, 24 hours after it was issued, then call it again for a new one.
+     *
+     * Calling it with a different `human_email` replaces the attached human and sends the new human an OTP. An organization can replace its human at most 2 times.
+     *
+     * Only available until the organization is verified.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail agent attach-human --human-email user@example.com
+     * ```
+     *
+     * @param {AgentMail.AgentAttachHumanRequest} request
+     * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.ConflictError}
+     *
+     * @example
+     *     await client.agent.attachHuman({
+     *         humanEmail: "human_email"
+     *     })
+     */
+    attachHuman(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__attachHuman(request, requestOptions));
+    }
+    __attachHuman(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AgentMailEnvironment.Prod)
+                    .http, "/v0/agent/human"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.AgentAttachHumanRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.AgentAttachHumanResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new AgentMail.ValidationError(serializers.ValidationErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            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,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/agent/human");
+        });
+    }
     /**
      * Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
      *
      * 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. 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.
+     * The OTP expires after 24 hours and allows a maximum of 10 attempts. If the OTP expired, call the attach human endpoint with the same `human_email` to get a new one without rotating the API key. Once all 10 attempts are used, even the correct OTP is rejected, and attach human keeps returning the same OTP until it expires, so wait for it to expire before asking for a new one. An organization that signed up without a `human_email` has no OTP until a human is attached. 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/types/AgentAttachHumanRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Request body to attach a human to an agent organization.
+ */
+export interface AgentAttachHumanRequest {
+    /** Email address of the human who owns the agent. A 6-digit OTP will be sent to this address. */
+    humanEmail: string;
+}

package/dist/cjs/api/resources/agent/types/AgentAttachHumanRequest.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/agent/types/AgentAttachHumanResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response after attaching a human to an agent organization.
+ */
+export interface AgentAttachHumanResponse {
+    /** Email address of the attached human. */
+    humanEmail: string;
+    /** Next steps for the agent, in plain text. */
+    instructions: string;
+}

package/dist/cjs/api/resources/agent/types/AgentAttachHumanResponse.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/agent/types/AgentSignupRequest.d.ts

@@ -2,8 +2,11 @@
  * Request body to sign up an agent.
  */
 export interface AgentSignupRequest {
-    /** Email address of the human who owns the agent. A 6-digit OTP will be sent to this address. */
-    humanEmail: string;
+    /**
+     * Email address of the human who owns the agent. A 6-digit OTP will be sent to this address.
+     * Omit it to get a receive-only inbox: it can receive email but cannot send until a human is attached with the attach human endpoint.
+     */
+    humanEmail?: string;
     /** Username for the auto-created inbox (e.g. "my-agent" creates my-agent@agentmail.to). */
     username: string;
     /**

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

@@ -1,3 +1,5 @@
+export * from "./AgentAttachHumanRequest.js";
+export * from "./AgentAttachHumanResponse.js";
 export * from "./AgentSignupRequest.js";
 export * from "./AgentSignupResponse.js";
 export * from "./AgentVerifyRequest.js";

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

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AgentAttachHumanRequest.js"), exports);
+__exportStar(require("./AgentAttachHumanResponse.js"), exports);
 __exportStar(require("./AgentSignupRequest.js"), exports);
 __exportStar(require("./AgentSignupResponse.js"), exports);
 __exportStar(require("./AgentVerifyRequest.js"), exports);

package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts

@@ -87,6 +87,8 @@ export interface ApiKeyPermissions {
     podRead?: boolean;
     /** Create pods. */
     podCreate?: boolean;
+    /** Update pods. */
+    podUpdate?: boolean;
     /** Delete pods. */
     podDelete?: boolean;
 }

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

@@ -53,4 +53,32 @@ export declare class MetricsClient {
      */
     queryUsage(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.QueryUsageRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryUsageResponse>;
     private __queryUsage;
+    /**
+     * Rolling bounce and complaint rates for the inbox. At each `period`
+     * grid point, the bounced (or complained) messages over the preceding
+     * `window` divided by the messages sent over the same window, with the
+     * send count alongside. Account moderation evaluates the organization-wide
+     * rate, so use the organization endpoint to see the number it acts on;
+     * the inbox view shows which inboxes contribute. Defaults to the rolling
+     * 24-hour rate sampled hourly over the last day; `start` must be within
+     * the last 90 days, `window` must be a whole multiple of `period`, and
+     * the range plus window divided by `period` must not exceed 1000
+     * buckets.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes metrics query-rates --inbox-id <inbox_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.QueryRatesRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.inboxes.metrics.queryRates("inbox_id")
+     */
+    queryRates(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.QueryRatesRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryRatesResponse>;
+    private __queryRates;
 }

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

@@ -238,5 +238,103 @@ class MetricsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics/usage");
         });
     }
+    /**
+     * Rolling bounce and complaint rates for the inbox. At each `period`
+     * grid point, the bounced (or complained) messages over the preceding
+     * `window` divided by the messages sent over the same window, with the
+     * send count alongside. Account moderation evaluates the organization-wide
+     * rate, so use the organization endpoint to see the number it acts on;
+     * the inbox view shows which inboxes contribute. Defaults to the rolling
+     * 24-hour rate sampled hourly over the last day; `start` must be within
+     * the last 90 days, `window` must be a whole multiple of `period`, and
+     * the range plus window divided by `period` must not exceed 1000
+     * buckets.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes metrics query-rates --inbox-id <inbox_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.QueryRatesRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.inboxes.metrics.queryRates("inbox_id")
+     */
+    queryRates(inbox_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryRates(inbox_id, request, requestOptions));
+    }
+    __queryRates(inbox_id_1) {
+        return __awaiter(this, arguments, void 0, function* (inbox_id, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { rateTypes, start, end, period, window, limit, descending } = request;
+            const _queryParams = {
+                rate_types: rateTypes != null
+                    ? (0, json_js_1.toJson)(serializers.RateTypes.jsonOrThrow(rateTypes, {
+                        unrecognizedObjectKeys: "strip",
+                        omitUndefined: true,
+                    }))
+                    : undefined,
+                start: start != null
+                    ? serializers.Start.jsonOrThrow(start, { unrecognizedObjectKeys: "strip", omitUndefined: true })
+                    : undefined,
+                end: end != null
+                    ? serializers.End.jsonOrThrow(end, { unrecognizedObjectKeys: "strip", omitUndefined: true })
+                    : undefined,
+                period,
+                window,
+                limit,
+                descending,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AgentMailEnvironment.Prod)
+                    .http, `/v0/inboxes/${core.url.encodePathParam(serializers.inboxes.InboxId.jsonOrThrow(inbox_id, { omitUndefined: true }))}/metrics/rates`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.QueryRatesResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    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,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics/rates");
+        });
+    }
 }
 exports.MetricsClient = MetricsClient;

package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as AgentMail from "../../../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface QueryRatesRequest {
+    rateTypes?: AgentMail.RateTypes;
+    start?: AgentMail.Start;
+    end?: AgentMail.End;
+    period?: AgentMail.RatePeriod;
+    window?: AgentMail.Window;
+    limit?: AgentMail.MetricLimit;
+    descending?: AgentMail.Descending;
+}

package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.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/resources/metrics/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export type { QueryEventsRequest } from "./QueryEventsRequest.js";
+export type { QueryRatesRequest } from "./QueryRatesRequest.js";
 export type { QueryUsageRequest } from "./QueryUsageRequest.js";

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

@@ -49,4 +49,32 @@ export declare class MetricsClient {
      */
     queryUsage(request?: AgentMail.QueryUsageRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryUsageResponse>;
     private __queryUsage;
+    /**
+     * Rolling bounce and complaint rates for the organization. At each
+     * `period` grid point, the bounced (or complained) messages over the
+     * preceding `window` divided by the messages sent over the same window,
+     * with the send count alongside so you can see the volume behind
+     * it. This is the number AgentMail's account moderation acts on: a
+     * warning at a 5% bounce rate and suspension at 10%, evaluated over a
+     * rolling 24 hours once at least 1,000 messages were sent in that
+     * window. Defaults to the rolling 24-hour rate sampled hourly over the
+     * last day; `start` must be within the last 90 days, `window` must be a
+     * whole multiple of `period`, and the range plus window divided by
+     * `period` must not exceed 1000 buckets.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail metrics query-rates
+     * ```
+     *
+     * @param {AgentMail.QueryRatesRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.metrics.queryRates()
+     */
+    queryRates(request?: AgentMail.QueryRatesRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryRatesResponse>;
+    private __queryRates;
 }

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

@@ -234,5 +234,103 @@ class MetricsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/metrics/usage");
         });
     }
+    /**
+     * Rolling bounce and complaint rates for the organization. At each
+     * `period` grid point, the bounced (or complained) messages over the
+     * preceding `window` divided by the messages sent over the same window,
+     * with the send count alongside so you can see the volume behind
+     * it. This is the number AgentMail's account moderation acts on: a
+     * warning at a 5% bounce rate and suspension at 10%, evaluated over a
+     * rolling 24 hours once at least 1,000 messages were sent in that
+     * window. Defaults to the rolling 24-hour rate sampled hourly over the
+     * last day; `start` must be within the last 90 days, `window` must be a
+     * whole multiple of `period`, and the range plus window divided by
+     * `period` must not exceed 1000 buckets.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail metrics query-rates
+     * ```
+     *
+     * @param {AgentMail.QueryRatesRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.metrics.queryRates()
+     */
+    queryRates(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryRates(request, requestOptions));
+    }
+    __queryRates() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { rateTypes, start, end, period, window, limit, descending } = request;
+            const _queryParams = {
+                rate_types: rateTypes != null
+                    ? (0, json_js_1.toJson)(serializers.RateTypes.jsonOrThrow(rateTypes, {
+                        unrecognizedObjectKeys: "strip",
+                        omitUndefined: true,
+                    }))
+                    : undefined,
+                start: start != null
+                    ? serializers.Start.jsonOrThrow(start, { unrecognizedObjectKeys: "strip", omitUndefined: true })
+                    : undefined,
+                end: end != null
+                    ? serializers.End.jsonOrThrow(end, { unrecognizedObjectKeys: "strip", omitUndefined: true })
+                    : undefined,
+                period,
+                window,
+                limit,
+                descending,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AgentMailEnvironment.Prod)
+                    .http, "/v0/metrics/rates"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.QueryRatesResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    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,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/metrics/rates");
+        });
+    }
 }
 exports.MetricsClient = MetricsClient;

package/dist/cjs/api/resources/metrics/client/requests/QueryRatesRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as AgentMail from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface QueryRatesRequest {
+    rateTypes?: AgentMail.RateTypes;
+    start?: AgentMail.Start;
+    end?: AgentMail.End;
+    period?: AgentMail.RatePeriod;
+    window?: AgentMail.Window;
+    limit?: AgentMail.MetricLimit;
+    descending?: AgentMail.Descending;
+}

package/dist/cjs/api/resources/metrics/client/requests/QueryRatesRequest.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/metrics/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export type { QueryEventsRequest } from "./QueryEventsRequest.js";
+export type { QueryRatesRequest } from "./QueryRatesRequest.js";
 export type { QueryUsageRequest } from "./QueryUsageRequest.js";

package/dist/cjs/api/resources/metrics/types/QueryRatesResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * Rate series grouped by rate type.
+ */
+export type QueryRatesResponse = Partial<Record<AgentMail.RateType, AgentMail.RatePoint[]>>;

package/dist/cjs/api/resources/metrics/types/QueryRatesResponse.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/metrics/types/RatePeriod.d.ts

@@ -0,0 +1,5 @@
+/**
+ * How often a point is sampled, as a whole number of seconds between 60
+ * and 86400. Defaults to 3600 (one point per hour).
+ */
+export type RatePeriod = number;

package/dist/cjs/api/resources/metrics/types/RatePeriod.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/metrics/types/RatePoint.d.ts

@@ -0,0 +1,12 @@
+export interface RatePoint {
+    /** End of the window the point covers; the window is the `window` seconds before it. */
+    timestamp: Date;
+    /**
+     * Bounced or complained messages divided by messages sent over the
+     * window, as a fraction (0.05 is 5%). Null when nothing was sent in
+     * the window.
+     */
+    rate?: number;
+    /** Messages sent in the window, counted per recipient. */
+    sent: number;
+}

package/dist/cjs/api/resources/metrics/types/RatePoint.js

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