@vrplatform/api 1.3.1-stage.4776 → 1.3.1-stage.4789
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/build/main/embed-lifecycle.d.ts +140 -0
- package/build/main/embed-lifecycle.js +93 -0
- package/build/main/embed-lifecycle.js.map +1 -0
- package/build/main/generated/v1.d.ts +255 -1
- package/build/main/generated/v1.js.map +1 -1
- package/build/main/index.d.ts +1 -0
- package/build/main/index.js +1 -0
- package/build/main/index.js.map +1 -1
- package/build/module/embed-lifecycle.d.ts +140 -0
- package/build/module/embed-lifecycle.js +90 -0
- package/build/module/embed-lifecycle.js.map +1 -0
- package/build/module/generated/v1.d.ts +255 -1
- package/build/module/generated/v1.js.map +1 -1
- package/build/module/index.d.ts +1 -0
- package/build/module/index.js +1 -0
- package/build/module/index.js.map +1 -1
- package/package.json +3 -2
- package/src/embed-lifecycle.ts +96 -0
- package/src/generated/v1.ts +255 -1
- package/src/index.ts +1 -0
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
declare const channelRequestSchema: z.ZodObject<{
|
|
3
|
+
requestId: z.ZodUUID;
|
|
4
|
+
type: z.ZodLiteral<"channel.request">;
|
|
5
|
+
channelId: z.ZodUUID;
|
|
6
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
7
|
+
version: z.ZodLiteral<1>;
|
|
8
|
+
}, z.core.$strict>;
|
|
9
|
+
declare const channelConnectSchema: z.ZodObject<{
|
|
10
|
+
replyTo: z.ZodUUID;
|
|
11
|
+
type: z.ZodLiteral<"channel.connect">;
|
|
12
|
+
channelId: z.ZodUUID;
|
|
13
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
14
|
+
version: z.ZodLiteral<1>;
|
|
15
|
+
}, z.core.$strict>;
|
|
16
|
+
declare const iframeMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
17
|
+
type: z.ZodLiteral<"ready">;
|
|
18
|
+
channelId: z.ZodUUID;
|
|
19
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
20
|
+
version: z.ZodLiteral<1>;
|
|
21
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
22
|
+
code: z.ZodEnum<{
|
|
23
|
+
authentication_failed: "authentication_failed";
|
|
24
|
+
access_denied: "access_denied";
|
|
25
|
+
session_expired: "session_expired";
|
|
26
|
+
renewal_failed: "renewal_failed";
|
|
27
|
+
unsupported_version: "unsupported_version";
|
|
28
|
+
internal_error: "internal_error";
|
|
29
|
+
}>;
|
|
30
|
+
correlationId: z.ZodString;
|
|
31
|
+
recoverable: z.ZodBoolean;
|
|
32
|
+
replyTo: z.ZodOptional<z.ZodUUID>;
|
|
33
|
+
type: z.ZodLiteral<"error">;
|
|
34
|
+
channelId: z.ZodUUID;
|
|
35
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
36
|
+
version: z.ZodLiteral<1>;
|
|
37
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
38
|
+
expiresAt: z.ZodISODateTime;
|
|
39
|
+
requestId: z.ZodUUID;
|
|
40
|
+
type: z.ZodLiteral<"session.expiring">;
|
|
41
|
+
channelId: z.ZodUUID;
|
|
42
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
43
|
+
version: z.ZodLiteral<1>;
|
|
44
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
45
|
+
expiresAt: z.ZodISODateTime;
|
|
46
|
+
replyTo: z.ZodUUID;
|
|
47
|
+
type: z.ZodLiteral<"session.renewed">;
|
|
48
|
+
channelId: z.ZodUUID;
|
|
49
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
50
|
+
version: z.ZodLiteral<1>;
|
|
51
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
52
|
+
height: z.ZodNumber;
|
|
53
|
+
type: z.ZodLiteral<"resize">;
|
|
54
|
+
channelId: z.ZodUUID;
|
|
55
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
56
|
+
version: z.ZodLiteral<1>;
|
|
57
|
+
}, z.core.$strict>], "type">;
|
|
58
|
+
declare const parentMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
59
|
+
embedUrl: z.ZodURL;
|
|
60
|
+
replyTo: z.ZodUUID;
|
|
61
|
+
requestId: z.ZodUUID;
|
|
62
|
+
type: z.ZodLiteral<"session.renew">;
|
|
63
|
+
channelId: z.ZodUUID;
|
|
64
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
65
|
+
version: z.ZodLiteral<1>;
|
|
66
|
+
}, z.core.$strict>], "type">;
|
|
67
|
+
export declare const embedLifecycle: {
|
|
68
|
+
readonly channelConnectSchema: z.ZodObject<{
|
|
69
|
+
replyTo: z.ZodUUID;
|
|
70
|
+
type: z.ZodLiteral<"channel.connect">;
|
|
71
|
+
channelId: z.ZodUUID;
|
|
72
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
73
|
+
version: z.ZodLiteral<1>;
|
|
74
|
+
}, z.core.$strict>;
|
|
75
|
+
readonly channelRequestSchema: z.ZodObject<{
|
|
76
|
+
requestId: z.ZodUUID;
|
|
77
|
+
type: z.ZodLiteral<"channel.request">;
|
|
78
|
+
channelId: z.ZodUUID;
|
|
79
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
80
|
+
version: z.ZodLiteral<1>;
|
|
81
|
+
}, z.core.$strict>;
|
|
82
|
+
readonly iframeMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
83
|
+
type: z.ZodLiteral<"ready">;
|
|
84
|
+
channelId: z.ZodUUID;
|
|
85
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
86
|
+
version: z.ZodLiteral<1>;
|
|
87
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
88
|
+
code: z.ZodEnum<{
|
|
89
|
+
authentication_failed: "authentication_failed";
|
|
90
|
+
access_denied: "access_denied";
|
|
91
|
+
session_expired: "session_expired";
|
|
92
|
+
renewal_failed: "renewal_failed";
|
|
93
|
+
unsupported_version: "unsupported_version";
|
|
94
|
+
internal_error: "internal_error";
|
|
95
|
+
}>;
|
|
96
|
+
correlationId: z.ZodString;
|
|
97
|
+
recoverable: z.ZodBoolean;
|
|
98
|
+
replyTo: z.ZodOptional<z.ZodUUID>;
|
|
99
|
+
type: z.ZodLiteral<"error">;
|
|
100
|
+
channelId: z.ZodUUID;
|
|
101
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
102
|
+
version: z.ZodLiteral<1>;
|
|
103
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
104
|
+
expiresAt: z.ZodISODateTime;
|
|
105
|
+
requestId: z.ZodUUID;
|
|
106
|
+
type: z.ZodLiteral<"session.expiring">;
|
|
107
|
+
channelId: z.ZodUUID;
|
|
108
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
109
|
+
version: z.ZodLiteral<1>;
|
|
110
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
111
|
+
expiresAt: z.ZodISODateTime;
|
|
112
|
+
replyTo: z.ZodUUID;
|
|
113
|
+
type: z.ZodLiteral<"session.renewed">;
|
|
114
|
+
channelId: z.ZodUUID;
|
|
115
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
116
|
+
version: z.ZodLiteral<1>;
|
|
117
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
118
|
+
height: z.ZodNumber;
|
|
119
|
+
type: z.ZodLiteral<"resize">;
|
|
120
|
+
channelId: z.ZodUUID;
|
|
121
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
122
|
+
version: z.ZodLiteral<1>;
|
|
123
|
+
}, z.core.$strict>], "type">;
|
|
124
|
+
readonly parentMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
125
|
+
embedUrl: z.ZodURL;
|
|
126
|
+
replyTo: z.ZodUUID;
|
|
127
|
+
requestId: z.ZodUUID;
|
|
128
|
+
type: z.ZodLiteral<"session.renew">;
|
|
129
|
+
channelId: z.ZodUUID;
|
|
130
|
+
protocol: z.ZodLiteral<"vrplatform.embed.lifecycle">;
|
|
131
|
+
version: z.ZodLiteral<1>;
|
|
132
|
+
}, z.core.$strict>], "type">;
|
|
133
|
+
readonly protocol: "vrplatform.embed.lifecycle";
|
|
134
|
+
readonly version: 1;
|
|
135
|
+
};
|
|
136
|
+
export type EmbedLifecycleChannelConnect = z.infer<typeof channelConnectSchema>;
|
|
137
|
+
export type EmbedLifecycleChannelRequest = z.infer<typeof channelRequestSchema>;
|
|
138
|
+
export type EmbedLifecycleIframeMessage = z.infer<typeof iframeMessageSchema>;
|
|
139
|
+
export type EmbedLifecycleParentMessage = z.infer<typeof parentMessageSchema>;
|
|
140
|
+
export {};
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.embedLifecycle = void 0;
|
|
4
|
+
const zod_1 = require("zod");
|
|
5
|
+
const protocol = 'vrplatform.embed.lifecycle';
|
|
6
|
+
const version = 1;
|
|
7
|
+
const envelope = {
|
|
8
|
+
channelId: zod_1.z.uuid(),
|
|
9
|
+
protocol: zod_1.z.literal(protocol),
|
|
10
|
+
version: zod_1.z.literal(version),
|
|
11
|
+
};
|
|
12
|
+
const channelRequestSchema = zod_1.z
|
|
13
|
+
.object({
|
|
14
|
+
...envelope,
|
|
15
|
+
requestId: zod_1.z.uuid(),
|
|
16
|
+
type: zod_1.z.literal('channel.request'),
|
|
17
|
+
})
|
|
18
|
+
.strict();
|
|
19
|
+
const channelConnectSchema = zod_1.z
|
|
20
|
+
.object({
|
|
21
|
+
...envelope,
|
|
22
|
+
replyTo: zod_1.z.uuid(),
|
|
23
|
+
type: zod_1.z.literal('channel.connect'),
|
|
24
|
+
})
|
|
25
|
+
.strict();
|
|
26
|
+
const iframeMessageSchema = zod_1.z.discriminatedUnion('type', [
|
|
27
|
+
zod_1.z
|
|
28
|
+
.object({
|
|
29
|
+
...envelope,
|
|
30
|
+
type: zod_1.z.literal('ready'),
|
|
31
|
+
})
|
|
32
|
+
.strict(),
|
|
33
|
+
zod_1.z
|
|
34
|
+
.object({
|
|
35
|
+
...envelope,
|
|
36
|
+
code: zod_1.z.enum([
|
|
37
|
+
'authentication_failed',
|
|
38
|
+
'access_denied',
|
|
39
|
+
'session_expired',
|
|
40
|
+
'renewal_failed',
|
|
41
|
+
'unsupported_version',
|
|
42
|
+
'internal_error',
|
|
43
|
+
]),
|
|
44
|
+
correlationId: zod_1.z.string().min(1).max(128),
|
|
45
|
+
recoverable: zod_1.z.boolean(),
|
|
46
|
+
replyTo: zod_1.z.uuid().optional(),
|
|
47
|
+
type: zod_1.z.literal('error'),
|
|
48
|
+
})
|
|
49
|
+
.strict(),
|
|
50
|
+
zod_1.z
|
|
51
|
+
.object({
|
|
52
|
+
...envelope,
|
|
53
|
+
expiresAt: zod_1.z.iso.datetime({ offset: true }),
|
|
54
|
+
requestId: zod_1.z.uuid(),
|
|
55
|
+
type: zod_1.z.literal('session.expiring'),
|
|
56
|
+
})
|
|
57
|
+
.strict(),
|
|
58
|
+
zod_1.z
|
|
59
|
+
.object({
|
|
60
|
+
...envelope,
|
|
61
|
+
expiresAt: zod_1.z.iso.datetime({ offset: true }),
|
|
62
|
+
replyTo: zod_1.z.uuid(),
|
|
63
|
+
type: zod_1.z.literal('session.renewed'),
|
|
64
|
+
})
|
|
65
|
+
.strict(),
|
|
66
|
+
zod_1.z
|
|
67
|
+
.object({
|
|
68
|
+
...envelope,
|
|
69
|
+
height: zod_1.z.number().int().positive(),
|
|
70
|
+
type: zod_1.z.literal('resize'),
|
|
71
|
+
})
|
|
72
|
+
.strict(),
|
|
73
|
+
]);
|
|
74
|
+
const parentMessageSchema = zod_1.z.discriminatedUnion('type', [
|
|
75
|
+
zod_1.z
|
|
76
|
+
.object({
|
|
77
|
+
...envelope,
|
|
78
|
+
embedUrl: zod_1.z.url(),
|
|
79
|
+
replyTo: zod_1.z.uuid(),
|
|
80
|
+
requestId: zod_1.z.uuid(),
|
|
81
|
+
type: zod_1.z.literal('session.renew'),
|
|
82
|
+
})
|
|
83
|
+
.strict(),
|
|
84
|
+
]);
|
|
85
|
+
exports.embedLifecycle = {
|
|
86
|
+
channelConnectSchema,
|
|
87
|
+
channelRequestSchema,
|
|
88
|
+
iframeMessageSchema,
|
|
89
|
+
parentMessageSchema,
|
|
90
|
+
protocol,
|
|
91
|
+
version,
|
|
92
|
+
};
|
|
93
|
+
//# sourceMappingURL=embed-lifecycle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"embed-lifecycle.js","sourceRoot":"src/","sources":["embed-lifecycle.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAC9C,MAAM,OAAO,GAAG,CAAC,CAAC;AAClB,MAAM,QAAQ,GAAG;IACf,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE;IACnB,QAAQ,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC7B,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CAC5B,CAAC;AACF,MAAM,oBAAoB,GAAG,OAAC;KAC3B,MAAM,CAAC;IACN,GAAG,QAAQ;IACX,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE;IACnB,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;CACnC,CAAC;KACD,MAAM,EAAE,CAAC;AACZ,MAAM,oBAAoB,GAAG,OAAC;KAC3B,MAAM,CAAC;IACN,GAAG,QAAQ;IACX,OAAO,EAAE,OAAC,CAAC,IAAI,EAAE;IACjB,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;CACnC,CAAC;KACD,MAAM,EAAE,CAAC;AACZ,MAAM,mBAAmB,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACvD,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACzB,CAAC;SACD,MAAM,EAAE;IACX,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC;YACX,uBAAuB;YACvB,eAAe;YACf,iBAAiB;YACjB,gBAAgB;YAChB,qBAAqB;YACrB,gBAAgB;SACjB,CAAC;QACF,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QACzC,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;QAC5B,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACzB,CAAC;SACD,MAAM,EAAE;IACX,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,SAAS,EAAE,OAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC3C,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE;QACnB,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;KACpC,CAAC;SACD,MAAM,EAAE;IACX,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,SAAS,EAAE,OAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC3C,OAAO,EAAE,OAAC,CAAC,IAAI,EAAE;QACjB,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;KACnC,CAAC;SACD,MAAM,EAAE;IACX,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC1B,CAAC;SACD,MAAM,EAAE;CACZ,CAAC,CAAC;AACH,MAAM,mBAAmB,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACvD,OAAC;SACE,MAAM,CAAC;QACN,GAAG,QAAQ;QACX,QAAQ,EAAE,OAAC,CAAC,GAAG,EAAE;QACjB,OAAO,EAAE,OAAC,CAAC,IAAI,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE;QACnB,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,eAAe,CAAC;KACjC,CAAC;SACD,MAAM,EAAE;CACZ,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG;IAC5B,oBAAoB;IACpB,oBAAoB;IACpB,mBAAmB;IACnB,mBAAmB;IACnB,QAAQ;IACR,OAAO;CACC,CAAC","sourcesContent":["import { z } from 'zod';\n\nconst protocol = 'vrplatform.embed.lifecycle';\nconst version = 1;\nconst envelope = {\n channelId: z.uuid(),\n protocol: z.literal(protocol),\n version: z.literal(version),\n};\nconst channelRequestSchema = z\n .object({\n ...envelope,\n requestId: z.uuid(),\n type: z.literal('channel.request'),\n })\n .strict();\nconst channelConnectSchema = z\n .object({\n ...envelope,\n replyTo: z.uuid(),\n type: z.literal('channel.connect'),\n })\n .strict();\nconst iframeMessageSchema = z.discriminatedUnion('type', [\n z\n .object({\n ...envelope,\n type: z.literal('ready'),\n })\n .strict(),\n z\n .object({\n ...envelope,\n code: z.enum([\n 'authentication_failed',\n 'access_denied',\n 'session_expired',\n 'renewal_failed',\n 'unsupported_version',\n 'internal_error',\n ]),\n correlationId: z.string().min(1).max(128),\n recoverable: z.boolean(),\n replyTo: z.uuid().optional(),\n type: z.literal('error'),\n })\n .strict(),\n z\n .object({\n ...envelope,\n expiresAt: z.iso.datetime({ offset: true }),\n requestId: z.uuid(),\n type: z.literal('session.expiring'),\n })\n .strict(),\n z\n .object({\n ...envelope,\n expiresAt: z.iso.datetime({ offset: true }),\n replyTo: z.uuid(),\n type: z.literal('session.renewed'),\n })\n .strict(),\n z\n .object({\n ...envelope,\n height: z.number().int().positive(),\n type: z.literal('resize'),\n })\n .strict(),\n]);\nconst parentMessageSchema = z.discriminatedUnion('type', [\n z\n .object({\n ...envelope,\n embedUrl: z.url(),\n replyTo: z.uuid(),\n requestId: z.uuid(),\n type: z.literal('session.renew'),\n })\n .strict(),\n]);\n\nexport const embedLifecycle = {\n channelConnectSchema,\n channelRequestSchema,\n iframeMessageSchema,\n parentMessageSchema,\n protocol,\n version,\n} as const;\n\nexport type EmbedLifecycleChannelConnect = z.infer<typeof channelConnectSchema>;\nexport type EmbedLifecycleChannelRequest = z.infer<typeof channelRequestSchema>;\nexport type EmbedLifecycleIframeMessage = z.infer<typeof iframeMessageSchema>;\nexport type EmbedLifecycleParentMessage = z.infer<typeof parentMessageSchema>;\n"]}
|
|
@@ -269,7 +269,7 @@ export interface paths {
|
|
|
269
269
|
/** @description List API token metadata for the current team without revealing token secrets. Requires an authenticated team admin or global VRP admin. */
|
|
270
270
|
get: operations["getApiTokens"];
|
|
271
271
|
put?: never;
|
|
272
|
-
/** @description Generate an API token for the current team and return its secret. Partner teams may provide capability bundles to restrict the token; omission grants unrestricted partner API access. An optional IP allowlist is enforced on every API-key request. Requires an authenticated team admin or global VRP admin. The token secret is never written to audit records. */
|
|
272
|
+
/** @description Generate an API token for the current team and return its secret. Partner teams may provide capability bundles to restrict the token; omission grants unrestricted partner API access. An optional IP allowlist is enforced on every API-key request, and an optional exact parent-origin allowlist restricts embedded-session creation and renewal. Requires an authenticated team admin or global VRP admin. The token secret is never written to audit records. */
|
|
273
273
|
post: operations["postApiTokens"];
|
|
274
274
|
delete?: never;
|
|
275
275
|
options?: never;
|
|
@@ -2682,6 +2682,27 @@ export interface paths {
|
|
|
2682
2682
|
patch?: never;
|
|
2683
2683
|
trace?: never;
|
|
2684
2684
|
};
|
|
2685
|
+
"/partner/embed-sessions/{id}/renewals": {
|
|
2686
|
+
parameters: {
|
|
2687
|
+
query?: never;
|
|
2688
|
+
header?: never;
|
|
2689
|
+
path?: never;
|
|
2690
|
+
cookie?: never;
|
|
2691
|
+
};
|
|
2692
|
+
get?: never;
|
|
2693
|
+
put?: never;
|
|
2694
|
+
/**
|
|
2695
|
+
* @description Issue a single-use successor for an active embedded session without changing its grant or revoking it before exchange.
|
|
2696
|
+
*
|
|
2697
|
+
* Required scope: embedded-sessions:issue
|
|
2698
|
+
*/
|
|
2699
|
+
post: operations["renewEmbedSession"];
|
|
2700
|
+
delete?: never;
|
|
2701
|
+
options?: never;
|
|
2702
|
+
head?: never;
|
|
2703
|
+
patch?: never;
|
|
2704
|
+
trace?: never;
|
|
2705
|
+
};
|
|
2685
2706
|
"/partner/listings": {
|
|
2686
2707
|
parameters: {
|
|
2687
2708
|
query?: never;
|
|
@@ -8949,6 +8970,7 @@ export interface operations {
|
|
|
8949
8970
|
content: {
|
|
8950
8971
|
"application/json": {
|
|
8951
8972
|
data: {
|
|
8973
|
+
allowedEmbedParentOrigins: string[];
|
|
8952
8974
|
allowedIpCidrs: string[];
|
|
8953
8975
|
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8954
8976
|
/** Format: uuid */
|
|
@@ -9120,6 +9142,8 @@ export interface operations {
|
|
|
9120
9142
|
requestBody?: {
|
|
9121
9143
|
content: {
|
|
9122
9144
|
"application/json": {
|
|
9145
|
+
/** @description Exact HTTP(S) parent origins allowed when this partner token creates embedded sessions. A non-empty list is enforced exactly on issuance and renewal; omission currently leaves parent origins unrestricted. An empty array is rejected. Rejected for ordinary teams. */
|
|
9146
|
+
allowedEmbedParentOrigins?: string[];
|
|
9123
9147
|
/** @description Optional IPv4 or IPv6 addresses and CIDRs allowed to use this token. Individual addresses are normalized to /32 or /128. Omit or send an empty array for no IP restriction. */
|
|
9124
9148
|
allowedIpCidrs?: string[];
|
|
9125
9149
|
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
@@ -9135,6 +9159,7 @@ export interface operations {
|
|
|
9135
9159
|
};
|
|
9136
9160
|
content: {
|
|
9137
9161
|
"application/json": {
|
|
9162
|
+
allowedEmbedParentOrigins: string[];
|
|
9138
9163
|
allowedIpCidrs: string[];
|
|
9139
9164
|
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
9140
9165
|
/** Format: uuid */
|
|
@@ -9305,6 +9330,7 @@ export interface operations {
|
|
|
9305
9330
|
};
|
|
9306
9331
|
content: {
|
|
9307
9332
|
"application/json": {
|
|
9333
|
+
allowedEmbedParentOrigins: string[];
|
|
9308
9334
|
allowedIpCidrs: string[];
|
|
9309
9335
|
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
9310
9336
|
/** Format: uuid */
|
|
@@ -21321,11 +21347,21 @@ export interface operations {
|
|
|
21321
21347
|
accessToken: string;
|
|
21322
21348
|
/** @description Embedded capability bundles granted to the session. */
|
|
21323
21349
|
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
|
|
21350
|
+
/**
|
|
21351
|
+
* Format: uuid
|
|
21352
|
+
* @description Stable lifecycle channel ID for this iframe.
|
|
21353
|
+
*/
|
|
21354
|
+
channelId: string;
|
|
21324
21355
|
/**
|
|
21325
21356
|
* Format: date-time
|
|
21326
21357
|
* @description Bearer-token expiration timestamp.
|
|
21327
21358
|
*/
|
|
21328
21359
|
expiresAt: string;
|
|
21360
|
+
/**
|
|
21361
|
+
* Format: uri
|
|
21362
|
+
* @description Exact parent-page origin bound to the lifecycle channel.
|
|
21363
|
+
*/
|
|
21364
|
+
parentOrigin: string;
|
|
21329
21365
|
/**
|
|
21330
21366
|
* Format: uuid
|
|
21331
21367
|
* @description Session ID created by the partner backend.
|
|
@@ -42734,6 +42770,16 @@ export interface operations {
|
|
|
42734
42770
|
autoProvision?: boolean;
|
|
42735
42771
|
/** @description Embedded capability bundles granted to the session. */
|
|
42736
42772
|
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
|
|
42773
|
+
/**
|
|
42774
|
+
* Format: uri
|
|
42775
|
+
* @description Exact embedded-application origin that will exchange the bootstrap.
|
|
42776
|
+
*/
|
|
42777
|
+
embedOrigin: string;
|
|
42778
|
+
/**
|
|
42779
|
+
* Format: uri
|
|
42780
|
+
* @description Exact parent-page origin to bind to this iframe lifecycle channel.
|
|
42781
|
+
*/
|
|
42782
|
+
parentOrigin: string;
|
|
42737
42783
|
/** @description Stable external user identifier in the partner system. */
|
|
42738
42784
|
sub: string;
|
|
42739
42785
|
/**
|
|
@@ -42761,6 +42807,11 @@ export interface operations {
|
|
|
42761
42807
|
* @description Deadline for exchanging the one-time bootstrap code.
|
|
42762
42808
|
*/
|
|
42763
42809
|
bootstrapExpiresAt: string;
|
|
42810
|
+
/**
|
|
42811
|
+
* Format: uuid
|
|
42812
|
+
* @description Stable lifecycle channel ID for this iframe.
|
|
42813
|
+
*/
|
|
42814
|
+
channelId: string;
|
|
42764
42815
|
/**
|
|
42765
42816
|
* Format: uri
|
|
42766
42817
|
* @description Ready-to-mount embedded application URL.
|
|
@@ -42771,6 +42822,11 @@ export interface operations {
|
|
|
42771
42822
|
* @description Session ID used for explicit revocation.
|
|
42772
42823
|
*/
|
|
42773
42824
|
id: string;
|
|
42825
|
+
/**
|
|
42826
|
+
* Format: uri
|
|
42827
|
+
* @description Exact parent-page origin bound to the lifecycle channel.
|
|
42828
|
+
*/
|
|
42829
|
+
parentOrigin: string;
|
|
42774
42830
|
/**
|
|
42775
42831
|
* @description Bearer-session lifetime, starting when the code is exchanged.
|
|
42776
42832
|
* @constant
|
|
@@ -43083,6 +43139,204 @@ export interface operations {
|
|
|
43083
43139
|
};
|
|
43084
43140
|
};
|
|
43085
43141
|
};
|
|
43142
|
+
renewEmbedSession: {
|
|
43143
|
+
parameters: {
|
|
43144
|
+
query?: never;
|
|
43145
|
+
header?: never;
|
|
43146
|
+
path: {
|
|
43147
|
+
/** @description Active embedded session to replace. */
|
|
43148
|
+
id: string;
|
|
43149
|
+
};
|
|
43150
|
+
cookie?: never;
|
|
43151
|
+
};
|
|
43152
|
+
requestBody?: never;
|
|
43153
|
+
responses: {
|
|
43154
|
+
/** @description Successful response */
|
|
43155
|
+
200: {
|
|
43156
|
+
headers: {
|
|
43157
|
+
/** @description Prevents storage of the successor bootstrap URL and code. */
|
|
43158
|
+
"Cache-Control"?: "no-store";
|
|
43159
|
+
[name: string]: unknown;
|
|
43160
|
+
};
|
|
43161
|
+
content: {
|
|
43162
|
+
"application/json": {
|
|
43163
|
+
/**
|
|
43164
|
+
* Format: date-time
|
|
43165
|
+
* @description Deadline for exchanging the one-time bootstrap code.
|
|
43166
|
+
*/
|
|
43167
|
+
bootstrapExpiresAt: string;
|
|
43168
|
+
/**
|
|
43169
|
+
* Format: uuid
|
|
43170
|
+
* @description Stable lifecycle channel ID for this iframe.
|
|
43171
|
+
*/
|
|
43172
|
+
channelId: string;
|
|
43173
|
+
/**
|
|
43174
|
+
* Format: uri
|
|
43175
|
+
* @description Ready-to-mount embedded application URL.
|
|
43176
|
+
*/
|
|
43177
|
+
embedUrl: string;
|
|
43178
|
+
/**
|
|
43179
|
+
* Format: uuid
|
|
43180
|
+
* @description Session ID used for explicit revocation.
|
|
43181
|
+
*/
|
|
43182
|
+
id: string;
|
|
43183
|
+
/**
|
|
43184
|
+
* Format: uri
|
|
43185
|
+
* @description Exact parent-page origin bound to the lifecycle channel.
|
|
43186
|
+
*/
|
|
43187
|
+
parentOrigin: string;
|
|
43188
|
+
/**
|
|
43189
|
+
* @description Bearer-session lifetime, starting when the code is exchanged.
|
|
43190
|
+
* @constant
|
|
43191
|
+
*/
|
|
43192
|
+
sessionTtlSeconds: 900;
|
|
43193
|
+
/**
|
|
43194
|
+
* Format: uuid
|
|
43195
|
+
* @description Team bound to the embedded session.
|
|
43196
|
+
*/
|
|
43197
|
+
teamId: string;
|
|
43198
|
+
/**
|
|
43199
|
+
* Format: uuid
|
|
43200
|
+
* @description VRPlatform user bound to the session.
|
|
43201
|
+
*/
|
|
43202
|
+
userId: string;
|
|
43203
|
+
};
|
|
43204
|
+
};
|
|
43205
|
+
};
|
|
43206
|
+
/** @description Bad request */
|
|
43207
|
+
400: {
|
|
43208
|
+
headers: {
|
|
43209
|
+
[name: string]: unknown;
|
|
43210
|
+
};
|
|
43211
|
+
content: {
|
|
43212
|
+
"application/json": {
|
|
43213
|
+
code: string;
|
|
43214
|
+
message: string;
|
|
43215
|
+
links?: {
|
|
43216
|
+
docs: string;
|
|
43217
|
+
schema: string;
|
|
43218
|
+
};
|
|
43219
|
+
issues?: {
|
|
43220
|
+
message: string;
|
|
43221
|
+
path?: (string | number)[];
|
|
43222
|
+
schema?: string;
|
|
43223
|
+
}[];
|
|
43224
|
+
context?: unknown;
|
|
43225
|
+
};
|
|
43226
|
+
};
|
|
43227
|
+
};
|
|
43228
|
+
/** @description Unauthorized */
|
|
43229
|
+
401: {
|
|
43230
|
+
headers: {
|
|
43231
|
+
[name: string]: unknown;
|
|
43232
|
+
};
|
|
43233
|
+
content: {
|
|
43234
|
+
"application/json": {
|
|
43235
|
+
code: string;
|
|
43236
|
+
message: string;
|
|
43237
|
+
links?: {
|
|
43238
|
+
docs: string;
|
|
43239
|
+
schema: string;
|
|
43240
|
+
};
|
|
43241
|
+
issues?: {
|
|
43242
|
+
message: string;
|
|
43243
|
+
path?: (string | number)[];
|
|
43244
|
+
schema?: string;
|
|
43245
|
+
}[];
|
|
43246
|
+
context?: unknown;
|
|
43247
|
+
};
|
|
43248
|
+
};
|
|
43249
|
+
};
|
|
43250
|
+
/** @description Forbidden */
|
|
43251
|
+
403: {
|
|
43252
|
+
headers: {
|
|
43253
|
+
[name: string]: unknown;
|
|
43254
|
+
};
|
|
43255
|
+
content: {
|
|
43256
|
+
"application/json": {
|
|
43257
|
+
code: string;
|
|
43258
|
+
message: string;
|
|
43259
|
+
links?: {
|
|
43260
|
+
docs: string;
|
|
43261
|
+
schema: string;
|
|
43262
|
+
};
|
|
43263
|
+
issues?: {
|
|
43264
|
+
message: string;
|
|
43265
|
+
path?: (string | number)[];
|
|
43266
|
+
schema?: string;
|
|
43267
|
+
}[];
|
|
43268
|
+
context?: unknown;
|
|
43269
|
+
};
|
|
43270
|
+
};
|
|
43271
|
+
};
|
|
43272
|
+
/** @description Not found */
|
|
43273
|
+
404: {
|
|
43274
|
+
headers: {
|
|
43275
|
+
[name: string]: unknown;
|
|
43276
|
+
};
|
|
43277
|
+
content: {
|
|
43278
|
+
"application/json": {
|
|
43279
|
+
code: string;
|
|
43280
|
+
message: string;
|
|
43281
|
+
links?: {
|
|
43282
|
+
docs: string;
|
|
43283
|
+
schema: string;
|
|
43284
|
+
};
|
|
43285
|
+
issues?: {
|
|
43286
|
+
message: string;
|
|
43287
|
+
path?: (string | number)[];
|
|
43288
|
+
schema?: string;
|
|
43289
|
+
}[];
|
|
43290
|
+
context?: unknown;
|
|
43291
|
+
};
|
|
43292
|
+
};
|
|
43293
|
+
};
|
|
43294
|
+
/** @description Internal server error */
|
|
43295
|
+
500: {
|
|
43296
|
+
headers: {
|
|
43297
|
+
[name: string]: unknown;
|
|
43298
|
+
};
|
|
43299
|
+
content: {
|
|
43300
|
+
"application/json": {
|
|
43301
|
+
code: string;
|
|
43302
|
+
message: string;
|
|
43303
|
+
links?: {
|
|
43304
|
+
docs: string;
|
|
43305
|
+
schema: string;
|
|
43306
|
+
};
|
|
43307
|
+
issues?: {
|
|
43308
|
+
message: string;
|
|
43309
|
+
path?: (string | number)[];
|
|
43310
|
+
schema?: string;
|
|
43311
|
+
}[];
|
|
43312
|
+
context?: unknown;
|
|
43313
|
+
};
|
|
43314
|
+
};
|
|
43315
|
+
};
|
|
43316
|
+
/** @description Service unavailable */
|
|
43317
|
+
503: {
|
|
43318
|
+
headers: {
|
|
43319
|
+
[name: string]: unknown;
|
|
43320
|
+
};
|
|
43321
|
+
content: {
|
|
43322
|
+
"application/json": {
|
|
43323
|
+
code: string;
|
|
43324
|
+
message: string;
|
|
43325
|
+
links?: {
|
|
43326
|
+
docs: string;
|
|
43327
|
+
schema: string;
|
|
43328
|
+
};
|
|
43329
|
+
issues?: {
|
|
43330
|
+
message: string;
|
|
43331
|
+
path?: (string | number)[];
|
|
43332
|
+
schema?: string;
|
|
43333
|
+
}[];
|
|
43334
|
+
context?: unknown;
|
|
43335
|
+
};
|
|
43336
|
+
};
|
|
43337
|
+
};
|
|
43338
|
+
};
|
|
43339
|
+
};
|
|
43086
43340
|
getPartnerListings: {
|
|
43087
43341
|
parameters: {
|
|
43088
43342
|
query?: {
|