agentmail 0.5.47 → 0.5.48
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/inboxes/client/Client.js +2 -1
- package/dist/cjs/api/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/types/Inbox.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.js +3 -0
- package/dist/cjs/api/resources/inboxes/types/UpdateInboxRequest.d.ts +7 -1
- package/dist/cjs/api/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.js +39 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/inboxes/client/Client.mjs +2 -1
- package/dist/esm/api/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/types/Inbox.d.mts +5 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.mjs +2 -0
- package/dist/esm/api/resources/inboxes/types/UpdateInboxRequest.d.mts +7 -1
- package/dist/esm/api/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.mjs +3 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -1
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -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
|
-
"User-Agent": "agentmail/0.5.
|
|
46
|
+
"X-Fern-SDK-Version": "0.5.48",
|
|
47
|
+
"User-Agent": "agentmail/0.5.48",
|
|
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.
|
|
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.
|
|
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,8 @@ 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;
|
|
15
17
|
/** Custom metadata to attach to the inbox. */
|
|
16
18
|
metadata?: AgentMail.inboxes.Metadata;
|
|
17
19
|
}
|
|
@@ -11,6 +11,11 @@ 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;
|
|
14
19
|
/** Custom metadata attached to the inbox. */
|
|
15
20
|
metadata?: AgentMail.inboxes.Metadata;
|
|
16
21
|
/** Time at which inbox was last updated. */
|
|
@@ -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;
|
|
@@ -7,13 +7,19 @@ 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;
|
|
10
16
|
/**
|
|
11
17
|
* Metadata to merge into the inbox's existing metadata. Keys you include
|
|
12
18
|
* are added or overwritten; keys you omit are left unchanged. To remove a
|
|
13
19
|
* single key, send it with a null value. To clear all metadata, send
|
|
14
20
|
* `metadata` as null. Sending an empty object is rejected; use null to
|
|
15
21
|
* clear. Each update must include at least one of `display_name`,
|
|
16
|
-
* `status`, or `metadata`.
|
|
22
|
+
* `status`, `pause_at`, or `metadata`.
|
|
17
23
|
*/
|
|
18
24
|
metadata?: AgentMail.inboxes.UpdateMetadata | null;
|
|
19
25
|
}
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.js";
|
|
|
10
10
|
export * from "./ListInboxesResponse.js";
|
|
11
11
|
export * from "./Metadata.js";
|
|
12
12
|
export * from "./MetadataValue.js";
|
|
13
|
+
export * from "./PauseAt.js";
|
|
13
14
|
export * from "./SearchInboxesResponse.js";
|
|
14
15
|
export * from "./UpdateInboxRequest.js";
|
|
15
16
|
export * from "./UpdateMetadata.js";
|
|
@@ -26,6 +26,7 @@ __exportStar(require("./InboxStatus.js"), exports);
|
|
|
26
26
|
__exportStar(require("./ListInboxesResponse.js"), exports);
|
|
27
27
|
__exportStar(require("./Metadata.js"), exports);
|
|
28
28
|
__exportStar(require("./MetadataValue.js"), exports);
|
|
29
|
+
__exportStar(require("./PauseAt.js"), exports);
|
|
29
30
|
__exportStar(require("./SearchInboxesResponse.js"), exports);
|
|
30
31
|
__exportStar(require("./UpdateInboxRequest.js"), exports);
|
|
31
32
|
__exportStar(require("./UpdateMetadata.js"), exports);
|
|
@@ -5,6 +5,7 @@ import { ClientId } from "./ClientId.js";
|
|
|
5
5
|
import { DisplayName } from "./DisplayName.js";
|
|
6
6
|
import { InboxStatus } from "./InboxStatus.js";
|
|
7
7
|
import { Metadata } from "./Metadata.js";
|
|
8
|
+
import { PauseAt } from "./PauseAt.js";
|
|
8
9
|
export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
|
|
9
10
|
export declare namespace CreateInboxRequest {
|
|
10
11
|
interface Raw {
|
|
@@ -13,6 +14,7 @@ export declare namespace CreateInboxRequest {
|
|
|
13
14
|
display_name?: DisplayName.Raw | null;
|
|
14
15
|
client_id?: ClientId.Raw | null;
|
|
15
16
|
status?: InboxStatus.Raw | null;
|
|
17
|
+
pause_at?: PauseAt.Raw | null;
|
|
16
18
|
metadata?: Metadata.Raw | null;
|
|
17
19
|
}
|
|
18
20
|
}
|
|
@@ -40,11 +40,13 @@ const ClientId_js_1 = require("./ClientId.js");
|
|
|
40
40
|
const DisplayName_js_1 = require("./DisplayName.js");
|
|
41
41
|
const InboxStatus_js_1 = require("./InboxStatus.js");
|
|
42
42
|
const Metadata_js_1 = require("./Metadata.js");
|
|
43
|
+
const PauseAt_js_1 = require("./PauseAt.js");
|
|
43
44
|
exports.CreateInboxRequest = core.serialization.object({
|
|
44
45
|
username: core.serialization.string().optional(),
|
|
45
46
|
domain: core.serialization.string().optional(),
|
|
46
47
|
displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
|
|
47
48
|
clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
|
|
48
49
|
status: InboxStatus_js_1.InboxStatus.optional(),
|
|
50
|
+
pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optional()),
|
|
49
51
|
metadata: Metadata_js_1.Metadata.optional(),
|
|
50
52
|
});
|
|
@@ -8,6 +8,7 @@ import { Email } from "./Email.js";
|
|
|
8
8
|
import { InboxId } from "./InboxId.js";
|
|
9
9
|
import { InboxStatus } from "./InboxStatus.js";
|
|
10
10
|
import { Metadata } from "./Metadata.js";
|
|
11
|
+
import { PauseAt } from "./PauseAt.js";
|
|
11
12
|
export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
|
|
12
13
|
export declare namespace Inbox {
|
|
13
14
|
interface Raw {
|
|
@@ -17,6 +18,7 @@ export declare namespace Inbox {
|
|
|
17
18
|
display_name?: DisplayName.Raw | null;
|
|
18
19
|
client_id?: ClientId.Raw | null;
|
|
19
20
|
status?: InboxStatus.Raw | null;
|
|
21
|
+
pause_at?: PauseAt.Raw | null;
|
|
20
22
|
metadata?: Metadata.Raw | null;
|
|
21
23
|
updated_at: string;
|
|
22
24
|
created_at: string;
|
|
@@ -43,6 +43,7 @@ const Email_js_1 = require("./Email.js");
|
|
|
43
43
|
const InboxId_js_1 = require("./InboxId.js");
|
|
44
44
|
const InboxStatus_js_1 = require("./InboxStatus.js");
|
|
45
45
|
const Metadata_js_1 = require("./Metadata.js");
|
|
46
|
+
const PauseAt_js_1 = require("./PauseAt.js");
|
|
46
47
|
exports.Inbox = core.serialization.object({
|
|
47
48
|
podId: core.serialization.property("pod_id", PodId_js_1.PodId),
|
|
48
49
|
inboxId: core.serialization.property("inbox_id", InboxId_js_1.InboxId),
|
|
@@ -50,6 +51,7 @@ exports.Inbox = core.serialization.object({
|
|
|
50
51
|
displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
|
|
51
52
|
clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
|
|
52
53
|
status: InboxStatus_js_1.InboxStatus.optional(),
|
|
54
|
+
pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optional()),
|
|
53
55
|
metadata: Metadata_js_1.Metadata.optional(),
|
|
54
56
|
updatedAt: core.serialization.property("updated_at", core.serialization.date()),
|
|
55
57
|
createdAt: core.serialization.property("created_at", core.serialization.date()),
|
|
@@ -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();
|
|
@@ -3,12 +3,14 @@ import * as core from "../../../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../../../index.js";
|
|
4
4
|
import { DisplayName } from "./DisplayName.js";
|
|
5
5
|
import { InboxStatus } from "./InboxStatus.js";
|
|
6
|
+
import { PauseAt } from "./PauseAt.js";
|
|
6
7
|
import { UpdateMetadata } from "./UpdateMetadata.js";
|
|
7
8
|
export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
|
|
8
9
|
export declare namespace UpdateInboxRequest {
|
|
9
10
|
interface Raw {
|
|
10
11
|
display_name?: DisplayName.Raw | null;
|
|
11
12
|
status?: InboxStatus.Raw | null;
|
|
13
|
+
pause_at?: (PauseAt.Raw | null | undefined) | null;
|
|
12
14
|
metadata?: (UpdateMetadata.Raw | null | undefined) | null;
|
|
13
15
|
}
|
|
14
16
|
}
|
|
@@ -38,9 +38,11 @@ exports.UpdateInboxRequest = void 0;
|
|
|
38
38
|
const core = __importStar(require("../../../../core/index.js"));
|
|
39
39
|
const DisplayName_js_1 = require("./DisplayName.js");
|
|
40
40
|
const InboxStatus_js_1 = require("./InboxStatus.js");
|
|
41
|
+
const PauseAt_js_1 = require("./PauseAt.js");
|
|
41
42
|
const UpdateMetadata_js_1 = require("./UpdateMetadata.js");
|
|
42
43
|
exports.UpdateInboxRequest = core.serialization.object({
|
|
43
44
|
displayName: core.serialization.property("display_name", DisplayName_js_1.DisplayName.optional()),
|
|
44
45
|
status: InboxStatus_js_1.InboxStatus.optional(),
|
|
46
|
+
pauseAt: core.serialization.property("pause_at", PauseAt_js_1.PauseAt.optionalNullable()),
|
|
45
47
|
metadata: UpdateMetadata_js_1.UpdateMetadata.optionalNullable(),
|
|
46
48
|
});
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.js";
|
|
|
10
10
|
export * from "./ListInboxesResponse.js";
|
|
11
11
|
export * from "./Metadata.js";
|
|
12
12
|
export * from "./MetadataValue.js";
|
|
13
|
+
export * from "./PauseAt.js";
|
|
13
14
|
export * from "./SearchInboxesResponse.js";
|
|
14
15
|
export * from "./UpdateInboxRequest.js";
|
|
15
16
|
export * from "./UpdateMetadata.js";
|
|
@@ -26,6 +26,7 @@ __exportStar(require("./InboxStatus.js"), exports);
|
|
|
26
26
|
__exportStar(require("./ListInboxesResponse.js"), exports);
|
|
27
27
|
__exportStar(require("./Metadata.js"), exports);
|
|
28
28
|
__exportStar(require("./MetadataValue.js"), exports);
|
|
29
|
+
__exportStar(require("./PauseAt.js"), exports);
|
|
29
30
|
__exportStar(require("./SearchInboxesResponse.js"), exports);
|
|
30
31
|
__exportStar(require("./UpdateInboxRequest.js"), exports);
|
|
31
32
|
__exportStar(require("./UpdateMetadata.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.5.
|
|
1
|
+
export declare const SDK_VERSION = "0.5.48";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -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.
|
|
10
|
-
"User-Agent": "agentmail/0.5.
|
|
9
|
+
"X-Fern-SDK-Version": "0.5.48",
|
|
10
|
+
"User-Agent": "agentmail/0.5.48",
|
|
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.
|
|
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.
|
|
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,8 @@ 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;
|
|
15
17
|
/** Custom metadata to attach to the inbox. */
|
|
16
18
|
metadata?: AgentMail.inboxes.Metadata;
|
|
17
19
|
}
|
|
@@ -11,6 +11,11 @@ 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;
|
|
14
19
|
/** Custom metadata attached to the inbox. */
|
|
15
20
|
metadata?: AgentMail.inboxes.Metadata;
|
|
16
21
|
/** Time at which inbox was last updated. */
|
|
@@ -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;
|
|
@@ -7,13 +7,19 @@ 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;
|
|
10
16
|
/**
|
|
11
17
|
* Metadata to merge into the inbox's existing metadata. Keys you include
|
|
12
18
|
* are added or overwritten; keys you omit are left unchanged. To remove a
|
|
13
19
|
* single key, send it with a null value. To clear all metadata, send
|
|
14
20
|
* `metadata` as null. Sending an empty object is rejected; use null to
|
|
15
21
|
* clear. Each update must include at least one of `display_name`,
|
|
16
|
-
* `status`, or `metadata`.
|
|
22
|
+
* `status`, `pause_at`, or `metadata`.
|
|
17
23
|
*/
|
|
18
24
|
metadata?: AgentMail.inboxes.UpdateMetadata | null;
|
|
19
25
|
}
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
|
@@ -5,6 +5,7 @@ import { ClientId } from "./ClientId.mjs";
|
|
|
5
5
|
import { DisplayName } from "./DisplayName.mjs";
|
|
6
6
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
7
7
|
import { Metadata } from "./Metadata.mjs";
|
|
8
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
8
9
|
export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
|
|
9
10
|
export declare namespace CreateInboxRequest {
|
|
10
11
|
interface Raw {
|
|
@@ -13,6 +14,7 @@ export declare namespace CreateInboxRequest {
|
|
|
13
14
|
display_name?: DisplayName.Raw | null;
|
|
14
15
|
client_id?: ClientId.Raw | null;
|
|
15
16
|
status?: InboxStatus.Raw | null;
|
|
17
|
+
pause_at?: PauseAt.Raw | null;
|
|
16
18
|
metadata?: Metadata.Raw | null;
|
|
17
19
|
}
|
|
18
20
|
}
|
|
@@ -4,11 +4,13 @@ import { ClientId } from "./ClientId.mjs";
|
|
|
4
4
|
import { DisplayName } from "./DisplayName.mjs";
|
|
5
5
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
6
6
|
import { Metadata } from "./Metadata.mjs";
|
|
7
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
7
8
|
export const CreateInboxRequest = core.serialization.object({
|
|
8
9
|
username: core.serialization.string().optional(),
|
|
9
10
|
domain: core.serialization.string().optional(),
|
|
10
11
|
displayName: core.serialization.property("display_name", DisplayName.optional()),
|
|
11
12
|
clientId: core.serialization.property("client_id", ClientId.optional()),
|
|
12
13
|
status: InboxStatus.optional(),
|
|
14
|
+
pauseAt: core.serialization.property("pause_at", PauseAt.optional()),
|
|
13
15
|
metadata: Metadata.optional(),
|
|
14
16
|
});
|
|
@@ -8,6 +8,7 @@ import { Email } from "./Email.mjs";
|
|
|
8
8
|
import { InboxId } from "./InboxId.mjs";
|
|
9
9
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
10
10
|
import { Metadata } from "./Metadata.mjs";
|
|
11
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
11
12
|
export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
|
|
12
13
|
export declare namespace Inbox {
|
|
13
14
|
interface Raw {
|
|
@@ -17,6 +18,7 @@ export declare namespace Inbox {
|
|
|
17
18
|
display_name?: DisplayName.Raw | null;
|
|
18
19
|
client_id?: ClientId.Raw | null;
|
|
19
20
|
status?: InboxStatus.Raw | null;
|
|
21
|
+
pause_at?: PauseAt.Raw | null;
|
|
20
22
|
metadata?: Metadata.Raw | null;
|
|
21
23
|
updated_at: string;
|
|
22
24
|
created_at: string;
|
|
@@ -7,6 +7,7 @@ import { Email } from "./Email.mjs";
|
|
|
7
7
|
import { InboxId } from "./InboxId.mjs";
|
|
8
8
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
9
9
|
import { Metadata } from "./Metadata.mjs";
|
|
10
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
10
11
|
export const Inbox = core.serialization.object({
|
|
11
12
|
podId: core.serialization.property("pod_id", PodId),
|
|
12
13
|
inboxId: core.serialization.property("inbox_id", InboxId),
|
|
@@ -14,6 +15,7 @@ export const Inbox = core.serialization.object({
|
|
|
14
15
|
displayName: core.serialization.property("display_name", DisplayName.optional()),
|
|
15
16
|
clientId: core.serialization.property("client_id", ClientId.optional()),
|
|
16
17
|
status: InboxStatus.optional(),
|
|
18
|
+
pauseAt: core.serialization.property("pause_at", PauseAt.optional()),
|
|
17
19
|
metadata: Metadata.optional(),
|
|
18
20
|
updatedAt: core.serialization.property("updated_at", core.serialization.date()),
|
|
19
21
|
createdAt: core.serialization.property("created_at", core.serialization.date()),
|
|
@@ -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
|
+
}
|
|
@@ -3,12 +3,14 @@ import * as core from "../../../../core/index.mjs";
|
|
|
3
3
|
import type * as serializers from "../../../index.mjs";
|
|
4
4
|
import { DisplayName } from "./DisplayName.mjs";
|
|
5
5
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
6
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
6
7
|
import { UpdateMetadata } from "./UpdateMetadata.mjs";
|
|
7
8
|
export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
|
|
8
9
|
export declare namespace UpdateInboxRequest {
|
|
9
10
|
interface Raw {
|
|
10
11
|
display_name?: DisplayName.Raw | null;
|
|
11
12
|
status?: InboxStatus.Raw | null;
|
|
13
|
+
pause_at?: (PauseAt.Raw | null | undefined) | null;
|
|
12
14
|
metadata?: (UpdateMetadata.Raw | null | undefined) | null;
|
|
13
15
|
}
|
|
14
16
|
}
|
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
import * as core from "../../../../core/index.mjs";
|
|
3
3
|
import { DisplayName } from "./DisplayName.mjs";
|
|
4
4
|
import { InboxStatus } from "./InboxStatus.mjs";
|
|
5
|
+
import { PauseAt } from "./PauseAt.mjs";
|
|
5
6
|
import { UpdateMetadata } from "./UpdateMetadata.mjs";
|
|
6
7
|
export const UpdateInboxRequest = core.serialization.object({
|
|
7
8
|
displayName: core.serialization.property("display_name", DisplayName.optional()),
|
|
8
9
|
status: InboxStatus.optional(),
|
|
10
|
+
pauseAt: core.serialization.property("pause_at", PauseAt.optionalNullable()),
|
|
9
11
|
metadata: UpdateMetadata.optionalNullable(),
|
|
10
12
|
});
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.5.
|
|
1
|
+
export declare const SDK_VERSION = "0.5.48";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.5.
|
|
1
|
+
export const SDK_VERSION = "0.5.48";
|
package/package.json
CHANGED
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.
|
|
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>
|