agentmail 0.5.45 → 0.5.46

package/dist/cjs/api/resources/files/types/File_.d.ts

@@ -0,0 +1,14 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * A file. A `ready` file returned to a caller with the `file_read` permission carries a signed `download_url`.
+ */
+export interface File_ extends AgentMail.FileItem {
+    /**
+     * A signed URL that downloads the file's bytes, named by `name`. No API key is needed to use it, so treat it
+     * as a secret. It works until `download_expires_at`, at most an hour, even after the file is deleted. Get the
+     * file again for a fresh one.
+     */
+    downloadUrl?: string;
+    /** When `download_url` stops working. Never after the file's own expiry. */
+    downloadExpiresAt?: Date;
+}

package/dist/cjs/api/resources/files/types/File_.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/files/types/ListFilesResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../index.js";
+export interface ListFilesResponse {
+    count: AgentMail.Count;
+    limit: AgentMail.Limit;
+    nextPageToken?: AgentMail.PageToken;
+    /** The inbox's files in path order. A list has no download URLs; get a file for one. */
+    files: AgentMail.FileItem[];
+}

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

@@ -0,0 +1,14 @@
+export * from "./CreateFileRequest.js";
+export * from "./CreateFileResponse.js";
+export * from "./File_.js";
+export * from "./FileContentType.js";
+export * from "./FileExpiresAt.js";
+export * from "./FileId.js";
+export * from "./FileItem.js";
+export * from "./FileName.js";
+export * from "./FilePath.js";
+export * from "./FileSha256.js";
+export * from "./FileSize.js";
+export * from "./FileStatus.js";
+export * from "./FileUpload.js";
+export * from "./ListFilesResponse.js";

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

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __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("./CreateFileRequest.js"), exports);
+__exportStar(require("./CreateFileResponse.js"), exports);
+__exportStar(require("./File_.js"), exports);
+__exportStar(require("./FileContentType.js"), exports);
+__exportStar(require("./FileExpiresAt.js"), exports);
+__exportStar(require("./FileId.js"), exports);
+__exportStar(require("./FileItem.js"), exports);
+__exportStar(require("./FileName.js"), exports);
+__exportStar(require("./FilePath.js"), exports);
+__exportStar(require("./FileSha256.js"), exports);
+__exportStar(require("./FileSize.js"), exports);
+__exportStar(require("./FileStatus.js"), exports);
+__exportStar(require("./FileUpload.js"), exports);
+__exportStar(require("./ListFilesResponse.js"), exports);

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

@@ -7,6 +7,7 @@ import { ApiKeysClient } from "../resources/apiKeys/client/Client.js";
 import { CalendarClient } from "../resources/calendar/client/Client.js";
 import { DraftsClient } from "../resources/drafts/client/Client.js";
 import { EventsClient } from "../resources/events/client/Client.js";
+import { FilesClient } from "../resources/files/client/Client.js";
 import { ListsClient } from "../resources/lists/client/Client.js";
 import { MessagesClient } from "../resources/messages/client/Client.js";
 import { MetricsClient } from "../resources/metrics/client/Client.js";
@@ -29,6 +30,7 @@ export declare class InboxesClient {
     protected _apiKeys: ApiKeysClient | undefined;
     protected _accounts: AccountsClient | undefined;
     protected _calendar: CalendarClient | undefined;
+    protected _files: FilesClient | undefined;
     constructor(options?: InboxesClient.Options);
     get threads(): ThreadsClient;
     get messages(): MessagesClient;
@@ -40,6 +42,7 @@ export declare class InboxesClient {
     get apiKeys(): ApiKeysClient;
     get accounts(): AccountsClient;
     get calendar(): CalendarClient;
+    get files(): FilesClient;
     /**
      * **CLI:**
      * ```bash

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

@@ -57,22 +57,23 @@ const Client_js_2 = require("../resources/apiKeys/client/Client.js");
 const Client_js_3 = require("../resources/calendar/client/Client.js");
 const Client_js_4 = require("../resources/drafts/client/Client.js");
 const Client_js_5 = require("../resources/events/client/Client.js");
-const Client_js_6 = require("../resources/lists/client/Client.js");
-const Client_js_7 = require("../resources/messages/client/Client.js");
-const Client_js_8 = require("../resources/metrics/client/Client.js");
-const Client_js_9 = require("../resources/threads/client/Client.js");
-const Client_js_10 = require("../resources/webhooks/client/Client.js");
+const Client_js_6 = require("../resources/files/client/Client.js");
+const Client_js_7 = require("../resources/lists/client/Client.js");
+const Client_js_8 = require("../resources/messages/client/Client.js");
+const Client_js_9 = require("../resources/metrics/client/Client.js");
+const Client_js_10 = require("../resources/threads/client/Client.js");
+const Client_js_11 = require("../resources/webhooks/client/Client.js");
 class InboxesClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     get threads() {
         var _a;
-        return ((_a = this._threads) !== null && _a !== void 0 ? _a : (this._threads = new Client_js_9.ThreadsClient(this._options)));
+        return ((_a = this._threads) !== null && _a !== void 0 ? _a : (this._threads = new Client_js_10.ThreadsClient(this._options)));
     }
     get messages() {
         var _a;
-        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_7.MessagesClient(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_8.MessagesClient(this._options)));
     }
     get drafts() {
         var _a;
@@ -80,15 +81,15 @@ class InboxesClient {
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_10.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_11.WebhooksClient(this._options)));
     }
     get lists() {
         var _a;
-        return ((_a = this._lists) !== null && _a !== void 0 ? _a : (this._lists = new Client_js_6.ListsClient(this._options)));
+        return ((_a = this._lists) !== null && _a !== void 0 ? _a : (this._lists = new Client_js_7.ListsClient(this._options)));
     }
     get metrics() {
         var _a;
-        return ((_a = this._metrics) !== null && _a !== void 0 ? _a : (this._metrics = new Client_js_8.MetricsClient(this._options)));
+        return ((_a = this._metrics) !== null && _a !== void 0 ? _a : (this._metrics = new Client_js_9.MetricsClient(this._options)));
     }
     get events() {
         var _a;
@@ -106,6 +107,10 @@ class InboxesClient {
         var _a;
         return ((_a = this._calendar) !== null && _a !== void 0 ? _a : (this._calendar = new Client_js_3.CalendarClient(this._options)));
     }
+    get files() {
+        var _a;
+        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_6.FilesClient(this._options)));
+    }
     /**
      * **CLI:**
      * ```bash

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

@@ -0,0 +1,156 @@
+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 FilesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class FilesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<FilesClient.Options>;
+    constructor(options?: FilesClient.Options);
+    /**
+     * @beta This endpoint is in pre-release and may change.
+     *
+     * Starts an upload: creates a pending file at `path` and returns an `upload` to `PUT` its bytes to. The bytes go
+     * straight to storage, not through the API. Then call Complete File to make the file `ready`.
+     *
+     * Retry-safe: sending the identical request again (same `path`, `size`, `sha256`, `content_type` and
+     * `expires_at`) returns the existing file with `200` instead of `201`: a pending one with a fresh `upload`, or
+     * a `ready` one without. If its bytes were uploaded but the upload was never completed, it is completed then. A
+     * different request at a path whose file is still pending and has no bytes replaces that file; at any other
+     * taken path it returns `409`.
+     *
+     * The file counts against the organization's Drive quota from creation, pending or not: 1 GiB and 10,000 files
+     * by default. A file that doesn't fit returns `403` with code `limit_exceeded`. Deleting a file frees its
+     * space within seconds. Expired files count until a create needs their space: a create that doesn't fit first
+     * gives back what expired files hold, a batch at a time, so retry a refusal while many expired files remain.
+     *
+     * Requires the `file_create` permission, which an unverified organization's keys don't have at any scope until
+     * it completes agent verification. A key without `file_read` can still create files, but gets the plain `409` at
+     * any taken path, even for an identical request at a file it didn't create.
+     *
+     * Agent Drive is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet in EU
+     * production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.CreateFileRequestWrapper} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.FileForbiddenError}
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ConflictError}
+     *
+     * @example
+     *     await client.inboxes.files.create("reports@agentmail.to", {
+     *         path: "reports/q3.pdf",
+     *         size: 48213,
+     *         sha256: "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
+     *         contentType: "application/pdf"
+     *     })
+     */
+    create(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.CreateFileRequestWrapper, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<AgentMail.CreateFileResponse>;
+    private __create;
+    /**
+     * @beta This endpoint is in pre-release and may change.
+     *
+     * Makes a pending file `ready` once its bytes are uploaded, and returns it, with its `download_url` if the key
+     * has `file_read`. Calling it on a file that is already `ready` returns the file.
+     *
+     * Returns `409` if the bytes haven't been uploaded yet, or if what was uploaded doesn't match the file's `size`
+     * and `sha256`. Returns `404` for a file that has expired or was deleted, including a pending file not
+     * completed within a day of its creation.
+     *
+     * Requires the `file_create` permission. Only a key with `file_read`, or the key that created the file, can
+     * complete it; any other key gets `404`.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.FileId} file_id
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.FileForbiddenError}
+     * @throws {@link AgentMail.NotFoundError}
+     * @throws {@link AgentMail.ConflictError}
+     *
+     * @example
+     *     await client.inboxes.files.complete("reports@agentmail.to", "6f1c2f4e-8d3b-4a5e-9c7d-1b2a3c4d5e6f")
+     */
+    complete(inbox_id: AgentMail.inboxes.InboxId, file_id: AgentMail.FileId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<AgentMail.File_>;
+    private __complete;
+    /**
+     * @beta This endpoint is in pre-release and may change.
+     *
+     * Gets a file. A `ready` file comes with a fresh `download_url`, valid for up to an hour.
+     *
+     * A get reads the region that serves the request, so for about a second after a delete it can still return
+     * the deleted file. A file that has expired returns `404` at once.
+     *
+     * Requires the `file_read` permission.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.FileId} file_id
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.FileForbiddenError}
+     * @throws {@link AgentMail.NotFoundError}
+     *
+     * @example
+     *     await client.inboxes.files.get("reports@agentmail.to", "6f1c2f4e-8d3b-4a5e-9c7d-1b2a3c4d5e6f")
+     */
+    get(inbox_id: AgentMail.inboxes.InboxId, file_id: AgentMail.FileId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<AgentMail.File_>;
+    private __get;
+    /**
+     * @beta This endpoint is in pre-release and may change.
+     *
+     * Lists the inbox's files in path order, pending ones included, optionally only those whose path starts with
+     * `path_prefix`. A prefix matches characters, not whole segments: `reports/q` matches `reports/q3.pdf`. Items
+     * carry no download URL; get a file for one.
+     *
+     * The list is read in the region that serves the request, so a file created or deleted a moment ago may not
+     * show yet. Expired files never show.
+     *
+     * Requires the `file_read` permission.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.inboxes.ListFilesRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.FileForbiddenError}
+     * @throws {@link AgentMail.NotFoundError}
+     *
+     * @example
+     *     await client.inboxes.files.list("reports@agentmail.to", {
+     *         pathPrefix: "reports/"
+     *     })
+     */
+    list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListFilesRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListFilesResponse>;
+    private __list;
+    /**
+     * @beta This endpoint is in pre-release and may change.
+     *
+     * Deletes a file, pending or `ready`, and frees its path at once. Its bytes are deleted, and its space given
+     * back to the organization's quota, within seconds. A download URL signed before the delete keeps working
+     * until it expires, at most an hour. Deleting a file that is already gone returns `404`.
+     *
+     * Requires the `file_delete` permission. Only a key with `file_read`, or the key that created the file, can
+     * delete it; any other key gets `404`.
+     *
+     * @param {AgentMail.inboxes.InboxId} inbox_id
+     * @param {AgentMail.FileId} file_id
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AgentMail.ValidationError}
+     * @throws {@link AgentMail.FileForbiddenError}
+     * @throws {@link AgentMail.NotFoundError}
+     *
+     * @example
+     *     await client.inboxes.files.delete("reports@agentmail.to", "6f1c2f4e-8d3b-4a5e-9c7d-1b2a3c4d5e6f")
+     */
+    delete(inbox_id: AgentMail.inboxes.InboxId, file_id: AgentMail.FileId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+}