agentmail 0.5.44 → 0.5.46

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

@@ -20,6 +20,11 @@ export * from "./MessageOpenedEvent.js";
 export * from "./MessageReceivedEvent.js";
 export * from "./MessageReceivedEventType.js";
 export * from "./MessageRejectedEvent.js";
+export * from "./MessageSecurity.js";
+export * from "./MessageSecurityCompletedEvent.js";
+export * from "./MessageSecurityOverride.js";
+export * from "./MessageSecurityOverrideEvent.js";
+export * from "./MessageSecurityReviewEvent.js";
 export * from "./MessageSentEvent.js";
 export * from "./Open.js";
 export * from "./PodIds.js";

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

@@ -36,6 +36,11 @@ __exportStar(require("./MessageOpenedEvent.js"), exports);
 __exportStar(require("./MessageReceivedEvent.js"), exports);
 __exportStar(require("./MessageReceivedEventType.js"), exports);
 __exportStar(require("./MessageRejectedEvent.js"), exports);
+__exportStar(require("./MessageSecurity.js"), exports);
+__exportStar(require("./MessageSecurityCompletedEvent.js"), exports);
+__exportStar(require("./MessageSecurityOverride.js"), exports);
+__exportStar(require("./MessageSecurityOverrideEvent.js"), exports);
+__exportStar(require("./MessageSecurityReviewEvent.js"), exports);
 __exportStar(require("./MessageSentEvent.js"), exports);
 __exportStar(require("./Open.js"), exports);
 __exportStar(require("./PodIds.js"), exports);

package/dist/cjs/api/resources/files/errors/FileForbiddenError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../../../core/index.js";
+import * as errors from "../../../../errors/index.js";
+import type * as AgentMail from "../../../index.js";
+export declare class FileForbiddenError extends errors.AgentMailError {
+    constructor(body: AgentMail.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/resources/files/errors/FileForbiddenError.js

@@ -0,0 +1,54 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileForbiddenError = void 0;
+const errors = __importStar(require("../../../../errors/index.js"));
+class FileForbiddenError extends errors.AgentMailError {
+    constructor(body, rawResponse) {
+        super({
+            message: "FileForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.FileForbiddenError = FileForbiddenError;

package/dist/cjs/api/resources/files/errors/index.d.ts

@@ -0,0 +1 @@
+export * from "./FileForbiddenError.js";

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

@@ -0,0 +1,17 @@
+"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("./FileForbiddenError.js"), exports);

package/dist/cjs/api/resources/files/exports.d.ts

@@ -0,0 +1 @@
+export * from "./index.js";

package/dist/cjs/api/resources/files/exports.js

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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("./index.js"), exports);

package/dist/cjs/api/resources/files/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./errors/index.js";
+export * from "./types/index.js";

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

@@ -0,0 +1,18 @@
+"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("./errors/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

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

@@ -0,0 +1,12 @@
+import type * as AgentMail from "../../../index.js";
+export interface CreateFileRequest {
+    path: AgentMail.FilePath;
+    size: AgentMail.FileSize;
+    sha256: AgentMail.FileSha256;
+    contentType?: AgentMail.FileContentType;
+    /**
+     * When the file expires, in the future. Rounded up to a whole second and returned in UTC. On a retry, send
+     * the `expires_at` the first response returned.
+     */
+    expiresAt?: AgentMail.FileExpiresAt;
+}

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

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * The created file. A pending file carries `upload`; a create that returns an existing `ready` file does not.
+ */
+export interface CreateFileResponse extends AgentMail.File_ {
+    upload?: AgentMail.FileUpload;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * The file's MIME type, such as `application/pdf`. Defaults to `application/octet-stream`.
+ */
+export type FileContentType = string;

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

@@ -0,0 +1,5 @@
+/**
+ * When the file expires. After it, the file is gone from get and list and its path is free; its bytes are
+ * deleted soon after. Absent for a file that never expires.
+ */
+export type FileExpiresAt = Date;

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

@@ -0,0 +1,4 @@
+/**
+ * ID of the file. A UUID.
+ */
+export type FileId = string;

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

@@ -0,0 +1,20 @@
+import type * as AgentMail from "../../../index.js";
+/**
+ * A file, as a list returns it.
+ */
+export interface FileItem {
+    fileId: AgentMail.FileId;
+    inboxId: AgentMail.inboxes.InboxId;
+    email: AgentMail.inboxes.Email;
+    path: AgentMail.FilePath;
+    name: AgentMail.FileName;
+    size: AgentMail.FileSize;
+    contentType: AgentMail.FileContentType;
+    sha256: AgentMail.FileSha256;
+    status: AgentMail.FileStatus;
+    /** When the file was created. */
+    createdAt: Date;
+    /** When the file last changed, such as when its upload was completed. */
+    updatedAt: Date;
+    expiresAt?: AgentMail.FileExpiresAt;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * The path's last segment. A download saves under this name.
+ */
+export type FileName = string;

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

@@ -0,0 +1,7 @@
+/**
+ * Where the file lives in its inbox's drive, such as `reports/q3.pdf`. Unique within the inbox. Segments are
+ * separated by `/`, with no leading or trailing `/`, no empty, `.` or `..` segment, no `\` and no control or
+ * invisible characters. At most 1,024 bytes, and at most 255 bytes per segment. Stored in Unicode NFC, so two
+ * spellings of one name are one path. Case is kept.
+ */
+export type FilePath = string;

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

@@ -0,0 +1,5 @@
+/**
+ * The base64 encoding of the file's 32-byte SHA-256 digest, as S3's `x-amz-checksum-sha256` takes it (44
+ * characters, ending in `=`). S3 refuses an upload whose bytes don't match.
+ */
+export type FileSha256 = string;

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

@@ -0,0 +1,4 @@
+/**
+ * Size of the file in bytes. At most 104,857,600 (100 MiB).
+ */
+export type FileSize = number;

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

@@ -0,0 +1,9 @@
+/**
+ * `pending` until its bytes are uploaded and the upload is completed, then `ready`. Only a `ready` file has a
+ * download URL. A pending file is deleted if it isn't completed within a day.
+ */
+export declare const FileStatus: {
+    readonly Pending: "pending";
+    readonly Ready: "ready";
+};
+export type FileStatus = (typeof FileStatus)[keyof typeof FileStatus];

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

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStatus = void 0;
+/**
+ * `pending` until its bytes are uploaded and the upload is completed, then `ready`. Only a `ready` file has a
+ * download URL. A pending file is deleted if it isn't completed within a day.
+ */
+exports.FileStatus = {
+    Pending: "pending",
+    Ready: "ready",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * Where to upload a pending file's bytes: one HTTP `PUT` to `url` with exactly `headers` and the file's bytes as
+ * the body. Every header is signed, so S3 refuses the upload if any is missing or different, and refuses bytes
+ * whose size or SHA-256 doesn't match the file. Then call Complete File.
+ */
+export interface FileUpload {
+    /** Always `PUT`. */
+    method: "PUT";
+    /** The presigned S3 URL. No API key is needed to use it. */
+    url: string;
+    /** The headers to send with the `PUT`, exactly as given. */
+    headers: Record<string, string>;
+    /** When `url` stops working, at most an hour after it was issued. Send the identical create request again for a fresh one. */
+    expiresAt: Date;
+}

package/dist/cjs/api/resources/files/types/FileUpload.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/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