@freedome/protocol 0.0.0-stage → 1.0.0

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