@freedome/protocol 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js ADDED
@@ -0,0 +1,3541 @@
1
+ // src/envelope.ts
2
+ var MessageTypes = {
3
+ hello: "hello",
4
+ welcome: "welcome",
5
+ subscribe: "subscribe",
6
+ unsubscribe: "unsubscribe",
7
+ call: "call",
8
+ result: "result",
9
+ event: "event",
10
+ error: "error",
11
+ resync: "resync",
12
+ ping: "ping",
13
+ pong: "pong",
14
+ bye: "bye"
15
+ };
16
+ var WsCloseCodes = {
17
+ unauthenticated: 4401,
18
+ forbidden: 4403,
19
+ heartbeatTimeout: 4408,
20
+ superseded: 4409,
21
+ messageTooLarge: 4413,
22
+ serviceRestart: 1012
23
+ };
24
+ var WS_SUBPROTOCOL = "freedome.v1";
25
+ var isObj = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
26
+ function parseWsMessage(json) {
27
+ if (!isObj(json)) throw new TypeError("envelope: not an object");
28
+ for (const k of ["type", "id", "ts"]) {
29
+ if (typeof json[k] !== "string") throw new TypeError(`envelope: /${k} required`);
30
+ }
31
+ if (!("data" in json)) throw new TypeError("envelope: /data required");
32
+ return json;
33
+ }
34
+ function eventFromMessage(m) {
35
+ if (m.type !== MessageTypes.event) throw new TypeError(`not an event (${m.type})`);
36
+ const d = m.data;
37
+ if (!isObj(d) || typeof d.seq !== "number" || typeof d.kind !== "string")
38
+ throw new TypeError("event: /data.seq and /data.kind required");
39
+ if (!m.topic) throw new TypeError("event: /topic required");
40
+ const e = {
41
+ id: m.id,
42
+ topic: m.topic,
43
+ seq: d.seq,
44
+ kind: d.kind,
45
+ ts: m.ts,
46
+ data: d
47
+ };
48
+ if ("resource" in d) e.resource = d.resource;
49
+ if (isObj(d.patch)) e.patch = d.patch;
50
+ if (typeof d.revision === "number") e.revision = d.revision;
51
+ if (m.replyTo !== void 0) e.replyTo = m.replyTo;
52
+ return e;
53
+ }
54
+ function jsonMergePatch(target, patch) {
55
+ if (!isObj(patch)) return patch;
56
+ const out = isObj(target) ? { ...target } : {};
57
+ for (const [k, v] of Object.entries(patch)) {
58
+ if (v === null) Reflect.deleteProperty(out, k);
59
+ else out[k] = jsonMergePatch(out[k], v);
60
+ }
61
+ return out;
62
+ }
63
+ function rfc3339Millis(t = /* @__PURE__ */ new Date()) {
64
+ return t.toISOString();
65
+ }
66
+ var SemVer = class _SemVer {
67
+ constructor(major, minor, patch, preRelease = "") {
68
+ this.major = major;
69
+ this.minor = minor;
70
+ this.patch = patch;
71
+ this.preRelease = preRelease;
72
+ }
73
+ major;
74
+ minor;
75
+ patch;
76
+ preRelease;
77
+ static parse(text) {
78
+ const m = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+[0-9A-Za-z.-]+)?$/.exec(text.trim());
79
+ if (!m) throw new TypeError(`not a semantic version: ${text}`);
80
+ return new _SemVer(Number(m[1]), Number(m[2]), Number(m[3]), m[4] ?? "");
81
+ }
82
+ static tryParse(text) {
83
+ try {
84
+ return _SemVer.parse(text);
85
+ } catch {
86
+ return null;
87
+ }
88
+ }
89
+ compareTo(o) {
90
+ for (const [a, b] of [
91
+ [this.major, o.major],
92
+ [this.minor, o.minor],
93
+ [this.patch, o.patch]
94
+ ]) {
95
+ if (a !== b) return a < b ? -1 : 1;
96
+ }
97
+ if (this.preRelease === o.preRelease) return 0;
98
+ if (!this.preRelease) return 1;
99
+ if (!o.preRelease) return -1;
100
+ return this.preRelease < o.preRelease ? -1 : 1;
101
+ }
102
+ toString() {
103
+ return `${this.major}.${this.minor}.${this.patch}${this.preRelease ? `-${this.preRelease}` : ""}`;
104
+ }
105
+ };
106
+ var ProtocolVersions = {
107
+ /** `.dome` format version written. */
108
+ domeFormat: new SemVer(1, 1, 0),
109
+ /** API majors understood (`/api/v1`). */
110
+ apiMajors: [1],
111
+ /** Whether a `.dome` of [v] can be read (same major; newer minors keep unknown keys). */
112
+ canReadDome: (v) => v.major === 1
113
+ };
114
+ function openEnum(known, value) {
115
+ return typeof value === "string" && known.includes(value) ? value : "UNKNOWN";
116
+ }
117
+
118
+ // src/operation.ts
119
+ function expandPath(op, params = {}) {
120
+ return op.path.replace(/\{([^}]+)\}/g, (_, name) => {
121
+ const v = params[name];
122
+ if (v === void 0) throw new TypeError(`${op.id}: path parameter ${name} missing`);
123
+ return encodeURIComponent(v);
124
+ });
125
+ }
126
+ function matchOperation(op, method, path) {
127
+ if (method.toUpperCase() !== op.method) return null;
128
+ const want = op.path.split("/");
129
+ const got = path.split("/");
130
+ if (want.length !== got.length) return null;
131
+ const out = {};
132
+ for (let i = 0; i < want.length; i++) {
133
+ const w = want[i];
134
+ const g = got[i];
135
+ const m = /^\{([^}]+)\}$/.exec(w);
136
+ if (m) {
137
+ if (!g) return null;
138
+ out[m[1]] = decodeURIComponent(g);
139
+ } else if (w !== g) {
140
+ return null;
141
+ }
142
+ }
143
+ return out;
144
+ }
145
+
146
+ // src/topics.ts
147
+ function topicMatches(filter, topic) {
148
+ if (filter === "#") return true;
149
+ const f = filter.split("/");
150
+ const t = topic.split("/");
151
+ for (let i = 0; i < f.length; i++) {
152
+ const x = f[i];
153
+ if (x === "#") return i === f.length - 1;
154
+ if (i >= t.length) return false;
155
+ if (x !== "+" && x !== t[i]) return false;
156
+ }
157
+ return f.length === t.length;
158
+ }
159
+ function topicIsInstanceOf(template, topic) {
160
+ return topicMatches(template.replace(/\{[^}]+\}/g, "+"), topic);
161
+ }
162
+ var lvl = (s) => {
163
+ if (!s || s.includes("/") || s === "+" || s === "#")
164
+ throw new TypeError(`invalid topic level: ${s}`);
165
+ return s;
166
+ };
167
+ var DomeTopics = {
168
+ systemInfo: "system/info",
169
+ systemHealth: "system/health",
170
+ systemLogs: "system/logs",
171
+ node: (nodeId) => `nodes/${lvl(nodeId)}`,
172
+ engine: (name) => `engines/${lvl(name)}`,
173
+ venue: (venueId = "default") => `venues/${lvl(venueId)}`,
174
+ output: (venueId = "default") => `venues/${lvl(venueId)}/output`,
175
+ display: (displayId, venueId = "default") => `venues/${lvl(venueId)}/displays/${lvl(displayId)}`,
176
+ calibration: (venueId = "default") => `venues/${lvl(venueId)}/calibration`,
177
+ player: (playerId = "main", venueId = "default") => `venues/${lvl(venueId)}/players/${lvl(playerId)}`,
178
+ parameters: (venueId = "default") => `venues/${lvl(venueId)}/parameters`,
179
+ audio: (venueId = "default") => `venues/${lvl(venueId)}/audio`,
180
+ show: (showId) => `shows/${lvl(showId)}`,
181
+ asset: (assetId) => `assets/${lvl(assetId)}`,
182
+ upload: (uploadId) => `uploads/${lvl(uploadId)}`,
183
+ job: (jobId) => `jobs/${lvl(jobId)}`,
184
+ app: (app) => `apps/${lvl(app)}`,
185
+ clientCommands: (clientId) => `clients/${lvl(clientId)}/commands`,
186
+ authSessions: "auth/sessions",
187
+ cues: (venueId = "default") => `venues/${lvl(venueId)}/cues`,
188
+ calibrationJob: (jobId, venueId = "default") => `venues/${lvl(venueId)}/calibration/jobs/${lvl(jobId)}`,
189
+ audioLayout: (venueId = "default") => `venues/${lvl(venueId)}/audio/layout`,
190
+ audioLevels: (venueId = "default") => `venues/${lvl(venueId)}/audio/levels`,
191
+ audioZone: (zoneId, venueId = "default") => `venues/${lvl(venueId)}/audio/zones/${lvl(zoneId)}`,
192
+ audioDevice: (deviceId, venueId = "default") => `venues/${lvl(venueId)}/audio/devices/${lvl(deviceId)}`,
193
+ audioSession: (sessionId, venueId = "default") => `venues/${lvl(venueId)}/audio/sessions/${lvl(sessionId)}`,
194
+ audioGenerator: (venueId = "default") => `venues/${lvl(venueId)}/audio/generator`,
195
+ audioAnalysis: (venueId = "default") => `venues/${lvl(venueId)}/audio/analysis`,
196
+ audioAnalysisInput: (inputId, venueId = "default") => `venues/${lvl(venueId)}/audio/analysis/${lvl(inputId)}`,
197
+ audioOnsets: (inputId, venueId = "default") => `venues/${lvl(venueId)}/audio/onsets/${lvl(inputId)}`,
198
+ audioReactive: (venueId = "default") => `venues/${lvl(venueId)}/audio/reactive`,
199
+ audioReactiveScenes: (venueId = "default") => `venues/${lvl(venueId)}/audio/reactive/scenes`,
200
+ textureSource: (sourceId, venueId = "default") => `venues/${lvl(venueId)}/texture-sources/${lvl(sourceId)}`,
201
+ gateway: (gatewayId) => `gateways/${lvl(gatewayId)}`,
202
+ device: (deviceId) => `devices/${lvl(deviceId)}`,
203
+ scenarioSession: (sessionId, venueId = "default") => `venues/${lvl(venueId)}/scenarios/${lvl(sessionId)}`
204
+ };
205
+
206
+ // src/generated/contract.ts
207
+ var CONTRACT = {
208
+ label: "v1.0.0",
209
+ bundle: "freedome-contract-1.0.0.tar.gz",
210
+ sha256: "7cd2668450d65266521fa7285f74846271d1dca1695418543490bc8db491d225"
211
+ };
212
+
213
+ // src/generated/mediaserver-operations.ts
214
+ var Operations = {
215
+ activateVenue: {
216
+ id: "activateVenue",
217
+ method: "POST",
218
+ path: "/venues/{venueId}/activate",
219
+ scope: "venues:write",
220
+ tags: ["venues"],
221
+ params: [
222
+ { name: "venueId", in: "path", required: true },
223
+ { name: "Idempotency-Key", in: "header", required: false }
224
+ ],
225
+ requestContentTypes: []
226
+ },
227
+ appendUpload: {
228
+ id: "appendUpload",
229
+ method: "PATCH",
230
+ path: "/uploads/{uploadId}",
231
+ scope: "content:write",
232
+ tags: ["uploads"],
233
+ params: [
234
+ { name: "uploadId", in: "path", required: true },
235
+ { name: "Tus-Resumable", in: "header", required: true },
236
+ { name: "Upload-Offset", in: "header", required: true },
237
+ { name: "Upload-Checksum", in: "header", required: false }
238
+ ],
239
+ requestContentTypes: ["application/offset+octet-stream"]
240
+ },
241
+ applyCalibrationJob: {
242
+ id: "applyCalibrationJob",
243
+ method: "POST",
244
+ path: "/venues/{venueId}/calibration/jobs/{jobId}/apply",
245
+ scope: "calibration:run",
246
+ tags: ["calibration"],
247
+ params: [
248
+ { name: "venueId", in: "path", required: true },
249
+ { name: "jobId", in: "path", required: true },
250
+ { name: "Idempotency-Key", in: "header", required: false }
251
+ ],
252
+ requestContentTypes: []
253
+ },
254
+ approvePairing: {
255
+ id: "approvePairing",
256
+ method: "POST",
257
+ path: "/auth/pairings/{pairingId}/approve",
258
+ scope: "users:manage",
259
+ tags: ["auth"],
260
+ params: [
261
+ { name: "pairingId", in: "path", required: true },
262
+ { name: "Idempotency-Key", in: "header", required: false }
263
+ ],
264
+ requestContentTypes: ["application/json"]
265
+ },
266
+ beginDevicePairing: {
267
+ id: "beginDevicePairing",
268
+ method: "POST",
269
+ path: "/devices/{deviceId}/pairing",
270
+ scope: "venues:write",
271
+ tags: ["devices"],
272
+ params: [
273
+ { name: "deviceId", in: "path", required: true },
274
+ { name: "Idempotency-Key", in: "header", required: false }
275
+ ],
276
+ requestContentTypes: []
277
+ },
278
+ bindDevice: {
279
+ id: "bindDevice",
280
+ method: "PUT",
281
+ path: "/devices/{deviceId}/display",
282
+ scope: "venues:write",
283
+ tags: ["devices"],
284
+ params: [
285
+ { name: "deviceId", in: "path", required: true },
286
+ { name: "If-Match", in: "header", required: true }
287
+ ],
288
+ requestContentTypes: ["application/json"]
289
+ },
290
+ cancelCalibrationJob: {
291
+ id: "cancelCalibrationJob",
292
+ method: "POST",
293
+ path: "/venues/{venueId}/calibration/jobs/{jobId}/cancel",
294
+ scope: "calibration:run",
295
+ tags: ["calibration"],
296
+ params: [
297
+ { name: "venueId", in: "path", required: true },
298
+ { name: "jobId", in: "path", required: true },
299
+ { name: "Idempotency-Key", in: "header", required: false }
300
+ ],
301
+ requestContentTypes: []
302
+ },
303
+ cancelJob: {
304
+ id: "cancelJob",
305
+ method: "POST",
306
+ path: "/jobs/{jobId}/cancel",
307
+ scope: "any",
308
+ tags: ["jobs"],
309
+ params: [
310
+ { name: "jobId", in: "path", required: true },
311
+ { name: "Idempotency-Key", in: "header", required: false }
312
+ ],
313
+ requestContentTypes: []
314
+ },
315
+ clearAppPayloads: {
316
+ id: "clearAppPayloads",
317
+ method: "DELETE",
318
+ path: "/apps/{app}/payloads",
319
+ scope: "apps:publish",
320
+ tags: ["apps"],
321
+ params: [{ name: "app", in: "path", required: true }],
322
+ requestContentTypes: []
323
+ },
324
+ clearLogs: {
325
+ id: "clearLogs",
326
+ method: "DELETE",
327
+ path: "/system/logs",
328
+ scope: "system:admin",
329
+ tags: ["system"],
330
+ params: [],
331
+ requestContentTypes: []
332
+ },
333
+ confirmDevicePairing: {
334
+ id: "confirmDevicePairing",
335
+ method: "POST",
336
+ path: "/devices/{deviceId}/pairing/confirm",
337
+ scope: "venues:write",
338
+ tags: ["devices"],
339
+ params: [
340
+ { name: "deviceId", in: "path", required: true },
341
+ { name: "Idempotency-Key", in: "header", required: false }
342
+ ],
343
+ requestContentTypes: ["application/json"]
344
+ },
345
+ createApiKey: {
346
+ id: "createApiKey",
347
+ method: "POST",
348
+ path: "/api-keys",
349
+ scope: "keys:manage",
350
+ tags: ["api-keys"],
351
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
352
+ requestContentTypes: ["application/json"]
353
+ },
354
+ createAsset: {
355
+ id: "createAsset",
356
+ method: "POST",
357
+ path: "/assets",
358
+ scope: "content:write",
359
+ tags: ["assets"],
360
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
361
+ requestContentTypes: ["application/json", "multipart/form-data"]
362
+ },
363
+ createBackup: {
364
+ id: "createBackup",
365
+ method: "POST",
366
+ path: "/system/backup",
367
+ scope: "system:admin",
368
+ tags: ["system"],
369
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
370
+ requestContentTypes: ["application/json"]
371
+ },
372
+ createPairing: {
373
+ id: "createPairing",
374
+ method: "POST",
375
+ path: "/auth/pairings",
376
+ scope: "anon",
377
+ tags: ["auth"],
378
+ params: [],
379
+ requestContentTypes: ["application/json"]
380
+ },
381
+ createSession: {
382
+ id: "createSession",
383
+ method: "POST",
384
+ path: "/auth/session",
385
+ scope: "anon",
386
+ tags: ["auth"],
387
+ params: [],
388
+ requestContentTypes: ["application/json"]
389
+ },
390
+ createShow: {
391
+ id: "createShow",
392
+ method: "POST",
393
+ path: "/shows",
394
+ scope: "content:write",
395
+ tags: ["shows"],
396
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
397
+ requestContentTypes: ["application/json"]
398
+ },
399
+ createUpload: {
400
+ id: "createUpload",
401
+ method: "POST",
402
+ path: "/uploads",
403
+ scope: "content:write",
404
+ tags: ["uploads"],
405
+ params: [
406
+ { name: "Tus-Resumable", in: "header", required: true },
407
+ { name: "Upload-Length", in: "header", required: true },
408
+ { name: "Upload-Metadata", in: "header", required: true },
409
+ { name: "Upload-Checksum", in: "header", required: false },
410
+ { name: "Idempotency-Key", in: "header", required: false }
411
+ ],
412
+ requestContentTypes: ["application/offset+octet-stream"]
413
+ },
414
+ createUser: {
415
+ id: "createUser",
416
+ method: "POST",
417
+ path: "/users",
418
+ scope: "users:manage",
419
+ tags: ["users"],
420
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
421
+ requestContentTypes: ["application/json"]
422
+ },
423
+ createVenue: {
424
+ id: "createVenue",
425
+ method: "POST",
426
+ path: "/venues",
427
+ scope: "venues:write",
428
+ tags: ["venues"],
429
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
430
+ requestContentTypes: ["application/json"]
431
+ },
432
+ deleteApiKey: {
433
+ id: "deleteApiKey",
434
+ method: "DELETE",
435
+ path: "/api-keys/{keyId}",
436
+ scope: "keys:manage",
437
+ tags: ["api-keys"],
438
+ params: [{ name: "keyId", in: "path", required: true }],
439
+ requestContentTypes: []
440
+ },
441
+ deleteAsset: {
442
+ id: "deleteAsset",
443
+ method: "DELETE",
444
+ path: "/assets/{assetId}",
445
+ scope: "content:write",
446
+ tags: ["assets"],
447
+ params: [
448
+ { name: "assetId", in: "path", required: true },
449
+ { name: "If-Match", in: "header", required: true },
450
+ { name: "force", in: "query", required: false }
451
+ ],
452
+ requestContentTypes: []
453
+ },
454
+ deleteAudioPreset: {
455
+ id: "deleteAudioPreset",
456
+ method: "DELETE",
457
+ path: "/venues/{venueId}/audio/presets/{presetId}",
458
+ scope: "content:write",
459
+ tags: ["audio"],
460
+ params: [
461
+ { name: "venueId", in: "path", required: true },
462
+ { name: "presetId", in: "path", required: true },
463
+ { name: "If-Match", in: "header", required: true }
464
+ ],
465
+ requestContentTypes: []
466
+ },
467
+ deleteAudioReactiveScene: {
468
+ id: "deleteAudioReactiveScene",
469
+ method: "DELETE",
470
+ path: "/venues/{venueId}/audio/reactive/scenes/{sceneId}",
471
+ scope: "content:write",
472
+ tags: ["audio"],
473
+ params: [
474
+ { name: "venueId", in: "path", required: true },
475
+ { name: "sceneId", in: "path", required: true },
476
+ { name: "If-Match", in: "header", required: true }
477
+ ],
478
+ requestContentTypes: []
479
+ },
480
+ deleteAudioZone: {
481
+ id: "deleteAudioZone",
482
+ method: "DELETE",
483
+ path: "/venues/{venueId}/audio/zones/{zoneId}",
484
+ scope: "audio:control",
485
+ tags: ["audio"],
486
+ params: [
487
+ { name: "venueId", in: "path", required: true },
488
+ { name: "zoneId", in: "path", required: true },
489
+ { name: "If-Match", in: "header", required: true }
490
+ ],
491
+ requestContentTypes: []
492
+ },
493
+ deleteCue: {
494
+ id: "deleteCue",
495
+ method: "DELETE",
496
+ path: "/shows/{showId}/cues/{itemId}",
497
+ scope: "content:write",
498
+ tags: ["shows"],
499
+ params: [
500
+ { name: "showId", in: "path", required: true },
501
+ { name: "itemId", in: "path", required: true },
502
+ { name: "If-Match", in: "header", required: true }
503
+ ],
504
+ requestContentTypes: []
505
+ },
506
+ deletePlaylist: {
507
+ id: "deletePlaylist",
508
+ method: "DELETE",
509
+ path: "/shows/{showId}/playlists/{itemId}",
510
+ scope: "content:write",
511
+ tags: ["shows"],
512
+ params: [
513
+ { name: "showId", in: "path", required: true },
514
+ { name: "itemId", in: "path", required: true },
515
+ { name: "If-Match", in: "header", required: true }
516
+ ],
517
+ requestContentTypes: []
518
+ },
519
+ deleteSession: {
520
+ id: "deleteSession",
521
+ method: "DELETE",
522
+ path: "/auth/session",
523
+ scope: "any",
524
+ tags: ["auth"],
525
+ params: [],
526
+ requestContentTypes: []
527
+ },
528
+ deleteShow: {
529
+ id: "deleteShow",
530
+ method: "DELETE",
531
+ path: "/shows/{showId}",
532
+ scope: "content:write",
533
+ tags: ["shows"],
534
+ params: [
535
+ { name: "showId", in: "path", required: true },
536
+ { name: "If-Match", in: "header", required: true }
537
+ ],
538
+ requestContentTypes: []
539
+ },
540
+ deleteTimeline: {
541
+ id: "deleteTimeline",
542
+ method: "DELETE",
543
+ path: "/shows/{showId}/timelines/{itemId}",
544
+ scope: "content:write",
545
+ tags: ["shows"],
546
+ params: [
547
+ { name: "showId", in: "path", required: true },
548
+ { name: "itemId", in: "path", required: true },
549
+ { name: "If-Match", in: "header", required: true }
550
+ ],
551
+ requestContentTypes: []
552
+ },
553
+ deleteTrigger: {
554
+ id: "deleteTrigger",
555
+ method: "DELETE",
556
+ path: "/shows/{showId}/triggers/{itemId}",
557
+ scope: "content:write",
558
+ tags: ["shows"],
559
+ params: [
560
+ { name: "showId", in: "path", required: true },
561
+ { name: "itemId", in: "path", required: true },
562
+ { name: "If-Match", in: "header", required: true }
563
+ ],
564
+ requestContentTypes: []
565
+ },
566
+ deleteUpload: {
567
+ id: "deleteUpload",
568
+ method: "DELETE",
569
+ path: "/uploads/{uploadId}",
570
+ scope: "content:write",
571
+ tags: ["uploads"],
572
+ params: [
573
+ { name: "uploadId", in: "path", required: true },
574
+ { name: "Tus-Resumable", in: "header", required: true }
575
+ ],
576
+ requestContentTypes: []
577
+ },
578
+ deleteUser: {
579
+ id: "deleteUser",
580
+ method: "DELETE",
581
+ path: "/users/{userId}",
582
+ scope: "users:manage",
583
+ tags: ["users"],
584
+ params: [
585
+ { name: "userId", in: "path", required: true },
586
+ { name: "If-Match", in: "header", required: true }
587
+ ],
588
+ requestContentTypes: []
589
+ },
590
+ deleteVenue: {
591
+ id: "deleteVenue",
592
+ method: "DELETE",
593
+ path: "/venues/{venueId}",
594
+ scope: "venues:write",
595
+ tags: ["venues"],
596
+ params: [
597
+ { name: "venueId", in: "path", required: true },
598
+ { name: "If-Match", in: "header", required: true }
599
+ ],
600
+ requestContentTypes: []
601
+ },
602
+ downloadAsset: {
603
+ id: "downloadAsset",
604
+ method: "GET",
605
+ path: "/assets/{assetId}/content",
606
+ scope: "content:read",
607
+ tags: ["assets"],
608
+ params: [
609
+ { name: "assetId", in: "path", required: true },
610
+ { name: "Range", in: "header", required: false },
611
+ { name: "If-None-Match", in: "header", required: false }
612
+ ],
613
+ requestContentTypes: []
614
+ },
615
+ exchangeCloudToken: {
616
+ id: "exchangeCloudToken",
617
+ method: "POST",
618
+ path: "/auth/token-exchange",
619
+ scope: "anon",
620
+ tags: ["auth"],
621
+ params: [],
622
+ requestContentTypes: ["application/json"]
623
+ },
624
+ exportShow: {
625
+ id: "exportShow",
626
+ method: "GET",
627
+ path: "/shows/{showId}/export",
628
+ scope: "content:read",
629
+ tags: ["shows"],
630
+ params: [
631
+ { name: "showId", in: "path", required: true },
632
+ { name: "embedAssets", in: "query", required: false },
633
+ { name: "Range", in: "header", required: false }
634
+ ],
635
+ requestContentTypes: []
636
+ },
637
+ exportVenue: {
638
+ id: "exportVenue",
639
+ method: "GET",
640
+ path: "/venues/{venueId}/export",
641
+ scope: "content:read",
642
+ tags: ["venues"],
643
+ params: [{ name: "venueId", in: "path", required: true }],
644
+ requestContentTypes: []
645
+ },
646
+ fireCue: {
647
+ id: "fireCue",
648
+ method: "POST",
649
+ path: "/venues/{venueId}/cues/{cueId}/fire",
650
+ scope: "playback:control",
651
+ tags: ["playback"],
652
+ params: [
653
+ { name: "venueId", in: "path", required: true },
654
+ { name: "cueId", in: "path", required: true },
655
+ { name: "Idempotency-Key", in: "header", required: false }
656
+ ],
657
+ requestContentTypes: ["application/json"]
658
+ },
659
+ getActiveShow: {
660
+ id: "getActiveShow",
661
+ method: "GET",
662
+ path: "/venues/{venueId}/active-show",
663
+ scope: "playback:read",
664
+ tags: ["playback"],
665
+ params: [{ name: "venueId", in: "path", required: true }],
666
+ requestContentTypes: []
667
+ },
668
+ getApiKey: {
669
+ id: "getApiKey",
670
+ method: "GET",
671
+ path: "/api-keys/{keyId}",
672
+ scope: "keys:manage",
673
+ tags: ["api-keys"],
674
+ params: [{ name: "keyId", in: "path", required: true }],
675
+ requestContentTypes: []
676
+ },
677
+ getAsset: {
678
+ id: "getAsset",
679
+ method: "GET",
680
+ path: "/assets/{assetId}",
681
+ scope: "content:read",
682
+ tags: ["assets"],
683
+ params: [
684
+ { name: "assetId", in: "path", required: true },
685
+ { name: "If-None-Match", in: "header", required: false }
686
+ ],
687
+ requestContentTypes: []
688
+ },
689
+ getAssetThumbnail: {
690
+ id: "getAssetThumbnail",
691
+ method: "GET",
692
+ path: "/assets/{assetId}/thumbnail",
693
+ scope: "content:read",
694
+ tags: ["assets"],
695
+ params: [
696
+ { name: "assetId", in: "path", required: true },
697
+ { name: "size", in: "query", required: false }
698
+ ],
699
+ requestContentTypes: []
700
+ },
701
+ getAudio: {
702
+ id: "getAudio",
703
+ method: "GET",
704
+ path: "/venues/{venueId}/audio",
705
+ scope: "playback:read",
706
+ tags: ["audio"],
707
+ params: [{ name: "venueId", in: "path", required: true }],
708
+ requestContentTypes: []
709
+ },
710
+ getAudioAnalysis: {
711
+ id: "getAudioAnalysis",
712
+ method: "GET",
713
+ path: "/venues/{venueId}/audio/analysis",
714
+ scope: "playback:read",
715
+ tags: ["audio"],
716
+ params: [{ name: "venueId", in: "path", required: true }],
717
+ requestContentTypes: []
718
+ },
719
+ getAudioDevice: {
720
+ id: "getAudioDevice",
721
+ method: "GET",
722
+ path: "/venues/{venueId}/audio/devices/{deviceId}",
723
+ scope: "playback:read",
724
+ tags: ["audio"],
725
+ params: [
726
+ { name: "venueId", in: "path", required: true },
727
+ { name: "deviceId", in: "path", required: true }
728
+ ],
729
+ requestContentTypes: []
730
+ },
731
+ getAudioPreset: {
732
+ id: "getAudioPreset",
733
+ method: "GET",
734
+ path: "/venues/{venueId}/audio/presets/{presetId}",
735
+ scope: "content:read",
736
+ tags: ["audio"],
737
+ params: [
738
+ { name: "venueId", in: "path", required: true },
739
+ { name: "presetId", in: "path", required: true }
740
+ ],
741
+ requestContentTypes: []
742
+ },
743
+ getAudioReactive: {
744
+ id: "getAudioReactive",
745
+ method: "GET",
746
+ path: "/venues/{venueId}/audio/reactive",
747
+ scope: "playback:read",
748
+ tags: ["audio"],
749
+ params: [{ name: "venueId", in: "path", required: true }],
750
+ requestContentTypes: []
751
+ },
752
+ getAudioReactiveScene: {
753
+ id: "getAudioReactiveScene",
754
+ method: "GET",
755
+ path: "/venues/{venueId}/audio/reactive/scenes/{sceneId}",
756
+ scope: "content:read",
757
+ tags: ["audio"],
758
+ params: [
759
+ { name: "venueId", in: "path", required: true },
760
+ { name: "sceneId", in: "path", required: true }
761
+ ],
762
+ requestContentTypes: []
763
+ },
764
+ getAudioSession: {
765
+ id: "getAudioSession",
766
+ method: "GET",
767
+ path: "/venues/{venueId}/audio/sessions/{sessionId}",
768
+ scope: "playback:read",
769
+ tags: ["audio"],
770
+ params: [
771
+ { name: "venueId", in: "path", required: true },
772
+ { name: "sessionId", in: "path", required: true }
773
+ ],
774
+ requestContentTypes: []
775
+ },
776
+ getAudioZone: {
777
+ id: "getAudioZone",
778
+ method: "GET",
779
+ path: "/venues/{venueId}/audio/zones/{zoneId}",
780
+ scope: "playback:read",
781
+ tags: ["audio"],
782
+ params: [
783
+ { name: "venueId", in: "path", required: true },
784
+ { name: "zoneId", in: "path", required: true }
785
+ ],
786
+ requestContentTypes: []
787
+ },
788
+ getCalibration: {
789
+ id: "getCalibration",
790
+ method: "GET",
791
+ path: "/venues/{venueId}/calibration",
792
+ scope: "info:read",
793
+ tags: ["calibration"],
794
+ params: [{ name: "venueId", in: "path", required: true }],
795
+ requestContentTypes: []
796
+ },
797
+ getCalibrationFile: {
798
+ id: "getCalibrationFile",
799
+ method: "GET",
800
+ path: "/venues/{venueId}/calibration/displays/{displayId}/{file}",
801
+ scope: "info:read",
802
+ tags: ["calibration"],
803
+ params: [
804
+ { name: "venueId", in: "path", required: true },
805
+ { name: "displayId", in: "path", required: true },
806
+ { name: "file", in: "path", required: true }
807
+ ],
808
+ requestContentTypes: []
809
+ },
810
+ getCalibrationJob: {
811
+ id: "getCalibrationJob",
812
+ method: "GET",
813
+ path: "/venues/{venueId}/calibration/jobs/{jobId}",
814
+ scope: "info:read",
815
+ tags: ["calibration"],
816
+ params: [
817
+ { name: "venueId", in: "path", required: true },
818
+ { name: "jobId", in: "path", required: true }
819
+ ],
820
+ requestContentTypes: []
821
+ },
822
+ getConfig: {
823
+ id: "getConfig",
824
+ method: "GET",
825
+ path: "/system/config",
826
+ scope: "system:read",
827
+ tags: ["system"],
828
+ params: [],
829
+ requestContentTypes: []
830
+ },
831
+ getCue: {
832
+ id: "getCue",
833
+ method: "GET",
834
+ path: "/shows/{showId}/cues/{itemId}",
835
+ scope: "content:read",
836
+ tags: ["shows"],
837
+ params: [
838
+ { name: "showId", in: "path", required: true },
839
+ { name: "itemId", in: "path", required: true }
840
+ ],
841
+ requestContentTypes: []
842
+ },
843
+ getDevice: {
844
+ id: "getDevice",
845
+ method: "GET",
846
+ path: "/devices/{deviceId}",
847
+ scope: "info:read",
848
+ tags: ["devices"],
849
+ params: [{ name: "deviceId", in: "path", required: true }],
850
+ requestContentTypes: []
851
+ },
852
+ getDisplay: {
853
+ id: "getDisplay",
854
+ method: "GET",
855
+ path: "/venues/{venueId}/displays/{displayId}",
856
+ scope: "info:read",
857
+ tags: ["displays"],
858
+ params: [
859
+ { name: "venueId", in: "path", required: true },
860
+ { name: "displayId", in: "path", required: true }
861
+ ],
862
+ requestContentTypes: []
863
+ },
864
+ getEngine: {
865
+ id: "getEngine",
866
+ method: "GET",
867
+ path: "/engines/{name}",
868
+ scope: "info:read",
869
+ tags: ["engines"],
870
+ params: [{ name: "name", in: "path", required: true }],
871
+ requestContentTypes: []
872
+ },
873
+ getGateway: {
874
+ id: "getGateway",
875
+ method: "GET",
876
+ path: "/gateways/{gatewayId}",
877
+ scope: "gateways:manage",
878
+ tags: ["gateways"],
879
+ params: [{ name: "gatewayId", in: "path", required: true }],
880
+ requestContentTypes: []
881
+ },
882
+ getGenerator: {
883
+ id: "getGenerator",
884
+ method: "GET",
885
+ path: "/venues/{venueId}/audio/generator",
886
+ scope: "playback:read",
887
+ tags: ["audio"],
888
+ params: [{ name: "venueId", in: "path", required: true }],
889
+ requestContentTypes: []
890
+ },
891
+ getHealth: {
892
+ id: "getHealth",
893
+ method: "GET",
894
+ path: "/health",
895
+ scope: "anon",
896
+ tags: ["discovery"],
897
+ params: [],
898
+ requestContentTypes: []
899
+ },
900
+ getInfo: {
901
+ id: "getInfo",
902
+ method: "GET",
903
+ path: "/info",
904
+ scope: "anon",
905
+ tags: ["discovery"],
906
+ params: [{ name: "If-None-Match", in: "header", required: false }],
907
+ requestContentTypes: []
908
+ },
909
+ getJob: {
910
+ id: "getJob",
911
+ method: "GET",
912
+ path: "/jobs/{jobId}",
913
+ scope: "any",
914
+ tags: ["jobs"],
915
+ params: [{ name: "jobId", in: "path", required: true }],
916
+ requestContentTypes: []
917
+ },
918
+ getLogs: {
919
+ id: "getLogs",
920
+ method: "GET",
921
+ path: "/system/logs",
922
+ scope: "system:read",
923
+ tags: ["system"],
924
+ params: [
925
+ { name: "limit", in: "query", required: false },
926
+ { name: "cursor", in: "query", required: false },
927
+ { name: "since", in: "query", required: false },
928
+ { name: "level", in: "query", required: false }
929
+ ],
930
+ requestContentTypes: []
931
+ },
932
+ getMatrix: {
933
+ id: "getMatrix",
934
+ method: "GET",
935
+ path: "/shows/{showId}/matrix",
936
+ scope: "content:read",
937
+ tags: ["shows"],
938
+ params: [{ name: "showId", in: "path", required: true }],
939
+ requestContentTypes: []
940
+ },
941
+ getMe: {
942
+ id: "getMe",
943
+ method: "GET",
944
+ path: "/auth/me",
945
+ scope: "any",
946
+ tags: ["auth"],
947
+ params: [],
948
+ requestContentTypes: []
949
+ },
950
+ getMetrics: {
951
+ id: "getMetrics",
952
+ method: "GET",
953
+ path: "/metrics",
954
+ scope: "anon",
955
+ tags: ["discovery"],
956
+ params: [],
957
+ requestContentTypes: []
958
+ },
959
+ getNode: {
960
+ id: "getNode",
961
+ method: "GET",
962
+ path: "/nodes/{nodeId}",
963
+ scope: "info:read",
964
+ tags: ["system"],
965
+ params: [{ name: "nodeId", in: "path", required: true }],
966
+ requestContentTypes: []
967
+ },
968
+ getOpenApi: {
969
+ id: "getOpenApi",
970
+ method: "GET",
971
+ path: "/openapi.json",
972
+ scope: "anon",
973
+ tags: ["discovery"],
974
+ params: [],
975
+ requestContentTypes: []
976
+ },
977
+ getOutput: {
978
+ id: "getOutput",
979
+ method: "GET",
980
+ path: "/venues/{venueId}/output",
981
+ scope: "playback:read",
982
+ tags: ["output"],
983
+ params: [{ name: "venueId", in: "path", required: true }],
984
+ requestContentTypes: []
985
+ },
986
+ getPairing: {
987
+ id: "getPairing",
988
+ method: "GET",
989
+ path: "/auth/pairings/{pairingId}",
990
+ scope: "anon",
991
+ tags: ["auth"],
992
+ params: [{ name: "pairingId", in: "path", required: true }],
993
+ requestContentTypes: []
994
+ },
995
+ getParameter: {
996
+ id: "getParameter",
997
+ method: "GET",
998
+ path: "/venues/{venueId}/parameters/{path}",
999
+ scope: "playback:read",
1000
+ tags: ["playback"],
1001
+ params: [
1002
+ { name: "venueId", in: "path", required: true },
1003
+ { name: "path", in: "path", required: true }
1004
+ ],
1005
+ requestContentTypes: []
1006
+ },
1007
+ getPlayer: {
1008
+ id: "getPlayer",
1009
+ method: "GET",
1010
+ path: "/venues/{venueId}/players/{playerId}",
1011
+ scope: "playback:read",
1012
+ tags: ["playback"],
1013
+ params: [
1014
+ { name: "venueId", in: "path", required: true },
1015
+ { name: "playerId", in: "path", required: true }
1016
+ ],
1017
+ requestContentTypes: []
1018
+ },
1019
+ getPlaylist: {
1020
+ id: "getPlaylist",
1021
+ method: "GET",
1022
+ path: "/shows/{showId}/playlists/{itemId}",
1023
+ scope: "content:read",
1024
+ tags: ["shows"],
1025
+ params: [
1026
+ { name: "showId", in: "path", required: true },
1027
+ { name: "itemId", in: "path", required: true }
1028
+ ],
1029
+ requestContentTypes: []
1030
+ },
1031
+ getReady: {
1032
+ id: "getReady",
1033
+ method: "GET",
1034
+ path: "/ready",
1035
+ scope: "anon",
1036
+ tags: ["discovery"],
1037
+ params: [],
1038
+ requestContentTypes: []
1039
+ },
1040
+ getScenario: {
1041
+ id: "getScenario",
1042
+ method: "GET",
1043
+ path: "/scenarios/{scenarioId}",
1044
+ scope: "content:read",
1045
+ tags: ["scenarios"],
1046
+ params: [{ name: "scenarioId", in: "path", required: true }],
1047
+ requestContentTypes: []
1048
+ },
1049
+ getScenarioSession: {
1050
+ id: "getScenarioSession",
1051
+ method: "GET",
1052
+ path: "/venues/{venueId}/scenario-sessions/{sessionId}",
1053
+ scope: "playback:read",
1054
+ tags: ["scenarios"],
1055
+ params: [
1056
+ { name: "venueId", in: "path", required: true },
1057
+ { name: "sessionId", in: "path", required: true }
1058
+ ],
1059
+ requestContentTypes: []
1060
+ },
1061
+ getScenarioSessionLog: {
1062
+ id: "getScenarioSessionLog",
1063
+ method: "GET",
1064
+ path: "/venues/{venueId}/scenario-sessions/{sessionId}/log",
1065
+ scope: "playback:read",
1066
+ tags: ["scenarios"],
1067
+ params: [
1068
+ { name: "venueId", in: "path", required: true },
1069
+ { name: "sessionId", in: "path", required: true },
1070
+ { name: "limit", in: "query", required: false },
1071
+ { name: "cursor", in: "query", required: false }
1072
+ ],
1073
+ requestContentTypes: []
1074
+ },
1075
+ getShow: {
1076
+ id: "getShow",
1077
+ method: "GET",
1078
+ path: "/shows/{showId}",
1079
+ scope: "content:read",
1080
+ tags: ["shows"],
1081
+ params: [
1082
+ { name: "showId", in: "path", required: true },
1083
+ { name: "If-None-Match", in: "header", required: false }
1084
+ ],
1085
+ requestContentTypes: []
1086
+ },
1087
+ getSpeakerLayout: {
1088
+ id: "getSpeakerLayout",
1089
+ method: "GET",
1090
+ path: "/venues/{venueId}/audio/layout",
1091
+ scope: "info:read",
1092
+ tags: ["audio"],
1093
+ params: [{ name: "venueId", in: "path", required: true }],
1094
+ requestContentTypes: []
1095
+ },
1096
+ getStorageStats: {
1097
+ id: "getStorageStats",
1098
+ method: "GET",
1099
+ path: "/storage",
1100
+ scope: "content:read",
1101
+ tags: ["assets"],
1102
+ params: [],
1103
+ requestContentTypes: []
1104
+ },
1105
+ getSystem: {
1106
+ id: "getSystem",
1107
+ method: "GET",
1108
+ path: "/system",
1109
+ scope: "system:read",
1110
+ tags: ["system"],
1111
+ params: [],
1112
+ requestContentTypes: []
1113
+ },
1114
+ getTimeline: {
1115
+ id: "getTimeline",
1116
+ method: "GET",
1117
+ path: "/shows/{showId}/timelines/{itemId}",
1118
+ scope: "content:read",
1119
+ tags: ["shows"],
1120
+ params: [
1121
+ { name: "showId", in: "path", required: true },
1122
+ { name: "itemId", in: "path", required: true }
1123
+ ],
1124
+ requestContentTypes: []
1125
+ },
1126
+ getTrigger: {
1127
+ id: "getTrigger",
1128
+ method: "GET",
1129
+ path: "/shows/{showId}/triggers/{itemId}",
1130
+ scope: "content:read",
1131
+ tags: ["shows"],
1132
+ params: [
1133
+ { name: "showId", in: "path", required: true },
1134
+ { name: "itemId", in: "path", required: true }
1135
+ ],
1136
+ requestContentTypes: []
1137
+ },
1138
+ getUpdate: {
1139
+ id: "getUpdate",
1140
+ method: "GET",
1141
+ path: "/system/update",
1142
+ scope: "system:read",
1143
+ tags: ["system"],
1144
+ params: [],
1145
+ requestContentTypes: []
1146
+ },
1147
+ getUpload: {
1148
+ id: "getUpload",
1149
+ method: "GET",
1150
+ path: "/uploads/{uploadId}",
1151
+ scope: "content:write",
1152
+ tags: ["uploads"],
1153
+ params: [{ name: "uploadId", in: "path", required: true }],
1154
+ requestContentTypes: []
1155
+ },
1156
+ getUploadCapabilities: {
1157
+ id: "getUploadCapabilities",
1158
+ method: "OPTIONS",
1159
+ path: "/uploads",
1160
+ scope: "anon",
1161
+ tags: ["uploads"],
1162
+ params: [],
1163
+ requestContentTypes: []
1164
+ },
1165
+ getUploadOffset: {
1166
+ id: "getUploadOffset",
1167
+ method: "HEAD",
1168
+ path: "/uploads/{uploadId}",
1169
+ scope: "content:write",
1170
+ tags: ["uploads"],
1171
+ params: [
1172
+ { name: "uploadId", in: "path", required: true },
1173
+ { name: "Tus-Resumable", in: "header", required: true }
1174
+ ],
1175
+ requestContentTypes: []
1176
+ },
1177
+ getUser: {
1178
+ id: "getUser",
1179
+ method: "GET",
1180
+ path: "/users/{userId}",
1181
+ scope: "users:manage",
1182
+ tags: ["users"],
1183
+ params: [{ name: "userId", in: "path", required: true }],
1184
+ requestContentTypes: []
1185
+ },
1186
+ getVenue: {
1187
+ id: "getVenue",
1188
+ method: "GET",
1189
+ path: "/venues/{venueId}",
1190
+ scope: "info:read",
1191
+ tags: ["venues"],
1192
+ params: [
1193
+ { name: "venueId", in: "path", required: true },
1194
+ { name: "If-None-Match", in: "header", required: false }
1195
+ ],
1196
+ requestContentTypes: []
1197
+ },
1198
+ identifyDisplay: {
1199
+ id: "identifyDisplay",
1200
+ method: "POST",
1201
+ path: "/venues/{venueId}/displays/{displayId}/identify",
1202
+ scope: "displays:control",
1203
+ tags: ["displays"],
1204
+ params: [
1205
+ { name: "venueId", in: "path", required: true },
1206
+ { name: "displayId", in: "path", required: true },
1207
+ { name: "Idempotency-Key", in: "header", required: false }
1208
+ ],
1209
+ requestContentTypes: ["application/json"]
1210
+ },
1211
+ listApiKeys: {
1212
+ id: "listApiKeys",
1213
+ method: "GET",
1214
+ path: "/api-keys",
1215
+ scope: "keys:manage",
1216
+ tags: ["api-keys"],
1217
+ params: [
1218
+ { name: "limit", in: "query", required: false },
1219
+ { name: "cursor", in: "query", required: false }
1220
+ ],
1221
+ requestContentTypes: []
1222
+ },
1223
+ listAssets: {
1224
+ id: "listAssets",
1225
+ method: "GET",
1226
+ path: "/assets",
1227
+ scope: "content:read",
1228
+ tags: ["assets"],
1229
+ params: [
1230
+ { name: "limit", in: "query", required: false },
1231
+ { name: "cursor", in: "query", required: false },
1232
+ { name: "q", in: "query", required: false },
1233
+ { name: "sort", in: "query", required: false },
1234
+ { name: "count", in: "query", required: false },
1235
+ { name: "type", in: "query", required: false },
1236
+ { name: "tag", in: "query", required: false },
1237
+ { name: "status", in: "query", required: false }
1238
+ ],
1239
+ requestContentTypes: []
1240
+ },
1241
+ listAudioDevices: {
1242
+ id: "listAudioDevices",
1243
+ method: "GET",
1244
+ path: "/venues/{venueId}/audio/devices",
1245
+ scope: "playback:read",
1246
+ tags: ["audio"],
1247
+ params: [
1248
+ { name: "venueId", in: "path", required: true },
1249
+ { name: "limit", in: "query", required: false },
1250
+ { name: "cursor", in: "query", required: false },
1251
+ { name: "kind", in: "query", required: false }
1252
+ ],
1253
+ requestContentTypes: []
1254
+ },
1255
+ listAudioPresets: {
1256
+ id: "listAudioPresets",
1257
+ method: "GET",
1258
+ path: "/venues/{venueId}/audio/presets",
1259
+ scope: "content:read",
1260
+ tags: ["audio"],
1261
+ params: [
1262
+ { name: "venueId", in: "path", required: true },
1263
+ { name: "limit", in: "query", required: false },
1264
+ { name: "cursor", in: "query", required: false },
1265
+ { name: "kind", in: "query", required: false }
1266
+ ],
1267
+ requestContentTypes: []
1268
+ },
1269
+ listAudioReactiveScenes: {
1270
+ id: "listAudioReactiveScenes",
1271
+ method: "GET",
1272
+ path: "/venues/{venueId}/audio/reactive/scenes",
1273
+ scope: "content:read",
1274
+ tags: ["audio"],
1275
+ params: [
1276
+ { name: "venueId", in: "path", required: true },
1277
+ { name: "limit", in: "query", required: false },
1278
+ { name: "cursor", in: "query", required: false }
1279
+ ],
1280
+ requestContentTypes: []
1281
+ },
1282
+ listAudioSessions: {
1283
+ id: "listAudioSessions",
1284
+ method: "GET",
1285
+ path: "/venues/{venueId}/audio/sessions",
1286
+ scope: "playback:read",
1287
+ tags: ["audio"],
1288
+ params: [
1289
+ { name: "venueId", in: "path", required: true },
1290
+ { name: "limit", in: "query", required: false },
1291
+ { name: "cursor", in: "query", required: false }
1292
+ ],
1293
+ requestContentTypes: []
1294
+ },
1295
+ listAudioZones: {
1296
+ id: "listAudioZones",
1297
+ method: "GET",
1298
+ path: "/venues/{venueId}/audio/zones",
1299
+ scope: "playback:read",
1300
+ tags: ["audio"],
1301
+ params: [
1302
+ { name: "venueId", in: "path", required: true },
1303
+ { name: "limit", in: "query", required: false },
1304
+ { name: "cursor", in: "query", required: false }
1305
+ ],
1306
+ requestContentTypes: []
1307
+ },
1308
+ listCalibrationJobs: {
1309
+ id: "listCalibrationJobs",
1310
+ method: "GET",
1311
+ path: "/venues/{venueId}/calibration/jobs",
1312
+ scope: "info:read",
1313
+ tags: ["calibration"],
1314
+ params: [
1315
+ { name: "venueId", in: "path", required: true },
1316
+ { name: "limit", in: "query", required: false },
1317
+ { name: "cursor", in: "query", required: false },
1318
+ { name: "status", in: "query", required: false }
1319
+ ],
1320
+ requestContentTypes: []
1321
+ },
1322
+ listClients: {
1323
+ id: "listClients",
1324
+ method: "GET",
1325
+ path: "/clients",
1326
+ scope: "system:read",
1327
+ tags: ["clients"],
1328
+ params: [
1329
+ { name: "limit", in: "query", required: false },
1330
+ { name: "cursor", in: "query", required: false }
1331
+ ],
1332
+ requestContentTypes: []
1333
+ },
1334
+ listDevices: {
1335
+ id: "listDevices",
1336
+ method: "GET",
1337
+ path: "/devices",
1338
+ scope: "info:read",
1339
+ tags: ["devices"],
1340
+ params: [
1341
+ { name: "limit", in: "query", required: false },
1342
+ { name: "cursor", in: "query", required: false }
1343
+ ],
1344
+ requestContentTypes: []
1345
+ },
1346
+ listDisplays: {
1347
+ id: "listDisplays",
1348
+ method: "GET",
1349
+ path: "/venues/{venueId}/displays",
1350
+ scope: "info:read",
1351
+ tags: ["displays"],
1352
+ params: [
1353
+ { name: "venueId", in: "path", required: true },
1354
+ { name: "limit", in: "query", required: false },
1355
+ { name: "cursor", in: "query", required: false }
1356
+ ],
1357
+ requestContentTypes: []
1358
+ },
1359
+ listEngines: {
1360
+ id: "listEngines",
1361
+ method: "GET",
1362
+ path: "/engines",
1363
+ scope: "info:read",
1364
+ tags: ["engines"],
1365
+ params: [
1366
+ { name: "limit", in: "query", required: false },
1367
+ { name: "cursor", in: "query", required: false }
1368
+ ],
1369
+ requestContentTypes: []
1370
+ },
1371
+ listEvents: {
1372
+ id: "listEvents",
1373
+ method: "GET",
1374
+ path: "/events",
1375
+ scope: "events:subscribe",
1376
+ tags: ["events"],
1377
+ params: [
1378
+ { name: "limit", in: "query", required: false },
1379
+ { name: "cursor", in: "query", required: false },
1380
+ { name: "topics", in: "query", required: true },
1381
+ { name: "sinceSeq", in: "query", required: false }
1382
+ ],
1383
+ requestContentTypes: []
1384
+ },
1385
+ listGateways: {
1386
+ id: "listGateways",
1387
+ method: "GET",
1388
+ path: "/gateways",
1389
+ scope: "gateways:manage",
1390
+ tags: ["gateways"],
1391
+ params: [
1392
+ { name: "limit", in: "query", required: false },
1393
+ { name: "cursor", in: "query", required: false }
1394
+ ],
1395
+ requestContentTypes: []
1396
+ },
1397
+ listJobs: {
1398
+ id: "listJobs",
1399
+ method: "GET",
1400
+ path: "/jobs",
1401
+ scope: "any",
1402
+ tags: ["jobs"],
1403
+ params: [
1404
+ { name: "limit", in: "query", required: false },
1405
+ { name: "cursor", in: "query", required: false },
1406
+ { name: "kind", in: "query", required: false },
1407
+ { name: "status", in: "query", required: false }
1408
+ ],
1409
+ requestContentTypes: []
1410
+ },
1411
+ listNodes: {
1412
+ id: "listNodes",
1413
+ method: "GET",
1414
+ path: "/nodes",
1415
+ scope: "info:read",
1416
+ tags: ["system"],
1417
+ params: [
1418
+ { name: "limit", in: "query", required: false },
1419
+ { name: "cursor", in: "query", required: false }
1420
+ ],
1421
+ requestContentTypes: []
1422
+ },
1423
+ listPairings: {
1424
+ id: "listPairings",
1425
+ method: "GET",
1426
+ path: "/auth/pairings",
1427
+ scope: "users:manage",
1428
+ tags: ["auth"],
1429
+ params: [
1430
+ { name: "limit", in: "query", required: false },
1431
+ { name: "cursor", in: "query", required: false }
1432
+ ],
1433
+ requestContentTypes: []
1434
+ },
1435
+ listParameters: {
1436
+ id: "listParameters",
1437
+ method: "GET",
1438
+ path: "/venues/{venueId}/parameters",
1439
+ scope: "playback:read",
1440
+ tags: ["playback"],
1441
+ params: [
1442
+ { name: "venueId", in: "path", required: true },
1443
+ { name: "limit", in: "query", required: false },
1444
+ { name: "cursor", in: "query", required: false },
1445
+ { name: "prefix", in: "query", required: false }
1446
+ ],
1447
+ requestContentTypes: []
1448
+ },
1449
+ listPlayers: {
1450
+ id: "listPlayers",
1451
+ method: "GET",
1452
+ path: "/venues/{venueId}/players",
1453
+ scope: "playback:read",
1454
+ tags: ["playback"],
1455
+ params: [
1456
+ { name: "venueId", in: "path", required: true },
1457
+ { name: "limit", in: "query", required: false },
1458
+ { name: "cursor", in: "query", required: false }
1459
+ ],
1460
+ requestContentTypes: []
1461
+ },
1462
+ listScenarioSessions: {
1463
+ id: "listScenarioSessions",
1464
+ method: "GET",
1465
+ path: "/venues/{venueId}/scenario-sessions",
1466
+ scope: "playback:read",
1467
+ tags: ["scenarios"],
1468
+ params: [
1469
+ { name: "venueId", in: "path", required: true },
1470
+ { name: "limit", in: "query", required: false },
1471
+ { name: "cursor", in: "query", required: false }
1472
+ ],
1473
+ requestContentTypes: []
1474
+ },
1475
+ listScenarios: {
1476
+ id: "listScenarios",
1477
+ method: "GET",
1478
+ path: "/scenarios",
1479
+ scope: "content:read",
1480
+ tags: ["scenarios"],
1481
+ params: [
1482
+ { name: "limit", in: "query", required: false },
1483
+ { name: "cursor", in: "query", required: false }
1484
+ ],
1485
+ requestContentTypes: []
1486
+ },
1487
+ listShows: {
1488
+ id: "listShows",
1489
+ method: "GET",
1490
+ path: "/shows",
1491
+ scope: "content:read",
1492
+ tags: ["shows"],
1493
+ params: [
1494
+ { name: "limit", in: "query", required: false },
1495
+ { name: "cursor", in: "query", required: false },
1496
+ { name: "q", in: "query", required: false },
1497
+ { name: "sort", in: "query", required: false },
1498
+ { name: "tag", in: "query", required: false }
1499
+ ],
1500
+ requestContentTypes: []
1501
+ },
1502
+ listTextureSources: {
1503
+ id: "listTextureSources",
1504
+ method: "GET",
1505
+ path: "/venues/{venueId}/texture-sources",
1506
+ scope: "playback:read",
1507
+ tags: ["assets"],
1508
+ params: [
1509
+ { name: "venueId", in: "path", required: true },
1510
+ { name: "limit", in: "query", required: false },
1511
+ { name: "cursor", in: "query", required: false }
1512
+ ],
1513
+ requestContentTypes: []
1514
+ },
1515
+ listUsers: {
1516
+ id: "listUsers",
1517
+ method: "GET",
1518
+ path: "/users",
1519
+ scope: "users:manage",
1520
+ tags: ["users"],
1521
+ params: [
1522
+ { name: "limit", in: "query", required: false },
1523
+ { name: "cursor", in: "query", required: false },
1524
+ { name: "q", in: "query", required: false }
1525
+ ],
1526
+ requestContentTypes: []
1527
+ },
1528
+ listVenues: {
1529
+ id: "listVenues",
1530
+ method: "GET",
1531
+ path: "/venues",
1532
+ scope: "info:read",
1533
+ tags: ["venues"],
1534
+ params: [
1535
+ { name: "limit", in: "query", required: false },
1536
+ { name: "cursor", in: "query", required: false }
1537
+ ],
1538
+ requestContentTypes: []
1539
+ },
1540
+ next: {
1541
+ id: "next",
1542
+ method: "POST",
1543
+ path: "/venues/{venueId}/players/{playerId}/next",
1544
+ scope: "playback:control",
1545
+ tags: ["playback"],
1546
+ params: [
1547
+ { name: "venueId", in: "path", required: true },
1548
+ { name: "playerId", in: "path", required: true },
1549
+ { name: "Idempotency-Key", in: "header", required: false }
1550
+ ],
1551
+ requestContentTypes: []
1552
+ },
1553
+ patchAsset: {
1554
+ id: "patchAsset",
1555
+ method: "PATCH",
1556
+ path: "/assets/{assetId}",
1557
+ scope: "content:write",
1558
+ tags: ["assets"],
1559
+ params: [
1560
+ { name: "assetId", in: "path", required: true },
1561
+ { name: "If-Match", in: "header", required: true }
1562
+ ],
1563
+ requestContentTypes: ["application/merge-patch+json"]
1564
+ },
1565
+ patchAudio: {
1566
+ id: "patchAudio",
1567
+ method: "PATCH",
1568
+ path: "/venues/{venueId}/audio",
1569
+ scope: "audio:control",
1570
+ tags: ["audio"],
1571
+ params: [{ name: "venueId", in: "path", required: true }],
1572
+ requestContentTypes: ["application/merge-patch+json"]
1573
+ },
1574
+ patchAudioDevice: {
1575
+ id: "patchAudioDevice",
1576
+ method: "PATCH",
1577
+ path: "/venues/{venueId}/audio/devices/{deviceId}",
1578
+ scope: "audio:control",
1579
+ tags: ["audio"],
1580
+ params: [
1581
+ { name: "venueId", in: "path", required: true },
1582
+ { name: "deviceId", in: "path", required: true }
1583
+ ],
1584
+ requestContentTypes: ["application/merge-patch+json"]
1585
+ },
1586
+ patchAudioReactive: {
1587
+ id: "patchAudioReactive",
1588
+ method: "PATCH",
1589
+ path: "/venues/{venueId}/audio/reactive",
1590
+ scope: "playback:control",
1591
+ tags: ["audio"],
1592
+ params: [{ name: "venueId", in: "path", required: true }],
1593
+ requestContentTypes: ["application/merge-patch+json"]
1594
+ },
1595
+ patchAudioZone: {
1596
+ id: "patchAudioZone",
1597
+ method: "PATCH",
1598
+ path: "/venues/{venueId}/audio/zones/{zoneId}",
1599
+ scope: "audio:control",
1600
+ tags: ["audio"],
1601
+ params: [
1602
+ { name: "venueId", in: "path", required: true },
1603
+ { name: "zoneId", in: "path", required: true }
1604
+ ],
1605
+ requestContentTypes: ["application/merge-patch+json"]
1606
+ },
1607
+ patchDisplay: {
1608
+ id: "patchDisplay",
1609
+ method: "PATCH",
1610
+ path: "/venues/{venueId}/displays/{displayId}",
1611
+ scope: "venues:write",
1612
+ tags: ["displays"],
1613
+ params: [
1614
+ { name: "venueId", in: "path", required: true },
1615
+ { name: "displayId", in: "path", required: true },
1616
+ { name: "If-Match", in: "header", required: true }
1617
+ ],
1618
+ requestContentTypes: ["application/merge-patch+json"]
1619
+ },
1620
+ patchGateway: {
1621
+ id: "patchGateway",
1622
+ method: "PATCH",
1623
+ path: "/gateways/{gatewayId}",
1624
+ scope: "gateways:manage",
1625
+ tags: ["gateways"],
1626
+ params: [
1627
+ { name: "gatewayId", in: "path", required: true },
1628
+ { name: "If-Match", in: "header", required: true }
1629
+ ],
1630
+ requestContentTypes: ["application/merge-patch+json"]
1631
+ },
1632
+ patchOutput: {
1633
+ id: "patchOutput",
1634
+ method: "PATCH",
1635
+ path: "/venues/{venueId}/output",
1636
+ scope: "playback:control",
1637
+ tags: ["output"],
1638
+ params: [{ name: "venueId", in: "path", required: true }],
1639
+ requestContentTypes: ["application/merge-patch+json"]
1640
+ },
1641
+ patchPlayer: {
1642
+ id: "patchPlayer",
1643
+ method: "PATCH",
1644
+ path: "/venues/{venueId}/players/{playerId}",
1645
+ scope: "playback:control",
1646
+ tags: ["playback"],
1647
+ params: [
1648
+ { name: "venueId", in: "path", required: true },
1649
+ { name: "playerId", in: "path", required: true }
1650
+ ],
1651
+ requestContentTypes: ["application/merge-patch+json"]
1652
+ },
1653
+ patchScenario: {
1654
+ id: "patchScenario",
1655
+ method: "PATCH",
1656
+ path: "/scenarios/{scenarioId}",
1657
+ scope: "system:admin",
1658
+ tags: ["scenarios"],
1659
+ params: [{ name: "scenarioId", in: "path", required: true }],
1660
+ requestContentTypes: ["application/merge-patch+json"]
1661
+ },
1662
+ patchShow: {
1663
+ id: "patchShow",
1664
+ method: "PATCH",
1665
+ path: "/shows/{showId}",
1666
+ scope: "content:write",
1667
+ tags: ["shows"],
1668
+ params: [
1669
+ { name: "showId", in: "path", required: true },
1670
+ { name: "If-Match", in: "header", required: true }
1671
+ ],
1672
+ requestContentTypes: ["application/merge-patch+json"]
1673
+ },
1674
+ patchUser: {
1675
+ id: "patchUser",
1676
+ method: "PATCH",
1677
+ path: "/users/{userId}",
1678
+ scope: "users:manage",
1679
+ tags: ["users"],
1680
+ params: [
1681
+ { name: "userId", in: "path", required: true },
1682
+ { name: "If-Match", in: "header", required: true }
1683
+ ],
1684
+ requestContentTypes: ["application/merge-patch+json"]
1685
+ },
1686
+ patchVenue: {
1687
+ id: "patchVenue",
1688
+ method: "PATCH",
1689
+ path: "/venues/{venueId}",
1690
+ scope: "venues:write",
1691
+ tags: ["venues"],
1692
+ params: [
1693
+ { name: "venueId", in: "path", required: true },
1694
+ { name: "If-Match", in: "header", required: true }
1695
+ ],
1696
+ requestContentTypes: ["application/merge-patch+json"]
1697
+ },
1698
+ pause: {
1699
+ id: "pause",
1700
+ method: "POST",
1701
+ path: "/venues/{venueId}/players/{playerId}/pause",
1702
+ scope: "playback:control",
1703
+ tags: ["playback"],
1704
+ params: [
1705
+ { name: "venueId", in: "path", required: true },
1706
+ { name: "playerId", in: "path", required: true },
1707
+ { name: "Idempotency-Key", in: "header", required: false }
1708
+ ],
1709
+ requestContentTypes: []
1710
+ },
1711
+ pauseScenarioSession: {
1712
+ id: "pauseScenarioSession",
1713
+ method: "POST",
1714
+ path: "/venues/{venueId}/scenario-sessions/{sessionId}/pause",
1715
+ scope: "playback:control",
1716
+ tags: ["scenarios"],
1717
+ params: [
1718
+ { name: "venueId", in: "path", required: true },
1719
+ { name: "sessionId", in: "path", required: true },
1720
+ { name: "Idempotency-Key", in: "header", required: false }
1721
+ ],
1722
+ requestContentTypes: []
1723
+ },
1724
+ play: {
1725
+ id: "play",
1726
+ method: "POST",
1727
+ path: "/venues/{venueId}/players/{playerId}/play",
1728
+ scope: "playback:control",
1729
+ tags: ["playback"],
1730
+ params: [
1731
+ { name: "venueId", in: "path", required: true },
1732
+ { name: "playerId", in: "path", required: true },
1733
+ { name: "Idempotency-Key", in: "header", required: false }
1734
+ ],
1735
+ requestContentTypes: ["application/json"]
1736
+ },
1737
+ postClientTelemetry: {
1738
+ id: "postClientTelemetry",
1739
+ method: "POST",
1740
+ path: "/clients/{clientId}/telemetry",
1741
+ scope: "any",
1742
+ tags: ["clients"],
1743
+ params: [
1744
+ { name: "clientId", in: "path", required: true },
1745
+ { name: "Idempotency-Key", in: "header", required: false }
1746
+ ],
1747
+ requestContentTypes: ["application/json"]
1748
+ },
1749
+ previous: {
1750
+ id: "previous",
1751
+ method: "POST",
1752
+ path: "/venues/{venueId}/players/{playerId}/previous",
1753
+ scope: "playback:control",
1754
+ tags: ["playback"],
1755
+ params: [
1756
+ { name: "venueId", in: "path", required: true },
1757
+ { name: "playerId", in: "path", required: true },
1758
+ { name: "Idempotency-Key", in: "header", required: false }
1759
+ ],
1760
+ requestContentTypes: []
1761
+ },
1762
+ publishAppPayload: {
1763
+ id: "publishAppPayload",
1764
+ method: "POST",
1765
+ path: "/apps/{app}/payloads",
1766
+ scope: "apps:publish",
1767
+ tags: ["apps"],
1768
+ params: [
1769
+ { name: "app", in: "path", required: true },
1770
+ { name: "Idempotency-Key", in: "header", required: false }
1771
+ ],
1772
+ requestContentTypes: ["application/json"]
1773
+ },
1774
+ putAudioPreset: {
1775
+ id: "putAudioPreset",
1776
+ method: "PUT",
1777
+ path: "/venues/{venueId}/audio/presets/{presetId}",
1778
+ scope: "content:write",
1779
+ tags: ["audio"],
1780
+ params: [
1781
+ { name: "venueId", in: "path", required: true },
1782
+ { name: "presetId", in: "path", required: true },
1783
+ { name: "If-Match", in: "header", required: false },
1784
+ { name: "If-None-Match", in: "header", required: false }
1785
+ ],
1786
+ requestContentTypes: ["application/json"]
1787
+ },
1788
+ putAudioReactiveScene: {
1789
+ id: "putAudioReactiveScene",
1790
+ method: "PUT",
1791
+ path: "/venues/{venueId}/audio/reactive/scenes/{sceneId}",
1792
+ scope: "content:write",
1793
+ tags: ["audio"],
1794
+ params: [
1795
+ { name: "venueId", in: "path", required: true },
1796
+ { name: "sceneId", in: "path", required: true },
1797
+ { name: "If-Match", in: "header", required: false },
1798
+ { name: "If-None-Match", in: "header", required: false }
1799
+ ],
1800
+ requestContentTypes: ["application/json"]
1801
+ },
1802
+ putAudioZone: {
1803
+ id: "putAudioZone",
1804
+ method: "PUT",
1805
+ path: "/venues/{venueId}/audio/zones/{zoneId}",
1806
+ scope: "audio:control",
1807
+ tags: ["audio"],
1808
+ params: [
1809
+ { name: "venueId", in: "path", required: true },
1810
+ { name: "zoneId", in: "path", required: true },
1811
+ { name: "If-Match", in: "header", required: false },
1812
+ { name: "If-None-Match", in: "header", required: false }
1813
+ ],
1814
+ requestContentTypes: ["application/json"]
1815
+ },
1816
+ putCalibrationFile: {
1817
+ id: "putCalibrationFile",
1818
+ method: "PUT",
1819
+ path: "/venues/{venueId}/calibration/displays/{displayId}/{file}",
1820
+ scope: "calibration:run",
1821
+ tags: ["calibration"],
1822
+ params: [
1823
+ { name: "venueId", in: "path", required: true },
1824
+ { name: "displayId", in: "path", required: true },
1825
+ { name: "file", in: "path", required: true },
1826
+ { name: "If-Match", in: "header", required: true }
1827
+ ],
1828
+ requestContentTypes: ["application/vnd.nativemind.freedome.fdmesh", "image/png", "text/plain"]
1829
+ },
1830
+ putConfig: {
1831
+ id: "putConfig",
1832
+ method: "PUT",
1833
+ path: "/system/config",
1834
+ scope: "system:admin",
1835
+ tags: ["system"],
1836
+ params: [{ name: "If-Match", in: "header", required: true }],
1837
+ requestContentTypes: ["application/json"]
1838
+ },
1839
+ putCue: {
1840
+ id: "putCue",
1841
+ method: "PUT",
1842
+ path: "/shows/{showId}/cues/{itemId}",
1843
+ scope: "content:write",
1844
+ tags: ["shows"],
1845
+ params: [
1846
+ { name: "showId", in: "path", required: true },
1847
+ { name: "itemId", in: "path", required: true },
1848
+ { name: "If-Match", in: "header", required: true }
1849
+ ],
1850
+ requestContentTypes: ["application/json"]
1851
+ },
1852
+ putMatrix: {
1853
+ id: "putMatrix",
1854
+ method: "PUT",
1855
+ path: "/shows/{showId}/matrix",
1856
+ scope: "content:write",
1857
+ tags: ["shows"],
1858
+ params: [
1859
+ { name: "showId", in: "path", required: true },
1860
+ { name: "If-Match", in: "header", required: true }
1861
+ ],
1862
+ requestContentTypes: ["application/json"]
1863
+ },
1864
+ putPlaylist: {
1865
+ id: "putPlaylist",
1866
+ method: "PUT",
1867
+ path: "/shows/{showId}/playlists/{itemId}",
1868
+ scope: "content:write",
1869
+ tags: ["shows"],
1870
+ params: [
1871
+ { name: "showId", in: "path", required: true },
1872
+ { name: "itemId", in: "path", required: true },
1873
+ { name: "If-Match", in: "header", required: true }
1874
+ ],
1875
+ requestContentTypes: ["application/json"]
1876
+ },
1877
+ putShow: {
1878
+ id: "putShow",
1879
+ method: "PUT",
1880
+ path: "/shows/{showId}",
1881
+ scope: "content:write",
1882
+ tags: ["shows"],
1883
+ params: [
1884
+ { name: "showId", in: "path", required: true },
1885
+ { name: "If-Match", in: "header", required: false },
1886
+ { name: "If-None-Match", in: "header", required: false }
1887
+ ],
1888
+ requestContentTypes: ["application/json"]
1889
+ },
1890
+ putSpeakerLayout: {
1891
+ id: "putSpeakerLayout",
1892
+ method: "PUT",
1893
+ path: "/venues/{venueId}/audio/layout",
1894
+ scope: "venues:write",
1895
+ tags: ["audio"],
1896
+ params: [
1897
+ { name: "venueId", in: "path", required: true },
1898
+ { name: "If-Match", in: "header", required: true }
1899
+ ],
1900
+ requestContentTypes: ["application/json"]
1901
+ },
1902
+ putTimeline: {
1903
+ id: "putTimeline",
1904
+ method: "PUT",
1905
+ path: "/shows/{showId}/timelines/{itemId}",
1906
+ scope: "content:write",
1907
+ tags: ["shows"],
1908
+ params: [
1909
+ { name: "showId", in: "path", required: true },
1910
+ { name: "itemId", in: "path", required: true },
1911
+ { name: "If-Match", in: "header", required: true }
1912
+ ],
1913
+ requestContentTypes: ["application/json"]
1914
+ },
1915
+ putTrigger: {
1916
+ id: "putTrigger",
1917
+ method: "PUT",
1918
+ path: "/shows/{showId}/triggers/{itemId}",
1919
+ scope: "content:write",
1920
+ tags: ["shows"],
1921
+ params: [
1922
+ { name: "showId", in: "path", required: true },
1923
+ { name: "itemId", in: "path", required: true },
1924
+ { name: "If-Match", in: "header", required: true }
1925
+ ],
1926
+ requestContentTypes: ["application/json"]
1927
+ },
1928
+ putVenue: {
1929
+ id: "putVenue",
1930
+ method: "PUT",
1931
+ path: "/venues/{venueId}",
1932
+ scope: "venues:write",
1933
+ tags: ["venues"],
1934
+ params: [
1935
+ { name: "venueId", in: "path", required: true },
1936
+ { name: "If-Match", in: "header", required: false },
1937
+ { name: "If-None-Match", in: "header", required: false }
1938
+ ],
1939
+ requestContentTypes: ["application/json"]
1940
+ },
1941
+ rebootSystem: {
1942
+ id: "rebootSystem",
1943
+ method: "POST",
1944
+ path: "/system/reboot",
1945
+ scope: "system:admin",
1946
+ tags: ["system"],
1947
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
1948
+ requestContentTypes: ["application/json"]
1949
+ },
1950
+ refreshSession: {
1951
+ id: "refreshSession",
1952
+ method: "POST",
1953
+ path: "/auth/refresh",
1954
+ scope: "anon",
1955
+ tags: ["auth"],
1956
+ params: [],
1957
+ requestContentTypes: ["application/json"]
1958
+ },
1959
+ registerClient: {
1960
+ id: "registerClient",
1961
+ method: "POST",
1962
+ path: "/clients",
1963
+ scope: "any",
1964
+ tags: ["clients"],
1965
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
1966
+ requestContentTypes: ["application/json"]
1967
+ },
1968
+ restartEngine: {
1969
+ id: "restartEngine",
1970
+ method: "POST",
1971
+ path: "/engines/{name}/restart",
1972
+ scope: "system:admin",
1973
+ tags: ["engines"],
1974
+ params: [
1975
+ { name: "name", in: "path", required: true },
1976
+ { name: "Idempotency-Key", in: "header", required: false }
1977
+ ],
1978
+ requestContentTypes: []
1979
+ },
1980
+ restoreBackup: {
1981
+ id: "restoreBackup",
1982
+ method: "POST",
1983
+ path: "/system/restore",
1984
+ scope: "system:admin",
1985
+ tags: ["system"],
1986
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
1987
+ requestContentTypes: ["application/json"]
1988
+ },
1989
+ resume: {
1990
+ id: "resume",
1991
+ method: "POST",
1992
+ path: "/venues/{venueId}/players/{playerId}/resume",
1993
+ scope: "playback:control",
1994
+ tags: ["playback"],
1995
+ params: [
1996
+ { name: "venueId", in: "path", required: true },
1997
+ { name: "playerId", in: "path", required: true },
1998
+ { name: "Idempotency-Key", in: "header", required: false }
1999
+ ],
2000
+ requestContentTypes: []
2001
+ },
2002
+ resumeScenarioSession: {
2003
+ id: "resumeScenarioSession",
2004
+ method: "POST",
2005
+ path: "/venues/{venueId}/scenario-sessions/{sessionId}/resume",
2006
+ scope: "playback:control",
2007
+ tags: ["scenarios"],
2008
+ params: [
2009
+ { name: "venueId", in: "path", required: true },
2010
+ { name: "sessionId", in: "path", required: true },
2011
+ { name: "Idempotency-Key", in: "header", required: false }
2012
+ ],
2013
+ requestContentTypes: []
2014
+ },
2015
+ runDiagnostics: {
2016
+ id: "runDiagnostics",
2017
+ method: "POST",
2018
+ path: "/system/diagnostics",
2019
+ scope: "system:read",
2020
+ tags: ["system"],
2021
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2022
+ requestContentTypes: ["application/json"]
2023
+ },
2024
+ seek: {
2025
+ id: "seek",
2026
+ method: "POST",
2027
+ path: "/venues/{venueId}/players/{playerId}/seek",
2028
+ scope: "playback:control",
2029
+ tags: ["playback"],
2030
+ params: [
2031
+ { name: "venueId", in: "path", required: true },
2032
+ { name: "playerId", in: "path", required: true },
2033
+ { name: "Idempotency-Key", in: "header", required: false }
2034
+ ],
2035
+ requestContentTypes: ["application/json"]
2036
+ },
2037
+ sendOsc: {
2038
+ id: "sendOsc",
2039
+ method: "POST",
2040
+ path: "/integrations/osc/send",
2041
+ scope: "gateways:manage",
2042
+ tags: ["gateways"],
2043
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2044
+ requestContentTypes: ["application/json"]
2045
+ },
2046
+ setActiveShow: {
2047
+ id: "setActiveShow",
2048
+ method: "PUT",
2049
+ path: "/venues/{venueId}/active-show",
2050
+ scope: "playback:control",
2051
+ tags: ["playback"],
2052
+ params: [{ name: "venueId", in: "path", required: true }],
2053
+ requestContentTypes: ["application/json"]
2054
+ },
2055
+ setAudioAnalysis: {
2056
+ id: "setAudioAnalysis",
2057
+ method: "PUT",
2058
+ path: "/venues/{venueId}/audio/analysis",
2059
+ scope: "audio:control",
2060
+ tags: ["audio"],
2061
+ params: [{ name: "venueId", in: "path", required: true }],
2062
+ requestContentTypes: ["application/json"]
2063
+ },
2064
+ setComputeBackend: {
2065
+ id: "setComputeBackend",
2066
+ method: "PUT",
2067
+ path: "/engines/visual/backend",
2068
+ scope: "system:admin",
2069
+ tags: ["engines"],
2070
+ params: [],
2071
+ requestContentTypes: ["application/json"]
2072
+ },
2073
+ setDisplayPower: {
2074
+ id: "setDisplayPower",
2075
+ method: "POST",
2076
+ path: "/venues/{venueId}/displays/{displayId}/power",
2077
+ scope: "displays:control",
2078
+ tags: ["displays"],
2079
+ params: [
2080
+ { name: "venueId", in: "path", required: true },
2081
+ { name: "displayId", in: "path", required: true },
2082
+ { name: "Idempotency-Key", in: "header", required: false }
2083
+ ],
2084
+ requestContentTypes: ["application/json"]
2085
+ },
2086
+ setGenerator: {
2087
+ id: "setGenerator",
2088
+ method: "PUT",
2089
+ path: "/venues/{venueId}/audio/generator",
2090
+ scope: "audio:control",
2091
+ tags: ["audio"],
2092
+ params: [{ name: "venueId", in: "path", required: true }],
2093
+ requestContentTypes: ["application/json"]
2094
+ },
2095
+ setParameter: {
2096
+ id: "setParameter",
2097
+ method: "PUT",
2098
+ path: "/venues/{venueId}/parameters/{path}",
2099
+ scope: "playback:control",
2100
+ tags: ["playback"],
2101
+ params: [
2102
+ { name: "venueId", in: "path", required: true },
2103
+ { name: "path", in: "path", required: true }
2104
+ ],
2105
+ requestContentTypes: ["application/json"]
2106
+ },
2107
+ setSourcePosition: {
2108
+ id: "setSourcePosition",
2109
+ method: "PUT",
2110
+ path: "/venues/{venueId}/audio/sources/{sourceId}/position",
2111
+ scope: "audio:control",
2112
+ tags: ["audio"],
2113
+ params: [
2114
+ { name: "venueId", in: "path", required: true },
2115
+ { name: "sourceId", in: "path", required: true }
2116
+ ],
2117
+ requestContentTypes: ["application/json"]
2118
+ },
2119
+ setTestPattern: {
2120
+ id: "setTestPattern",
2121
+ method: "PUT",
2122
+ path: "/venues/{venueId}/displays/{displayId}/pattern",
2123
+ scope: "displays:control",
2124
+ tags: ["displays"],
2125
+ params: [
2126
+ { name: "venueId", in: "path", required: true },
2127
+ { name: "displayId", in: "path", required: true }
2128
+ ],
2129
+ requestContentTypes: ["application/json"]
2130
+ },
2131
+ shutdownSystem: {
2132
+ id: "shutdownSystem",
2133
+ method: "POST",
2134
+ path: "/system/shutdown",
2135
+ scope: "system:admin",
2136
+ tags: ["system"],
2137
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2138
+ requestContentTypes: ["application/json"]
2139
+ },
2140
+ startAudioSession: {
2141
+ id: "startAudioSession",
2142
+ method: "POST",
2143
+ path: "/venues/{venueId}/audio/sessions",
2144
+ scope: "audio:control",
2145
+ tags: ["audio"],
2146
+ params: [
2147
+ { name: "venueId", in: "path", required: true },
2148
+ { name: "Idempotency-Key", in: "header", required: false }
2149
+ ],
2150
+ requestContentTypes: ["application/json"]
2151
+ },
2152
+ startCalibrationJob: {
2153
+ id: "startCalibrationJob",
2154
+ method: "POST",
2155
+ path: "/venues/{venueId}/calibration/jobs",
2156
+ scope: "calibration:run",
2157
+ tags: ["calibration"],
2158
+ params: [
2159
+ { name: "venueId", in: "path", required: true },
2160
+ { name: "Idempotency-Key", in: "header", required: false }
2161
+ ],
2162
+ requestContentTypes: ["application/json"]
2163
+ },
2164
+ startImport: {
2165
+ id: "startImport",
2166
+ method: "POST",
2167
+ path: "/imports",
2168
+ scope: "content:write",
2169
+ tags: ["shows"],
2170
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2171
+ requestContentTypes: ["application/json"]
2172
+ },
2173
+ startScenarioSession: {
2174
+ id: "startScenarioSession",
2175
+ method: "POST",
2176
+ path: "/venues/{venueId}/scenario-sessions",
2177
+ scope: "playback:control",
2178
+ tags: ["scenarios"],
2179
+ params: [
2180
+ { name: "venueId", in: "path", required: true },
2181
+ { name: "Idempotency-Key", in: "header", required: false }
2182
+ ],
2183
+ requestContentTypes: ["application/json"]
2184
+ },
2185
+ startUpdate: {
2186
+ id: "startUpdate",
2187
+ method: "POST",
2188
+ path: "/system/update",
2189
+ scope: "system:admin",
2190
+ tags: ["system"],
2191
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2192
+ requestContentTypes: ["application/json"]
2193
+ },
2194
+ stop: {
2195
+ id: "stop",
2196
+ method: "POST",
2197
+ path: "/venues/{venueId}/players/{playerId}/stop",
2198
+ scope: "playback:control",
2199
+ tags: ["playback"],
2200
+ params: [
2201
+ { name: "venueId", in: "path", required: true },
2202
+ { name: "playerId", in: "path", required: true },
2203
+ { name: "Idempotency-Key", in: "header", required: false }
2204
+ ],
2205
+ requestContentTypes: []
2206
+ },
2207
+ stopAudioSession: {
2208
+ id: "stopAudioSession",
2209
+ method: "DELETE",
2210
+ path: "/venues/{venueId}/audio/sessions/{sessionId}",
2211
+ scope: "audio:control",
2212
+ tags: ["audio"],
2213
+ params: [
2214
+ { name: "venueId", in: "path", required: true },
2215
+ { name: "sessionId", in: "path", required: true }
2216
+ ],
2217
+ requestContentTypes: []
2218
+ },
2219
+ stopGenerator: {
2220
+ id: "stopGenerator",
2221
+ method: "DELETE",
2222
+ path: "/venues/{venueId}/audio/generator",
2223
+ scope: "audio:control",
2224
+ tags: ["audio"],
2225
+ params: [{ name: "venueId", in: "path", required: true }],
2226
+ requestContentTypes: []
2227
+ },
2228
+ stopScenarioSession: {
2229
+ id: "stopScenarioSession",
2230
+ method: "POST",
2231
+ path: "/venues/{venueId}/scenario-sessions/{sessionId}/stop",
2232
+ scope: "playback:control",
2233
+ tags: ["scenarios"],
2234
+ params: [
2235
+ { name: "venueId", in: "path", required: true },
2236
+ { name: "sessionId", in: "path", required: true },
2237
+ { name: "Idempotency-Key", in: "header", required: false }
2238
+ ],
2239
+ requestContentTypes: []
2240
+ },
2241
+ submitCalibrationCapture: {
2242
+ id: "submitCalibrationCapture",
2243
+ method: "POST",
2244
+ path: "/venues/{venueId}/calibration/jobs/{jobId}/captures",
2245
+ scope: "calibration:run",
2246
+ tags: ["calibration"],
2247
+ params: [
2248
+ { name: "venueId", in: "path", required: true },
2249
+ { name: "jobId", in: "path", required: true },
2250
+ { name: "Idempotency-Key", in: "header", required: false }
2251
+ ],
2252
+ requestContentTypes: ["application/json", "multipart/form-data"]
2253
+ },
2254
+ testAudioDevice: {
2255
+ id: "testAudioDevice",
2256
+ method: "POST",
2257
+ path: "/venues/{venueId}/audio/devices/{deviceId}/test",
2258
+ scope: "audio:control",
2259
+ tags: ["audio"],
2260
+ params: [
2261
+ { name: "venueId", in: "path", required: true },
2262
+ { name: "deviceId", in: "path", required: true },
2263
+ { name: "Idempotency-Key", in: "header", required: false }
2264
+ ],
2265
+ requestContentTypes: ["application/json"]
2266
+ },
2267
+ testGateway: {
2268
+ id: "testGateway",
2269
+ method: "POST",
2270
+ path: "/gateways/{gatewayId}/test",
2271
+ scope: "gateways:manage",
2272
+ tags: ["gateways"],
2273
+ params: [
2274
+ { name: "gatewayId", in: "path", required: true },
2275
+ { name: "Idempotency-Key", in: "header", required: false }
2276
+ ],
2277
+ requestContentTypes: []
2278
+ },
2279
+ unpairDevice: {
2280
+ id: "unpairDevice",
2281
+ method: "POST",
2282
+ path: "/devices/{deviceId}/unpair",
2283
+ scope: "venues:write",
2284
+ tags: ["devices"],
2285
+ params: [
2286
+ { name: "deviceId", in: "path", required: true },
2287
+ { name: "Idempotency-Key", in: "header", required: false }
2288
+ ],
2289
+ requestContentTypes: []
2290
+ },
2291
+ unregisterClient: {
2292
+ id: "unregisterClient",
2293
+ method: "DELETE",
2294
+ path: "/clients/{clientId}",
2295
+ scope: "any",
2296
+ tags: ["clients"],
2297
+ params: [{ name: "clientId", in: "path", required: true }],
2298
+ requestContentTypes: []
2299
+ }
2300
+ };
2301
+
2302
+ // src/generated/cloud-operations.ts
2303
+ var CloudOperations = {
2304
+ acceptInvitation: {
2305
+ id: "acceptInvitation",
2306
+ method: "POST",
2307
+ path: "/invitations/accept",
2308
+ scope: "any",
2309
+ tags: ["orgs"],
2310
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2311
+ requestContentTypes: ["application/json"]
2312
+ },
2313
+ approveEnrollmentRequest: {
2314
+ id: "approveEnrollmentRequest",
2315
+ method: "POST",
2316
+ path: "/installations/enroll-requests/{userCode}/approve",
2317
+ scope: "registry:write",
2318
+ tags: ["enrollment"],
2319
+ params: [
2320
+ { name: "userCode", in: "path", required: true },
2321
+ { name: "Idempotency-Key", in: "header", required: false }
2322
+ ],
2323
+ requestContentTypes: ["application/json"]
2324
+ },
2325
+ cancelAccountDeletion: {
2326
+ id: "cancelAccountDeletion",
2327
+ method: "POST",
2328
+ path: "/me/deletion/cancel",
2329
+ scope: "any",
2330
+ tags: ["account"],
2331
+ params: [],
2332
+ requestContentTypes: []
2333
+ },
2334
+ changePassword: {
2335
+ id: "changePassword",
2336
+ method: "POST",
2337
+ path: "/auth/password/change",
2338
+ scope: "any",
2339
+ tags: ["auth"],
2340
+ params: [],
2341
+ requestContentTypes: ["application/json"]
2342
+ },
2343
+ createAccountApiKey: {
2344
+ id: "createAccountApiKey",
2345
+ method: "POST",
2346
+ path: "/me/api-keys",
2347
+ scope: "any",
2348
+ tags: ["api-keys"],
2349
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2350
+ requestContentTypes: ["application/json"]
2351
+ },
2352
+ createEnrollmentRequest: {
2353
+ id: "createEnrollmentRequest",
2354
+ method: "POST",
2355
+ path: "/installations/enroll-requests",
2356
+ scope: "anon",
2357
+ tags: ["enrollment"],
2358
+ params: [],
2359
+ requestContentTypes: ["application/json"]
2360
+ },
2361
+ createEnrollmentToken: {
2362
+ id: "createEnrollmentToken",
2363
+ method: "POST",
2364
+ path: "/orgs/{orgId}/enrollment-tokens",
2365
+ scope: "registry:write",
2366
+ tags: ["registry"],
2367
+ params: [
2368
+ { name: "orgId", in: "path", required: true },
2369
+ { name: "Idempotency-Key", in: "header", required: false }
2370
+ ],
2371
+ requestContentTypes: ["application/json"]
2372
+ },
2373
+ createOrg: {
2374
+ id: "createOrg",
2375
+ method: "POST",
2376
+ path: "/orgs",
2377
+ scope: "any",
2378
+ tags: ["orgs"],
2379
+ params: [{ name: "Idempotency-Key", in: "header", required: false }],
2380
+ requestContentTypes: ["application/json"]
2381
+ },
2382
+ createOrgApiKey: {
2383
+ id: "createOrgApiKey",
2384
+ method: "POST",
2385
+ path: "/orgs/{orgId}/api-keys",
2386
+ scope: "keys:write",
2387
+ tags: ["api-keys"],
2388
+ params: [
2389
+ { name: "orgId", in: "path", required: true },
2390
+ { name: "Idempotency-Key", in: "header", required: false }
2391
+ ],
2392
+ requestContentTypes: ["application/json"]
2393
+ },
2394
+ createOrgDome: {
2395
+ id: "createOrgDome",
2396
+ method: "POST",
2397
+ path: "/orgs/{orgId}/venues/{venueId}/domes",
2398
+ scope: "registry:write",
2399
+ tags: ["registry"],
2400
+ params: [
2401
+ { name: "orgId", in: "path", required: true },
2402
+ { name: "venueId", in: "path", required: true },
2403
+ { name: "Idempotency-Key", in: "header", required: false }
2404
+ ],
2405
+ requestContentTypes: ["application/json"]
2406
+ },
2407
+ createOrgInvitation: {
2408
+ id: "createOrgInvitation",
2409
+ method: "POST",
2410
+ path: "/orgs/{orgId}/invitations",
2411
+ scope: "members:write",
2412
+ tags: ["orgs"],
2413
+ params: [
2414
+ { name: "orgId", in: "path", required: true },
2415
+ { name: "Idempotency-Key", in: "header", required: false }
2416
+ ],
2417
+ requestContentTypes: ["application/json"]
2418
+ },
2419
+ createOrgVenue: {
2420
+ id: "createOrgVenue",
2421
+ method: "POST",
2422
+ path: "/orgs/{orgId}/venues",
2423
+ scope: "registry:write",
2424
+ tags: ["registry"],
2425
+ params: [
2426
+ { name: "orgId", in: "path", required: true },
2427
+ { name: "Idempotency-Key", in: "header", required: false }
2428
+ ],
2429
+ requestContentTypes: ["application/json"]
2430
+ },
2431
+ createSession: {
2432
+ id: "createSession",
2433
+ method: "POST",
2434
+ path: "/auth/session",
2435
+ scope: "anon",
2436
+ tags: ["auth"],
2437
+ params: [],
2438
+ requestContentTypes: ["application/json"]
2439
+ },
2440
+ deleteAccount: {
2441
+ id: "deleteAccount",
2442
+ method: "DELETE",
2443
+ path: "/me",
2444
+ scope: "any",
2445
+ tags: ["account"],
2446
+ params: [],
2447
+ requestContentTypes: []
2448
+ },
2449
+ deleteAccountApiKey: {
2450
+ id: "deleteAccountApiKey",
2451
+ method: "DELETE",
2452
+ path: "/me/api-keys/{keyId}",
2453
+ scope: "any",
2454
+ tags: ["api-keys"],
2455
+ params: [{ name: "keyId", in: "path", required: true }],
2456
+ requestContentTypes: []
2457
+ },
2458
+ deleteAccountDevice: {
2459
+ id: "deleteAccountDevice",
2460
+ method: "DELETE",
2461
+ path: "/me/devices/{sessionId}",
2462
+ scope: "any",
2463
+ tags: ["account"],
2464
+ params: [{ name: "sessionId", in: "path", required: true }],
2465
+ requestContentTypes: []
2466
+ },
2467
+ deleteOrg: {
2468
+ id: "deleteOrg",
2469
+ method: "DELETE",
2470
+ path: "/orgs/{orgId}",
2471
+ scope: "org:owner",
2472
+ tags: ["orgs"],
2473
+ params: [{ name: "orgId", in: "path", required: true }],
2474
+ requestContentTypes: []
2475
+ },
2476
+ deleteOrgApiKey: {
2477
+ id: "deleteOrgApiKey",
2478
+ method: "DELETE",
2479
+ path: "/orgs/{orgId}/api-keys/{keyId}",
2480
+ scope: "keys:write",
2481
+ tags: ["api-keys"],
2482
+ params: [
2483
+ { name: "orgId", in: "path", required: true },
2484
+ { name: "keyId", in: "path", required: true }
2485
+ ],
2486
+ requestContentTypes: []
2487
+ },
2488
+ deleteOrgDome: {
2489
+ id: "deleteOrgDome",
2490
+ method: "DELETE",
2491
+ path: "/orgs/{orgId}/domes/{domeId}",
2492
+ scope: "registry:write",
2493
+ tags: ["registry"],
2494
+ params: [
2495
+ { name: "orgId", in: "path", required: true },
2496
+ { name: "domeId", in: "path", required: true }
2497
+ ],
2498
+ requestContentTypes: []
2499
+ },
2500
+ deleteOrgVenue: {
2501
+ id: "deleteOrgVenue",
2502
+ method: "DELETE",
2503
+ path: "/orgs/{orgId}/venues/{venueId}",
2504
+ scope: "registry:write",
2505
+ tags: ["registry"],
2506
+ params: [
2507
+ { name: "orgId", in: "path", required: true },
2508
+ { name: "venueId", in: "path", required: true }
2509
+ ],
2510
+ requestContentTypes: []
2511
+ },
2512
+ deleteSession: {
2513
+ id: "deleteSession",
2514
+ method: "DELETE",
2515
+ path: "/auth/session",
2516
+ scope: "any",
2517
+ tags: ["auth"],
2518
+ params: [],
2519
+ requestContentTypes: []
2520
+ },
2521
+ denyEnrollmentRequest: {
2522
+ id: "denyEnrollmentRequest",
2523
+ method: "POST",
2524
+ path: "/installations/enroll-requests/{userCode}/deny",
2525
+ scope: "registry:write",
2526
+ tags: ["enrollment"],
2527
+ params: [
2528
+ { name: "userCode", in: "path", required: true },
2529
+ { name: "Idempotency-Key", in: "header", required: false }
2530
+ ],
2531
+ requestContentTypes: ["application/json"]
2532
+ },
2533
+ enrollWithToken: {
2534
+ id: "enrollWithToken",
2535
+ method: "POST",
2536
+ path: "/installations/enroll",
2537
+ scope: "anon",
2538
+ tags: ["enrollment"],
2539
+ params: [],
2540
+ requestContentTypes: ["application/json"]
2541
+ },
2542
+ forgotPassword: {
2543
+ id: "forgotPassword",
2544
+ method: "POST",
2545
+ path: "/auth/password/forgot",
2546
+ scope: "anon",
2547
+ tags: ["auth"],
2548
+ params: [],
2549
+ requestContentTypes: ["application/json"]
2550
+ },
2551
+ getAccount: {
2552
+ id: "getAccount",
2553
+ method: "GET",
2554
+ path: "/me",
2555
+ scope: "any",
2556
+ tags: ["account"],
2557
+ params: [],
2558
+ requestContentTypes: []
2559
+ },
2560
+ getCatalogueItem: {
2561
+ id: "getCatalogueItem",
2562
+ method: "GET",
2563
+ path: "/catalogue/items/{itemId}",
2564
+ scope: "catalogue:read",
2565
+ tags: ["catalogue"],
2566
+ params: [{ name: "itemId", in: "path", required: true }],
2567
+ requestContentTypes: []
2568
+ },
2569
+ getEnrollmentRequest: {
2570
+ id: "getEnrollmentRequest",
2571
+ method: "GET",
2572
+ path: "/installations/enroll-requests/{userCode}",
2573
+ scope: "any",
2574
+ tags: ["enrollment"],
2575
+ params: [{ name: "userCode", in: "path", required: true }],
2576
+ requestContentTypes: []
2577
+ },
2578
+ getInfo: {
2579
+ id: "getInfo",
2580
+ method: "GET",
2581
+ path: "/info",
2582
+ scope: "anon",
2583
+ tags: ["discovery"],
2584
+ params: [],
2585
+ requestContentTypes: []
2586
+ },
2587
+ getJwks: {
2588
+ id: "getJwks",
2589
+ method: "GET",
2590
+ path: "/.well-known/jwks.json",
2591
+ scope: "anon",
2592
+ tags: ["discovery"],
2593
+ params: [],
2594
+ requestContentTypes: []
2595
+ },
2596
+ getMeta: {
2597
+ id: "getMeta",
2598
+ method: "GET",
2599
+ path: "/meta",
2600
+ scope: "anon",
2601
+ tags: ["discovery"],
2602
+ params: [],
2603
+ requestContentTypes: []
2604
+ },
2605
+ getOrg: {
2606
+ id: "getOrg",
2607
+ method: "GET",
2608
+ path: "/orgs/{orgId}",
2609
+ scope: "org:read",
2610
+ tags: ["orgs"],
2611
+ params: [{ name: "orgId", in: "path", required: true }],
2612
+ requestContentTypes: []
2613
+ },
2614
+ getOrgDome: {
2615
+ id: "getOrgDome",
2616
+ method: "GET",
2617
+ path: "/orgs/{orgId}/domes/{domeId}",
2618
+ scope: "registry:read",
2619
+ tags: ["registry"],
2620
+ params: [
2621
+ { name: "orgId", in: "path", required: true },
2622
+ { name: "domeId", in: "path", required: true }
2623
+ ],
2624
+ requestContentTypes: []
2625
+ },
2626
+ getOrgVenue: {
2627
+ id: "getOrgVenue",
2628
+ method: "GET",
2629
+ path: "/orgs/{orgId}/venues/{venueId}",
2630
+ scope: "registry:read",
2631
+ tags: ["registry"],
2632
+ params: [
2633
+ { name: "orgId", in: "path", required: true },
2634
+ { name: "venueId", in: "path", required: true }
2635
+ ],
2636
+ requestContentTypes: []
2637
+ },
2638
+ getOwnInstallation: {
2639
+ id: "getOwnInstallation",
2640
+ method: "GET",
2641
+ path: "/installations/self",
2642
+ scope: "registry:self",
2643
+ tags: ["enrollment"],
2644
+ params: [],
2645
+ requestContentTypes: []
2646
+ },
2647
+ listAccountApiKeys: {
2648
+ id: "listAccountApiKeys",
2649
+ method: "GET",
2650
+ path: "/me/api-keys",
2651
+ scope: "any",
2652
+ tags: ["api-keys"],
2653
+ params: [
2654
+ { name: "limit", in: "query", required: false },
2655
+ { name: "cursor", in: "query", required: false }
2656
+ ],
2657
+ requestContentTypes: []
2658
+ },
2659
+ listAccountDevices: {
2660
+ id: "listAccountDevices",
2661
+ method: "GET",
2662
+ path: "/me/devices",
2663
+ scope: "any",
2664
+ tags: ["account"],
2665
+ params: [
2666
+ { name: "limit", in: "query", required: false },
2667
+ { name: "cursor", in: "query", required: false }
2668
+ ],
2669
+ requestContentTypes: []
2670
+ },
2671
+ listApps: {
2672
+ id: "listApps",
2673
+ method: "GET",
2674
+ path: "/apps",
2675
+ scope: "anon",
2676
+ tags: ["apps"],
2677
+ params: [
2678
+ { name: "limit", in: "query", required: false },
2679
+ { name: "cursor", in: "query", required: false }
2680
+ ],
2681
+ requestContentTypes: []
2682
+ },
2683
+ listCatalogueItems: {
2684
+ id: "listCatalogueItems",
2685
+ method: "GET",
2686
+ path: "/catalogue/items",
2687
+ scope: "catalogue:read",
2688
+ tags: ["catalogue"],
2689
+ params: [
2690
+ { name: "limit", in: "query", required: false },
2691
+ { name: "cursor", in: "query", required: false }
2692
+ ],
2693
+ requestContentTypes: []
2694
+ },
2695
+ listEnrollmentTokens: {
2696
+ id: "listEnrollmentTokens",
2697
+ method: "GET",
2698
+ path: "/orgs/{orgId}/enrollment-tokens",
2699
+ scope: "registry:write",
2700
+ tags: ["registry"],
2701
+ params: [
2702
+ { name: "orgId", in: "path", required: true },
2703
+ { name: "limit", in: "query", required: false },
2704
+ { name: "cursor", in: "query", required: false }
2705
+ ],
2706
+ requestContentTypes: []
2707
+ },
2708
+ listOrgApiKeys: {
2709
+ id: "listOrgApiKeys",
2710
+ method: "GET",
2711
+ path: "/orgs/{orgId}/api-keys",
2712
+ scope: "keys:write",
2713
+ tags: ["api-keys"],
2714
+ params: [
2715
+ { name: "orgId", in: "path", required: true },
2716
+ { name: "limit", in: "query", required: false },
2717
+ { name: "cursor", in: "query", required: false }
2718
+ ],
2719
+ requestContentTypes: []
2720
+ },
2721
+ listOrgInstallations: {
2722
+ id: "listOrgInstallations",
2723
+ method: "GET",
2724
+ path: "/orgs/{orgId}/installations",
2725
+ scope: "registry:read",
2726
+ tags: ["registry"],
2727
+ params: [
2728
+ { name: "orgId", in: "path", required: true },
2729
+ { name: "limit", in: "query", required: false },
2730
+ { name: "cursor", in: "query", required: false }
2731
+ ],
2732
+ requestContentTypes: []
2733
+ },
2734
+ listOrgInvitations: {
2735
+ id: "listOrgInvitations",
2736
+ method: "GET",
2737
+ path: "/orgs/{orgId}/invitations",
2738
+ scope: "members:write",
2739
+ tags: ["orgs"],
2740
+ params: [
2741
+ { name: "orgId", in: "path", required: true },
2742
+ { name: "limit", in: "query", required: false },
2743
+ { name: "cursor", in: "query", required: false }
2744
+ ],
2745
+ requestContentTypes: []
2746
+ },
2747
+ listOrgMembers: {
2748
+ id: "listOrgMembers",
2749
+ method: "GET",
2750
+ path: "/orgs/{orgId}/members",
2751
+ scope: "org:read",
2752
+ tags: ["orgs"],
2753
+ params: [
2754
+ { name: "orgId", in: "path", required: true },
2755
+ { name: "limit", in: "query", required: false },
2756
+ { name: "cursor", in: "query", required: false }
2757
+ ],
2758
+ requestContentTypes: []
2759
+ },
2760
+ listOrgVenues: {
2761
+ id: "listOrgVenues",
2762
+ method: "GET",
2763
+ path: "/orgs/{orgId}/venues",
2764
+ scope: "registry:read",
2765
+ tags: ["registry"],
2766
+ params: [
2767
+ { name: "orgId", in: "path", required: true },
2768
+ { name: "limit", in: "query", required: false },
2769
+ { name: "cursor", in: "query", required: false }
2770
+ ],
2771
+ requestContentTypes: []
2772
+ },
2773
+ listOrgs: {
2774
+ id: "listOrgs",
2775
+ method: "GET",
2776
+ path: "/orgs",
2777
+ scope: "any",
2778
+ tags: ["orgs"],
2779
+ params: [
2780
+ { name: "limit", in: "query", required: false },
2781
+ { name: "cursor", in: "query", required: false }
2782
+ ],
2783
+ requestContentTypes: []
2784
+ },
2785
+ patchAccount: {
2786
+ id: "patchAccount",
2787
+ method: "PATCH",
2788
+ path: "/me",
2789
+ scope: "any",
2790
+ tags: ["account"],
2791
+ params: [],
2792
+ requestContentTypes: ["application/merge-patch+json"]
2793
+ },
2794
+ patchOrg: {
2795
+ id: "patchOrg",
2796
+ method: "PATCH",
2797
+ path: "/orgs/{orgId}",
2798
+ scope: "org:write",
2799
+ tags: ["orgs"],
2800
+ params: [{ name: "orgId", in: "path", required: true }],
2801
+ requestContentTypes: ["application/merge-patch+json"]
2802
+ },
2803
+ patchOrgDome: {
2804
+ id: "patchOrgDome",
2805
+ method: "PATCH",
2806
+ path: "/orgs/{orgId}/domes/{domeId}",
2807
+ scope: "registry:write",
2808
+ tags: ["registry"],
2809
+ params: [
2810
+ { name: "orgId", in: "path", required: true },
2811
+ { name: "domeId", in: "path", required: true }
2812
+ ],
2813
+ requestContentTypes: ["application/merge-patch+json"]
2814
+ },
2815
+ patchOrgInstallation: {
2816
+ id: "patchOrgInstallation",
2817
+ method: "PATCH",
2818
+ path: "/orgs/{orgId}/installations/{installationId}",
2819
+ scope: "registry:write",
2820
+ tags: ["registry"],
2821
+ params: [
2822
+ { name: "orgId", in: "path", required: true },
2823
+ { name: "installationId", in: "path", required: true }
2824
+ ],
2825
+ requestContentTypes: ["application/merge-patch+json"]
2826
+ },
2827
+ patchOrgMember: {
2828
+ id: "patchOrgMember",
2829
+ method: "PATCH",
2830
+ path: "/orgs/{orgId}/members/{userId}",
2831
+ scope: "members:write",
2832
+ tags: ["orgs"],
2833
+ params: [
2834
+ { name: "orgId", in: "path", required: true },
2835
+ { name: "userId", in: "path", required: true }
2836
+ ],
2837
+ requestContentTypes: ["application/merge-patch+json"]
2838
+ },
2839
+ patchOrgVenue: {
2840
+ id: "patchOrgVenue",
2841
+ method: "PATCH",
2842
+ path: "/orgs/{orgId}/venues/{venueId}",
2843
+ scope: "registry:write",
2844
+ tags: ["registry"],
2845
+ params: [
2846
+ { name: "orgId", in: "path", required: true },
2847
+ { name: "venueId", in: "path", required: true }
2848
+ ],
2849
+ requestContentTypes: ["application/merge-patch+json"]
2850
+ },
2851
+ pollEnrollment: {
2852
+ id: "pollEnrollment",
2853
+ method: "POST",
2854
+ path: "/installations/enroll-requests/token",
2855
+ scope: "anon",
2856
+ tags: ["enrollment"],
2857
+ params: [],
2858
+ requestContentTypes: ["application/json"]
2859
+ },
2860
+ refreshSession: {
2861
+ id: "refreshSession",
2862
+ method: "POST",
2863
+ path: "/auth/refresh",
2864
+ scope: "anon",
2865
+ tags: ["auth"],
2866
+ params: [],
2867
+ requestContentTypes: ["application/json"]
2868
+ },
2869
+ removeOrgMember: {
2870
+ id: "removeOrgMember",
2871
+ method: "DELETE",
2872
+ path: "/orgs/{orgId}/members/{userId}",
2873
+ scope: "members:write",
2874
+ tags: ["orgs"],
2875
+ params: [
2876
+ { name: "orgId", in: "path", required: true },
2877
+ { name: "userId", in: "path", required: true }
2878
+ ],
2879
+ requestContentTypes: []
2880
+ },
2881
+ requestMagicLink: {
2882
+ id: "requestMagicLink",
2883
+ method: "POST",
2884
+ path: "/auth/magic-link",
2885
+ scope: "anon",
2886
+ tags: ["auth"],
2887
+ params: [],
2888
+ requestContentTypes: ["application/json"]
2889
+ },
2890
+ resendEmailVerification: {
2891
+ id: "resendEmailVerification",
2892
+ method: "POST",
2893
+ path: "/auth/email/verify/resend",
2894
+ scope: "any",
2895
+ tags: ["auth"],
2896
+ params: [],
2897
+ requestContentTypes: []
2898
+ },
2899
+ resetPassword: {
2900
+ id: "resetPassword",
2901
+ method: "POST",
2902
+ path: "/auth/password/reset",
2903
+ scope: "anon",
2904
+ tags: ["auth"],
2905
+ params: [],
2906
+ requestContentTypes: ["application/json"]
2907
+ },
2908
+ revokeEnrollmentToken: {
2909
+ id: "revokeEnrollmentToken",
2910
+ method: "DELETE",
2911
+ path: "/orgs/{orgId}/enrollment-tokens/{tokenId}",
2912
+ scope: "registry:write",
2913
+ tags: ["registry"],
2914
+ params: [
2915
+ { name: "orgId", in: "path", required: true },
2916
+ { name: "tokenId", in: "path", required: true }
2917
+ ],
2918
+ requestContentTypes: []
2919
+ },
2920
+ revokeOrgInstallation: {
2921
+ id: "revokeOrgInstallation",
2922
+ method: "DELETE",
2923
+ path: "/orgs/{orgId}/installations/{installationId}",
2924
+ scope: "registry:write",
2925
+ tags: ["registry"],
2926
+ params: [
2927
+ { name: "orgId", in: "path", required: true },
2928
+ { name: "installationId", in: "path", required: true }
2929
+ ],
2930
+ requestContentTypes: []
2931
+ },
2932
+ revokeOrgInvitation: {
2933
+ id: "revokeOrgInvitation",
2934
+ method: "DELETE",
2935
+ path: "/orgs/{orgId}/invitations/{invitationId}",
2936
+ scope: "members:write",
2937
+ tags: ["orgs"],
2938
+ params: [
2939
+ { name: "orgId", in: "path", required: true },
2940
+ { name: "invitationId", in: "path", required: true }
2941
+ ],
2942
+ requestContentTypes: []
2943
+ },
2944
+ signIn: {
2945
+ id: "signIn",
2946
+ method: "POST",
2947
+ path: "/auth/sign-in",
2948
+ scope: "anon",
2949
+ tags: ["auth"],
2950
+ params: [],
2951
+ requestContentTypes: ["application/json"]
2952
+ },
2953
+ signInWithProvider: {
2954
+ id: "signInWithProvider",
2955
+ method: "POST",
2956
+ path: "/auth/oauth/{provider}",
2957
+ scope: "anon",
2958
+ tags: ["auth"],
2959
+ params: [{ name: "provider", in: "path", required: true }],
2960
+ requestContentTypes: ["application/json"]
2961
+ },
2962
+ signOut: {
2963
+ id: "signOut",
2964
+ method: "POST",
2965
+ path: "/auth/sign-out",
2966
+ scope: "any",
2967
+ tags: ["auth"],
2968
+ params: [],
2969
+ requestContentTypes: []
2970
+ },
2971
+ signOutAll: {
2972
+ id: "signOutAll",
2973
+ method: "POST",
2974
+ path: "/auth/sign-out-all",
2975
+ scope: "any",
2976
+ tags: ["auth"],
2977
+ params: [],
2978
+ requestContentTypes: []
2979
+ },
2980
+ signUp: {
2981
+ id: "signUp",
2982
+ method: "POST",
2983
+ path: "/auth/sign-up",
2984
+ scope: "anon",
2985
+ tags: ["auth"],
2986
+ params: [],
2987
+ requestContentTypes: ["application/json"]
2988
+ },
2989
+ verifyEmail: {
2990
+ id: "verifyEmail",
2991
+ method: "POST",
2992
+ path: "/auth/email/verify",
2993
+ scope: "anon",
2994
+ tags: ["auth"],
2995
+ params: [],
2996
+ requestContentTypes: ["application/json"]
2997
+ },
2998
+ verifyMagicLink: {
2999
+ id: "verifyMagicLink",
3000
+ method: "POST",
3001
+ path: "/auth/magic-link/verify",
3002
+ scope: "anon",
3003
+ tags: ["auth"],
3004
+ params: [],
3005
+ requestContentTypes: ["application/json"]
3006
+ }
3007
+ };
3008
+
3009
+ // src/generated/topics.ts
3010
+ var TopicTable = [
3011
+ { topic: "system/info", kinds: ["system.info"], scope: "info:read", class: "S", rate: "on change" },
3012
+ { topic: "system/health", kinds: ["system.health"], scope: "info:read", class: "S", rate: "on change (\u2264 1 Hz)" },
3013
+ {
3014
+ topic: "system/logs",
3015
+ kinds: ["log.entry"],
3016
+ scope: "system:read",
3017
+ class: "T",
3018
+ rate: "warn+ by default, level filter in subscribe options; throttled"
3019
+ },
3020
+ {
3021
+ topic: "nodes/{nodeId}",
3022
+ kinds: ["node.state"],
3023
+ scope: "info:read",
3024
+ class: "S",
3025
+ rate: "on change; clock offset \u2264 1 Hz (patch)"
3026
+ },
3027
+ {
3028
+ topic: "engines/{name}",
3029
+ kinds: ["engine.status", "engine.metrics", "engine.error"],
3030
+ scope: "info:read",
3031
+ class: "S",
3032
+ rate: "engine.metrics \u2264 1 Hz (patch); others on change"
3033
+ },
3034
+ {
3035
+ topic: "venues/{venueId}",
3036
+ kinds: ["venue.updated", "venue.deleted", "venue.activeShow"],
3037
+ scope: "info:read",
3038
+ class: "S",
3039
+ rate: "on change"
3040
+ },
3041
+ {
3042
+ topic: "venues/{venueId}/output",
3043
+ kinds: ["output.state"],
3044
+ scope: "playback:read",
3045
+ class: "S",
3046
+ rate: "on change (latest-value coalescing on slow links)"
3047
+ },
3048
+ {
3049
+ topic: "venues/{venueId}/players/{playerId}",
3050
+ kinds: ["player.state", "player.position", "player.ended", "player.error"],
3051
+ scope: "playback:read",
3052
+ class: "S",
3053
+ rate: "player.position default 4 Hz, max 30 Hz (T-class patch); others on change"
3054
+ },
3055
+ {
3056
+ topic: "venues/{venueId}/cues",
3057
+ kinds: ["cue.fired", "cue.failed"],
3058
+ scope: "playback:read",
3059
+ class: "E",
3060
+ rate: "per cue"
3061
+ },
3062
+ {
3063
+ topic: "venues/{venueId}/parameters",
3064
+ kinds: ["parameter.changed"],
3065
+ scope: "playback:read",
3066
+ class: "S",
3067
+ rate: "on change, throttled to 30 Hz per parameter"
3068
+ },
3069
+ {
3070
+ topic: "venues/{venueId}/displays/{displayId}",
3071
+ kinds: ["display.state", "display.pattern", "display.error"],
3072
+ scope: "info:read",
3073
+ class: "S",
3074
+ rate: "on change; display.state temperature \u2264 0.2 Hz"
3075
+ },
3076
+ {
3077
+ topic: "venues/{venueId}/calibration",
3078
+ kinds: ["calibration.updated"],
3079
+ scope: "info:read",
3080
+ class: "S",
3081
+ rate: "on change"
3082
+ },
3083
+ {
3084
+ topic: "venues/{venueId}/calibration/jobs/{jobId}",
3085
+ kinds: ["calibrationJob.state", "calibrationJob.progress", "calibrationJob.awaiting"],
3086
+ scope: "info:read",
3087
+ class: "S",
3088
+ rate: "progress \u2264 4 Hz (patch)"
3089
+ },
3090
+ { topic: "venues/{venueId}/audio", kinds: ["audio.state"], scope: "playback:read", class: "S", rate: "on change" },
3091
+ {
3092
+ topic: "venues/{venueId}/audio/layout",
3093
+ kinds: ["audio.layout"],
3094
+ scope: "info:read",
3095
+ class: "S",
3096
+ rate: "on change"
3097
+ },
3098
+ {
3099
+ topic: "venues/{venueId}/audio/levels",
3100
+ kinds: ["audio.levels"],
3101
+ scope: "playback:read",
3102
+ class: "T",
3103
+ rate: "\u2264 10 Hz meters"
3104
+ },
3105
+ {
3106
+ topic: "venues/{venueId}/audio/analysis",
3107
+ kinds: ["audioAnalysis.state"],
3108
+ scope: "playback:read",
3109
+ class: "S",
3110
+ rate: "on change"
3111
+ },
3112
+ {
3113
+ topic: "venues/{venueId}/audio/analysis/{inputId}",
3114
+ kinds: ["audio.analysis"],
3115
+ scope: "playback:read",
3116
+ class: "T",
3117
+ rate: "default 15 Hz, max 60 Hz per subscription option analysisHz; monitoring only, not kept in the ring buffer (the live path is L2)"
3118
+ },
3119
+ {
3120
+ topic: "venues/{venueId}/audio/onsets/{inputId}",
3121
+ kinds: ["audio.onset"],
3122
+ scope: "playback:read",
3123
+ class: "E",
3124
+ rate: "per attack, limited by the input's refractoryMs"
3125
+ },
3126
+ {
3127
+ topic: "venues/{venueId}/audio/reactive",
3128
+ kinds: ["audioReactive.state"],
3129
+ scope: "playback:read",
3130
+ class: "S",
3131
+ rate: "on change, including the Resolume connection; stats \u2264 1 Hz (patch)"
3132
+ },
3133
+ {
3134
+ topic: "venues/{venueId}/audio/reactive/scenes",
3135
+ kinds: ["audioReactiveScene.updated", "audioReactiveScene.deleted"],
3136
+ scope: "content:read",
3137
+ class: "E",
3138
+ rate: "per edit"
3139
+ },
3140
+ {
3141
+ topic: "venues/{venueId}/audio/zones/{zoneId}",
3142
+ kinds: ["zone.state", "zone.deleted"],
3143
+ scope: "playback:read",
3144
+ class: "S",
3145
+ rate: "on change"
3146
+ },
3147
+ {
3148
+ topic: "venues/{venueId}/audio/devices/{deviceId}",
3149
+ kinds: ["audioDevice.state"],
3150
+ scope: "playback:read",
3151
+ class: "S",
3152
+ rate: "on change; telemetry \u2264 1 Hz (patch)"
3153
+ },
3154
+ {
3155
+ topic: "venues/{venueId}/audio/sessions/{sessionId}",
3156
+ kinds: ["audioSession.state"],
3157
+ scope: "playback:read",
3158
+ class: "S",
3159
+ rate: "on change; position \u2264 1 Hz (patch)"
3160
+ },
3161
+ {
3162
+ topic: "venues/{venueId}/audio/generator",
3163
+ kinds: ["generator.state"],
3164
+ scope: "playback:read",
3165
+ class: "S",
3166
+ rate: "on change"
3167
+ },
3168
+ {
3169
+ topic: "venues/{venueId}/texture-sources/{sourceId}",
3170
+ kinds: ["textureSource.state"],
3171
+ scope: "playback:read",
3172
+ class: "S",
3173
+ rate: "on change; fps \u2264 1 Hz (patch)"
3174
+ },
3175
+ {
3176
+ topic: "venues/{venueId}/scenarios/{sessionId}",
3177
+ kinds: ["scenarioSession.state", "scenarioSession.log"],
3178
+ scope: "playback:read",
3179
+ class: "S",
3180
+ rate: "state on change (S); log lines E-class"
3181
+ },
3182
+ {
3183
+ topic: "shows/{showId}",
3184
+ kinds: [
3185
+ "show.updated",
3186
+ "show.deleted",
3187
+ "playlist.updated",
3188
+ "playlist.deleted",
3189
+ "timeline.updated",
3190
+ "timeline.deleted",
3191
+ "cue.updated",
3192
+ "cue.deleted",
3193
+ "trigger.updated",
3194
+ "trigger.deleted",
3195
+ "matrix.updated"
3196
+ ],
3197
+ scope: "content:read",
3198
+ class: "E",
3199
+ rate: "per edit"
3200
+ },
3201
+ {
3202
+ topic: "assets/{assetId}",
3203
+ kinds: ["asset.created", "asset.progress", "asset.ready", "asset.failed", "asset.deleted"],
3204
+ scope: "content:read",
3205
+ class: "S",
3206
+ rate: "asset.progress \u2264 2 Hz (patch)"
3207
+ },
3208
+ {
3209
+ topic: "uploads/{uploadId}",
3210
+ kinds: ["upload.progress"],
3211
+ scope: "content:write",
3212
+ class: "T",
3213
+ rate: "\u2264 2 Hz (patch); visible to the uploader"
3214
+ },
3215
+ {
3216
+ topic: "jobs/{jobId}",
3217
+ kinds: ["job.state", "job.progress"],
3218
+ scope: "any",
3219
+ class: "S",
3220
+ rate: "progress \u2264 4 Hz (patch); visible to the job owner and system:read"
3221
+ },
3222
+ {
3223
+ topic: "gateways/{gatewayId}",
3224
+ kinds: ["gateway.state", "gateway.message"],
3225
+ scope: "gateways:manage",
3226
+ class: "S",
3227
+ rate: "state on change; gateway.message is a T-class debug trace, off unless enabled for the gateway"
3228
+ },
3229
+ { topic: "apps/{app}", kinds: ["app.payload", "app.cleared"], scope: "info:read", class: "E", rate: "per publish" },
3230
+ {
3231
+ topic: "clients/{clientId}/commands",
3232
+ kinds: ["client.command"],
3233
+ scope: "any",
3234
+ class: "E",
3235
+ rate: "targeted \u2014 only the principal that registered the client may subscribe"
3236
+ },
3237
+ {
3238
+ topic: "devices/{deviceId}",
3239
+ kinds: ["device.state"],
3240
+ scope: "info:read",
3241
+ class: "S",
3242
+ rate: "on change; telemetry \u2264 1 Hz (patch)"
3243
+ },
3244
+ { topic: "auth/sessions", kinds: ["session.revoked"], scope: "any", class: "E", rate: "own principal only" }
3245
+ ];
3246
+ var EventKinds = {
3247
+ appCleared: "app.cleared",
3248
+ appPayload: "app.payload",
3249
+ assetCreated: "asset.created",
3250
+ assetDeleted: "asset.deleted",
3251
+ assetFailed: "asset.failed",
3252
+ assetProgress: "asset.progress",
3253
+ assetReady: "asset.ready",
3254
+ audioAnalysis: "audio.analysis",
3255
+ audioLayout: "audio.layout",
3256
+ audioLevels: "audio.levels",
3257
+ audioOnset: "audio.onset",
3258
+ audioState: "audio.state",
3259
+ audioAnalysisState: "audioAnalysis.state",
3260
+ audioDeviceState: "audioDevice.state",
3261
+ audioReactiveState: "audioReactive.state",
3262
+ audioReactiveSceneDeleted: "audioReactiveScene.deleted",
3263
+ audioReactiveSceneUpdated: "audioReactiveScene.updated",
3264
+ audioSessionState: "audioSession.state",
3265
+ calibrationUpdated: "calibration.updated",
3266
+ calibrationJobAwaiting: "calibrationJob.awaiting",
3267
+ calibrationJobProgress: "calibrationJob.progress",
3268
+ calibrationJobState: "calibrationJob.state",
3269
+ clientCommand: "client.command",
3270
+ cueDeleted: "cue.deleted",
3271
+ cueFailed: "cue.failed",
3272
+ cueFired: "cue.fired",
3273
+ cueUpdated: "cue.updated",
3274
+ deviceState: "device.state",
3275
+ displayError: "display.error",
3276
+ displayPattern: "display.pattern",
3277
+ displayState: "display.state",
3278
+ engineError: "engine.error",
3279
+ engineMetrics: "engine.metrics",
3280
+ engineStatus: "engine.status",
3281
+ gatewayMessage: "gateway.message",
3282
+ gatewayState: "gateway.state",
3283
+ generatorState: "generator.state",
3284
+ jobProgress: "job.progress",
3285
+ jobState: "job.state",
3286
+ logEntry: "log.entry",
3287
+ matrixUpdated: "matrix.updated",
3288
+ nodeState: "node.state",
3289
+ outputState: "output.state",
3290
+ parameterChanged: "parameter.changed",
3291
+ playerEnded: "player.ended",
3292
+ playerError: "player.error",
3293
+ playerPosition: "player.position",
3294
+ playerState: "player.state",
3295
+ playlistDeleted: "playlist.deleted",
3296
+ playlistUpdated: "playlist.updated",
3297
+ scenarioSessionLog: "scenarioSession.log",
3298
+ scenarioSessionState: "scenarioSession.state",
3299
+ sessionRevoked: "session.revoked",
3300
+ showDeleted: "show.deleted",
3301
+ showUpdated: "show.updated",
3302
+ systemHealth: "system.health",
3303
+ systemInfo: "system.info",
3304
+ textureSourceState: "textureSource.state",
3305
+ timelineDeleted: "timeline.deleted",
3306
+ timelineUpdated: "timeline.updated",
3307
+ triggerDeleted: "trigger.deleted",
3308
+ triggerUpdated: "trigger.updated",
3309
+ uploadProgress: "upload.progress",
3310
+ venueActiveShow: "venue.activeShow",
3311
+ venueDeleted: "venue.deleted",
3312
+ venueUpdated: "venue.updated",
3313
+ zoneDeleted: "zone.deleted",
3314
+ zoneState: "zone.state"
3315
+ };
3316
+ var TopicDelivery = {
3317
+ ringBuffer: { events: 1e4, maxAgeSec: 600 },
3318
+ positionHz: { default: 4, max: 30 }
3319
+ };
3320
+
3321
+ // src/generated/scopes.ts
3322
+ var Scopes = {
3323
+ "info:read": "server info, venues, displays, engines, nodes, devices (read)",
3324
+ "events:subscribe": "subscribe to topics / GET /events",
3325
+ "playback:read": "players, output, audio state, parameters (read)",
3326
+ "content:read": "shows, assets, presets, scenarios (read), exports, downloads",
3327
+ "playback:control": "play / pause / seek / output / parameters / cues / scenario sessions",
3328
+ "apps:publish": "ecosystem-app payloads",
3329
+ "content:write": "assets, uploads, imports, shows, presets",
3330
+ "audio:control": "audio mode / gain / zones / devices / sessions / generator / sources",
3331
+ "displays:control": "test patterns, identify, power",
3332
+ "calibration:run": "visual calibration jobs and sidecars",
3333
+ "audio:calibrate": "audio calibration jobs (audio-room, audio-speaker-check)",
3334
+ "venues:write": "venues, displays config, speaker layout, device pairing / binding",
3335
+ "gateways:manage": "gateways, OSC send",
3336
+ "system:read": "system status, logs, config (redacted), diagnostics, clients, jobs of others",
3337
+ "users:manage": "local users, pairing approval",
3338
+ "keys:manage": "API keys",
3339
+ "system:admin": "reboot / shutdown / update / restore / config write / engine restart / backend / scenario enable"
3340
+ };
3341
+ var PseudoScopes = ["anon", "any"];
3342
+ var RoleScopes = {
3343
+ guest: ["info:read", "events:subscribe", "playback:read", "content:read"],
3344
+ operator: [
3345
+ "info:read",
3346
+ "events:subscribe",
3347
+ "playback:read",
3348
+ "content:read",
3349
+ "playback:control",
3350
+ "apps:publish",
3351
+ "content:write",
3352
+ "audio:control",
3353
+ "displays:control"
3354
+ ],
3355
+ admin: [
3356
+ "info:read",
3357
+ "events:subscribe",
3358
+ "playback:read",
3359
+ "content:read",
3360
+ "playback:control",
3361
+ "apps:publish",
3362
+ "content:write",
3363
+ "audio:control",
3364
+ "displays:control",
3365
+ "calibration:run",
3366
+ "audio:calibrate",
3367
+ "venues:write",
3368
+ "gateways:manage",
3369
+ "system:read",
3370
+ "users:manage",
3371
+ "keys:manage"
3372
+ ],
3373
+ superadmin: [
3374
+ "info:read",
3375
+ "events:subscribe",
3376
+ "playback:read",
3377
+ "content:read",
3378
+ "playback:control",
3379
+ "apps:publish",
3380
+ "content:write",
3381
+ "audio:control",
3382
+ "displays:control",
3383
+ "calibration:run",
3384
+ "audio:calibrate",
3385
+ "venues:write",
3386
+ "gateways:manage",
3387
+ "system:read",
3388
+ "users:manage",
3389
+ "keys:manage",
3390
+ "system:admin"
3391
+ ]
3392
+ };
3393
+
3394
+ // src/generated/problem-codes.ts
3395
+ var ProblemCodes = [
3396
+ "validation-failed",
3397
+ "not-found",
3398
+ "conflict",
3399
+ "precondition-failed",
3400
+ "precondition-required",
3401
+ "unauthenticated",
3402
+ "forbidden",
3403
+ "rate-limited",
3404
+ "payload-too-large",
3405
+ "unsupported-format",
3406
+ "engine-unavailable",
3407
+ "engine-incompatible",
3408
+ "degraded",
3409
+ "job-failed",
3410
+ "upload-checksum-mismatch",
3411
+ "legacy-unsupported",
3412
+ "internal",
3413
+ "clock-unlocked",
3414
+ "not-configured",
3415
+ "authorization-pending",
3416
+ "slow-down",
3417
+ "access-denied",
3418
+ "expired-token",
3419
+ "token-reused",
3420
+ "idempotency-key-reused",
3421
+ "idempotency-in-progress"
3422
+ ];
3423
+
3424
+ // src/generated/asyncapi.ts
3425
+ var AsyncApiCatalogue = {
3426
+ "cloud-socketio": {
3427
+ version: "1.0.0",
3428
+ messages: ["event", "join"],
3429
+ channels: ["v1"],
3430
+ operations: ["emitJoin", "receiveEvent"]
3431
+ },
3432
+ "socketio-legacy": {
3433
+ version: "1.0.0",
3434
+ messages: [
3435
+ "brightness",
3436
+ "clear-integration",
3437
+ "command",
3438
+ "command_response",
3439
+ "dome-state",
3440
+ "error",
3441
+ "getState",
3442
+ "heartbeat",
3443
+ "integration-event",
3444
+ "oscSent",
3445
+ "rotation",
3446
+ "sendOsc",
3447
+ "setState",
3448
+ "state",
3449
+ "system_event",
3450
+ "volume"
3451
+ ],
3452
+ channels: ["root"],
3453
+ operations: [
3454
+ "emitClearIntegration",
3455
+ "emitCommand",
3456
+ "emitHeartbeat",
3457
+ "emitIntegrationEvent",
3458
+ "emitOutputNumbers",
3459
+ "emitV3SendOsc",
3460
+ "emitV3State",
3461
+ "receiveDomeState",
3462
+ "receiveIntegrationEvent",
3463
+ "receiveSystemEvent"
3464
+ ]
3465
+ },
3466
+ socketio: {
3467
+ version: "1.0.0",
3468
+ messages: ["ack", "bye", "call", "event", "resync", "subscribe", "unsubscribe", "welcome"],
3469
+ channels: ["v1"],
3470
+ operations: [
3471
+ "emitCall",
3472
+ "emitSubscribe",
3473
+ "emitUnsubscribe",
3474
+ "receiveBye",
3475
+ "receiveEvent",
3476
+ "receiveResync",
3477
+ "receiveWelcome"
3478
+ ]
3479
+ },
3480
+ ws: {
3481
+ version: "1.0.0",
3482
+ messages: [
3483
+ "bye",
3484
+ "call",
3485
+ "error",
3486
+ "event",
3487
+ "hello",
3488
+ "ping",
3489
+ "pong",
3490
+ "result",
3491
+ "resync",
3492
+ "subscribe",
3493
+ "unsubscribe",
3494
+ "welcome"
3495
+ ],
3496
+ channels: ["ws"],
3497
+ operations: [
3498
+ "receiveBye",
3499
+ "receiveEvent",
3500
+ "receivePing",
3501
+ "receiveResync",
3502
+ "sendCall",
3503
+ "sendHello",
3504
+ "sendPing",
3505
+ "sendSubscribe",
3506
+ "sendUnsubscribe"
3507
+ ]
3508
+ }
3509
+ };
3510
+
3511
+ // src/index.ts
3512
+ var PACKAGE_NAME = "@freedome/protocol";
3513
+ export {
3514
+ AsyncApiCatalogue,
3515
+ CONTRACT,
3516
+ CloudOperations,
3517
+ DomeTopics,
3518
+ EventKinds,
3519
+ MessageTypes,
3520
+ Operations,
3521
+ PACKAGE_NAME,
3522
+ ProblemCodes,
3523
+ ProtocolVersions,
3524
+ PseudoScopes,
3525
+ RoleScopes,
3526
+ Scopes,
3527
+ SemVer,
3528
+ TopicDelivery,
3529
+ TopicTable,
3530
+ WS_SUBPROTOCOL,
3531
+ WsCloseCodes,
3532
+ eventFromMessage,
3533
+ expandPath,
3534
+ jsonMergePatch,
3535
+ matchOperation,
3536
+ openEnum,
3537
+ parseWsMessage,
3538
+ rfc3339Millis,
3539
+ topicIsInstanceOf,
3540
+ topicMatches
3541
+ };