@inkbox/sdk 0.2.2 → 0.2.3
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/README.md +198 -12
- package/dist/_http.d.ts +1 -0
- package/dist/_http.d.ts.map +1 -1
- package/dist/_http.js +3 -0
- package/dist/_http.js.map +1 -1
- package/dist/agent_identity.d.ts +6 -3
- package/dist/agent_identity.d.ts.map +1 -1
- package/dist/agent_identity.js +4 -1
- package/dist/agent_identity.js.map +1 -1
- package/dist/identities/resources/identities.d.ts +9 -2
- package/dist/identities/resources/identities.d.ts.map +1 -1
- package/dist/identities/resources/identities.js +12 -4
- package/dist/identities/resources/identities.js.map +1 -1
- package/dist/identities/types.d.ts +33 -0
- package/dist/identities/types.d.ts.map +1 -1
- package/dist/identities/types.js +44 -0
- package/dist/identities/types.js.map +1 -1
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/inkbox.d.ts +16 -5
- package/dist/inkbox.d.ts.map +1 -1
- package/dist/inkbox.js +28 -6
- package/dist/inkbox.js.map +1 -1
- package/dist/mail/resources/mailboxes.d.ts +13 -12
- package/dist/mail/resources/mailboxes.d.ts.map +1 -1
- package/dist/mail/resources/mailboxes.js +17 -16
- package/dist/mail/resources/mailboxes.js.map +1 -1
- package/dist/mail/types.d.ts +1 -1
- package/dist/mail/types.d.ts.map +1 -1
- package/dist/mail/types.js +1 -1
- package/dist/mail/types.js.map +1 -1
- package/dist/phone/resources/texts.d.ts +2 -2
- package/dist/phone/resources/texts.js +2 -2
- package/dist/vault/resources/vault.d.ts +50 -1
- package/dist/vault/resources/vault.d.ts.map +1 -1
- package/dist/vault/resources/vault.js +123 -1
- package/dist/vault/resources/vault.js.map +1 -1
- package/dist/vault/types.d.ts +17 -0
- package/dist/vault/types.d.ts.map +1 -1
- package/dist/vault/types.js.map +1 -1
- package/package.json +1 -1
package/dist/identities/types.js
CHANGED
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* inkbox-identities TypeScript SDK — public types.
|
|
3
3
|
*/
|
|
4
|
+
/**
|
|
5
|
+
* Allowed lifecycle statuses for identity updates.
|
|
6
|
+
*/
|
|
7
|
+
export const ResourceStatus = {
|
|
8
|
+
ACTIVE: "active",
|
|
9
|
+
PAUSED: "paused",
|
|
10
|
+
};
|
|
4
11
|
// ---- parsers ----
|
|
5
12
|
export function parseIdentityMailbox(r) {
|
|
6
13
|
return {
|
|
@@ -31,6 +38,7 @@ export function parseAgentIdentitySummary(r) {
|
|
|
31
38
|
organizationId: r.organization_id,
|
|
32
39
|
agentHandle: r.agent_handle,
|
|
33
40
|
status: r.status,
|
|
41
|
+
emailAddress: r.email_address,
|
|
34
42
|
createdAt: new Date(r.created_at),
|
|
35
43
|
updatedAt: new Date(r.updated_at),
|
|
36
44
|
};
|
|
@@ -42,4 +50,40 @@ export function parseAgentIdentityData(r) {
|
|
|
42
50
|
phoneNumber: r.phone_number ? parseIdentityPhoneNumber(r.phone_number) : null,
|
|
43
51
|
};
|
|
44
52
|
}
|
|
53
|
+
export function identityMailboxCreateOptionsToWire(options) {
|
|
54
|
+
const body = {};
|
|
55
|
+
if (options.displayName !== undefined)
|
|
56
|
+
body["display_name"] = options.displayName;
|
|
57
|
+
if (options.emailLocalPart !== undefined)
|
|
58
|
+
body["email_local_part"] = options.emailLocalPart;
|
|
59
|
+
return body;
|
|
60
|
+
}
|
|
61
|
+
export function identityPhoneNumberCreateOptionsToWire(options) {
|
|
62
|
+
if (options.type === "toll_free" && options.state !== undefined) {
|
|
63
|
+
throw new Error("state is only supported for local phone numbers");
|
|
64
|
+
}
|
|
65
|
+
if (options.incomingCallAction === "auto_accept" && options.clientWebsocketUrl === undefined) {
|
|
66
|
+
throw new Error("clientWebsocketUrl is required for auto_accept");
|
|
67
|
+
}
|
|
68
|
+
if (options.incomingCallAction === "webhook" && options.incomingCallWebhookUrl === undefined) {
|
|
69
|
+
throw new Error("incomingCallWebhookUrl is required for webhook");
|
|
70
|
+
}
|
|
71
|
+
const body = {};
|
|
72
|
+
if (options.type !== undefined)
|
|
73
|
+
body["type"] = options.type;
|
|
74
|
+
if (options.state !== undefined)
|
|
75
|
+
body["state"] = options.state;
|
|
76
|
+
if (options.incomingCallAction !== undefined)
|
|
77
|
+
body["incoming_call_action"] = options.incomingCallAction;
|
|
78
|
+
if (options.clientWebsocketUrl !== undefined)
|
|
79
|
+
body["client_websocket_url"] = options.clientWebsocketUrl;
|
|
80
|
+
if (options.incomingCallWebhookUrl !== undefined)
|
|
81
|
+
body["incoming_call_webhook_url"] = options.incomingCallWebhookUrl;
|
|
82
|
+
if (options.incomingTextWebhookUrl !== undefined)
|
|
83
|
+
body["incoming_text_webhook_url"] = options.incomingTextWebhookUrl;
|
|
84
|
+
return body;
|
|
85
|
+
}
|
|
86
|
+
export function vaultSecretIdsToWire(value) {
|
|
87
|
+
return value;
|
|
88
|
+
}
|
|
45
89
|
//# sourceMappingURL=types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/identities/types.ts"],"names":[],"mappings":"AAAA;;GAEG;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/identities/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AA6GX,oBAAoB;AAEpB,MAAM,UAAU,oBAAoB,CAAC,CAAqB;IACxD,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,YAAY,EAAE,CAAC,CAAC,aAAa;QAC7B,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,CAAyB;IAChE,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,kBAAkB,EAAE,CAAC,CAAC,oBAAoB;QAC1C,kBAAkB,EAAE,CAAC,CAAC,oBAAoB;QAC1C,sBAAsB,EAAE,CAAC,CAAC,yBAAyB,IAAI,IAAI;QAC3D,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,CAA0B;IAClE,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,cAAc,EAAE,CAAC,CAAC,eAAe;QACjC,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,YAAY,EAAE,CAAC,CAAC,aAAa;QAC7B,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,CAAuB;IAC5D,OAAO;QACL,GAAG,yBAAyB,CAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3D,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;KAC9E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kCAAkC,CAChD,OAAqC;IAErC,MAAM,IAAI,GAA2B,EAAE,CAAC;IACxC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;IAClF,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;QAAE,IAAI,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAC5F,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,sCAAsC,CACpD,OAAyC;IAEzC,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,OAAO,CAAC,kBAAkB,KAAK,aAAa,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAC7F,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,IAAI,OAAO,CAAC,sBAAsB,KAAK,SAAS,EAAE,CAAC;QAC7F,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,IAAI,GAA4B,EAAE,CAAC;IACzC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5D,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,IAAI,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/D,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS;QAAE,IAAI,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACxG,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS;QAAE,IAAI,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACxG,IAAI,OAAO,CAAC,sBAAsB,KAAK,SAAS;QAAE,IAAI,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IACrH,IAAI,OAAO,CAAC,sBAAsB,KAAK,SAAS;QAAE,IAAI,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IACrH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAkD;IAElD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -8,8 +8,9 @@ export { verifyWebhook } from "./signing_keys.js";
|
|
|
8
8
|
export { MessageDirection } from "./mail/types.js";
|
|
9
9
|
export type { Mailbox, Message, MessageDetail, Thread, ThreadDetail, } from "./mail/types.js";
|
|
10
10
|
export type { PhoneNumber, PhoneCall, PhoneCallWithRateLimit, RateLimitInfo, PhoneTranscript, TextMediaItem, TextMessage, TextConversationSummary, } from "./phone/types.js";
|
|
11
|
-
export type { AgentIdentitySummary, IdentityMailbox, IdentityPhoneNumber, } from "./identities/types.js";
|
|
12
|
-
export
|
|
11
|
+
export type { AgentIdentitySummary, CreateIdentityOptions, IdentityMailboxCreateOptions, IdentityMailbox, IdentityPhoneNumberCreateOptions, IdentityPhoneNumber, } from "./identities/types.js";
|
|
12
|
+
export { ResourceStatus } from "./identities/types.js";
|
|
13
|
+
export type { AccessRule, VaultInfo, VaultInitializeResult, VaultKey, VaultSecret, VaultSecretDetail, DecryptedVaultSecret, LoginPayload, OtherPayload, SSHKeyPayload, APIKeyPayload, KeyPairPayload, SecretPayload, } from "./vault/types.js";
|
|
13
14
|
export { VaultSecretType, VaultKeyType } from "./vault/types.js";
|
|
14
15
|
export type { TOTPConfig, TOTPCode } from "./vault/totp.js";
|
|
15
16
|
export { TOTPAlgorithm, generateTotp, parseTotpUri } from "./vault/totp.js";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC9E,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,YAAY,EACV,OAAO,EACP,OAAO,EACP,aAAa,EACb,MAAM,EACN,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,WAAW,EACX,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,eAAe,EACf,aAAa,EACb,WAAW,EACX,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,oBAAoB,EACpB,eAAe,EACf,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,cAAc,EACd,aAAa,GACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACjE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC5E,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC9E,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,YAAY,EACV,OAAO,EACP,OAAO,EACP,aAAa,EACb,MAAM,EACN,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,WAAW,EACX,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,eAAe,EACf,aAAa,EACb,WAAW,EACX,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,eAAe,EACf,gCAAgC,EAChC,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EACV,UAAU,EACV,SAAS,EACT,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,cAAc,EACd,aAAa,GACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACjE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC5E,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,7 @@ export { Credentials } from "./credentials.js";
|
|
|
4
4
|
export { InkboxError, InkboxAPIError, InkboxVaultKeyError } from "./_http.js";
|
|
5
5
|
export { verifyWebhook } from "./signing_keys.js";
|
|
6
6
|
export { MessageDirection } from "./mail/types.js";
|
|
7
|
+
export { ResourceStatus } from "./identities/types.js";
|
|
7
8
|
export { VaultSecretType, VaultKeyType } from "./vault/types.js";
|
|
8
9
|
export { TOTPAlgorithm, generateTotp, parseTotpUri } from "./vault/totp.js";
|
|
9
10
|
export { UnlockedVault } from "./vault/resources/vault.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AA0BnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAgBvD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE5E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC"}
|
package/dist/inkbox.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ import { TranscriptsResource } from "./phone/resources/transcripts.js";
|
|
|
15
15
|
import { IdentitiesResource } from "./identities/resources/identities.js";
|
|
16
16
|
import { VaultResource } from "./vault/resources/vault.js";
|
|
17
17
|
import { AgentIdentity } from "./agent_identity.js";
|
|
18
|
-
import type { AgentIdentitySummary } from "./identities/types.js";
|
|
18
|
+
import type { AgentIdentitySummary, CreateIdentityOptions } from "./identities/types.js";
|
|
19
19
|
export interface InkboxOptions {
|
|
20
20
|
/** Your Inkbox API key (sent as `X-Service-Token`). */
|
|
21
21
|
apiKey: string;
|
|
@@ -42,9 +42,8 @@ export interface InkboxOptions {
|
|
|
42
42
|
* // Create an agent identity
|
|
43
43
|
* const identity = await inkbox.createIdentity("support-bot");
|
|
44
44
|
*
|
|
45
|
-
* //
|
|
46
|
-
* const
|
|
47
|
-
* const phone = await identity.provisionPhoneNumber({ type: "toll_free" });
|
|
45
|
+
* // Provision a phone number for the identity
|
|
46
|
+
* const phone = await identity.provisionPhoneNumber({ type: "toll_free" });
|
|
48
47
|
*
|
|
49
48
|
* // Send email directly from the identity
|
|
50
49
|
* await identity.sendEmail({
|
|
@@ -100,6 +99,10 @@ export declare class Inkbox {
|
|
|
100
99
|
ready(): Promise<Inkbox>;
|
|
101
100
|
/** Org-level mailbox operations (list, get, create, update, delete). */
|
|
102
101
|
get mailboxes(): MailboxesResource;
|
|
102
|
+
/** Message operations (list, get, send, delete, star/unstar). */
|
|
103
|
+
get messages(): MessagesResource;
|
|
104
|
+
/** Thread operations (list, get, delete). */
|
|
105
|
+
get threads(): ThreadsResource;
|
|
103
106
|
/** Org-level phone number operations (list, get, provision, release). */
|
|
104
107
|
get phoneNumbers(): PhoneNumbersResource;
|
|
105
108
|
/** Text message operations (list, get, search, conversations). */
|
|
@@ -110,9 +113,17 @@ export declare class Inkbox {
|
|
|
110
113
|
* Create a new agent identity.
|
|
111
114
|
*
|
|
112
115
|
* @param agentHandle - Unique handle for this identity (e.g. `"sales-bot"`).
|
|
116
|
+
* @param options.createMailbox - Whether to create and link a mailbox in the
|
|
117
|
+
* same request. This is also implied when `displayName` or `emailLocalPart`
|
|
118
|
+
* is provided.
|
|
119
|
+
* @param options.displayName - Optional human-readable mailbox name.
|
|
120
|
+
* @param options.emailLocalPart - Optional requested mailbox local part.
|
|
121
|
+
* @param options.phoneNumber - Optional phone-number provisioning payload.
|
|
122
|
+
* @param options.vaultSecretIds - Optional vault secret selection to attach
|
|
123
|
+
* to the new identity.
|
|
113
124
|
* @returns The created {@link AgentIdentity}.
|
|
114
125
|
*/
|
|
115
|
-
createIdentity(agentHandle: string): Promise<AgentIdentity>;
|
|
126
|
+
createIdentity(agentHandle: string, options?: CreateIdentityOptions): Promise<AgentIdentity>;
|
|
116
127
|
/**
|
|
117
128
|
* Get an existing agent identity by handle.
|
|
118
129
|
*
|
package/dist/inkbox.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inkbox.d.ts","sourceRoot":"","sources":["../src/inkbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"inkbox.d.ts","sourceRoot":"","sources":["../src/inkbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAIzF,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,MAAM;IACjB,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAC1C,QAAQ,CAAC,cAAc,EAAE,aAAa,CAAC;IACvC,gBAAgB;IAChB,mBAAmB,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAQ;gBAExC,OAAO,EAAE,aAAa;IA4ClC;;;;;;;;;;;;;;;OAeG;IACG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAW9B,wEAAwE;IACxE,IAAI,SAAS,IAAI,iBAAiB,CAA4B;IAE9D,iEAAiE;IACjE,IAAI,QAAQ,IAAI,gBAAgB,CAA2B;IAE3D,6CAA6C;IAC7C,IAAI,OAAO,IAAI,eAAe,CAA0B;IAExD,yEAAyE;IACzE,IAAI,YAAY,IAAI,oBAAoB,CAA0B;IAElE,kEAAkE;IAClE,IAAI,KAAK,IAAI,aAAa,CAAwB;IAElD,+CAA+C;IAC/C,IAAI,KAAK,IAAI,aAAa,CAAgC;IAM1D;;;;;;;;;;;;;OAaG;IACG,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAoBzB;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAI9D;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAIvD;;;;;;OAMG;IACG,gBAAgB,IAAI,OAAO,CAAC,UAAU,CAAC;CAG9C"}
|
package/dist/inkbox.js
CHANGED
|
@@ -15,7 +15,7 @@ import { TranscriptsResource } from "./phone/resources/transcripts.js";
|
|
|
15
15
|
import { IdentitiesResource } from "./identities/resources/identities.js";
|
|
16
16
|
import { VaultResource } from "./vault/resources/vault.js";
|
|
17
17
|
import { AgentIdentity } from "./agent_identity.js";
|
|
18
|
-
const DEFAULT_BASE_URL = "https://
|
|
18
|
+
const DEFAULT_BASE_URL = "https://inkbox.ai";
|
|
19
19
|
/**
|
|
20
20
|
* Org-level entry point for all Inkbox APIs.
|
|
21
21
|
*
|
|
@@ -28,9 +28,8 @@ const DEFAULT_BASE_URL = "https://api.inkbox.ai";
|
|
|
28
28
|
* // Create an agent identity
|
|
29
29
|
* const identity = await inkbox.createIdentity("support-bot");
|
|
30
30
|
*
|
|
31
|
-
* //
|
|
32
|
-
* const
|
|
33
|
-
* const phone = await identity.provisionPhoneNumber({ type: "toll_free" });
|
|
31
|
+
* // Provision a phone number for the identity
|
|
32
|
+
* const phone = await identity.provisionPhoneNumber({ type: "toll_free" });
|
|
34
33
|
*
|
|
35
34
|
* // Send email directly from the identity
|
|
36
35
|
* await identity.sendEmail({
|
|
@@ -127,6 +126,10 @@ export class Inkbox {
|
|
|
127
126
|
// ------------------------------------------------------------------
|
|
128
127
|
/** Org-level mailbox operations (list, get, create, update, delete). */
|
|
129
128
|
get mailboxes() { return this._mailboxes; }
|
|
129
|
+
/** Message operations (list, get, send, delete, star/unstar). */
|
|
130
|
+
get messages() { return this._messages; }
|
|
131
|
+
/** Thread operations (list, get, delete). */
|
|
132
|
+
get threads() { return this._threads; }
|
|
130
133
|
/** Org-level phone number operations (list, get, provision, release). */
|
|
131
134
|
get phoneNumbers() { return this._numbers; }
|
|
132
135
|
/** Text message operations (list, get, search, conversations). */
|
|
@@ -140,10 +143,29 @@ export class Inkbox {
|
|
|
140
143
|
* Create a new agent identity.
|
|
141
144
|
*
|
|
142
145
|
* @param agentHandle - Unique handle for this identity (e.g. `"sales-bot"`).
|
|
146
|
+
* @param options.createMailbox - Whether to create and link a mailbox in the
|
|
147
|
+
* same request. This is also implied when `displayName` or `emailLocalPart`
|
|
148
|
+
* is provided.
|
|
149
|
+
* @param options.displayName - Optional human-readable mailbox name.
|
|
150
|
+
* @param options.emailLocalPart - Optional requested mailbox local part.
|
|
151
|
+
* @param options.phoneNumber - Optional phone-number provisioning payload.
|
|
152
|
+
* @param options.vaultSecretIds - Optional vault secret selection to attach
|
|
153
|
+
* to the new identity.
|
|
143
154
|
* @returns The created {@link AgentIdentity}.
|
|
144
155
|
*/
|
|
145
|
-
async createIdentity(agentHandle) {
|
|
146
|
-
|
|
156
|
+
async createIdentity(agentHandle, options = {}) {
|
|
157
|
+
const mailbox = options.createMailbox || options.displayName !== undefined || options.emailLocalPart !== undefined
|
|
158
|
+
? {
|
|
159
|
+
displayName: options.displayName,
|
|
160
|
+
emailLocalPart: options.emailLocalPart,
|
|
161
|
+
}
|
|
162
|
+
: undefined;
|
|
163
|
+
await this._idsResource.create({
|
|
164
|
+
agentHandle,
|
|
165
|
+
mailbox,
|
|
166
|
+
phoneNumber: options.phoneNumber,
|
|
167
|
+
vaultSecretIds: options.vaultSecretIds,
|
|
168
|
+
});
|
|
147
169
|
// POST /identities returns summary (no channel fields); fetch detail so
|
|
148
170
|
// AgentIdentity has a fully-populated _AgentIdentityData.
|
|
149
171
|
const data = await this._idsResource.get(agentHandle);
|
package/dist/inkbox.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inkbox.js","sourceRoot":"","sources":["../src/inkbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,MAAM,gBAAgB,GAAG,
|
|
1
|
+
{"version":3,"file":"inkbox.js","sourceRoot":"","sources":["../src/inkbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAiB7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,OAAO,MAAM;IACR,UAAU,CAAoB;IAC9B,SAAS,CAAmB;IAC5B,QAAQ,CAAkB;IAC1B,YAAY,CAAsB;IAClC,QAAQ,CAAuB;IAC/B,MAAM,CAAgB;IACtB,MAAM,CAAgB;IACtB,YAAY,CAAsB;IAClC,YAAY,CAAqB;IACjC,cAAc,CAAgB;IACvC,gBAAgB;IAChB,mBAAmB,GAA4B,IAAI,CAAC;IAEpD,YAAY,OAAsB;QAChC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACvE,MAAM,IAAI,KAAK,CACb,0DAA0D;oBAC1D,4BAA4B;oBAC5B,yDAAyD,CAC1D,CAAC;YACJ,CAAC;QACH,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC;QACvD,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC;QAEvC,MAAM,QAAQ,GAAI,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAK,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,aAAa,EAAE,EAAE,CAAC,CAAC;QACjF,MAAM,SAAS,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAK,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjE,IAAI,CAAC,UAAU,GAAK,IAAI,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,SAAS,GAAM,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAO,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAErD,IAAI,CAAC,QAAQ,GAAO,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAS,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,GAAS,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAEvD,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;QAEnD,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED,qEAAqE;IACrE,YAAY;IACZ,qEAAqE;IAErE;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,mBAAmB,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qEAAqE;IACrE,4BAA4B;IAC5B,qEAAqE;IAErE,wEAAwE;IACxE,IAAI,SAAS,KAAwB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9D,iEAAiE;IACjE,IAAI,QAAQ,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE3D,6CAA6C;IAC7C,IAAI,OAAO,KAAsB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExD,yEAAyE;IACzE,IAAI,YAAY,KAA2B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElE,kEAAkE;IAClE,IAAI,KAAK,KAAoB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAElD,+CAA+C;IAC/C,IAAI,KAAK,KAAoB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE1D,qEAAqE;IACrE,uBAAuB;IACvB,qEAAqE;IAErE;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,cAAc,CAClB,WAAmB,EACnB,UAAiC,EAAE;QAEnC,MAAM,OAAO,GACX,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;YAChG,CAAC,CAAC;gBACE,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;aACvC;YACH,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YAC7B,WAAW;YACX,OAAO;YACP,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;QACH,wEAAwE;QACxE,0DAA0D;QAC1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,WAAmB;QACnC,OAAO,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;CACF"}
|
|
@@ -8,18 +8,6 @@ import { Mailbox, Message } from "../types.js";
|
|
|
8
8
|
export declare class MailboxesResource {
|
|
9
9
|
private readonly http;
|
|
10
10
|
constructor(http: HttpTransport);
|
|
11
|
-
/**
|
|
12
|
-
* Create a new mailbox and link it to an agent identity.
|
|
13
|
-
*
|
|
14
|
-
* The email address is automatically generated by the server.
|
|
15
|
-
*
|
|
16
|
-
* @param options.agentHandle - Handle of the agent identity to assign this mailbox to.
|
|
17
|
-
* @param options.displayName - Optional human-readable name shown as the sender.
|
|
18
|
-
*/
|
|
19
|
-
create(options: {
|
|
20
|
-
agentHandle: string;
|
|
21
|
-
displayName?: string;
|
|
22
|
-
}): Promise<Mailbox>;
|
|
23
11
|
/** List all mailboxes for your organisation. */
|
|
24
12
|
list(): Promise<Mailbox[]>;
|
|
25
13
|
/**
|
|
@@ -28,6 +16,19 @@ export declare class MailboxesResource {
|
|
|
28
16
|
* @param emailAddress - Full email address of the mailbox (e.g. `"abc-xyz@inkboxmail.com"`).
|
|
29
17
|
*/
|
|
30
18
|
get(emailAddress: string): Promise<Mailbox>;
|
|
19
|
+
/**
|
|
20
|
+
* Create and link a mailbox to an existing identity.
|
|
21
|
+
*
|
|
22
|
+
* @param options.agentHandle - Handle of the identity that should own the mailbox.
|
|
23
|
+
* @param options.displayName - Optional human-readable sender name.
|
|
24
|
+
* @param options.emailLocalPart - Optional requested local part. If omitted,
|
|
25
|
+
* the server generates a random address.
|
|
26
|
+
*/
|
|
27
|
+
create(options: {
|
|
28
|
+
agentHandle: string;
|
|
29
|
+
displayName?: string;
|
|
30
|
+
emailLocalPart?: string;
|
|
31
|
+
}): Promise<Mailbox>;
|
|
31
32
|
/**
|
|
32
33
|
* Update mutable mailbox fields.
|
|
33
34
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mailboxes.d.ts","sourceRoot":"","sources":["../../../src/mail/resources/mailboxes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EACL,OAAO,EACP,OAAO,EAMR,MAAM,aAAa,CAAC;AAIrB,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,aAAa;IAEhD
|
|
1
|
+
{"version":3,"file":"mailboxes.d.ts","sourceRoot":"","sources":["../../../src/mail/resources/mailboxes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EACL,OAAO,EACP,OAAO,EAMR,MAAM,aAAa,CAAC;AAIrB,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,aAAa;IAEhD,gDAAgD;IAC1C,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKhC;;;;OAIG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKjD;;;;;;;OAOG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpB;;;;;;;;;OASG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAC5D,OAAO,CAAC,OAAO,CAAC;IAYnB;;;;OAIG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD;;;;;;OAMG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC,OAAO,CAAC,OAAO,EAAE,CAAC;CAOtB"}
|
|
@@ -10,22 +10,6 @@ export class MailboxesResource {
|
|
|
10
10
|
constructor(http) {
|
|
11
11
|
this.http = http;
|
|
12
12
|
}
|
|
13
|
-
/**
|
|
14
|
-
* Create a new mailbox and link it to an agent identity.
|
|
15
|
-
*
|
|
16
|
-
* The email address is automatically generated by the server.
|
|
17
|
-
*
|
|
18
|
-
* @param options.agentHandle - Handle of the agent identity to assign this mailbox to.
|
|
19
|
-
* @param options.displayName - Optional human-readable name shown as the sender.
|
|
20
|
-
*/
|
|
21
|
-
async create(options) {
|
|
22
|
-
const body = { agent_handle: options.agentHandle };
|
|
23
|
-
if (options.displayName !== undefined) {
|
|
24
|
-
body["display_name"] = options.displayName;
|
|
25
|
-
}
|
|
26
|
-
const data = await this.http.post(BASE, body);
|
|
27
|
-
return parseMailbox(data);
|
|
28
|
-
}
|
|
29
13
|
/** List all mailboxes for your organisation. */
|
|
30
14
|
async list() {
|
|
31
15
|
const data = await this.http.get(BASE);
|
|
@@ -40,6 +24,23 @@ export class MailboxesResource {
|
|
|
40
24
|
const data = await this.http.get(`${BASE}/${emailAddress}`);
|
|
41
25
|
return parseMailbox(data);
|
|
42
26
|
}
|
|
27
|
+
/**
|
|
28
|
+
* Create and link a mailbox to an existing identity.
|
|
29
|
+
*
|
|
30
|
+
* @param options.agentHandle - Handle of the identity that should own the mailbox.
|
|
31
|
+
* @param options.displayName - Optional human-readable sender name.
|
|
32
|
+
* @param options.emailLocalPart - Optional requested local part. If omitted,
|
|
33
|
+
* the server generates a random address.
|
|
34
|
+
*/
|
|
35
|
+
async create(options) {
|
|
36
|
+
const body = { agent_handle: options.agentHandle };
|
|
37
|
+
if (options.displayName !== undefined)
|
|
38
|
+
body["display_name"] = options.displayName;
|
|
39
|
+
if (options.emailLocalPart !== undefined)
|
|
40
|
+
body["email_local_part"] = options.emailLocalPart;
|
|
41
|
+
const data = await this.http.post(BASE, body);
|
|
42
|
+
return parseMailbox(data);
|
|
43
|
+
}
|
|
43
44
|
/**
|
|
44
45
|
* Update mutable mailbox fields.
|
|
45
46
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mailboxes.js","sourceRoot":"","sources":["../../../src/mail/resources/mailboxes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAML,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,MAAM,IAAI,GAAG,YAAY,CAAC;AAE1B,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD
|
|
1
|
+
{"version":3,"file":"mailboxes.js","sourceRoot":"","sources":["../../../src/mail/resources/mailboxes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAML,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,MAAM,IAAI,GAAG,YAAY,CAAC;AAE1B,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,gDAAgD;IAChD,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAe,IAAI,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,YAAoB;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAa,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC;QACxE,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,OAIZ;QACC,MAAM,IAAI,GAA4B,EAAE,YAAY,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAAE,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;QAClF,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;YAAE,IAAI,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;QAC5F,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAa,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1D,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,OAA6D;QAE7D,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;QAC3C,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAa,GAAG,IAAI,IAAI,YAAY,EAAE,EAAE,IAAI,CAAC,CAAC;QAChF,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,OAAsC;QAEtC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAC9B,GAAG,IAAI,IAAI,YAAY,SAAS,EAChC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAC7C,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;CACF"}
|
package/dist/mail/types.d.ts
CHANGED
package/dist/mail/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/mail/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,gEAAgE;AAChE,oBAAY,gBAAgB;IAC1B,8CAA8C;IAC9C,OAAO,YAAY;IACnB,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/mail/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,gEAAgE;AAChE,oBAAY,gBAAgB;IAC1B,8CAA8C;IAC9C,OAAO,YAAY;IACnB,iCAAiC;IACjC,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,mDAAmD;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC9B,wCAAwC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,wCAAwC;IACxC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;IACrD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,IAAI,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,+CAA+C;IAC/C,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAID,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;IACvD,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAID,wBAAgB,YAAY,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,CAUnD;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,CAkBnD;AAED,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,UAAU,GAAG,aAAa,CAY/D;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,CAUhD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,SAAS,GAAG,YAAY,CAK5D"}
|
package/dist/mail/types.js
CHANGED
|
@@ -6,7 +6,7 @@ export var MessageDirection;
|
|
|
6
6
|
(function (MessageDirection) {
|
|
7
7
|
/** Email received from an external sender. */
|
|
8
8
|
MessageDirection["INBOUND"] = "inbound";
|
|
9
|
-
/** Email sent by the mailbox
|
|
9
|
+
/** Email sent by the mailbox. */
|
|
10
10
|
MessageDirection["OUTBOUND"] = "outbound";
|
|
11
11
|
})(MessageDirection || (MessageDirection = {}));
|
|
12
12
|
// ---- parsers ----
|
package/dist/mail/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/mail/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,gEAAgE;AAChE,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,8CAA8C;IAC9C,uCAAmB,CAAA;IACnB,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/mail/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,gEAAgE;AAChE,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,8CAA8C;IAC9C,uCAAmB,CAAA;IACnB,iCAAiC;IACjC,yCAAqB,CAAA;AACvB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAsHD,oBAAoB;AAEpB,MAAM,UAAU,YAAY,CAAC,CAAa;IACxC,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,YAAY,EAAE,CAAC,CAAC,aAAa;QAC7B,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,UAAU,EAAE,CAAC,CAAC,WAAW;QACzB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,CAAa;IACxC,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,WAAW,EAAE,CAAC,CAAC,YAAY,IAAI,IAAI;QACnC,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,SAAS,EAAE,CAAC,CAAC,SAA6B;QAC1C,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,MAAM,EAAE,CAAC,CAAC,OAAO;QACjB,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,cAAc,EAAE,CAAC,CAAC,eAAe;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,CAAa;IAC9C,OAAO;QACL,GAAG,YAAY,CAAC,CAAC,CAAC;QAClB,QAAQ,EAAE,CAAC,CAAC,SAAS,IAAI,IAAI;QAC7B,QAAQ,EAAE,CAAC,CAAC,SAAS,IAAI,IAAI;QAC7B,YAAY,EAAE,CAAC,CAAC,aAAa,IAAI,IAAI;QACrC,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,IAAI;QAChC,UAAU,EAAE,CAAC,CAAC,UAAU,IAAI,IAAI;QAChC,kBAAkB,EAAE,CAAC,CAAC,mBAAmB,IAAI,IAAI;QACjD,YAAY,EAAE,CAAC,CAAC,cAAc,IAAI,IAAI;QACtC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAW,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAY;IACtC,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,YAAY,EAAE,CAAC,CAAC,aAAa;QAC7B,aAAa,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC;QAC1C,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,CAAY;IAC5C,OAAO;QACL,GAAG,WAAW,CAAC,CAAC,CAAC;QACjB,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;KAC/C,CAAC;AACJ,CAAC"}
|
|
@@ -29,12 +29,12 @@ export declare class TextsResource {
|
|
|
29
29
|
*/
|
|
30
30
|
get(phoneNumberId: string, textId: string): Promise<TextMessage>;
|
|
31
31
|
/**
|
|
32
|
-
* Update a text message (mark as read,
|
|
32
|
+
* Update a text message (mark as read, delete).
|
|
33
33
|
*
|
|
34
34
|
* @param phoneNumberId - UUID of the phone number.
|
|
35
35
|
* @param textId - UUID of the text message.
|
|
36
36
|
* @param options.isRead - Mark as read or unread.
|
|
37
|
-
* @param options.status - Set to `"deleted"` to
|
|
37
|
+
* @param options.status - Set to `"deleted"` to delete.
|
|
38
38
|
*/
|
|
39
39
|
update(phoneNumberId: string, textId: string, options: {
|
|
40
40
|
isRead?: boolean;
|
|
@@ -39,12 +39,12 @@ export class TextsResource {
|
|
|
39
39
|
return parseTextMessage(data);
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* Update a text message (mark as read,
|
|
42
|
+
* Update a text message (mark as read, delete).
|
|
43
43
|
*
|
|
44
44
|
* @param phoneNumberId - UUID of the phone number.
|
|
45
45
|
* @param textId - UUID of the text message.
|
|
46
46
|
* @param options.isRead - Mark as read or unread.
|
|
47
|
-
* @param options.status - Set to `"deleted"` to
|
|
47
|
+
* @param options.status - Set to `"deleted"` to delete.
|
|
48
48
|
*/
|
|
49
49
|
async update(phoneNumberId, textId, options) {
|
|
50
50
|
const body = {};
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import { HttpTransport } from "../../_http.js";
|
|
8
8
|
import type { TOTPCode, TOTPConfig } from "../totp.js";
|
|
9
|
-
import type { AccessRule, DecryptedVaultSecret, SecretPayload, VaultInfo, VaultKey, VaultSecret } from "../types.js";
|
|
9
|
+
import type { AccessRule, DecryptedVaultSecret, SecretPayload, VaultInfo, VaultInitializeResult, VaultKey, VaultSecret } from "../types.js";
|
|
10
10
|
/**
|
|
11
11
|
* Org-level vault operations.
|
|
12
12
|
*
|
|
@@ -23,6 +23,49 @@ export declare class VaultResource {
|
|
|
23
23
|
constructor(http: HttpTransport);
|
|
24
24
|
/** Get vault metadata for the caller's organisation. */
|
|
25
25
|
info(): Promise<VaultInfo>;
|
|
26
|
+
/**
|
|
27
|
+
* Initialize a new vault for the organisation.
|
|
28
|
+
*
|
|
29
|
+
* Generates a random org encryption key, wraps it with the provided
|
|
30
|
+
* vault key, and creates four recovery codes. All cryptographic
|
|
31
|
+
* material is generated client-side; the server only receives
|
|
32
|
+
* ciphertexts and identifiers.
|
|
33
|
+
*
|
|
34
|
+
* @param vaultKey - The vault key (password) to protect the vault.
|
|
35
|
+
* Must be at least 16 characters with uppercase, lowercase, digit,
|
|
36
|
+
* and special character.
|
|
37
|
+
* @param organizationId - The organisation ID (needed for key
|
|
38
|
+
* derivation; the vault does not exist yet so it cannot be fetched).
|
|
39
|
+
* @returns {@link VaultInitializeResult} containing the vault ID,
|
|
40
|
+
* primary key ID, and recovery codes. The recovery codes must be
|
|
41
|
+
* stored securely — they cannot be retrieved again.
|
|
42
|
+
* @throws If the organisation already has an active vault (409).
|
|
43
|
+
*/
|
|
44
|
+
initialize(vaultKey: string, organizationId: string): Promise<VaultInitializeResult>;
|
|
45
|
+
/**
|
|
46
|
+
* Replace the primary vault key (change the vault password).
|
|
47
|
+
*
|
|
48
|
+
* Exactly one of `currentVaultKey` or `recoveryCode` must be
|
|
49
|
+
* provided to authenticate the change:
|
|
50
|
+
*
|
|
51
|
+
* - **Normal update** (`currentVaultKey`): proves knowledge of the
|
|
52
|
+
* current primary key. The old key is deleted.
|
|
53
|
+
* - **Recovery update** (`recoveryCode`): proves knowledge of a
|
|
54
|
+
* recovery code which is consumed (one-time use). The current
|
|
55
|
+
* primary key is also deleted.
|
|
56
|
+
*
|
|
57
|
+
* In both cases a new primary key is created from `newVaultKey`.
|
|
58
|
+
*
|
|
59
|
+
* @param options.newVaultKey - The new vault key (password).
|
|
60
|
+
* @param options.currentVaultKey - Current primary vault key (normal update).
|
|
61
|
+
* @param options.recoveryCode - A recovery code (recovery update).
|
|
62
|
+
* @returns {@link VaultKey} metadata for the newly created primary key.
|
|
63
|
+
*/
|
|
64
|
+
updateKey(options: {
|
|
65
|
+
newVaultKey: string;
|
|
66
|
+
currentVaultKey?: string;
|
|
67
|
+
recoveryCode?: string;
|
|
68
|
+
}): Promise<VaultKey>;
|
|
26
69
|
/**
|
|
27
70
|
* List vault keys (metadata only — no wrapped key material).
|
|
28
71
|
*
|
|
@@ -31,6 +74,12 @@ export declare class VaultResource {
|
|
|
31
74
|
listKeys(options?: {
|
|
32
75
|
keyType?: string;
|
|
33
76
|
}): Promise<VaultKey[]>;
|
|
77
|
+
/**
|
|
78
|
+
* Delete a vault key by auth hash.
|
|
79
|
+
*
|
|
80
|
+
* @param authHash - Auth hash of the key to revoke.
|
|
81
|
+
*/
|
|
82
|
+
deleteKey(authHash: string): Promise<void>;
|
|
34
83
|
/**
|
|
35
84
|
* List vault secrets (metadata only, no encrypted payload).
|
|
36
85
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/vault/resources/vault.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,aAAa,EAAe,MAAM,gBAAgB,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/vault/resources/vault.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,aAAa,EAAe,MAAM,gBAAgB,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAcvD,OAAO,KAAK,EACV,UAAU,EACV,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,qBAAqB,EACrB,QAAQ,EACR,WAAW,EAEZ,MAAM,aAAa,CAAC;AAsBrB;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAE7B,gBAAgB;IAChB,SAAS,EAAE,aAAa,GAAG,IAAI,CAAQ;IAEvC,gBAAgB;gBACJ,IAAI,EAAE,aAAa;IAQ/B,wDAAwD;IAClD,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC;IAKhC;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,qBAAqB,CAAC;IAoCjC;;;;;;;;;;;;;;;;;;OAkBG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkFrB;;;;OAIG;IACG,QAAQ,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOvE;;;;OAIG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQhD;;;;;OAKG;IACG,WAAW,CAAC,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAOhF;;;;OAIG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD;;;;OAIG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAO9D;;;;;OAKG;IACG,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQ5E;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQvE;;;;;;;;;;;;;OAaG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GACpC,OAAO,CAAC,aAAa,CAAC;CA4F1B;AAED;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgB;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,YAAY,CAAyB;gBAG3C,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,UAAU,EAClB,YAAY,EAAE,oBAAoB,EAAE;IAOtC,4DAA4D;IAC5D,IAAI,OAAO,IAAI,oBAAoB,EAAE,CAEpC;IAED;;;;OAIG;YACW,mBAAmB;IAejC;;;;OAIG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAsBhE;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE,aAAa,CAAC;KACxB,GAAG,OAAO,CAAC,WAAW,CAAC;IA0BxB;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,GACA,OAAO,CAAC,WAAW,CAAC;IA4BvB;;;;OAIG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASnD;;;;;;;;OAQG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,UAAU,GAAG,MAAM,GACxB,OAAO,CAAC,WAAW,CAAC;IAYvB;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAYxD;;;;;;;OAOG;IACG,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAavD"}
|