agentmail 0.5.11 → 0.5.12

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

@@ -22,24 +22,30 @@ export class MetricsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Counts of email events (sent, delivered, bounced, etc.) over time for
+     * the inbox. Defaults to the last 24 hours; `start` must be within the
+     * last 90 days, and a future `end` is clamped to now. Omit `period` for
+     * individual event counts, or set it to sum counts into buckets of that
+     * many seconds.
+     *
      * **CLI:**
      * ```bash
      * agentmail inboxes:metrics query --inbox-id <inbox_id>
      * ```
      *
      * @param {AgentMail.inboxes.InboxId} inbox_id
-     * @param {AgentMail.inboxes.QueryMetricsRequest} request
+     * @param {AgentMail.inboxes.QueryEventsRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.inboxes.metrics.query("inbox_id")
+     *     await client.inboxes.metrics.queryEvents("inbox_id")
      */
-    query(inbox_id, request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__query(inbox_id, request, requestOptions));
+    queryEvents(inbox_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryEvents(inbox_id, request, requestOptions));
     }
-    __query(inbox_id_1) {
+    __queryEvents(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 { eventTypes, start, end, period, limit, descending } = request;
@@ -64,7 +70,7 @@ export class MetricsClient {
             const _headers = 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`),
+                    .http, `/v0/inboxes/${core.url.encodePathParam(serializers.inboxes.InboxId.jsonOrThrow(inbox_id, { omitUndefined: true }))}/metrics/events`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -104,7 +110,96 @@ export class MetricsClient {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics");
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics/events");
+        });
+    }
+    /**
+     * Cumulative usage series for the inbox. Each point is the running total
+     * of the usage type at that timestamp, not the change within the bucket.
+     * Inbox-scoped queries carry `storage_bytes`, `message_count`, and
+     * `thread_count`; requested types that don't apply to the scope are
+     * ignored. Defaults to the last 24 hours; `start` must be within the
+     * last 90 days, and a future `end` is clamped to now. The range divided
+     * by `period` must not exceed 1000 buckets.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.QueryUsageRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.inboxes.metrics.queryUsage("inbox_id")
+     */
+    queryUsage(inbox_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryUsage(inbox_id, request, requestOptions));
+    }
+    __queryUsage(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 { usageTypes, start, end, period, limit, descending } = request;
+            const _queryParams = {
+                usage_types: usageTypes != null
+                    ? toJson(serializers.UsageTypes.jsonOrThrow(usageTypes, {
+                        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,
+                limit,
+                descending,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = 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/usage`),
+                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.QueryUsageResponse.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 handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics/usage");
         });
     }
 }

package/dist/esm/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.d.mts → inboxes/resources/metrics/client/requests/QueryEventsRequest.d.mts}

@@ -3,7 +3,7 @@ import type * as AgentMail from "../../../../../../index.mjs";
  * @example
  *     {}
  */
-export interface QueryMetricsRequest {
+export interface QueryEventsRequest {
     eventTypes?: AgentMail.MetricEventTypes;
     start?: AgentMail.Start;
     end?: AgentMail.End;

package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.d.mts

@@ -0,0 +1,13 @@
+import type * as AgentMail from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface QueryUsageRequest {
+    usageTypes?: AgentMail.UsageTypes;
+    start?: AgentMail.Start;
+    end?: AgentMail.End;
+    period?: AgentMail.Period;
+    limit?: AgentMail.MetricLimit;
+    descending?: AgentMail.Descending;
+}

package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/index.d.mts

@@ -1 +1,2 @@
-export type { QueryMetricsRequest } from "./QueryMetricsRequest.mjs";
+export type { QueryEventsRequest } from "./QueryEventsRequest.mjs";
+export type { QueryUsageRequest } from "./QueryUsageRequest.mjs";

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

@@ -11,19 +11,42 @@ export declare class MetricsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<MetricsClient.Options>;
     constructor(options?: MetricsClient.Options);
     /**
+     * Counts of email events (sent, delivered, bounced, etc.) over time for
+     * the organization. Defaults to the last 24 hours; `start` must be within
+     * the last 90 days, and a future `end` is clamped to now. Omit `period`
+     * for individual event counts, or set it to sum counts into buckets of
+     * that many seconds.
+     *
      * **CLI:**
      * ```bash
      * agentmail metrics list
      * ```
      *
-     * @param {AgentMail.QueryMetricsRequest} request
+     * @param {AgentMail.QueryEventsRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.metrics.queryEvents()
+     */
+    queryEvents(request?: AgentMail.QueryEventsRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryMetricsResponse>;
+    private __queryEvents;
+    /**
+     * Cumulative usage series for the organization. Each point is the running
+     * total of the usage type at that timestamp, not the change within the
+     * bucket. Defaults to the last 24 hours; `start` must be within the last
+     * 90 days, and a future `end` is clamped to now. The range divided by
+     * `period` must not exceed 1000 buckets.
+     *
+     * @param {AgentMail.QueryUsageRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.metrics.query()
+     *     await client.metrics.queryUsage()
      */
-    query(request?: AgentMail.QueryMetricsRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryMetricsResponse>;
-    private __query;
+    queryUsage(request?: AgentMail.QueryUsageRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryUsageResponse>;
+    private __queryUsage;
 }

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

@@ -22,23 +22,29 @@ export class MetricsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Counts of email events (sent, delivered, bounced, etc.) over time for
+     * the organization. Defaults to the last 24 hours; `start` must be within
+     * the last 90 days, and a future `end` is clamped to now. Omit `period`
+     * for individual event counts, or set it to sum counts into buckets of
+     * that many seconds.
+     *
      * **CLI:**
      * ```bash
      * agentmail metrics list
      * ```
      *
-     * @param {AgentMail.QueryMetricsRequest} request
+     * @param {AgentMail.QueryEventsRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.metrics.query()
+     *     await client.metrics.queryEvents()
      */
-    query(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__query(request, requestOptions));
+    queryEvents(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryEvents(request, requestOptions));
     }
-    __query() {
+    __queryEvents() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { eventTypes, start, end, period, limit, descending } = request;
@@ -63,7 +69,7 @@ export class MetricsClient {
             const _headers = 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"),
+                    .http, "/v0/metrics/events"),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -103,7 +109,93 @@ export class MetricsClient {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/metrics");
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/metrics/events");
+        });
+    }
+    /**
+     * Cumulative usage series for the organization. Each point is the running
+     * total of the usage type at that timestamp, not the change within the
+     * bucket. Defaults to the last 24 hours; `start` must be within the last
+     * 90 days, and a future `end` is clamped to now. The range divided by
+     * `period` must not exceed 1000 buckets.
+     *
+     * @param {AgentMail.QueryUsageRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.metrics.queryUsage()
+     */
+    queryUsage(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__queryUsage(request, requestOptions));
+    }
+    __queryUsage() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { usageTypes, start, end, period, limit, descending } = request;
+            const _queryParams = {
+                usage_types: usageTypes != null
+                    ? toJson(serializers.UsageTypes.jsonOrThrow(usageTypes, {
+                        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,
+                limit,
+                descending,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = 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/usage"),
+                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.QueryUsageResponse.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 handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v0/metrics/usage");
         });
     }
 }

package/dist/esm/api/resources/metrics/client/requests/{QueryMetricsRequest.d.mts → QueryEventsRequest.d.mts}

@@ -3,7 +3,7 @@ import type * as AgentMail from "../../../../index.mjs";
  * @example
  *     {}
  */
-export interface QueryMetricsRequest {
+export interface QueryEventsRequest {
     eventTypes?: AgentMail.MetricEventTypes;
     start?: AgentMail.Start;
     end?: AgentMail.End;

package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.d.mts

@@ -0,0 +1,13 @@
+import type * as AgentMail from "../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface QueryUsageRequest {
+    usageTypes?: AgentMail.UsageTypes;
+    start?: AgentMail.Start;
+    end?: AgentMail.End;
+    period?: AgentMail.Period;
+    limit?: AgentMail.MetricLimit;
+    descending?: AgentMail.Descending;
+}

package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.mjs

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

package/dist/esm/api/resources/metrics/client/requests/index.d.mts

@@ -1 +1,2 @@
-export type { QueryMetricsRequest } from "./QueryMetricsRequest.mjs";
+export type { QueryEventsRequest } from "./QueryEventsRequest.mjs";
+export type { QueryUsageRequest } from "./QueryUsageRequest.mjs";

package/dist/esm/api/resources/metrics/types/MetricEventType.d.mts

@@ -1,11 +1,14 @@
 /** Type of metric event. */
 export declare const MetricEventType: {
+    readonly MessageReceived: "message.received";
+    readonly MessageReceivedSpam: "message.received.spam";
+    readonly MessageReceivedBlocked: "message.received.blocked";
+    readonly MessageReceivedUnauthenticated: "message.received.unauthenticated";
     readonly MessageSent: "message.sent";
     readonly MessageDelivered: "message.delivered";
     readonly MessageBounced: "message.bounced";
-    readonly MessageDelayed: "message.delayed";
-    readonly MessageRejected: "message.rejected";
     readonly MessageComplained: "message.complained";
-    readonly MessageReceived: "message.received";
+    readonly MessageRejected: "message.rejected";
+    readonly DomainVerified: "domain.verified";
 };
 export type MetricEventType = (typeof MetricEventType)[keyof typeof MetricEventType];

package/dist/esm/api/resources/metrics/types/MetricEventType.mjs

@@ -1,11 +1,14 @@
 // This file was auto-generated by Fern from our API Definition.
 /** Type of metric event. */
 export const MetricEventType = {
+    MessageReceived: "message.received",
+    MessageReceivedSpam: "message.received.spam",
+    MessageReceivedBlocked: "message.received.blocked",
+    MessageReceivedUnauthenticated: "message.received.unauthenticated",
     MessageSent: "message.sent",
     MessageDelivered: "message.delivered",
     MessageBounced: "message.bounced",
-    MessageDelayed: "message.delayed",
-    MessageRejected: "message.rejected",
     MessageComplained: "message.complained",
-    MessageReceived: "message.received",
+    MessageRejected: "message.rejected",
+    DomainVerified: "domain.verified",
 };

package/dist/esm/api/resources/metrics/types/Period.d.mts

@@ -1,4 +1,4 @@
 /**
- * Period in number of seconds for the query.
+ * Size of each time bucket as a whole number of seconds, between 1 and 86400.
  */
-export type Period = string;
+export type Period = number;

package/dist/esm/api/resources/metrics/types/QueryUsageResponse.d.mts

@@ -0,0 +1,5 @@
+import type * as AgentMail from "../../../index.mjs";
+/**
+ * Cumulative usage series grouped by usage type.
+ */
+export type QueryUsageResponse = Partial<Record<AgentMail.UsageType, AgentMail.UsagePoint[]>>;

package/dist/esm/api/resources/metrics/types/QueryUsageResponse.mjs

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

package/dist/esm/api/resources/metrics/types/UsagePoint.d.mts

@@ -0,0 +1,6 @@
+export interface UsagePoint {
+    /** Timestamp of the point. */
+    timestamp: Date;
+    /** Cumulative value of the usage metric at the timestamp. */
+    value: number;
+}

package/dist/esm/api/resources/metrics/types/UsagePoint.mjs

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

package/dist/esm/api/resources/metrics/types/UsageType.d.mts

@@ -0,0 +1,14 @@
+/**
+ * Type of usage metric. Inbox-scoped queries carry `storage_bytes`,
+ * `message_count`, and `thread_count`; pod-scoped queries add `inbox_count`
+ * and `domain_count`; organization-scoped queries add `pod_count`.
+ */
+export declare const UsageType: {
+    readonly StorageBytes: "storage_bytes";
+    readonly MessageCount: "message_count";
+    readonly ThreadCount: "thread_count";
+    readonly InboxCount: "inbox_count";
+    readonly PodCount: "pod_count";
+    readonly DomainCount: "domain_count";
+};
+export type UsageType = (typeof UsageType)[keyof typeof UsageType];

package/dist/esm/api/resources/metrics/types/UsageType.mjs

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Type of usage metric. Inbox-scoped queries carry `storage_bytes`,
+ * `message_count`, and `thread_count`; pod-scoped queries add `inbox_count`
+ * and `domain_count`; organization-scoped queries add `pod_count`.
+ */
+export const UsageType = {
+    StorageBytes: "storage_bytes",
+    MessageCount: "message_count",
+    ThreadCount: "thread_count",
+    InboxCount: "inbox_count",
+    PodCount: "pod_count",
+    DomainCount: "domain_count",
+};

package/dist/esm/api/resources/metrics/types/UsageTypes.d.mts

@@ -0,0 +1,5 @@
+import type * as AgentMail from "../../../index.mjs";
+/**
+ * List of usage metric types to query. Omit to query every type valid for the scope.
+ */
+export type UsageTypes = AgentMail.UsageType[];

package/dist/esm/api/resources/metrics/types/UsageTypes.mjs

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

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

@@ -6,4 +6,8 @@ export * from "./MetricEventTypes.mjs";
 export * from "./MetricLimit.mjs";
 export * from "./Period.mjs";
 export * from "./QueryMetricsResponse.mjs";
+export * from "./QueryUsageResponse.mjs";
 export * from "./Start.mjs";
+export * from "./UsagePoint.mjs";
+export * from "./UsageType.mjs";
+export * from "./UsageTypes.mjs";

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

@@ -6,4 +6,8 @@ export * from "./MetricEventTypes.mjs";
 export * from "./MetricLimit.mjs";
 export * from "./Period.mjs";
 export * from "./QueryMetricsResponse.mjs";
+export * from "./QueryUsageResponse.mjs";
 export * from "./Start.mjs";
+export * from "./UsagePoint.mjs";
+export * from "./UsageType.mjs";
+export * from "./UsageTypes.mjs";

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

@@ -11,20 +11,46 @@ export declare class MetricsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<MetricsClient.Options>;
     constructor(options?: MetricsClient.Options);
     /**
+     * Counts of email events (sent, delivered, bounced, etc.) over time for
+     * the pod. Defaults to the last 24 hours; `start` must be within the last
+     * 90 days, and a future `end` is clamped to now. Omit `period` for
+     * individual event counts, or set it to sum counts into buckets of that
+     * many seconds.
+     *
      * **CLI:**
      * ```bash
      * agentmail pods:metrics query --pod-id <pod_id>
      * ```
      *
      * @param {AgentMail.pods.PodId} pod_id
-     * @param {AgentMail.pods.QueryMetricsRequest} request
+     * @param {AgentMail.pods.QueryEventsRequest} request
+     * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.pods.metrics.queryEvents("pod_id")
+     */
+    queryEvents(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.QueryEventsRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryMetricsResponse>;
+    private __queryEvents;
+    /**
+     * Cumulative usage series for the pod. Each point is the running total of
+     * the usage type at that timestamp, not the change within the bucket.
+     * Pod-scoped queries carry every usage type except `pod_count`; requested
+     * types that don't apply to the scope are ignored. Defaults to the last
+     * 24 hours; `start` must be within the last 90 days, and a future `end`
+     * is clamped to now. The range divided by `period` must not exceed 1000
+     * buckets.
+     *
+     * @param {AgentMail.pods.PodId} pod_id
+     * @param {AgentMail.pods.QueryUsageRequest} request
      * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.pods.metrics.query("pod_id")
+     *     await client.pods.metrics.queryUsage("pod_id")
      */
-    query(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.QueryMetricsRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryMetricsResponse>;
-    private __query;
+    queryUsage(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.QueryUsageRequest, requestOptions?: MetricsClient.RequestOptions): core.HttpResponsePromise<AgentMail.QueryUsageResponse>;
+    private __queryUsage;
 }