agentmail 0.5.25 → 0.5.27
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/domains/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/domains/client/Client.js +9 -0
- package/dist/cjs/api/resources/domains/types/CreateDomainRequest.d.ts +8 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/inboxes/client/Client.js +4 -3
- package/dist/cjs/api/resources/inboxes/types/AuthorizeInboxResponse.d.ts +11 -0
- package/dist/cjs/api/resources/inboxes/types/AuthorizeInboxResponse.js +3 -0
- 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/api/resources/pods/resources/domains/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +9 -0
- package/dist/cjs/api/resources/providers/types/Provider.d.ts +2 -0
- package/dist/cjs/serialization/resources/domains/types/CreateDomainRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/domains/types/CreateDomainRequest.js +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/AuthorizeInboxResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/inboxes/types/AuthorizeInboxResponse.js +43 -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/serialization/resources/providers/types/Provider.d.ts +1 -0
- package/dist/cjs/serialization/resources/providers/types/Provider.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/domains/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/domains/client/Client.mjs +9 -0
- package/dist/esm/api/resources/domains/types/CreateDomainRequest.d.mts +8 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/inboxes/client/Client.mjs +4 -3
- package/dist/esm/api/resources/inboxes/types/AuthorizeInboxResponse.d.mts +11 -0
- package/dist/esm/api/resources/inboxes/types/AuthorizeInboxResponse.mjs +2 -0
- 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/api/resources/pods/resources/domains/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +9 -0
- package/dist/esm/api/resources/providers/types/Provider.d.mts +2 -0
- package/dist/esm/serialization/resources/domains/types/CreateDomainRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/domains/types/CreateDomainRequest.mjs +1 -0
- package/dist/esm/serialization/resources/inboxes/types/AuthorizeInboxResponse.d.mts +11 -0
- package/dist/esm/serialization/resources/inboxes/types/AuthorizeInboxResponse.mjs +7 -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/serialization/resources/providers/types/Provider.d.mts +1 -0
- package/dist/esm/serialization/resources/providers/types/Provider.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +0 -1
- package/dist/llms.txt +7 -14
- package/package.json +1 -1
- package/reference.md +4 -3
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.27",
|
|
47
|
+
"User-Agent": "agentmail/0.5.27",
|
|
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);
|
|
@@ -60,6 +60,7 @@ export declare class DomainsClient {
|
|
|
60
60
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link AgentMail.ValidationError}
|
|
63
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
63
64
|
*
|
|
64
65
|
* @example
|
|
65
66
|
* await client.domains.create({
|
|
@@ -246,6 +246,7 @@ class DomainsClient {
|
|
|
246
246
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
247
247
|
*
|
|
248
248
|
* @throws {@link AgentMail.ValidationError}
|
|
249
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
249
250
|
*
|
|
250
251
|
* @example
|
|
251
252
|
* await client.domains.create({
|
|
@@ -300,6 +301,14 @@ class DomainsClient {
|
|
|
300
301
|
skipValidation: true,
|
|
301
302
|
breadcrumbsPrefix: ["response"],
|
|
302
303
|
}), _response.rawResponse);
|
|
304
|
+
case 422:
|
|
305
|
+
throw new AgentMail.UnprocessableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
|
|
306
|
+
unrecognizedObjectKeys: "passthrough",
|
|
307
|
+
allowUnrecognizedUnionMembers: true,
|
|
308
|
+
allowUnrecognizedEnumValues: true,
|
|
309
|
+
skipValidation: true,
|
|
310
|
+
breadcrumbsPrefix: ["response"],
|
|
311
|
+
}), _response.rawResponse);
|
|
303
312
|
default:
|
|
304
313
|
throw new errors.AgentMailError({
|
|
305
314
|
statusCode: _response.error.statusCode,
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
import type * as AgentMail from "../../../index.js";
|
|
2
2
|
export interface CreateDomainRequest {
|
|
3
3
|
domain: AgentMail.DomainName;
|
|
4
|
+
/**
|
|
5
|
+
* Allow registration when the domain already has Google Workspace MX records.
|
|
6
|
+
* Defaults to false; registration otherwise returns 422 when a conflicting
|
|
7
|
+
* provider is detected.
|
|
8
|
+
* This flag does not configure DNS or inbound routing. For shared Google
|
|
9
|
+
* Workspace domains, follow the [Google Workspace guide](/google-workspace).
|
|
10
|
+
*/
|
|
11
|
+
allowConflictingProvider?: boolean;
|
|
4
12
|
feedbackEnabled?: AgentMail.FeedbackEnabled;
|
|
5
13
|
subdomainsEnabled?: AgentMail.SubdomainsEnabled;
|
|
6
14
|
trackingEnabled?: AgentMail.TrackingEnabled;
|
|
@@ -137,8 +137,9 @@ export declare class InboxesClient {
|
|
|
137
137
|
private __delete;
|
|
138
138
|
/**
|
|
139
139
|
* Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
140
|
-
* inbox in the path, and returns the pending public key it will
|
|
141
|
-
*
|
|
140
|
+
* inbox in the path, and returns the ID of the pending public key it will
|
|
141
|
+
* activate. Read the key with Get API Key. A repeat for the same token,
|
|
142
|
+
* inbox, and bearer returns the same key ID.
|
|
142
143
|
*
|
|
143
144
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
144
145
|
* @param {AgentMail.inboxes.AuthorizeInboxRequest} request
|
|
@@ -152,6 +153,6 @@ export declare class InboxesClient {
|
|
|
152
153
|
* authToken: "blackcurrant.........."
|
|
153
154
|
* })
|
|
154
155
|
*/
|
|
155
|
-
authorize(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.AuthorizeInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.
|
|
156
|
+
authorize(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.AuthorizeInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.AuthorizeInboxResponse>;
|
|
156
157
|
private __authorize;
|
|
157
158
|
}
|
|
@@ -525,8 +525,9 @@ class InboxesClient {
|
|
|
525
525
|
}
|
|
526
526
|
/**
|
|
527
527
|
* Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
528
|
-
* inbox in the path, and returns the pending public key it will
|
|
529
|
-
*
|
|
528
|
+
* inbox in the path, and returns the ID of the pending public key it will
|
|
529
|
+
* activate. Read the key with Get API Key. A repeat for the same token,
|
|
530
|
+
* inbox, and bearer returns the same key ID.
|
|
530
531
|
*
|
|
531
532
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
532
533
|
* @param {AgentMail.inboxes.AuthorizeInboxRequest} request
|
|
@@ -568,7 +569,7 @@ class InboxesClient {
|
|
|
568
569
|
});
|
|
569
570
|
if (_response.ok) {
|
|
570
571
|
return {
|
|
571
|
-
data: serializers.
|
|
572
|
+
data: serializers.inboxes.AuthorizeInboxResponse.parseOrThrow(_response.body, {
|
|
572
573
|
unrecognizedObjectKeys: "passthrough",
|
|
573
574
|
allowUnrecognizedUnionMembers: true,
|
|
574
575
|
allowUnrecognizedEnumValues: true,
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* The authorized sign-in's key ID plus the agent's next step. The key itself
|
|
4
|
+
* is read with Get API Key.
|
|
5
|
+
*/
|
|
6
|
+
export interface AuthorizeInboxResponse {
|
|
7
|
+
/** ID of the public key the client will activate. */
|
|
8
|
+
apiKeyId: AgentMail.ApiKeyId;
|
|
9
|
+
/** The agent's next step. Nothing further is required from the agent. */
|
|
10
|
+
instructions: "Authorization complete. Return to browser.";
|
|
11
|
+
}
|
|
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./AuthorizeInboxRequest.js"), exports);
|
|
18
|
+
__exportStar(require("./AuthorizeInboxResponse.js"), exports);
|
|
18
19
|
__exportStar(require("./ClientId.js"), exports);
|
|
19
20
|
__exportStar(require("./CreateInboxRequest.js"), exports);
|
|
20
21
|
__exportStar(require("./DisplayName.js"), exports);
|
|
@@ -65,6 +65,7 @@ export declare class DomainsClient {
|
|
|
65
65
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link AgentMail.ValidationError}
|
|
68
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
68
69
|
*
|
|
69
70
|
* @example
|
|
70
71
|
* await client.pods.domains.create("pod_id", {
|
|
@@ -262,6 +262,7 @@ class DomainsClient {
|
|
|
262
262
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
263
263
|
*
|
|
264
264
|
* @throws {@link AgentMail.ValidationError}
|
|
265
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
265
266
|
*
|
|
266
267
|
* @example
|
|
267
268
|
* await client.pods.domains.create("pod_id", {
|
|
@@ -316,6 +317,14 @@ class DomainsClient {
|
|
|
316
317
|
skipValidation: true,
|
|
317
318
|
breadcrumbsPrefix: ["response"],
|
|
318
319
|
}), _response.rawResponse);
|
|
320
|
+
case 422:
|
|
321
|
+
throw new AgentMail.UnprocessableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
|
|
322
|
+
unrecognizedObjectKeys: "passthrough",
|
|
323
|
+
allowUnrecognizedUnionMembers: true,
|
|
324
|
+
allowUnrecognizedEnumValues: true,
|
|
325
|
+
skipValidation: true,
|
|
326
|
+
breadcrumbsPrefix: ["response"],
|
|
327
|
+
}), _response.rawResponse);
|
|
319
328
|
default:
|
|
320
329
|
throw new errors.AgentMailError({
|
|
321
330
|
statusCode: _response.error.statusCode,
|
|
@@ -11,4 +11,6 @@ export interface Provider {
|
|
|
11
11
|
logoUrl?: string;
|
|
12
12
|
termsUrl?: string;
|
|
13
13
|
privacyUrl?: string;
|
|
14
|
+
/** Maximum number of accounts your organization may sign up at this provider. Omitted when the provider sets no limit. 0 means the provider has paused new sign-ups; existing accounts keep signing in. */
|
|
15
|
+
ownerSignupLimit?: number;
|
|
14
16
|
}
|
|
@@ -9,6 +9,7 @@ export declare const CreateDomainRequest: core.serialization.ObjectSchema<serial
|
|
|
9
9
|
export declare namespace CreateDomainRequest {
|
|
10
10
|
interface Raw {
|
|
11
11
|
domain: DomainName.Raw;
|
|
12
|
+
allow_conflicting_provider?: boolean | null;
|
|
12
13
|
feedback_enabled?: FeedbackEnabled.Raw | null;
|
|
13
14
|
subdomains_enabled?: SubdomainsEnabled.Raw | null;
|
|
14
15
|
tracking_enabled?: TrackingEnabled.Raw | null;
|
|
@@ -42,6 +42,7 @@ const SubdomainsEnabled_js_1 = require("./SubdomainsEnabled.js");
|
|
|
42
42
|
const TrackingEnabled_js_1 = require("./TrackingEnabled.js");
|
|
43
43
|
exports.CreateDomainRequest = core.serialization.object({
|
|
44
44
|
domain: DomainName_js_1.DomainName,
|
|
45
|
+
allowConflictingProvider: core.serialization.property("allow_conflicting_provider", core.serialization.boolean().optional()),
|
|
45
46
|
feedbackEnabled: core.serialization.property("feedback_enabled", FeedbackEnabled_js_1.FeedbackEnabled.optional()),
|
|
46
47
|
subdomainsEnabled: core.serialization.property("subdomains_enabled", SubdomainsEnabled_js_1.SubdomainsEnabled.optional()),
|
|
47
48
|
trackingEnabled: core.serialization.property("tracking_enabled", TrackingEnabled_js_1.TrackingEnabled.optional()),
|
|
@@ -0,0 +1,11 @@
|
|
|
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
|
+
import { ApiKeyId } from "../../apiKeys/types/ApiKeyId.js";
|
|
5
|
+
export declare const AuthorizeInboxResponse: core.serialization.ObjectSchema<serializers.inboxes.AuthorizeInboxResponse.Raw, AgentMail.inboxes.AuthorizeInboxResponse>;
|
|
6
|
+
export declare namespace AuthorizeInboxResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
api_key_id: ApiKeyId.Raw;
|
|
9
|
+
instructions: "Authorization complete. Return to browser.";
|
|
10
|
+
}
|
|
11
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
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.AuthorizeInboxResponse = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
const ApiKeyId_js_1 = require("../../apiKeys/types/ApiKeyId.js");
|
|
40
|
+
exports.AuthorizeInboxResponse = core.serialization.object({
|
|
41
|
+
apiKeyId: core.serialization.property("api_key_id", ApiKeyId_js_1.ApiKeyId),
|
|
42
|
+
instructions: core.serialization.stringLiteral("Authorization complete. Return to browser."),
|
|
43
|
+
});
|
|
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./AuthorizeInboxRequest.js"), exports);
|
|
18
|
+
__exportStar(require("./AuthorizeInboxResponse.js"), exports);
|
|
18
19
|
__exportStar(require("./ClientId.js"), exports);
|
|
19
20
|
__exportStar(require("./CreateInboxRequest.js"), exports);
|
|
20
21
|
__exportStar(require("./DisplayName.js"), exports);
|
|
@@ -45,4 +45,5 @@ exports.Provider = core.serialization.object({
|
|
|
45
45
|
logoUrl: core.serialization.property("logo_url", core.serialization.string().optional()),
|
|
46
46
|
termsUrl: core.serialization.property("terms_url", core.serialization.string().optional()),
|
|
47
47
|
privacyUrl: core.serialization.property("privacy_url", core.serialization.string().optional()),
|
|
48
|
+
ownerSignupLimit: core.serialization.property("owner_signup_limit", core.serialization.number().optional()),
|
|
48
49
|
});
|
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.27";
|
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.27",
|
|
10
|
+
"User-Agent": "agentmail/0.5.27",
|
|
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);
|
|
@@ -60,6 +60,7 @@ export declare class DomainsClient {
|
|
|
60
60
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link AgentMail.ValidationError}
|
|
63
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
63
64
|
*
|
|
64
65
|
* @example
|
|
65
66
|
* await client.domains.create({
|
|
@@ -210,6 +210,7 @@ export class DomainsClient {
|
|
|
210
210
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
211
211
|
*
|
|
212
212
|
* @throws {@link AgentMail.ValidationError}
|
|
213
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
213
214
|
*
|
|
214
215
|
* @example
|
|
215
216
|
* await client.domains.create({
|
|
@@ -264,6 +265,14 @@ export class DomainsClient {
|
|
|
264
265
|
skipValidation: true,
|
|
265
266
|
breadcrumbsPrefix: ["response"],
|
|
266
267
|
}), _response.rawResponse);
|
|
268
|
+
case 422:
|
|
269
|
+
throw new AgentMail.UnprocessableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
|
|
270
|
+
unrecognizedObjectKeys: "passthrough",
|
|
271
|
+
allowUnrecognizedUnionMembers: true,
|
|
272
|
+
allowUnrecognizedEnumValues: true,
|
|
273
|
+
skipValidation: true,
|
|
274
|
+
breadcrumbsPrefix: ["response"],
|
|
275
|
+
}), _response.rawResponse);
|
|
267
276
|
default:
|
|
268
277
|
throw new errors.AgentMailError({
|
|
269
278
|
statusCode: _response.error.statusCode,
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
import type * as AgentMail from "../../../index.mjs";
|
|
2
2
|
export interface CreateDomainRequest {
|
|
3
3
|
domain: AgentMail.DomainName;
|
|
4
|
+
/**
|
|
5
|
+
* Allow registration when the domain already has Google Workspace MX records.
|
|
6
|
+
* Defaults to false; registration otherwise returns 422 when a conflicting
|
|
7
|
+
* provider is detected.
|
|
8
|
+
* This flag does not configure DNS or inbound routing. For shared Google
|
|
9
|
+
* Workspace domains, follow the [Google Workspace guide](/google-workspace).
|
|
10
|
+
*/
|
|
11
|
+
allowConflictingProvider?: boolean;
|
|
4
12
|
feedbackEnabled?: AgentMail.FeedbackEnabled;
|
|
5
13
|
subdomainsEnabled?: AgentMail.SubdomainsEnabled;
|
|
6
14
|
trackingEnabled?: AgentMail.TrackingEnabled;
|
|
@@ -137,8 +137,9 @@ export declare class InboxesClient {
|
|
|
137
137
|
private __delete;
|
|
138
138
|
/**
|
|
139
139
|
* Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
140
|
-
* inbox in the path, and returns the pending public key it will
|
|
141
|
-
*
|
|
140
|
+
* inbox in the path, and returns the ID of the pending public key it will
|
|
141
|
+
* activate. Read the key with Get API Key. A repeat for the same token,
|
|
142
|
+
* inbox, and bearer returns the same key ID.
|
|
142
143
|
*
|
|
143
144
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
144
145
|
* @param {AgentMail.inboxes.AuthorizeInboxRequest} request
|
|
@@ -152,6 +153,6 @@ export declare class InboxesClient {
|
|
|
152
153
|
* authToken: "blackcurrant.........."
|
|
153
154
|
* })
|
|
154
155
|
*/
|
|
155
|
-
authorize(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.AuthorizeInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.
|
|
156
|
+
authorize(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.AuthorizeInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.AuthorizeInboxResponse>;
|
|
156
157
|
private __authorize;
|
|
157
158
|
}
|
|
@@ -489,8 +489,9 @@ export class InboxesClient {
|
|
|
489
489
|
}
|
|
490
490
|
/**
|
|
491
491
|
* Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
492
|
-
* inbox in the path, and returns the pending public key it will
|
|
493
|
-
*
|
|
492
|
+
* inbox in the path, and returns the ID of the pending public key it will
|
|
493
|
+
* activate. Read the key with Get API Key. A repeat for the same token,
|
|
494
|
+
* inbox, and bearer returns the same key ID.
|
|
494
495
|
*
|
|
495
496
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
496
497
|
* @param {AgentMail.inboxes.AuthorizeInboxRequest} request
|
|
@@ -532,7 +533,7 @@ export class InboxesClient {
|
|
|
532
533
|
});
|
|
533
534
|
if (_response.ok) {
|
|
534
535
|
return {
|
|
535
|
-
data: serializers.
|
|
536
|
+
data: serializers.inboxes.AuthorizeInboxResponse.parseOrThrow(_response.body, {
|
|
536
537
|
unrecognizedObjectKeys: "passthrough",
|
|
537
538
|
allowUnrecognizedUnionMembers: true,
|
|
538
539
|
allowUnrecognizedEnumValues: true,
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* The authorized sign-in's key ID plus the agent's next step. The key itself
|
|
4
|
+
* is read with Get API Key.
|
|
5
|
+
*/
|
|
6
|
+
export interface AuthorizeInboxResponse {
|
|
7
|
+
/** ID of the public key the client will activate. */
|
|
8
|
+
apiKeyId: AgentMail.ApiKeyId;
|
|
9
|
+
/** The agent's next step. Nothing further is required from the agent. */
|
|
10
|
+
instructions: "Authorization complete. Return to browser.";
|
|
11
|
+
}
|
|
@@ -65,6 +65,7 @@ export declare class DomainsClient {
|
|
|
65
65
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link AgentMail.ValidationError}
|
|
68
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
68
69
|
*
|
|
69
70
|
* @example
|
|
70
71
|
* await client.pods.domains.create("pod_id", {
|
|
@@ -226,6 +226,7 @@ export class DomainsClient {
|
|
|
226
226
|
* @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
227
227
|
*
|
|
228
228
|
* @throws {@link AgentMail.ValidationError}
|
|
229
|
+
* @throws {@link AgentMail.UnprocessableError}
|
|
229
230
|
*
|
|
230
231
|
* @example
|
|
231
232
|
* await client.pods.domains.create("pod_id", {
|
|
@@ -280,6 +281,14 @@ export class DomainsClient {
|
|
|
280
281
|
skipValidation: true,
|
|
281
282
|
breadcrumbsPrefix: ["response"],
|
|
282
283
|
}), _response.rawResponse);
|
|
284
|
+
case 422:
|
|
285
|
+
throw new AgentMail.UnprocessableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
|
|
286
|
+
unrecognizedObjectKeys: "passthrough",
|
|
287
|
+
allowUnrecognizedUnionMembers: true,
|
|
288
|
+
allowUnrecognizedEnumValues: true,
|
|
289
|
+
skipValidation: true,
|
|
290
|
+
breadcrumbsPrefix: ["response"],
|
|
291
|
+
}), _response.rawResponse);
|
|
283
292
|
default:
|
|
284
293
|
throw new errors.AgentMailError({
|
|
285
294
|
statusCode: _response.error.statusCode,
|
|
@@ -11,4 +11,6 @@ export interface Provider {
|
|
|
11
11
|
logoUrl?: string;
|
|
12
12
|
termsUrl?: string;
|
|
13
13
|
privacyUrl?: string;
|
|
14
|
+
/** Maximum number of accounts your organization may sign up at this provider. Omitted when the provider sets no limit. 0 means the provider has paused new sign-ups; existing accounts keep signing in. */
|
|
15
|
+
ownerSignupLimit?: number;
|
|
14
16
|
}
|
|
@@ -9,6 +9,7 @@ export declare const CreateDomainRequest: core.serialization.ObjectSchema<serial
|
|
|
9
9
|
export declare namespace CreateDomainRequest {
|
|
10
10
|
interface Raw {
|
|
11
11
|
domain: DomainName.Raw;
|
|
12
|
+
allow_conflicting_provider?: boolean | null;
|
|
12
13
|
feedback_enabled?: FeedbackEnabled.Raw | null;
|
|
13
14
|
subdomains_enabled?: SubdomainsEnabled.Raw | null;
|
|
14
15
|
tracking_enabled?: TrackingEnabled.Raw | null;
|
|
@@ -6,6 +6,7 @@ import { SubdomainsEnabled } from "./SubdomainsEnabled.mjs";
|
|
|
6
6
|
import { TrackingEnabled } from "./TrackingEnabled.mjs";
|
|
7
7
|
export const CreateDomainRequest = core.serialization.object({
|
|
8
8
|
domain: DomainName,
|
|
9
|
+
allowConflictingProvider: core.serialization.property("allow_conflicting_provider", core.serialization.boolean().optional()),
|
|
9
10
|
feedbackEnabled: core.serialization.property("feedback_enabled", FeedbackEnabled.optional()),
|
|
10
11
|
subdomainsEnabled: core.serialization.property("subdomains_enabled", SubdomainsEnabled.optional()),
|
|
11
12
|
trackingEnabled: core.serialization.property("tracking_enabled", TrackingEnabled.optional()),
|
|
@@ -0,0 +1,11 @@
|
|
|
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
|
+
import { ApiKeyId } from "../../apiKeys/types/ApiKeyId.mjs";
|
|
5
|
+
export declare const AuthorizeInboxResponse: core.serialization.ObjectSchema<serializers.inboxes.AuthorizeInboxResponse.Raw, AgentMail.inboxes.AuthorizeInboxResponse>;
|
|
6
|
+
export declare namespace AuthorizeInboxResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
api_key_id: ApiKeyId.Raw;
|
|
9
|
+
instructions: "Authorization complete. Return to browser.";
|
|
10
|
+
}
|
|
11
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.mjs";
|
|
3
|
+
import { ApiKeyId } from "../../apiKeys/types/ApiKeyId.mjs";
|
|
4
|
+
export const AuthorizeInboxResponse = core.serialization.object({
|
|
5
|
+
apiKeyId: core.serialization.property("api_key_id", ApiKeyId),
|
|
6
|
+
instructions: core.serialization.stringLiteral("Authorization complete. Return to browser."),
|
|
7
|
+
});
|
|
@@ -9,4 +9,5 @@ export const Provider = core.serialization.object({
|
|
|
9
9
|
logoUrl: core.serialization.property("logo_url", core.serialization.string().optional()),
|
|
10
10
|
termsUrl: core.serialization.property("terms_url", core.serialization.string().optional()),
|
|
11
11
|
privacyUrl: core.serialization.property("privacy_url", core.serialization.string().optional()),
|
|
12
|
+
ownerSignupLimit: core.serialization.property("owner_signup_limit", core.serialization.number().optional()),
|
|
12
13
|
});
|
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.27";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.5.
|
|
1
|
+
export const SDK_VERSION = "0.5.27";
|
package/dist/llms-full.txt
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
Redirecting...
|
package/dist/llms.txt
CHANGED
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
- [MPP](https://docs.agentmail.to/integrations/mpp.md): AgentMail's MPP integration for machine-to-machine payments via Stripe
|
|
36
36
|
- [Integrate LiveKit Agents](https://docs.agentmail.to/integrate-livekit-agents.md): A step-by-step guide to integrate with the LiveKit Agents SDK.
|
|
37
37
|
- [Sim.ai](https://docs.agentmail.to/integrations/sim.md): AgentMail's Sim.ai integration
|
|
38
|
-
- [AgentID
|
|
39
|
-
- [AgentID Public-Key Authentication](https://docs.agentmail.to/agentid-public-key-authentication.md):
|
|
38
|
+
- [AgentID Sign-In](https://docs.agentmail.to/agentid-sign-in.md): Connect an inbox to a provider, authorize a pending AgentID sign-in, and manage sign-in keys with the AgentMail API and CLI.
|
|
39
|
+
- [AgentID Public-Key Authentication](https://docs.agentmail.to/agentid-public-key-authentication.md): Register a public P-256 key, choose its scope and permissions, and manage it through the current AgentMail API Keys endpoints.
|
|
40
40
|
- [Guide: Sending & Receiving Email](https://docs.agentmail.to/sending-receiving-email.md): A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
|
|
41
41
|
- [IMAP & SMTP](https://docs.agentmail.to/imap-smtp.md): Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
|
|
42
42
|
- [Guide: Multi-Tenancy](https://docs.agentmail.to/multi-tenancy.md): How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
|
|
@@ -104,6 +104,7 @@
|
|
|
104
104
|
- API Reference > Inboxes [Create Inbox](https://docs.agentmail.to/api-reference/inboxes/create.md)
|
|
105
105
|
- API Reference > Inboxes [Update Inbox](https://docs.agentmail.to/api-reference/inboxes/update.md)
|
|
106
106
|
- API Reference > Inboxes [Delete Inbox](https://docs.agentmail.to/api-reference/inboxes/delete.md)
|
|
107
|
+
- API Reference > Inboxes [Authorize Inbox](https://docs.agentmail.to/api-reference/inboxes/authorize.md)
|
|
107
108
|
- API Reference > Inboxes > Threads [List Threads](https://docs.agentmail.to/api-reference/inboxes/threads/list.md)
|
|
108
109
|
- API Reference > Inboxes > Threads [Search Threads](https://docs.agentmail.to/api-reference/inboxes/threads/search.md)
|
|
109
110
|
- API Reference > Inboxes > Threads [Get Thread](https://docs.agentmail.to/api-reference/inboxes/threads/get.md)
|
|
@@ -130,7 +131,6 @@
|
|
|
130
131
|
- API Reference > Inboxes > Drafts [Update Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/update.md)
|
|
131
132
|
- API Reference > Inboxes > Drafts [Delete Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/delete.md)
|
|
132
133
|
- API Reference > Inboxes > Drafts [Send Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/send.md)
|
|
133
|
-
- API Reference > Inboxes > Browser Credentials [Create Browser Enrollment](https://docs.agentmail.to/api-reference/inboxes/browser-credentials/create-enrollment.md)
|
|
134
134
|
- API Reference > Inboxes > Webhooks [List Webhooks](https://docs.agentmail.to/api-reference/inboxes/webhooks/list.md)
|
|
135
135
|
- API Reference > Inboxes > Webhooks [Get Webhook](https://docs.agentmail.to/api-reference/inboxes/webhooks/get.md)
|
|
136
136
|
- API Reference > Inboxes > Webhooks [Get Webhook Headers](https://docs.agentmail.to/api-reference/inboxes/webhooks/get-headers.md)
|
|
@@ -147,6 +147,7 @@
|
|
|
147
147
|
- API Reference > Inboxes > Events [List Inbox Events](https://docs.agentmail.to/api-reference/inboxes/events/list.md)
|
|
148
148
|
- API Reference > Inboxes > API Keys [List API Keys](https://docs.agentmail.to/api-reference/inboxes/api-keys/list.md)
|
|
149
149
|
- API Reference > Inboxes > API Keys [Create API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/create.md)
|
|
150
|
+
- API Reference > Inboxes > API Keys [Update API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/update.md)
|
|
150
151
|
- API Reference > Inboxes > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/delete.md)
|
|
151
152
|
- API Reference > Threads [List Threads](https://docs.agentmail.to/api-reference/threads/list.md)
|
|
152
153
|
- API Reference > Threads [Search Threads](https://docs.agentmail.to/api-reference/threads/search.md)
|
|
@@ -188,19 +189,10 @@
|
|
|
188
189
|
- API Reference > Metrics [Query Events](https://docs.agentmail.to/api-reference/metrics/query-events.md)
|
|
189
190
|
- API Reference > Metrics [Query Usage](https://docs.agentmail.to/api-reference/metrics/query-usage.md)
|
|
190
191
|
- API Reference > API Keys [List API Keys](https://docs.agentmail.to/api-reference/api-keys/list.md)
|
|
192
|
+
- API Reference > API Keys [Get API Key](https://docs.agentmail.to/api-reference/api-keys/get.md)
|
|
191
193
|
- API Reference > API Keys [Create API Key](https://docs.agentmail.to/api-reference/api-keys/create.md)
|
|
194
|
+
- API Reference > API Keys [Update API Key](https://docs.agentmail.to/api-reference/api-keys/update.md)
|
|
192
195
|
- API Reference > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/api-keys/delete.md)
|
|
193
|
-
- API Reference > API Keys [List Public-Key Credentials](https://docs.agentmail.to/api-reference/api-keys/list-public-keys.md)
|
|
194
|
-
- API Reference > API Keys [Register Public-Key Credential](https://docs.agentmail.to/api-reference/api-keys/create-public-key.md)
|
|
195
|
-
- API Reference > API Keys [Rename Public-Key Credential](https://docs.agentmail.to/api-reference/api-keys/update-public-key-name.md)
|
|
196
|
-
- API Reference > API Keys [Revoke Public-Key Credential](https://docs.agentmail.to/api-reference/api-keys/revoke-public-key.md)
|
|
197
|
-
- API Reference > API Keys [Revoke All AgentID Sign-In Keys](https://docs.agentmail.to/api-reference/api-keys/revoke-all-agent-id-sign-in-keys.md)
|
|
198
|
-
- API Reference > API Keys [List Browser Credentials](https://docs.agentmail.to/api-reference/api-keys/list-browser-credentials.md)
|
|
199
|
-
- API Reference > API Keys [List Browser Credential Events](https://docs.agentmail.to/api-reference/api-keys/list-browser-credential-events.md)
|
|
200
|
-
- API Reference > API Keys [Delete Browser Credential](https://docs.agentmail.to/api-reference/api-keys/delete-browser-credential.md)
|
|
201
|
-
- API Reference > API Keys [Cancel Browser Enrollment](https://docs.agentmail.to/api-reference/api-keys/cancel-browser-enrollment.md)
|
|
202
|
-
- API Reference > API Keys [List Browser Consents](https://docs.agentmail.to/api-reference/api-keys/list-browser-consents.md)
|
|
203
|
-
- API Reference > API Keys [Delete Browser Consent](https://docs.agentmail.to/api-reference/api-keys/delete-browser-consent.md)
|
|
204
196
|
- API Reference > Providers [List Providers](https://docs.agentmail.to/api-reference/providers/list.md)
|
|
205
197
|
- API Reference > Providers [Search Providers](https://docs.agentmail.to/api-reference/providers/search.md)
|
|
206
198
|
- API Reference > Providers [Get Provider](https://docs.agentmail.to/api-reference/providers/get.md)
|
|
@@ -249,6 +241,7 @@
|
|
|
249
241
|
- API Reference > Pods > Metrics [Query Usage](https://docs.agentmail.to/api-reference/pods/metrics/query-usage.md)
|
|
250
242
|
- API Reference > Pods > API Keys [List API Keys](https://docs.agentmail.to/api-reference/pods/api-keys/list.md)
|
|
251
243
|
- API Reference > Pods > API Keys [Create API Key](https://docs.agentmail.to/api-reference/pods/api-keys/create.md)
|
|
244
|
+
- API Reference > Pods > API Keys [Update API Key](https://docs.agentmail.to/api-reference/pods/api-keys/update.md)
|
|
252
245
|
- API Reference > Pods > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/pods/api-keys/delete.md)
|
|
253
246
|
- API Reference > Organizations [Get Organization](https://docs.agentmail.to/api-reference/organizations/get.md)
|
|
254
247
|
- API Reference > Auth [Who Am I](https://docs.agentmail.to/api-reference/auth/me.md)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -408,7 +408,7 @@ await client.inboxes.delete("inbox_id");
|
|
|
408
408
|
</dl>
|
|
409
409
|
</details>
|
|
410
410
|
|
|
411
|
-
<details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">authorize</a>(inbox_id, { ...params }) -> AgentMail.
|
|
411
|
+
<details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">authorize</a>(inbox_id, { ...params }) -> AgentMail.AuthorizeInboxResponse</code></summary>
|
|
412
412
|
<dl>
|
|
413
413
|
<dd>
|
|
414
414
|
|
|
@@ -421,8 +421,9 @@ await client.inboxes.delete("inbox_id");
|
|
|
421
421
|
<dd>
|
|
422
422
|
|
|
423
423
|
Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
424
|
-
inbox in the path, and returns the pending public key it will
|
|
425
|
-
|
|
424
|
+
inbox in the path, and returns the ID of the pending public key it will
|
|
425
|
+
activate. Read the key with Get API Key. A repeat for the same token,
|
|
426
|
+
inbox, and bearer returns the same key ID.
|
|
426
427
|
</dd>
|
|
427
428
|
</dl>
|
|
428
429
|
</dd>
|