@freedome/protocol 1.1.0 → 1.2.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/CHANGELOG.md +6 -0
- package/dist/index.cjs +140 -7
- package/dist/index.d.cts +2209 -112
- package/dist/index.d.ts +2209 -112
- package/dist/index.js +140 -7
- package/dist/validate.cjs +526 -0
- package/dist/validate.js +526 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -748,6 +748,114 @@ type paths$1 = {
|
|
|
748
748
|
patch: operations$1['patchUser'];
|
|
749
749
|
trace?: never;
|
|
750
750
|
};
|
|
751
|
+
'/assistant/confirmations': {
|
|
752
|
+
parameters: {
|
|
753
|
+
query?: never;
|
|
754
|
+
header?: never;
|
|
755
|
+
path?: never;
|
|
756
|
+
cookie?: never;
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* Pending physical actions, with their codes
|
|
760
|
+
* @description The code is in `code` only for a person: a sign-in session or a paired Manager, with role `operator` or higher. Plain API
|
|
761
|
+
* keys, which are what an assistant holds, see the list without it, and such keys are the only credentials `/mcp` takes.
|
|
762
|
+
*/
|
|
763
|
+
get: operations$1['listAssistantConfirmations'];
|
|
764
|
+
put?: never;
|
|
765
|
+
post?: never;
|
|
766
|
+
delete?: never;
|
|
767
|
+
options?: never;
|
|
768
|
+
head?: never;
|
|
769
|
+
patch?: never;
|
|
770
|
+
trace?: never;
|
|
771
|
+
};
|
|
772
|
+
'/assistant/confirmations/{confirmationId}/refuse': {
|
|
773
|
+
parameters: {
|
|
774
|
+
query?: never;
|
|
775
|
+
header?: never;
|
|
776
|
+
path: {
|
|
777
|
+
/** @description Confirmation id. */
|
|
778
|
+
confirmationId: string;
|
|
779
|
+
};
|
|
780
|
+
cookie?: never;
|
|
781
|
+
};
|
|
782
|
+
get?: never;
|
|
783
|
+
put?: never;
|
|
784
|
+
/**
|
|
785
|
+
* Refuse a pending physical action
|
|
786
|
+
* @description The code stops working at once; the assistant is told `confirmation_refused`.
|
|
787
|
+
*/
|
|
788
|
+
post: operations$1['refuseAssistantConfirmation'];
|
|
789
|
+
delete?: never;
|
|
790
|
+
options?: never;
|
|
791
|
+
head?: never;
|
|
792
|
+
patch?: never;
|
|
793
|
+
trace?: never;
|
|
794
|
+
};
|
|
795
|
+
'/assistant/link': {
|
|
796
|
+
parameters: {
|
|
797
|
+
query?: never;
|
|
798
|
+
header?: never;
|
|
799
|
+
path?: never;
|
|
800
|
+
cookie?: never;
|
|
801
|
+
};
|
|
802
|
+
/**
|
|
803
|
+
* State of the outbound link and its approvals
|
|
804
|
+
* @description `[cloud_link] enabled = false` gives `enabled: false` and `state: off`.
|
|
805
|
+
*/
|
|
806
|
+
get: operations$1['getAssistantLink'];
|
|
807
|
+
put?: never;
|
|
808
|
+
post?: never;
|
|
809
|
+
delete?: never;
|
|
810
|
+
options?: never;
|
|
811
|
+
head?: never;
|
|
812
|
+
patch?: never;
|
|
813
|
+
trace?: never;
|
|
814
|
+
};
|
|
815
|
+
'/assistant/link/approvals': {
|
|
816
|
+
parameters: {
|
|
817
|
+
query?: never;
|
|
818
|
+
header?: never;
|
|
819
|
+
path?: never;
|
|
820
|
+
cookie?: never;
|
|
821
|
+
};
|
|
822
|
+
get?: never;
|
|
823
|
+
put?: never;
|
|
824
|
+
/**
|
|
825
|
+
* Approve a link code shown by the assistant
|
|
826
|
+
* @description Role `operator` or higher, as a person (see listAssistantConfirmations). The approval lasts 8 hours, and the link gets the
|
|
827
|
+
* scopes of the person who approved it, no more. The code goes to the cloud over the link; a wrong one gets 422.
|
|
828
|
+
*/
|
|
829
|
+
post: operations$1['approveAssistantLink'];
|
|
830
|
+
delete?: never;
|
|
831
|
+
options?: never;
|
|
832
|
+
head?: never;
|
|
833
|
+
patch?: never;
|
|
834
|
+
trace?: never;
|
|
835
|
+
};
|
|
836
|
+
'/assistant/link/sessions/{sessionId}': {
|
|
837
|
+
parameters: {
|
|
838
|
+
query?: never;
|
|
839
|
+
header?: never;
|
|
840
|
+
path: {
|
|
841
|
+
/** @description Approval id. */
|
|
842
|
+
sessionId: string;
|
|
843
|
+
};
|
|
844
|
+
cookie?: never;
|
|
845
|
+
};
|
|
846
|
+
get?: never;
|
|
847
|
+
put?: never;
|
|
848
|
+
post?: never;
|
|
849
|
+
/**
|
|
850
|
+
* End an approval now
|
|
851
|
+
* @description Live tools of this approval answer `not_linked` from this moment.
|
|
852
|
+
*/
|
|
853
|
+
delete: operations$1['endAssistantLink'];
|
|
854
|
+
options?: never;
|
|
855
|
+
head?: never;
|
|
856
|
+
patch?: never;
|
|
857
|
+
trace?: never;
|
|
858
|
+
};
|
|
751
859
|
'/api-keys': {
|
|
752
860
|
parameters: {
|
|
753
861
|
query?: never;
|
|
@@ -4135,6 +4243,58 @@ type components$1 = {
|
|
|
4135
4243
|
role?: components$1['schemas']['role'];
|
|
4136
4244
|
disabled?: boolean;
|
|
4137
4245
|
};
|
|
4246
|
+
/** @description A physical action waiting for a person. The code hash stays on the venue and is never part of this shape. */
|
|
4247
|
+
confirmation: {
|
|
4248
|
+
id: string;
|
|
4249
|
+
tool: string;
|
|
4250
|
+
/** @constant */
|
|
4251
|
+
risk: 'physical';
|
|
4252
|
+
/** @description What will happen, in plain words, made on the venue from the tool and its arguments. */
|
|
4253
|
+
text: string;
|
|
4254
|
+
argumentsHash: string;
|
|
4255
|
+
/** @enum {unknown} */
|
|
4256
|
+
via: 'local' | 'link';
|
|
4257
|
+
/** @description The approval it came through, when `via` is `link`. */
|
|
4258
|
+
sessionId?: string;
|
|
4259
|
+
/** Format: date-time */
|
|
4260
|
+
createdAt: string;
|
|
4261
|
+
/** Format: date-time */
|
|
4262
|
+
expiresAt: string;
|
|
4263
|
+
/** @enum {unknown} */
|
|
4264
|
+
status: 'pending' | 'confirmed' | 'expired' | 'refused';
|
|
4265
|
+
/** @description Only for a person, and only while `pending`. */
|
|
4266
|
+
code?: string;
|
|
4267
|
+
};
|
|
4268
|
+
confirmationPage: {
|
|
4269
|
+
items: components$1['schemas']['confirmation'][];
|
|
4270
|
+
nextCursor: string | null;
|
|
4271
|
+
};
|
|
4272
|
+
/** @description One approval: who gave it, what it may do, until when. */
|
|
4273
|
+
linkSession: {
|
|
4274
|
+
id: string;
|
|
4275
|
+
approver: string;
|
|
4276
|
+
/** @enum {unknown} */
|
|
4277
|
+
role: 'operator' | 'admin' | 'superadmin';
|
|
4278
|
+
scopes: string[];
|
|
4279
|
+
/** Format: date-time */
|
|
4280
|
+
createdAt: string;
|
|
4281
|
+
/** Format: date-time */
|
|
4282
|
+
expiresAt: string;
|
|
4283
|
+
/** @enum {unknown} */
|
|
4284
|
+
status: 'active' | 'ended' | 'expired';
|
|
4285
|
+
calls: number;
|
|
4286
|
+
};
|
|
4287
|
+
link: {
|
|
4288
|
+
enabled: boolean;
|
|
4289
|
+
/** @enum {unknown} */
|
|
4290
|
+
state: 'off' | 'connecting' | 'online' | 'offline';
|
|
4291
|
+
installationId?: string;
|
|
4292
|
+
sessions: components$1['schemas']['linkSession'][];
|
|
4293
|
+
};
|
|
4294
|
+
linkApprove: {
|
|
4295
|
+
/** @description The code the assistant showed. */
|
|
4296
|
+
code: string;
|
|
4297
|
+
};
|
|
4138
4298
|
keyId: string;
|
|
4139
4299
|
apiKey: {
|
|
4140
4300
|
id: components$1['schemas']['keyId'];
|
|
@@ -10284,6 +10444,212 @@ interface operations$1 {
|
|
|
10284
10444
|
default: components$1['responses']['Problem'];
|
|
10285
10445
|
};
|
|
10286
10446
|
};
|
|
10447
|
+
listAssistantConfirmations: {
|
|
10448
|
+
parameters: {
|
|
10449
|
+
query?: {
|
|
10450
|
+
/** @description Page size (default 50, max 500). */
|
|
10451
|
+
limit?: components$1['parameters']['Limit'];
|
|
10452
|
+
/** @description Opaque cursor from the previous page's `nextCursor`. */
|
|
10453
|
+
cursor?: components$1['parameters']['Cursor'];
|
|
10454
|
+
};
|
|
10455
|
+
header?: never;
|
|
10456
|
+
path?: never;
|
|
10457
|
+
cookie?: never;
|
|
10458
|
+
};
|
|
10459
|
+
requestBody?: never;
|
|
10460
|
+
responses: {
|
|
10461
|
+
/** @description Pending confirmations, newest first. */
|
|
10462
|
+
200: {
|
|
10463
|
+
headers: {
|
|
10464
|
+
[name: string]: unknown;
|
|
10465
|
+
};
|
|
10466
|
+
content: {
|
|
10467
|
+
/**
|
|
10468
|
+
* @example {
|
|
10469
|
+
* "items": [
|
|
10470
|
+
* {
|
|
10471
|
+
* "id": "01J9Z3K7Q2",
|
|
10472
|
+
* "tool": "player_play",
|
|
10473
|
+
* "risk": "physical",
|
|
10474
|
+
* "text": "Start playback of player main in venue default.",
|
|
10475
|
+
* "argumentsHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
|
|
10476
|
+
* "via": "link",
|
|
10477
|
+
* "sessionId": "01J9Z3K7Q3",
|
|
10478
|
+
* "createdAt": "2026-11-07T12:00:00.000Z",
|
|
10479
|
+
* "expiresAt": "2026-11-07T12:02:00.000Z",
|
|
10480
|
+
* "status": "pending",
|
|
10481
|
+
* "code": "4821"
|
|
10482
|
+
* }
|
|
10483
|
+
* ],
|
|
10484
|
+
* "nextCursor": null
|
|
10485
|
+
* }
|
|
10486
|
+
*/
|
|
10487
|
+
'application/json': components$1['schemas']['confirmationPage'];
|
|
10488
|
+
};
|
|
10489
|
+
};
|
|
10490
|
+
403: components$1['responses']['Problem'];
|
|
10491
|
+
default: components$1['responses']['Problem'];
|
|
10492
|
+
};
|
|
10493
|
+
};
|
|
10494
|
+
refuseAssistantConfirmation: {
|
|
10495
|
+
parameters: {
|
|
10496
|
+
query?: never;
|
|
10497
|
+
header?: never;
|
|
10498
|
+
path: {
|
|
10499
|
+
/** @description Confirmation id. */
|
|
10500
|
+
confirmationId: string;
|
|
10501
|
+
};
|
|
10502
|
+
cookie?: never;
|
|
10503
|
+
};
|
|
10504
|
+
requestBody?: never;
|
|
10505
|
+
responses: {
|
|
10506
|
+
/** @description Refused. */
|
|
10507
|
+
200: {
|
|
10508
|
+
headers: {
|
|
10509
|
+
[name: string]: unknown;
|
|
10510
|
+
};
|
|
10511
|
+
content: {
|
|
10512
|
+
/**
|
|
10513
|
+
* @example {
|
|
10514
|
+
* "id": "01J9Z3K7Q2",
|
|
10515
|
+
* "tool": "player_play",
|
|
10516
|
+
* "risk": "physical",
|
|
10517
|
+
* "text": "Start playback of player main in venue default.",
|
|
10518
|
+
* "argumentsHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
|
|
10519
|
+
* "via": "link",
|
|
10520
|
+
* "createdAt": "2026-11-07T12:00:00.000Z",
|
|
10521
|
+
* "expiresAt": "2026-11-07T12:02:00.000Z",
|
|
10522
|
+
* "status": "refused"
|
|
10523
|
+
* }
|
|
10524
|
+
*/
|
|
10525
|
+
'application/json': components$1['schemas']['confirmation'];
|
|
10526
|
+
};
|
|
10527
|
+
};
|
|
10528
|
+
403: components$1['responses']['Problem'];
|
|
10529
|
+
404: components$1['responses']['Problem'];
|
|
10530
|
+
409: components$1['responses']['Problem'];
|
|
10531
|
+
default: components$1['responses']['Problem'];
|
|
10532
|
+
};
|
|
10533
|
+
};
|
|
10534
|
+
getAssistantLink: {
|
|
10535
|
+
parameters: {
|
|
10536
|
+
query?: never;
|
|
10537
|
+
header?: never;
|
|
10538
|
+
path?: never;
|
|
10539
|
+
cookie?: never;
|
|
10540
|
+
};
|
|
10541
|
+
requestBody?: never;
|
|
10542
|
+
responses: {
|
|
10543
|
+
/** @description The link. */
|
|
10544
|
+
200: {
|
|
10545
|
+
headers: {
|
|
10546
|
+
[name: string]: unknown;
|
|
10547
|
+
};
|
|
10548
|
+
content: {
|
|
10549
|
+
/**
|
|
10550
|
+
* @example {
|
|
10551
|
+
* "enabled": true,
|
|
10552
|
+
* "state": "online",
|
|
10553
|
+
* "installationId": "7f3a9c52-1f0e-4f6e-9a3e-0d5b3c1f8a11",
|
|
10554
|
+
* "sessions": [
|
|
10555
|
+
* {
|
|
10556
|
+
* "id": "01J9Z3K7Q3",
|
|
10557
|
+
* "approver": "jwt:u1",
|
|
10558
|
+
* "role": "operator",
|
|
10559
|
+
* "scopes": [
|
|
10560
|
+
* "info:read",
|
|
10561
|
+
* "playback:read",
|
|
10562
|
+
* "playback:control"
|
|
10563
|
+
* ],
|
|
10564
|
+
* "createdAt": "2026-11-07T12:00:00.000Z",
|
|
10565
|
+
* "expiresAt": "2026-11-07T20:00:00.000Z",
|
|
10566
|
+
* "status": "active",
|
|
10567
|
+
* "calls": 12
|
|
10568
|
+
* }
|
|
10569
|
+
* ]
|
|
10570
|
+
* }
|
|
10571
|
+
*/
|
|
10572
|
+
'application/json': components$1['schemas']['link'];
|
|
10573
|
+
};
|
|
10574
|
+
};
|
|
10575
|
+
403: components$1['responses']['Problem'];
|
|
10576
|
+
default: components$1['responses']['Problem'];
|
|
10577
|
+
};
|
|
10578
|
+
};
|
|
10579
|
+
approveAssistantLink: {
|
|
10580
|
+
parameters: {
|
|
10581
|
+
query?: never;
|
|
10582
|
+
header?: never;
|
|
10583
|
+
path?: never;
|
|
10584
|
+
cookie?: never;
|
|
10585
|
+
};
|
|
10586
|
+
requestBody: {
|
|
10587
|
+
content: {
|
|
10588
|
+
/**
|
|
10589
|
+
* @example {
|
|
10590
|
+
* "code": "7KQM-2XVB"
|
|
10591
|
+
* }
|
|
10592
|
+
*/
|
|
10593
|
+
'application/json': components$1['schemas']['linkApprove'];
|
|
10594
|
+
};
|
|
10595
|
+
};
|
|
10596
|
+
responses: {
|
|
10597
|
+
/** @description Approved. */
|
|
10598
|
+
201: {
|
|
10599
|
+
headers: {
|
|
10600
|
+
[name: string]: unknown;
|
|
10601
|
+
};
|
|
10602
|
+
content: {
|
|
10603
|
+
/**
|
|
10604
|
+
* @example {
|
|
10605
|
+
* "id": "01J9Z3K7Q3",
|
|
10606
|
+
* "approver": "jwt:u1",
|
|
10607
|
+
* "role": "operator",
|
|
10608
|
+
* "scopes": [
|
|
10609
|
+
* "info:read",
|
|
10610
|
+
* "playback:read",
|
|
10611
|
+
* "playback:control"
|
|
10612
|
+
* ],
|
|
10613
|
+
* "createdAt": "2026-11-07T12:00:00.000Z",
|
|
10614
|
+
* "expiresAt": "2026-11-07T20:00:00.000Z",
|
|
10615
|
+
* "status": "active",
|
|
10616
|
+
* "calls": 0
|
|
10617
|
+
* }
|
|
10618
|
+
*/
|
|
10619
|
+
'application/json': components$1['schemas']['linkSession'];
|
|
10620
|
+
};
|
|
10621
|
+
};
|
|
10622
|
+
403: components$1['responses']['Problem'];
|
|
10623
|
+
409: components$1['responses']['Problem'];
|
|
10624
|
+
422: components$1['responses']['Problem'];
|
|
10625
|
+
503: components$1['responses']['Problem'];
|
|
10626
|
+
default: components$1['responses']['Problem'];
|
|
10627
|
+
};
|
|
10628
|
+
};
|
|
10629
|
+
endAssistantLink: {
|
|
10630
|
+
parameters: {
|
|
10631
|
+
query?: never;
|
|
10632
|
+
header?: never;
|
|
10633
|
+
path: {
|
|
10634
|
+
/** @description Approval id. */
|
|
10635
|
+
sessionId: string;
|
|
10636
|
+
};
|
|
10637
|
+
cookie?: never;
|
|
10638
|
+
};
|
|
10639
|
+
requestBody?: never;
|
|
10640
|
+
responses: {
|
|
10641
|
+
/** @description Ended. */
|
|
10642
|
+
204: {
|
|
10643
|
+
headers: {
|
|
10644
|
+
[name: string]: unknown;
|
|
10645
|
+
};
|
|
10646
|
+
content?: never;
|
|
10647
|
+
};
|
|
10648
|
+
403: components$1['responses']['Problem'];
|
|
10649
|
+
404: components$1['responses']['Problem'];
|
|
10650
|
+
default: components$1['responses']['Problem'];
|
|
10651
|
+
};
|
|
10652
|
+
};
|
|
10287
10653
|
listApiKeys: {
|
|
10288
10654
|
parameters: {
|
|
10289
10655
|
query?: {
|
|
@@ -18480,6 +18846,137 @@ type paths = {
|
|
|
18480
18846
|
patch?: never;
|
|
18481
18847
|
trace?: never;
|
|
18482
18848
|
};
|
|
18849
|
+
'/dossiers/self': {
|
|
18850
|
+
parameters: {
|
|
18851
|
+
query?: never;
|
|
18852
|
+
header?: never;
|
|
18853
|
+
path?: never;
|
|
18854
|
+
cookie?: never;
|
|
18855
|
+
};
|
|
18856
|
+
/**
|
|
18857
|
+
* Read the dossier of a code
|
|
18858
|
+
* @description Read the dossier of a code.
|
|
18859
|
+
*/
|
|
18860
|
+
get: operations['getDossierSelf'];
|
|
18861
|
+
put?: never;
|
|
18862
|
+
post?: never;
|
|
18863
|
+
/**
|
|
18864
|
+
* Delete the dossier and its attachments now
|
|
18865
|
+
* @description Deletes at once, attachments included. A claimed dossier needs the code too.
|
|
18866
|
+
*/
|
|
18867
|
+
delete: operations['deleteDossierSelf'];
|
|
18868
|
+
options?: never;
|
|
18869
|
+
head?: never;
|
|
18870
|
+
patch?: never;
|
|
18871
|
+
trace?: never;
|
|
18872
|
+
};
|
|
18873
|
+
'/dossiers/self/export': {
|
|
18874
|
+
parameters: {
|
|
18875
|
+
query?: never;
|
|
18876
|
+
header?: never;
|
|
18877
|
+
path?: never;
|
|
18878
|
+
cookie?: never;
|
|
18879
|
+
};
|
|
18880
|
+
/**
|
|
18881
|
+
* Export the dossier
|
|
18882
|
+
* @description The dossier with its `.dome` draft, answers, checklist and open items, as one JSON file.
|
|
18883
|
+
*/
|
|
18884
|
+
get: operations['exportDossierSelf'];
|
|
18885
|
+
put?: never;
|
|
18886
|
+
post?: never;
|
|
18887
|
+
delete?: never;
|
|
18888
|
+
options?: never;
|
|
18889
|
+
head?: never;
|
|
18890
|
+
patch?: never;
|
|
18891
|
+
trace?: never;
|
|
18892
|
+
};
|
|
18893
|
+
'/dossiers/self/consent': {
|
|
18894
|
+
parameters: {
|
|
18895
|
+
query?: never;
|
|
18896
|
+
header?: never;
|
|
18897
|
+
path?: never;
|
|
18898
|
+
cookie?: never;
|
|
18899
|
+
};
|
|
18900
|
+
get?: never;
|
|
18901
|
+
put?: never;
|
|
18902
|
+
/**
|
|
18903
|
+
* Record consent to store the dossier and its attachments
|
|
18904
|
+
* @description Consent of the holder of the code, with the version of the notice they read.
|
|
18905
|
+
*/
|
|
18906
|
+
post: operations['consentDossier'];
|
|
18907
|
+
delete?: never;
|
|
18908
|
+
options?: never;
|
|
18909
|
+
head?: never;
|
|
18910
|
+
patch?: never;
|
|
18911
|
+
trace?: never;
|
|
18912
|
+
};
|
|
18913
|
+
'/dossiers/self/claim': {
|
|
18914
|
+
parameters: {
|
|
18915
|
+
query?: never;
|
|
18916
|
+
header?: never;
|
|
18917
|
+
path?: never;
|
|
18918
|
+
cookie?: never;
|
|
18919
|
+
};
|
|
18920
|
+
get?: never;
|
|
18921
|
+
put?: never;
|
|
18922
|
+
/**
|
|
18923
|
+
* Save the dossier to the signed-in account
|
|
18924
|
+
* @description Needs consent first. A claimed dossier is no longer deleted after 30 days. Another account cannot claim it again.
|
|
18925
|
+
*/
|
|
18926
|
+
post: operations['claimDossier'];
|
|
18927
|
+
delete?: never;
|
|
18928
|
+
options?: never;
|
|
18929
|
+
head?: never;
|
|
18930
|
+
patch?: never;
|
|
18931
|
+
trace?: never;
|
|
18932
|
+
};
|
|
18933
|
+
'/dossiers/self/attachments': {
|
|
18934
|
+
parameters: {
|
|
18935
|
+
query?: never;
|
|
18936
|
+
header?: never;
|
|
18937
|
+
path?: never;
|
|
18938
|
+
cookie?: never;
|
|
18939
|
+
};
|
|
18940
|
+
get?: never;
|
|
18941
|
+
put?: never;
|
|
18942
|
+
/**
|
|
18943
|
+
* Add a photo or plan
|
|
18944
|
+
* @description Multipart field `file`. JPEG, PNG, WebP or PDF, checked by content; size and count are limited. Needs consent first.
|
|
18945
|
+
*/
|
|
18946
|
+
post: operations['uploadDossierAttachment'];
|
|
18947
|
+
delete?: never;
|
|
18948
|
+
options?: never;
|
|
18949
|
+
head?: never;
|
|
18950
|
+
patch?: never;
|
|
18951
|
+
trace?: never;
|
|
18952
|
+
};
|
|
18953
|
+
'/dossiers/self/attachments/{attachmentId}': {
|
|
18954
|
+
parameters: {
|
|
18955
|
+
query?: never;
|
|
18956
|
+
header?: never;
|
|
18957
|
+
path: {
|
|
18958
|
+
/** @description Attachment id. */
|
|
18959
|
+
attachmentId: components['parameters']['AttachmentId'];
|
|
18960
|
+
};
|
|
18961
|
+
cookie?: never;
|
|
18962
|
+
};
|
|
18963
|
+
/**
|
|
18964
|
+
* Download an attachment
|
|
18965
|
+
* @description Served as a download, never inline.
|
|
18966
|
+
*/
|
|
18967
|
+
get: operations['getDossierAttachment'];
|
|
18968
|
+
put?: never;
|
|
18969
|
+
post?: never;
|
|
18970
|
+
/**
|
|
18971
|
+
* Delete an attachment
|
|
18972
|
+
* @description Removes the file at once.
|
|
18973
|
+
*/
|
|
18974
|
+
delete: operations['deleteDossierAttachment'];
|
|
18975
|
+
options?: never;
|
|
18976
|
+
head?: never;
|
|
18977
|
+
patch?: never;
|
|
18978
|
+
trace?: never;
|
|
18979
|
+
};
|
|
18483
18980
|
'/installations/enroll-requests': {
|
|
18484
18981
|
parameters: {
|
|
18485
18982
|
query?: never;
|
|
@@ -19169,24 +19666,1133 @@ type components = {
|
|
|
19169
19666
|
/** @enum {unknown} */
|
|
19170
19667
|
telemetryLevel?: 'off' | 'basic' | 'full';
|
|
19171
19668
|
};
|
|
19172
|
-
enrollmentToken: {
|
|
19173
|
-
id: components['schemas']['uuid'];
|
|
19174
|
-
name?: string;
|
|
19175
|
-
/** @description returned once on creation */
|
|
19176
|
-
token?: string;
|
|
19177
|
-
expiresAt: components['schemas']['timestamp'];
|
|
19178
|
-
usedAt?: components['schemas']['timestamp'] | null;
|
|
19669
|
+
enrollmentToken: {
|
|
19670
|
+
id: components['schemas']['uuid'];
|
|
19671
|
+
name?: string;
|
|
19672
|
+
/** @description returned once on creation */
|
|
19673
|
+
token?: string;
|
|
19674
|
+
expiresAt: components['schemas']['timestamp'];
|
|
19675
|
+
usedAt?: components['schemas']['timestamp'] | null;
|
|
19676
|
+
};
|
|
19677
|
+
enrollmentTokenPage: {
|
|
19678
|
+
items: components['schemas']['enrollmentToken'][];
|
|
19679
|
+
nextCursor: string | null;
|
|
19680
|
+
};
|
|
19681
|
+
enrollmentTokenInput: {
|
|
19682
|
+
name?: string;
|
|
19683
|
+
ttlHours?: number;
|
|
19684
|
+
};
|
|
19685
|
+
/** @description Lowercase hex SHA-256 digest. */
|
|
19686
|
+
sha256: string;
|
|
19687
|
+
/** @description Entry path inside the container: relative, `/`-separated, no `..` segment, no backslash, no NUL. */
|
|
19688
|
+
path: string;
|
|
19689
|
+
/** @description Value of an open enum: one of the listed values or any other token (clients tolerate unknown values). */
|
|
19690
|
+
'token-2': string;
|
|
19691
|
+
/** @description [x, y, z], metres, dome frame (01b §3). */
|
|
19692
|
+
vec3: number[];
|
|
19693
|
+
vec2: number[];
|
|
19694
|
+
/** @description Rotation quaternion [x, y, z, w]. */
|
|
19695
|
+
quat: number[];
|
|
19696
|
+
/** @description Document-scoped id (02e §3.2). */
|
|
19697
|
+
id: components['schemas']['docId'];
|
|
19698
|
+
/** @description [width, height] or [cols, rows]. */
|
|
19699
|
+
size2: number[];
|
|
19700
|
+
lens: {
|
|
19701
|
+
kind: ('fisheye' | 'standard' | 'pyramid' | 'prism' | 'equirect') | components['schemas']['token-2'];
|
|
19702
|
+
/** @description ° */
|
|
19703
|
+
fov?: number;
|
|
19704
|
+
throwRatio?: number | null;
|
|
19705
|
+
/** @description lens shift [x, y] as a fraction of the image size */
|
|
19706
|
+
shift?: components['schemas']['vec2'];
|
|
19707
|
+
/** @description 1.1 (02b E4): lens distortion model. */
|
|
19708
|
+
distortion?: {
|
|
19709
|
+
model: ('brown-conrady' | 'fisheye-equidistant' | 'fisheye-equisolid' | 'fisheye-poly' | 'radial') | components['schemas']['token-2'];
|
|
19710
|
+
/** @description brown-conrady [k1,k2,k3,p1,p2]; fisheye-poly [k1..k4]; radial [k1,k2,k3] (01b §4.2.1) */
|
|
19711
|
+
coefficients?: number[];
|
|
19712
|
+
/** @description distortion centre, normalised image coordinates */
|
|
19713
|
+
centre?: number[];
|
|
19714
|
+
} & {
|
|
19715
|
+
[key: string]: unknown;
|
|
19716
|
+
};
|
|
19717
|
+
/** @description 1.1 (02b E4): lens profile id shipped as data (engine data/lens_profiles/<id>.json), e.g. sh001. */
|
|
19718
|
+
profileRef?: string;
|
|
19719
|
+
/** @description 1.1 (EN, curved LED walls): the display surface is a cylinder (axis vertical = curved horizontally, the usual curved wall) or a sphere section; absent = flat. */
|
|
19720
|
+
curvature?: {
|
|
19721
|
+
/** @description m, curvature radius of the panel surface */
|
|
19722
|
+
radius: number;
|
|
19723
|
+
/** @default vertical */
|
|
19724
|
+
axis: ('vertical' | 'horizontal' | 'spherical') | components['schemas']['token-2'];
|
|
19725
|
+
/**
|
|
19726
|
+
* @description true = curved towards the audience
|
|
19727
|
+
* @default true
|
|
19728
|
+
*/
|
|
19729
|
+
concave: boolean;
|
|
19730
|
+
} & {
|
|
19731
|
+
[key: string]: unknown;
|
|
19732
|
+
};
|
|
19733
|
+
} & {
|
|
19734
|
+
[key: string]: unknown;
|
|
19735
|
+
};
|
|
19736
|
+
pose: {
|
|
19737
|
+
position?: components['schemas']['vec3'];
|
|
19738
|
+
rotation?: components['schemas']['quat'];
|
|
19739
|
+
} & {
|
|
19740
|
+
[key: string]: unknown;
|
|
19741
|
+
};
|
|
19742
|
+
/** @description Normalised [x, y, w, h] of the display frame (0..1, origin top-left, y down; 01b §3). */
|
|
19743
|
+
rect: number[];
|
|
19744
|
+
/** @description 1.1 (02a V12, replaces x-freedome-optics): per-face layout of prism / pyramid optics on the display frame. */
|
|
19745
|
+
optics: {
|
|
19746
|
+
/** @enum {unknown} */
|
|
19747
|
+
faces: 1 | 3 | 4 | 6;
|
|
19748
|
+
/** @description ° between a face and the screen plane */
|
|
19749
|
+
faceAngle?: number;
|
|
19750
|
+
viewports?: ({
|
|
19751
|
+
/** @description 0 = front, clockwise from above */
|
|
19752
|
+
face: number;
|
|
19753
|
+
rect: components['schemas']['rect'];
|
|
19754
|
+
/** @description ° clockwise */
|
|
19755
|
+
rotation?: number;
|
|
19756
|
+
/** @enum {unknown} */
|
|
19757
|
+
mirror?: 'none' | 'horizontal' | 'vertical';
|
|
19758
|
+
} & {
|
|
19759
|
+
[key: string]: unknown;
|
|
19760
|
+
})[];
|
|
19761
|
+
/** @description lit region; outside is black */
|
|
19762
|
+
activeRegion?: components['schemas']['rect'];
|
|
19763
|
+
} & {
|
|
19764
|
+
[key: string]: unknown;
|
|
19765
|
+
};
|
|
19766
|
+
/** @description 1.1 (02b E4): physical prism / pyramid geometry (engine PrismGeometry). */
|
|
19767
|
+
prism: {
|
|
19768
|
+
faces: number;
|
|
19769
|
+
baseMm?: number;
|
|
19770
|
+
heightMm?: number;
|
|
19771
|
+
faceAngle?: number;
|
|
19772
|
+
refractiveIndex?: number;
|
|
19773
|
+
solid?: boolean;
|
|
19774
|
+
} & {
|
|
19775
|
+
[key: string]: unknown;
|
|
19776
|
+
};
|
|
19777
|
+
unit: number;
|
|
19778
|
+
displayCalibration: {
|
|
19779
|
+
warp?: {
|
|
19780
|
+
/** @description FDMESH file (01b §5) */
|
|
19781
|
+
file: components['schemas']['path'];
|
|
19782
|
+
kind?: 'uv-grid' | components['schemas']['token-2'];
|
|
19783
|
+
/** @description [cols, rows]; must match the FDMESH header */
|
|
19784
|
+
size?: components['schemas']['size2'];
|
|
19785
|
+
} & {
|
|
19786
|
+
[key: string]: unknown;
|
|
19787
|
+
};
|
|
19788
|
+
blend?: {
|
|
19789
|
+
/** @description 16-bit greyscale PNG */
|
|
19790
|
+
file: components['schemas']['path'];
|
|
19791
|
+
/** @enum {unknown} */
|
|
19792
|
+
bitDepth?: 8 | 16;
|
|
19793
|
+
gamma?: number;
|
|
19794
|
+
} & {
|
|
19795
|
+
[key: string]: unknown;
|
|
19796
|
+
};
|
|
19797
|
+
colour?: {
|
|
19798
|
+
/** @description Adobe / Resolve .cube 3D LUT */
|
|
19799
|
+
lut?: components['schemas']['path'];
|
|
19800
|
+
blackLevel?: components['schemas']['unit'];
|
|
19801
|
+
} & {
|
|
19802
|
+
[key: string]: unknown;
|
|
19803
|
+
};
|
|
19804
|
+
report?: {
|
|
19805
|
+
method?: ('camera-homography' | 'manual' | 'imported' | 'model') | components['schemas']['token-2'];
|
|
19806
|
+
/** Format: date-time */
|
|
19807
|
+
date?: string;
|
|
19808
|
+
meanError?: number;
|
|
19809
|
+
maxError?: number;
|
|
19810
|
+
unit?: ('px' | 'deg' | 'mm') | components['schemas']['token-2'];
|
|
19811
|
+
file?: components['schemas']['path'];
|
|
19812
|
+
} & {
|
|
19813
|
+
[key: string]: unknown;
|
|
19814
|
+
};
|
|
19815
|
+
} & {
|
|
19816
|
+
[key: string]: unknown;
|
|
19817
|
+
};
|
|
19818
|
+
gainDb: number;
|
|
19819
|
+
speaker: {
|
|
19820
|
+
id: components['schemas']['id'];
|
|
19821
|
+
/** @description ° (0 = front, clockwise from above) */
|
|
19822
|
+
azimuth: number;
|
|
19823
|
+
/** @description ° (0 = spring line) */
|
|
19824
|
+
elevation: number;
|
|
19825
|
+
/** @description m */
|
|
19826
|
+
distance?: number;
|
|
19827
|
+
channel?: number;
|
|
19828
|
+
delayMs?: number;
|
|
19829
|
+
gainDb?: components['schemas']['gainDb'];
|
|
19830
|
+
kind?: ('fullrange' | 'subwoofer' | 'satellite') | components['schemas']['token-2'];
|
|
19831
|
+
lfe?: boolean;
|
|
19832
|
+
} & {
|
|
19833
|
+
[key: string]: unknown;
|
|
19834
|
+
};
|
|
19835
|
+
audioDevice: {
|
|
19836
|
+
id: components['schemas']['id'];
|
|
19837
|
+
name?: string;
|
|
19838
|
+
kind: ('qrd' | 'patefon' | 'karmic_cluster' | 'speaker_amp' | 'microphone') | components['schemas']['token-2'];
|
|
19839
|
+
/** @description e.g. osc://10.0.0.20:9000 */
|
|
19840
|
+
address?: string;
|
|
19841
|
+
} & {
|
|
19842
|
+
[key: string]: unknown;
|
|
19843
|
+
};
|
|
19844
|
+
/** @description An entry path (see path) or an absolute URI (`https:`, `http:`, `file:`, `ndi:`, `srt:` …). */
|
|
19845
|
+
uriOrPath: components['schemas']['path'] | string;
|
|
19846
|
+
/** @description Content mapping onto the dome (01b §4.5, 02b §4.4). */
|
|
19847
|
+
mapping: {
|
|
19848
|
+
projection: ('domemaster' | 'equirect' | 'cubemap' | 'flat' | 'pyramid_views') | components['schemas']['token-2'];
|
|
19849
|
+
/** @description ° (domemaster 180–230) */
|
|
19850
|
+
fov?: number;
|
|
19851
|
+
tilt?: number;
|
|
19852
|
+
/** @description flat: ° centre azimuth */
|
|
19853
|
+
azimuth?: number;
|
|
19854
|
+
/** @description flat: ° centre elevation */
|
|
19855
|
+
elevation?: number;
|
|
19856
|
+
/** @description flat: ° angular width */
|
|
19857
|
+
width?: number;
|
|
19858
|
+
/**
|
|
19859
|
+
* @description 1.1 pyramid_views: number of views
|
|
19860
|
+
* @enum {unknown}
|
|
19861
|
+
*/
|
|
19862
|
+
faces?: 3 | 4 | 6;
|
|
19863
|
+
/** @description 1.1: cubemap 3x2 | 6x1 | cross; pyramid_views cross | row | grid */
|
|
19864
|
+
layout?: ('3x2' | '6x1' | 'cross' | 'row' | 'grid') | components['schemas']['token-2'];
|
|
19865
|
+
} & {
|
|
19866
|
+
[key: string]: unknown;
|
|
19867
|
+
};
|
|
19868
|
+
seconds: number;
|
|
19869
|
+
transition: {
|
|
19870
|
+
kind: ('cut' | 'fade' | 'dissolve' | 'wipe') | components['schemas']['token-2'];
|
|
19871
|
+
duration?: components['schemas']['seconds'];
|
|
19872
|
+
} & {
|
|
19873
|
+
[key: string]: unknown;
|
|
19874
|
+
};
|
|
19875
|
+
/** @description x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8). */
|
|
19876
|
+
playlistItem: {
|
|
19877
|
+
asset: components['schemas']['id'];
|
|
19878
|
+
in?: components['schemas']['seconds'];
|
|
19879
|
+
out?: components['schemas']['seconds'];
|
|
19880
|
+
loop?: boolean;
|
|
19881
|
+
transition?: components['schemas']['transition'];
|
|
19882
|
+
} & {
|
|
19883
|
+
[key: string]: unknown;
|
|
19884
|
+
};
|
|
19885
|
+
/** @description x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8). */
|
|
19886
|
+
clip: {
|
|
19887
|
+
asset: components['schemas']['id'];
|
|
19888
|
+
start: components['schemas']['seconds'];
|
|
19889
|
+
in?: components['schemas']['seconds'];
|
|
19890
|
+
out?: components['schemas']['seconds'];
|
|
19891
|
+
gainDb?: components['schemas']['gainDb'];
|
|
19892
|
+
opacity?: components['schemas']['unit'];
|
|
19893
|
+
} & {
|
|
19894
|
+
[key: string]: unknown;
|
|
19895
|
+
};
|
|
19896
|
+
matrixAxis: (components['schemas']['id'] | ({
|
|
19897
|
+
id: components['schemas']['id'];
|
|
19898
|
+
name?: string;
|
|
19899
|
+
} & {
|
|
19900
|
+
[key: string]: unknown;
|
|
19901
|
+
}))[];
|
|
19902
|
+
action: {
|
|
19903
|
+
do: ('play' | 'pause' | 'stop' | 'seek' | 'setVolume' | 'setBrightness' | 'setParameter' | 'osc' | 'http' | 'scenario') | components['schemas']['token-2'];
|
|
19904
|
+
/** @description e.g. player id, playlist:<id>, param path, osc://host:port/address, URL */
|
|
19905
|
+
target?: string;
|
|
19906
|
+
/** @description Action arguments (object or positional array). */
|
|
19907
|
+
args?: unknown;
|
|
19908
|
+
} & {
|
|
19909
|
+
[key: string]: unknown;
|
|
19910
|
+
};
|
|
19911
|
+
playlist: {
|
|
19912
|
+
id: components['schemas']['id'];
|
|
19913
|
+
name?: string;
|
|
19914
|
+
loop?: boolean;
|
|
19915
|
+
items: components['schemas']['playlistItem'][];
|
|
19916
|
+
} & {
|
|
19917
|
+
[key: string]: unknown;
|
|
19918
|
+
};
|
|
19919
|
+
timeline: {
|
|
19920
|
+
id: components['schemas']['id'];
|
|
19921
|
+
name?: string;
|
|
19922
|
+
duration?: components['schemas']['seconds'];
|
|
19923
|
+
tracks: ({
|
|
19924
|
+
id?: components['schemas']['id'];
|
|
19925
|
+
kind: ('video' | 'audio' | 'control') | components['schemas']['token-2'];
|
|
19926
|
+
clips: components['schemas']['clip'][];
|
|
19927
|
+
} & {
|
|
19928
|
+
[key: string]: unknown;
|
|
19929
|
+
})[];
|
|
19930
|
+
markers?: ({
|
|
19931
|
+
time: components['schemas']['seconds'];
|
|
19932
|
+
name?: string;
|
|
19933
|
+
id?: components['schemas']['id'];
|
|
19934
|
+
kind?: ('marker' | 'pause' | 'jump' | 'timecode') | components['schemas']['token-2'];
|
|
19935
|
+
} & {
|
|
19936
|
+
[key: string]: unknown;
|
|
19937
|
+
})[];
|
|
19938
|
+
/** @description 1.1 (02d) */
|
|
19939
|
+
fps?: number;
|
|
19940
|
+
} & {
|
|
19941
|
+
[key: string]: unknown;
|
|
19942
|
+
};
|
|
19943
|
+
/** @description Screenberry-style matrix (compatibility); cells reference row / column ids. */
|
|
19944
|
+
matrix: {
|
|
19945
|
+
id?: components['schemas']['id'];
|
|
19946
|
+
rows: components['schemas']['matrixAxis'];
|
|
19947
|
+
columns: components['schemas']['matrixAxis'];
|
|
19948
|
+
cells: ({
|
|
19949
|
+
row: components['schemas']['id'];
|
|
19950
|
+
column: components['schemas']['id'];
|
|
19951
|
+
asset: components['schemas']['id'];
|
|
19952
|
+
} & {
|
|
19953
|
+
[key: string]: unknown;
|
|
19954
|
+
})[];
|
|
19955
|
+
} & {
|
|
19956
|
+
[key: string]: unknown;
|
|
19957
|
+
};
|
|
19958
|
+
cue: {
|
|
19959
|
+
id: components['schemas']['id'];
|
|
19960
|
+
name?: string;
|
|
19961
|
+
at?: ({
|
|
19962
|
+
timeline: components['schemas']['id'];
|
|
19963
|
+
time: components['schemas']['seconds'];
|
|
19964
|
+
} & {
|
|
19965
|
+
[key: string]: unknown;
|
|
19966
|
+
}) | ({
|
|
19967
|
+
trigger: components['schemas']['id'];
|
|
19968
|
+
} & {
|
|
19969
|
+
[key: string]: unknown;
|
|
19970
|
+
});
|
|
19971
|
+
actions: components['schemas']['action'][];
|
|
19972
|
+
} & {
|
|
19973
|
+
[key: string]: unknown;
|
|
19974
|
+
};
|
|
19975
|
+
trigger: {
|
|
19976
|
+
id: components['schemas']['id'];
|
|
19977
|
+
source: ('osc' | 'midi' | 'time' | 'api' | 'dmx') | components['schemas']['token-2'];
|
|
19978
|
+
/** @description Source-specific match (OSC address pattern, MIDI note, cron / time, DMX channel …). */
|
|
19979
|
+
match?: unknown;
|
|
19980
|
+
} & {
|
|
19981
|
+
[key: string]: unknown;
|
|
19982
|
+
};
|
|
19983
|
+
/** @description Exactly one of playlist / timeline / matrix / asset id. */
|
|
19984
|
+
showRef: ({
|
|
19985
|
+
playlist?: components['schemas']['id'];
|
|
19986
|
+
timeline?: components['schemas']['id'];
|
|
19987
|
+
matrix?: components['schemas']['id'];
|
|
19988
|
+
asset?: components['schemas']['id'];
|
|
19989
|
+
} & {
|
|
19990
|
+
[key: string]: unknown;
|
|
19991
|
+
}) & (unknown | unknown | unknown | unknown);
|
|
19992
|
+
/** @description 1.1 (02d MD8): named media player. Player `main` always exists (implicit: all displays, source = startup). */
|
|
19993
|
+
mediaPlayer: {
|
|
19994
|
+
id: components['schemas']['id'];
|
|
19995
|
+
name?: string;
|
|
19996
|
+
/** @description absent = all displays */
|
|
19997
|
+
target?: {
|
|
19998
|
+
displays?: components['schemas']['id'][];
|
|
19999
|
+
layer?: number;
|
|
20000
|
+
} & {
|
|
20001
|
+
[key: string]: unknown;
|
|
20002
|
+
};
|
|
20003
|
+
source?: components['schemas']['showRef'];
|
|
20004
|
+
volume?: components['schemas']['unit'];
|
|
20005
|
+
brightness?: components['schemas']['unit'];
|
|
20006
|
+
/** @description ° content rotation about the dome axis */
|
|
20007
|
+
rotation?: number;
|
|
20008
|
+
/** @description playback rate, 1 = normal */
|
|
20009
|
+
speed?: number;
|
|
20010
|
+
} & {
|
|
20011
|
+
[key: string]: unknown;
|
|
20012
|
+
};
|
|
20013
|
+
'meta-2': {
|
|
20014
|
+
/** @description Stable document id (UUID, lowercase); the venue / show id on import (02e §3.2). */
|
|
20015
|
+
id: components['schemas']['uuid'];
|
|
20016
|
+
title: components['schemas']['i18n-text.schema'];
|
|
20017
|
+
description?: components['schemas']['i18n-text.schema'];
|
|
20018
|
+
authors?: ({
|
|
20019
|
+
name: string;
|
|
20020
|
+
/** Format: email */
|
|
20021
|
+
email?: string;
|
|
20022
|
+
/** Format: uri */
|
|
20023
|
+
url?: string;
|
|
20024
|
+
role?: string;
|
|
20025
|
+
} & {
|
|
20026
|
+
[key: string]: unknown;
|
|
20027
|
+
})[];
|
|
20028
|
+
/** Format: date-time */
|
|
20029
|
+
created?: string;
|
|
20030
|
+
/** Format: date-time */
|
|
20031
|
+
modified?: string;
|
|
20032
|
+
generator?: {
|
|
20033
|
+
name: string;
|
|
20034
|
+
version?: string;
|
|
20035
|
+
} & {
|
|
20036
|
+
[key: string]: unknown;
|
|
20037
|
+
};
|
|
20038
|
+
/** @default NativeMindNONC */
|
|
20039
|
+
license: string;
|
|
20040
|
+
tags?: string[];
|
|
20041
|
+
} & {
|
|
20042
|
+
[key: string]: unknown;
|
|
20043
|
+
};
|
|
20044
|
+
/** @description Dome geometry (01b §4.1). Right-handed, metres, degrees; +Y zenith, -Z front. */
|
|
20045
|
+
'dome-2': {
|
|
20046
|
+
mode: ('classical' | 'quantum') | components['schemas']['token-2'];
|
|
20047
|
+
shape: ('hemisphere' | 'sphere' | 'truncated' | 'cylinder' | 'cylinder_outer' | 'cone' | 'pyramid' | 'geodesic' | 'flat' | 'multiwall' | 'cave' | 'volumetric') | components['schemas']['token-2'];
|
|
20048
|
+
/** @description m */
|
|
20049
|
+
radius: number;
|
|
20050
|
+
/** @description ° forward tilt of the dome axis */
|
|
20051
|
+
tilt?: number;
|
|
20052
|
+
/** @description ° below the spring line projected (negative = cut off) */
|
|
20053
|
+
truncation?: number;
|
|
20054
|
+
orientation?: ('upright' | 'inverted' | 'tilted') | components['schemas']['token-2'];
|
|
20055
|
+
/** @description m above floor */
|
|
20056
|
+
springLineHeight?: number;
|
|
20057
|
+
surface?: {
|
|
20058
|
+
gain?: number;
|
|
20059
|
+
material?: string;
|
|
20060
|
+
} & {
|
|
20061
|
+
[key: string]: unknown;
|
|
20062
|
+
};
|
|
20063
|
+
seating?: ('unidirectional' | 'concentric' | 'free') | components['schemas']['token-2'];
|
|
20064
|
+
sweetSpot?: components['schemas']['vec3'];
|
|
20065
|
+
/** @description Quantum mode only: presentation base of the circle (e.g. 108); values stay in degrees. */
|
|
20066
|
+
angularBase?: number;
|
|
20067
|
+
} & {
|
|
20068
|
+
[key: string]: unknown;
|
|
20069
|
+
};
|
|
20070
|
+
/** @description Visual device (01b §4.2): projector (incl. fisheye), LED, prism unit, smartphone + lens, NDI output. */
|
|
20071
|
+
display: {
|
|
20072
|
+
id: components['schemas']['id'];
|
|
20073
|
+
name?: string;
|
|
20074
|
+
type: ('projector' | 'led' | 'prism_unit' | 'smartphone_lens' | 'ndi_output') | components['schemas']['token-2'];
|
|
20075
|
+
model?: {
|
|
20076
|
+
vendor?: string;
|
|
20077
|
+
product?: string;
|
|
20078
|
+
variant?: string;
|
|
20079
|
+
} & {
|
|
20080
|
+
[key: string]: unknown;
|
|
20081
|
+
};
|
|
20082
|
+
resolution?: components['schemas']['size2'];
|
|
20083
|
+
/** @description Hz */
|
|
20084
|
+
refreshRate?: number;
|
|
20085
|
+
lens?: components['schemas']['lens'];
|
|
20086
|
+
pose?: components['schemas']['pose'];
|
|
20087
|
+
output?: {
|
|
20088
|
+
host?: string;
|
|
20089
|
+
/** @description e.g. DP-1, HDMI-1, stream:<displayId> */
|
|
20090
|
+
connector?: string;
|
|
20091
|
+
} & {
|
|
20092
|
+
[key: string]: unknown;
|
|
20093
|
+
};
|
|
20094
|
+
colour?: {
|
|
20095
|
+
gamut?: ('rec709' | 'dci-p3' | 'display-p3' | 'rec2020' | 'srgb') | components['schemas']['token-2'];
|
|
20096
|
+
gamma?: number;
|
|
20097
|
+
whitePoint?: string;
|
|
20098
|
+
} & {
|
|
20099
|
+
[key: string]: unknown;
|
|
20100
|
+
};
|
|
20101
|
+
stereo?: null | ({
|
|
20102
|
+
/** @enum {unknown} */
|
|
20103
|
+
eye: 'left' | 'right';
|
|
20104
|
+
} & {
|
|
20105
|
+
[key: string]: unknown;
|
|
20106
|
+
});
|
|
20107
|
+
optics?: components['schemas']['optics'];
|
|
20108
|
+
prism?: components['schemas']['prism'];
|
|
20109
|
+
} & {
|
|
20110
|
+
[key: string]: unknown;
|
|
20111
|
+
};
|
|
20112
|
+
/** @description Per-display calibration (01b §4.3); keys of `displays` are display ids (checked by the codecs). */
|
|
20113
|
+
calibration: {
|
|
20114
|
+
displays?: {
|
|
20115
|
+
[key: string]: components['schemas']['displayCalibration'];
|
|
20116
|
+
};
|
|
20117
|
+
} & {
|
|
20118
|
+
[key: string]: unknown;
|
|
20119
|
+
};
|
|
20120
|
+
/** @description AnantaSound layout (01b §4.4). */
|
|
20121
|
+
audio: {
|
|
20122
|
+
ambisonics?: {
|
|
20123
|
+
order?: number;
|
|
20124
|
+
normalisation?: ('SN3D' | 'N3D' | 'FuMa') | components['schemas']['token-2'];
|
|
20125
|
+
channelOrder?: ('ACN' | 'FuMa') | components['schemas']['token-2'];
|
|
20126
|
+
} & {
|
|
20127
|
+
[key: string]: unknown;
|
|
20128
|
+
};
|
|
20129
|
+
decoder?: {
|
|
20130
|
+
kind?: ('allrad' | 'sad' | 'mmd' | 'epad') | components['schemas']['token-2'];
|
|
20131
|
+
dualBand?: boolean;
|
|
20132
|
+
} & {
|
|
20133
|
+
[key: string]: unknown;
|
|
20134
|
+
};
|
|
20135
|
+
speakers?: components['schemas']['speaker'][];
|
|
20136
|
+
roomCorrection?: {
|
|
20137
|
+
file: components['schemas']['path'];
|
|
20138
|
+
kind?: ('fir' | 'iir' | 'peq') | components['schemas']['token-2'];
|
|
20139
|
+
} & {
|
|
20140
|
+
[key: string]: unknown;
|
|
20141
|
+
};
|
|
20142
|
+
devices?: components['schemas']['audioDevice'][];
|
|
20143
|
+
} & {
|
|
20144
|
+
[key: string]: unknown;
|
|
20145
|
+
};
|
|
20146
|
+
/** @description Media / scene (01b §4.5). External assets (absolute URI) carry sha256 + size. */
|
|
20147
|
+
asset: {
|
|
20148
|
+
id: components['schemas']['id'];
|
|
20149
|
+
name?: string;
|
|
20150
|
+
src: components['schemas']['uriOrPath'];
|
|
20151
|
+
sha256?: components['schemas']['sha256'];
|
|
20152
|
+
size?: number;
|
|
20153
|
+
type: ('video' | 'image' | 'audio' | 'zelim' | 'boranko' | 'comics' | 'realtime' | 'stream') | components['schemas']['token-2'];
|
|
20154
|
+
mapping?: components['schemas']['mapping'];
|
|
20155
|
+
video?: {
|
|
20156
|
+
resolution?: components['schemas']['size2'];
|
|
20157
|
+
fps?: number;
|
|
20158
|
+
codec?: ('hap' | 'hap-q' | 'hap-alpha' | 'h264' | 'h265' | 'av1' | 'vp9' | 'prores' | 'png-sequence' | 'exr-sequence') | components['schemas']['token-2'];
|
|
20159
|
+
stereo?: null | ('top-bottom' | 'side-by-side');
|
|
20160
|
+
} & {
|
|
20161
|
+
[key: string]: unknown;
|
|
20162
|
+
};
|
|
20163
|
+
audio?: {
|
|
20164
|
+
kind: ('ambisonic' | 'channels' | 'stereo' | 'mono') | components['schemas']['token-2'];
|
|
20165
|
+
order?: number;
|
|
20166
|
+
/** @description channels: e.g. 5.1, 7.1, 7.1.4 */
|
|
20167
|
+
layout?: string;
|
|
20168
|
+
} & {
|
|
20169
|
+
[key: string]: unknown;
|
|
20170
|
+
};
|
|
20171
|
+
duration?: components['schemas']['seconds'];
|
|
20172
|
+
thumbnail?: components['schemas']['path'];
|
|
20173
|
+
/** @description 1.1: hint for type zelim (project = JSON variant J, binary = variant B); content sniffing wins. A J project may carry quantum.scene (02e §9.3). */
|
|
20174
|
+
zelim?: {
|
|
20175
|
+
variant?: ('project' | 'binary') | components['schemas']['token-2'];
|
|
20176
|
+
} & {
|
|
20177
|
+
[key: string]: unknown;
|
|
20178
|
+
};
|
|
20179
|
+
} & {
|
|
20180
|
+
[key: string]: unknown;
|
|
20181
|
+
};
|
|
20182
|
+
/** @description Playlists, timelines, matrix, cues, triggers, startup (01b §4.6). */
|
|
20183
|
+
show: {
|
|
20184
|
+
playlists?: components['schemas']['playlist'][];
|
|
20185
|
+
timelines?: components['schemas']['timeline'][];
|
|
20186
|
+
matrix?: components['schemas']['matrix'];
|
|
20187
|
+
cues?: components['schemas']['cue'][];
|
|
20188
|
+
triggers?: components['schemas']['trigger'][];
|
|
20189
|
+
mediaPlayers?: components['schemas']['mediaPlayer'][];
|
|
20190
|
+
/** @description What plays when the venue powers on. */
|
|
20191
|
+
startup?: components['schemas']['showRef'];
|
|
20192
|
+
/** @description 1.1 (02c AQ4, replaces x-ananta.mode): audio engines used by the show; absent = digital. */
|
|
20193
|
+
audioMode?: ('digital' | 'hybrid' | 'combined') | components['schemas']['token-2'];
|
|
20194
|
+
} & {
|
|
20195
|
+
[key: string]: unknown;
|
|
20196
|
+
};
|
|
20197
|
+
/** @description Declarative mappings for the A6 gateways (01b §4.7); never required for playback. */
|
|
20198
|
+
compat: {
|
|
20199
|
+
[key: string]: Record<string, never>;
|
|
20200
|
+
};
|
|
20201
|
+
/** .dome manifest 1.1 */
|
|
20202
|
+
'dome.schema': ({
|
|
20203
|
+
/** @constant */
|
|
20204
|
+
format: 'dome';
|
|
20205
|
+
/** @description Semver of the format the writer implements; this schema accepts any 1.x (readers reject an unknown major). */
|
|
20206
|
+
formatVersion: string;
|
|
20207
|
+
/**
|
|
20208
|
+
* @description Closed: selects the required sections.
|
|
20209
|
+
* @enum {unknown}
|
|
20210
|
+
*/
|
|
20211
|
+
kind: 'venue' | 'show' | 'bundle';
|
|
20212
|
+
meta: components['schemas']['meta-2'];
|
|
20213
|
+
dome?: components['schemas']['dome-2'];
|
|
20214
|
+
/** @description Display ids are unique in the file (checked by the codecs). */
|
|
20215
|
+
displays?: components['schemas']['display'][];
|
|
20216
|
+
calibration?: components['schemas']['calibration'];
|
|
20217
|
+
audio?: components['schemas']['audio'];
|
|
20218
|
+
/** @description Asset ids are unique in the file (checked by the codecs). */
|
|
20219
|
+
assets?: components['schemas']['asset'][];
|
|
20220
|
+
show?: components['schemas']['show'];
|
|
20221
|
+
compat?: components['schemas']['compat'];
|
|
20222
|
+
$defs: {
|
|
20223
|
+
/** @description Value of an open enum: one of the listed values or any other token (clients tolerate unknown values). */
|
|
20224
|
+
token: string;
|
|
20225
|
+
/** @description Document-scoped id (02e §3.2). */
|
|
20226
|
+
id: components['schemas']['docId'];
|
|
20227
|
+
i18n: components['schemas']['i18n-text.schema'];
|
|
20228
|
+
sha256: components['schemas']['sha256'];
|
|
20229
|
+
/** @description Entry path inside the container: relative, `/`-separated, no `..` segment, no backslash, no NUL. */
|
|
20230
|
+
path: string;
|
|
20231
|
+
/** @description An entry path (see path) or an absolute URI (`https:`, `http:`, `file:`, `ndi:`, `srt:` …). */
|
|
20232
|
+
uriOrPath: components['schemas']['path'] | string;
|
|
20233
|
+
vec2: number[];
|
|
20234
|
+
/** @description [x, y, z], metres, dome frame (01b §3). */
|
|
20235
|
+
vec3: number[];
|
|
20236
|
+
/** @description Rotation quaternion [x, y, z, w]. */
|
|
20237
|
+
quat: number[];
|
|
20238
|
+
/** @description [width, height] or [cols, rows]. */
|
|
20239
|
+
size2: number[];
|
|
20240
|
+
seconds: number;
|
|
20241
|
+
unit: number;
|
|
20242
|
+
gainDb: number;
|
|
20243
|
+
meta: {
|
|
20244
|
+
/** @description Stable document id (UUID, lowercase); the venue / show id on import (02e §3.2). */
|
|
20245
|
+
id: components['schemas']['uuid'];
|
|
20246
|
+
title: components['schemas']['i18n-text.schema'];
|
|
20247
|
+
description?: components['schemas']['i18n-text.schema'];
|
|
20248
|
+
authors?: ({
|
|
20249
|
+
name: string;
|
|
20250
|
+
/** Format: email */
|
|
20251
|
+
email?: string;
|
|
20252
|
+
/** Format: uri */
|
|
20253
|
+
url?: string;
|
|
20254
|
+
role?: string;
|
|
20255
|
+
} & {
|
|
20256
|
+
[key: string]: unknown;
|
|
20257
|
+
})[];
|
|
20258
|
+
/** Format: date-time */
|
|
20259
|
+
created?: string;
|
|
20260
|
+
/** Format: date-time */
|
|
20261
|
+
modified?: string;
|
|
20262
|
+
generator?: {
|
|
20263
|
+
name: string;
|
|
20264
|
+
version?: string;
|
|
20265
|
+
} & {
|
|
20266
|
+
[key: string]: unknown;
|
|
20267
|
+
};
|
|
20268
|
+
/** @default NativeMindNONC */
|
|
20269
|
+
license: string;
|
|
20270
|
+
tags?: string[];
|
|
20271
|
+
} & {
|
|
20272
|
+
[key: string]: unknown;
|
|
20273
|
+
};
|
|
20274
|
+
/** @description Dome geometry (01b §4.1). Right-handed, metres, degrees; +Y zenith, -Z front. */
|
|
20275
|
+
dome: {
|
|
20276
|
+
mode: ('classical' | 'quantum') | components['schemas']['token-2'];
|
|
20277
|
+
shape: ('hemisphere' | 'sphere' | 'truncated' | 'cylinder' | 'cylinder_outer' | 'cone' | 'pyramid' | 'geodesic' | 'flat' | 'multiwall' | 'cave' | 'volumetric') | components['schemas']['token-2'];
|
|
20278
|
+
/** @description m */
|
|
20279
|
+
radius: number;
|
|
20280
|
+
/** @description ° forward tilt of the dome axis */
|
|
20281
|
+
tilt?: number;
|
|
20282
|
+
/** @description ° below the spring line projected (negative = cut off) */
|
|
20283
|
+
truncation?: number;
|
|
20284
|
+
orientation?: ('upright' | 'inverted' | 'tilted') | components['schemas']['token-2'];
|
|
20285
|
+
/** @description m above floor */
|
|
20286
|
+
springLineHeight?: number;
|
|
20287
|
+
surface?: {
|
|
20288
|
+
gain?: number;
|
|
20289
|
+
material?: string;
|
|
20290
|
+
} & {
|
|
20291
|
+
[key: string]: unknown;
|
|
20292
|
+
};
|
|
20293
|
+
seating?: ('unidirectional' | 'concentric' | 'free') | components['schemas']['token-2'];
|
|
20294
|
+
sweetSpot?: components['schemas']['vec3'];
|
|
20295
|
+
/** @description Quantum mode only: presentation base of the circle (e.g. 108); values stay in degrees. */
|
|
20296
|
+
angularBase?: number;
|
|
20297
|
+
} & {
|
|
20298
|
+
[key: string]: unknown;
|
|
20299
|
+
};
|
|
20300
|
+
lens: {
|
|
20301
|
+
kind: ('fisheye' | 'standard' | 'pyramid' | 'prism' | 'equirect') | components['schemas']['token-2'];
|
|
20302
|
+
/** @description ° */
|
|
20303
|
+
fov?: number;
|
|
20304
|
+
throwRatio?: number | null;
|
|
20305
|
+
/** @description lens shift [x, y] as a fraction of the image size */
|
|
20306
|
+
shift?: components['schemas']['vec2'];
|
|
20307
|
+
/** @description 1.1 (02b E4): lens distortion model. */
|
|
20308
|
+
distortion?: {
|
|
20309
|
+
model: ('brown-conrady' | 'fisheye-equidistant' | 'fisheye-equisolid' | 'fisheye-poly' | 'radial') | components['schemas']['token-2'];
|
|
20310
|
+
/** @description brown-conrady [k1,k2,k3,p1,p2]; fisheye-poly [k1..k4]; radial [k1,k2,k3] (01b §4.2.1) */
|
|
20311
|
+
coefficients?: number[];
|
|
20312
|
+
/** @description distortion centre, normalised image coordinates */
|
|
20313
|
+
centre?: number[];
|
|
20314
|
+
} & {
|
|
20315
|
+
[key: string]: unknown;
|
|
20316
|
+
};
|
|
20317
|
+
/** @description 1.1 (02b E4): lens profile id shipped as data (engine data/lens_profiles/<id>.json), e.g. sh001. */
|
|
20318
|
+
profileRef?: string;
|
|
20319
|
+
/** @description 1.1 (EN, curved LED walls): the display surface is a cylinder (axis vertical = curved horizontally, the usual curved wall) or a sphere section; absent = flat. */
|
|
20320
|
+
curvature?: {
|
|
20321
|
+
/** @description m, curvature radius of the panel surface */
|
|
20322
|
+
radius: number;
|
|
20323
|
+
/** @default vertical */
|
|
20324
|
+
axis: ('vertical' | 'horizontal' | 'spherical') | components['schemas']['token-2'];
|
|
20325
|
+
/**
|
|
20326
|
+
* @description true = curved towards the audience
|
|
20327
|
+
* @default true
|
|
20328
|
+
*/
|
|
20329
|
+
concave: boolean;
|
|
20330
|
+
} & {
|
|
20331
|
+
[key: string]: unknown;
|
|
20332
|
+
};
|
|
20333
|
+
} & {
|
|
20334
|
+
[key: string]: unknown;
|
|
20335
|
+
};
|
|
20336
|
+
pose: {
|
|
20337
|
+
position?: components['schemas']['vec3'];
|
|
20338
|
+
rotation?: components['schemas']['quat'];
|
|
20339
|
+
} & {
|
|
20340
|
+
[key: string]: unknown;
|
|
20341
|
+
};
|
|
20342
|
+
/** @description Visual device (01b §4.2): projector (incl. fisheye), LED, prism unit, smartphone + lens, NDI output. */
|
|
20343
|
+
display: {
|
|
20344
|
+
id: components['schemas']['id'];
|
|
20345
|
+
name?: string;
|
|
20346
|
+
type: ('projector' | 'led' | 'prism_unit' | 'smartphone_lens' | 'ndi_output') | components['schemas']['token-2'];
|
|
20347
|
+
model?: {
|
|
20348
|
+
vendor?: string;
|
|
20349
|
+
product?: string;
|
|
20350
|
+
variant?: string;
|
|
20351
|
+
} & {
|
|
20352
|
+
[key: string]: unknown;
|
|
20353
|
+
};
|
|
20354
|
+
resolution?: components['schemas']['size2'];
|
|
20355
|
+
/** @description Hz */
|
|
20356
|
+
refreshRate?: number;
|
|
20357
|
+
lens?: components['schemas']['lens'];
|
|
20358
|
+
pose?: components['schemas']['pose'];
|
|
20359
|
+
output?: {
|
|
20360
|
+
host?: string;
|
|
20361
|
+
/** @description e.g. DP-1, HDMI-1, stream:<displayId> */
|
|
20362
|
+
connector?: string;
|
|
20363
|
+
} & {
|
|
20364
|
+
[key: string]: unknown;
|
|
20365
|
+
};
|
|
20366
|
+
colour?: {
|
|
20367
|
+
gamut?: ('rec709' | 'dci-p3' | 'display-p3' | 'rec2020' | 'srgb') | components['schemas']['token-2'];
|
|
20368
|
+
gamma?: number;
|
|
20369
|
+
whitePoint?: string;
|
|
20370
|
+
} & {
|
|
20371
|
+
[key: string]: unknown;
|
|
20372
|
+
};
|
|
20373
|
+
stereo?: null | ({
|
|
20374
|
+
/** @enum {unknown} */
|
|
20375
|
+
eye: 'left' | 'right';
|
|
20376
|
+
} & {
|
|
20377
|
+
[key: string]: unknown;
|
|
20378
|
+
});
|
|
20379
|
+
optics?: components['schemas']['optics'];
|
|
20380
|
+
prism?: components['schemas']['prism'];
|
|
20381
|
+
} & {
|
|
20382
|
+
[key: string]: unknown;
|
|
20383
|
+
};
|
|
20384
|
+
displayCalibration: {
|
|
20385
|
+
warp?: {
|
|
20386
|
+
/** @description FDMESH file (01b §5) */
|
|
20387
|
+
file: components['schemas']['path'];
|
|
20388
|
+
kind?: 'uv-grid' | components['schemas']['token-2'];
|
|
20389
|
+
/** @description [cols, rows]; must match the FDMESH header */
|
|
20390
|
+
size?: components['schemas']['size2'];
|
|
20391
|
+
} & {
|
|
20392
|
+
[key: string]: unknown;
|
|
20393
|
+
};
|
|
20394
|
+
blend?: {
|
|
20395
|
+
/** @description 16-bit greyscale PNG */
|
|
20396
|
+
file: components['schemas']['path'];
|
|
20397
|
+
/** @enum {unknown} */
|
|
20398
|
+
bitDepth?: 8 | 16;
|
|
20399
|
+
gamma?: number;
|
|
20400
|
+
} & {
|
|
20401
|
+
[key: string]: unknown;
|
|
20402
|
+
};
|
|
20403
|
+
colour?: {
|
|
20404
|
+
/** @description Adobe / Resolve .cube 3D LUT */
|
|
20405
|
+
lut?: components['schemas']['path'];
|
|
20406
|
+
blackLevel?: components['schemas']['unit'];
|
|
20407
|
+
} & {
|
|
20408
|
+
[key: string]: unknown;
|
|
20409
|
+
};
|
|
20410
|
+
report?: {
|
|
20411
|
+
method?: ('camera-homography' | 'manual' | 'imported' | 'model') | components['schemas']['token-2'];
|
|
20412
|
+
/** Format: date-time */
|
|
20413
|
+
date?: string;
|
|
20414
|
+
meanError?: number;
|
|
20415
|
+
maxError?: number;
|
|
20416
|
+
unit?: ('px' | 'deg' | 'mm') | components['schemas']['token-2'];
|
|
20417
|
+
file?: components['schemas']['path'];
|
|
20418
|
+
} & {
|
|
20419
|
+
[key: string]: unknown;
|
|
20420
|
+
};
|
|
20421
|
+
} & {
|
|
20422
|
+
[key: string]: unknown;
|
|
20423
|
+
};
|
|
20424
|
+
/** @description Per-display calibration (01b §4.3); keys of `displays` are display ids (checked by the codecs). */
|
|
20425
|
+
calibration: {
|
|
20426
|
+
displays?: {
|
|
20427
|
+
[key: string]: components['schemas']['displayCalibration'];
|
|
20428
|
+
};
|
|
20429
|
+
} & {
|
|
20430
|
+
[key: string]: unknown;
|
|
20431
|
+
};
|
|
20432
|
+
speaker: {
|
|
20433
|
+
id: components['schemas']['id'];
|
|
20434
|
+
/** @description ° (0 = front, clockwise from above) */
|
|
20435
|
+
azimuth: number;
|
|
20436
|
+
/** @description ° (0 = spring line) */
|
|
20437
|
+
elevation: number;
|
|
20438
|
+
/** @description m */
|
|
20439
|
+
distance?: number;
|
|
20440
|
+
channel?: number;
|
|
20441
|
+
delayMs?: number;
|
|
20442
|
+
gainDb?: components['schemas']['gainDb'];
|
|
20443
|
+
kind?: ('fullrange' | 'subwoofer' | 'satellite') | components['schemas']['token-2'];
|
|
20444
|
+
lfe?: boolean;
|
|
20445
|
+
} & {
|
|
20446
|
+
[key: string]: unknown;
|
|
20447
|
+
};
|
|
20448
|
+
audioDevice: {
|
|
20449
|
+
id: components['schemas']['id'];
|
|
20450
|
+
name?: string;
|
|
20451
|
+
kind: ('qrd' | 'patefon' | 'karmic_cluster' | 'speaker_amp' | 'microphone') | components['schemas']['token-2'];
|
|
20452
|
+
/** @description e.g. osc://10.0.0.20:9000 */
|
|
20453
|
+
address?: string;
|
|
20454
|
+
} & {
|
|
20455
|
+
[key: string]: unknown;
|
|
20456
|
+
};
|
|
20457
|
+
/** @description AnantaSound layout (01b §4.4). */
|
|
20458
|
+
audio: {
|
|
20459
|
+
ambisonics?: {
|
|
20460
|
+
order?: number;
|
|
20461
|
+
normalisation?: ('SN3D' | 'N3D' | 'FuMa') | components['schemas']['token-2'];
|
|
20462
|
+
channelOrder?: ('ACN' | 'FuMa') | components['schemas']['token-2'];
|
|
20463
|
+
} & {
|
|
20464
|
+
[key: string]: unknown;
|
|
20465
|
+
};
|
|
20466
|
+
decoder?: {
|
|
20467
|
+
kind?: ('allrad' | 'sad' | 'mmd' | 'epad') | components['schemas']['token-2'];
|
|
20468
|
+
dualBand?: boolean;
|
|
20469
|
+
} & {
|
|
20470
|
+
[key: string]: unknown;
|
|
20471
|
+
};
|
|
20472
|
+
speakers?: components['schemas']['speaker'][];
|
|
20473
|
+
roomCorrection?: {
|
|
20474
|
+
file: components['schemas']['path'];
|
|
20475
|
+
kind?: ('fir' | 'iir' | 'peq') | components['schemas']['token-2'];
|
|
20476
|
+
} & {
|
|
20477
|
+
[key: string]: unknown;
|
|
20478
|
+
};
|
|
20479
|
+
devices?: components['schemas']['audioDevice'][];
|
|
20480
|
+
} & {
|
|
20481
|
+
[key: string]: unknown;
|
|
20482
|
+
};
|
|
20483
|
+
/** @description Content mapping onto the dome (01b §4.5, 02b §4.4). */
|
|
20484
|
+
mapping: {
|
|
20485
|
+
projection: ('domemaster' | 'equirect' | 'cubemap' | 'flat' | 'pyramid_views') | components['schemas']['token-2'];
|
|
20486
|
+
/** @description ° (domemaster 180–230) */
|
|
20487
|
+
fov?: number;
|
|
20488
|
+
tilt?: number;
|
|
20489
|
+
/** @description flat: ° centre azimuth */
|
|
20490
|
+
azimuth?: number;
|
|
20491
|
+
/** @description flat: ° centre elevation */
|
|
20492
|
+
elevation?: number;
|
|
20493
|
+
/** @description flat: ° angular width */
|
|
20494
|
+
width?: number;
|
|
20495
|
+
/**
|
|
20496
|
+
* @description 1.1 pyramid_views: number of views
|
|
20497
|
+
* @enum {unknown}
|
|
20498
|
+
*/
|
|
20499
|
+
faces?: 3 | 4 | 6;
|
|
20500
|
+
/** @description 1.1: cubemap 3x2 | 6x1 | cross; pyramid_views cross | row | grid */
|
|
20501
|
+
layout?: ('3x2' | '6x1' | 'cross' | 'row' | 'grid') | components['schemas']['token-2'];
|
|
20502
|
+
} & {
|
|
20503
|
+
[key: string]: unknown;
|
|
20504
|
+
};
|
|
20505
|
+
/** @description Media / scene (01b §4.5). External assets (absolute URI) carry sha256 + size. */
|
|
20506
|
+
asset: {
|
|
20507
|
+
id: components['schemas']['id'];
|
|
20508
|
+
name?: string;
|
|
20509
|
+
src: components['schemas']['uriOrPath'];
|
|
20510
|
+
sha256?: components['schemas']['sha256'];
|
|
20511
|
+
size?: number;
|
|
20512
|
+
type: ('video' | 'image' | 'audio' | 'zelim' | 'boranko' | 'comics' | 'realtime' | 'stream') | components['schemas']['token-2'];
|
|
20513
|
+
mapping?: components['schemas']['mapping'];
|
|
20514
|
+
video?: {
|
|
20515
|
+
resolution?: components['schemas']['size2'];
|
|
20516
|
+
fps?: number;
|
|
20517
|
+
codec?: ('hap' | 'hap-q' | 'hap-alpha' | 'h264' | 'h265' | 'av1' | 'vp9' | 'prores' | 'png-sequence' | 'exr-sequence') | components['schemas']['token-2'];
|
|
20518
|
+
stereo?: null | ('top-bottom' | 'side-by-side');
|
|
20519
|
+
} & {
|
|
20520
|
+
[key: string]: unknown;
|
|
20521
|
+
};
|
|
20522
|
+
audio?: {
|
|
20523
|
+
kind: ('ambisonic' | 'channels' | 'stereo' | 'mono') | components['schemas']['token-2'];
|
|
20524
|
+
order?: number;
|
|
20525
|
+
/** @description channels: e.g. 5.1, 7.1, 7.1.4 */
|
|
20526
|
+
layout?: string;
|
|
20527
|
+
} & {
|
|
20528
|
+
[key: string]: unknown;
|
|
20529
|
+
};
|
|
20530
|
+
duration?: components['schemas']['seconds'];
|
|
20531
|
+
thumbnail?: components['schemas']['path'];
|
|
20532
|
+
/** @description 1.1: hint for type zelim (project = JSON variant J, binary = variant B); content sniffing wins. A J project may carry quantum.scene (02e §9.3). */
|
|
20533
|
+
zelim?: {
|
|
20534
|
+
variant?: ('project' | 'binary') | components['schemas']['token-2'];
|
|
20535
|
+
} & {
|
|
20536
|
+
[key: string]: unknown;
|
|
20537
|
+
};
|
|
20538
|
+
} & {
|
|
20539
|
+
[key: string]: unknown;
|
|
20540
|
+
};
|
|
20541
|
+
transition: {
|
|
20542
|
+
kind: ('cut' | 'fade' | 'dissolve' | 'wipe') | components['schemas']['token-2'];
|
|
20543
|
+
duration?: components['schemas']['seconds'];
|
|
20544
|
+
} & {
|
|
20545
|
+
[key: string]: unknown;
|
|
20546
|
+
};
|
|
20547
|
+
/** @description x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8). */
|
|
20548
|
+
playlistItem: {
|
|
20549
|
+
asset: components['schemas']['id'];
|
|
20550
|
+
in?: components['schemas']['seconds'];
|
|
20551
|
+
out?: components['schemas']['seconds'];
|
|
20552
|
+
loop?: boolean;
|
|
20553
|
+
transition?: components['schemas']['transition'];
|
|
20554
|
+
} & {
|
|
20555
|
+
[key: string]: unknown;
|
|
20556
|
+
};
|
|
20557
|
+
playlist: {
|
|
20558
|
+
id: components['schemas']['id'];
|
|
20559
|
+
name?: string;
|
|
20560
|
+
loop?: boolean;
|
|
20561
|
+
items: components['schemas']['playlistItem'][];
|
|
20562
|
+
} & {
|
|
20563
|
+
[key: string]: unknown;
|
|
20564
|
+
};
|
|
20565
|
+
/** @description x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8). */
|
|
20566
|
+
clip: {
|
|
20567
|
+
asset: components['schemas']['id'];
|
|
20568
|
+
start: components['schemas']['seconds'];
|
|
20569
|
+
in?: components['schemas']['seconds'];
|
|
20570
|
+
out?: components['schemas']['seconds'];
|
|
20571
|
+
gainDb?: components['schemas']['gainDb'];
|
|
20572
|
+
opacity?: components['schemas']['unit'];
|
|
20573
|
+
} & {
|
|
20574
|
+
[key: string]: unknown;
|
|
20575
|
+
};
|
|
20576
|
+
timeline: {
|
|
20577
|
+
id: components['schemas']['id'];
|
|
20578
|
+
name?: string;
|
|
20579
|
+
duration?: components['schemas']['seconds'];
|
|
20580
|
+
tracks: ({
|
|
20581
|
+
id?: components['schemas']['id'];
|
|
20582
|
+
kind: ('video' | 'audio' | 'control') | components['schemas']['token-2'];
|
|
20583
|
+
clips: components['schemas']['clip'][];
|
|
20584
|
+
} & {
|
|
20585
|
+
[key: string]: unknown;
|
|
20586
|
+
})[];
|
|
20587
|
+
markers?: ({
|
|
20588
|
+
time: components['schemas']['seconds'];
|
|
20589
|
+
name?: string;
|
|
20590
|
+
id?: components['schemas']['id'];
|
|
20591
|
+
kind?: ('marker' | 'pause' | 'jump' | 'timecode') | components['schemas']['token-2'];
|
|
20592
|
+
} & {
|
|
20593
|
+
[key: string]: unknown;
|
|
20594
|
+
})[];
|
|
20595
|
+
/** @description 1.1 (02d) */
|
|
20596
|
+
fps?: number;
|
|
20597
|
+
} & {
|
|
20598
|
+
[key: string]: unknown;
|
|
20599
|
+
};
|
|
20600
|
+
matrixAxis: (components['schemas']['id'] | ({
|
|
20601
|
+
id: components['schemas']['id'];
|
|
20602
|
+
name?: string;
|
|
20603
|
+
} & {
|
|
20604
|
+
[key: string]: unknown;
|
|
20605
|
+
}))[];
|
|
20606
|
+
/** @description Screenberry-style matrix (compatibility); cells reference row / column ids. */
|
|
20607
|
+
matrix: {
|
|
20608
|
+
id?: components['schemas']['id'];
|
|
20609
|
+
rows: components['schemas']['matrixAxis'];
|
|
20610
|
+
columns: components['schemas']['matrixAxis'];
|
|
20611
|
+
cells: ({
|
|
20612
|
+
row: components['schemas']['id'];
|
|
20613
|
+
column: components['schemas']['id'];
|
|
20614
|
+
asset: components['schemas']['id'];
|
|
20615
|
+
} & {
|
|
20616
|
+
[key: string]: unknown;
|
|
20617
|
+
})[];
|
|
20618
|
+
} & {
|
|
20619
|
+
[key: string]: unknown;
|
|
20620
|
+
};
|
|
20621
|
+
action: {
|
|
20622
|
+
do: ('play' | 'pause' | 'stop' | 'seek' | 'setVolume' | 'setBrightness' | 'setParameter' | 'osc' | 'http' | 'scenario') | components['schemas']['token-2'];
|
|
20623
|
+
/** @description e.g. player id, playlist:<id>, param path, osc://host:port/address, URL */
|
|
20624
|
+
target?: string;
|
|
20625
|
+
/** @description Action arguments (object or positional array). */
|
|
20626
|
+
args?: unknown;
|
|
20627
|
+
} & {
|
|
20628
|
+
[key: string]: unknown;
|
|
20629
|
+
};
|
|
20630
|
+
cue: {
|
|
20631
|
+
id: components['schemas']['id'];
|
|
20632
|
+
name?: string;
|
|
20633
|
+
at?: ({
|
|
20634
|
+
timeline: components['schemas']['id'];
|
|
20635
|
+
time: components['schemas']['seconds'];
|
|
20636
|
+
} & {
|
|
20637
|
+
[key: string]: unknown;
|
|
20638
|
+
}) | ({
|
|
20639
|
+
trigger: components['schemas']['id'];
|
|
20640
|
+
} & {
|
|
20641
|
+
[key: string]: unknown;
|
|
20642
|
+
});
|
|
20643
|
+
actions: components['schemas']['action'][];
|
|
20644
|
+
} & {
|
|
20645
|
+
[key: string]: unknown;
|
|
20646
|
+
};
|
|
20647
|
+
trigger: {
|
|
20648
|
+
id: components['schemas']['id'];
|
|
20649
|
+
source: ('osc' | 'midi' | 'time' | 'api' | 'dmx') | components['schemas']['token-2'];
|
|
20650
|
+
/** @description Source-specific match (OSC address pattern, MIDI note, cron / time, DMX channel …). */
|
|
20651
|
+
match?: unknown;
|
|
20652
|
+
} & {
|
|
20653
|
+
[key: string]: unknown;
|
|
20654
|
+
};
|
|
20655
|
+
/** @description Exactly one of playlist / timeline / matrix / asset id. */
|
|
20656
|
+
showRef: ({
|
|
20657
|
+
playlist?: components['schemas']['id'];
|
|
20658
|
+
timeline?: components['schemas']['id'];
|
|
20659
|
+
matrix?: components['schemas']['id'];
|
|
20660
|
+
asset?: components['schemas']['id'];
|
|
20661
|
+
} & {
|
|
20662
|
+
[key: string]: unknown;
|
|
20663
|
+
}) & (unknown | unknown | unknown | unknown);
|
|
20664
|
+
/** @description Playlists, timelines, matrix, cues, triggers, startup (01b §4.6). */
|
|
20665
|
+
show: {
|
|
20666
|
+
playlists?: components['schemas']['playlist'][];
|
|
20667
|
+
timelines?: components['schemas']['timeline'][];
|
|
20668
|
+
matrix?: components['schemas']['matrix'];
|
|
20669
|
+
cues?: components['schemas']['cue'][];
|
|
20670
|
+
triggers?: components['schemas']['trigger'][];
|
|
20671
|
+
mediaPlayers?: components['schemas']['mediaPlayer'][];
|
|
20672
|
+
/** @description What plays when the venue powers on. */
|
|
20673
|
+
startup?: components['schemas']['showRef'];
|
|
20674
|
+
/** @description 1.1 (02c AQ4, replaces x-ananta.mode): audio engines used by the show; absent = digital. */
|
|
20675
|
+
audioMode?: ('digital' | 'hybrid' | 'combined') | components['schemas']['token-2'];
|
|
20676
|
+
} & {
|
|
20677
|
+
[key: string]: unknown;
|
|
20678
|
+
};
|
|
20679
|
+
/** @description Declarative mappings for the A6 gateways (01b §4.7); never required for playback. */
|
|
20680
|
+
compat: {
|
|
20681
|
+
[key: string]: Record<string, never>;
|
|
20682
|
+
};
|
|
20683
|
+
/** @description Normalised [x, y, w, h] of the display frame (0..1, origin top-left, y down; 01b §3). */
|
|
20684
|
+
rect: number[];
|
|
20685
|
+
/** @description 1.1 (02a V12, replaces x-freedome-optics): per-face layout of prism / pyramid optics on the display frame. */
|
|
20686
|
+
optics: {
|
|
20687
|
+
/** @enum {unknown} */
|
|
20688
|
+
faces: 1 | 3 | 4 | 6;
|
|
20689
|
+
/** @description ° between a face and the screen plane */
|
|
20690
|
+
faceAngle?: number;
|
|
20691
|
+
viewports?: ({
|
|
20692
|
+
/** @description 0 = front, clockwise from above */
|
|
20693
|
+
face: number;
|
|
20694
|
+
rect: components['schemas']['rect'];
|
|
20695
|
+
/** @description ° clockwise */
|
|
20696
|
+
rotation?: number;
|
|
20697
|
+
/** @enum {unknown} */
|
|
20698
|
+
mirror?: 'none' | 'horizontal' | 'vertical';
|
|
20699
|
+
} & {
|
|
20700
|
+
[key: string]: unknown;
|
|
20701
|
+
})[];
|
|
20702
|
+
/** @description lit region; outside is black */
|
|
20703
|
+
activeRegion?: components['schemas']['rect'];
|
|
20704
|
+
} & {
|
|
20705
|
+
[key: string]: unknown;
|
|
20706
|
+
};
|
|
20707
|
+
/** @description 1.1 (02b E4): physical prism / pyramid geometry (engine PrismGeometry). */
|
|
20708
|
+
prism: {
|
|
20709
|
+
faces: number;
|
|
20710
|
+
baseMm?: number;
|
|
20711
|
+
heightMm?: number;
|
|
20712
|
+
faceAngle?: number;
|
|
20713
|
+
refractiveIndex?: number;
|
|
20714
|
+
solid?: boolean;
|
|
20715
|
+
} & {
|
|
20716
|
+
[key: string]: unknown;
|
|
20717
|
+
};
|
|
20718
|
+
/** @description 1.1 (02d MD8): named media player. Player `main` always exists (implicit: all displays, source = startup). */
|
|
20719
|
+
mediaPlayer: {
|
|
20720
|
+
id: components['schemas']['id'];
|
|
20721
|
+
name?: string;
|
|
20722
|
+
/** @description absent = all displays */
|
|
20723
|
+
target?: {
|
|
20724
|
+
displays?: components['schemas']['id'][];
|
|
20725
|
+
layer?: number;
|
|
20726
|
+
} & {
|
|
20727
|
+
[key: string]: unknown;
|
|
20728
|
+
};
|
|
20729
|
+
source?: components['schemas']['showRef'];
|
|
20730
|
+
volume?: components['schemas']['unit'];
|
|
20731
|
+
brightness?: components['schemas']['unit'];
|
|
20732
|
+
/** @description ° content rotation about the dome axis */
|
|
20733
|
+
rotation?: number;
|
|
20734
|
+
/** @description playback rate, 1 = normal */
|
|
20735
|
+
speed?: number;
|
|
20736
|
+
} & {
|
|
20737
|
+
[key: string]: unknown;
|
|
20738
|
+
};
|
|
20739
|
+
};
|
|
20740
|
+
} & {
|
|
20741
|
+
[key: string]: unknown;
|
|
20742
|
+
}) & (unknown & unknown & unknown);
|
|
20743
|
+
checkItem: {
|
|
20744
|
+
id: string;
|
|
20745
|
+
done: boolean;
|
|
20746
|
+
note?: string;
|
|
20747
|
+
};
|
|
20748
|
+
attachment: {
|
|
20749
|
+
/** Format: uuid */
|
|
20750
|
+
id: string;
|
|
20751
|
+
name: string;
|
|
20752
|
+
/** @enum {unknown} */
|
|
20753
|
+
contentType: 'image/jpeg' | 'image/png' | 'image/webp' | 'application/pdf';
|
|
20754
|
+
size: number;
|
|
20755
|
+
/** Format: date-time */
|
|
20756
|
+
createdAt: string;
|
|
20757
|
+
};
|
|
20758
|
+
consent: {
|
|
20759
|
+
/** Format: date-time */
|
|
20760
|
+
at: string;
|
|
20761
|
+
version: string;
|
|
19179
20762
|
};
|
|
19180
|
-
|
|
19181
|
-
|
|
19182
|
-
|
|
20763
|
+
dossier: {
|
|
20764
|
+
/** Format: uuid */
|
|
20765
|
+
id: string;
|
|
20766
|
+
version: number;
|
|
20767
|
+
/** @enum {unknown} */
|
|
20768
|
+
lang: 'en' | 'ru';
|
|
20769
|
+
/** @enum {unknown} */
|
|
20770
|
+
stage: 'intake' | 'survey' | 'choices' | 'prepared' | 'installed';
|
|
20771
|
+
claimed?: boolean;
|
|
20772
|
+
room?: Record<string, never>;
|
|
20773
|
+
goals?: string;
|
|
20774
|
+
answers: Record<string, never>;
|
|
20775
|
+
choices?: Record<string, never>;
|
|
20776
|
+
estimates?: {
|
|
20777
|
+
[key: string]: Record<string, never>;
|
|
20778
|
+
};
|
|
20779
|
+
domeDraft?: components['schemas']['dome.schema'];
|
|
20780
|
+
checklist: components['schemas']['checkItem'][];
|
|
20781
|
+
openItems: string[];
|
|
20782
|
+
attachments: components['schemas']['attachment'][];
|
|
20783
|
+
consent?: components['schemas']['consent'];
|
|
20784
|
+
/** Format: uuid */
|
|
20785
|
+
linkedInstallationId?: string;
|
|
20786
|
+
/** Format: date-time */
|
|
20787
|
+
expiresAt?: string;
|
|
20788
|
+
/** Format: date-time */
|
|
20789
|
+
createdAt: string;
|
|
20790
|
+
/** Format: date-time */
|
|
20791
|
+
updatedAt: string;
|
|
19183
20792
|
};
|
|
19184
|
-
|
|
19185
|
-
|
|
19186
|
-
ttlHours?: number;
|
|
20793
|
+
consentRequest: {
|
|
20794
|
+
version: string;
|
|
19187
20795
|
};
|
|
19188
|
-
/** @description Lowercase hex SHA-256 digest. */
|
|
19189
|
-
sha256: string;
|
|
19190
20796
|
enrollRequest: {
|
|
19191
20797
|
fingerprintHash: components['schemas']['sha256'];
|
|
19192
20798
|
/** @description ed25519 public key, base64url (32 bytes) */
|
|
@@ -19340,6 +20946,10 @@ type components = {
|
|
|
19340
20946
|
UserCode: string;
|
|
19341
20947
|
/** @description Catalogue item id. */
|
|
19342
20948
|
ItemId: string;
|
|
20949
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
20950
|
+
DossierCode: string;
|
|
20951
|
+
/** @description Attachment id. */
|
|
20952
|
+
AttachmentId: string;
|
|
19343
20953
|
/** @description Page size (default 20, max 100 on the cloud server, 02h §3.4). */
|
|
19344
20954
|
CloudLimit: number;
|
|
19345
20955
|
/** @description Opaque cursor from the previous page's `nextCursor`. */
|
|
@@ -21261,47 +22871,320 @@ interface operations {
|
|
|
21261
22871
|
default: components['responses']['Problem'];
|
|
21262
22872
|
};
|
|
21263
22873
|
};
|
|
21264
|
-
revokeOrgInstallation: {
|
|
22874
|
+
revokeOrgInstallation: {
|
|
22875
|
+
parameters: {
|
|
22876
|
+
query?: never;
|
|
22877
|
+
header?: never;
|
|
22878
|
+
path: {
|
|
22879
|
+
/** @description Organisation id. */
|
|
22880
|
+
orgId: components['parameters']['OrgId'];
|
|
22881
|
+
/** @description Installation id. */
|
|
22882
|
+
installationId: components['parameters']['InstallationId'];
|
|
22883
|
+
};
|
|
22884
|
+
cookie?: never;
|
|
22885
|
+
};
|
|
22886
|
+
requestBody?: never;
|
|
22887
|
+
responses: {
|
|
22888
|
+
204: components['responses']['NoContent'];
|
|
22889
|
+
401: components['responses']['Problem'];
|
|
22890
|
+
403: components['responses']['Problem'];
|
|
22891
|
+
404: components['responses']['Problem'];
|
|
22892
|
+
default: components['responses']['Problem'];
|
|
22893
|
+
};
|
|
22894
|
+
};
|
|
22895
|
+
patchOrgInstallation: {
|
|
22896
|
+
parameters: {
|
|
22897
|
+
query?: never;
|
|
22898
|
+
header?: never;
|
|
22899
|
+
path: {
|
|
22900
|
+
/** @description Organisation id. */
|
|
22901
|
+
orgId: components['parameters']['OrgId'];
|
|
22902
|
+
/** @description Installation id. */
|
|
22903
|
+
installationId: components['parameters']['InstallationId'];
|
|
22904
|
+
};
|
|
22905
|
+
cookie?: never;
|
|
22906
|
+
};
|
|
22907
|
+
requestBody: {
|
|
22908
|
+
content: {
|
|
22909
|
+
/**
|
|
22910
|
+
* @example {
|
|
22911
|
+
* "telemetryLevel": "full"
|
|
22912
|
+
* }
|
|
22913
|
+
*/
|
|
22914
|
+
'application/merge-patch+json': components['schemas']['installationPatch'];
|
|
22915
|
+
};
|
|
22916
|
+
};
|
|
22917
|
+
responses: {
|
|
22918
|
+
/** @description OK. */
|
|
22919
|
+
200: {
|
|
22920
|
+
headers: {
|
|
22921
|
+
[name: string]: unknown;
|
|
22922
|
+
};
|
|
22923
|
+
content: {
|
|
22924
|
+
/**
|
|
22925
|
+
* @example {
|
|
22926
|
+
* "id": "0192f3a4-5b6c-7d8e-9f01-23456789c005",
|
|
22927
|
+
* "orgId": "0192f3a4-5b6c-7d8e-9f01-23456789c002",
|
|
22928
|
+
* "name": "Dome 8 m",
|
|
22929
|
+
* "platform": "linux",
|
|
22930
|
+
* "arch": "x86_64",
|
|
22931
|
+
* "mediaserverVersion": "1.0.0",
|
|
22932
|
+
* "status": "active",
|
|
22933
|
+
* "telemetryLevel": "basic",
|
|
22934
|
+
* "enrolledAt": "2026-10-19T12:00:00.000Z"
|
|
22935
|
+
* }
|
|
22936
|
+
*/
|
|
22937
|
+
'application/json': components['schemas']['installation'];
|
|
22938
|
+
};
|
|
22939
|
+
};
|
|
22940
|
+
401: components['responses']['Problem'];
|
|
22941
|
+
403: components['responses']['Problem'];
|
|
22942
|
+
404: components['responses']['Problem'];
|
|
22943
|
+
422: components['responses']['Problem'];
|
|
22944
|
+
default: components['responses']['Problem'];
|
|
22945
|
+
};
|
|
22946
|
+
};
|
|
22947
|
+
listEnrollmentTokens: {
|
|
22948
|
+
parameters: {
|
|
22949
|
+
query?: {
|
|
22950
|
+
/** @description Page size (default 20, max 100 on the cloud server, 02h §3.4). */
|
|
22951
|
+
limit?: components['parameters']['CloudLimit'];
|
|
22952
|
+
/** @description Opaque cursor from the previous page's `nextCursor`. */
|
|
22953
|
+
cursor?: components['parameters']['Cursor'];
|
|
22954
|
+
};
|
|
22955
|
+
header?: never;
|
|
22956
|
+
path: {
|
|
22957
|
+
/** @description Organisation id. */
|
|
22958
|
+
orgId: components['parameters']['OrgId'];
|
|
22959
|
+
};
|
|
22960
|
+
cookie?: never;
|
|
22961
|
+
};
|
|
22962
|
+
requestBody?: never;
|
|
22963
|
+
responses: {
|
|
22964
|
+
/** @description OK. */
|
|
22965
|
+
200: {
|
|
22966
|
+
headers: {
|
|
22967
|
+
[name: string]: unknown;
|
|
22968
|
+
};
|
|
22969
|
+
content: {
|
|
22970
|
+
/**
|
|
22971
|
+
* @example {
|
|
22972
|
+
* "items": [
|
|
22973
|
+
* {
|
|
22974
|
+
* "id": "0192f3a4-5b6c-7d8e-9f01-23456789c007",
|
|
22975
|
+
* "name": "Bench",
|
|
22976
|
+
* "expiresAt": "2026-10-20T12:00:00.000Z",
|
|
22977
|
+
* "usedAt": null
|
|
22978
|
+
* }
|
|
22979
|
+
* ],
|
|
22980
|
+
* "nextCursor": null
|
|
22981
|
+
* }
|
|
22982
|
+
*/
|
|
22983
|
+
'application/json': components['schemas']['enrollmentTokenPage'];
|
|
22984
|
+
};
|
|
22985
|
+
};
|
|
22986
|
+
401: components['responses']['Problem'];
|
|
22987
|
+
403: components['responses']['Problem'];
|
|
22988
|
+
404: components['responses']['Problem'];
|
|
22989
|
+
default: components['responses']['Problem'];
|
|
22990
|
+
};
|
|
22991
|
+
};
|
|
22992
|
+
createEnrollmentToken: {
|
|
22993
|
+
parameters: {
|
|
22994
|
+
query?: never;
|
|
22995
|
+
header?: {
|
|
22996
|
+
/** @description UUID; replays within 24 h return the original response, a different body with the same key → 409. */
|
|
22997
|
+
'Idempotency-Key'?: components['parameters']['IdempotencyKey'];
|
|
22998
|
+
};
|
|
22999
|
+
path: {
|
|
23000
|
+
/** @description Organisation id. */
|
|
23001
|
+
orgId: components['parameters']['OrgId'];
|
|
23002
|
+
};
|
|
23003
|
+
cookie?: never;
|
|
23004
|
+
};
|
|
23005
|
+
requestBody: {
|
|
23006
|
+
content: {
|
|
23007
|
+
/**
|
|
23008
|
+
* @example {
|
|
23009
|
+
* "name": "Bench",
|
|
23010
|
+
* "ttlHours": 24
|
|
23011
|
+
* }
|
|
23012
|
+
*/
|
|
23013
|
+
'application/json': components['schemas']['enrollmentTokenInput'];
|
|
23014
|
+
};
|
|
23015
|
+
};
|
|
23016
|
+
responses: {
|
|
23017
|
+
/** @description OK. */
|
|
23018
|
+
201: {
|
|
23019
|
+
headers: {
|
|
23020
|
+
[name: string]: unknown;
|
|
23021
|
+
};
|
|
23022
|
+
content: {
|
|
23023
|
+
/**
|
|
23024
|
+
* @example {
|
|
23025
|
+
* "id": "0192f3a4-5b6c-7d8e-9f01-23456789c007",
|
|
23026
|
+
* "name": "Bench",
|
|
23027
|
+
* "expiresAt": "2026-10-20T12:00:00.000Z",
|
|
23028
|
+
* "usedAt": null,
|
|
23029
|
+
* "token": "example-enrollment-token-not-a-secret"
|
|
23030
|
+
* }
|
|
23031
|
+
*/
|
|
23032
|
+
'application/json': components['schemas']['enrollmentToken'];
|
|
23033
|
+
};
|
|
23034
|
+
};
|
|
23035
|
+
401: components['responses']['Problem'];
|
|
23036
|
+
403: components['responses']['Problem'];
|
|
23037
|
+
404: components['responses']['Problem'];
|
|
23038
|
+
422: components['responses']['Problem'];
|
|
23039
|
+
default: components['responses']['Problem'];
|
|
23040
|
+
};
|
|
23041
|
+
};
|
|
23042
|
+
revokeEnrollmentToken: {
|
|
23043
|
+
parameters: {
|
|
23044
|
+
query?: never;
|
|
23045
|
+
header?: never;
|
|
23046
|
+
path: {
|
|
23047
|
+
/** @description Organisation id. */
|
|
23048
|
+
orgId: components['parameters']['OrgId'];
|
|
23049
|
+
/** @description Enrollment token id. */
|
|
23050
|
+
tokenId: components['parameters']['EnrollmentTokenId'];
|
|
23051
|
+
};
|
|
23052
|
+
cookie?: never;
|
|
23053
|
+
};
|
|
23054
|
+
requestBody?: never;
|
|
23055
|
+
responses: {
|
|
23056
|
+
204: components['responses']['NoContent'];
|
|
23057
|
+
401: components['responses']['Problem'];
|
|
23058
|
+
403: components['responses']['Problem'];
|
|
23059
|
+
404: components['responses']['Problem'];
|
|
23060
|
+
default: components['responses']['Problem'];
|
|
23061
|
+
};
|
|
23062
|
+
};
|
|
23063
|
+
getDossierSelf: {
|
|
23064
|
+
parameters: {
|
|
23065
|
+
query?: never;
|
|
23066
|
+
header: {
|
|
23067
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23068
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
23069
|
+
};
|
|
23070
|
+
path?: never;
|
|
23071
|
+
cookie?: never;
|
|
23072
|
+
};
|
|
23073
|
+
requestBody?: never;
|
|
23074
|
+
responses: {
|
|
23075
|
+
/** @description OK. */
|
|
23076
|
+
200: {
|
|
23077
|
+
headers: {
|
|
23078
|
+
[name: string]: unknown;
|
|
23079
|
+
};
|
|
23080
|
+
content: {
|
|
23081
|
+
/**
|
|
23082
|
+
* @example {
|
|
23083
|
+
* "id": "018f0f6e-0000-7000-8000-000000000001",
|
|
23084
|
+
* "version": 3,
|
|
23085
|
+
* "lang": "en",
|
|
23086
|
+
* "stage": "survey",
|
|
23087
|
+
* "claimed": false,
|
|
23088
|
+
* "answers": {
|
|
23089
|
+
* "site": "indoor"
|
|
23090
|
+
* },
|
|
23091
|
+
* "checklist": [],
|
|
23092
|
+
* "openItems": [],
|
|
23093
|
+
* "attachments": [],
|
|
23094
|
+
* "createdAt": "2026-11-07T00:00:00Z",
|
|
23095
|
+
* "updatedAt": "2026-11-07T00:05:00Z"
|
|
23096
|
+
* }
|
|
23097
|
+
*/
|
|
23098
|
+
'application/json': components['schemas']['dossier'];
|
|
23099
|
+
};
|
|
23100
|
+
};
|
|
23101
|
+
404: components['responses']['Problem'];
|
|
23102
|
+
default: components['responses']['Problem'];
|
|
23103
|
+
};
|
|
23104
|
+
};
|
|
23105
|
+
deleteDossierSelf: {
|
|
23106
|
+
parameters: {
|
|
23107
|
+
query?: never;
|
|
23108
|
+
header: {
|
|
23109
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23110
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
23111
|
+
};
|
|
23112
|
+
path?: never;
|
|
23113
|
+
cookie?: never;
|
|
23114
|
+
};
|
|
23115
|
+
requestBody?: never;
|
|
23116
|
+
responses: {
|
|
23117
|
+
/** @description Deleted. */
|
|
23118
|
+
204: {
|
|
23119
|
+
headers: {
|
|
23120
|
+
[name: string]: unknown;
|
|
23121
|
+
};
|
|
23122
|
+
content?: never;
|
|
23123
|
+
};
|
|
23124
|
+
404: components['responses']['Problem'];
|
|
23125
|
+
default: components['responses']['Problem'];
|
|
23126
|
+
};
|
|
23127
|
+
};
|
|
23128
|
+
exportDossierSelf: {
|
|
21265
23129
|
parameters: {
|
|
21266
23130
|
query?: never;
|
|
21267
|
-
header
|
|
21268
|
-
|
|
21269
|
-
|
|
21270
|
-
orgId: components['parameters']['OrgId'];
|
|
21271
|
-
/** @description Installation id. */
|
|
21272
|
-
installationId: components['parameters']['InstallationId'];
|
|
23131
|
+
header: {
|
|
23132
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23133
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
21273
23134
|
};
|
|
23135
|
+
path?: never;
|
|
21274
23136
|
cookie?: never;
|
|
21275
23137
|
};
|
|
21276
23138
|
requestBody?: never;
|
|
21277
23139
|
responses: {
|
|
21278
|
-
|
|
21279
|
-
|
|
21280
|
-
|
|
23140
|
+
/** @description OK. */
|
|
23141
|
+
200: {
|
|
23142
|
+
headers: {
|
|
23143
|
+
[name: string]: unknown;
|
|
23144
|
+
};
|
|
23145
|
+
content: {
|
|
23146
|
+
/**
|
|
23147
|
+
* @example {
|
|
23148
|
+
* "id": "018f0f6e-0000-7000-8000-000000000001",
|
|
23149
|
+
* "version": 3,
|
|
23150
|
+
* "lang": "en",
|
|
23151
|
+
* "stage": "survey",
|
|
23152
|
+
* "claimed": false,
|
|
23153
|
+
* "answers": {
|
|
23154
|
+
* "site": "indoor"
|
|
23155
|
+
* },
|
|
23156
|
+
* "checklist": [],
|
|
23157
|
+
* "openItems": [],
|
|
23158
|
+
* "attachments": [],
|
|
23159
|
+
* "createdAt": "2026-11-07T00:00:00Z",
|
|
23160
|
+
* "updatedAt": "2026-11-07T00:05:00Z"
|
|
23161
|
+
* }
|
|
23162
|
+
*/
|
|
23163
|
+
'application/json': components['schemas']['dossier'];
|
|
23164
|
+
};
|
|
23165
|
+
};
|
|
21281
23166
|
404: components['responses']['Problem'];
|
|
21282
23167
|
default: components['responses']['Problem'];
|
|
21283
23168
|
};
|
|
21284
23169
|
};
|
|
21285
|
-
|
|
23170
|
+
consentDossier: {
|
|
21286
23171
|
parameters: {
|
|
21287
23172
|
query?: never;
|
|
21288
|
-
header
|
|
21289
|
-
|
|
21290
|
-
|
|
21291
|
-
orgId: components['parameters']['OrgId'];
|
|
21292
|
-
/** @description Installation id. */
|
|
21293
|
-
installationId: components['parameters']['InstallationId'];
|
|
23173
|
+
header: {
|
|
23174
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23175
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
21294
23176
|
};
|
|
23177
|
+
path?: never;
|
|
21295
23178
|
cookie?: never;
|
|
21296
23179
|
};
|
|
21297
23180
|
requestBody: {
|
|
21298
23181
|
content: {
|
|
21299
23182
|
/**
|
|
21300
23183
|
* @example {
|
|
21301
|
-
* "
|
|
23184
|
+
* "version": "2026-11"
|
|
21302
23185
|
* }
|
|
21303
23186
|
*/
|
|
21304
|
-
'application/
|
|
23187
|
+
'application/json': components['schemas']['consentRequest'];
|
|
21305
23188
|
};
|
|
21306
23189
|
};
|
|
21307
23190
|
responses: {
|
|
@@ -21313,40 +23196,37 @@ interface operations {
|
|
|
21313
23196
|
content: {
|
|
21314
23197
|
/**
|
|
21315
23198
|
* @example {
|
|
21316
|
-
* "id": "
|
|
21317
|
-
* "
|
|
21318
|
-
* "
|
|
21319
|
-
* "
|
|
21320
|
-
* "
|
|
21321
|
-
* "
|
|
21322
|
-
*
|
|
21323
|
-
*
|
|
21324
|
-
* "
|
|
23199
|
+
* "id": "018f0f6e-0000-7000-8000-000000000001",
|
|
23200
|
+
* "version": 3,
|
|
23201
|
+
* "lang": "en",
|
|
23202
|
+
* "stage": "survey",
|
|
23203
|
+
* "claimed": false,
|
|
23204
|
+
* "answers": {
|
|
23205
|
+
* "site": "indoor"
|
|
23206
|
+
* },
|
|
23207
|
+
* "checklist": [],
|
|
23208
|
+
* "openItems": [],
|
|
23209
|
+
* "attachments": [],
|
|
23210
|
+
* "createdAt": "2026-11-07T00:00:00Z",
|
|
23211
|
+
* "updatedAt": "2026-11-07T00:05:00Z"
|
|
21325
23212
|
* }
|
|
21326
23213
|
*/
|
|
21327
|
-
'application/json': components['schemas']['
|
|
23214
|
+
'application/json': components['schemas']['dossier'];
|
|
21328
23215
|
};
|
|
21329
23216
|
};
|
|
21330
|
-
401: components['responses']['Problem'];
|
|
21331
|
-
403: components['responses']['Problem'];
|
|
21332
23217
|
404: components['responses']['Problem'];
|
|
21333
23218
|
422: components['responses']['Problem'];
|
|
21334
23219
|
default: components['responses']['Problem'];
|
|
21335
23220
|
};
|
|
21336
23221
|
};
|
|
21337
|
-
|
|
23222
|
+
claimDossier: {
|
|
21338
23223
|
parameters: {
|
|
21339
|
-
query?:
|
|
21340
|
-
|
|
21341
|
-
|
|
21342
|
-
|
|
21343
|
-
cursor?: components['parameters']['Cursor'];
|
|
21344
|
-
};
|
|
21345
|
-
header?: never;
|
|
21346
|
-
path: {
|
|
21347
|
-
/** @description Organisation id. */
|
|
21348
|
-
orgId: components['parameters']['OrgId'];
|
|
23224
|
+
query?: never;
|
|
23225
|
+
header: {
|
|
23226
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23227
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
21349
23228
|
};
|
|
23229
|
+
path?: never;
|
|
21350
23230
|
cookie?: never;
|
|
21351
23231
|
};
|
|
21352
23232
|
requestBody?: never;
|
|
@@ -21359,52 +23239,50 @@ interface operations {
|
|
|
21359
23239
|
content: {
|
|
21360
23240
|
/**
|
|
21361
23241
|
* @example {
|
|
21362
|
-
* "
|
|
21363
|
-
*
|
|
21364
|
-
*
|
|
21365
|
-
*
|
|
21366
|
-
*
|
|
21367
|
-
*
|
|
21368
|
-
*
|
|
21369
|
-
*
|
|
21370
|
-
* "
|
|
23242
|
+
* "id": "018f0f6e-0000-7000-8000-000000000001",
|
|
23243
|
+
* "version": 3,
|
|
23244
|
+
* "lang": "en",
|
|
23245
|
+
* "stage": "survey",
|
|
23246
|
+
* "claimed": false,
|
|
23247
|
+
* "answers": {
|
|
23248
|
+
* "site": "indoor"
|
|
23249
|
+
* },
|
|
23250
|
+
* "checklist": [],
|
|
23251
|
+
* "openItems": [],
|
|
23252
|
+
* "attachments": [],
|
|
23253
|
+
* "createdAt": "2026-11-07T00:00:00Z",
|
|
23254
|
+
* "updatedAt": "2026-11-07T00:05:00Z"
|
|
21371
23255
|
* }
|
|
21372
23256
|
*/
|
|
21373
|
-
'application/json': components['schemas']['
|
|
23257
|
+
'application/json': components['schemas']['dossier'];
|
|
21374
23258
|
};
|
|
21375
23259
|
};
|
|
21376
23260
|
401: components['responses']['Problem'];
|
|
21377
|
-
403: components['responses']['Problem'];
|
|
21378
23261
|
404: components['responses']['Problem'];
|
|
23262
|
+
409: components['responses']['Problem'];
|
|
21379
23263
|
default: components['responses']['Problem'];
|
|
21380
23264
|
};
|
|
21381
23265
|
};
|
|
21382
|
-
|
|
23266
|
+
uploadDossierAttachment: {
|
|
21383
23267
|
parameters: {
|
|
21384
23268
|
query?: never;
|
|
21385
|
-
header
|
|
21386
|
-
/** @description
|
|
21387
|
-
'
|
|
21388
|
-
};
|
|
21389
|
-
path: {
|
|
21390
|
-
/** @description Organisation id. */
|
|
21391
|
-
orgId: components['parameters']['OrgId'];
|
|
23269
|
+
header: {
|
|
23270
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23271
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
21392
23272
|
};
|
|
23273
|
+
path?: never;
|
|
21393
23274
|
cookie?: never;
|
|
21394
23275
|
};
|
|
21395
23276
|
requestBody: {
|
|
21396
23277
|
content: {
|
|
21397
|
-
|
|
21398
|
-
|
|
21399
|
-
|
|
21400
|
-
|
|
21401
|
-
* }
|
|
21402
|
-
*/
|
|
21403
|
-
'application/json': components['schemas']['enrollmentTokenInput'];
|
|
23278
|
+
'multipart/form-data': {
|
|
23279
|
+
/** Format: binary */
|
|
23280
|
+
file: string;
|
|
23281
|
+
};
|
|
21404
23282
|
};
|
|
21405
23283
|
};
|
|
21406
23284
|
responses: {
|
|
21407
|
-
/** @description
|
|
23285
|
+
/** @description Stored. */
|
|
21408
23286
|
201: {
|
|
21409
23287
|
headers: {
|
|
21410
23288
|
[name: string]: unknown;
|
|
@@ -21412,40 +23290,73 @@ interface operations {
|
|
|
21412
23290
|
content: {
|
|
21413
23291
|
/**
|
|
21414
23292
|
* @example {
|
|
21415
|
-
* "id": "
|
|
21416
|
-
* "name": "
|
|
21417
|
-
* "
|
|
21418
|
-
* "
|
|
21419
|
-
* "
|
|
23293
|
+
* "id": "018f0f6e-0000-7000-8000-000000000002",
|
|
23294
|
+
* "name": "hall.jpg",
|
|
23295
|
+
* "contentType": "image/jpeg",
|
|
23296
|
+
* "size": 120344,
|
|
23297
|
+
* "createdAt": "2026-11-07T00:10:00Z"
|
|
21420
23298
|
* }
|
|
21421
23299
|
*/
|
|
21422
|
-
'application/json': components['schemas']['
|
|
23300
|
+
'application/json': components['schemas']['attachment'];
|
|
21423
23301
|
};
|
|
21424
23302
|
};
|
|
21425
|
-
401: components['responses']['Problem'];
|
|
21426
|
-
403: components['responses']['Problem'];
|
|
21427
23303
|
404: components['responses']['Problem'];
|
|
21428
|
-
|
|
23304
|
+
409: components['responses']['Problem'];
|
|
23305
|
+
413: components['responses']['Problem'];
|
|
23306
|
+
415: components['responses']['Problem'];
|
|
21429
23307
|
default: components['responses']['Problem'];
|
|
21430
23308
|
};
|
|
21431
23309
|
};
|
|
21432
|
-
|
|
23310
|
+
getDossierAttachment: {
|
|
21433
23311
|
parameters: {
|
|
21434
23312
|
query?: never;
|
|
21435
|
-
header
|
|
23313
|
+
header: {
|
|
23314
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23315
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
23316
|
+
};
|
|
21436
23317
|
path: {
|
|
21437
|
-
/** @description
|
|
21438
|
-
|
|
21439
|
-
/** @description Enrollment token id. */
|
|
21440
|
-
tokenId: components['parameters']['EnrollmentTokenId'];
|
|
23318
|
+
/** @description Attachment id. */
|
|
23319
|
+
attachmentId: components['parameters']['AttachmentId'];
|
|
21441
23320
|
};
|
|
21442
23321
|
cookie?: never;
|
|
21443
23322
|
};
|
|
21444
23323
|
requestBody?: never;
|
|
21445
23324
|
responses: {
|
|
21446
|
-
|
|
21447
|
-
|
|
21448
|
-
|
|
23325
|
+
/** @description The file. */
|
|
23326
|
+
200: {
|
|
23327
|
+
headers: {
|
|
23328
|
+
[name: string]: unknown;
|
|
23329
|
+
};
|
|
23330
|
+
content: {
|
|
23331
|
+
'application/octet-stream': string;
|
|
23332
|
+
};
|
|
23333
|
+
};
|
|
23334
|
+
404: components['responses']['Problem'];
|
|
23335
|
+
default: components['responses']['Problem'];
|
|
23336
|
+
};
|
|
23337
|
+
};
|
|
23338
|
+
deleteDossierAttachment: {
|
|
23339
|
+
parameters: {
|
|
23340
|
+
query?: never;
|
|
23341
|
+
header: {
|
|
23342
|
+
/** @description The dossier code. In a header, so that it stays out of URLs and logs. */
|
|
23343
|
+
'X-Dossier-Code': components['parameters']['DossierCode'];
|
|
23344
|
+
};
|
|
23345
|
+
path: {
|
|
23346
|
+
/** @description Attachment id. */
|
|
23347
|
+
attachmentId: components['parameters']['AttachmentId'];
|
|
23348
|
+
};
|
|
23349
|
+
cookie?: never;
|
|
23350
|
+
};
|
|
23351
|
+
requestBody?: never;
|
|
23352
|
+
responses: {
|
|
23353
|
+
/** @description Deleted. */
|
|
23354
|
+
204: {
|
|
23355
|
+
headers: {
|
|
23356
|
+
[name: string]: unknown;
|
|
23357
|
+
};
|
|
23358
|
+
content?: never;
|
|
23359
|
+
};
|
|
21449
23360
|
404: components['responses']['Problem'];
|
|
21450
23361
|
default: components['responses']['Problem'];
|
|
21451
23362
|
};
|
|
@@ -21976,6 +23887,12 @@ type AppPayload$1 = OperationBody<'publishAppPayload'>;
|
|
|
21976
23887
|
type OscSendRequest = OperationBody<'sendOsc'>;
|
|
21977
23888
|
/** Registered client device. */
|
|
21978
23889
|
type ClientDevice = ItemOf<OperationResponse<'listClients'>>;
|
|
23890
|
+
/** A physical action waiting for a person. */
|
|
23891
|
+
type AssistantConfirmation = ItemOf<OperationResponse<'listAssistantConfirmations'>>;
|
|
23892
|
+
/** The outbound link and its approvals. */
|
|
23893
|
+
type AssistantLink = OperationResponse<'getAssistantLink'>;
|
|
23894
|
+
/** One approval of the link. */
|
|
23895
|
+
type AssistantLinkSession = OperationResponse<'approveAssistantLink'>;
|
|
21979
23896
|
/** Client registration. */
|
|
21980
23897
|
type ClientRegistration = OperationBody<'registerClient'>;
|
|
21981
23898
|
/** Batched client telemetry. */
|
|
@@ -22207,6 +24124,13 @@ declare const ProtocolVersions: {
|
|
|
22207
24124
|
* new members.
|
|
22208
24125
|
*/
|
|
22209
24126
|
readonly audioControl: SemVer;
|
|
24127
|
+
/** First contract with the person's side of the assistant (confirmations, the link). An older server answers 404. */
|
|
24128
|
+
readonly assistant: SemVer;
|
|
24129
|
+
/**
|
|
24130
|
+
* The freedome_contract release this package was generated from and implements (`contract/contract.lock.json`).
|
|
24131
|
+
* Compare it with a server's `contractVersion` to tell which side is newer, e.g. for an About screen. Added in 1.2.0.
|
|
24132
|
+
*/
|
|
24133
|
+
readonly contract: SemVer;
|
|
22210
24134
|
/** Whether a `.dome` of [v] can be read (same major; newer minors keep unknown keys). */
|
|
22211
24135
|
readonly canReadDome: (v: SemVer) => boolean;
|
|
22212
24136
|
};
|
|
@@ -22239,12 +24163,12 @@ declare function matchOperation(op: ApiOperation, method: string, path: string):
|
|
|
22239
24163
|
|
|
22240
24164
|
/** Contract release these types were generated from. */
|
|
22241
24165
|
declare const CONTRACT: {
|
|
22242
|
-
readonly label: "v1.
|
|
22243
|
-
readonly bundle: "freedome-contract-1.
|
|
22244
|
-
readonly sha256: "
|
|
24166
|
+
readonly label: "v1.2.0";
|
|
24167
|
+
readonly bundle: "freedome-contract-1.2.0.tar.gz";
|
|
24168
|
+
readonly sha256: "27a9c4aa46a82485459269ebeb973c8a86e746c3e4f20d4aefe9c56291a4549d";
|
|
22245
24169
|
};
|
|
22246
24170
|
|
|
22247
|
-
/** mediaserver operations (
|
|
24171
|
+
/** mediaserver operations (191) by operationId: method, path template, required scope, parameters. */
|
|
22248
24172
|
declare const Operations: {
|
|
22249
24173
|
readonly activateVenue: {
|
|
22250
24174
|
readonly id: "activateVenue";
|
|
@@ -22309,6 +24233,15 @@ declare const Operations: {
|
|
|
22309
24233
|
}];
|
|
22310
24234
|
readonly requestContentTypes: readonly [];
|
|
22311
24235
|
};
|
|
24236
|
+
readonly approveAssistantLink: {
|
|
24237
|
+
readonly id: "approveAssistantLink";
|
|
24238
|
+
readonly method: "POST";
|
|
24239
|
+
readonly path: "/assistant/link/approvals";
|
|
24240
|
+
readonly scope: "playback:control";
|
|
24241
|
+
readonly tags: readonly ["assistant"];
|
|
24242
|
+
readonly params: readonly [];
|
|
24243
|
+
readonly requestContentTypes: readonly ["application/json"];
|
|
24244
|
+
};
|
|
22312
24245
|
readonly approvePairing: {
|
|
22313
24246
|
readonly id: "approvePairing";
|
|
22314
24247
|
readonly method: "POST";
|
|
@@ -22841,6 +24774,19 @@ declare const Operations: {
|
|
|
22841
24774
|
}];
|
|
22842
24775
|
readonly requestContentTypes: readonly [];
|
|
22843
24776
|
};
|
|
24777
|
+
readonly endAssistantLink: {
|
|
24778
|
+
readonly id: "endAssistantLink";
|
|
24779
|
+
readonly method: "DELETE";
|
|
24780
|
+
readonly path: "/assistant/link/sessions/{sessionId}";
|
|
24781
|
+
readonly scope: "playback:control";
|
|
24782
|
+
readonly tags: readonly ["assistant"];
|
|
24783
|
+
readonly params: readonly [{
|
|
24784
|
+
readonly name: "sessionId";
|
|
24785
|
+
readonly in: "path";
|
|
24786
|
+
readonly required: true;
|
|
24787
|
+
}];
|
|
24788
|
+
readonly requestContentTypes: readonly [];
|
|
24789
|
+
};
|
|
22844
24790
|
readonly exchangeCloudToken: {
|
|
22845
24791
|
readonly id: "exchangeCloudToken";
|
|
22846
24792
|
readonly method: "POST";
|
|
@@ -22965,6 +24911,15 @@ declare const Operations: {
|
|
|
22965
24911
|
}];
|
|
22966
24912
|
readonly requestContentTypes: readonly [];
|
|
22967
24913
|
};
|
|
24914
|
+
readonly getAssistantLink: {
|
|
24915
|
+
readonly id: "getAssistantLink";
|
|
24916
|
+
readonly method: "GET";
|
|
24917
|
+
readonly path: "/assistant/link";
|
|
24918
|
+
readonly scope: "playback:control";
|
|
24919
|
+
readonly tags: readonly ["assistant"];
|
|
24920
|
+
readonly params: readonly [];
|
|
24921
|
+
readonly requestContentTypes: readonly [];
|
|
24922
|
+
};
|
|
22968
24923
|
readonly getAudio: {
|
|
22969
24924
|
readonly id: "getAudio";
|
|
22970
24925
|
readonly method: "GET";
|
|
@@ -23728,6 +25683,23 @@ declare const Operations: {
|
|
|
23728
25683
|
}];
|
|
23729
25684
|
readonly requestContentTypes: readonly [];
|
|
23730
25685
|
};
|
|
25686
|
+
readonly listAssistantConfirmations: {
|
|
25687
|
+
readonly id: "listAssistantConfirmations";
|
|
25688
|
+
readonly method: "GET";
|
|
25689
|
+
readonly path: "/assistant/confirmations";
|
|
25690
|
+
readonly scope: "playback:control";
|
|
25691
|
+
readonly tags: readonly ["assistant"];
|
|
25692
|
+
readonly params: readonly [{
|
|
25693
|
+
readonly name: "limit";
|
|
25694
|
+
readonly in: "query";
|
|
25695
|
+
readonly required: false;
|
|
25696
|
+
}, {
|
|
25697
|
+
readonly name: "cursor";
|
|
25698
|
+
readonly in: "query";
|
|
25699
|
+
readonly required: false;
|
|
25700
|
+
}];
|
|
25701
|
+
readonly requestContentTypes: readonly [];
|
|
25702
|
+
};
|
|
23731
25703
|
readonly listAudioDevices: {
|
|
23732
25704
|
readonly id: "listAudioDevices";
|
|
23733
25705
|
readonly method: "GET";
|
|
@@ -24875,6 +26847,19 @@ declare const Operations: {
|
|
|
24875
26847
|
readonly params: readonly [];
|
|
24876
26848
|
readonly requestContentTypes: readonly ["application/json"];
|
|
24877
26849
|
};
|
|
26850
|
+
readonly refuseAssistantConfirmation: {
|
|
26851
|
+
readonly id: "refuseAssistantConfirmation";
|
|
26852
|
+
readonly method: "POST";
|
|
26853
|
+
readonly path: "/assistant/confirmations/{confirmationId}/refuse";
|
|
26854
|
+
readonly scope: "playback:control";
|
|
26855
|
+
readonly tags: readonly ["assistant"];
|
|
26856
|
+
readonly params: readonly [{
|
|
26857
|
+
readonly name: "confirmationId";
|
|
26858
|
+
readonly in: "path";
|
|
26859
|
+
readonly required: true;
|
|
26860
|
+
}];
|
|
26861
|
+
readonly requestContentTypes: readonly [];
|
|
26862
|
+
};
|
|
24878
26863
|
readonly registerClient: {
|
|
24879
26864
|
readonly id: "registerClient";
|
|
24880
26865
|
readonly method: "POST";
|
|
@@ -25422,7 +27407,7 @@ declare const Operations: {
|
|
|
25422
27407
|
};
|
|
25423
27408
|
};
|
|
25424
27409
|
|
|
25425
|
-
/** cloud operations (
|
|
27410
|
+
/** cloud operations (75) by operationId: method, path template, required scope, parameters. */
|
|
25426
27411
|
declare const CloudOperations: {
|
|
25427
27412
|
readonly acceptInvitation: {
|
|
25428
27413
|
readonly id: "acceptInvitation";
|
|
@@ -25472,6 +27457,32 @@ declare const CloudOperations: {
|
|
|
25472
27457
|
readonly params: readonly [];
|
|
25473
27458
|
readonly requestContentTypes: readonly ["application/json"];
|
|
25474
27459
|
};
|
|
27460
|
+
readonly claimDossier: {
|
|
27461
|
+
readonly id: "claimDossier";
|
|
27462
|
+
readonly method: "POST";
|
|
27463
|
+
readonly path: "/dossiers/self/claim";
|
|
27464
|
+
readonly scope: "any";
|
|
27465
|
+
readonly tags: readonly ["dossier"];
|
|
27466
|
+
readonly params: readonly [{
|
|
27467
|
+
readonly name: "X-Dossier-Code";
|
|
27468
|
+
readonly in: "header";
|
|
27469
|
+
readonly required: true;
|
|
27470
|
+
}];
|
|
27471
|
+
readonly requestContentTypes: readonly [];
|
|
27472
|
+
};
|
|
27473
|
+
readonly consentDossier: {
|
|
27474
|
+
readonly id: "consentDossier";
|
|
27475
|
+
readonly method: "POST";
|
|
27476
|
+
readonly path: "/dossiers/self/consent";
|
|
27477
|
+
readonly scope: "anon";
|
|
27478
|
+
readonly tags: readonly ["dossier"];
|
|
27479
|
+
readonly params: readonly [{
|
|
27480
|
+
readonly name: "X-Dossier-Code";
|
|
27481
|
+
readonly in: "header";
|
|
27482
|
+
readonly required: true;
|
|
27483
|
+
}];
|
|
27484
|
+
readonly requestContentTypes: readonly ["application/json"];
|
|
27485
|
+
};
|
|
25475
27486
|
readonly createAccountApiKey: {
|
|
25476
27487
|
readonly id: "createAccountApiKey";
|
|
25477
27488
|
readonly method: "POST";
|
|
@@ -25640,6 +27651,36 @@ declare const CloudOperations: {
|
|
|
25640
27651
|
}];
|
|
25641
27652
|
readonly requestContentTypes: readonly [];
|
|
25642
27653
|
};
|
|
27654
|
+
readonly deleteDossierAttachment: {
|
|
27655
|
+
readonly id: "deleteDossierAttachment";
|
|
27656
|
+
readonly method: "DELETE";
|
|
27657
|
+
readonly path: "/dossiers/self/attachments/{attachmentId}";
|
|
27658
|
+
readonly scope: "anon";
|
|
27659
|
+
readonly tags: readonly ["dossier"];
|
|
27660
|
+
readonly params: readonly [{
|
|
27661
|
+
readonly name: "attachmentId";
|
|
27662
|
+
readonly in: "path";
|
|
27663
|
+
readonly required: true;
|
|
27664
|
+
}, {
|
|
27665
|
+
readonly name: "X-Dossier-Code";
|
|
27666
|
+
readonly in: "header";
|
|
27667
|
+
readonly required: true;
|
|
27668
|
+
}];
|
|
27669
|
+
readonly requestContentTypes: readonly [];
|
|
27670
|
+
};
|
|
27671
|
+
readonly deleteDossierSelf: {
|
|
27672
|
+
readonly id: "deleteDossierSelf";
|
|
27673
|
+
readonly method: "DELETE";
|
|
27674
|
+
readonly path: "/dossiers/self";
|
|
27675
|
+
readonly scope: "anon";
|
|
27676
|
+
readonly tags: readonly ["dossier"];
|
|
27677
|
+
readonly params: readonly [{
|
|
27678
|
+
readonly name: "X-Dossier-Code";
|
|
27679
|
+
readonly in: "header";
|
|
27680
|
+
readonly required: true;
|
|
27681
|
+
}];
|
|
27682
|
+
readonly requestContentTypes: readonly [];
|
|
27683
|
+
};
|
|
25643
27684
|
readonly deleteOrg: {
|
|
25644
27685
|
readonly id: "deleteOrg";
|
|
25645
27686
|
readonly method: "DELETE";
|
|
@@ -25739,6 +27780,19 @@ declare const CloudOperations: {
|
|
|
25739
27780
|
readonly params: readonly [];
|
|
25740
27781
|
readonly requestContentTypes: readonly ["application/json"];
|
|
25741
27782
|
};
|
|
27783
|
+
readonly exportDossierSelf: {
|
|
27784
|
+
readonly id: "exportDossierSelf";
|
|
27785
|
+
readonly method: "GET";
|
|
27786
|
+
readonly path: "/dossiers/self/export";
|
|
27787
|
+
readonly scope: "anon";
|
|
27788
|
+
readonly tags: readonly ["dossier"];
|
|
27789
|
+
readonly params: readonly [{
|
|
27790
|
+
readonly name: "X-Dossier-Code";
|
|
27791
|
+
readonly in: "header";
|
|
27792
|
+
readonly required: true;
|
|
27793
|
+
}];
|
|
27794
|
+
readonly requestContentTypes: readonly [];
|
|
27795
|
+
};
|
|
25742
27796
|
readonly forgotPassword: {
|
|
25743
27797
|
readonly id: "forgotPassword";
|
|
25744
27798
|
readonly method: "POST";
|
|
@@ -25770,6 +27824,36 @@ declare const CloudOperations: {
|
|
|
25770
27824
|
}];
|
|
25771
27825
|
readonly requestContentTypes: readonly [];
|
|
25772
27826
|
};
|
|
27827
|
+
readonly getDossierAttachment: {
|
|
27828
|
+
readonly id: "getDossierAttachment";
|
|
27829
|
+
readonly method: "GET";
|
|
27830
|
+
readonly path: "/dossiers/self/attachments/{attachmentId}";
|
|
27831
|
+
readonly scope: "anon";
|
|
27832
|
+
readonly tags: readonly ["dossier"];
|
|
27833
|
+
readonly params: readonly [{
|
|
27834
|
+
readonly name: "attachmentId";
|
|
27835
|
+
readonly in: "path";
|
|
27836
|
+
readonly required: true;
|
|
27837
|
+
}, {
|
|
27838
|
+
readonly name: "X-Dossier-Code";
|
|
27839
|
+
readonly in: "header";
|
|
27840
|
+
readonly required: true;
|
|
27841
|
+
}];
|
|
27842
|
+
readonly requestContentTypes: readonly [];
|
|
27843
|
+
};
|
|
27844
|
+
readonly getDossierSelf: {
|
|
27845
|
+
readonly id: "getDossierSelf";
|
|
27846
|
+
readonly method: "GET";
|
|
27847
|
+
readonly path: "/dossiers/self";
|
|
27848
|
+
readonly scope: "anon";
|
|
27849
|
+
readonly tags: readonly ["dossier"];
|
|
27850
|
+
readonly params: readonly [{
|
|
27851
|
+
readonly name: "X-Dossier-Code";
|
|
27852
|
+
readonly in: "header";
|
|
27853
|
+
readonly required: true;
|
|
27854
|
+
}];
|
|
27855
|
+
readonly requestContentTypes: readonly [];
|
|
27856
|
+
};
|
|
25773
27857
|
readonly getEnrollmentRequest: {
|
|
25774
27858
|
readonly id: "getEnrollmentRequest";
|
|
25775
27859
|
readonly method: "GET";
|
|
@@ -26329,6 +28413,19 @@ declare const CloudOperations: {
|
|
|
26329
28413
|
readonly params: readonly [];
|
|
26330
28414
|
readonly requestContentTypes: readonly ["application/json"];
|
|
26331
28415
|
};
|
|
28416
|
+
readonly uploadDossierAttachment: {
|
|
28417
|
+
readonly id: "uploadDossierAttachment";
|
|
28418
|
+
readonly method: "POST";
|
|
28419
|
+
readonly path: "/dossiers/self/attachments";
|
|
28420
|
+
readonly scope: "anon";
|
|
28421
|
+
readonly tags: readonly ["dossier"];
|
|
28422
|
+
readonly params: readonly [{
|
|
28423
|
+
readonly name: "X-Dossier-Code";
|
|
28424
|
+
readonly in: "header";
|
|
28425
|
+
readonly required: true;
|
|
28426
|
+
}];
|
|
28427
|
+
readonly requestContentTypes: readonly ["multipart/form-data"];
|
|
28428
|
+
};
|
|
26332
28429
|
readonly verifyEmail: {
|
|
26333
28430
|
readonly id: "verifyEmail";
|
|
26334
28431
|
readonly method: "POST";
|
|
@@ -26391,25 +28488,25 @@ type ProblemCode = (typeof ProblemCodes)[number];
|
|
|
26391
28488
|
/** AsyncAPI documents: messages / channels / operations (asyncapi/*.yaml). */
|
|
26392
28489
|
declare const AsyncApiCatalogue: {
|
|
26393
28490
|
readonly 'cloud-socketio': {
|
|
26394
|
-
readonly version: "1.
|
|
28491
|
+
readonly version: "1.2.0";
|
|
26395
28492
|
readonly messages: readonly ["event", "join"];
|
|
26396
28493
|
readonly channels: readonly ["v1"];
|
|
26397
28494
|
readonly operations: readonly ["emitJoin", "receiveEvent"];
|
|
26398
28495
|
};
|
|
26399
28496
|
readonly 'socketio-legacy': {
|
|
26400
|
-
readonly version: "1.
|
|
28497
|
+
readonly version: "1.2.0";
|
|
26401
28498
|
readonly messages: readonly ["brightness", "clear-integration", "command", "command_response", "dome-state", "error", "getState", "heartbeat", "integration-event", "oscSent", "rotation", "sendOsc", "setState", "state", "system_event", "volume"];
|
|
26402
28499
|
readonly channels: readonly ["root"];
|
|
26403
28500
|
readonly operations: readonly ["emitClearIntegration", "emitCommand", "emitHeartbeat", "emitIntegrationEvent", "emitOutputNumbers", "emitV3SendOsc", "emitV3State", "receiveDomeState", "receiveIntegrationEvent", "receiveSystemEvent"];
|
|
26404
28501
|
};
|
|
26405
28502
|
readonly socketio: {
|
|
26406
|
-
readonly version: "1.
|
|
28503
|
+
readonly version: "1.2.0";
|
|
26407
28504
|
readonly messages: readonly ["ack", "bye", "call", "event", "resync", "subscribe", "unsubscribe", "welcome"];
|
|
26408
28505
|
readonly channels: readonly ["v1"];
|
|
26409
28506
|
readonly operations: readonly ["emitCall", "emitSubscribe", "emitUnsubscribe", "receiveBye", "receiveEvent", "receiveResync", "receiveWelcome"];
|
|
26410
28507
|
};
|
|
26411
28508
|
readonly ws: {
|
|
26412
|
-
readonly version: "1.
|
|
28509
|
+
readonly version: "1.2.0";
|
|
26413
28510
|
readonly messages: readonly ["bye", "call", "error", "event", "hello", "ping", "pong", "result", "resync", "subscribe", "unsubscribe", "welcome"];
|
|
26414
28511
|
readonly channels: readonly ["ws"];
|
|
26415
28512
|
readonly operations: readonly ["receiveBye", "receiveEvent", "receivePing", "receiveResync", "sendCall", "sendHello", "sendPing", "sendSubscribe", "sendUnsubscribe"];
|
|
@@ -32036,4 +34133,4 @@ declare namespace wsMessages {
|
|
|
32036
34133
|
*/
|
|
32037
34134
|
declare const PACKAGE_NAME = "@freedome/protocol";
|
|
32038
34135
|
|
|
32039
|
-
export { type ActiveShowState, type ApiOperation, type AppPayload$1 as AppPayload, type AssetCreateRequest, type AssetResource, AsyncApiCatalogue, type BorankoDocument, CONTRACT, type CalibrationJob$1 as CalibrationJob, type CalibrationState, type ClientDevice, type ClientRegistration, type ClientTelemetry, openapiCloud as CloudApi, type CloudOperationBody, type CloudOperationId, type CloudOperationResponse, CloudOperations, type ComicsData, type ComicsMetadata, type DisplayResource, type DomeManifest, type DomeSignature, DomeTopics, type EngineStatus$1 as EngineStatus, type EventKind, EventKinds, type EventPage, formats as Formats, type FreedomeEvent, graphqlCloud as GraphqlCloud, graphqlMediaserver as GraphqlMediaServer, type ImportRequest, type Job$1 as Job, type MediaOperationId, openapiMediaserver as MediaServerApi, type MessageType, MessageTypes, type OperationBody, type OperationParam, type OperationPathParams, type OperationQuery, type OperationResponse, Operations, type OscSendRequest, PACKAGE_NAME, type Pairing$1 as Pairing, type ParameterInfo, type PlayRequest, type PlayerState, type Principal$1 as Principal, type Problem$2 as Problem, type ProblemCode, ProblemCodes, ProtocolVersions, PseudoScopes, type Role$1 as Role, RoleScopes, type Scope, Scopes, SemVer, type ServerInfo$2 as ServerInfo, type ShowInput, type ShowResource, type ShowSummary$1 as ShowSummary, type StorageStats$1 as StorageStats, type SystemStatus$1 as SystemStatus, type TokenSet, TopicDelivery, type TopicSpec, TopicTable, type UploadStatus, type Venue$1 as Venue, type VenueInput, type VenueOutput, WS_SUBPROTOCOL, WsCloseCodes, type WsMessage, wsMessages as WsMessages, type ZelimProject, eventFromMessage, expandPath, jsonMergePatch, matchOperation, openEnum, parseWsMessage, rfc3339Millis, topicIsInstanceOf, topicMatches };
|
|
34136
|
+
export { type ActiveShowState, type ApiOperation, type AppPayload$1 as AppPayload, type AssetCreateRequest, type AssetResource, type AssistantConfirmation, type AssistantLink, type AssistantLinkSession, AsyncApiCatalogue, type BorankoDocument, CONTRACT, type CalibrationJob$1 as CalibrationJob, type CalibrationState, type ClientDevice, type ClientRegistration, type ClientTelemetry, openapiCloud as CloudApi, type CloudOperationBody, type CloudOperationId, type CloudOperationResponse, CloudOperations, type ComicsData, type ComicsMetadata, type DisplayResource, type DomeManifest, type DomeSignature, DomeTopics, type EngineStatus$1 as EngineStatus, type EventKind, EventKinds, type EventPage, formats as Formats, type FreedomeEvent, graphqlCloud as GraphqlCloud, graphqlMediaserver as GraphqlMediaServer, type ImportRequest, type Job$1 as Job, type MediaOperationId, openapiMediaserver as MediaServerApi, type MessageType, MessageTypes, type OperationBody, type OperationParam, type OperationPathParams, type OperationQuery, type OperationResponse, Operations, type OscSendRequest, PACKAGE_NAME, type Pairing$1 as Pairing, type ParameterInfo, type PlayRequest, type PlayerState, type Principal$1 as Principal, type Problem$2 as Problem, type ProblemCode, ProblemCodes, ProtocolVersions, PseudoScopes, type Role$1 as Role, RoleScopes, type Scope, Scopes, SemVer, type ServerInfo$2 as ServerInfo, type ShowInput, type ShowResource, type ShowSummary$1 as ShowSummary, type StorageStats$1 as StorageStats, type SystemStatus$1 as SystemStatus, type TokenSet, TopicDelivery, type TopicSpec, TopicTable, type UploadStatus, type Venue$1 as Venue, type VenueInput, type VenueOutput, WS_SUBPROTOCOL, WsCloseCodes, type WsMessage, wsMessages as WsMessages, type ZelimProject, eventFromMessage, expandPath, jsonMergePatch, matchOperation, openEnum, parseWsMessage, rfc3339Millis, topicIsInstanceOf, topicMatches };
|