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