agentmail 0.5.36 → 0.5.37

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.36",
-        "User-Agent": "agentmail/0.5.36",
+        "X-Fern-SDK-Version": "0.5.37",
+        "User-Agent": "agentmail/0.5.37",
         "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,7 +15,7 @@ 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.
+     * `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 or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). 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.
      *

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

@@ -61,7 +61,7 @@ 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.
+     * `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 or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). 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.
      *

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

@@ -39,44 +39,47 @@ export declare class AppsClient {
     search(request: AgentMail.SearchAppsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.SearchAppsResponse>;
     private __search;
     /**
-     * Gets one app by ID. An app in the catalog returns its full entry.
+     * Gets one app by ID or slug. A catalog app returns its full entry.
      * A registered app that the catalog does not list returns its ID and
      * name only, without `updated_at`, so anyone holding its ID can still look
-     * it up. List Apps and Search Apps show catalog entries only.
+     * it up; a slug finds catalog apps only. List Apps and Search Apps show
+     * catalog entries only.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.get("app_id")
      */
-    get(app_id: AgentMail.AppId, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.App>;
+    get(app_id: string, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.App>;
     private __get;
     /**
      * Lists accounts at one app, most recent sign-in first.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ListAppAccountsRequest} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.listAccounts("app_id")
      */
-    listAccounts(app_id: AgentMail.AppId, request?: AgentMail.ListAppAccountsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListAppAccountsResponse>;
+    listAccounts(app_id: string, request?: AgentMail.ListAppAccountsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListAppAccountsResponse>;
     private __listAccounts;
     /**
      * Starts signing an inbox in to an app. Returns a single-use `magic_url`,
      * valid for five minutes, to open in the client that will hold the sign-in;
      * the client enrolls as the inbox and continues to the app.
+     * An app in the catalog can be named by its `slug`, as in
+     * `POST /v0/apps/firecrawl/connect`.
      * A `404` names the missing resource: `App` or `Inbox`.
      * A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
      * your organization; sign in with an inbox that already has an account there.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ConnectAppBody} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -85,8 +88,8 @@ export declare class AppsClient {
      * @throws {@link AgentMail.AppSignupLimitError}
      *
      * @example
-     *     await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined)
+     *     await client.apps.connect("app_id", undefined)
      */
-    connect(app_id: AgentMail.AppId, request?: AgentMail.ConnectAppBody, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ConnectAccepted>;
+    connect(app_id: string, request?: AgentMail.ConnectAppBody, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ConnectAccepted>;
     private __connect;
 }

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

@@ -203,18 +203,19 @@ class AppsClient {
         });
     }
     /**
-     * Gets one app by ID. An app in the catalog returns its full entry.
+     * Gets one app by ID or slug. A catalog app returns its full entry.
      * A registered app that the catalog does not list returns its ID and
      * name only, without `updated_at`, so anyone holding its ID can still look
-     * it up. List Apps and Search Apps show catalog entries only.
+     * it up; a slug finds catalog apps only. List Apps and Search Apps show
+     * catalog entries only.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.get("app_id")
      */
     get(app_id, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(app_id, requestOptions));
@@ -226,7 +227,7 @@ class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -272,14 +273,14 @@ class AppsClient {
     /**
      * Lists accounts at one app, most recent sign-in first.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ListAppAccountsRequest} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.listAccounts("app_id")
      */
     listAccounts(app_id, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__listAccounts(app_id, request, requestOptions));
@@ -296,7 +297,7 @@ class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}/accounts`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}/accounts`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -343,11 +344,13 @@ class AppsClient {
      * Starts signing an inbox in to an app. Returns a single-use `magic_url`,
      * valid for five minutes, to open in the client that will hold the sign-in;
      * the client enrolls as the inbox and continues to the app.
+     * An app in the catalog can be named by its `slug`, as in
+     * `POST /v0/apps/firecrawl/connect`.
      * A `404` names the missing resource: `App` or `Inbox`.
      * A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
      * your organization; sign in with an inbox that already has an account there.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ConnectAppBody} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -356,7 +359,7 @@ class AppsClient {
      * @throws {@link AgentMail.AppSignupLimitError}
      *
      * @example
-     *     await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined)
+     *     await client.apps.connect("app_id", undefined)
      */
     connect(app_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__connect(app_id, request, requestOptions));
@@ -368,7 +371,7 @@ class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}/connect`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}/connect`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",

package/dist/cjs/api/resources/apps/types/App.d.ts

@@ -4,6 +4,8 @@ import type * as AgentMail from "../../../index.js";
  */
 export interface App {
     appId: AgentMail.AppId;
+    /** Short name accepted in place of `app_id` by Get App, List App Accounts and Connect App. Set by AgentMail on apps in the catalog; renaming the app does not change it. Store `app_id`, the app's permanent ID. */
+    slug?: string;
     name?: string;
     /** Time at which app was last updated. */
     updatedAt?: Date;

package/dist/cjs/serialization/resources/apps/types/App.d.ts

@@ -7,6 +7,7 @@ export declare const App: core.serialization.ObjectSchema<serializers.App.Raw, A
 export declare namespace App {
     interface Raw {
         app_id: AppId.Raw;
+        slug?: string | null;
         name?: string | null;
         updated_at?: string | null;
         description?: string | null;

package/dist/cjs/serialization/resources/apps/types/App.js

@@ -40,6 +40,7 @@ const AppCategory_js_1 = require("./AppCategory.js");
 const AppId_js_1 = require("./AppId.js");
 exports.App = core.serialization.object({
     appId: core.serialization.property("app_id", AppId_js_1.AppId),
+    slug: core.serialization.string().optional(),
     name: core.serialization.string().optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date().optional()),
     description: core.serialization.string().optional(),

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.5.36";
+export declare const SDK_VERSION = "0.5.37";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.5.36";
+exports.SDK_VERSION = "0.5.37";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "agentmail",
-        "X-Fern-SDK-Version": "0.5.36",
-        "User-Agent": "agentmail/0.5.36",
+        "X-Fern-SDK-Version": "0.5.37",
+        "User-Agent": "agentmail/0.5.37",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -15,7 +15,7 @@ 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.
+     * `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 or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). 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.
      *

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

@@ -25,7 +25,7 @@ export 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.
+     * `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 or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). 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.
      *

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

@@ -39,44 +39,47 @@ export declare class AppsClient {
     search(request: AgentMail.SearchAppsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.SearchAppsResponse>;
     private __search;
     /**
-     * Gets one app by ID. An app in the catalog returns its full entry.
+     * Gets one app by ID or slug. A catalog app returns its full entry.
      * A registered app that the catalog does not list returns its ID and
      * name only, without `updated_at`, so anyone holding its ID can still look
-     * it up. List Apps and Search Apps show catalog entries only.
+     * it up; a slug finds catalog apps only. List Apps and Search Apps show
+     * catalog entries only.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.get("app_id")
      */
-    get(app_id: AgentMail.AppId, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.App>;
+    get(app_id: string, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.App>;
     private __get;
     /**
      * Lists accounts at one app, most recent sign-in first.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ListAppAccountsRequest} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.listAccounts("app_id")
      */
-    listAccounts(app_id: AgentMail.AppId, request?: AgentMail.ListAppAccountsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListAppAccountsResponse>;
+    listAccounts(app_id: string, request?: AgentMail.ListAppAccountsRequest, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListAppAccountsResponse>;
     private __listAccounts;
     /**
      * Starts signing an inbox in to an app. Returns a single-use `magic_url`,
      * valid for five minutes, to open in the client that will hold the sign-in;
      * the client enrolls as the inbox and continues to the app.
+     * An app in the catalog can be named by its `slug`, as in
+     * `POST /v0/apps/firecrawl/connect`.
      * A `404` names the missing resource: `App` or `Inbox`.
      * A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
      * your organization; sign in with an inbox that already has an account there.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ConnectAppBody} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -85,8 +88,8 @@ export declare class AppsClient {
      * @throws {@link AgentMail.AppSignupLimitError}
      *
      * @example
-     *     await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined)
+     *     await client.apps.connect("app_id", undefined)
      */
-    connect(app_id: AgentMail.AppId, request?: AgentMail.ConnectAppBody, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ConnectAccepted>;
+    connect(app_id: string, request?: AgentMail.ConnectAppBody, requestOptions?: AppsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ConnectAccepted>;
     private __connect;
 }

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

@@ -167,18 +167,19 @@ export class AppsClient {
         });
     }
     /**
-     * Gets one app by ID. An app in the catalog returns its full entry.
+     * Gets one app by ID or slug. A catalog app returns its full entry.
      * A registered app that the catalog does not list returns its ID and
      * name only, without `updated_at`, so anyone holding its ID can still look
-     * it up. List Apps and Search Apps show catalog entries only.
+     * it up; a slug finds catalog apps only. List Apps and Search Apps show
+     * catalog entries only.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.NotFoundError}
      *
      * @example
-     *     await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.get("app_id")
      */
     get(app_id, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(app_id, requestOptions));
@@ -190,7 +191,7 @@ export class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -236,14 +237,14 @@ export class AppsClient {
     /**
      * Lists accounts at one app, most recent sign-in first.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ListAppAccountsRequest} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AgentMail.ValidationError}
      *
      * @example
-     *     await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+     *     await client.apps.listAccounts("app_id")
      */
     listAccounts(app_id, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__listAccounts(app_id, request, requestOptions));
@@ -260,7 +261,7 @@ export class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}/accounts`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}/accounts`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -307,11 +308,13 @@ export class AppsClient {
      * Starts signing an inbox in to an app. Returns a single-use `magic_url`,
      * valid for five minutes, to open in the client that will hold the sign-in;
      * the client enrolls as the inbox and continues to the app.
+     * An app in the catalog can be named by its `slug`, as in
+     * `POST /v0/apps/firecrawl/connect`.
      * A `404` names the missing resource: `App` or `Inbox`.
      * A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
      * your organization; sign in with an inbox that already has an account there.
      *
-     * @param {AgentMail.AppId} app_id
+     * @param {string} app_id - ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
      * @param {AgentMail.ConnectAppBody} request
      * @param {AppsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -320,7 +323,7 @@ export class AppsClient {
      * @throws {@link AgentMail.AppSignupLimitError}
      *
      * @example
-     *     await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined)
+     *     await client.apps.connect("app_id", undefined)
      */
     connect(app_id, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__connect(app_id, request, requestOptions));
@@ -332,7 +335,7 @@ export class AppsClient {
             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/apps/${core.url.encodePathParam(serializers.AppId.jsonOrThrow(app_id, { omitUndefined: true }))}/connect`),
+                    .http, `/v0/apps/${core.url.encodePathParam(app_id)}/connect`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",

package/dist/esm/api/resources/apps/types/App.d.mts

@@ -4,6 +4,8 @@ import type * as AgentMail from "../../../index.mjs";
  */
 export interface App {
     appId: AgentMail.AppId;
+    /** Short name accepted in place of `app_id` by Get App, List App Accounts and Connect App. Set by AgentMail on apps in the catalog; renaming the app does not change it. Store `app_id`, the app's permanent ID. */
+    slug?: string;
     name?: string;
     /** Time at which app was last updated. */
     updatedAt?: Date;

package/dist/esm/serialization/resources/apps/types/App.d.mts

@@ -7,6 +7,7 @@ export declare const App: core.serialization.ObjectSchema<serializers.App.Raw, A
 export declare namespace App {
     interface Raw {
         app_id: AppId.Raw;
+        slug?: string | null;
         name?: string | null;
         updated_at?: string | null;
         description?: string | null;

package/dist/esm/serialization/resources/apps/types/App.mjs

@@ -4,6 +4,7 @@ import { AppCategory } from "./AppCategory.mjs";
 import { AppId } from "./AppId.mjs";
 export const App = core.serialization.object({
     appId: core.serialization.property("app_id", AppId),
+    slug: core.serialization.string().optional(),
     name: core.serialization.string().optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date().optional()),
     description: core.serialization.string().optional(),

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.5.36";
+export declare const SDK_VERSION = "0.5.37";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.5.36";
+export const SDK_VERSION = "0.5.37";

package/dist/llms.txt

@@ -1,6 +1,6 @@
 # AgentMail | Documentation
 
-> AgentMail is an email API built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically.
+> AgentMail is the first email provider built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically. Free tier, no credit card required.
 
 ## Instructions for AI Agents
 
@@ -71,8 +71,10 @@
 - [Knowledge Base](https://docs.agentmail.to/knowledge-base.md): A collection of answers to frequently asked questions.
 - [What is AgentMail and how is it different?](https://docs.agentmail.to/knowledge-base/what-is-agentmail.md): Understand how AgentMail compares to traditional email providers.
 - [What can I do with an AgentMail inbox?](https://docs.agentmail.to/knowledge-base/inbox-capabilities.md): A complete overview of inbox capabilities for AI agents.
+- [Can I set a profile picture for my inbox?](https://docs.agentmail.to/knowledge-base/inbox-profile-pictures.md): Learn how to associate a Google profile picture with an AgentMail address, how BIMI logos differ, and when Gmail requires a VMC or CMC certificate.
 - [How do I create my first inbox?](https://docs.agentmail.to/knowledge-base/creating-first-inbox.md): Get up and running with your first AgentMail inbox.
 - [How do I get my API key?](https://docs.agentmail.to/knowledge-base/getting-api-key.md): Create and manage your AgentMail API keys.
+- [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox.md): Take ownership of an inbox your agent created without your email.
 - [How do I handle inbound emails with my agent?](https://docs.agentmail.to/knowledge-base/handling-inbound-emails.md): Compare Webhooks and WebSockets for processing incoming emails.
 - [How do I set up allowlists and blocklists?](https://docs.agentmail.to/knowledge-base/allowlists-blocklists.md): Control who your AI agent can send to and receive from.
 - [How do I manage threaded conversations?](https://docs.agentmail.to/knowledge-base/threaded-conversations.md): Maintain context across multi-turn email conversations with your agent.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agentmail",
-    "version": "0.5.36",
+    "version": "0.5.37",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -1468,7 +1468,7 @@ Create a new agent organization with an inbox and API key. This endpoint is for
 
 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.
+`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 or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). 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.
 
@@ -2169,10 +2169,11 @@ await client.apps.search({
 <dl>
 <dd>
 
-Gets one app by ID. An app in the catalog returns its full entry.
+Gets one app by ID or slug. A catalog app returns its full entry.
 A registered app that the catalog does not list returns its ID and
 name only, without `updated_at`, so anyone holding its ID can still look
-it up. List Apps and Search Apps show catalog entries only.
+it up; a slug finds catalog apps only. List Apps and Search Apps show
+catalog entries only.
 </dd>
 </dl>
 </dd>
@@ -2187,7 +2188,7 @@ it up. List Apps and Search Apps show catalog entries only.
 <dd>
 
 ```typescript
-await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+await client.apps.get("app_id");
 
 ```
 </dd>
@@ -2203,7 +2204,7 @@ await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>
@@ -2250,7 +2251,7 @@ Lists accounts at one app, most recent sign-in first.
 <dd>
 
 ```typescript
-await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+await client.apps.listAccounts("app_id");
 
 ```
 </dd>
@@ -2266,7 +2267,7 @@ await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>
@@ -2309,6 +2310,8 @@ await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 Starts signing an inbox in to an app. Returns a single-use `magic_url`,
 valid for five minutes, to open in the client that will hold the sign-in;
 the client enrolls as the inbox and continues to the app.
+An app in the catalog can be named by its `slug`, as in
+`POST /v0/apps/firecrawl/connect`.
 A `404` names the missing resource: `App` or `Inbox`.
 A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
 your organization; sign in with an inbox that already has an account there.
@@ -2326,7 +2329,7 @@ your organization; sign in with an inbox that already has an account there.
 <dd>
 
 ```typescript
-await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined);
+await client.apps.connect("app_id", undefined);
 
 ```
 </dd>
@@ -2342,7 +2345,7 @@ await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined);
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>