agentmail 0.5.11 → 0.5.13

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

@@ -58,24 +58,30 @@ class MetricsClient {
         this._options = (0, BaseClient_js_1.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;
@@ -100,7 +106,7 @@ class MetricsClient {
             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`),
+                    .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),
@@ -140,7 +146,96 @@ class MetricsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics");
+            return (0, handleNonStatusCodeError_js_1.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
+                    ? (0, json_js_1.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 = (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/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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v0/inboxes/{inbox_id}/metrics/usage");
         });
     }
 }

package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts}

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

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

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

package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.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 +1,2 @@
-export type { QueryMetricsRequest } from "./QueryMetricsRequest.js";
+export type { QueryEventsRequest } from "./QueryEventsRequest.js";
+export type { QueryUsageRequest } from "./QueryUsageRequest.js";

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

@@ -0,0 +1,103 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as AgentMail from "../../../../../index.js";
+export declare namespace WebhooksClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class WebhooksClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WebhooksClient.Options>;
+    constructor(options?: WebhooksClient.Options);
+    /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:webhooks list --inbox-id <inbox_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.InboxListWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.inboxes.webhooks.list("inbox_id")
+     */
+    list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.InboxListWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.ListWebhooksResponse>;
+    private __list;
+    /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:webhooks get --inbox-id <inbox_id> --webhook-id <webhook_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.webhooks.WebhookId} webhook_id
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.NotFoundError}
+     *
+     * @example
+     *     await client.inboxes.webhooks.get("inbox_id", "webhook_id")
+     */
+    get(inbox_id: AgentMail.inboxes.InboxId, webhook_id: AgentMail.webhooks.WebhookId, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
+    private __get;
+    /**
+     * Create a webhook scoped to this inbox.
+     *
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:webhooks create --inbox-id <inbox_id> --url https://example.com/webhook --event-type message.received
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.webhooks.CreateInboxWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.inboxes.webhooks.create("inbox_id", {
+     *         url: "url",
+     *         eventTypes: ["message.received", "message.received"]
+     *     })
+     */
+    create(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.webhooks.CreateInboxWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
+    private __create;
+    /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:webhooks update --inbox-id <inbox_id> --webhook-id <webhook_id> --event-type message.received
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.webhooks.WebhookId} webhook_id
+     * @param {AgentMail.webhooks.UpdateInboxWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ValidationError}
+     *
+     * @example
+     *     await client.inboxes.webhooks.update("inbox_id", "webhook_id", {})
+     */
+    update(inbox_id: AgentMail.inboxes.InboxId, webhook_id: AgentMail.webhooks.WebhookId, request: AgentMail.webhooks.UpdateInboxWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
+    private __update;
+    /**
+     * **CLI:**
+     * ```bash
+     * agentmail inboxes:webhooks delete --inbox-id <inbox_id> --webhook-id <webhook_id>
+     * ```
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.webhooks.WebhookId} webhook_id
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.NotFoundError}
+     *
+     * @example
+     *     await client.inboxes.webhooks.delete("inbox_id", "webhook_id")
+     */
+    delete(inbox_id: AgentMail.inboxes.InboxId, webhook_id: AgentMail.webhooks.WebhookId, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+}