@oxchannels/sdk 1.0.0
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/LICENSE +7 -0
- package/QUICKSTART.md +604 -0
- package/README.md +193 -0
- package/contracts/openapi-agent-bootstrap-contract-v2.json +1266 -0
- package/contracts/openapi-dashboard-contract-v2.json +98996 -0
- package/contracts/openapi-partner-contract-v2.json +14808 -0
- package/contracts/openapi-public-contract-v2.json +13489 -0
- package/dist/client.d.ts +83 -0
- package/dist/client.js +661 -0
- package/dist/generated/agent-bootstrap-contract-v2-schema.d.ts +398 -0
- package/dist/generated/agent-bootstrap-contract-v2-schema.js +1 -0
- package/dist/generated/client.d.ts +1 -0
- package/dist/generated/client.js +2 -0
- package/dist/generated/contracts/api-errors.d.ts +83 -0
- package/dist/generated/contracts/api-errors.js +296 -0
- package/dist/generated/contracts/json-data.d.ts +16 -0
- package/dist/generated/contracts/json-data.js +308 -0
- package/dist/generated/dashboard-contract-v2-schema.d.ts +45429 -0
- package/dist/generated/dashboard-contract-v2-schema.js +1 -0
- package/dist/generated/partner-contract-v2-schema.d.ts +6458 -0
- package/dist/generated/partner-contract-v2-schema.js +1 -0
- package/dist/generated/public-contract-v2-schema.d.ts +4112 -0
- package/dist/generated/public-contract-v2-schema.js +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +1 -0
- package/generated/provenance.json +87 -0
- package/package.json +55 -0
|
@@ -0,0 +1,4112 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/.well-known/oauth-authorization-server": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/** RFC 8414 authorization server metadata */
|
|
10
|
+
get: operations["OAuthDiscovery_authorizationServer"];
|
|
11
|
+
put?: never;
|
|
12
|
+
post?: never;
|
|
13
|
+
delete?: never;
|
|
14
|
+
options?: never;
|
|
15
|
+
head?: never;
|
|
16
|
+
patch?: never;
|
|
17
|
+
trace?: never;
|
|
18
|
+
};
|
|
19
|
+
"/.well-known/oauth-protected-resource/mcp": {
|
|
20
|
+
parameters: {
|
|
21
|
+
query?: never;
|
|
22
|
+
header?: never;
|
|
23
|
+
path?: never;
|
|
24
|
+
cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
/** RFC 9728 protected resource metadata for hosted MCP */
|
|
27
|
+
get: operations["OAuthDiscovery_protectedResource"];
|
|
28
|
+
put?: never;
|
|
29
|
+
post?: never;
|
|
30
|
+
delete?: never;
|
|
31
|
+
options?: never;
|
|
32
|
+
head?: never;
|
|
33
|
+
patch?: never;
|
|
34
|
+
trace?: never;
|
|
35
|
+
};
|
|
36
|
+
"/.well-known/openid-configuration": {
|
|
37
|
+
parameters: {
|
|
38
|
+
query?: never;
|
|
39
|
+
header?: never;
|
|
40
|
+
path?: never;
|
|
41
|
+
cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
/** OpenID Connect discovery alias for the same authorization server */
|
|
44
|
+
get: operations["OAuthDiscovery_openidConfiguration"];
|
|
45
|
+
put?: never;
|
|
46
|
+
post?: never;
|
|
47
|
+
delete?: never;
|
|
48
|
+
options?: never;
|
|
49
|
+
head?: never;
|
|
50
|
+
patch?: never;
|
|
51
|
+
trace?: never;
|
|
52
|
+
};
|
|
53
|
+
"/health/live": {
|
|
54
|
+
parameters: {
|
|
55
|
+
query?: never;
|
|
56
|
+
header?: never;
|
|
57
|
+
path?: never;
|
|
58
|
+
cookie?: never;
|
|
59
|
+
};
|
|
60
|
+
/** get Liveness */
|
|
61
|
+
get: operations["getLiveness"];
|
|
62
|
+
put?: never;
|
|
63
|
+
post?: never;
|
|
64
|
+
delete?: never;
|
|
65
|
+
options?: never;
|
|
66
|
+
head?: never;
|
|
67
|
+
patch?: never;
|
|
68
|
+
trace?: never;
|
|
69
|
+
};
|
|
70
|
+
"/health/ready": {
|
|
71
|
+
parameters: {
|
|
72
|
+
query?: never;
|
|
73
|
+
header?: never;
|
|
74
|
+
path?: never;
|
|
75
|
+
cookie?: never;
|
|
76
|
+
};
|
|
77
|
+
/** get Readiness */
|
|
78
|
+
get: operations["getReadiness"];
|
|
79
|
+
put?: never;
|
|
80
|
+
post?: never;
|
|
81
|
+
delete?: never;
|
|
82
|
+
options?: never;
|
|
83
|
+
head?: never;
|
|
84
|
+
patch?: never;
|
|
85
|
+
trace?: never;
|
|
86
|
+
};
|
|
87
|
+
"/oauth/register": {
|
|
88
|
+
parameters: {
|
|
89
|
+
query?: never;
|
|
90
|
+
header?: never;
|
|
91
|
+
path?: never;
|
|
92
|
+
cookie?: never;
|
|
93
|
+
};
|
|
94
|
+
get?: never;
|
|
95
|
+
put?: never;
|
|
96
|
+
/** Admit a client metadata document URL for MCP registration */
|
|
97
|
+
post: operations["OAuthClientRegistration_admit"];
|
|
98
|
+
delete?: never;
|
|
99
|
+
options?: never;
|
|
100
|
+
head?: never;
|
|
101
|
+
patch?: never;
|
|
102
|
+
trace?: never;
|
|
103
|
+
};
|
|
104
|
+
"/oauth/token": {
|
|
105
|
+
parameters: {
|
|
106
|
+
query?: never;
|
|
107
|
+
header?: never;
|
|
108
|
+
path?: never;
|
|
109
|
+
cookie?: never;
|
|
110
|
+
};
|
|
111
|
+
get?: never;
|
|
112
|
+
put?: never;
|
|
113
|
+
/** Issue a hosted MCP access token */
|
|
114
|
+
post: operations["OAuthToken_issue"];
|
|
115
|
+
delete?: never;
|
|
116
|
+
options?: never;
|
|
117
|
+
head?: never;
|
|
118
|
+
patch?: never;
|
|
119
|
+
trace?: never;
|
|
120
|
+
};
|
|
121
|
+
"/v1/auth/local/password/forgot": {
|
|
122
|
+
parameters: {
|
|
123
|
+
query?: never;
|
|
124
|
+
header?: never;
|
|
125
|
+
path?: never;
|
|
126
|
+
cookie?: never;
|
|
127
|
+
};
|
|
128
|
+
get?: never;
|
|
129
|
+
put?: never;
|
|
130
|
+
/** Local Auth forgot Password */
|
|
131
|
+
post: operations["LocalAuth_forgotPassword"];
|
|
132
|
+
delete?: never;
|
|
133
|
+
options?: never;
|
|
134
|
+
head?: never;
|
|
135
|
+
patch?: never;
|
|
136
|
+
trace?: never;
|
|
137
|
+
};
|
|
138
|
+
"/v1/auth/local/password/reset": {
|
|
139
|
+
parameters: {
|
|
140
|
+
query?: never;
|
|
141
|
+
header?: never;
|
|
142
|
+
path?: never;
|
|
143
|
+
cookie?: never;
|
|
144
|
+
};
|
|
145
|
+
get?: never;
|
|
146
|
+
put?: never;
|
|
147
|
+
/** Local Auth reset Password */
|
|
148
|
+
post: operations["LocalAuth_resetPassword"];
|
|
149
|
+
delete?: never;
|
|
150
|
+
options?: never;
|
|
151
|
+
head?: never;
|
|
152
|
+
patch?: never;
|
|
153
|
+
trace?: never;
|
|
154
|
+
};
|
|
155
|
+
"/v1/auth/local/signin": {
|
|
156
|
+
parameters: {
|
|
157
|
+
query?: never;
|
|
158
|
+
header?: never;
|
|
159
|
+
path?: never;
|
|
160
|
+
cookie?: never;
|
|
161
|
+
};
|
|
162
|
+
get?: never;
|
|
163
|
+
put?: never;
|
|
164
|
+
/** Local Auth sign In */
|
|
165
|
+
post: operations["LocalAuth_signIn"];
|
|
166
|
+
delete?: never;
|
|
167
|
+
options?: never;
|
|
168
|
+
head?: never;
|
|
169
|
+
patch?: never;
|
|
170
|
+
trace?: never;
|
|
171
|
+
};
|
|
172
|
+
"/v1/auth/local/signup": {
|
|
173
|
+
parameters: {
|
|
174
|
+
query?: never;
|
|
175
|
+
header?: never;
|
|
176
|
+
path?: never;
|
|
177
|
+
cookie?: never;
|
|
178
|
+
};
|
|
179
|
+
get?: never;
|
|
180
|
+
put?: never;
|
|
181
|
+
/** Local Auth signup */
|
|
182
|
+
post: operations["LocalAuth_signup"];
|
|
183
|
+
delete?: never;
|
|
184
|
+
options?: never;
|
|
185
|
+
head?: never;
|
|
186
|
+
patch?: never;
|
|
187
|
+
trace?: never;
|
|
188
|
+
};
|
|
189
|
+
"/v1/auth/local/verify/resend": {
|
|
190
|
+
parameters: {
|
|
191
|
+
query?: never;
|
|
192
|
+
header?: never;
|
|
193
|
+
path?: never;
|
|
194
|
+
cookie?: never;
|
|
195
|
+
};
|
|
196
|
+
get?: never;
|
|
197
|
+
put?: never;
|
|
198
|
+
/** Local Auth resend */
|
|
199
|
+
post: operations["LocalAuth_resend"];
|
|
200
|
+
delete?: never;
|
|
201
|
+
options?: never;
|
|
202
|
+
head?: never;
|
|
203
|
+
patch?: never;
|
|
204
|
+
trace?: never;
|
|
205
|
+
};
|
|
206
|
+
"/v1/auth/resume/start": {
|
|
207
|
+
parameters: {
|
|
208
|
+
query?: never;
|
|
209
|
+
header?: never;
|
|
210
|
+
path?: never;
|
|
211
|
+
cookie?: never;
|
|
212
|
+
};
|
|
213
|
+
get?: never;
|
|
214
|
+
put?: never;
|
|
215
|
+
/** Identity start Journey Resume */
|
|
216
|
+
post: operations["Identity_startJourneyResume"];
|
|
217
|
+
delete?: never;
|
|
218
|
+
options?: never;
|
|
219
|
+
head?: never;
|
|
220
|
+
patch?: never;
|
|
221
|
+
trace?: never;
|
|
222
|
+
};
|
|
223
|
+
"/v1/auth/social/providers": {
|
|
224
|
+
parameters: {
|
|
225
|
+
query?: never;
|
|
226
|
+
header?: never;
|
|
227
|
+
path?: never;
|
|
228
|
+
cookie?: never;
|
|
229
|
+
};
|
|
230
|
+
/** Local Auth providers */
|
|
231
|
+
get: operations["LocalAuth_providers"];
|
|
232
|
+
put?: never;
|
|
233
|
+
post?: never;
|
|
234
|
+
delete?: never;
|
|
235
|
+
options?: never;
|
|
236
|
+
head?: never;
|
|
237
|
+
patch?: never;
|
|
238
|
+
trace?: never;
|
|
239
|
+
};
|
|
240
|
+
"/v1/public/catalog": {
|
|
241
|
+
parameters: {
|
|
242
|
+
query?: never;
|
|
243
|
+
header?: never;
|
|
244
|
+
path?: never;
|
|
245
|
+
cookie?: never;
|
|
246
|
+
};
|
|
247
|
+
/** Public Catalog list */
|
|
248
|
+
get: operations["PublicCatalog_list"];
|
|
249
|
+
put?: never;
|
|
250
|
+
post?: never;
|
|
251
|
+
delete?: never;
|
|
252
|
+
options?: never;
|
|
253
|
+
head?: never;
|
|
254
|
+
patch?: never;
|
|
255
|
+
trace?: never;
|
|
256
|
+
};
|
|
257
|
+
"/v1/public/channels/{providerKey}/capabilities": {
|
|
258
|
+
parameters: {
|
|
259
|
+
query?: never;
|
|
260
|
+
header?: never;
|
|
261
|
+
path?: never;
|
|
262
|
+
cookie?: never;
|
|
263
|
+
};
|
|
264
|
+
/** Public Catalog capabilities */
|
|
265
|
+
get: operations["PublicCatalog_capabilities"];
|
|
266
|
+
put?: never;
|
|
267
|
+
post?: never;
|
|
268
|
+
delete?: never;
|
|
269
|
+
options?: never;
|
|
270
|
+
head?: never;
|
|
271
|
+
patch?: never;
|
|
272
|
+
trace?: never;
|
|
273
|
+
};
|
|
274
|
+
"/v1/public/channels/{providerKey}/limits": {
|
|
275
|
+
parameters: {
|
|
276
|
+
query?: never;
|
|
277
|
+
header?: never;
|
|
278
|
+
path?: never;
|
|
279
|
+
cookie?: never;
|
|
280
|
+
};
|
|
281
|
+
/** Public Catalog limits */
|
|
282
|
+
get: operations["PublicCatalog_limits"];
|
|
283
|
+
put?: never;
|
|
284
|
+
post?: never;
|
|
285
|
+
delete?: never;
|
|
286
|
+
options?: never;
|
|
287
|
+
head?: never;
|
|
288
|
+
patch?: never;
|
|
289
|
+
trace?: never;
|
|
290
|
+
};
|
|
291
|
+
"/v1/public/channels/{providerKey}/validation": {
|
|
292
|
+
parameters: {
|
|
293
|
+
query?: never;
|
|
294
|
+
header?: never;
|
|
295
|
+
path?: never;
|
|
296
|
+
cookie?: never;
|
|
297
|
+
};
|
|
298
|
+
/** Public Catalog validate */
|
|
299
|
+
get: operations["PublicCatalog_validate"];
|
|
300
|
+
put?: never;
|
|
301
|
+
post?: never;
|
|
302
|
+
delete?: never;
|
|
303
|
+
options?: never;
|
|
304
|
+
head?: never;
|
|
305
|
+
patch?: never;
|
|
306
|
+
trace?: never;
|
|
307
|
+
};
|
|
308
|
+
"/v1/public/demo/{fixtureKey}": {
|
|
309
|
+
parameters: {
|
|
310
|
+
query?: never;
|
|
311
|
+
header?: never;
|
|
312
|
+
path?: never;
|
|
313
|
+
cookie?: never;
|
|
314
|
+
};
|
|
315
|
+
/** Public Catalog demo */
|
|
316
|
+
get: operations["PublicCatalog_demo"];
|
|
317
|
+
put?: never;
|
|
318
|
+
post?: never;
|
|
319
|
+
delete?: never;
|
|
320
|
+
options?: never;
|
|
321
|
+
head?: never;
|
|
322
|
+
patch?: never;
|
|
323
|
+
trace?: never;
|
|
324
|
+
};
|
|
325
|
+
"/v1/public/pricing": {
|
|
326
|
+
parameters: {
|
|
327
|
+
query?: never;
|
|
328
|
+
header?: never;
|
|
329
|
+
path?: never;
|
|
330
|
+
cookie?: never;
|
|
331
|
+
};
|
|
332
|
+
/** Public Catalog pricing */
|
|
333
|
+
get: operations["PublicCatalog_pricing"];
|
|
334
|
+
put?: never;
|
|
335
|
+
post?: never;
|
|
336
|
+
delete?: never;
|
|
337
|
+
options?: never;
|
|
338
|
+
head?: never;
|
|
339
|
+
patch?: never;
|
|
340
|
+
trace?: never;
|
|
341
|
+
};
|
|
342
|
+
"/v1/public/pricing/calculate": {
|
|
343
|
+
parameters: {
|
|
344
|
+
query?: never;
|
|
345
|
+
header?: never;
|
|
346
|
+
path?: never;
|
|
347
|
+
cookie?: never;
|
|
348
|
+
};
|
|
349
|
+
/** Public Catalog calculate Pricing */
|
|
350
|
+
get: operations["PublicCatalog_calculatePricing"];
|
|
351
|
+
put?: never;
|
|
352
|
+
post?: never;
|
|
353
|
+
delete?: never;
|
|
354
|
+
options?: never;
|
|
355
|
+
head?: never;
|
|
356
|
+
patch?: never;
|
|
357
|
+
trace?: never;
|
|
358
|
+
};
|
|
359
|
+
}
|
|
360
|
+
export type webhooks = Record<string, never>;
|
|
361
|
+
export interface components {
|
|
362
|
+
schemas: {
|
|
363
|
+
CheckEmailResponseDto: {
|
|
364
|
+
/** @enum {string} */
|
|
365
|
+
status: "CHECK_EMAIL";
|
|
366
|
+
};
|
|
367
|
+
/** OxChannels ErrorEnvelope v1 */
|
|
368
|
+
ErrorEnvelope: {
|
|
369
|
+
/** @enum {string} */
|
|
370
|
+
code: "INVALID_REQUEST" | "AUTHENTICATION_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "IDEMPOTENCY_CONFLICT" | "RATE_LIMITED" | "INTERNAL_SAFE_FAILURE";
|
|
371
|
+
message: string;
|
|
372
|
+
retryable: boolean;
|
|
373
|
+
traceId: string;
|
|
374
|
+
/** @enum {string} */
|
|
375
|
+
version: "v1";
|
|
376
|
+
};
|
|
377
|
+
/** OxChannels ErrorEnvelope v2 */
|
|
378
|
+
ErrorEnvelopeV2: {
|
|
379
|
+
/** @enum {unknown} */
|
|
380
|
+
category: "VALIDATION";
|
|
381
|
+
/** @enum {unknown} */
|
|
382
|
+
code: "INVALID_REQUEST";
|
|
383
|
+
correlationId: string;
|
|
384
|
+
/** @enum {unknown} */
|
|
385
|
+
effectEvidence: "NOT_APPLIED";
|
|
386
|
+
message: string;
|
|
387
|
+
/** @enum {unknown} */
|
|
388
|
+
retryable: false;
|
|
389
|
+
/** @enum {unknown} */
|
|
390
|
+
schemaVersion: "2.0.0";
|
|
391
|
+
traceId: string;
|
|
392
|
+
violations?: {
|
|
393
|
+
code: string;
|
|
394
|
+
path: string;
|
|
395
|
+
}[];
|
|
396
|
+
} | {
|
|
397
|
+
/** @enum {unknown} */
|
|
398
|
+
category: "AUTHENTICATION";
|
|
399
|
+
/** @enum {unknown} */
|
|
400
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
401
|
+
correlationId: string;
|
|
402
|
+
/** @enum {unknown} */
|
|
403
|
+
effectEvidence: "NOT_APPLIED";
|
|
404
|
+
message: string;
|
|
405
|
+
/** @enum {unknown} */
|
|
406
|
+
retryable: true;
|
|
407
|
+
/** @enum {unknown} */
|
|
408
|
+
schemaVersion: "2.0.0";
|
|
409
|
+
traceId: string;
|
|
410
|
+
violations?: {
|
|
411
|
+
code: string;
|
|
412
|
+
path: string;
|
|
413
|
+
}[];
|
|
414
|
+
} | {
|
|
415
|
+
/** @enum {unknown} */
|
|
416
|
+
category: "AUTHORIZATION";
|
|
417
|
+
/** @enum {unknown} */
|
|
418
|
+
code: "FORBIDDEN";
|
|
419
|
+
correlationId: string;
|
|
420
|
+
/** @enum {unknown} */
|
|
421
|
+
effectEvidence: "NOT_APPLIED";
|
|
422
|
+
message: string;
|
|
423
|
+
/** @enum {unknown} */
|
|
424
|
+
retryable: false;
|
|
425
|
+
/** @enum {unknown} */
|
|
426
|
+
schemaVersion: "2.0.0";
|
|
427
|
+
traceId: string;
|
|
428
|
+
violations?: {
|
|
429
|
+
code: string;
|
|
430
|
+
path: string;
|
|
431
|
+
}[];
|
|
432
|
+
} | {
|
|
433
|
+
/** @enum {unknown} */
|
|
434
|
+
category: "RESOURCE";
|
|
435
|
+
/** @enum {unknown} */
|
|
436
|
+
code: "NOT_FOUND";
|
|
437
|
+
correlationId: string;
|
|
438
|
+
/** @enum {unknown} */
|
|
439
|
+
effectEvidence: "NOT_APPLIED";
|
|
440
|
+
message: string;
|
|
441
|
+
/** @enum {unknown} */
|
|
442
|
+
retryable: false;
|
|
443
|
+
/** @enum {unknown} */
|
|
444
|
+
schemaVersion: "2.0.0";
|
|
445
|
+
traceId: string;
|
|
446
|
+
violations?: {
|
|
447
|
+
code: string;
|
|
448
|
+
path: string;
|
|
449
|
+
}[];
|
|
450
|
+
} | {
|
|
451
|
+
/** @enum {unknown} */
|
|
452
|
+
category: "CONFLICT";
|
|
453
|
+
/** @enum {unknown} */
|
|
454
|
+
code: "IDEMPOTENCY_CONFLICT";
|
|
455
|
+
correlationId: string;
|
|
456
|
+
/** @enum {unknown} */
|
|
457
|
+
effectEvidence: null;
|
|
458
|
+
message: string;
|
|
459
|
+
/** @enum {unknown} */
|
|
460
|
+
retryable: false;
|
|
461
|
+
/** @enum {unknown} */
|
|
462
|
+
schemaVersion: "2.0.0";
|
|
463
|
+
traceId: string;
|
|
464
|
+
violations?: {
|
|
465
|
+
code: string;
|
|
466
|
+
path: string;
|
|
467
|
+
}[];
|
|
468
|
+
} | {
|
|
469
|
+
/** @enum {unknown} */
|
|
470
|
+
category: "RATE_LIMIT";
|
|
471
|
+
/** @enum {unknown} */
|
|
472
|
+
code: "RATE_LIMITED";
|
|
473
|
+
correlationId: string;
|
|
474
|
+
/** @enum {unknown} */
|
|
475
|
+
effectEvidence: null;
|
|
476
|
+
message: string;
|
|
477
|
+
/** @enum {unknown} */
|
|
478
|
+
retryable: true;
|
|
479
|
+
retryAfterSeconds: number;
|
|
480
|
+
/** @enum {unknown} */
|
|
481
|
+
schemaVersion: "2.0.0";
|
|
482
|
+
traceId: string;
|
|
483
|
+
violations?: {
|
|
484
|
+
code: string;
|
|
485
|
+
path: string;
|
|
486
|
+
}[];
|
|
487
|
+
} | {
|
|
488
|
+
/** @enum {unknown} */
|
|
489
|
+
category: "INTERNAL";
|
|
490
|
+
/** @enum {unknown} */
|
|
491
|
+
code: "INTERNAL_SAFE_FAILURE";
|
|
492
|
+
correlationId: string;
|
|
493
|
+
/** @enum {unknown} */
|
|
494
|
+
effectEvidence: null;
|
|
495
|
+
message: string;
|
|
496
|
+
/** @enum {unknown} */
|
|
497
|
+
retryable: false;
|
|
498
|
+
/** @enum {unknown} */
|
|
499
|
+
schemaVersion: "2.0.0";
|
|
500
|
+
traceId: string;
|
|
501
|
+
violations?: {
|
|
502
|
+
code: string;
|
|
503
|
+
path: string;
|
|
504
|
+
}[];
|
|
505
|
+
} | {
|
|
506
|
+
/** @enum {unknown} */
|
|
507
|
+
category: "CONFLICT";
|
|
508
|
+
/** @enum {unknown} */
|
|
509
|
+
code: "CONFLICT";
|
|
510
|
+
correlationId: string;
|
|
511
|
+
/** @enum {unknown} */
|
|
512
|
+
effectEvidence: null;
|
|
513
|
+
message: string;
|
|
514
|
+
/** @enum {unknown} */
|
|
515
|
+
retryable: false;
|
|
516
|
+
/** @enum {unknown} */
|
|
517
|
+
schemaVersion: "2.0.0";
|
|
518
|
+
traceId: string;
|
|
519
|
+
violations?: {
|
|
520
|
+
code: string;
|
|
521
|
+
path: string;
|
|
522
|
+
}[];
|
|
523
|
+
};
|
|
524
|
+
ErrorEnvelopeV2AuthenticationRequired: {
|
|
525
|
+
code: "ErrorEnvelopeV2AuthenticationRequired";
|
|
526
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
527
|
+
/** @enum {unknown} */
|
|
528
|
+
category: "AUTHENTICATION";
|
|
529
|
+
/** @enum {unknown} */
|
|
530
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
531
|
+
correlationId: string;
|
|
532
|
+
/** @enum {unknown} */
|
|
533
|
+
effectEvidence: "NOT_APPLIED";
|
|
534
|
+
message: string;
|
|
535
|
+
/** @enum {unknown} */
|
|
536
|
+
retryable: true;
|
|
537
|
+
/** @enum {unknown} */
|
|
538
|
+
schemaVersion: "2.0.0";
|
|
539
|
+
traceId: string;
|
|
540
|
+
violations?: {
|
|
541
|
+
code: string;
|
|
542
|
+
path: string;
|
|
543
|
+
}[];
|
|
544
|
+
});
|
|
545
|
+
ErrorEnvelopeV2Conflict: {
|
|
546
|
+
code: "ErrorEnvelopeV2Conflict";
|
|
547
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
548
|
+
/** @enum {unknown} */
|
|
549
|
+
category: "CONFLICT";
|
|
550
|
+
/** @enum {unknown} */
|
|
551
|
+
code: "CONFLICT";
|
|
552
|
+
correlationId: string;
|
|
553
|
+
/** @enum {unknown} */
|
|
554
|
+
effectEvidence: null;
|
|
555
|
+
message: string;
|
|
556
|
+
/** @enum {unknown} */
|
|
557
|
+
retryable: false;
|
|
558
|
+
/** @enum {unknown} */
|
|
559
|
+
schemaVersion: "2.0.0";
|
|
560
|
+
traceId: string;
|
|
561
|
+
violations?: {
|
|
562
|
+
code: string;
|
|
563
|
+
path: string;
|
|
564
|
+
}[];
|
|
565
|
+
});
|
|
566
|
+
ErrorEnvelopeV2IdempotencyConflict: {
|
|
567
|
+
code: "ErrorEnvelopeV2IdempotencyConflict";
|
|
568
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
569
|
+
/** @enum {unknown} */
|
|
570
|
+
category: "CONFLICT";
|
|
571
|
+
/** @enum {unknown} */
|
|
572
|
+
code: "IDEMPOTENCY_CONFLICT";
|
|
573
|
+
correlationId: string;
|
|
574
|
+
/** @enum {unknown} */
|
|
575
|
+
effectEvidence: null;
|
|
576
|
+
message: string;
|
|
577
|
+
/** @enum {unknown} */
|
|
578
|
+
retryable: false;
|
|
579
|
+
/** @enum {unknown} */
|
|
580
|
+
schemaVersion: "2.0.0";
|
|
581
|
+
traceId: string;
|
|
582
|
+
violations?: {
|
|
583
|
+
code: string;
|
|
584
|
+
path: string;
|
|
585
|
+
}[];
|
|
586
|
+
});
|
|
587
|
+
ErrorEnvelopeV2InternalSafeFailure: {
|
|
588
|
+
code: "ErrorEnvelopeV2InternalSafeFailure";
|
|
589
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
590
|
+
/** @enum {unknown} */
|
|
591
|
+
category: "INTERNAL";
|
|
592
|
+
/** @enum {unknown} */
|
|
593
|
+
code: "INTERNAL_SAFE_FAILURE";
|
|
594
|
+
correlationId: string;
|
|
595
|
+
/** @enum {unknown} */
|
|
596
|
+
effectEvidence: null;
|
|
597
|
+
message: string;
|
|
598
|
+
/** @enum {unknown} */
|
|
599
|
+
retryable: false;
|
|
600
|
+
/** @enum {unknown} */
|
|
601
|
+
schemaVersion: "2.0.0";
|
|
602
|
+
traceId: string;
|
|
603
|
+
violations?: {
|
|
604
|
+
code: string;
|
|
605
|
+
path: string;
|
|
606
|
+
}[];
|
|
607
|
+
});
|
|
608
|
+
ErrorEnvelopeV2InvalidRequest: {
|
|
609
|
+
code: "ErrorEnvelopeV2InvalidRequest";
|
|
610
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
611
|
+
/** @enum {unknown} */
|
|
612
|
+
category: "VALIDATION";
|
|
613
|
+
/** @enum {unknown} */
|
|
614
|
+
code: "INVALID_REQUEST";
|
|
615
|
+
correlationId: string;
|
|
616
|
+
/** @enum {unknown} */
|
|
617
|
+
effectEvidence: "NOT_APPLIED";
|
|
618
|
+
message: string;
|
|
619
|
+
/** @enum {unknown} */
|
|
620
|
+
retryable: false;
|
|
621
|
+
/** @enum {unknown} */
|
|
622
|
+
schemaVersion: "2.0.0";
|
|
623
|
+
traceId: string;
|
|
624
|
+
violations?: {
|
|
625
|
+
code: string;
|
|
626
|
+
path: string;
|
|
627
|
+
}[];
|
|
628
|
+
});
|
|
629
|
+
ErrorEnvelopeV2NotFound: {
|
|
630
|
+
code: "ErrorEnvelopeV2NotFound";
|
|
631
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
632
|
+
/** @enum {unknown} */
|
|
633
|
+
category: "RESOURCE";
|
|
634
|
+
/** @enum {unknown} */
|
|
635
|
+
code: "NOT_FOUND";
|
|
636
|
+
correlationId: string;
|
|
637
|
+
/** @enum {unknown} */
|
|
638
|
+
effectEvidence: "NOT_APPLIED";
|
|
639
|
+
message: string;
|
|
640
|
+
/** @enum {unknown} */
|
|
641
|
+
retryable: false;
|
|
642
|
+
/** @enum {unknown} */
|
|
643
|
+
schemaVersion: "2.0.0";
|
|
644
|
+
traceId: string;
|
|
645
|
+
violations?: {
|
|
646
|
+
code: string;
|
|
647
|
+
path: string;
|
|
648
|
+
}[];
|
|
649
|
+
});
|
|
650
|
+
ErrorEnvelopeV2RateLimited: {
|
|
651
|
+
code: "ErrorEnvelopeV2RateLimited";
|
|
652
|
+
} & (Omit<components["schemas"]["ErrorEnvelopeV2"], "code"> & {
|
|
653
|
+
/** @enum {unknown} */
|
|
654
|
+
category: "RATE_LIMIT";
|
|
655
|
+
/** @enum {unknown} */
|
|
656
|
+
code: "RATE_LIMITED";
|
|
657
|
+
correlationId: string;
|
|
658
|
+
/** @enum {unknown} */
|
|
659
|
+
effectEvidence: null;
|
|
660
|
+
message: string;
|
|
661
|
+
/** @enum {unknown} */
|
|
662
|
+
retryable: true;
|
|
663
|
+
retryAfterSeconds: number;
|
|
664
|
+
/** @enum {unknown} */
|
|
665
|
+
schemaVersion: "2.0.0";
|
|
666
|
+
traceId: string;
|
|
667
|
+
violations?: {
|
|
668
|
+
code: string;
|
|
669
|
+
path: string;
|
|
670
|
+
}[];
|
|
671
|
+
});
|
|
672
|
+
ForgotPasswordRequestDto: {
|
|
673
|
+
/** Format: email */
|
|
674
|
+
email: string;
|
|
675
|
+
};
|
|
676
|
+
PasswordChangedResponseDto: {
|
|
677
|
+
/** @enum {string} */
|
|
678
|
+
status: "PASSWORD_CHANGED";
|
|
679
|
+
};
|
|
680
|
+
ResendVerificationRequestDto: {
|
|
681
|
+
/** Format: email */
|
|
682
|
+
email: string;
|
|
683
|
+
};
|
|
684
|
+
ResetPasswordRequestDto: {
|
|
685
|
+
password: string;
|
|
686
|
+
token: string;
|
|
687
|
+
};
|
|
688
|
+
SignedInResponseDto: {
|
|
689
|
+
/** @description Docelowy adres panelu po zalogowaniu. */
|
|
690
|
+
returnTo: string;
|
|
691
|
+
/** @enum {string} */
|
|
692
|
+
status: "SIGNED_IN";
|
|
693
|
+
};
|
|
694
|
+
SignInRequestDto: {
|
|
695
|
+
/** Format: email */
|
|
696
|
+
email: string;
|
|
697
|
+
password: string;
|
|
698
|
+
returnTo?: string;
|
|
699
|
+
};
|
|
700
|
+
SignupRequestDto: {
|
|
701
|
+
/** Format: email */
|
|
702
|
+
email: string;
|
|
703
|
+
password: string;
|
|
704
|
+
};
|
|
705
|
+
SocialProvidersResponseDto: {
|
|
706
|
+
facebook: boolean;
|
|
707
|
+
google: boolean;
|
|
708
|
+
};
|
|
709
|
+
StartJourneyResumeDto: {
|
|
710
|
+
/** @enum {string} */
|
|
711
|
+
actionKey: "USE_REAL_WORKSPACE" | "CONNECT_PROVIDER" | "MANAGE_CONNECTION" | "REFRESH_TARGETS" | "SAVE_DRAFT" | "UPLOAD_MEDIA" | "PUBLISH_CONTENT" | "SCHEDULE_CONTENT" | "SCHEDULE_FROM_COMPOSER" | "READ_REAL_INBOX" | "READ_REAL_ANALYTICS" | "MANAGE_REAL_ADS" | "SAVE_REAL_WORKFLOW" | "ENROLL_AGENT" | "MANAGE_AGENT" | "OPEN_LOCAL_AGENT" | "CREATE_API_CLIENT" | "MANAGE_API_CLIENT" | "EXPORT_REAL_AUDIT" | "READ_REAL_AUDIT" | "REPLAY_REAL_AUDIT_DELIVERIES" | "INVITE_MEMBER" | "MANAGE_MEMBERS" | "APPLY_ENTITLEMENT_POLICY" | "RECONCILE_EFFECT" | "INSPECT_EFFECT" | "CANCEL_OPERATION";
|
|
712
|
+
/** @enum {number} */
|
|
713
|
+
actionVersion: 1;
|
|
714
|
+
intentVersion: number;
|
|
715
|
+
route: string;
|
|
716
|
+
/** @enum {number} */
|
|
717
|
+
schemaVersion: 1;
|
|
718
|
+
tabBinding: string;
|
|
719
|
+
};
|
|
720
|
+
};
|
|
721
|
+
responses: never;
|
|
722
|
+
parameters: never;
|
|
723
|
+
requestBodies: never;
|
|
724
|
+
headers: never;
|
|
725
|
+
pathItems: never;
|
|
726
|
+
}
|
|
727
|
+
export type $defs = Record<string, never>;
|
|
728
|
+
export interface operations {
|
|
729
|
+
OAuthDiscovery_authorizationServer: {
|
|
730
|
+
parameters: {
|
|
731
|
+
query?: never;
|
|
732
|
+
header?: never;
|
|
733
|
+
path?: never;
|
|
734
|
+
cookie?: never;
|
|
735
|
+
};
|
|
736
|
+
requestBody?: never;
|
|
737
|
+
responses: {
|
|
738
|
+
200: {
|
|
739
|
+
headers: {
|
|
740
|
+
[name: string]: unknown;
|
|
741
|
+
};
|
|
742
|
+
content: {
|
|
743
|
+
"application/json": {
|
|
744
|
+
/** Format: uri */
|
|
745
|
+
authorization_endpoint: string;
|
|
746
|
+
authorization_response_iss_parameter_supported?: boolean;
|
|
747
|
+
code_challenge_methods_supported?: string[];
|
|
748
|
+
grant_types_supported: string[];
|
|
749
|
+
/** Format: uri */
|
|
750
|
+
issuer: string;
|
|
751
|
+
/** Format: uri */
|
|
752
|
+
registration_endpoint?: string;
|
|
753
|
+
resource_indicators_supported?: boolean;
|
|
754
|
+
response_types_supported?: string[];
|
|
755
|
+
scopes_supported?: string[];
|
|
756
|
+
/** Format: uri */
|
|
757
|
+
token_endpoint: string;
|
|
758
|
+
token_endpoint_auth_methods_supported?: string[];
|
|
759
|
+
token_endpoint_auth_signing_alg_values_supported?: string[];
|
|
760
|
+
"x-oxchannels-mcp-protocol-revision"?: string;
|
|
761
|
+
/** Format: uri */
|
|
762
|
+
"x-oxchannels-mcp-resource"?: string;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
};
|
|
766
|
+
/** @description Invalid request */
|
|
767
|
+
400: {
|
|
768
|
+
headers: {
|
|
769
|
+
[name: string]: unknown;
|
|
770
|
+
};
|
|
771
|
+
content: {
|
|
772
|
+
"application/json": {
|
|
773
|
+
error: string;
|
|
774
|
+
error_description?: string;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
};
|
|
778
|
+
/** @description Authentication required */
|
|
779
|
+
401: {
|
|
780
|
+
headers: {
|
|
781
|
+
[name: string]: unknown;
|
|
782
|
+
};
|
|
783
|
+
content: {
|
|
784
|
+
"application/json": {
|
|
785
|
+
error: string;
|
|
786
|
+
error_description?: string;
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
/** @description Resource unavailable */
|
|
791
|
+
404: {
|
|
792
|
+
headers: {
|
|
793
|
+
[name: string]: unknown;
|
|
794
|
+
};
|
|
795
|
+
content: {
|
|
796
|
+
"application/json": {
|
|
797
|
+
error: string;
|
|
798
|
+
error_description?: string;
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
/** @description Unexpected server failure */
|
|
803
|
+
500: {
|
|
804
|
+
headers: {
|
|
805
|
+
[name: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
content: {
|
|
808
|
+
"application/json": {
|
|
809
|
+
error: string;
|
|
810
|
+
error_description?: string;
|
|
811
|
+
};
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
OAuthDiscovery_protectedResource: {
|
|
817
|
+
parameters: {
|
|
818
|
+
query?: never;
|
|
819
|
+
header?: never;
|
|
820
|
+
path?: never;
|
|
821
|
+
cookie?: never;
|
|
822
|
+
};
|
|
823
|
+
requestBody?: never;
|
|
824
|
+
responses: {
|
|
825
|
+
200: {
|
|
826
|
+
headers: {
|
|
827
|
+
[name: string]: unknown;
|
|
828
|
+
};
|
|
829
|
+
content: {
|
|
830
|
+
"application/json": {
|
|
831
|
+
authorization_servers: string[];
|
|
832
|
+
bearer_methods_supported?: string[];
|
|
833
|
+
/** Format: uri */
|
|
834
|
+
resource: string;
|
|
835
|
+
/** Format: uri */
|
|
836
|
+
resource_documentation?: string;
|
|
837
|
+
scopes_supported?: string[];
|
|
838
|
+
"x-oxchannels-mcp-protocol-revision"?: string;
|
|
839
|
+
};
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
/** @description Invalid request */
|
|
843
|
+
400: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content: {
|
|
848
|
+
"application/json": {
|
|
849
|
+
error: string;
|
|
850
|
+
error_description?: string;
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
/** @description Authentication required */
|
|
855
|
+
401: {
|
|
856
|
+
headers: {
|
|
857
|
+
[name: string]: unknown;
|
|
858
|
+
};
|
|
859
|
+
content: {
|
|
860
|
+
"application/json": {
|
|
861
|
+
error: string;
|
|
862
|
+
error_description?: string;
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
/** @description Resource unavailable */
|
|
867
|
+
404: {
|
|
868
|
+
headers: {
|
|
869
|
+
[name: string]: unknown;
|
|
870
|
+
};
|
|
871
|
+
content: {
|
|
872
|
+
"application/json": {
|
|
873
|
+
error: string;
|
|
874
|
+
error_description?: string;
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
};
|
|
878
|
+
/** @description Unexpected server failure */
|
|
879
|
+
500: {
|
|
880
|
+
headers: {
|
|
881
|
+
[name: string]: unknown;
|
|
882
|
+
};
|
|
883
|
+
content: {
|
|
884
|
+
"application/json": {
|
|
885
|
+
error: string;
|
|
886
|
+
error_description?: string;
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
OAuthDiscovery_openidConfiguration: {
|
|
893
|
+
parameters: {
|
|
894
|
+
query?: never;
|
|
895
|
+
header?: never;
|
|
896
|
+
path?: never;
|
|
897
|
+
cookie?: never;
|
|
898
|
+
};
|
|
899
|
+
requestBody?: never;
|
|
900
|
+
responses: {
|
|
901
|
+
200: {
|
|
902
|
+
headers: {
|
|
903
|
+
[name: string]: unknown;
|
|
904
|
+
};
|
|
905
|
+
content: {
|
|
906
|
+
"application/json": {
|
|
907
|
+
/** Format: uri */
|
|
908
|
+
authorization_endpoint: string;
|
|
909
|
+
authorization_response_iss_parameter_supported?: boolean;
|
|
910
|
+
code_challenge_methods_supported?: string[];
|
|
911
|
+
grant_types_supported: string[];
|
|
912
|
+
/** Format: uri */
|
|
913
|
+
issuer: string;
|
|
914
|
+
/** Format: uri */
|
|
915
|
+
registration_endpoint?: string;
|
|
916
|
+
resource_indicators_supported?: boolean;
|
|
917
|
+
response_types_supported?: string[];
|
|
918
|
+
scopes_supported?: string[];
|
|
919
|
+
/** Format: uri */
|
|
920
|
+
token_endpoint: string;
|
|
921
|
+
token_endpoint_auth_methods_supported?: string[];
|
|
922
|
+
token_endpoint_auth_signing_alg_values_supported?: string[];
|
|
923
|
+
"x-oxchannels-mcp-protocol-revision"?: string;
|
|
924
|
+
/** Format: uri */
|
|
925
|
+
"x-oxchannels-mcp-resource"?: string;
|
|
926
|
+
};
|
|
927
|
+
};
|
|
928
|
+
};
|
|
929
|
+
/** @description Invalid request */
|
|
930
|
+
400: {
|
|
931
|
+
headers: {
|
|
932
|
+
[name: string]: unknown;
|
|
933
|
+
};
|
|
934
|
+
content: {
|
|
935
|
+
"application/json": {
|
|
936
|
+
error: string;
|
|
937
|
+
error_description?: string;
|
|
938
|
+
};
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
/** @description Authentication required */
|
|
942
|
+
401: {
|
|
943
|
+
headers: {
|
|
944
|
+
[name: string]: unknown;
|
|
945
|
+
};
|
|
946
|
+
content: {
|
|
947
|
+
"application/json": {
|
|
948
|
+
error: string;
|
|
949
|
+
error_description?: string;
|
|
950
|
+
};
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
/** @description Resource unavailable */
|
|
954
|
+
404: {
|
|
955
|
+
headers: {
|
|
956
|
+
[name: string]: unknown;
|
|
957
|
+
};
|
|
958
|
+
content: {
|
|
959
|
+
"application/json": {
|
|
960
|
+
error: string;
|
|
961
|
+
error_description?: string;
|
|
962
|
+
};
|
|
963
|
+
};
|
|
964
|
+
};
|
|
965
|
+
/** @description Unexpected server failure */
|
|
966
|
+
500: {
|
|
967
|
+
headers: {
|
|
968
|
+
[name: string]: unknown;
|
|
969
|
+
};
|
|
970
|
+
content: {
|
|
971
|
+
"application/json": {
|
|
972
|
+
error: string;
|
|
973
|
+
error_description?: string;
|
|
974
|
+
};
|
|
975
|
+
};
|
|
976
|
+
};
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
getLiveness: {
|
|
980
|
+
parameters: {
|
|
981
|
+
query?: never;
|
|
982
|
+
header?: never;
|
|
983
|
+
path?: never;
|
|
984
|
+
cookie?: never;
|
|
985
|
+
};
|
|
986
|
+
requestBody?: never;
|
|
987
|
+
responses: {
|
|
988
|
+
/** @description Process event loop is serving requests. */
|
|
989
|
+
200: {
|
|
990
|
+
headers: {
|
|
991
|
+
[name: string]: unknown;
|
|
992
|
+
};
|
|
993
|
+
content: {
|
|
994
|
+
"application/json": {
|
|
995
|
+
/** @enum {string} */
|
|
996
|
+
status: "live";
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
/** @description Invalid request */
|
|
1001
|
+
400: {
|
|
1002
|
+
headers: {
|
|
1003
|
+
[name: string]: unknown;
|
|
1004
|
+
};
|
|
1005
|
+
content: {
|
|
1006
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1007
|
+
};
|
|
1008
|
+
};
|
|
1009
|
+
/** @description Authentication required */
|
|
1010
|
+
401: {
|
|
1011
|
+
headers: {
|
|
1012
|
+
[name: string]: unknown;
|
|
1013
|
+
};
|
|
1014
|
+
content: {
|
|
1015
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
/** @description Resource unavailable */
|
|
1019
|
+
404: {
|
|
1020
|
+
headers: {
|
|
1021
|
+
[name: string]: unknown;
|
|
1022
|
+
};
|
|
1023
|
+
content: {
|
|
1024
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1025
|
+
};
|
|
1026
|
+
};
|
|
1027
|
+
/** @description Unexpected server failure */
|
|
1028
|
+
500: {
|
|
1029
|
+
headers: {
|
|
1030
|
+
[name: string]: unknown;
|
|
1031
|
+
};
|
|
1032
|
+
content: {
|
|
1033
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
};
|
|
1038
|
+
getReadiness: {
|
|
1039
|
+
parameters: {
|
|
1040
|
+
query?: never;
|
|
1041
|
+
header?: never;
|
|
1042
|
+
path?: never;
|
|
1043
|
+
cookie?: never;
|
|
1044
|
+
};
|
|
1045
|
+
requestBody?: never;
|
|
1046
|
+
responses: {
|
|
1047
|
+
/** @description Successful response */
|
|
1048
|
+
200: {
|
|
1049
|
+
headers: {
|
|
1050
|
+
[name: string]: unknown;
|
|
1051
|
+
};
|
|
1052
|
+
content: {
|
|
1053
|
+
"application/json": {
|
|
1054
|
+
dependencies: {
|
|
1055
|
+
database: {
|
|
1056
|
+
required: boolean;
|
|
1057
|
+
/** @enum {string} */
|
|
1058
|
+
status: "up" | "down" | "optional-down";
|
|
1059
|
+
};
|
|
1060
|
+
objectStore: {
|
|
1061
|
+
required: boolean;
|
|
1062
|
+
/** @enum {string} */
|
|
1063
|
+
status: "up" | "down" | "optional-down";
|
|
1064
|
+
};
|
|
1065
|
+
redis: {
|
|
1066
|
+
required: boolean;
|
|
1067
|
+
/** @enum {string} */
|
|
1068
|
+
status: "up" | "down" | "optional-down";
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
/** @enum {string} */
|
|
1072
|
+
status: "ready" | "not-ready";
|
|
1073
|
+
};
|
|
1074
|
+
};
|
|
1075
|
+
};
|
|
1076
|
+
/** @description Invalid request */
|
|
1077
|
+
400: {
|
|
1078
|
+
headers: {
|
|
1079
|
+
[name: string]: unknown;
|
|
1080
|
+
};
|
|
1081
|
+
content: {
|
|
1082
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
/** @description Authentication required */
|
|
1086
|
+
401: {
|
|
1087
|
+
headers: {
|
|
1088
|
+
[name: string]: unknown;
|
|
1089
|
+
};
|
|
1090
|
+
content: {
|
|
1091
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1092
|
+
};
|
|
1093
|
+
};
|
|
1094
|
+
/** @description Resource unavailable */
|
|
1095
|
+
404: {
|
|
1096
|
+
headers: {
|
|
1097
|
+
[name: string]: unknown;
|
|
1098
|
+
};
|
|
1099
|
+
content: {
|
|
1100
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1101
|
+
};
|
|
1102
|
+
};
|
|
1103
|
+
/** @description Unexpected server failure */
|
|
1104
|
+
500: {
|
|
1105
|
+
headers: {
|
|
1106
|
+
[name: string]: unknown;
|
|
1107
|
+
};
|
|
1108
|
+
content: {
|
|
1109
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
/** @description Required dependency temporarily unavailable */
|
|
1113
|
+
503: {
|
|
1114
|
+
headers: {
|
|
1115
|
+
[name: string]: unknown;
|
|
1116
|
+
};
|
|
1117
|
+
content: {
|
|
1118
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1119
|
+
};
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1122
|
+
};
|
|
1123
|
+
OAuthClientRegistration_admit: {
|
|
1124
|
+
parameters: {
|
|
1125
|
+
query?: never;
|
|
1126
|
+
header?: never;
|
|
1127
|
+
path?: never;
|
|
1128
|
+
cookie?: never;
|
|
1129
|
+
};
|
|
1130
|
+
requestBody: {
|
|
1131
|
+
content: {
|
|
1132
|
+
"application/json": {
|
|
1133
|
+
client_name?: string;
|
|
1134
|
+
/** Format: uri */
|
|
1135
|
+
client_uri: string;
|
|
1136
|
+
grant_types?: string[];
|
|
1137
|
+
redirect_uris?: string[];
|
|
1138
|
+
token_endpoint_auth_method?: string;
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
responses: {
|
|
1143
|
+
200: {
|
|
1144
|
+
headers: {
|
|
1145
|
+
[name: string]: unknown;
|
|
1146
|
+
};
|
|
1147
|
+
content: {
|
|
1148
|
+
"application/json": {
|
|
1149
|
+
/** Format: uri */
|
|
1150
|
+
client_uri?: string;
|
|
1151
|
+
error?: string;
|
|
1152
|
+
error_description?: string;
|
|
1153
|
+
/** @enum {string} */
|
|
1154
|
+
next?: "OWNER_APPROVAL_REQUIRED";
|
|
1155
|
+
/** @enum {string} */
|
|
1156
|
+
status?: "ADMITTED";
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
/** @description Invalid request */
|
|
1161
|
+
400: {
|
|
1162
|
+
headers: {
|
|
1163
|
+
[name: string]: unknown;
|
|
1164
|
+
};
|
|
1165
|
+
content: {
|
|
1166
|
+
"application/json": {
|
|
1167
|
+
error: string;
|
|
1168
|
+
error_description?: string;
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
/** @description Authentication required */
|
|
1173
|
+
401: {
|
|
1174
|
+
headers: {
|
|
1175
|
+
[name: string]: unknown;
|
|
1176
|
+
};
|
|
1177
|
+
content: {
|
|
1178
|
+
"application/json": {
|
|
1179
|
+
error: string;
|
|
1180
|
+
error_description?: string;
|
|
1181
|
+
};
|
|
1182
|
+
};
|
|
1183
|
+
};
|
|
1184
|
+
/** @description Resource unavailable */
|
|
1185
|
+
404: {
|
|
1186
|
+
headers: {
|
|
1187
|
+
[name: string]: unknown;
|
|
1188
|
+
};
|
|
1189
|
+
content: {
|
|
1190
|
+
"application/json": {
|
|
1191
|
+
error: string;
|
|
1192
|
+
error_description?: string;
|
|
1193
|
+
};
|
|
1194
|
+
};
|
|
1195
|
+
};
|
|
1196
|
+
/** @description State or idempotency conflict */
|
|
1197
|
+
409: {
|
|
1198
|
+
headers: {
|
|
1199
|
+
[name: string]: unknown;
|
|
1200
|
+
};
|
|
1201
|
+
content: {
|
|
1202
|
+
"application/json": {
|
|
1203
|
+
error: string;
|
|
1204
|
+
error_description?: string;
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
/** @description Unexpected server failure */
|
|
1209
|
+
500: {
|
|
1210
|
+
headers: {
|
|
1211
|
+
[name: string]: unknown;
|
|
1212
|
+
};
|
|
1213
|
+
content: {
|
|
1214
|
+
"application/json": {
|
|
1215
|
+
error: string;
|
|
1216
|
+
error_description?: string;
|
|
1217
|
+
};
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
};
|
|
1221
|
+
};
|
|
1222
|
+
OAuthToken_issue: {
|
|
1223
|
+
parameters: {
|
|
1224
|
+
query?: never;
|
|
1225
|
+
header?: never;
|
|
1226
|
+
path?: never;
|
|
1227
|
+
cookie?: never;
|
|
1228
|
+
};
|
|
1229
|
+
requestBody: {
|
|
1230
|
+
content: {
|
|
1231
|
+
"application/json": {
|
|
1232
|
+
client_assertion?: string;
|
|
1233
|
+
client_assertion_type?: string;
|
|
1234
|
+
client_id?: string;
|
|
1235
|
+
client_secret?: string;
|
|
1236
|
+
code?: string;
|
|
1237
|
+
code_verifier?: string;
|
|
1238
|
+
/** @enum {string} */
|
|
1239
|
+
grant_type: "authorization_code" | "client_credentials" | "refresh_token";
|
|
1240
|
+
/** Format: uri */
|
|
1241
|
+
redirect_uri?: string;
|
|
1242
|
+
refresh_token?: string;
|
|
1243
|
+
/** Format: uri */
|
|
1244
|
+
resource: string;
|
|
1245
|
+
scope?: string;
|
|
1246
|
+
};
|
|
1247
|
+
};
|
|
1248
|
+
};
|
|
1249
|
+
responses: {
|
|
1250
|
+
200: {
|
|
1251
|
+
headers: {
|
|
1252
|
+
[name: string]: unknown;
|
|
1253
|
+
};
|
|
1254
|
+
content: {
|
|
1255
|
+
"application/json": {
|
|
1256
|
+
access_token: string;
|
|
1257
|
+
expires_in: number;
|
|
1258
|
+
refresh_token?: string;
|
|
1259
|
+
scope: string;
|
|
1260
|
+
/** @enum {string} */
|
|
1261
|
+
token_type: "Bearer";
|
|
1262
|
+
};
|
|
1263
|
+
};
|
|
1264
|
+
};
|
|
1265
|
+
/** @description Invalid request */
|
|
1266
|
+
400: {
|
|
1267
|
+
headers: {
|
|
1268
|
+
[name: string]: unknown;
|
|
1269
|
+
};
|
|
1270
|
+
content: {
|
|
1271
|
+
"application/json": {
|
|
1272
|
+
error: string;
|
|
1273
|
+
error_description?: string;
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
/** @description Authentication required */
|
|
1278
|
+
401: {
|
|
1279
|
+
headers: {
|
|
1280
|
+
[name: string]: unknown;
|
|
1281
|
+
};
|
|
1282
|
+
content: {
|
|
1283
|
+
"application/json": {
|
|
1284
|
+
error: string;
|
|
1285
|
+
error_description?: string;
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
};
|
|
1289
|
+
/** @description Resource unavailable */
|
|
1290
|
+
404: {
|
|
1291
|
+
headers: {
|
|
1292
|
+
[name: string]: unknown;
|
|
1293
|
+
};
|
|
1294
|
+
content: {
|
|
1295
|
+
"application/json": {
|
|
1296
|
+
error: string;
|
|
1297
|
+
error_description?: string;
|
|
1298
|
+
};
|
|
1299
|
+
};
|
|
1300
|
+
};
|
|
1301
|
+
/** @description State or idempotency conflict */
|
|
1302
|
+
409: {
|
|
1303
|
+
headers: {
|
|
1304
|
+
[name: string]: unknown;
|
|
1305
|
+
};
|
|
1306
|
+
content: {
|
|
1307
|
+
"application/json": {
|
|
1308
|
+
error: string;
|
|
1309
|
+
error_description?: string;
|
|
1310
|
+
};
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
/** @description Unexpected server failure */
|
|
1314
|
+
500: {
|
|
1315
|
+
headers: {
|
|
1316
|
+
[name: string]: unknown;
|
|
1317
|
+
};
|
|
1318
|
+
content: {
|
|
1319
|
+
"application/json": {
|
|
1320
|
+
error: string;
|
|
1321
|
+
error_description?: string;
|
|
1322
|
+
};
|
|
1323
|
+
};
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
};
|
|
1327
|
+
LocalAuth_forgotPassword: {
|
|
1328
|
+
parameters: {
|
|
1329
|
+
query?: never;
|
|
1330
|
+
header?: never;
|
|
1331
|
+
path?: never;
|
|
1332
|
+
cookie?: never;
|
|
1333
|
+
};
|
|
1334
|
+
requestBody: {
|
|
1335
|
+
content: {
|
|
1336
|
+
"application/json": components["schemas"]["ForgotPasswordRequestDto"];
|
|
1337
|
+
};
|
|
1338
|
+
};
|
|
1339
|
+
responses: {
|
|
1340
|
+
202: {
|
|
1341
|
+
headers: {
|
|
1342
|
+
[name: string]: unknown;
|
|
1343
|
+
};
|
|
1344
|
+
content: {
|
|
1345
|
+
"application/json": components["schemas"]["CheckEmailResponseDto"];
|
|
1346
|
+
};
|
|
1347
|
+
};
|
|
1348
|
+
/** @description Invalid request */
|
|
1349
|
+
400: {
|
|
1350
|
+
headers: {
|
|
1351
|
+
[name: string]: unknown;
|
|
1352
|
+
};
|
|
1353
|
+
content: {
|
|
1354
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
/** @description Authentication required */
|
|
1358
|
+
401: {
|
|
1359
|
+
headers: {
|
|
1360
|
+
[name: string]: unknown;
|
|
1361
|
+
};
|
|
1362
|
+
content: {
|
|
1363
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1364
|
+
};
|
|
1365
|
+
};
|
|
1366
|
+
/** @description Resource unavailable */
|
|
1367
|
+
404: {
|
|
1368
|
+
headers: {
|
|
1369
|
+
[name: string]: unknown;
|
|
1370
|
+
};
|
|
1371
|
+
content: {
|
|
1372
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
/** @description State or idempotency conflict */
|
|
1376
|
+
409: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1382
|
+
};
|
|
1383
|
+
};
|
|
1384
|
+
/** @description Unexpected server failure */
|
|
1385
|
+
500: {
|
|
1386
|
+
headers: {
|
|
1387
|
+
[name: string]: unknown;
|
|
1388
|
+
};
|
|
1389
|
+
content: {
|
|
1390
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
LocalAuth_resetPassword: {
|
|
1396
|
+
parameters: {
|
|
1397
|
+
query?: never;
|
|
1398
|
+
header?: never;
|
|
1399
|
+
path?: never;
|
|
1400
|
+
cookie?: never;
|
|
1401
|
+
};
|
|
1402
|
+
requestBody: {
|
|
1403
|
+
content: {
|
|
1404
|
+
"application/json": components["schemas"]["ResetPasswordRequestDto"];
|
|
1405
|
+
};
|
|
1406
|
+
};
|
|
1407
|
+
responses: {
|
|
1408
|
+
200: {
|
|
1409
|
+
headers: {
|
|
1410
|
+
[name: string]: unknown;
|
|
1411
|
+
};
|
|
1412
|
+
content: {
|
|
1413
|
+
"application/json": components["schemas"]["PasswordChangedResponseDto"];
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
/** @description Invalid request */
|
|
1417
|
+
400: {
|
|
1418
|
+
headers: {
|
|
1419
|
+
[name: string]: unknown;
|
|
1420
|
+
};
|
|
1421
|
+
content: {
|
|
1422
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1425
|
+
/** @description Authentication required */
|
|
1426
|
+
401: {
|
|
1427
|
+
headers: {
|
|
1428
|
+
[name: string]: unknown;
|
|
1429
|
+
};
|
|
1430
|
+
content: {
|
|
1431
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
/** @description Resource unavailable */
|
|
1435
|
+
404: {
|
|
1436
|
+
headers: {
|
|
1437
|
+
[name: string]: unknown;
|
|
1438
|
+
};
|
|
1439
|
+
content: {
|
|
1440
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
/** @description State or idempotency conflict */
|
|
1444
|
+
409: {
|
|
1445
|
+
headers: {
|
|
1446
|
+
[name: string]: unknown;
|
|
1447
|
+
};
|
|
1448
|
+
content: {
|
|
1449
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1450
|
+
};
|
|
1451
|
+
};
|
|
1452
|
+
/** @description Unexpected server failure */
|
|
1453
|
+
500: {
|
|
1454
|
+
headers: {
|
|
1455
|
+
[name: string]: unknown;
|
|
1456
|
+
};
|
|
1457
|
+
content: {
|
|
1458
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
LocalAuth_signIn: {
|
|
1464
|
+
parameters: {
|
|
1465
|
+
query?: never;
|
|
1466
|
+
header?: never;
|
|
1467
|
+
path?: never;
|
|
1468
|
+
cookie?: never;
|
|
1469
|
+
};
|
|
1470
|
+
requestBody: {
|
|
1471
|
+
content: {
|
|
1472
|
+
"application/json": components["schemas"]["SignInRequestDto"];
|
|
1473
|
+
};
|
|
1474
|
+
};
|
|
1475
|
+
responses: {
|
|
1476
|
+
201: {
|
|
1477
|
+
headers: {
|
|
1478
|
+
[name: string]: unknown;
|
|
1479
|
+
};
|
|
1480
|
+
content: {
|
|
1481
|
+
"application/json": components["schemas"]["SignedInResponseDto"];
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
/** @description Invalid request */
|
|
1485
|
+
400: {
|
|
1486
|
+
headers: {
|
|
1487
|
+
[name: string]: unknown;
|
|
1488
|
+
};
|
|
1489
|
+
content: {
|
|
1490
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1491
|
+
};
|
|
1492
|
+
};
|
|
1493
|
+
/** @description Authentication required */
|
|
1494
|
+
401: {
|
|
1495
|
+
headers: {
|
|
1496
|
+
[name: string]: unknown;
|
|
1497
|
+
};
|
|
1498
|
+
content: {
|
|
1499
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1500
|
+
};
|
|
1501
|
+
};
|
|
1502
|
+
/** @description Resource unavailable */
|
|
1503
|
+
404: {
|
|
1504
|
+
headers: {
|
|
1505
|
+
[name: string]: unknown;
|
|
1506
|
+
};
|
|
1507
|
+
content: {
|
|
1508
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
/** @description State or idempotency conflict */
|
|
1512
|
+
409: {
|
|
1513
|
+
headers: {
|
|
1514
|
+
[name: string]: unknown;
|
|
1515
|
+
};
|
|
1516
|
+
content: {
|
|
1517
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1518
|
+
};
|
|
1519
|
+
};
|
|
1520
|
+
/** @description Unexpected server failure */
|
|
1521
|
+
500: {
|
|
1522
|
+
headers: {
|
|
1523
|
+
[name: string]: unknown;
|
|
1524
|
+
};
|
|
1525
|
+
content: {
|
|
1526
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1527
|
+
};
|
|
1528
|
+
};
|
|
1529
|
+
};
|
|
1530
|
+
};
|
|
1531
|
+
LocalAuth_signup: {
|
|
1532
|
+
parameters: {
|
|
1533
|
+
query?: never;
|
|
1534
|
+
header?: never;
|
|
1535
|
+
path?: never;
|
|
1536
|
+
cookie?: never;
|
|
1537
|
+
};
|
|
1538
|
+
requestBody: {
|
|
1539
|
+
content: {
|
|
1540
|
+
"application/json": components["schemas"]["SignupRequestDto"];
|
|
1541
|
+
};
|
|
1542
|
+
};
|
|
1543
|
+
responses: {
|
|
1544
|
+
202: {
|
|
1545
|
+
headers: {
|
|
1546
|
+
[name: string]: unknown;
|
|
1547
|
+
};
|
|
1548
|
+
content: {
|
|
1549
|
+
"application/json": components["schemas"]["CheckEmailResponseDto"];
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
/** @description Invalid request */
|
|
1553
|
+
400: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
/** @description Authentication required */
|
|
1562
|
+
401: {
|
|
1563
|
+
headers: {
|
|
1564
|
+
[name: string]: unknown;
|
|
1565
|
+
};
|
|
1566
|
+
content: {
|
|
1567
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
/** @description Resource unavailable */
|
|
1571
|
+
404: {
|
|
1572
|
+
headers: {
|
|
1573
|
+
[name: string]: unknown;
|
|
1574
|
+
};
|
|
1575
|
+
content: {
|
|
1576
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1579
|
+
/** @description State or idempotency conflict */
|
|
1580
|
+
409: {
|
|
1581
|
+
headers: {
|
|
1582
|
+
[name: string]: unknown;
|
|
1583
|
+
};
|
|
1584
|
+
content: {
|
|
1585
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1586
|
+
};
|
|
1587
|
+
};
|
|
1588
|
+
/** @description Unexpected server failure */
|
|
1589
|
+
500: {
|
|
1590
|
+
headers: {
|
|
1591
|
+
[name: string]: unknown;
|
|
1592
|
+
};
|
|
1593
|
+
content: {
|
|
1594
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1595
|
+
};
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
LocalAuth_resend: {
|
|
1600
|
+
parameters: {
|
|
1601
|
+
query?: never;
|
|
1602
|
+
header?: never;
|
|
1603
|
+
path?: never;
|
|
1604
|
+
cookie?: never;
|
|
1605
|
+
};
|
|
1606
|
+
requestBody: {
|
|
1607
|
+
content: {
|
|
1608
|
+
"application/json": components["schemas"]["ResendVerificationRequestDto"];
|
|
1609
|
+
};
|
|
1610
|
+
};
|
|
1611
|
+
responses: {
|
|
1612
|
+
202: {
|
|
1613
|
+
headers: {
|
|
1614
|
+
[name: string]: unknown;
|
|
1615
|
+
};
|
|
1616
|
+
content: {
|
|
1617
|
+
"application/json": components["schemas"]["CheckEmailResponseDto"];
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
/** @description Invalid request */
|
|
1621
|
+
400: {
|
|
1622
|
+
headers: {
|
|
1623
|
+
[name: string]: unknown;
|
|
1624
|
+
};
|
|
1625
|
+
content: {
|
|
1626
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1627
|
+
};
|
|
1628
|
+
};
|
|
1629
|
+
/** @description Authentication required */
|
|
1630
|
+
401: {
|
|
1631
|
+
headers: {
|
|
1632
|
+
[name: string]: unknown;
|
|
1633
|
+
};
|
|
1634
|
+
content: {
|
|
1635
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
/** @description Resource unavailable */
|
|
1639
|
+
404: {
|
|
1640
|
+
headers: {
|
|
1641
|
+
[name: string]: unknown;
|
|
1642
|
+
};
|
|
1643
|
+
content: {
|
|
1644
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1645
|
+
};
|
|
1646
|
+
};
|
|
1647
|
+
/** @description State or idempotency conflict */
|
|
1648
|
+
409: {
|
|
1649
|
+
headers: {
|
|
1650
|
+
[name: string]: unknown;
|
|
1651
|
+
};
|
|
1652
|
+
content: {
|
|
1653
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
/** @description Unexpected server failure */
|
|
1657
|
+
500: {
|
|
1658
|
+
headers: {
|
|
1659
|
+
[name: string]: unknown;
|
|
1660
|
+
};
|
|
1661
|
+
content: {
|
|
1662
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1663
|
+
};
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
};
|
|
1667
|
+
Identity_startJourneyResume: {
|
|
1668
|
+
parameters: {
|
|
1669
|
+
query?: {
|
|
1670
|
+
mode?: "login" | "register";
|
|
1671
|
+
};
|
|
1672
|
+
header?: never;
|
|
1673
|
+
path?: never;
|
|
1674
|
+
cookie?: never;
|
|
1675
|
+
};
|
|
1676
|
+
requestBody: {
|
|
1677
|
+
content: {
|
|
1678
|
+
"application/json": components["schemas"]["StartJourneyResumeDto"];
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1681
|
+
responses: {
|
|
1682
|
+
/** @description Successful response */
|
|
1683
|
+
201: {
|
|
1684
|
+
headers: {
|
|
1685
|
+
[name: string]: unknown;
|
|
1686
|
+
};
|
|
1687
|
+
content: {
|
|
1688
|
+
"application/json": {
|
|
1689
|
+
/** Format: uri */
|
|
1690
|
+
authorizationUrl: string;
|
|
1691
|
+
correlation: string;
|
|
1692
|
+
/** Format: date-time */
|
|
1693
|
+
expiresAt: string;
|
|
1694
|
+
};
|
|
1695
|
+
};
|
|
1696
|
+
};
|
|
1697
|
+
/** @description Invalid request */
|
|
1698
|
+
400: {
|
|
1699
|
+
headers: {
|
|
1700
|
+
[name: string]: unknown;
|
|
1701
|
+
};
|
|
1702
|
+
content: {
|
|
1703
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1704
|
+
};
|
|
1705
|
+
};
|
|
1706
|
+
/** @description Authentication required */
|
|
1707
|
+
401: {
|
|
1708
|
+
headers: {
|
|
1709
|
+
[name: string]: unknown;
|
|
1710
|
+
};
|
|
1711
|
+
content: {
|
|
1712
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1713
|
+
};
|
|
1714
|
+
};
|
|
1715
|
+
/** @description Resource unavailable */
|
|
1716
|
+
404: {
|
|
1717
|
+
headers: {
|
|
1718
|
+
[name: string]: unknown;
|
|
1719
|
+
};
|
|
1720
|
+
content: {
|
|
1721
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1722
|
+
};
|
|
1723
|
+
};
|
|
1724
|
+
/** @description State or idempotency conflict */
|
|
1725
|
+
409: {
|
|
1726
|
+
headers: {
|
|
1727
|
+
[name: string]: unknown;
|
|
1728
|
+
};
|
|
1729
|
+
content: {
|
|
1730
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2Conflict"] | components["schemas"]["ErrorEnvelopeV2IdempotencyConflict"];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
/** @description Unexpected server failure */
|
|
1734
|
+
500: {
|
|
1735
|
+
headers: {
|
|
1736
|
+
[name: string]: unknown;
|
|
1737
|
+
};
|
|
1738
|
+
content: {
|
|
1739
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1740
|
+
};
|
|
1741
|
+
};
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
LocalAuth_providers: {
|
|
1745
|
+
parameters: {
|
|
1746
|
+
query?: never;
|
|
1747
|
+
header?: never;
|
|
1748
|
+
path?: never;
|
|
1749
|
+
cookie?: never;
|
|
1750
|
+
};
|
|
1751
|
+
requestBody?: never;
|
|
1752
|
+
responses: {
|
|
1753
|
+
200: {
|
|
1754
|
+
headers: {
|
|
1755
|
+
[name: string]: unknown;
|
|
1756
|
+
};
|
|
1757
|
+
content: {
|
|
1758
|
+
"application/json": components["schemas"]["SocialProvidersResponseDto"];
|
|
1759
|
+
};
|
|
1760
|
+
};
|
|
1761
|
+
/** @description Invalid request */
|
|
1762
|
+
400: {
|
|
1763
|
+
headers: {
|
|
1764
|
+
[name: string]: unknown;
|
|
1765
|
+
};
|
|
1766
|
+
content: {
|
|
1767
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
/** @description Authentication required */
|
|
1771
|
+
401: {
|
|
1772
|
+
headers: {
|
|
1773
|
+
[name: string]: unknown;
|
|
1774
|
+
};
|
|
1775
|
+
content: {
|
|
1776
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2AuthenticationRequired"];
|
|
1777
|
+
};
|
|
1778
|
+
};
|
|
1779
|
+
/** @description Resource unavailable */
|
|
1780
|
+
404: {
|
|
1781
|
+
headers: {
|
|
1782
|
+
[name: string]: unknown;
|
|
1783
|
+
};
|
|
1784
|
+
content: {
|
|
1785
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
/** @description Unexpected server failure */
|
|
1789
|
+
500: {
|
|
1790
|
+
headers: {
|
|
1791
|
+
[name: string]: unknown;
|
|
1792
|
+
};
|
|
1793
|
+
content: {
|
|
1794
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
1795
|
+
};
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
};
|
|
1799
|
+
PublicCatalog_list: {
|
|
1800
|
+
parameters: {
|
|
1801
|
+
query?: never;
|
|
1802
|
+
header?: {
|
|
1803
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
1804
|
+
"If-None-Match"?: string;
|
|
1805
|
+
};
|
|
1806
|
+
path?: never;
|
|
1807
|
+
cookie?: never;
|
|
1808
|
+
};
|
|
1809
|
+
requestBody?: never;
|
|
1810
|
+
responses: {
|
|
1811
|
+
/** @description Versioned public channel catalog. */
|
|
1812
|
+
200: {
|
|
1813
|
+
headers: {
|
|
1814
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
1815
|
+
"Cache-Control": string;
|
|
1816
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
1817
|
+
ETag: string;
|
|
1818
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
1819
|
+
Vary: string;
|
|
1820
|
+
[name: string]: unknown;
|
|
1821
|
+
};
|
|
1822
|
+
content: {
|
|
1823
|
+
"application/json": {
|
|
1824
|
+
/** @enum {string} */
|
|
1825
|
+
catalogVersion: "1.0.0";
|
|
1826
|
+
channelCatalog: {
|
|
1827
|
+
/** @enum {string} */
|
|
1828
|
+
catalogVersion: "2.0.0";
|
|
1829
|
+
/** @enum {string} */
|
|
1830
|
+
schemaVersion: "2.0.0";
|
|
1831
|
+
sourceDigest: string;
|
|
1832
|
+
};
|
|
1833
|
+
fixtures: [
|
|
1834
|
+
{
|
|
1835
|
+
data: {
|
|
1836
|
+
activity: [
|
|
1837
|
+
{
|
|
1838
|
+
/** @enum {string} */
|
|
1839
|
+
id: "synthetic-overview-activity-1";
|
|
1840
|
+
label: string;
|
|
1841
|
+
/** @enum {string} */
|
|
1842
|
+
status: "scheduled" | "published";
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
/** @enum {string} */
|
|
1846
|
+
id: "synthetic-overview-activity-2";
|
|
1847
|
+
label: string;
|
|
1848
|
+
/** @enum {string} */
|
|
1849
|
+
status: "scheduled" | "published";
|
|
1850
|
+
}
|
|
1851
|
+
];
|
|
1852
|
+
headline: string;
|
|
1853
|
+
metrics: [
|
|
1854
|
+
{
|
|
1855
|
+
/** @enum {string} */
|
|
1856
|
+
key: "scheduled";
|
|
1857
|
+
label: string;
|
|
1858
|
+
value: number;
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
/** @enum {string} */
|
|
1862
|
+
key: "published";
|
|
1863
|
+
label: string;
|
|
1864
|
+
value: number;
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
/** @enum {string} */
|
|
1868
|
+
key: "engagements";
|
|
1869
|
+
label: string;
|
|
1870
|
+
value: number;
|
|
1871
|
+
}
|
|
1872
|
+
];
|
|
1873
|
+
};
|
|
1874
|
+
/** @enum {string} */
|
|
1875
|
+
effectMode: "NONE";
|
|
1876
|
+
/** @enum {string} */
|
|
1877
|
+
fixtureId: "synthetic-overview-v1";
|
|
1878
|
+
/** @enum {string} */
|
|
1879
|
+
fixtureVersion: "1.0.0";
|
|
1880
|
+
/** Format: date-time */
|
|
1881
|
+
observedAt: string;
|
|
1882
|
+
/** @enum {string} */
|
|
1883
|
+
schemaVersion: "1.0.0";
|
|
1884
|
+
/** @enum {string} */
|
|
1885
|
+
surface: "overview";
|
|
1886
|
+
/** @enum {boolean} */
|
|
1887
|
+
synthetic: true;
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
data: {
|
|
1891
|
+
items: [
|
|
1892
|
+
{
|
|
1893
|
+
/** @enum {string} */
|
|
1894
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
1895
|
+
/** @enum {string} */
|
|
1896
|
+
id: "synthetic-calendar-item-1";
|
|
1897
|
+
/** Format: date-time */
|
|
1898
|
+
startsAt: string;
|
|
1899
|
+
/** @enum {string} */
|
|
1900
|
+
status: "draft" | "scheduled";
|
|
1901
|
+
title: string;
|
|
1902
|
+
},
|
|
1903
|
+
{
|
|
1904
|
+
/** @enum {string} */
|
|
1905
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
1906
|
+
/** @enum {string} */
|
|
1907
|
+
id: "synthetic-calendar-item-2";
|
|
1908
|
+
/** Format: date-time */
|
|
1909
|
+
startsAt: string;
|
|
1910
|
+
/** @enum {string} */
|
|
1911
|
+
status: "draft" | "scheduled";
|
|
1912
|
+
title: string;
|
|
1913
|
+
}
|
|
1914
|
+
];
|
|
1915
|
+
/** @enum {string} */
|
|
1916
|
+
timeZone: "UTC";
|
|
1917
|
+
};
|
|
1918
|
+
/** @enum {string} */
|
|
1919
|
+
effectMode: "NONE";
|
|
1920
|
+
/** @enum {string} */
|
|
1921
|
+
fixtureId: "synthetic-calendar-v1";
|
|
1922
|
+
/** @enum {string} */
|
|
1923
|
+
fixtureVersion: "1.0.0";
|
|
1924
|
+
/** Format: date-time */
|
|
1925
|
+
observedAt: string;
|
|
1926
|
+
/** @enum {string} */
|
|
1927
|
+
schemaVersion: "1.0.0";
|
|
1928
|
+
/** @enum {string} */
|
|
1929
|
+
surface: "calendar";
|
|
1930
|
+
/** @enum {boolean} */
|
|
1931
|
+
synthetic: true;
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
data: {
|
|
1935
|
+
conversations: [
|
|
1936
|
+
{
|
|
1937
|
+
/** @enum {string} */
|
|
1938
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
1939
|
+
displayName: string;
|
|
1940
|
+
/** @enum {string} */
|
|
1941
|
+
id: "synthetic-inbox-conversation-1";
|
|
1942
|
+
preview: string;
|
|
1943
|
+
unread: boolean;
|
|
1944
|
+
},
|
|
1945
|
+
{
|
|
1946
|
+
/** @enum {string} */
|
|
1947
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
1948
|
+
displayName: string;
|
|
1949
|
+
/** @enum {string} */
|
|
1950
|
+
id: "synthetic-inbox-conversation-2";
|
|
1951
|
+
preview: string;
|
|
1952
|
+
unread: boolean;
|
|
1953
|
+
}
|
|
1954
|
+
];
|
|
1955
|
+
};
|
|
1956
|
+
/** @enum {string} */
|
|
1957
|
+
effectMode: "NONE";
|
|
1958
|
+
/** @enum {string} */
|
|
1959
|
+
fixtureId: "synthetic-inbox-v1";
|
|
1960
|
+
/** @enum {string} */
|
|
1961
|
+
fixtureVersion: "1.0.0";
|
|
1962
|
+
/** Format: date-time */
|
|
1963
|
+
observedAt: string;
|
|
1964
|
+
/** @enum {string} */
|
|
1965
|
+
schemaVersion: "1.0.0";
|
|
1966
|
+
/** @enum {string} */
|
|
1967
|
+
surface: "inbox";
|
|
1968
|
+
/** @enum {boolean} */
|
|
1969
|
+
synthetic: true;
|
|
1970
|
+
},
|
|
1971
|
+
{
|
|
1972
|
+
data: {
|
|
1973
|
+
points: [
|
|
1974
|
+
{
|
|
1975
|
+
/**
|
|
1976
|
+
* Format: date
|
|
1977
|
+
* @enum {string}
|
|
1978
|
+
*/
|
|
1979
|
+
date: "2026-07-15";
|
|
1980
|
+
engagements: number;
|
|
1981
|
+
impressions: number;
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
/**
|
|
1985
|
+
* Format: date
|
|
1986
|
+
* @enum {string}
|
|
1987
|
+
*/
|
|
1988
|
+
date: "2026-07-16";
|
|
1989
|
+
engagements: number;
|
|
1990
|
+
impressions: number;
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
/**
|
|
1994
|
+
* Format: date
|
|
1995
|
+
* @enum {string}
|
|
1996
|
+
*/
|
|
1997
|
+
date: "2026-07-17";
|
|
1998
|
+
engagements: number;
|
|
1999
|
+
impressions: number;
|
|
2000
|
+
},
|
|
2001
|
+
{
|
|
2002
|
+
/**
|
|
2003
|
+
* Format: date
|
|
2004
|
+
* @enum {string}
|
|
2005
|
+
*/
|
|
2006
|
+
date: "2026-07-18";
|
|
2007
|
+
engagements: number;
|
|
2008
|
+
impressions: number;
|
|
2009
|
+
},
|
|
2010
|
+
{
|
|
2011
|
+
/**
|
|
2012
|
+
* Format: date
|
|
2013
|
+
* @enum {string}
|
|
2014
|
+
*/
|
|
2015
|
+
date: "2026-07-19";
|
|
2016
|
+
engagements: number;
|
|
2017
|
+
impressions: number;
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
/**
|
|
2021
|
+
* Format: date
|
|
2022
|
+
* @enum {string}
|
|
2023
|
+
*/
|
|
2024
|
+
date: "2026-07-20";
|
|
2025
|
+
engagements: number;
|
|
2026
|
+
impressions: number;
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
/**
|
|
2030
|
+
* Format: date
|
|
2031
|
+
* @enum {string}
|
|
2032
|
+
*/
|
|
2033
|
+
date: "2026-07-21";
|
|
2034
|
+
engagements: number;
|
|
2035
|
+
impressions: number;
|
|
2036
|
+
}
|
|
2037
|
+
];
|
|
2038
|
+
/** @enum {string} */
|
|
2039
|
+
range: "LAST_7_DAYS";
|
|
2040
|
+
};
|
|
2041
|
+
/** @enum {string} */
|
|
2042
|
+
effectMode: "NONE";
|
|
2043
|
+
/** @enum {string} */
|
|
2044
|
+
fixtureId: "synthetic-analytics-v1";
|
|
2045
|
+
/** @enum {string} */
|
|
2046
|
+
fixtureVersion: "1.0.0";
|
|
2047
|
+
/** Format: date-time */
|
|
2048
|
+
observedAt: string;
|
|
2049
|
+
/** @enum {string} */
|
|
2050
|
+
schemaVersion: "1.0.0";
|
|
2051
|
+
/** @enum {string} */
|
|
2052
|
+
surface: "analytics";
|
|
2053
|
+
/** @enum {boolean} */
|
|
2054
|
+
synthetic: true;
|
|
2055
|
+
},
|
|
2056
|
+
{
|
|
2057
|
+
data: {
|
|
2058
|
+
campaigns: [
|
|
2059
|
+
{
|
|
2060
|
+
budgetMinor: string;
|
|
2061
|
+
/** @enum {string} */
|
|
2062
|
+
id: "synthetic-ads-campaign-1";
|
|
2063
|
+
name: string;
|
|
2064
|
+
projectedReach: number;
|
|
2065
|
+
/** @enum {string} */
|
|
2066
|
+
status: "draft" | "simulated";
|
|
2067
|
+
},
|
|
2068
|
+
{
|
|
2069
|
+
budgetMinor: string;
|
|
2070
|
+
/** @enum {string} */
|
|
2071
|
+
id: "synthetic-ads-campaign-2";
|
|
2072
|
+
name: string;
|
|
2073
|
+
projectedReach: number;
|
|
2074
|
+
/** @enum {string} */
|
|
2075
|
+
status: "draft" | "simulated";
|
|
2076
|
+
}
|
|
2077
|
+
];
|
|
2078
|
+
/** @enum {string} */
|
|
2079
|
+
currency: "USD";
|
|
2080
|
+
};
|
|
2081
|
+
/** @enum {string} */
|
|
2082
|
+
effectMode: "SIMULATION";
|
|
2083
|
+
/** @enum {string} */
|
|
2084
|
+
fixtureId: "synthetic-ads-v1";
|
|
2085
|
+
/** @enum {string} */
|
|
2086
|
+
fixtureVersion: "1.0.0";
|
|
2087
|
+
/** Format: date-time */
|
|
2088
|
+
observedAt: string;
|
|
2089
|
+
/** @enum {string} */
|
|
2090
|
+
schemaVersion: "1.0.0";
|
|
2091
|
+
/** @enum {string} */
|
|
2092
|
+
surface: "ads";
|
|
2093
|
+
/** @enum {boolean} */
|
|
2094
|
+
synthetic: true;
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
data: {
|
|
2098
|
+
workflows: [
|
|
2099
|
+
{
|
|
2100
|
+
/** @enum {string} */
|
|
2101
|
+
id: "synthetic-workflow-1";
|
|
2102
|
+
name: string;
|
|
2103
|
+
/** @enum {string} */
|
|
2104
|
+
status: "draft" | "simulated";
|
|
2105
|
+
steps: string[];
|
|
2106
|
+
trigger: string;
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
/** @enum {string} */
|
|
2110
|
+
id: "synthetic-workflow-2";
|
|
2111
|
+
name: string;
|
|
2112
|
+
/** @enum {string} */
|
|
2113
|
+
status: "draft" | "simulated";
|
|
2114
|
+
steps: string[];
|
|
2115
|
+
trigger: string;
|
|
2116
|
+
}
|
|
2117
|
+
];
|
|
2118
|
+
};
|
|
2119
|
+
/** @enum {string} */
|
|
2120
|
+
effectMode: "SIMULATION";
|
|
2121
|
+
/** @enum {string} */
|
|
2122
|
+
fixtureId: "synthetic-workflows-v1";
|
|
2123
|
+
/** @enum {string} */
|
|
2124
|
+
fixtureVersion: "1.0.0";
|
|
2125
|
+
/** Format: date-time */
|
|
2126
|
+
observedAt: string;
|
|
2127
|
+
/** @enum {string} */
|
|
2128
|
+
schemaVersion: "1.0.0";
|
|
2129
|
+
/** @enum {string} */
|
|
2130
|
+
surface: "workflows";
|
|
2131
|
+
/** @enum {boolean} */
|
|
2132
|
+
synthetic: true;
|
|
2133
|
+
}
|
|
2134
|
+
];
|
|
2135
|
+
pricing: {
|
|
2136
|
+
/** @enum {string} */
|
|
2137
|
+
accountBaseAmountMicros: "0";
|
|
2138
|
+
/** @enum {string} */
|
|
2139
|
+
currency: "USD";
|
|
2140
|
+
/**
|
|
2141
|
+
* Format: date
|
|
2142
|
+
* @enum {string}
|
|
2143
|
+
*/
|
|
2144
|
+
effectiveFrom: "2026-07-21";
|
|
2145
|
+
/** @enum {integer} */
|
|
2146
|
+
minorUnitExponent: 2;
|
|
2147
|
+
/** @enum {string} */
|
|
2148
|
+
plan: "FREE";
|
|
2149
|
+
/** @enum {string} */
|
|
2150
|
+
pricingModel: "GRADUATED";
|
|
2151
|
+
/** @enum {string} */
|
|
2152
|
+
proration: "REMAINING_FIXED_PERIOD";
|
|
2153
|
+
providerPassThrough: {
|
|
2154
|
+
/** @enum {string} */
|
|
2155
|
+
currencyPolicy: "SAME_CURRENCY_ONLY";
|
|
2156
|
+
/** @enum {boolean} */
|
|
2157
|
+
fxApplied: false;
|
|
2158
|
+
/** @enum {boolean} */
|
|
2159
|
+
includedInOxchannelsFee: false;
|
|
2160
|
+
/** @enum {string} */
|
|
2161
|
+
mode: "CALLER_SUPPLIED_DYNAMIC";
|
|
2162
|
+
};
|
|
2163
|
+
/** @enum {string} */
|
|
2164
|
+
rounding: "HALF_UP_AGGREGATE";
|
|
2165
|
+
/** @enum {string} */
|
|
2166
|
+
schemaVersion: "1.0.0";
|
|
2167
|
+
tiers: [
|
|
2168
|
+
{
|
|
2169
|
+
/** @enum {string} */
|
|
2170
|
+
flatAmountMicros: "0";
|
|
2171
|
+
/** @enum {string} */
|
|
2172
|
+
fromInclusive: "1";
|
|
2173
|
+
/** @enum {string} */
|
|
2174
|
+
unitAmountMicros: "0";
|
|
2175
|
+
/** @enum {string} */
|
|
2176
|
+
upToInclusive: "8000";
|
|
2177
|
+
},
|
|
2178
|
+
{
|
|
2179
|
+
/** @enum {string} */
|
|
2180
|
+
flatAmountMicros: "0";
|
|
2181
|
+
/** @enum {string} */
|
|
2182
|
+
fromInclusive: "8001";
|
|
2183
|
+
/** @enum {string} */
|
|
2184
|
+
unitAmountMicros: "0";
|
|
2185
|
+
/** @enum {string} */
|
|
2186
|
+
upToInclusive: "10000";
|
|
2187
|
+
}
|
|
2188
|
+
];
|
|
2189
|
+
/** @enum {string} */
|
|
2190
|
+
usageDimension: "API_CALL";
|
|
2191
|
+
usageThresholds: {
|
|
2192
|
+
/** @enum {string} */
|
|
2193
|
+
hardLimit: "10000";
|
|
2194
|
+
/** @enum {string} */
|
|
2195
|
+
softLimit: "8000";
|
|
2196
|
+
};
|
|
2197
|
+
/** @enum {string} */
|
|
2198
|
+
version: "1.0.0";
|
|
2199
|
+
};
|
|
2200
|
+
providers: [
|
|
2201
|
+
{
|
|
2202
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2203
|
+
capabilities: {
|
|
2204
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2205
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2206
|
+
publishVariants: string[];
|
|
2207
|
+
};
|
|
2208
|
+
displayName: string;
|
|
2209
|
+
/** @enum {string} */
|
|
2210
|
+
key: "bluesky";
|
|
2211
|
+
limits: {
|
|
2212
|
+
allowedMimeTypes: string[];
|
|
2213
|
+
/** @enum {string} */
|
|
2214
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2215
|
+
maxBodyLength: number;
|
|
2216
|
+
maxMediaBytes: number;
|
|
2217
|
+
maxMediaItems: number;
|
|
2218
|
+
};
|
|
2219
|
+
/** @enum {string} */
|
|
2220
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2221
|
+
targetTypes: string[];
|
|
2222
|
+
validation: {
|
|
2223
|
+
/**
|
|
2224
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2225
|
+
* @enum {string}
|
|
2226
|
+
*/
|
|
2227
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2228
|
+
/** @enum {string} */
|
|
2229
|
+
operation: "publishing.createPost";
|
|
2230
|
+
};
|
|
2231
|
+
},
|
|
2232
|
+
{
|
|
2233
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2234
|
+
capabilities: {
|
|
2235
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2236
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2237
|
+
publishVariants: string[];
|
|
2238
|
+
};
|
|
2239
|
+
displayName: string;
|
|
2240
|
+
/** @enum {string} */
|
|
2241
|
+
key: "facebook";
|
|
2242
|
+
limits: {
|
|
2243
|
+
allowedMimeTypes: string[];
|
|
2244
|
+
/** @enum {string} */
|
|
2245
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2246
|
+
maxBodyLength: number;
|
|
2247
|
+
maxMediaBytes: number;
|
|
2248
|
+
maxMediaItems: number;
|
|
2249
|
+
};
|
|
2250
|
+
/** @enum {string} */
|
|
2251
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2252
|
+
targetTypes: string[];
|
|
2253
|
+
validation: {
|
|
2254
|
+
/**
|
|
2255
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2256
|
+
* @enum {string}
|
|
2257
|
+
*/
|
|
2258
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2259
|
+
/** @enum {string} */
|
|
2260
|
+
operation: "publishing.createPost";
|
|
2261
|
+
};
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2265
|
+
capabilities: {
|
|
2266
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2267
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2268
|
+
publishVariants: string[];
|
|
2269
|
+
};
|
|
2270
|
+
displayName: string;
|
|
2271
|
+
/** @enum {string} */
|
|
2272
|
+
key: "instagram";
|
|
2273
|
+
limits: {
|
|
2274
|
+
allowedMimeTypes: string[];
|
|
2275
|
+
/** @enum {string} */
|
|
2276
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2277
|
+
maxBodyLength: number;
|
|
2278
|
+
maxMediaBytes: number;
|
|
2279
|
+
maxMediaItems: number;
|
|
2280
|
+
};
|
|
2281
|
+
/** @enum {string} */
|
|
2282
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2283
|
+
targetTypes: string[];
|
|
2284
|
+
validation: {
|
|
2285
|
+
/**
|
|
2286
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2287
|
+
* @enum {string}
|
|
2288
|
+
*/
|
|
2289
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2290
|
+
/** @enum {string} */
|
|
2291
|
+
operation: "publishing.createPost";
|
|
2292
|
+
};
|
|
2293
|
+
},
|
|
2294
|
+
{
|
|
2295
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2296
|
+
capabilities: {
|
|
2297
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2298
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2299
|
+
publishVariants: string[];
|
|
2300
|
+
};
|
|
2301
|
+
displayName: string;
|
|
2302
|
+
/** @enum {string} */
|
|
2303
|
+
key: "linkedin";
|
|
2304
|
+
limits: {
|
|
2305
|
+
allowedMimeTypes: string[];
|
|
2306
|
+
/** @enum {string} */
|
|
2307
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2308
|
+
maxBodyLength: number;
|
|
2309
|
+
maxMediaBytes: number;
|
|
2310
|
+
maxMediaItems: number;
|
|
2311
|
+
};
|
|
2312
|
+
/** @enum {string} */
|
|
2313
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2314
|
+
targetTypes: string[];
|
|
2315
|
+
validation: {
|
|
2316
|
+
/**
|
|
2317
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2318
|
+
* @enum {string}
|
|
2319
|
+
*/
|
|
2320
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2321
|
+
/** @enum {string} */
|
|
2322
|
+
operation: "publishing.createPost";
|
|
2323
|
+
};
|
|
2324
|
+
},
|
|
2325
|
+
{
|
|
2326
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2327
|
+
capabilities: {
|
|
2328
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2329
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2330
|
+
publishVariants: string[];
|
|
2331
|
+
};
|
|
2332
|
+
displayName: string;
|
|
2333
|
+
/** @enum {string} */
|
|
2334
|
+
key: "mastodon";
|
|
2335
|
+
limits: {
|
|
2336
|
+
allowedMimeTypes: string[];
|
|
2337
|
+
/** @enum {string} */
|
|
2338
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2339
|
+
maxBodyLength: number;
|
|
2340
|
+
maxMediaBytes: number;
|
|
2341
|
+
maxMediaItems: number;
|
|
2342
|
+
};
|
|
2343
|
+
/** @enum {string} */
|
|
2344
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2345
|
+
targetTypes: string[];
|
|
2346
|
+
validation: {
|
|
2347
|
+
/**
|
|
2348
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2349
|
+
* @enum {string}
|
|
2350
|
+
*/
|
|
2351
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2352
|
+
/** @enum {string} */
|
|
2353
|
+
operation: "publishing.createPost";
|
|
2354
|
+
};
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2358
|
+
capabilities: {
|
|
2359
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2360
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2361
|
+
publishVariants: string[];
|
|
2362
|
+
};
|
|
2363
|
+
displayName: string;
|
|
2364
|
+
/** @enum {string} */
|
|
2365
|
+
key: "pinterest";
|
|
2366
|
+
limits: {
|
|
2367
|
+
allowedMimeTypes: string[];
|
|
2368
|
+
/** @enum {string} */
|
|
2369
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2370
|
+
maxBodyLength: number;
|
|
2371
|
+
maxMediaBytes: number;
|
|
2372
|
+
maxMediaItems: number;
|
|
2373
|
+
};
|
|
2374
|
+
/** @enum {string} */
|
|
2375
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2376
|
+
targetTypes: string[];
|
|
2377
|
+
validation: {
|
|
2378
|
+
/**
|
|
2379
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2380
|
+
* @enum {string}
|
|
2381
|
+
*/
|
|
2382
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2383
|
+
/** @enum {string} */
|
|
2384
|
+
operation: "publishing.createPost";
|
|
2385
|
+
};
|
|
2386
|
+
},
|
|
2387
|
+
{
|
|
2388
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2389
|
+
capabilities: {
|
|
2390
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2391
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2392
|
+
publishVariants: string[];
|
|
2393
|
+
};
|
|
2394
|
+
displayName: string;
|
|
2395
|
+
/** @enum {string} */
|
|
2396
|
+
key: "reddit";
|
|
2397
|
+
limits: {
|
|
2398
|
+
allowedMimeTypes: string[];
|
|
2399
|
+
/** @enum {string} */
|
|
2400
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2401
|
+
maxBodyLength: number;
|
|
2402
|
+
maxMediaBytes: number;
|
|
2403
|
+
maxMediaItems: number;
|
|
2404
|
+
};
|
|
2405
|
+
/** @enum {string} */
|
|
2406
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2407
|
+
targetTypes: string[];
|
|
2408
|
+
validation: {
|
|
2409
|
+
/**
|
|
2410
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2411
|
+
* @enum {string}
|
|
2412
|
+
*/
|
|
2413
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2414
|
+
/** @enum {string} */
|
|
2415
|
+
operation: "publishing.createPost";
|
|
2416
|
+
};
|
|
2417
|
+
},
|
|
2418
|
+
{
|
|
2419
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2420
|
+
capabilities: {
|
|
2421
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2422
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2423
|
+
publishVariants: string[];
|
|
2424
|
+
};
|
|
2425
|
+
displayName: string;
|
|
2426
|
+
/** @enum {string} */
|
|
2427
|
+
key: "telegram";
|
|
2428
|
+
limits: {
|
|
2429
|
+
allowedMimeTypes: string[];
|
|
2430
|
+
/** @enum {string} */
|
|
2431
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2432
|
+
maxBodyLength: number;
|
|
2433
|
+
maxMediaBytes: number;
|
|
2434
|
+
maxMediaItems: number;
|
|
2435
|
+
};
|
|
2436
|
+
/** @enum {string} */
|
|
2437
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2438
|
+
targetTypes: string[];
|
|
2439
|
+
validation: {
|
|
2440
|
+
/**
|
|
2441
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2442
|
+
* @enum {string}
|
|
2443
|
+
*/
|
|
2444
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2445
|
+
/** @enum {string} */
|
|
2446
|
+
operation: "publishing.createPost";
|
|
2447
|
+
};
|
|
2448
|
+
},
|
|
2449
|
+
{
|
|
2450
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2451
|
+
capabilities: {
|
|
2452
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2453
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2454
|
+
publishVariants: string[];
|
|
2455
|
+
};
|
|
2456
|
+
displayName: string;
|
|
2457
|
+
/** @enum {string} */
|
|
2458
|
+
key: "threads";
|
|
2459
|
+
limits: {
|
|
2460
|
+
allowedMimeTypes: string[];
|
|
2461
|
+
/** @enum {string} */
|
|
2462
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2463
|
+
maxBodyLength: number;
|
|
2464
|
+
maxMediaBytes: number;
|
|
2465
|
+
maxMediaItems: number;
|
|
2466
|
+
};
|
|
2467
|
+
/** @enum {string} */
|
|
2468
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2469
|
+
targetTypes: string[];
|
|
2470
|
+
validation: {
|
|
2471
|
+
/**
|
|
2472
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2473
|
+
* @enum {string}
|
|
2474
|
+
*/
|
|
2475
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2476
|
+
/** @enum {string} */
|
|
2477
|
+
operation: "publishing.createPost";
|
|
2478
|
+
};
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2482
|
+
capabilities: {
|
|
2483
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2484
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2485
|
+
publishVariants: string[];
|
|
2486
|
+
};
|
|
2487
|
+
displayName: string;
|
|
2488
|
+
/** @enum {string} */
|
|
2489
|
+
key: "tiktok";
|
|
2490
|
+
limits: {
|
|
2491
|
+
allowedMimeTypes: string[];
|
|
2492
|
+
/** @enum {string} */
|
|
2493
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2494
|
+
maxBodyLength: number;
|
|
2495
|
+
maxMediaBytes: number;
|
|
2496
|
+
maxMediaItems: number;
|
|
2497
|
+
};
|
|
2498
|
+
/** @enum {string} */
|
|
2499
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2500
|
+
targetTypes: string[];
|
|
2501
|
+
validation: {
|
|
2502
|
+
/**
|
|
2503
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2504
|
+
* @enum {string}
|
|
2505
|
+
*/
|
|
2506
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2507
|
+
/** @enum {string} */
|
|
2508
|
+
operation: "publishing.createPost";
|
|
2509
|
+
};
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2513
|
+
capabilities: {
|
|
2514
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2515
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2516
|
+
publishVariants: string[];
|
|
2517
|
+
};
|
|
2518
|
+
displayName: string;
|
|
2519
|
+
/** @enum {string} */
|
|
2520
|
+
key: "x-twitter";
|
|
2521
|
+
limits: {
|
|
2522
|
+
allowedMimeTypes: string[];
|
|
2523
|
+
/** @enum {string} */
|
|
2524
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2525
|
+
maxBodyLength: number;
|
|
2526
|
+
maxMediaBytes: number;
|
|
2527
|
+
maxMediaItems: number;
|
|
2528
|
+
};
|
|
2529
|
+
/** @enum {string} */
|
|
2530
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2531
|
+
targetTypes: string[];
|
|
2532
|
+
validation: {
|
|
2533
|
+
/**
|
|
2534
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2535
|
+
* @enum {string}
|
|
2536
|
+
*/
|
|
2537
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2538
|
+
/** @enum {string} */
|
|
2539
|
+
operation: "publishing.createPost";
|
|
2540
|
+
};
|
|
2541
|
+
},
|
|
2542
|
+
{
|
|
2543
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2544
|
+
capabilities: {
|
|
2545
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2546
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2547
|
+
publishVariants: string[];
|
|
2548
|
+
};
|
|
2549
|
+
displayName: string;
|
|
2550
|
+
/** @enum {string} */
|
|
2551
|
+
key: "youtube";
|
|
2552
|
+
limits: {
|
|
2553
|
+
allowedMimeTypes: string[];
|
|
2554
|
+
/** @enum {string} */
|
|
2555
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2556
|
+
maxBodyLength: number;
|
|
2557
|
+
maxMediaBytes: number;
|
|
2558
|
+
maxMediaItems: number;
|
|
2559
|
+
};
|
|
2560
|
+
/** @enum {string} */
|
|
2561
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2562
|
+
targetTypes: string[];
|
|
2563
|
+
validation: {
|
|
2564
|
+
/**
|
|
2565
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2566
|
+
* @enum {string}
|
|
2567
|
+
*/
|
|
2568
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2569
|
+
/** @enum {string} */
|
|
2570
|
+
operation: "publishing.createPost";
|
|
2571
|
+
};
|
|
2572
|
+
},
|
|
2573
|
+
{
|
|
2574
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2575
|
+
capabilities: {
|
|
2576
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2577
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2578
|
+
publishVariants: string[];
|
|
2579
|
+
};
|
|
2580
|
+
displayName: string;
|
|
2581
|
+
/** @enum {string} */
|
|
2582
|
+
key: "google-business";
|
|
2583
|
+
limits: {
|
|
2584
|
+
allowedMimeTypes: string[];
|
|
2585
|
+
/** @enum {string} */
|
|
2586
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2587
|
+
maxBodyLength: number;
|
|
2588
|
+
maxMediaBytes: number;
|
|
2589
|
+
maxMediaItems: number;
|
|
2590
|
+
};
|
|
2591
|
+
/** @enum {string} */
|
|
2592
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2593
|
+
targetTypes: string[];
|
|
2594
|
+
validation: {
|
|
2595
|
+
/**
|
|
2596
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2597
|
+
* @enum {string}
|
|
2598
|
+
*/
|
|
2599
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2600
|
+
/** @enum {string} */
|
|
2601
|
+
operation: "publishing.createPost";
|
|
2602
|
+
};
|
|
2603
|
+
},
|
|
2604
|
+
{
|
|
2605
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2606
|
+
capabilities: {
|
|
2607
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2608
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2609
|
+
publishVariants: string[];
|
|
2610
|
+
};
|
|
2611
|
+
displayName: string;
|
|
2612
|
+
/** @enum {string} */
|
|
2613
|
+
key: "snapchat";
|
|
2614
|
+
limits: {
|
|
2615
|
+
allowedMimeTypes: string[];
|
|
2616
|
+
/** @enum {string} */
|
|
2617
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2618
|
+
maxBodyLength: number;
|
|
2619
|
+
maxMediaBytes: number;
|
|
2620
|
+
maxMediaItems: number;
|
|
2621
|
+
};
|
|
2622
|
+
/** @enum {string} */
|
|
2623
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2624
|
+
targetTypes: string[];
|
|
2625
|
+
validation: {
|
|
2626
|
+
/**
|
|
2627
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2628
|
+
* @enum {string}
|
|
2629
|
+
*/
|
|
2630
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2631
|
+
/** @enum {string} */
|
|
2632
|
+
operation: "publishing.createPost";
|
|
2633
|
+
};
|
|
2634
|
+
},
|
|
2635
|
+
{
|
|
2636
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2637
|
+
capabilities: {
|
|
2638
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2639
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2640
|
+
publishVariants: string[];
|
|
2641
|
+
};
|
|
2642
|
+
displayName: string;
|
|
2643
|
+
/** @enum {string} */
|
|
2644
|
+
key: "whatsapp";
|
|
2645
|
+
limits: {
|
|
2646
|
+
allowedMimeTypes: string[];
|
|
2647
|
+
/** @enum {string} */
|
|
2648
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2649
|
+
maxBodyLength: number;
|
|
2650
|
+
maxMediaBytes: number;
|
|
2651
|
+
maxMediaItems: number;
|
|
2652
|
+
};
|
|
2653
|
+
/** @enum {string} */
|
|
2654
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2655
|
+
targetTypes: string[];
|
|
2656
|
+
validation: {
|
|
2657
|
+
/**
|
|
2658
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2659
|
+
* @enum {string}
|
|
2660
|
+
*/
|
|
2661
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2662
|
+
/** @enum {string} */
|
|
2663
|
+
operation: "publishing.createPost";
|
|
2664
|
+
};
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2668
|
+
capabilities: {
|
|
2669
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2670
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2671
|
+
publishVariants: string[];
|
|
2672
|
+
};
|
|
2673
|
+
displayName: string;
|
|
2674
|
+
/** @enum {string} */
|
|
2675
|
+
key: "discord";
|
|
2676
|
+
limits: {
|
|
2677
|
+
allowedMimeTypes: string[];
|
|
2678
|
+
/** @enum {string} */
|
|
2679
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2680
|
+
maxBodyLength: number;
|
|
2681
|
+
maxMediaBytes: number;
|
|
2682
|
+
maxMediaItems: number;
|
|
2683
|
+
};
|
|
2684
|
+
/** @enum {string} */
|
|
2685
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2686
|
+
targetTypes: string[];
|
|
2687
|
+
validation: {
|
|
2688
|
+
/**
|
|
2689
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2690
|
+
* @enum {string}
|
|
2691
|
+
*/
|
|
2692
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2693
|
+
/** @enum {string} */
|
|
2694
|
+
operation: "publishing.createPost";
|
|
2695
|
+
};
|
|
2696
|
+
},
|
|
2697
|
+
{
|
|
2698
|
+
authMethods: ("APP_PASSWORD" | "BOT_TOKEN" | "OAUTH2_AUTHORIZATION_CODE" | "OAUTH2_PKCE" | "STATIC_TOKEN")[];
|
|
2699
|
+
capabilities: {
|
|
2700
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2701
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2702
|
+
publishVariants: string[];
|
|
2703
|
+
};
|
|
2704
|
+
displayName: string;
|
|
2705
|
+
/** @enum {string} */
|
|
2706
|
+
key: "site-plugin";
|
|
2707
|
+
limits: {
|
|
2708
|
+
allowedMimeTypes: string[];
|
|
2709
|
+
/** @enum {string} */
|
|
2710
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2711
|
+
maxBodyLength: number;
|
|
2712
|
+
maxMediaBytes: number;
|
|
2713
|
+
maxMediaItems: number;
|
|
2714
|
+
};
|
|
2715
|
+
/** @enum {string} */
|
|
2716
|
+
releaseClaim: "CURRENT_CODE_UPPER_BOUND";
|
|
2717
|
+
targetTypes: string[];
|
|
2718
|
+
validation: {
|
|
2719
|
+
/**
|
|
2720
|
+
* @description Transport-independent input schema. This GET maps repeated mediaMimeType and mediaByteLength query parameters to its plural array fields; MIME values are bounded to 127 Unicode code points and publishVariant to 256.
|
|
2721
|
+
* @enum {string}
|
|
2722
|
+
*/
|
|
2723
|
+
inputSchemaRef: "urn:oxchannels:schema:public-channel-validation-input:1.0.0";
|
|
2724
|
+
/** @enum {string} */
|
|
2725
|
+
operation: "publishing.createPost";
|
|
2726
|
+
};
|
|
2727
|
+
}
|
|
2728
|
+
];
|
|
2729
|
+
/**
|
|
2730
|
+
* Format: date
|
|
2731
|
+
* @enum {string}
|
|
2732
|
+
*/
|
|
2733
|
+
reviewedAt: "2026-07-21";
|
|
2734
|
+
/** @enum {string} */
|
|
2735
|
+
schemaVersion: "1.0.0";
|
|
2736
|
+
sourceDigest: string;
|
|
2737
|
+
supportSemantics: {
|
|
2738
|
+
/** @enum {string} */
|
|
2739
|
+
catalog: "CURRENT_CODE_UPPER_BOUND";
|
|
2740
|
+
/** @enum {string} */
|
|
2741
|
+
demo: "SYNTHETIC_NO_PROVIDER_EFFECTS";
|
|
2742
|
+
/** @enum {string} */
|
|
2743
|
+
limits: "STATIC_CURRENT_CODE_UPPER_BOUND";
|
|
2744
|
+
/** @enum {string} */
|
|
2745
|
+
pricing: "OXCHANNELS_FEE_ONLY_PROVIDER_COST_NOT_INCLUDED";
|
|
2746
|
+
/** @enum {string} */
|
|
2747
|
+
readiness: "DYNAMIC_CHECKS_REQUIRED_AFTER_AUTH";
|
|
2748
|
+
};
|
|
2749
|
+
};
|
|
2750
|
+
};
|
|
2751
|
+
};
|
|
2752
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
2753
|
+
304: {
|
|
2754
|
+
headers: {
|
|
2755
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
2756
|
+
"Cache-Control": string;
|
|
2757
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
2758
|
+
ETag: string;
|
|
2759
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
2760
|
+
Vary: string;
|
|
2761
|
+
[name: string]: unknown;
|
|
2762
|
+
};
|
|
2763
|
+
content?: never;
|
|
2764
|
+
};
|
|
2765
|
+
/** @description The public request input is invalid. */
|
|
2766
|
+
400: {
|
|
2767
|
+
headers: {
|
|
2768
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2769
|
+
"Cache-Control": "no-store";
|
|
2770
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2771
|
+
Vary: string;
|
|
2772
|
+
[name: string]: unknown;
|
|
2773
|
+
};
|
|
2774
|
+
content: {
|
|
2775
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
2776
|
+
};
|
|
2777
|
+
};
|
|
2778
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
2779
|
+
404: {
|
|
2780
|
+
headers: {
|
|
2781
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2782
|
+
"Cache-Control": "no-store";
|
|
2783
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2784
|
+
Vary: string;
|
|
2785
|
+
[name: string]: unknown;
|
|
2786
|
+
};
|
|
2787
|
+
content: {
|
|
2788
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
2789
|
+
};
|
|
2790
|
+
};
|
|
2791
|
+
/** @description The shared public-read rate limit was reached. */
|
|
2792
|
+
429: {
|
|
2793
|
+
headers: {
|
|
2794
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2795
|
+
"Cache-Control": "no-store";
|
|
2796
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
2797
|
+
"Retry-After": string;
|
|
2798
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2799
|
+
Vary: string;
|
|
2800
|
+
[name: string]: unknown;
|
|
2801
|
+
};
|
|
2802
|
+
content: {
|
|
2803
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
2804
|
+
};
|
|
2805
|
+
};
|
|
2806
|
+
/** @description The public request failed without exposing internal details. */
|
|
2807
|
+
500: {
|
|
2808
|
+
headers: {
|
|
2809
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2810
|
+
"Cache-Control": "no-store";
|
|
2811
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2812
|
+
Vary: string;
|
|
2813
|
+
[name: string]: unknown;
|
|
2814
|
+
};
|
|
2815
|
+
content: {
|
|
2816
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
2817
|
+
};
|
|
2818
|
+
};
|
|
2819
|
+
};
|
|
2820
|
+
};
|
|
2821
|
+
PublicCatalog_capabilities: {
|
|
2822
|
+
parameters: {
|
|
2823
|
+
query?: never;
|
|
2824
|
+
header?: {
|
|
2825
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
2826
|
+
"If-None-Match"?: string;
|
|
2827
|
+
};
|
|
2828
|
+
path: {
|
|
2829
|
+
providerKey: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
2830
|
+
};
|
|
2831
|
+
cookie?: never;
|
|
2832
|
+
};
|
|
2833
|
+
requestBody?: never;
|
|
2834
|
+
responses: {
|
|
2835
|
+
/** @description Public channel capability upper bounds. */
|
|
2836
|
+
200: {
|
|
2837
|
+
headers: {
|
|
2838
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
2839
|
+
"Cache-Control": string;
|
|
2840
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
2841
|
+
ETag: string;
|
|
2842
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
2843
|
+
Vary: string;
|
|
2844
|
+
[name: string]: unknown;
|
|
2845
|
+
};
|
|
2846
|
+
content: {
|
|
2847
|
+
"application/json": {
|
|
2848
|
+
capabilities: {
|
|
2849
|
+
mediaModes: ("PUBLIC_URL" | "BINARY_STREAM" | "MULTIPART" | "RESUMABLE" | "CONTAINER_ASYNC")[];
|
|
2850
|
+
outboundFeatures: ("TEXT" | "IMAGE" | "VIDEO" | "SCHEDULE")[];
|
|
2851
|
+
publishVariants: string[];
|
|
2852
|
+
};
|
|
2853
|
+
/** @enum {string} */
|
|
2854
|
+
catalogVersion: "1.0.0";
|
|
2855
|
+
provider: {
|
|
2856
|
+
displayName: string;
|
|
2857
|
+
/** @enum {string} */
|
|
2858
|
+
key: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
2859
|
+
};
|
|
2860
|
+
/** @enum {string} */
|
|
2861
|
+
schemaVersion: "1.0.0";
|
|
2862
|
+
sourceDigest: string;
|
|
2863
|
+
};
|
|
2864
|
+
};
|
|
2865
|
+
};
|
|
2866
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
2867
|
+
304: {
|
|
2868
|
+
headers: {
|
|
2869
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
2870
|
+
"Cache-Control": string;
|
|
2871
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
2872
|
+
ETag: string;
|
|
2873
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
2874
|
+
Vary: string;
|
|
2875
|
+
[name: string]: unknown;
|
|
2876
|
+
};
|
|
2877
|
+
content?: never;
|
|
2878
|
+
};
|
|
2879
|
+
/** @description The public request input is invalid. */
|
|
2880
|
+
400: {
|
|
2881
|
+
headers: {
|
|
2882
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2883
|
+
"Cache-Control": "no-store";
|
|
2884
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2885
|
+
Vary: string;
|
|
2886
|
+
[name: string]: unknown;
|
|
2887
|
+
};
|
|
2888
|
+
content: {
|
|
2889
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
2890
|
+
};
|
|
2891
|
+
};
|
|
2892
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
2893
|
+
404: {
|
|
2894
|
+
headers: {
|
|
2895
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2896
|
+
"Cache-Control": "no-store";
|
|
2897
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2898
|
+
Vary: string;
|
|
2899
|
+
[name: string]: unknown;
|
|
2900
|
+
};
|
|
2901
|
+
content: {
|
|
2902
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
2903
|
+
};
|
|
2904
|
+
};
|
|
2905
|
+
/** @description The shared public-read rate limit was reached. */
|
|
2906
|
+
429: {
|
|
2907
|
+
headers: {
|
|
2908
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2909
|
+
"Cache-Control": "no-store";
|
|
2910
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
2911
|
+
"Retry-After": string;
|
|
2912
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2913
|
+
Vary: string;
|
|
2914
|
+
[name: string]: unknown;
|
|
2915
|
+
};
|
|
2916
|
+
content: {
|
|
2917
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
/** @description The public request failed without exposing internal details. */
|
|
2921
|
+
500: {
|
|
2922
|
+
headers: {
|
|
2923
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
2924
|
+
"Cache-Control": "no-store";
|
|
2925
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
2926
|
+
Vary: string;
|
|
2927
|
+
[name: string]: unknown;
|
|
2928
|
+
};
|
|
2929
|
+
content: {
|
|
2930
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
};
|
|
2934
|
+
};
|
|
2935
|
+
PublicCatalog_limits: {
|
|
2936
|
+
parameters: {
|
|
2937
|
+
query?: never;
|
|
2938
|
+
header?: {
|
|
2939
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
2940
|
+
"If-None-Match"?: string;
|
|
2941
|
+
};
|
|
2942
|
+
path: {
|
|
2943
|
+
providerKey: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
2944
|
+
};
|
|
2945
|
+
cookie?: never;
|
|
2946
|
+
};
|
|
2947
|
+
requestBody?: never;
|
|
2948
|
+
responses: {
|
|
2949
|
+
/** @description Public channel validation limits. */
|
|
2950
|
+
200: {
|
|
2951
|
+
headers: {
|
|
2952
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
2953
|
+
"Cache-Control": string;
|
|
2954
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
2955
|
+
ETag: string;
|
|
2956
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
2957
|
+
Vary: string;
|
|
2958
|
+
[name: string]: unknown;
|
|
2959
|
+
};
|
|
2960
|
+
content: {
|
|
2961
|
+
"application/json": {
|
|
2962
|
+
/** @enum {string} */
|
|
2963
|
+
catalogVersion: "1.0.0";
|
|
2964
|
+
limits: {
|
|
2965
|
+
allowedMimeTypes: string[];
|
|
2966
|
+
/** @enum {string} */
|
|
2967
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
2968
|
+
maxBodyLength: number;
|
|
2969
|
+
maxMediaBytes: number;
|
|
2970
|
+
maxMediaItems: number;
|
|
2971
|
+
};
|
|
2972
|
+
provider: {
|
|
2973
|
+
displayName: string;
|
|
2974
|
+
/** @enum {string} */
|
|
2975
|
+
key: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
2976
|
+
};
|
|
2977
|
+
/** @enum {string} */
|
|
2978
|
+
schemaVersion: "1.0.0";
|
|
2979
|
+
sourceDigest: string;
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
};
|
|
2983
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
2984
|
+
304: {
|
|
2985
|
+
headers: {
|
|
2986
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
2987
|
+
"Cache-Control": string;
|
|
2988
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
2989
|
+
ETag: string;
|
|
2990
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
2991
|
+
Vary: string;
|
|
2992
|
+
[name: string]: unknown;
|
|
2993
|
+
};
|
|
2994
|
+
content?: never;
|
|
2995
|
+
};
|
|
2996
|
+
/** @description The public request input is invalid. */
|
|
2997
|
+
400: {
|
|
2998
|
+
headers: {
|
|
2999
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3000
|
+
"Cache-Control": "no-store";
|
|
3001
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3002
|
+
Vary: string;
|
|
3003
|
+
[name: string]: unknown;
|
|
3004
|
+
};
|
|
3005
|
+
content: {
|
|
3006
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
3007
|
+
};
|
|
3008
|
+
};
|
|
3009
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
3010
|
+
404: {
|
|
3011
|
+
headers: {
|
|
3012
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3013
|
+
"Cache-Control": "no-store";
|
|
3014
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3015
|
+
Vary: string;
|
|
3016
|
+
[name: string]: unknown;
|
|
3017
|
+
};
|
|
3018
|
+
content: {
|
|
3019
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
/** @description The shared public-read rate limit was reached. */
|
|
3023
|
+
429: {
|
|
3024
|
+
headers: {
|
|
3025
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3026
|
+
"Cache-Control": "no-store";
|
|
3027
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
3028
|
+
"Retry-After": string;
|
|
3029
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3030
|
+
Vary: string;
|
|
3031
|
+
[name: string]: unknown;
|
|
3032
|
+
};
|
|
3033
|
+
content: {
|
|
3034
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
3035
|
+
};
|
|
3036
|
+
};
|
|
3037
|
+
/** @description The public request failed without exposing internal details. */
|
|
3038
|
+
500: {
|
|
3039
|
+
headers: {
|
|
3040
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3041
|
+
"Cache-Control": "no-store";
|
|
3042
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3043
|
+
Vary: string;
|
|
3044
|
+
[name: string]: unknown;
|
|
3045
|
+
};
|
|
3046
|
+
content: {
|
|
3047
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
3051
|
+
};
|
|
3052
|
+
PublicCatalog_validate: {
|
|
3053
|
+
parameters: {
|
|
3054
|
+
query: {
|
|
3055
|
+
bodyLength: number;
|
|
3056
|
+
mediaByteLength?: number[];
|
|
3057
|
+
mediaCount: number;
|
|
3058
|
+
mediaMimeType?: string[];
|
|
3059
|
+
publishVariant?: string;
|
|
3060
|
+
};
|
|
3061
|
+
header?: {
|
|
3062
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
3063
|
+
"If-None-Match"?: string;
|
|
3064
|
+
};
|
|
3065
|
+
path: {
|
|
3066
|
+
providerKey: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3067
|
+
};
|
|
3068
|
+
cookie?: never;
|
|
3069
|
+
};
|
|
3070
|
+
requestBody?: never;
|
|
3071
|
+
responses: {
|
|
3072
|
+
/** @description Content-free public channel validation result. */
|
|
3073
|
+
200: {
|
|
3074
|
+
headers: {
|
|
3075
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3076
|
+
"Cache-Control": string;
|
|
3077
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3078
|
+
ETag: string;
|
|
3079
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3080
|
+
Vary: string;
|
|
3081
|
+
[name: string]: unknown;
|
|
3082
|
+
};
|
|
3083
|
+
content: {
|
|
3084
|
+
"application/json": {
|
|
3085
|
+
/** @enum {string} */
|
|
3086
|
+
catalogVersion: "1.0.0";
|
|
3087
|
+
provider: {
|
|
3088
|
+
displayName: string;
|
|
3089
|
+
/** @enum {string} */
|
|
3090
|
+
key: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3091
|
+
};
|
|
3092
|
+
/** @enum {string} */
|
|
3093
|
+
schemaVersion: "1.0.0";
|
|
3094
|
+
sourceDigest: string;
|
|
3095
|
+
validation: {
|
|
3096
|
+
issues: ({
|
|
3097
|
+
/** @enum {string} */
|
|
3098
|
+
code: "MEDIA_METADATA_COUNT_MISMATCH";
|
|
3099
|
+
/** @enum {string} */
|
|
3100
|
+
field: "mediaCount";
|
|
3101
|
+
indexes: number[];
|
|
3102
|
+
} | {
|
|
3103
|
+
/** @enum {string} */
|
|
3104
|
+
code: "BODY_LENGTH_EXCEEDED";
|
|
3105
|
+
/** @enum {string} */
|
|
3106
|
+
field: "bodyLength";
|
|
3107
|
+
indexes: number[];
|
|
3108
|
+
} | {
|
|
3109
|
+
/** @enum {string} */
|
|
3110
|
+
code: "MEDIA_COUNT_EXCEEDED";
|
|
3111
|
+
/** @enum {string} */
|
|
3112
|
+
field: "mediaCount";
|
|
3113
|
+
indexes: number[];
|
|
3114
|
+
} | {
|
|
3115
|
+
/** @enum {string} */
|
|
3116
|
+
code: "MEDIA_MIME_TYPE_UNSUPPORTED";
|
|
3117
|
+
/** @enum {string} */
|
|
3118
|
+
field: "mediaMimeTypes";
|
|
3119
|
+
indexes: number[];
|
|
3120
|
+
} | {
|
|
3121
|
+
/** @enum {string} */
|
|
3122
|
+
code: "MEDIA_BYTES_EXCEEDED";
|
|
3123
|
+
/** @enum {string} */
|
|
3124
|
+
field: "mediaByteLengths";
|
|
3125
|
+
indexes: number[];
|
|
3126
|
+
} | {
|
|
3127
|
+
/** @enum {string} */
|
|
3128
|
+
code: "PUBLISH_VARIANT_UNSUPPORTED";
|
|
3129
|
+
/** @enum {string} */
|
|
3130
|
+
field: "publishVariant";
|
|
3131
|
+
indexes: number[];
|
|
3132
|
+
})[] & (unknown & unknown & unknown & unknown & unknown & unknown);
|
|
3133
|
+
limits: {
|
|
3134
|
+
allowedMimeTypes: string[];
|
|
3135
|
+
/** @enum {string} */
|
|
3136
|
+
bodyLengthUnit: "CODE_UNITS" | "GRAPHEMES";
|
|
3137
|
+
maxBodyLength: number;
|
|
3138
|
+
maxMediaBytes: number;
|
|
3139
|
+
maxMediaItems: number;
|
|
3140
|
+
};
|
|
3141
|
+
/** @enum {string} */
|
|
3142
|
+
provider: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3143
|
+
valid: boolean;
|
|
3144
|
+
} & ({
|
|
3145
|
+
issues?: unknown[];
|
|
3146
|
+
/** @enum {boolean} */
|
|
3147
|
+
valid?: true;
|
|
3148
|
+
} | {
|
|
3149
|
+
issues?: unknown[];
|
|
3150
|
+
/** @enum {boolean} */
|
|
3151
|
+
valid?: false;
|
|
3152
|
+
});
|
|
3153
|
+
} & ({
|
|
3154
|
+
provider?: {
|
|
3155
|
+
/** @enum {string} */
|
|
3156
|
+
key?: "bluesky";
|
|
3157
|
+
};
|
|
3158
|
+
validation?: {
|
|
3159
|
+
/** @enum {string} */
|
|
3160
|
+
provider?: "bluesky";
|
|
3161
|
+
};
|
|
3162
|
+
} | {
|
|
3163
|
+
provider?: {
|
|
3164
|
+
/** @enum {string} */
|
|
3165
|
+
key?: "facebook";
|
|
3166
|
+
};
|
|
3167
|
+
validation?: {
|
|
3168
|
+
/** @enum {string} */
|
|
3169
|
+
provider?: "facebook";
|
|
3170
|
+
};
|
|
3171
|
+
} | {
|
|
3172
|
+
provider?: {
|
|
3173
|
+
/** @enum {string} */
|
|
3174
|
+
key?: "instagram";
|
|
3175
|
+
};
|
|
3176
|
+
validation?: {
|
|
3177
|
+
/** @enum {string} */
|
|
3178
|
+
provider?: "instagram";
|
|
3179
|
+
};
|
|
3180
|
+
} | {
|
|
3181
|
+
provider?: {
|
|
3182
|
+
/** @enum {string} */
|
|
3183
|
+
key?: "linkedin";
|
|
3184
|
+
};
|
|
3185
|
+
validation?: {
|
|
3186
|
+
/** @enum {string} */
|
|
3187
|
+
provider?: "linkedin";
|
|
3188
|
+
};
|
|
3189
|
+
} | {
|
|
3190
|
+
provider?: {
|
|
3191
|
+
/** @enum {string} */
|
|
3192
|
+
key?: "mastodon";
|
|
3193
|
+
};
|
|
3194
|
+
validation?: {
|
|
3195
|
+
/** @enum {string} */
|
|
3196
|
+
provider?: "mastodon";
|
|
3197
|
+
};
|
|
3198
|
+
} | {
|
|
3199
|
+
provider?: {
|
|
3200
|
+
/** @enum {string} */
|
|
3201
|
+
key?: "pinterest";
|
|
3202
|
+
};
|
|
3203
|
+
validation?: {
|
|
3204
|
+
/** @enum {string} */
|
|
3205
|
+
provider?: "pinterest";
|
|
3206
|
+
};
|
|
3207
|
+
} | {
|
|
3208
|
+
provider?: {
|
|
3209
|
+
/** @enum {string} */
|
|
3210
|
+
key?: "reddit";
|
|
3211
|
+
};
|
|
3212
|
+
validation?: {
|
|
3213
|
+
/** @enum {string} */
|
|
3214
|
+
provider?: "reddit";
|
|
3215
|
+
};
|
|
3216
|
+
} | {
|
|
3217
|
+
provider?: {
|
|
3218
|
+
/** @enum {string} */
|
|
3219
|
+
key?: "telegram";
|
|
3220
|
+
};
|
|
3221
|
+
validation?: {
|
|
3222
|
+
/** @enum {string} */
|
|
3223
|
+
provider?: "telegram";
|
|
3224
|
+
};
|
|
3225
|
+
} | {
|
|
3226
|
+
provider?: {
|
|
3227
|
+
/** @enum {string} */
|
|
3228
|
+
key?: "threads";
|
|
3229
|
+
};
|
|
3230
|
+
validation?: {
|
|
3231
|
+
/** @enum {string} */
|
|
3232
|
+
provider?: "threads";
|
|
3233
|
+
};
|
|
3234
|
+
} | {
|
|
3235
|
+
provider?: {
|
|
3236
|
+
/** @enum {string} */
|
|
3237
|
+
key?: "tiktok";
|
|
3238
|
+
};
|
|
3239
|
+
validation?: {
|
|
3240
|
+
/** @enum {string} */
|
|
3241
|
+
provider?: "tiktok";
|
|
3242
|
+
};
|
|
3243
|
+
} | {
|
|
3244
|
+
provider?: {
|
|
3245
|
+
/** @enum {string} */
|
|
3246
|
+
key?: "x-twitter";
|
|
3247
|
+
};
|
|
3248
|
+
validation?: {
|
|
3249
|
+
/** @enum {string} */
|
|
3250
|
+
provider?: "x-twitter";
|
|
3251
|
+
};
|
|
3252
|
+
} | {
|
|
3253
|
+
provider?: {
|
|
3254
|
+
/** @enum {string} */
|
|
3255
|
+
key?: "youtube";
|
|
3256
|
+
};
|
|
3257
|
+
validation?: {
|
|
3258
|
+
/** @enum {string} */
|
|
3259
|
+
provider?: "youtube";
|
|
3260
|
+
};
|
|
3261
|
+
} | {
|
|
3262
|
+
provider?: {
|
|
3263
|
+
/** @enum {string} */
|
|
3264
|
+
key?: "google-business";
|
|
3265
|
+
};
|
|
3266
|
+
validation?: {
|
|
3267
|
+
/** @enum {string} */
|
|
3268
|
+
provider?: "google-business";
|
|
3269
|
+
};
|
|
3270
|
+
} | {
|
|
3271
|
+
provider?: {
|
|
3272
|
+
/** @enum {string} */
|
|
3273
|
+
key?: "snapchat";
|
|
3274
|
+
};
|
|
3275
|
+
validation?: {
|
|
3276
|
+
/** @enum {string} */
|
|
3277
|
+
provider?: "snapchat";
|
|
3278
|
+
};
|
|
3279
|
+
} | {
|
|
3280
|
+
provider?: {
|
|
3281
|
+
/** @enum {string} */
|
|
3282
|
+
key?: "whatsapp";
|
|
3283
|
+
};
|
|
3284
|
+
validation?: {
|
|
3285
|
+
/** @enum {string} */
|
|
3286
|
+
provider?: "whatsapp";
|
|
3287
|
+
};
|
|
3288
|
+
} | {
|
|
3289
|
+
provider?: {
|
|
3290
|
+
/** @enum {string} */
|
|
3291
|
+
key?: "discord";
|
|
3292
|
+
};
|
|
3293
|
+
validation?: {
|
|
3294
|
+
/** @enum {string} */
|
|
3295
|
+
provider?: "discord";
|
|
3296
|
+
};
|
|
3297
|
+
} | {
|
|
3298
|
+
provider?: {
|
|
3299
|
+
/** @enum {string} */
|
|
3300
|
+
key?: "site-plugin";
|
|
3301
|
+
};
|
|
3302
|
+
validation?: {
|
|
3303
|
+
/** @enum {string} */
|
|
3304
|
+
provider?: "site-plugin";
|
|
3305
|
+
};
|
|
3306
|
+
});
|
|
3307
|
+
};
|
|
3308
|
+
};
|
|
3309
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
3310
|
+
304: {
|
|
3311
|
+
headers: {
|
|
3312
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3313
|
+
"Cache-Control": string;
|
|
3314
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3315
|
+
ETag: string;
|
|
3316
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3317
|
+
Vary: string;
|
|
3318
|
+
[name: string]: unknown;
|
|
3319
|
+
};
|
|
3320
|
+
content?: never;
|
|
3321
|
+
};
|
|
3322
|
+
/** @description The public request input is invalid. */
|
|
3323
|
+
400: {
|
|
3324
|
+
headers: {
|
|
3325
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3326
|
+
"Cache-Control": "no-store";
|
|
3327
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3328
|
+
Vary: string;
|
|
3329
|
+
[name: string]: unknown;
|
|
3330
|
+
};
|
|
3331
|
+
content: {
|
|
3332
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
3333
|
+
};
|
|
3334
|
+
};
|
|
3335
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
3336
|
+
404: {
|
|
3337
|
+
headers: {
|
|
3338
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3339
|
+
"Cache-Control": "no-store";
|
|
3340
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3341
|
+
Vary: string;
|
|
3342
|
+
[name: string]: unknown;
|
|
3343
|
+
};
|
|
3344
|
+
content: {
|
|
3345
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
3346
|
+
};
|
|
3347
|
+
};
|
|
3348
|
+
/** @description The shared public-read rate limit was reached. */
|
|
3349
|
+
429: {
|
|
3350
|
+
headers: {
|
|
3351
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3352
|
+
"Cache-Control": "no-store";
|
|
3353
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
3354
|
+
"Retry-After": string;
|
|
3355
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3356
|
+
Vary: string;
|
|
3357
|
+
[name: string]: unknown;
|
|
3358
|
+
};
|
|
3359
|
+
content: {
|
|
3360
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
3361
|
+
};
|
|
3362
|
+
};
|
|
3363
|
+
/** @description The public request failed without exposing internal details. */
|
|
3364
|
+
500: {
|
|
3365
|
+
headers: {
|
|
3366
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3367
|
+
"Cache-Control": "no-store";
|
|
3368
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3369
|
+
Vary: string;
|
|
3370
|
+
[name: string]: unknown;
|
|
3371
|
+
};
|
|
3372
|
+
content: {
|
|
3373
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
3374
|
+
};
|
|
3375
|
+
};
|
|
3376
|
+
};
|
|
3377
|
+
};
|
|
3378
|
+
PublicCatalog_demo: {
|
|
3379
|
+
parameters: {
|
|
3380
|
+
query?: never;
|
|
3381
|
+
header?: {
|
|
3382
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
3383
|
+
"If-None-Match"?: string;
|
|
3384
|
+
};
|
|
3385
|
+
path: {
|
|
3386
|
+
fixtureKey: "overview" | "calendar" | "inbox" | "analytics" | "ads" | "workflows";
|
|
3387
|
+
};
|
|
3388
|
+
cookie?: never;
|
|
3389
|
+
};
|
|
3390
|
+
requestBody?: never;
|
|
3391
|
+
responses: {
|
|
3392
|
+
/** @description Versioned synthetic public demo fixture. */
|
|
3393
|
+
200: {
|
|
3394
|
+
headers: {
|
|
3395
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3396
|
+
"Cache-Control": string;
|
|
3397
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3398
|
+
ETag: string;
|
|
3399
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3400
|
+
Vary: string;
|
|
3401
|
+
[name: string]: unknown;
|
|
3402
|
+
};
|
|
3403
|
+
content: {
|
|
3404
|
+
"application/json": {
|
|
3405
|
+
/** @enum {string} */
|
|
3406
|
+
catalogVersion: "1.0.0";
|
|
3407
|
+
fixture: {
|
|
3408
|
+
data: {
|
|
3409
|
+
activity: [
|
|
3410
|
+
{
|
|
3411
|
+
/** @enum {string} */
|
|
3412
|
+
id: "synthetic-overview-activity-1";
|
|
3413
|
+
label: string;
|
|
3414
|
+
/** @enum {string} */
|
|
3415
|
+
status: "scheduled" | "published";
|
|
3416
|
+
},
|
|
3417
|
+
{
|
|
3418
|
+
/** @enum {string} */
|
|
3419
|
+
id: "synthetic-overview-activity-2";
|
|
3420
|
+
label: string;
|
|
3421
|
+
/** @enum {string} */
|
|
3422
|
+
status: "scheduled" | "published";
|
|
3423
|
+
}
|
|
3424
|
+
];
|
|
3425
|
+
headline: string;
|
|
3426
|
+
metrics: [
|
|
3427
|
+
{
|
|
3428
|
+
/** @enum {string} */
|
|
3429
|
+
key: "scheduled";
|
|
3430
|
+
label: string;
|
|
3431
|
+
value: number;
|
|
3432
|
+
},
|
|
3433
|
+
{
|
|
3434
|
+
/** @enum {string} */
|
|
3435
|
+
key: "published";
|
|
3436
|
+
label: string;
|
|
3437
|
+
value: number;
|
|
3438
|
+
},
|
|
3439
|
+
{
|
|
3440
|
+
/** @enum {string} */
|
|
3441
|
+
key: "engagements";
|
|
3442
|
+
label: string;
|
|
3443
|
+
value: number;
|
|
3444
|
+
}
|
|
3445
|
+
];
|
|
3446
|
+
};
|
|
3447
|
+
/** @enum {string} */
|
|
3448
|
+
effectMode: "NONE";
|
|
3449
|
+
/** @enum {string} */
|
|
3450
|
+
fixtureId: "synthetic-overview-v1";
|
|
3451
|
+
/** @enum {string} */
|
|
3452
|
+
fixtureVersion: "1.0.0";
|
|
3453
|
+
/** Format: date-time */
|
|
3454
|
+
observedAt: string;
|
|
3455
|
+
/** @enum {string} */
|
|
3456
|
+
schemaVersion: "1.0.0";
|
|
3457
|
+
/** @enum {string} */
|
|
3458
|
+
surface: "overview";
|
|
3459
|
+
/** @enum {boolean} */
|
|
3460
|
+
synthetic: true;
|
|
3461
|
+
} | {
|
|
3462
|
+
data: {
|
|
3463
|
+
items: [
|
|
3464
|
+
{
|
|
3465
|
+
/** @enum {string} */
|
|
3466
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3467
|
+
/** @enum {string} */
|
|
3468
|
+
id: "synthetic-calendar-item-1";
|
|
3469
|
+
/** Format: date-time */
|
|
3470
|
+
startsAt: string;
|
|
3471
|
+
/** @enum {string} */
|
|
3472
|
+
status: "draft" | "scheduled";
|
|
3473
|
+
title: string;
|
|
3474
|
+
},
|
|
3475
|
+
{
|
|
3476
|
+
/** @enum {string} */
|
|
3477
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3478
|
+
/** @enum {string} */
|
|
3479
|
+
id: "synthetic-calendar-item-2";
|
|
3480
|
+
/** Format: date-time */
|
|
3481
|
+
startsAt: string;
|
|
3482
|
+
/** @enum {string} */
|
|
3483
|
+
status: "draft" | "scheduled";
|
|
3484
|
+
title: string;
|
|
3485
|
+
}
|
|
3486
|
+
];
|
|
3487
|
+
/** @enum {string} */
|
|
3488
|
+
timeZone: "UTC";
|
|
3489
|
+
};
|
|
3490
|
+
/** @enum {string} */
|
|
3491
|
+
effectMode: "NONE";
|
|
3492
|
+
/** @enum {string} */
|
|
3493
|
+
fixtureId: "synthetic-calendar-v1";
|
|
3494
|
+
/** @enum {string} */
|
|
3495
|
+
fixtureVersion: "1.0.0";
|
|
3496
|
+
/** Format: date-time */
|
|
3497
|
+
observedAt: string;
|
|
3498
|
+
/** @enum {string} */
|
|
3499
|
+
schemaVersion: "1.0.0";
|
|
3500
|
+
/** @enum {string} */
|
|
3501
|
+
surface: "calendar";
|
|
3502
|
+
/** @enum {boolean} */
|
|
3503
|
+
synthetic: true;
|
|
3504
|
+
} | {
|
|
3505
|
+
data: {
|
|
3506
|
+
conversations: [
|
|
3507
|
+
{
|
|
3508
|
+
/** @enum {string} */
|
|
3509
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3510
|
+
displayName: string;
|
|
3511
|
+
/** @enum {string} */
|
|
3512
|
+
id: "synthetic-inbox-conversation-1";
|
|
3513
|
+
preview: string;
|
|
3514
|
+
unread: boolean;
|
|
3515
|
+
},
|
|
3516
|
+
{
|
|
3517
|
+
/** @enum {string} */
|
|
3518
|
+
channel: "bluesky" | "facebook" | "instagram" | "linkedin" | "mastodon" | "pinterest" | "reddit" | "telegram" | "threads" | "tiktok" | "x-twitter" | "youtube" | "google-business" | "snapchat" | "whatsapp" | "discord" | "site-plugin";
|
|
3519
|
+
displayName: string;
|
|
3520
|
+
/** @enum {string} */
|
|
3521
|
+
id: "synthetic-inbox-conversation-2";
|
|
3522
|
+
preview: string;
|
|
3523
|
+
unread: boolean;
|
|
3524
|
+
}
|
|
3525
|
+
];
|
|
3526
|
+
};
|
|
3527
|
+
/** @enum {string} */
|
|
3528
|
+
effectMode: "NONE";
|
|
3529
|
+
/** @enum {string} */
|
|
3530
|
+
fixtureId: "synthetic-inbox-v1";
|
|
3531
|
+
/** @enum {string} */
|
|
3532
|
+
fixtureVersion: "1.0.0";
|
|
3533
|
+
/** Format: date-time */
|
|
3534
|
+
observedAt: string;
|
|
3535
|
+
/** @enum {string} */
|
|
3536
|
+
schemaVersion: "1.0.0";
|
|
3537
|
+
/** @enum {string} */
|
|
3538
|
+
surface: "inbox";
|
|
3539
|
+
/** @enum {boolean} */
|
|
3540
|
+
synthetic: true;
|
|
3541
|
+
} | {
|
|
3542
|
+
data: {
|
|
3543
|
+
points: [
|
|
3544
|
+
{
|
|
3545
|
+
/**
|
|
3546
|
+
* Format: date
|
|
3547
|
+
* @enum {string}
|
|
3548
|
+
*/
|
|
3549
|
+
date: "2026-07-15";
|
|
3550
|
+
engagements: number;
|
|
3551
|
+
impressions: number;
|
|
3552
|
+
},
|
|
3553
|
+
{
|
|
3554
|
+
/**
|
|
3555
|
+
* Format: date
|
|
3556
|
+
* @enum {string}
|
|
3557
|
+
*/
|
|
3558
|
+
date: "2026-07-16";
|
|
3559
|
+
engagements: number;
|
|
3560
|
+
impressions: number;
|
|
3561
|
+
},
|
|
3562
|
+
{
|
|
3563
|
+
/**
|
|
3564
|
+
* Format: date
|
|
3565
|
+
* @enum {string}
|
|
3566
|
+
*/
|
|
3567
|
+
date: "2026-07-17";
|
|
3568
|
+
engagements: number;
|
|
3569
|
+
impressions: number;
|
|
3570
|
+
},
|
|
3571
|
+
{
|
|
3572
|
+
/**
|
|
3573
|
+
* Format: date
|
|
3574
|
+
* @enum {string}
|
|
3575
|
+
*/
|
|
3576
|
+
date: "2026-07-18";
|
|
3577
|
+
engagements: number;
|
|
3578
|
+
impressions: number;
|
|
3579
|
+
},
|
|
3580
|
+
{
|
|
3581
|
+
/**
|
|
3582
|
+
* Format: date
|
|
3583
|
+
* @enum {string}
|
|
3584
|
+
*/
|
|
3585
|
+
date: "2026-07-19";
|
|
3586
|
+
engagements: number;
|
|
3587
|
+
impressions: number;
|
|
3588
|
+
},
|
|
3589
|
+
{
|
|
3590
|
+
/**
|
|
3591
|
+
* Format: date
|
|
3592
|
+
* @enum {string}
|
|
3593
|
+
*/
|
|
3594
|
+
date: "2026-07-20";
|
|
3595
|
+
engagements: number;
|
|
3596
|
+
impressions: number;
|
|
3597
|
+
},
|
|
3598
|
+
{
|
|
3599
|
+
/**
|
|
3600
|
+
* Format: date
|
|
3601
|
+
* @enum {string}
|
|
3602
|
+
*/
|
|
3603
|
+
date: "2026-07-21";
|
|
3604
|
+
engagements: number;
|
|
3605
|
+
impressions: number;
|
|
3606
|
+
}
|
|
3607
|
+
];
|
|
3608
|
+
/** @enum {string} */
|
|
3609
|
+
range: "LAST_7_DAYS";
|
|
3610
|
+
};
|
|
3611
|
+
/** @enum {string} */
|
|
3612
|
+
effectMode: "NONE";
|
|
3613
|
+
/** @enum {string} */
|
|
3614
|
+
fixtureId: "synthetic-analytics-v1";
|
|
3615
|
+
/** @enum {string} */
|
|
3616
|
+
fixtureVersion: "1.0.0";
|
|
3617
|
+
/** Format: date-time */
|
|
3618
|
+
observedAt: string;
|
|
3619
|
+
/** @enum {string} */
|
|
3620
|
+
schemaVersion: "1.0.0";
|
|
3621
|
+
/** @enum {string} */
|
|
3622
|
+
surface: "analytics";
|
|
3623
|
+
/** @enum {boolean} */
|
|
3624
|
+
synthetic: true;
|
|
3625
|
+
} | {
|
|
3626
|
+
data: {
|
|
3627
|
+
campaigns: [
|
|
3628
|
+
{
|
|
3629
|
+
budgetMinor: string;
|
|
3630
|
+
/** @enum {string} */
|
|
3631
|
+
id: "synthetic-ads-campaign-1";
|
|
3632
|
+
name: string;
|
|
3633
|
+
projectedReach: number;
|
|
3634
|
+
/** @enum {string} */
|
|
3635
|
+
status: "draft" | "simulated";
|
|
3636
|
+
},
|
|
3637
|
+
{
|
|
3638
|
+
budgetMinor: string;
|
|
3639
|
+
/** @enum {string} */
|
|
3640
|
+
id: "synthetic-ads-campaign-2";
|
|
3641
|
+
name: string;
|
|
3642
|
+
projectedReach: number;
|
|
3643
|
+
/** @enum {string} */
|
|
3644
|
+
status: "draft" | "simulated";
|
|
3645
|
+
}
|
|
3646
|
+
];
|
|
3647
|
+
/** @enum {string} */
|
|
3648
|
+
currency: "USD";
|
|
3649
|
+
};
|
|
3650
|
+
/** @enum {string} */
|
|
3651
|
+
effectMode: "SIMULATION";
|
|
3652
|
+
/** @enum {string} */
|
|
3653
|
+
fixtureId: "synthetic-ads-v1";
|
|
3654
|
+
/** @enum {string} */
|
|
3655
|
+
fixtureVersion: "1.0.0";
|
|
3656
|
+
/** Format: date-time */
|
|
3657
|
+
observedAt: string;
|
|
3658
|
+
/** @enum {string} */
|
|
3659
|
+
schemaVersion: "1.0.0";
|
|
3660
|
+
/** @enum {string} */
|
|
3661
|
+
surface: "ads";
|
|
3662
|
+
/** @enum {boolean} */
|
|
3663
|
+
synthetic: true;
|
|
3664
|
+
} | {
|
|
3665
|
+
data: {
|
|
3666
|
+
workflows: [
|
|
3667
|
+
{
|
|
3668
|
+
/** @enum {string} */
|
|
3669
|
+
id: "synthetic-workflow-1";
|
|
3670
|
+
name: string;
|
|
3671
|
+
/** @enum {string} */
|
|
3672
|
+
status: "draft" | "simulated";
|
|
3673
|
+
steps: string[];
|
|
3674
|
+
trigger: string;
|
|
3675
|
+
},
|
|
3676
|
+
{
|
|
3677
|
+
/** @enum {string} */
|
|
3678
|
+
id: "synthetic-workflow-2";
|
|
3679
|
+
name: string;
|
|
3680
|
+
/** @enum {string} */
|
|
3681
|
+
status: "draft" | "simulated";
|
|
3682
|
+
steps: string[];
|
|
3683
|
+
trigger: string;
|
|
3684
|
+
}
|
|
3685
|
+
];
|
|
3686
|
+
};
|
|
3687
|
+
/** @enum {string} */
|
|
3688
|
+
effectMode: "SIMULATION";
|
|
3689
|
+
/** @enum {string} */
|
|
3690
|
+
fixtureId: "synthetic-workflows-v1";
|
|
3691
|
+
/** @enum {string} */
|
|
3692
|
+
fixtureVersion: "1.0.0";
|
|
3693
|
+
/** Format: date-time */
|
|
3694
|
+
observedAt: string;
|
|
3695
|
+
/** @enum {string} */
|
|
3696
|
+
schemaVersion: "1.0.0";
|
|
3697
|
+
/** @enum {string} */
|
|
3698
|
+
surface: "workflows";
|
|
3699
|
+
/** @enum {boolean} */
|
|
3700
|
+
synthetic: true;
|
|
3701
|
+
};
|
|
3702
|
+
/** @enum {string} */
|
|
3703
|
+
schemaVersion: "1.0.0";
|
|
3704
|
+
sourceDigest: string;
|
|
3705
|
+
};
|
|
3706
|
+
};
|
|
3707
|
+
};
|
|
3708
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
3709
|
+
304: {
|
|
3710
|
+
headers: {
|
|
3711
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3712
|
+
"Cache-Control": string;
|
|
3713
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3714
|
+
ETag: string;
|
|
3715
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3716
|
+
Vary: string;
|
|
3717
|
+
[name: string]: unknown;
|
|
3718
|
+
};
|
|
3719
|
+
content?: never;
|
|
3720
|
+
};
|
|
3721
|
+
/** @description The public request input is invalid. */
|
|
3722
|
+
400: {
|
|
3723
|
+
headers: {
|
|
3724
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3725
|
+
"Cache-Control": "no-store";
|
|
3726
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3727
|
+
Vary: string;
|
|
3728
|
+
[name: string]: unknown;
|
|
3729
|
+
};
|
|
3730
|
+
content: {
|
|
3731
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
3732
|
+
};
|
|
3733
|
+
};
|
|
3734
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
3735
|
+
404: {
|
|
3736
|
+
headers: {
|
|
3737
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3738
|
+
"Cache-Control": "no-store";
|
|
3739
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3740
|
+
Vary: string;
|
|
3741
|
+
[name: string]: unknown;
|
|
3742
|
+
};
|
|
3743
|
+
content: {
|
|
3744
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
3745
|
+
};
|
|
3746
|
+
};
|
|
3747
|
+
/** @description The shared public-read rate limit was reached. */
|
|
3748
|
+
429: {
|
|
3749
|
+
headers: {
|
|
3750
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3751
|
+
"Cache-Control": "no-store";
|
|
3752
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
3753
|
+
"Retry-After": string;
|
|
3754
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3755
|
+
Vary: string;
|
|
3756
|
+
[name: string]: unknown;
|
|
3757
|
+
};
|
|
3758
|
+
content: {
|
|
3759
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
3760
|
+
};
|
|
3761
|
+
};
|
|
3762
|
+
/** @description The public request failed without exposing internal details. */
|
|
3763
|
+
500: {
|
|
3764
|
+
headers: {
|
|
3765
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3766
|
+
"Cache-Control": "no-store";
|
|
3767
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3768
|
+
Vary: string;
|
|
3769
|
+
[name: string]: unknown;
|
|
3770
|
+
};
|
|
3771
|
+
content: {
|
|
3772
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
3773
|
+
};
|
|
3774
|
+
};
|
|
3775
|
+
};
|
|
3776
|
+
};
|
|
3777
|
+
PublicCatalog_pricing: {
|
|
3778
|
+
parameters: {
|
|
3779
|
+
query?: never;
|
|
3780
|
+
header?: {
|
|
3781
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
3782
|
+
"If-None-Match"?: string;
|
|
3783
|
+
};
|
|
3784
|
+
path?: never;
|
|
3785
|
+
cookie?: never;
|
|
3786
|
+
};
|
|
3787
|
+
requestBody?: never;
|
|
3788
|
+
responses: {
|
|
3789
|
+
/** @description Versioned public OxChannels pricing and assumptions. */
|
|
3790
|
+
200: {
|
|
3791
|
+
headers: {
|
|
3792
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3793
|
+
"Cache-Control": string;
|
|
3794
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3795
|
+
ETag: string;
|
|
3796
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3797
|
+
Vary: string;
|
|
3798
|
+
[name: string]: unknown;
|
|
3799
|
+
};
|
|
3800
|
+
content: {
|
|
3801
|
+
"application/json": {
|
|
3802
|
+
/** @enum {string} */
|
|
3803
|
+
catalogVersion: "1.0.0";
|
|
3804
|
+
pricing: {
|
|
3805
|
+
/** @enum {string} */
|
|
3806
|
+
accountBaseAmountMicros: "0";
|
|
3807
|
+
/** @enum {string} */
|
|
3808
|
+
currency: "USD";
|
|
3809
|
+
/**
|
|
3810
|
+
* Format: date
|
|
3811
|
+
* @enum {string}
|
|
3812
|
+
*/
|
|
3813
|
+
effectiveFrom: "2026-07-21";
|
|
3814
|
+
/** @enum {integer} */
|
|
3815
|
+
minorUnitExponent: 2;
|
|
3816
|
+
/** @enum {string} */
|
|
3817
|
+
plan: "FREE";
|
|
3818
|
+
/** @enum {string} */
|
|
3819
|
+
pricingModel: "GRADUATED";
|
|
3820
|
+
/** @enum {string} */
|
|
3821
|
+
proration: "REMAINING_FIXED_PERIOD";
|
|
3822
|
+
providerPassThrough: {
|
|
3823
|
+
/** @enum {string} */
|
|
3824
|
+
currencyPolicy: "SAME_CURRENCY_ONLY";
|
|
3825
|
+
/** @enum {boolean} */
|
|
3826
|
+
fxApplied: false;
|
|
3827
|
+
/** @enum {boolean} */
|
|
3828
|
+
includedInOxchannelsFee: false;
|
|
3829
|
+
/** @enum {string} */
|
|
3830
|
+
mode: "CALLER_SUPPLIED_DYNAMIC";
|
|
3831
|
+
};
|
|
3832
|
+
/** @enum {string} */
|
|
3833
|
+
rounding: "HALF_UP_AGGREGATE";
|
|
3834
|
+
/** @enum {string} */
|
|
3835
|
+
schemaVersion: "1.0.0";
|
|
3836
|
+
tiers: [
|
|
3837
|
+
{
|
|
3838
|
+
/** @enum {string} */
|
|
3839
|
+
flatAmountMicros: "0";
|
|
3840
|
+
/** @enum {string} */
|
|
3841
|
+
fromInclusive: "1";
|
|
3842
|
+
/** @enum {string} */
|
|
3843
|
+
unitAmountMicros: "0";
|
|
3844
|
+
/** @enum {string} */
|
|
3845
|
+
upToInclusive: "8000";
|
|
3846
|
+
},
|
|
3847
|
+
{
|
|
3848
|
+
/** @enum {string} */
|
|
3849
|
+
flatAmountMicros: "0";
|
|
3850
|
+
/** @enum {string} */
|
|
3851
|
+
fromInclusive: "8001";
|
|
3852
|
+
/** @enum {string} */
|
|
3853
|
+
unitAmountMicros: "0";
|
|
3854
|
+
/** @enum {string} */
|
|
3855
|
+
upToInclusive: "10000";
|
|
3856
|
+
}
|
|
3857
|
+
];
|
|
3858
|
+
/** @enum {string} */
|
|
3859
|
+
usageDimension: "API_CALL";
|
|
3860
|
+
usageThresholds: {
|
|
3861
|
+
/** @enum {string} */
|
|
3862
|
+
hardLimit: "10000";
|
|
3863
|
+
/** @enum {string} */
|
|
3864
|
+
softLimit: "8000";
|
|
3865
|
+
};
|
|
3866
|
+
/** @enum {string} */
|
|
3867
|
+
version: "1.0.0";
|
|
3868
|
+
};
|
|
3869
|
+
/** @enum {string} */
|
|
3870
|
+
schemaVersion: "1.0.0";
|
|
3871
|
+
sourceDigest: string;
|
|
3872
|
+
};
|
|
3873
|
+
};
|
|
3874
|
+
};
|
|
3875
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
3876
|
+
304: {
|
|
3877
|
+
headers: {
|
|
3878
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3879
|
+
"Cache-Control": string;
|
|
3880
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3881
|
+
ETag: string;
|
|
3882
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3883
|
+
Vary: string;
|
|
3884
|
+
[name: string]: unknown;
|
|
3885
|
+
};
|
|
3886
|
+
content?: never;
|
|
3887
|
+
};
|
|
3888
|
+
/** @description The public request input is invalid. */
|
|
3889
|
+
400: {
|
|
3890
|
+
headers: {
|
|
3891
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3892
|
+
"Cache-Control": "no-store";
|
|
3893
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3894
|
+
Vary: string;
|
|
3895
|
+
[name: string]: unknown;
|
|
3896
|
+
};
|
|
3897
|
+
content: {
|
|
3898
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
3899
|
+
};
|
|
3900
|
+
};
|
|
3901
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
3902
|
+
404: {
|
|
3903
|
+
headers: {
|
|
3904
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3905
|
+
"Cache-Control": "no-store";
|
|
3906
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3907
|
+
Vary: string;
|
|
3908
|
+
[name: string]: unknown;
|
|
3909
|
+
};
|
|
3910
|
+
content: {
|
|
3911
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
3912
|
+
};
|
|
3913
|
+
};
|
|
3914
|
+
/** @description The shared public-read rate limit was reached. */
|
|
3915
|
+
429: {
|
|
3916
|
+
headers: {
|
|
3917
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3918
|
+
"Cache-Control": "no-store";
|
|
3919
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
3920
|
+
"Retry-After": string;
|
|
3921
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3922
|
+
Vary: string;
|
|
3923
|
+
[name: string]: unknown;
|
|
3924
|
+
};
|
|
3925
|
+
content: {
|
|
3926
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
3927
|
+
};
|
|
3928
|
+
};
|
|
3929
|
+
/** @description The public request failed without exposing internal details. */
|
|
3930
|
+
500: {
|
|
3931
|
+
headers: {
|
|
3932
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
3933
|
+
"Cache-Control": "no-store";
|
|
3934
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
3935
|
+
Vary: string;
|
|
3936
|
+
[name: string]: unknown;
|
|
3937
|
+
};
|
|
3938
|
+
content: {
|
|
3939
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
3940
|
+
};
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
};
|
|
3944
|
+
PublicCatalog_calculatePricing: {
|
|
3945
|
+
parameters: {
|
|
3946
|
+
query: {
|
|
3947
|
+
/** @description Canonical UTC instant with exactly three fractional digits. periodStart, periodEnd and effectiveAt must be supplied together or all omitted. periodEnd must be later than periodStart, effectiveAt must fall within the inclusive periodStart-to-periodEnd range, and effectiveAt cannot precede pricing effectiveFrom 2026-07-21. When all three fields are omitted, no proration is applied and the response still identifies the applicable pricing effectiveFrom date. */
|
|
3948
|
+
effectiveAt?: string;
|
|
3949
|
+
/** @description Canonical UTC instant with exactly three fractional digits. periodStart, periodEnd and effectiveAt must be supplied together or all omitted. periodEnd must be later than periodStart, effectiveAt must fall within the inclusive periodStart-to-periodEnd range, and effectiveAt cannot precede pricing effectiveFrom 2026-07-21. When all three fields are omitted, no proration is applied and the response still identifies the applicable pricing effectiveFrom date. */
|
|
3950
|
+
periodEnd?: string;
|
|
3951
|
+
/** @description Canonical UTC instant with exactly three fractional digits. periodStart, periodEnd and effectiveAt must be supplied together or all omitted. periodEnd must be later than periodStart, effectiveAt must fall within the inclusive periodStart-to-periodEnd range, and effectiveAt cannot precede pricing effectiveFrom 2026-07-21. When all three fields are omitted, no proration is applied and the response still identifies the applicable pricing effectiveFrom date. */
|
|
3952
|
+
periodStart?: string;
|
|
3953
|
+
providerPassThroughAmountMinor?: string;
|
|
3954
|
+
quantity: string;
|
|
3955
|
+
};
|
|
3956
|
+
header?: {
|
|
3957
|
+
/** @description RFC 9110 entity-tag condition evaluated with weak comparison after request validation. Accepts one tag, a comma-separated tag list, or wildcard *. Request Cache-Control directives do not override a matching validator. */
|
|
3958
|
+
"If-None-Match"?: string;
|
|
3959
|
+
};
|
|
3960
|
+
path?: never;
|
|
3961
|
+
cookie?: never;
|
|
3962
|
+
};
|
|
3963
|
+
requestBody?: never;
|
|
3964
|
+
responses: {
|
|
3965
|
+
/** @description Deterministic public pricing and proration result. */
|
|
3966
|
+
200: {
|
|
3967
|
+
headers: {
|
|
3968
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
3969
|
+
"Cache-Control": string;
|
|
3970
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
3971
|
+
ETag: string;
|
|
3972
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
3973
|
+
Vary: string;
|
|
3974
|
+
[name: string]: unknown;
|
|
3975
|
+
};
|
|
3976
|
+
content: {
|
|
3977
|
+
"application/json": {
|
|
3978
|
+
/** @enum {string} */
|
|
3979
|
+
catalogVersion: "1.0.0";
|
|
3980
|
+
pricing: {
|
|
3981
|
+
/**
|
|
3982
|
+
* Format: date
|
|
3983
|
+
* @enum {string}
|
|
3984
|
+
*/
|
|
3985
|
+
effectiveFrom: "2026-07-21";
|
|
3986
|
+
oxchannelsFee: {
|
|
3987
|
+
/** @enum {string} */
|
|
3988
|
+
amountMicros: "0";
|
|
3989
|
+
/** @enum {string} */
|
|
3990
|
+
amountMinor: "0";
|
|
3991
|
+
/** @enum {string} */
|
|
3992
|
+
currency: "USD";
|
|
3993
|
+
/** @enum {string} */
|
|
3994
|
+
fullPeriodAccountBaseAmountMicros: "0";
|
|
3995
|
+
/** @enum {string} */
|
|
3996
|
+
fullPeriodAmountMicros: "0";
|
|
3997
|
+
/** @enum {string} */
|
|
3998
|
+
fullPeriodUsageAmountMicros: "0";
|
|
3999
|
+
proration: {
|
|
4000
|
+
durationMilliseconds: string;
|
|
4001
|
+
/** Format: date-time */
|
|
4002
|
+
effectiveAt: string;
|
|
4003
|
+
/** Format: date-time */
|
|
4004
|
+
periodEnd: string;
|
|
4005
|
+
/** Format: date-time */
|
|
4006
|
+
periodStart: string;
|
|
4007
|
+
remainingMilliseconds: string;
|
|
4008
|
+
} | null;
|
|
4009
|
+
/** @enum {string} */
|
|
4010
|
+
rounding: "HALF_UP_AGGREGATE";
|
|
4011
|
+
};
|
|
4012
|
+
/** @enum {string} */
|
|
4013
|
+
pricingVersion: "1.0.0";
|
|
4014
|
+
providerPassThrough: {
|
|
4015
|
+
amountMinor: null;
|
|
4016
|
+
/** @enum {string} */
|
|
4017
|
+
currency: "USD";
|
|
4018
|
+
/** @enum {boolean} */
|
|
4019
|
+
fxApplied: false;
|
|
4020
|
+
/** @enum {boolean} */
|
|
4021
|
+
includedInOxchannelsFee: false;
|
|
4022
|
+
/** @enum {string} */
|
|
4023
|
+
mode: "NOT_SUPPLIED";
|
|
4024
|
+
} | {
|
|
4025
|
+
amountMinor: string;
|
|
4026
|
+
/** @enum {string} */
|
|
4027
|
+
currency: "USD";
|
|
4028
|
+
/** @enum {boolean} */
|
|
4029
|
+
fxApplied: false;
|
|
4030
|
+
/** @enum {boolean} */
|
|
4031
|
+
includedInOxchannelsFee: false;
|
|
4032
|
+
/** @enum {string} */
|
|
4033
|
+
mode: "CALLER_SUPPLIED_DYNAMIC";
|
|
4034
|
+
};
|
|
4035
|
+
quantity: string;
|
|
4036
|
+
};
|
|
4037
|
+
/** @enum {string} */
|
|
4038
|
+
schemaVersion: "1.0.0";
|
|
4039
|
+
sourceDigest: string;
|
|
4040
|
+
};
|
|
4041
|
+
};
|
|
4042
|
+
};
|
|
4043
|
+
/** @description The cached public representation is current; no response body is sent. */
|
|
4044
|
+
304: {
|
|
4045
|
+
headers: {
|
|
4046
|
+
/** @description Shared-cache policy for immutable public product metadata. */
|
|
4047
|
+
"Cache-Control": string;
|
|
4048
|
+
/** @description Strong validator derived from the exact public response representation. */
|
|
4049
|
+
ETag: string;
|
|
4050
|
+
/** @description Separates CORS origins and negotiated contract representations. */
|
|
4051
|
+
Vary: string;
|
|
4052
|
+
[name: string]: unknown;
|
|
4053
|
+
};
|
|
4054
|
+
content?: never;
|
|
4055
|
+
};
|
|
4056
|
+
/** @description The public request input is invalid. */
|
|
4057
|
+
400: {
|
|
4058
|
+
headers: {
|
|
4059
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
4060
|
+
"Cache-Control": "no-store";
|
|
4061
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
4062
|
+
Vary: string;
|
|
4063
|
+
[name: string]: unknown;
|
|
4064
|
+
};
|
|
4065
|
+
content: {
|
|
4066
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InvalidRequest"];
|
|
4067
|
+
};
|
|
4068
|
+
};
|
|
4069
|
+
/** @description The requested public provider or fixture is unavailable. */
|
|
4070
|
+
404: {
|
|
4071
|
+
headers: {
|
|
4072
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
4073
|
+
"Cache-Control": "no-store";
|
|
4074
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
4075
|
+
Vary: string;
|
|
4076
|
+
[name: string]: unknown;
|
|
4077
|
+
};
|
|
4078
|
+
content: {
|
|
4079
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2NotFound"];
|
|
4080
|
+
};
|
|
4081
|
+
};
|
|
4082
|
+
/** @description The shared public-read rate limit was reached. */
|
|
4083
|
+
429: {
|
|
4084
|
+
headers: {
|
|
4085
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
4086
|
+
"Cache-Control": "no-store";
|
|
4087
|
+
/** @description Remaining whole seconds in the active fixed rate-limit window. */
|
|
4088
|
+
"Retry-After": string;
|
|
4089
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
4090
|
+
Vary: string;
|
|
4091
|
+
[name: string]: unknown;
|
|
4092
|
+
};
|
|
4093
|
+
content: {
|
|
4094
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2RateLimited"];
|
|
4095
|
+
};
|
|
4096
|
+
};
|
|
4097
|
+
/** @description The public request failed without exposing internal details. */
|
|
4098
|
+
500: {
|
|
4099
|
+
headers: {
|
|
4100
|
+
/** @description Public error representations are never stored by browsers or shared caches. */
|
|
4101
|
+
"Cache-Control": "no-store";
|
|
4102
|
+
/** @description Includes OxChannels-Contract-Set so negotiated v1 and v2 error envelopes cannot share a cache entry. CORS middleware may also include Origin. */
|
|
4103
|
+
Vary: string;
|
|
4104
|
+
[name: string]: unknown;
|
|
4105
|
+
};
|
|
4106
|
+
content: {
|
|
4107
|
+
"application/json": components["schemas"]["ErrorEnvelopeV2InternalSafeFailure"];
|
|
4108
|
+
};
|
|
4109
|
+
};
|
|
4110
|
+
};
|
|
4111
|
+
};
|
|
4112
|
+
}
|