agentmail 0.5.47 → 0.5.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/inboxes/client/Client.d.ts +2 -1
  3. package/dist/cjs/api/resources/inboxes/client/Client.js +2 -1
  4. package/dist/cjs/api/resources/inboxes/types/CreateInboxRequest.d.ts +4 -0
  5. package/dist/cjs/api/resources/inboxes/types/Inbox.d.ts +7 -0
  6. package/dist/cjs/api/resources/inboxes/types/InboxSignature.d.ts +17 -0
  7. package/dist/cjs/api/resources/inboxes/types/InboxSignature.js +3 -0
  8. package/dist/cjs/api/resources/inboxes/types/PauseAt.d.ts +7 -0
  9. package/dist/cjs/api/resources/inboxes/types/PauseAt.js +3 -0
  10. package/dist/cjs/api/resources/inboxes/types/UpdateInboxRequest.d.ts +9 -1
  11. package/dist/cjs/api/resources/inboxes/types/index.d.ts +2 -0
  12. package/dist/cjs/api/resources/inboxes/types/index.js +2 -0
  13. package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.d.ts +4 -0
  14. package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.js +4 -0
  15. package/dist/cjs/serialization/resources/inboxes/types/Inbox.d.ts +4 -0
  16. package/dist/cjs/serialization/resources/inboxes/types/Inbox.js +4 -0
  17. package/dist/cjs/serialization/resources/inboxes/types/InboxSignature.d.ts +10 -0
  18. package/dist/cjs/serialization/resources/inboxes/types/InboxSignature.js +42 -0
  19. package/dist/cjs/serialization/resources/inboxes/types/PauseAt.d.ts +7 -0
  20. package/dist/cjs/serialization/resources/inboxes/types/PauseAt.js +39 -0
  21. package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.d.ts +4 -0
  22. package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.js +4 -0
  23. package/dist/cjs/serialization/resources/inboxes/types/index.d.ts +2 -0
  24. package/dist/cjs/serialization/resources/inboxes/types/index.js +2 -0
  25. package/dist/cjs/version.d.ts +1 -1
  26. package/dist/cjs/version.js +1 -1
  27. package/dist/esm/BaseClient.mjs +2 -2
  28. package/dist/esm/api/resources/inboxes/client/Client.d.mts +2 -1
  29. package/dist/esm/api/resources/inboxes/client/Client.mjs +2 -1
  30. package/dist/esm/api/resources/inboxes/types/CreateInboxRequest.d.mts +4 -0
  31. package/dist/esm/api/resources/inboxes/types/Inbox.d.mts +7 -0
  32. package/dist/esm/api/resources/inboxes/types/InboxSignature.d.mts +17 -0
  33. package/dist/esm/api/resources/inboxes/types/InboxSignature.mjs +2 -0
  34. package/dist/esm/api/resources/inboxes/types/PauseAt.d.mts +7 -0
  35. package/dist/esm/api/resources/inboxes/types/PauseAt.mjs +2 -0
  36. package/dist/esm/api/resources/inboxes/types/UpdateInboxRequest.d.mts +9 -1
  37. package/dist/esm/api/resources/inboxes/types/index.d.mts +2 -0
  38. package/dist/esm/api/resources/inboxes/types/index.mjs +2 -0
  39. package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts +4 -0
  40. package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs +4 -0
  41. package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts +4 -0
  42. package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs +4 -0
  43. package/dist/esm/serialization/resources/inboxes/types/InboxSignature.d.mts +10 -0
  44. package/dist/esm/serialization/resources/inboxes/types/InboxSignature.mjs +6 -0
  45. package/dist/esm/serialization/resources/inboxes/types/PauseAt.d.mts +7 -0
  46. package/dist/esm/serialization/resources/inboxes/types/PauseAt.mjs +3 -0
  47. package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts +4 -0
  48. package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs +4 -0
  49. package/dist/esm/serialization/resources/inboxes/types/index.d.mts +2 -0
  50. package/dist/esm/serialization/resources/inboxes/types/index.mjs +2 -0
  51. package/dist/esm/version.d.mts +1 -1
  52. package/dist/esm/version.mjs +1 -1
  53. package/package.json +4 -3
  54. package/reference.md +2 -1
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "agentmail",
46
- "X-Fern-SDK-Version": "0.5.47",
47
- "User-Agent": "agentmail/0.5.47",
46
+ "X-Fern-SDK-Version": "0.5.49",
47
+ "User-Agent": "agentmail/0.5.49",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -117,7 +117,8 @@ export declare class InboxesClient {
117
117
  * ```
118
118
  *
119
119
  * To pause an inbox, set `status` to `paused`; set it back to `active` to
120
- * resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
120
+ * resume. To pause it later, set `pause_at`. See
121
+ * [Pausing an inbox](/inboxes#pausing-an-inbox).
121
122
  *
122
123
  * @param {AgentMail.inboxes.InboxId} inbox_id
123
124
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
@@ -404,7 +404,8 @@ class InboxesClient {
404
404
  * ```
405
405
  *
406
406
  * To pause an inbox, set `status` to `paused`; set it back to `active` to
407
- * resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
407
+ * resume. To pause it later, set `pause_at`. See
408
+ * [Pausing an inbox](/inboxes#pausing-an-inbox).
408
409
  *
409
410
  * @param {AgentMail.inboxes.InboxId} inbox_id
410
411
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
@@ -12,6 +12,10 @@ export interface CreateInboxRequest {
12
12
  clientId?: AgentMail.inboxes.ClientId;
13
13
  /** Set `paused` to create the inbox paused. */
14
14
  status?: AgentMail.inboxes.InboxStatus;
15
+ /** Schedule the inbox to pause at this time, for example when a fixed term ends. */
16
+ pauseAt?: AgentMail.inboxes.PauseAt;
17
+ /** Signature to add to every message the inbox sends. */
18
+ signature?: AgentMail.inboxes.InboxSignature;
15
19
  /** Custom metadata to attach to the inbox. */
16
20
  metadata?: AgentMail.inboxes.Metadata;
17
21
  }
@@ -11,6 +11,13 @@ export interface Inbox {
11
11
  * receives normally.
12
12
  */
13
13
  status?: AgentMail.inboxes.InboxStatus;
14
+ /**
15
+ * When the inbox is scheduled to pause. Omitted when no pause is
16
+ * scheduled, and cleared once the pause happens.
17
+ */
18
+ pauseAt?: AgentMail.inboxes.PauseAt;
19
+ /** The signature added to messages this inbox sends. Omitted when none is set. */
20
+ signature?: AgentMail.inboxes.InboxSignature;
14
21
  /** Custom metadata attached to the inbox. */
15
22
  metadata?: AgentMail.inboxes.Metadata;
16
23
  /** Time at which inbox was last updated. */
@@ -0,0 +1,17 @@
1
+ /**
2
+ * A signature AgentMail adds to every message the inbox sends: send,
3
+ * reply, reply-all, forward, and drafts, including scheduled ones. It goes
4
+ * right after your content, above any quoted or forwarded message. It is
5
+ * not added again when your body already contains it, and it is not added
6
+ * to Visa TAP messages.
7
+ */
8
+ export interface InboxSignature {
9
+ /** Signature for the plain-text part. At most 1,000 characters. */
10
+ text: string;
11
+ /**
12
+ * Signature for the HTML part. At most 4,000 characters, so link images
13
+ * by URL rather than embedding them. When omitted, the HTML part gets
14
+ * `text` with its line breaks.
15
+ */
16
+ html?: string;
17
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * When the inbox pauses itself. Within about five minutes after this time,
3
+ * the inbox becomes paused exactly as if `status` had been set to `paused`,
4
+ * and `pause_at` is cleared. Must be in the future; returned in UTC. A
5
+ * manual pause or resume does not change it.
6
+ */
7
+ export type PauseAt = Date;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -7,13 +7,21 @@ export interface UpdateInboxRequest {
7
7
  * resume.
8
8
  */
9
9
  status?: AgentMail.inboxes.InboxStatus;
10
+ /**
11
+ * Schedule a pause, or move one already scheduled. Send null to cancel
12
+ * it. Only an organization- or pod-scoped API key can change it; an
13
+ * inbox-scoped key gets `403`.
14
+ */
15
+ pauseAt?: AgentMail.inboxes.PauseAt | null;
16
+ /** Set or replace the inbox's signature. Send null to remove it. */
17
+ signature?: AgentMail.inboxes.InboxSignature | null;
10
18
  /**
11
19
  * Metadata to merge into the inbox's existing metadata. Keys you include
12
20
  * are added or overwritten; keys you omit are left unchanged. To remove a
13
21
  * single key, send it with a null value. To clear all metadata, send
14
22
  * `metadata` as null. Sending an empty object is rejected; use null to
15
23
  * clear. Each update must include at least one of `display_name`,
16
- * `status`, or `metadata`.
24
+ * `status`, `pause_at`, `signature`, or `metadata`.
17
25
  */
18
26
  metadata?: AgentMail.inboxes.UpdateMetadata | null;
19
27
  }
@@ -6,10 +6,12 @@ export * from "./DisplayName.js";
6
6
  export * from "./Email.js";
7
7
  export * from "./Inbox.js";
8
8
  export * from "./InboxId.js";
9
+ export * from "./InboxSignature.js";
9
10
  export * from "./InboxStatus.js";
10
11
  export * from "./ListInboxesResponse.js";
11
12
  export * from "./Metadata.js";
12
13
  export * from "./MetadataValue.js";
14
+ export * from "./PauseAt.js";
13
15
  export * from "./SearchInboxesResponse.js";
14
16
  export * from "./UpdateInboxRequest.js";
15
17
  export * from "./UpdateMetadata.js";
@@ -22,10 +22,12 @@ __exportStar(require("./DisplayName.js"), exports);
22
22
  __exportStar(require("./Email.js"), exports);
23
23
  __exportStar(require("./Inbox.js"), exports);
24
24
  __exportStar(require("./InboxId.js"), exports);
25
+ __exportStar(require("./InboxSignature.js"), exports);
25
26
  __exportStar(require("./InboxStatus.js"), exports);
26
27
  __exportStar(require("./ListInboxesResponse.js"), exports);
27
28
  __exportStar(require("./Metadata.js"), exports);
28
29
  __exportStar(require("./MetadataValue.js"), exports);
30
+ __exportStar(require("./PauseAt.js"), exports);
29
31
  __exportStar(require("./SearchInboxesResponse.js"), exports);
30
32
  __exportStar(require("./UpdateInboxRequest.js"), exports);
31
33
  __exportStar(require("./UpdateMetadata.js"), exports);
@@ -3,8 +3,10 @@ import * as core from "../../../../core/index.js";
3
3
  import type * as serializers from "../../../index.js";
4
4
  import { ClientId } from "./ClientId.js";
5
5
  import { DisplayName } from "./DisplayName.js";
6
+ import { InboxSignature } from "./InboxSignature.js";
6
7
  import { InboxStatus } from "./InboxStatus.js";
7
8
  import { Metadata } from "./Metadata.js";
9
+ import { PauseAt } from "./PauseAt.js";
8
10
  export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
9
11
  export declare namespace CreateInboxRequest {
10
12
  interface Raw {
@@ -13,6 +15,8 @@ export declare namespace CreateInboxRequest {
13
15
  display_name?: DisplayName.Raw | null;
14
16
  client_id?: ClientId.Raw | null;
15
17
  status?: InboxStatus.Raw | null;
18
+ pause_at?: PauseAt.Raw | null;
19
+ signature?: InboxSignature.Raw | null;
16
20
  metadata?: Metadata.Raw | null;
17
21
  }
18
22
  }
@@ -38,13 +38,17 @@ exports.CreateInboxRequest = void 0;
38
38
  const core = __importStar(require("../../../../core/index.js"));
39
39
  const ClientId_js_1 = require("./ClientId.js");
40
40
  const DisplayName_js_1 = require("./DisplayName.js");
41
+ const InboxSignature_js_1 = require("./InboxSignature.js");
41
42
  const InboxStatus_js_1 = require("./InboxStatus.js");
42
43
  const Metadata_js_1 = require("./Metadata.js");
44
+ const PauseAt_js_1 = require("./PauseAt.js");
43
45
  exports.CreateInboxRequest = core.serialization.object({
44
46
  username: core.serialization.string().optional(),
45
47
  domain: core.serialization.string().optional(),
46
48
  displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
47
49
  clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
48
50
  status: InboxStatus_js_1.InboxStatus.optional(),
51
+ pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optional()),
52
+ signature: InboxSignature_js_1.InboxSignature.optional(),
49
53
  metadata: Metadata_js_1.Metadata.optional(),
50
54
  });
@@ -6,8 +6,10 @@ import { ClientId } from "./ClientId.js";
6
6
  import { DisplayName } from "./DisplayName.js";
7
7
  import { Email } from "./Email.js";
8
8
  import { InboxId } from "./InboxId.js";
9
+ import { InboxSignature } from "./InboxSignature.js";
9
10
  import { InboxStatus } from "./InboxStatus.js";
10
11
  import { Metadata } from "./Metadata.js";
12
+ import { PauseAt } from "./PauseAt.js";
11
13
  export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
12
14
  export declare namespace Inbox {
13
15
  interface Raw {
@@ -17,6 +19,8 @@ export declare namespace Inbox {
17
19
  display_name?: DisplayName.Raw | null;
18
20
  client_id?: ClientId.Raw | null;
19
21
  status?: InboxStatus.Raw | null;
22
+ pause_at?: PauseAt.Raw | null;
23
+ signature?: InboxSignature.Raw | null;
20
24
  metadata?: Metadata.Raw | null;
21
25
  updated_at: string;
22
26
  created_at: string;
@@ -41,8 +41,10 @@ const ClientId_js_1 = require("./ClientId.js");
41
41
  const DisplayName_js_1 = require("./DisplayName.js");
42
42
  const Email_js_1 = require("./Email.js");
43
43
  const InboxId_js_1 = require("./InboxId.js");
44
+ const InboxSignature_js_1 = require("./InboxSignature.js");
44
45
  const InboxStatus_js_1 = require("./InboxStatus.js");
45
46
  const Metadata_js_1 = require("./Metadata.js");
47
+ const PauseAt_js_1 = require("./PauseAt.js");
46
48
  exports.Inbox = core.serialization.object({
47
49
  podId: core.serialization.property("pod_id", PodId_js_1.PodId),
48
50
  inboxId: core.serialization.property("inbox_id", InboxId_js_1.InboxId),
@@ -50,6 +52,8 @@ exports.Inbox = core.serialization.object({
50
52
  displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
51
53
  clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
52
54
  status: InboxStatus_js_1.InboxStatus.optional(),
55
+ pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optional()),
56
+ signature: InboxSignature_js_1.InboxSignature.optional(),
53
57
  metadata: Metadata_js_1.Metadata.optional(),
54
58
  updatedAt: core.serialization.property("updated_at", core.serialization.date()),
55
59
  createdAt: core.serialization.property("created_at", core.serialization.date()),
@@ -0,0 +1,10 @@
1
+ import type * as AgentMail from "../../../../api/index.js";
2
+ import * as core from "../../../../core/index.js";
3
+ import type * as serializers from "../../../index.js";
4
+ export declare const InboxSignature: core.serialization.ObjectSchema<serializers.inboxes.InboxSignature.Raw, AgentMail.inboxes.InboxSignature>;
5
+ export declare namespace InboxSignature {
6
+ interface Raw {
7
+ text: string;
8
+ html?: string | null;
9
+ }
10
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.InboxSignature = void 0;
38
+ const core = __importStar(require("../../../../core/index.js"));
39
+ exports.InboxSignature = core.serialization.object({
40
+ text: core.serialization.string(),
41
+ html: core.serialization.string().optional(),
42
+ });
@@ -0,0 +1,7 @@
1
+ import type * as AgentMail from "../../../../api/index.js";
2
+ import * as core from "../../../../core/index.js";
3
+ import type * as serializers from "../../../index.js";
4
+ export declare const PauseAt: core.serialization.Schema<serializers.inboxes.PauseAt.Raw, AgentMail.inboxes.PauseAt>;
5
+ export declare namespace PauseAt {
6
+ type Raw = string;
7
+ }
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.PauseAt = void 0;
38
+ const core = __importStar(require("../../../../core/index.js"));
39
+ exports.PauseAt = core.serialization.date();
@@ -2,13 +2,17 @@ import type * as AgentMail from "../../../../api/index.js";
2
2
  import * as core from "../../../../core/index.js";
3
3
  import type * as serializers from "../../../index.js";
4
4
  import { DisplayName } from "./DisplayName.js";
5
+ import { InboxSignature } from "./InboxSignature.js";
5
6
  import { InboxStatus } from "./InboxStatus.js";
7
+ import { PauseAt } from "./PauseAt.js";
6
8
  import { UpdateMetadata } from "./UpdateMetadata.js";
7
9
  export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
8
10
  export declare namespace UpdateInboxRequest {
9
11
  interface Raw {
10
12
  display_name?: DisplayName.Raw | null;
11
13
  status?: InboxStatus.Raw | null;
14
+ pause_at?: (PauseAt.Raw | null | undefined) | null;
15
+ signature?: (InboxSignature.Raw | null | undefined) | null;
12
16
  metadata?: (UpdateMetadata.Raw | null | undefined) | null;
13
17
  }
14
18
  }
@@ -37,10 +37,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.UpdateInboxRequest = void 0;
38
38
  const core = __importStar(require("../../../../core/index.js"));
39
39
  const DisplayName_js_1 = require("./DisplayName.js");
40
+ const InboxSignature_js_1 = require("./InboxSignature.js");
40
41
  const InboxStatus_js_1 = require("./InboxStatus.js");
42
+ const PauseAt_js_1 = require("./PauseAt.js");
41
43
  const UpdateMetadata_js_1 = require("./UpdateMetadata.js");
42
44
  exports.UpdateInboxRequest = core.serialization.object({
43
45
  displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
44
46
  status: InboxStatus_js_1.InboxStatus.optional(),
47
+ pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optionalNullable()),
48
+ signature: InboxSignature_js_1.InboxSignature.optionalNullable(),
45
49
  metadata: UpdateMetadata_js_1.UpdateMetadata.optionalNullable(),
46
50
  });
@@ -6,10 +6,12 @@ export * from "./DisplayName.js";
6
6
  export * from "./Email.js";
7
7
  export * from "./Inbox.js";
8
8
  export * from "./InboxId.js";
9
+ export * from "./InboxSignature.js";
9
10
  export * from "./InboxStatus.js";
10
11
  export * from "./ListInboxesResponse.js";
11
12
  export * from "./Metadata.js";
12
13
  export * from "./MetadataValue.js";
14
+ export * from "./PauseAt.js";
13
15
  export * from "./SearchInboxesResponse.js";
14
16
  export * from "./UpdateInboxRequest.js";
15
17
  export * from "./UpdateMetadata.js";
@@ -22,10 +22,12 @@ __exportStar(require("./DisplayName.js"), exports);
22
22
  __exportStar(require("./Email.js"), exports);
23
23
  __exportStar(require("./Inbox.js"), exports);
24
24
  __exportStar(require("./InboxId.js"), exports);
25
+ __exportStar(require("./InboxSignature.js"), exports);
25
26
  __exportStar(require("./InboxStatus.js"), exports);
26
27
  __exportStar(require("./ListInboxesResponse.js"), exports);
27
28
  __exportStar(require("./Metadata.js"), exports);
28
29
  __exportStar(require("./MetadataValue.js"), exports);
30
+ __exportStar(require("./PauseAt.js"), exports);
29
31
  __exportStar(require("./SearchInboxesResponse.js"), exports);
30
32
  __exportStar(require("./UpdateInboxRequest.js"), exports);
31
33
  __exportStar(require("./UpdateMetadata.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.5.47";
1
+ export declare const SDK_VERSION = "0.5.49";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.5.47";
4
+ exports.SDK_VERSION = "0.5.49";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "agentmail",
9
- "X-Fern-SDK-Version": "0.5.47",
10
- "User-Agent": "agentmail/0.5.47",
9
+ "X-Fern-SDK-Version": "0.5.49",
10
+ "User-Agent": "agentmail/0.5.49",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -117,7 +117,8 @@ export declare class InboxesClient {
117
117
  * ```
118
118
  *
119
119
  * To pause an inbox, set `status` to `paused`; set it back to `active` to
120
- * resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
120
+ * resume. To pause it later, set `pause_at`. See
121
+ * [Pausing an inbox](/inboxes#pausing-an-inbox).
121
122
  *
122
123
  * @param {AgentMail.inboxes.InboxId} inbox_id
123
124
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
@@ -368,7 +368,8 @@ export class InboxesClient {
368
368
  * ```
369
369
  *
370
370
  * To pause an inbox, set `status` to `paused`; set it back to `active` to
371
- * resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
371
+ * resume. To pause it later, set `pause_at`. See
372
+ * [Pausing an inbox](/inboxes#pausing-an-inbox).
372
373
  *
373
374
  * @param {AgentMail.inboxes.InboxId} inbox_id
374
375
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
@@ -12,6 +12,10 @@ export interface CreateInboxRequest {
12
12
  clientId?: AgentMail.inboxes.ClientId;
13
13
  /** Set `paused` to create the inbox paused. */
14
14
  status?: AgentMail.inboxes.InboxStatus;
15
+ /** Schedule the inbox to pause at this time, for example when a fixed term ends. */
16
+ pauseAt?: AgentMail.inboxes.PauseAt;
17
+ /** Signature to add to every message the inbox sends. */
18
+ signature?: AgentMail.inboxes.InboxSignature;
15
19
  /** Custom metadata to attach to the inbox. */
16
20
  metadata?: AgentMail.inboxes.Metadata;
17
21
  }
@@ -11,6 +11,13 @@ export interface Inbox {
11
11
  * receives normally.
12
12
  */
13
13
  status?: AgentMail.inboxes.InboxStatus;
14
+ /**
15
+ * When the inbox is scheduled to pause. Omitted when no pause is
16
+ * scheduled, and cleared once the pause happens.
17
+ */
18
+ pauseAt?: AgentMail.inboxes.PauseAt;
19
+ /** The signature added to messages this inbox sends. Omitted when none is set. */
20
+ signature?: AgentMail.inboxes.InboxSignature;
14
21
  /** Custom metadata attached to the inbox. */
15
22
  metadata?: AgentMail.inboxes.Metadata;
16
23
  /** Time at which inbox was last updated. */
@@ -0,0 +1,17 @@
1
+ /**
2
+ * A signature AgentMail adds to every message the inbox sends: send,
3
+ * reply, reply-all, forward, and drafts, including scheduled ones. It goes
4
+ * right after your content, above any quoted or forwarded message. It is
5
+ * not added again when your body already contains it, and it is not added
6
+ * to Visa TAP messages.
7
+ */
8
+ export interface InboxSignature {
9
+ /** Signature for the plain-text part. At most 1,000 characters. */
10
+ text: string;
11
+ /**
12
+ * Signature for the HTML part. At most 4,000 characters, so link images
13
+ * by URL rather than embedding them. When omitted, the HTML part gets
14
+ * `text` with its line breaks.
15
+ */
16
+ html?: string;
17
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ /**
2
+ * When the inbox pauses itself. Within about five minutes after this time,
3
+ * the inbox becomes paused exactly as if `status` had been set to `paused`,
4
+ * and `pause_at` is cleared. Must be in the future; returned in UTC. A
5
+ * manual pause or resume does not change it.
6
+ */
7
+ export type PauseAt = Date;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -7,13 +7,21 @@ export interface UpdateInboxRequest {
7
7
  * resume.
8
8
  */
9
9
  status?: AgentMail.inboxes.InboxStatus;
10
+ /**
11
+ * Schedule a pause, or move one already scheduled. Send null to cancel
12
+ * it. Only an organization- or pod-scoped API key can change it; an
13
+ * inbox-scoped key gets `403`.
14
+ */
15
+ pauseAt?: AgentMail.inboxes.PauseAt | null;
16
+ /** Set or replace the inbox's signature. Send null to remove it. */
17
+ signature?: AgentMail.inboxes.InboxSignature | null;
10
18
  /**
11
19
  * Metadata to merge into the inbox's existing metadata. Keys you include
12
20
  * are added or overwritten; keys you omit are left unchanged. To remove a
13
21
  * single key, send it with a null value. To clear all metadata, send
14
22
  * `metadata` as null. Sending an empty object is rejected; use null to
15
23
  * clear. Each update must include at least one of `display_name`,
16
- * `status`, or `metadata`.
24
+ * `status`, `pause_at`, `signature`, or `metadata`.
17
25
  */
18
26
  metadata?: AgentMail.inboxes.UpdateMetadata | null;
19
27
  }
@@ -6,10 +6,12 @@ export * from "./DisplayName.mjs";
6
6
  export * from "./Email.mjs";
7
7
  export * from "./Inbox.mjs";
8
8
  export * from "./InboxId.mjs";
9
+ export * from "./InboxSignature.mjs";
9
10
  export * from "./InboxStatus.mjs";
10
11
  export * from "./ListInboxesResponse.mjs";
11
12
  export * from "./Metadata.mjs";
12
13
  export * from "./MetadataValue.mjs";
14
+ export * from "./PauseAt.mjs";
13
15
  export * from "./SearchInboxesResponse.mjs";
14
16
  export * from "./UpdateInboxRequest.mjs";
15
17
  export * from "./UpdateMetadata.mjs";
@@ -6,10 +6,12 @@ export * from "./DisplayName.mjs";
6
6
  export * from "./Email.mjs";
7
7
  export * from "./Inbox.mjs";
8
8
  export * from "./InboxId.mjs";
9
+ export * from "./InboxSignature.mjs";
9
10
  export * from "./InboxStatus.mjs";
10
11
  export * from "./ListInboxesResponse.mjs";
11
12
  export * from "./Metadata.mjs";
12
13
  export * from "./MetadataValue.mjs";
14
+ export * from "./PauseAt.mjs";
13
15
  export * from "./SearchInboxesResponse.mjs";
14
16
  export * from "./UpdateInboxRequest.mjs";
15
17
  export * from "./UpdateMetadata.mjs";
@@ -3,8 +3,10 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  import { ClientId } from "./ClientId.mjs";
5
5
  import { DisplayName } from "./DisplayName.mjs";
6
+ import { InboxSignature } from "./InboxSignature.mjs";
6
7
  import { InboxStatus } from "./InboxStatus.mjs";
7
8
  import { Metadata } from "./Metadata.mjs";
9
+ import { PauseAt } from "./PauseAt.mjs";
8
10
  export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
9
11
  export declare namespace CreateInboxRequest {
10
12
  interface Raw {
@@ -13,6 +15,8 @@ export declare namespace CreateInboxRequest {
13
15
  display_name?: DisplayName.Raw | null;
14
16
  client_id?: ClientId.Raw | null;
15
17
  status?: InboxStatus.Raw | null;
18
+ pause_at?: PauseAt.Raw | null;
19
+ signature?: InboxSignature.Raw | null;
16
20
  metadata?: Metadata.Raw | null;
17
21
  }
18
22
  }
@@ -2,13 +2,17 @@
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import { ClientId } from "./ClientId.mjs";
4
4
  import { DisplayName } from "./DisplayName.mjs";
5
+ import { InboxSignature } from "./InboxSignature.mjs";
5
6
  import { InboxStatus } from "./InboxStatus.mjs";
6
7
  import { Metadata } from "./Metadata.mjs";
8
+ import { PauseAt } from "./PauseAt.mjs";
7
9
  export const CreateInboxRequest = core.serialization.object({
8
10
  username: core.serialization.string().optional(),
9
11
  domain: core.serialization.string().optional(),
10
12
  displayName: core.serialization.property("display_name", DisplayName.optional()),
11
13
  clientId: core.serialization.property("client_id", ClientId.optional()),
12
14
  status: InboxStatus.optional(),
15
+ pauseAt: core.serialization.property("pause_at", PauseAt.optional()),
16
+ signature: InboxSignature.optional(),
13
17
  metadata: Metadata.optional(),
14
18
  });
@@ -6,8 +6,10 @@ import { ClientId } from "./ClientId.mjs";
6
6
  import { DisplayName } from "./DisplayName.mjs";
7
7
  import { Email } from "./Email.mjs";
8
8
  import { InboxId } from "./InboxId.mjs";
9
+ import { InboxSignature } from "./InboxSignature.mjs";
9
10
  import { InboxStatus } from "./InboxStatus.mjs";
10
11
  import { Metadata } from "./Metadata.mjs";
12
+ import { PauseAt } from "./PauseAt.mjs";
11
13
  export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
12
14
  export declare namespace Inbox {
13
15
  interface Raw {
@@ -17,6 +19,8 @@ export declare namespace Inbox {
17
19
  display_name?: DisplayName.Raw | null;
18
20
  client_id?: ClientId.Raw | null;
19
21
  status?: InboxStatus.Raw | null;
22
+ pause_at?: PauseAt.Raw | null;
23
+ signature?: InboxSignature.Raw | null;
20
24
  metadata?: Metadata.Raw | null;
21
25
  updated_at: string;
22
26
  created_at: string;
@@ -5,8 +5,10 @@ import { ClientId } from "./ClientId.mjs";
5
5
  import { DisplayName } from "./DisplayName.mjs";
6
6
  import { Email } from "./Email.mjs";
7
7
  import { InboxId } from "./InboxId.mjs";
8
+ import { InboxSignature } from "./InboxSignature.mjs";
8
9
  import { InboxStatus } from "./InboxStatus.mjs";
9
10
  import { Metadata } from "./Metadata.mjs";
11
+ import { PauseAt } from "./PauseAt.mjs";
10
12
  export const Inbox = core.serialization.object({
11
13
  podId: core.serialization.property("pod_id", PodId),
12
14
  inboxId: core.serialization.property("inbox_id", InboxId),
@@ -14,6 +16,8 @@ export const Inbox = core.serialization.object({
14
16
  displayName: core.serialization.property("display_name", DisplayName.optional()),
15
17
  clientId: core.serialization.property("client_id", ClientId.optional()),
16
18
  status: InboxStatus.optional(),
19
+ pauseAt: core.serialization.property("pause_at", PauseAt.optional()),
20
+ signature: InboxSignature.optional(),
17
21
  metadata: Metadata.optional(),
18
22
  updatedAt: core.serialization.property("updated_at", core.serialization.date()),
19
23
  createdAt: core.serialization.property("created_at", core.serialization.date()),
@@ -0,0 +1,10 @@
1
+ import type * as AgentMail from "../../../../api/index.mjs";
2
+ import * as core from "../../../../core/index.mjs";
3
+ import type * as serializers from "../../../index.mjs";
4
+ export declare const InboxSignature: core.serialization.ObjectSchema<serializers.inboxes.InboxSignature.Raw, AgentMail.inboxes.InboxSignature>;
5
+ export declare namespace InboxSignature {
6
+ interface Raw {
7
+ text: string;
8
+ html?: string | null;
9
+ }
10
+ }
@@ -0,0 +1,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ export const InboxSignature = core.serialization.object({
4
+ text: core.serialization.string(),
5
+ html: core.serialization.string().optional(),
6
+ });
@@ -0,0 +1,7 @@
1
+ import type * as AgentMail from "../../../../api/index.mjs";
2
+ import * as core from "../../../../core/index.mjs";
3
+ import type * as serializers from "../../../index.mjs";
4
+ export declare const PauseAt: core.serialization.Schema<serializers.inboxes.PauseAt.Raw, AgentMail.inboxes.PauseAt>;
5
+ export declare namespace PauseAt {
6
+ type Raw = string;
7
+ }
@@ -0,0 +1,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ export const PauseAt = core.serialization.date();
@@ -2,13 +2,17 @@ import type * as AgentMail from "../../../../api/index.mjs";
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  import { DisplayName } from "./DisplayName.mjs";
5
+ import { InboxSignature } from "./InboxSignature.mjs";
5
6
  import { InboxStatus } from "./InboxStatus.mjs";
7
+ import { PauseAt } from "./PauseAt.mjs";
6
8
  import { UpdateMetadata } from "./UpdateMetadata.mjs";
7
9
  export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
8
10
  export declare namespace UpdateInboxRequest {
9
11
  interface Raw {
10
12
  display_name?: DisplayName.Raw | null;
11
13
  status?: InboxStatus.Raw | null;
14
+ pause_at?: (PauseAt.Raw | null | undefined) | null;
15
+ signature?: (InboxSignature.Raw | null | undefined) | null;
12
16
  metadata?: (UpdateMetadata.Raw | null | undefined) | null;
13
17
  }
14
18
  }
@@ -1,10 +1,14 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import { DisplayName } from "./DisplayName.mjs";
4
+ import { InboxSignature } from "./InboxSignature.mjs";
4
5
  import { InboxStatus } from "./InboxStatus.mjs";
6
+ import { PauseAt } from "./PauseAt.mjs";
5
7
  import { UpdateMetadata } from "./UpdateMetadata.mjs";
6
8
  export const UpdateInboxRequest = core.serialization.object({
7
9
  displayName: core.serialization.property("display_name", DisplayName.optional()),
8
10
  status: InboxStatus.optional(),
11
+ pauseAt: core.serialization.property("pause_at", PauseAt.optionalNullable()),
12
+ signature: InboxSignature.optionalNullable(),
9
13
  metadata: UpdateMetadata.optionalNullable(),
10
14
  });
@@ -6,10 +6,12 @@ export * from "./DisplayName.mjs";
6
6
  export * from "./Email.mjs";
7
7
  export * from "./Inbox.mjs";
8
8
  export * from "./InboxId.mjs";
9
+ export * from "./InboxSignature.mjs";
9
10
  export * from "./InboxStatus.mjs";
10
11
  export * from "./ListInboxesResponse.mjs";
11
12
  export * from "./Metadata.mjs";
12
13
  export * from "./MetadataValue.mjs";
14
+ export * from "./PauseAt.mjs";
13
15
  export * from "./SearchInboxesResponse.mjs";
14
16
  export * from "./UpdateInboxRequest.mjs";
15
17
  export * from "./UpdateMetadata.mjs";
@@ -6,10 +6,12 @@ export * from "./DisplayName.mjs";
6
6
  export * from "./Email.mjs";
7
7
  export * from "./Inbox.mjs";
8
8
  export * from "./InboxId.mjs";
9
+ export * from "./InboxSignature.mjs";
9
10
  export * from "./InboxStatus.mjs";
10
11
  export * from "./ListInboxesResponse.mjs";
11
12
  export * from "./Metadata.mjs";
12
13
  export * from "./MetadataValue.mjs";
14
+ export * from "./PauseAt.mjs";
13
15
  export * from "./SearchInboxesResponse.mjs";
14
16
  export * from "./UpdateInboxRequest.mjs";
15
17
  export * from "./UpdateMetadata.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.5.47";
1
+ export declare const SDK_VERSION = "0.5.49";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.5.47";
1
+ export const SDK_VERSION = "0.5.49";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentmail",
3
- "version": "0.5.47",
3
+ "version": "0.5.49",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -489,7 +489,7 @@
489
489
  "webpack": "^5.105.4",
490
490
  "ts-loader": "^9.5.4",
491
491
  "@types/ws": "^8.18.1",
492
- "vitest": "^4.1.1",
492
+ "vitest": "^4.1.12",
493
493
  "msw": "2.11.2",
494
494
  "@types/node": "^18.19.70",
495
495
  "typescript": "~5.9.3",
@@ -512,7 +512,8 @@
512
512
  "overrides": {
513
513
  "postcss": ">=8.5.23",
514
514
  "fast-uri": ">=3.1.5",
515
- "browserslist": ">=4.28.7"
515
+ "browserslist": ">=4.28.7",
516
+ "baseline-browser-mapping": ">=2.11.12"
516
517
  }
517
518
  },
518
519
  "description": "The email inbox API for AI agents. Send, receive, reply, and manage threaded email conversations programmatically.",
package/reference.md CHANGED
@@ -286,7 +286,8 @@ agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
286
286
  ```
287
287
 
288
288
  To pause an inbox, set `status` to `paused`; set it back to `active` to
289
- resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
289
+ resume. To pause it later, set `pause_at`. See
290
+ [Pausing an inbox](/inboxes#pausing-an-inbox).
290
291
  </dd>
291
292
  </dl>
292
293
  </dd>