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