@oasisomniverse/web5-api 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.
Files changed (92) hide show
  1. package/README.md +250 -0
  2. package/docs/README.md +44 -0
  3. package/docs/modules/Avatar.md +606 -0
  4. package/docs/modules/CelestialBodies.md +1051 -0
  5. package/docs/modules/CelestialBodiesMetaData.md +949 -0
  6. package/docs/modules/CelestialSpaces.md +1051 -0
  7. package/docs/modules/Chapters.md +955 -0
  8. package/docs/modules/Competition.md +594 -0
  9. package/docs/modules/Cosmic.md +3653 -0
  10. package/docs/modules/Games.md +2619 -0
  11. package/docs/modules/GeoHotSpots.md +1027 -0
  12. package/docs/modules/GeoNFTs.md +1049 -0
  13. package/docs/modules/Health.md +90 -0
  14. package/docs/modules/Holons.md +1139 -0
  15. package/docs/modules/HolonsMetaData.md +949 -0
  16. package/docs/modules/InventoryItems.md +1071 -0
  17. package/docs/modules/Libraries.md +1052 -0
  18. package/docs/modules/Missions.md +1286 -0
  19. package/docs/modules/NFTs.md +1008 -0
  20. package/docs/modules/OAPPs.md +1190 -0
  21. package/docs/modules/Parks.md +1079 -0
  22. package/docs/modules/Plugins.md +1138 -0
  23. package/docs/modules/Quests.md +1941 -0
  24. package/docs/modules/Runtimes.md +1112 -0
  25. package/docs/modules/STAR.md +178 -0
  26. package/docs/modules/Templates.md +990 -0
  27. package/docs/modules/Zomes.md +1049 -0
  28. package/docs/modules/ZomesMetaData.md +949 -0
  29. package/index.d.ts +97 -0
  30. package/index.js +3 -0
  31. package/index.mjs +4 -0
  32. package/package.json +117 -0
  33. package/src/core/httpClient.js +110 -0
  34. package/src/core/routeHelper.js +85 -0
  35. package/src/core/tokenStore.js +52 -0
  36. package/src/core/types.d.ts +18 -0
  37. package/src/index.js +60 -0
  38. package/src/modules/Auth.d.ts +15 -0
  39. package/src/modules/Auth.js +62 -0
  40. package/src/modules/Avatar.d.ts +45 -0
  41. package/src/modules/Avatar.js +47 -0
  42. package/src/modules/CelestialBodies.d.ts +72 -0
  43. package/src/modules/CelestialBodies.js +65 -0
  44. package/src/modules/CelestialBodiesMetaData.d.ts +69 -0
  45. package/src/modules/CelestialBodiesMetaData.js +61 -0
  46. package/src/modules/CelestialSpaces.d.ts +72 -0
  47. package/src/modules/CelestialSpaces.js +65 -0
  48. package/src/modules/Chapters.d.ts +66 -0
  49. package/src/modules/Chapters.js +61 -0
  50. package/src/modules/Competition.d.ts +33 -0
  51. package/src/modules/Competition.js +39 -0
  52. package/src/modules/Cosmic.d.ts +222 -0
  53. package/src/modules/Cosmic.js +165 -0
  54. package/src/modules/Games.d.ts +171 -0
  55. package/src/modules/Games.js +131 -0
  56. package/src/modules/GeoHotSpots.d.ts +66 -0
  57. package/src/modules/GeoHotSpots.js +61 -0
  58. package/src/modules/GeoNFTs.d.ts +72 -0
  59. package/src/modules/GeoNFTs.js +65 -0
  60. package/src/modules/Health.d.ts +12 -0
  61. package/src/modules/Health.js +25 -0
  62. package/src/modules/Holons.d.ts +78 -0
  63. package/src/modules/Holons.js +69 -0
  64. package/src/modules/HolonsMetaData.d.ts +69 -0
  65. package/src/modules/HolonsMetaData.js +61 -0
  66. package/src/modules/InventoryItems.d.ts +69 -0
  67. package/src/modules/InventoryItems.js +63 -0
  68. package/src/modules/Libraries.d.ts +72 -0
  69. package/src/modules/Libraries.js +65 -0
  70. package/src/modules/Missions.d.ts +87 -0
  71. package/src/modules/Missions.js +75 -0
  72. package/src/modules/NFTs.d.ts +69 -0
  73. package/src/modules/NFTs.js +63 -0
  74. package/src/modules/OAPPs.d.ts +69 -0
  75. package/src/modules/OAPPs.js +61 -0
  76. package/src/modules/Parks.d.ts +72 -0
  77. package/src/modules/Parks.js +65 -0
  78. package/src/modules/Plugins.d.ts +78 -0
  79. package/src/modules/Plugins.js +69 -0
  80. package/src/modules/Quests.d.ts +129 -0
  81. package/src/modules/Quests.js +101 -0
  82. package/src/modules/Runtimes.d.ts +81 -0
  83. package/src/modules/Runtimes.js +69 -0
  84. package/src/modules/STAR.d.ts +18 -0
  85. package/src/modules/STAR.js +29 -0
  86. package/src/modules/Templates.d.ts +72 -0
  87. package/src/modules/Templates.js +63 -0
  88. package/src/modules/Zomes.d.ts +72 -0
  89. package/src/modules/Zomes.js +65 -0
  90. package/src/modules/ZomesMetaData.d.ts +69 -0
  91. package/src/modules/ZomesMetaData.js +61 -0
  92. package/src/modules/index.js +67 -0
@@ -0,0 +1,3653 @@
1
+ # Cosmic — `star.cosmic`
2
+
3
+ Source controller: [`CosmicController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CosmicController.cs)
4
+ Route prefix: `api/cosmic`
5
+ 72 operation(s).
6
+
7
+ Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
8
+
9
+ ```ts
10
+ {
11
+ isError: boolean;
12
+ isWarning: boolean;
13
+ message: string;
14
+ errorCode?: string;
15
+ result: T; // see each endpoint's Response section below
16
+ }
17
+ ```
18
+
19
+ ## Operations
20
+
21
+ ### `addAsteroid`
22
+
23
+ Adds an Asteroid to a Galaxy.
24
+
25
+ **POST** `api/cosmic/galaxy/{parentGalaxyId}/asteroid`
26
+
27
+ Route parameters:
28
+
29
+ | Field | Type |
30
+ | --- | --- |
31
+ | `parentGalaxyId` | `Guid` |
32
+
33
+ **Request**
34
+
35
+ Body type: `IAsteroid`
36
+
37
+ _No fields._
38
+
39
+ **Response**
40
+
41
+ Standard `OASISResult` envelope (see top of this page) with:
42
+
43
+ `result` type: `IActionResult` (not part of the request/response payload).
44
+
45
+ **Example**
46
+
47
+ ```js
48
+ const { isError, message, result } = await star.cosmic.addAsteroid({
49
+ parentGalaxyId: '<parentGalaxyId>'
50
+ });
51
+ if (isError) throw new Error(message);
52
+ console.log(result);
53
+ ```
54
+
55
+ Example response:
56
+
57
+ ```json
58
+ {
59
+ "isError": false,
60
+ "message": "",
61
+ "result": null
62
+ }
63
+ ```
64
+
65
+ ---
66
+
67
+ ### `addComet`
68
+
69
+ Adds a Comet to a Galaxy.
70
+
71
+ **POST** `api/cosmic/galaxy/{parentGalaxyId}/comet`
72
+
73
+ Route parameters:
74
+
75
+ | Field | Type |
76
+ | --- | --- |
77
+ | `parentGalaxyId` | `Guid` |
78
+
79
+ **Request**
80
+
81
+ Body type: `IComet`
82
+
83
+ _No fields._
84
+
85
+ **Response**
86
+
87
+ Standard `OASISResult` envelope (see top of this page) with:
88
+
89
+ `result` type: `IActionResult` (not part of the request/response payload).
90
+
91
+ **Example**
92
+
93
+ ```js
94
+ const { isError, message, result } = await star.cosmic.addComet({
95
+ parentGalaxyId: '<parentGalaxyId>'
96
+ });
97
+ if (isError) throw new Error(message);
98
+ console.log(result);
99
+ ```
100
+
101
+ Example response:
102
+
103
+ ```json
104
+ {
105
+ "isError": false,
106
+ "message": "",
107
+ "result": null
108
+ }
109
+ ```
110
+
111
+ ---
112
+
113
+ ### `addGalaxy`
114
+
115
+ Adds a Galaxy to a GalaxyCluster.
116
+
117
+ **POST** `api/cosmic/galaxy-cluster/{parentGalaxyClusterId}/galaxy`
118
+
119
+ Route parameters:
120
+
121
+ | Field | Type |
122
+ | --- | --- |
123
+ | `parentGalaxyClusterId` | `Guid` |
124
+
125
+ **Request**
126
+
127
+ Body type: `IGalaxy`
128
+
129
+ | Field | Type |
130
+ | --- | --- |
131
+ | `SuperStar` | `ISuperStar` |
132
+ | `SolarSystems` | `List<ISolarSystem>` |
133
+ | `Nebulas` | `List<INebula>` |
134
+ | `Stars` | `List<IStar>` |
135
+ | `Planets` | `List<IPlanet>` |
136
+ | `Asteroids` | `List<IAsteroid>` |
137
+ | `Comets` | `List<IComet>` |
138
+ | `Meteroids` | `List<IMeteroid>` |
139
+
140
+ **Response**
141
+
142
+ Standard `OASISResult` envelope (see top of this page) with:
143
+
144
+ `result` type: `IActionResult` (not part of the request/response payload).
145
+
146
+ **Example**
147
+
148
+ ```js
149
+ const { isError, message, result } = await star.cosmic.addGalaxy({
150
+ parentGalaxyClusterId: '<parentGalaxyClusterId>',
151
+ superStar: { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] },
152
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
153
+ nebulas: [{ }],
154
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
155
+ planets: [{ "Moons": [{ }] }],
156
+ asteroids: [{ }],
157
+ comets: [{ }],
158
+ meteroids: [{ }]
159
+ });
160
+ if (isError) throw new Error(message);
161
+ console.log(result);
162
+ ```
163
+
164
+ Example response:
165
+
166
+ ```json
167
+ {
168
+ "isError": false,
169
+ "message": "",
170
+ "result": null
171
+ }
172
+ ```
173
+
174
+ ---
175
+
176
+ ### `addGalaxyCluster`
177
+
178
+ Adds a GalaxyCluster to a Universe.
179
+
180
+ **POST** `api/cosmic/universe/{parentUniverseId}/galaxy-cluster`
181
+
182
+ Route parameters:
183
+
184
+ | Field | Type |
185
+ | --- | --- |
186
+ | `parentUniverseId` | `Guid` |
187
+
188
+ **Request**
189
+
190
+ Body type: `IGalaxyCluster`
191
+
192
+ | Field | Type |
193
+ | --- | --- |
194
+ | `Galaxies` | `List<IGalaxy>` |
195
+ | `SolarSystems` | `List<ISolarSystem>` |
196
+ | `Stars` | `List<IStar>` |
197
+ | `Planets` | `List<IPlanet>` |
198
+ | `Asteroids` | `List<IAsteroid>` |
199
+ | `Comets` | `List<IComet>` |
200
+ | `Meteroids` | `List<IMeteroid>` |
201
+ | `IsSuperCluster` | `bool` |
202
+
203
+ **Response**
204
+
205
+ Standard `OASISResult` envelope (see top of this page) with:
206
+
207
+ `result` type: `IActionResult` (not part of the request/response payload).
208
+
209
+ **Example**
210
+
211
+ ```js
212
+ const { isError, message, result } = await star.cosmic.addGalaxyCluster({
213
+ parentUniverseId: '<parentUniverseId>',
214
+ galaxies: [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }],
215
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
216
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
217
+ planets: [{ "Moons": [{ }] }],
218
+ asteroids: [{ }],
219
+ comets: [{ }],
220
+ meteroids: [{ }],
221
+ isSuperCluster: true
222
+ });
223
+ if (isError) throw new Error(message);
224
+ console.log(result);
225
+ ```
226
+
227
+ Example response:
228
+
229
+ ```json
230
+ {
231
+ "isError": false,
232
+ "message": "",
233
+ "result": null
234
+ }
235
+ ```
236
+
237
+ ---
238
+
239
+ ### `addMeteroid`
240
+
241
+ Adds a Meteroid to a Galaxy.
242
+
243
+ **POST** `api/cosmic/galaxy/{parentGalaxyId}/meteroid`
244
+
245
+ Route parameters:
246
+
247
+ | Field | Type |
248
+ | --- | --- |
249
+ | `parentGalaxyId` | `Guid` |
250
+
251
+ **Request**
252
+
253
+ Body type: `IMeteroid`
254
+
255
+ _No fields._
256
+
257
+ **Response**
258
+
259
+ Standard `OASISResult` envelope (see top of this page) with:
260
+
261
+ `result` type: `IActionResult` (not part of the request/response payload).
262
+
263
+ **Example**
264
+
265
+ ```js
266
+ const { isError, message, result } = await star.cosmic.addMeteroid({
267
+ parentGalaxyId: '<parentGalaxyId>'
268
+ });
269
+ if (isError) throw new Error(message);
270
+ console.log(result);
271
+ ```
272
+
273
+ Example response:
274
+
275
+ ```json
276
+ {
277
+ "isError": false,
278
+ "message": "",
279
+ "result": null
280
+ }
281
+ ```
282
+
283
+ ---
284
+
285
+ ### `addMoon`
286
+
287
+ Adds a Moon to a Planet.
288
+
289
+ **POST** `api/cosmic/planet/{parentPlanetId}/moon`
290
+
291
+ Route parameters:
292
+
293
+ | Field | Type |
294
+ | --- | --- |
295
+ | `parentPlanetId` | `Guid` |
296
+
297
+ **Request**
298
+
299
+ Body type: `IMoon`
300
+
301
+ _No fields._
302
+
303
+ **Response**
304
+
305
+ Standard `OASISResult` envelope (see top of this page) with:
306
+
307
+ `result` type: `IActionResult` (not part of the request/response payload).
308
+
309
+ **Example**
310
+
311
+ ```js
312
+ const { isError, message, result } = await star.cosmic.addMoon({
313
+ parentPlanetId: '<parentPlanetId>'
314
+ });
315
+ if (isError) throw new Error(message);
316
+ console.log(result);
317
+ ```
318
+
319
+ Example response:
320
+
321
+ ```json
322
+ {
323
+ "isError": false,
324
+ "message": "",
325
+ "result": null
326
+ }
327
+ ```
328
+
329
+ ---
330
+
331
+ ### `addMultiverse`
332
+
333
+ Adds a Multiverse to an Omniverse.
334
+
335
+ **POST** `api/cosmic/omniverse/{parentOmniverseId}/multiverse`
336
+
337
+ Route parameters:
338
+
339
+ | Field | Type |
340
+ | --- | --- |
341
+ | `parentOmniverseId` | `Guid` |
342
+
343
+ **Request**
344
+
345
+ Body type: `IMultiverse`
346
+
347
+ | Field | Type |
348
+ | --- | --- |
349
+ | `GrandSuperStar` | `IGrandSuperStar` |
350
+ | `Dimensions` | `IMultiverseDimensions` |
351
+
352
+ **Response**
353
+
354
+ Standard `OASISResult` envelope (see top of this page) with:
355
+
356
+ `result` type: `IActionResult` (not part of the request/response payload).
357
+
358
+ **Example**
359
+
360
+ ```js
361
+ const { isError, message, result } = await star.cosmic.addMultiverse({
362
+ parentOmniverseId: '<parentOmniverseId>',
363
+ grandSuperStar: { "Stars": [ /* <I> */ ] },
364
+ dimensions: { "FirstDimension": { "Universe": { "Dimensions": [{ "DimensionLevel": { } }], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] }
365
+ });
366
+ if (isError) throw new Error(message);
367
+ console.log(result);
368
+ ```
369
+
370
+ Example response:
371
+
372
+ ```json
373
+ {
374
+ "isError": false,
375
+ "message": "",
376
+ "result": null
377
+ }
378
+ ```
379
+
380
+ ---
381
+
382
+ ### `addPlanet`
383
+
384
+ Adds a Planet to a SolarSystem.
385
+
386
+ **POST** `api/cosmic/solar-system/{parentSolarSystemId}/planet`
387
+
388
+ Route parameters:
389
+
390
+ | Field | Type |
391
+ | --- | --- |
392
+ | `parentSolarSystemId` | `Guid` |
393
+
394
+ **Request**
395
+
396
+ Body type: `IPlanet`
397
+
398
+ | Field | Type |
399
+ | --- | --- |
400
+ | `Moons` | `List<IMoon>` |
401
+
402
+ **Response**
403
+
404
+ Standard `OASISResult` envelope (see top of this page) with:
405
+
406
+ `result` type: `IActionResult` (not part of the request/response payload).
407
+
408
+ **Example**
409
+
410
+ ```js
411
+ const { isError, message, result } = await star.cosmic.addPlanet({
412
+ parentSolarSystemId: '<parentSolarSystemId>',
413
+ moons: [{ }]
414
+ });
415
+ if (isError) throw new Error(message);
416
+ console.log(result);
417
+ ```
418
+
419
+ Example response:
420
+
421
+ ```json
422
+ {
423
+ "isError": false,
424
+ "message": "",
425
+ "result": null
426
+ }
427
+ ```
428
+
429
+ ---
430
+
431
+ ### `addSolarSystem`
432
+
433
+ Adds a SolarSystem to a Galaxy.
434
+
435
+ **POST** `api/cosmic/galaxy/{parentGalaxyId}/solar-system`
436
+
437
+ Route parameters:
438
+
439
+ | Field | Type |
440
+ | --- | --- |
441
+ | `parentGalaxyId` | `Guid` |
442
+
443
+ **Request**
444
+
445
+ Body type: `ISolarSystem`
446
+
447
+ | Field | Type |
448
+ | --- | --- |
449
+ | `Star` | `IStar` |
450
+ | `Planets` | `List<IPlanet>` |
451
+ | `Asteroids` | `List<IAsteroid>` |
452
+ | `Comets` | `List<IComet>` |
453
+ | `Meteroids` | `List<IMeteroid>` |
454
+
455
+ **Response**
456
+
457
+ Standard `OASISResult` envelope (see top of this page) with:
458
+
459
+ `result` type: `IActionResult` (not part of the request/response payload).
460
+
461
+ **Example**
462
+
463
+ ```js
464
+ const { isError, message, result } = await star.cosmic.addSolarSystem({
465
+ parentGalaxyId: '<parentGalaxyId>',
466
+ star: { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } },
467
+ planets: [{ "Moons": [{ }] }],
468
+ asteroids: [{ }],
469
+ comets: [{ }],
470
+ meteroids: [{ }]
471
+ });
472
+ if (isError) throw new Error(message);
473
+ console.log(result);
474
+ ```
475
+
476
+ Example response:
477
+
478
+ ```json
479
+ {
480
+ "isError": false,
481
+ "message": "",
482
+ "result": null
483
+ }
484
+ ```
485
+
486
+ ---
487
+
488
+ ### `addStar`
489
+
490
+ Adds a Star to a Galaxy.
491
+
492
+ **POST** `api/cosmic/galaxy/{parentGalaxyId}/star`
493
+
494
+ Route parameters:
495
+
496
+ | Field | Type |
497
+ | --- | --- |
498
+ | `parentGalaxyId` | `Guid` |
499
+
500
+ **Request**
501
+
502
+ Body type: `IStar`
503
+
504
+ | Field | Type |
505
+ | --- | --- |
506
+ | `Luminosity` | `int` |
507
+ | `StarType` | `StarType` |
508
+ | `StarClassification` | `StarClassification` |
509
+ | `StarBinaryType` | `StarBinaryType` |
510
+
511
+ **Response**
512
+
513
+ Standard `OASISResult` envelope (see top of this page) with:
514
+
515
+ `result` type: `IActionResult` (not part of the request/response payload).
516
+
517
+ **Example**
518
+
519
+ ```js
520
+ const { isError, message, result } = await star.cosmic.addStar({
521
+ parentGalaxyId: '<parentGalaxyId>',
522
+ luminosity: 1,
523
+ starType: { },
524
+ starClassification: { },
525
+ starBinaryType: { }
526
+ });
527
+ if (isError) throw new Error(message);
528
+ console.log(result);
529
+ ```
530
+
531
+ Example response:
532
+
533
+ ```json
534
+ {
535
+ "isError": false,
536
+ "message": "",
537
+ "result": null
538
+ }
539
+ ```
540
+
541
+ ---
542
+
543
+ ### `addUniverse`
544
+
545
+ Adds a Universe to a Multiverse.
546
+
547
+ **POST** `api/cosmic/multiverse/{parentMultiverseId}/universe`
548
+
549
+ Route parameters:
550
+
551
+ | Field | Type |
552
+ | --- | --- |
553
+ | `parentMultiverseId` | `Guid` |
554
+
555
+ **Request**
556
+
557
+ Body type: `IUniverse`
558
+
559
+ | Field | Type |
560
+ | --- | --- |
561
+ | `Dimensions` | `List<IDimension>` |
562
+ | `GalaxyClusters` | `List<IGalaxyCluster>` |
563
+ | `SolarSystems` | `List<ISolarSystem>` |
564
+ | `Nebulas` | `List<INebula>` |
565
+ | `Stars` | `List<IStar>` |
566
+ | `Planets` | `List<IPlanet>` |
567
+ | `Asteroids` | `List<IAsteroid>` |
568
+ | `Comets` | `List<IComet>` |
569
+ | `Meteroids` | `List<IMeteroid>` |
570
+
571
+ **Response**
572
+
573
+ Standard `OASISResult` envelope (see top of this page) with:
574
+
575
+ `result` type: `IActionResult` (not part of the request/response payload).
576
+
577
+ **Example**
578
+
579
+ ```js
580
+ const { isError, message, result } = await star.cosmic.addUniverse({
581
+ parentMultiverseId: '<parentMultiverseId>',
582
+ dimensions: [{ "DimensionLevel": { } }],
583
+ galaxyClusters: [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }],
584
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
585
+ nebulas: [{ }],
586
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
587
+ planets: [{ "Moons": [{ }] }],
588
+ asteroids: [{ }],
589
+ comets: [{ }],
590
+ meteroids: [{ }]
591
+ });
592
+ if (isError) throw new Error(message);
593
+ console.log(result);
594
+ ```
595
+
596
+ Example response:
597
+
598
+ ```json
599
+ {
600
+ "isError": false,
601
+ "message": "",
602
+ "result": null
603
+ }
604
+ ```
605
+
606
+ ---
607
+
608
+ ### `deleteAsteroid`
609
+
610
+ Deletes an Asteroid.
611
+
612
+ **DELETE** `api/cosmic/asteroid/{asteroidId}`
613
+
614
+ Route parameters:
615
+
616
+ | Field | Type |
617
+ | --- | --- |
618
+ | `asteroidId` | `Guid` |
619
+
620
+ **Request**
621
+
622
+ Query parameters:
623
+
624
+ | Field | Type |
625
+ | --- | --- |
626
+ | `softDelete` | `bool (optional)` |
627
+ | `providerType` | `ProviderType (optional)` |
628
+
629
+ **Response**
630
+
631
+ Standard `OASISResult` envelope (see top of this page) with:
632
+
633
+ `result` type: `IActionResult` (not part of the request/response payload).
634
+
635
+ **Example**
636
+
637
+ ```js
638
+ const { isError, message, result } = await star.cosmic.deleteAsteroid({
639
+ asteroidId: '<asteroidId>',
640
+ softDelete: true,
641
+ providerType: '<providerType>'
642
+ });
643
+ if (isError) throw new Error(message);
644
+ console.log(result);
645
+ ```
646
+
647
+ Example response:
648
+
649
+ ```json
650
+ {
651
+ "isError": false,
652
+ "message": "",
653
+ "result": null
654
+ }
655
+ ```
656
+
657
+ ---
658
+
659
+ ### `deleteBlackHole`
660
+
661
+ Deletes a BlackHole.
662
+
663
+ **DELETE** `api/cosmic/blackhole/{blackHoleId}`
664
+
665
+ Route parameters:
666
+
667
+ | Field | Type |
668
+ | --- | --- |
669
+ | `blackHoleId` | `Guid` |
670
+
671
+ **Request**
672
+
673
+ Query parameters:
674
+
675
+ | Field | Type |
676
+ | --- | --- |
677
+ | `softDelete` | `bool (optional)` |
678
+ | `providerType` | `ProviderType (optional)` |
679
+
680
+ **Response**
681
+
682
+ Standard `OASISResult` envelope (see top of this page) with:
683
+
684
+ `result` type: `IActionResult` (not part of the request/response payload).
685
+
686
+ **Example**
687
+
688
+ ```js
689
+ const { isError, message, result } = await star.cosmic.deleteBlackHole({
690
+ blackHoleId: '<blackHoleId>',
691
+ softDelete: true,
692
+ providerType: '<providerType>'
693
+ });
694
+ if (isError) throw new Error(message);
695
+ console.log(result);
696
+ ```
697
+
698
+ Example response:
699
+
700
+ ```json
701
+ {
702
+ "isError": false,
703
+ "message": "",
704
+ "result": null
705
+ }
706
+ ```
707
+
708
+ ---
709
+
710
+ ### `deleteComet`
711
+
712
+ Deletes a Comet.
713
+
714
+ **DELETE** `api/cosmic/comet/{cometId}`
715
+
716
+ Route parameters:
717
+
718
+ | Field | Type |
719
+ | --- | --- |
720
+ | `cometId` | `Guid` |
721
+
722
+ **Request**
723
+
724
+ Query parameters:
725
+
726
+ | Field | Type |
727
+ | --- | --- |
728
+ | `softDelete` | `bool (optional)` |
729
+ | `providerType` | `ProviderType (optional)` |
730
+
731
+ **Response**
732
+
733
+ Standard `OASISResult` envelope (see top of this page) with:
734
+
735
+ `result` type: `IActionResult` (not part of the request/response payload).
736
+
737
+ **Example**
738
+
739
+ ```js
740
+ const { isError, message, result } = await star.cosmic.deleteComet({
741
+ cometId: '<cometId>',
742
+ softDelete: true,
743
+ providerType: '<providerType>'
744
+ });
745
+ if (isError) throw new Error(message);
746
+ console.log(result);
747
+ ```
748
+
749
+ Example response:
750
+
751
+ ```json
752
+ {
753
+ "isError": false,
754
+ "message": "",
755
+ "result": null
756
+ }
757
+ ```
758
+
759
+ ---
760
+
761
+ ### `deleteCosmicRay`
762
+
763
+ Deletes a CosmicRay.
764
+
765
+ **DELETE** `api/cosmic/cosmic-ray/{rayId}`
766
+
767
+ Route parameters:
768
+
769
+ | Field | Type |
770
+ | --- | --- |
771
+ | `rayId` | `Guid` |
772
+
773
+ **Request**
774
+
775
+ Query parameters:
776
+
777
+ | Field | Type |
778
+ | --- | --- |
779
+ | `softDelete` | `bool (optional)` |
780
+ | `providerType` | `ProviderType (optional)` |
781
+
782
+ **Response**
783
+
784
+ Standard `OASISResult` envelope (see top of this page) with:
785
+
786
+ `result` type: `IActionResult` (not part of the request/response payload).
787
+
788
+ **Example**
789
+
790
+ ```js
791
+ const { isError, message, result } = await star.cosmic.deleteCosmicRay({
792
+ rayId: '<rayId>',
793
+ softDelete: true,
794
+ providerType: '<providerType>'
795
+ });
796
+ if (isError) throw new Error(message);
797
+ console.log(result);
798
+ ```
799
+
800
+ Example response:
801
+
802
+ ```json
803
+ {
804
+ "isError": false,
805
+ "message": "",
806
+ "result": null
807
+ }
808
+ ```
809
+
810
+ ---
811
+
812
+ ### `deleteCosmicWave`
813
+
814
+ Deletes a CosmicWave.
815
+
816
+ **DELETE** `api/cosmic/cosmic-wave/{waveId}`
817
+
818
+ Route parameters:
819
+
820
+ | Field | Type |
821
+ | --- | --- |
822
+ | `waveId` | `Guid` |
823
+
824
+ **Request**
825
+
826
+ Query parameters:
827
+
828
+ | Field | Type |
829
+ | --- | --- |
830
+ | `softDelete` | `bool (optional)` |
831
+ | `providerType` | `ProviderType (optional)` |
832
+
833
+ **Response**
834
+
835
+ Standard `OASISResult` envelope (see top of this page) with:
836
+
837
+ `result` type: `IActionResult` (not part of the request/response payload).
838
+
839
+ **Example**
840
+
841
+ ```js
842
+ const { isError, message, result } = await star.cosmic.deleteCosmicWave({
843
+ waveId: '<waveId>',
844
+ softDelete: true,
845
+ providerType: '<providerType>'
846
+ });
847
+ if (isError) throw new Error(message);
848
+ console.log(result);
849
+ ```
850
+
851
+ Example response:
852
+
853
+ ```json
854
+ {
855
+ "isError": false,
856
+ "message": "",
857
+ "result": null
858
+ }
859
+ ```
860
+
861
+ ---
862
+
863
+ ### `deleteGalaxy`
864
+
865
+ Deletes a Galaxy.
866
+
867
+ **DELETE** `api/cosmic/galaxy/{galaxyId}`
868
+
869
+ Route parameters:
870
+
871
+ | Field | Type |
872
+ | --- | --- |
873
+ | `galaxyId` | `Guid` |
874
+
875
+ **Request**
876
+
877
+ Query parameters:
878
+
879
+ | Field | Type |
880
+ | --- | --- |
881
+ | `softDelete` | `bool (optional)` |
882
+ | `providerType` | `ProviderType (optional)` |
883
+
884
+ **Response**
885
+
886
+ Standard `OASISResult` envelope (see top of this page) with:
887
+
888
+ `result` type: `IActionResult` (not part of the request/response payload).
889
+
890
+ **Example**
891
+
892
+ ```js
893
+ const { isError, message, result } = await star.cosmic.deleteGalaxy({
894
+ galaxyId: '<galaxyId>',
895
+ softDelete: true,
896
+ providerType: '<providerType>'
897
+ });
898
+ if (isError) throw new Error(message);
899
+ console.log(result);
900
+ ```
901
+
902
+ Example response:
903
+
904
+ ```json
905
+ {
906
+ "isError": false,
907
+ "message": "",
908
+ "result": null
909
+ }
910
+ ```
911
+
912
+ ---
913
+
914
+ ### `deleteGalaxyCluster`
915
+
916
+ Deletes a GalaxyCluster.
917
+
918
+ **DELETE** `api/cosmic/galaxy-cluster/{galaxyClusterId}`
919
+
920
+ Route parameters:
921
+
922
+ | Field | Type |
923
+ | --- | --- |
924
+ | `galaxyClusterId` | `Guid` |
925
+
926
+ **Request**
927
+
928
+ Query parameters:
929
+
930
+ | Field | Type |
931
+ | --- | --- |
932
+ | `softDelete` | `bool (optional)` |
933
+ | `providerType` | `ProviderType (optional)` |
934
+
935
+ **Response**
936
+
937
+ Standard `OASISResult` envelope (see top of this page) with:
938
+
939
+ `result` type: `IActionResult` (not part of the request/response payload).
940
+
941
+ **Example**
942
+
943
+ ```js
944
+ const { isError, message, result } = await star.cosmic.deleteGalaxyCluster({
945
+ galaxyClusterId: '<galaxyClusterId>',
946
+ softDelete: true,
947
+ providerType: '<providerType>'
948
+ });
949
+ if (isError) throw new Error(message);
950
+ console.log(result);
951
+ ```
952
+
953
+ Example response:
954
+
955
+ ```json
956
+ {
957
+ "isError": false,
958
+ "message": "",
959
+ "result": null
960
+ }
961
+ ```
962
+
963
+ ---
964
+
965
+ ### `deleteGravitationalWave`
966
+
967
+ Deletes a GravitationalWave.
968
+
969
+ **DELETE** `api/cosmic/gravitational-wave/{waveId}`
970
+
971
+ Route parameters:
972
+
973
+ | Field | Type |
974
+ | --- | --- |
975
+ | `waveId` | `Guid` |
976
+
977
+ **Request**
978
+
979
+ Query parameters:
980
+
981
+ | Field | Type |
982
+ | --- | --- |
983
+ | `softDelete` | `bool (optional)` |
984
+ | `providerType` | `ProviderType (optional)` |
985
+
986
+ **Response**
987
+
988
+ Standard `OASISResult` envelope (see top of this page) with:
989
+
990
+ `result` type: `IActionResult` (not part of the request/response payload).
991
+
992
+ **Example**
993
+
994
+ ```js
995
+ const { isError, message, result } = await star.cosmic.deleteGravitationalWave({
996
+ waveId: '<waveId>',
997
+ softDelete: true,
998
+ providerType: '<providerType>'
999
+ });
1000
+ if (isError) throw new Error(message);
1001
+ console.log(result);
1002
+ ```
1003
+
1004
+ Example response:
1005
+
1006
+ ```json
1007
+ {
1008
+ "isError": false,
1009
+ "message": "",
1010
+ "result": null
1011
+ }
1012
+ ```
1013
+
1014
+ ---
1015
+
1016
+ ### `deleteMeteroid`
1017
+
1018
+ Deletes a Meteroid.
1019
+
1020
+ **DELETE** `api/cosmic/meteroid/{meteroidId}`
1021
+
1022
+ Route parameters:
1023
+
1024
+ | Field | Type |
1025
+ | --- | --- |
1026
+ | `meteroidId` | `Guid` |
1027
+
1028
+ **Request**
1029
+
1030
+ Query parameters:
1031
+
1032
+ | Field | Type |
1033
+ | --- | --- |
1034
+ | `softDelete` | `bool (optional)` |
1035
+ | `providerType` | `ProviderType (optional)` |
1036
+
1037
+ **Response**
1038
+
1039
+ Standard `OASISResult` envelope (see top of this page) with:
1040
+
1041
+ `result` type: `IActionResult` (not part of the request/response payload).
1042
+
1043
+ **Example**
1044
+
1045
+ ```js
1046
+ const { isError, message, result } = await star.cosmic.deleteMeteroid({
1047
+ meteroidId: '<meteroidId>',
1048
+ softDelete: true,
1049
+ providerType: '<providerType>'
1050
+ });
1051
+ if (isError) throw new Error(message);
1052
+ console.log(result);
1053
+ ```
1054
+
1055
+ Example response:
1056
+
1057
+ ```json
1058
+ {
1059
+ "isError": false,
1060
+ "message": "",
1061
+ "result": null
1062
+ }
1063
+ ```
1064
+
1065
+ ---
1066
+
1067
+ ### `deleteMoon`
1068
+
1069
+ Deletes a Moon.
1070
+
1071
+ **DELETE** `api/cosmic/moon/{moonId}`
1072
+
1073
+ Route parameters:
1074
+
1075
+ | Field | Type |
1076
+ | --- | --- |
1077
+ | `moonId` | `Guid` |
1078
+
1079
+ **Request**
1080
+
1081
+ Query parameters:
1082
+
1083
+ | Field | Type |
1084
+ | --- | --- |
1085
+ | `softDelete` | `bool (optional)` |
1086
+ | `providerType` | `ProviderType (optional)` |
1087
+
1088
+ **Response**
1089
+
1090
+ Standard `OASISResult` envelope (see top of this page) with:
1091
+
1092
+ `result` type: `IActionResult` (not part of the request/response payload).
1093
+
1094
+ **Example**
1095
+
1096
+ ```js
1097
+ const { isError, message, result } = await star.cosmic.deleteMoon({
1098
+ moonId: '<moonId>',
1099
+ softDelete: true,
1100
+ providerType: '<providerType>'
1101
+ });
1102
+ if (isError) throw new Error(message);
1103
+ console.log(result);
1104
+ ```
1105
+
1106
+ Example response:
1107
+
1108
+ ```json
1109
+ {
1110
+ "isError": false,
1111
+ "message": "",
1112
+ "result": null
1113
+ }
1114
+ ```
1115
+
1116
+ ---
1117
+
1118
+ ### `deleteMultiverse`
1119
+
1120
+ Deletes a Multiverse.
1121
+
1122
+ **DELETE** `api/cosmic/multiverse/{multiverseId}`
1123
+
1124
+ Route parameters:
1125
+
1126
+ | Field | Type |
1127
+ | --- | --- |
1128
+ | `multiverseId` | `Guid` |
1129
+
1130
+ **Request**
1131
+
1132
+ Query parameters:
1133
+
1134
+ | Field | Type |
1135
+ | --- | --- |
1136
+ | `softDelete` | `bool (optional)` |
1137
+ | `providerType` | `ProviderType (optional)` |
1138
+
1139
+ **Response**
1140
+
1141
+ Standard `OASISResult` envelope (see top of this page) with:
1142
+
1143
+ `result` type: `IActionResult` (not part of the request/response payload).
1144
+
1145
+ **Example**
1146
+
1147
+ ```js
1148
+ const { isError, message, result } = await star.cosmic.deleteMultiverse({
1149
+ multiverseId: '<multiverseId>',
1150
+ softDelete: true,
1151
+ providerType: '<providerType>'
1152
+ });
1153
+ if (isError) throw new Error(message);
1154
+ console.log(result);
1155
+ ```
1156
+
1157
+ Example response:
1158
+
1159
+ ```json
1160
+ {
1161
+ "isError": false,
1162
+ "message": "",
1163
+ "result": null
1164
+ }
1165
+ ```
1166
+
1167
+ ---
1168
+
1169
+ ### `deleteNebula`
1170
+
1171
+ Deletes a Nebula.
1172
+
1173
+ **DELETE** `api/cosmic/nebula/{nebulaId}`
1174
+
1175
+ Route parameters:
1176
+
1177
+ | Field | Type |
1178
+ | --- | --- |
1179
+ | `nebulaId` | `Guid` |
1180
+
1181
+ **Request**
1182
+
1183
+ Query parameters:
1184
+
1185
+ | Field | Type |
1186
+ | --- | --- |
1187
+ | `softDelete` | `bool (optional)` |
1188
+ | `providerType` | `ProviderType (optional)` |
1189
+
1190
+ **Response**
1191
+
1192
+ Standard `OASISResult` envelope (see top of this page) with:
1193
+
1194
+ `result` type: `IActionResult` (not part of the request/response payload).
1195
+
1196
+ **Example**
1197
+
1198
+ ```js
1199
+ const { isError, message, result } = await star.cosmic.deleteNebula({
1200
+ nebulaId: '<nebulaId>',
1201
+ softDelete: true,
1202
+ providerType: '<providerType>'
1203
+ });
1204
+ if (isError) throw new Error(message);
1205
+ console.log(result);
1206
+ ```
1207
+
1208
+ Example response:
1209
+
1210
+ ```json
1211
+ {
1212
+ "isError": false,
1213
+ "message": "",
1214
+ "result": null
1215
+ }
1216
+ ```
1217
+
1218
+ ---
1219
+
1220
+ ### `deleteOmniverse`
1221
+
1222
+ Deletes an Omniverse.
1223
+
1224
+ **DELETE** `api/cosmic/omniverse/{omniverseId}`
1225
+
1226
+ Route parameters:
1227
+
1228
+ | Field | Type |
1229
+ | --- | --- |
1230
+ | `omniverseId` | `Guid` |
1231
+
1232
+ **Request**
1233
+
1234
+ Query parameters:
1235
+
1236
+ | Field | Type |
1237
+ | --- | --- |
1238
+ | `softDelete` | `bool (optional)` |
1239
+ | `providerType` | `ProviderType (optional)` |
1240
+
1241
+ **Response**
1242
+
1243
+ Standard `OASISResult` envelope (see top of this page) with:
1244
+
1245
+ `result` type: `IActionResult` (not part of the request/response payload).
1246
+
1247
+ **Example**
1248
+
1249
+ ```js
1250
+ const { isError, message, result } = await star.cosmic.deleteOmniverse({
1251
+ omniverseId: '<omniverseId>',
1252
+ softDelete: true,
1253
+ providerType: '<providerType>'
1254
+ });
1255
+ if (isError) throw new Error(message);
1256
+ console.log(result);
1257
+ ```
1258
+
1259
+ Example response:
1260
+
1261
+ ```json
1262
+ {
1263
+ "isError": false,
1264
+ "message": "",
1265
+ "result": null
1266
+ }
1267
+ ```
1268
+
1269
+ ---
1270
+
1271
+ ### `deletePlanet`
1272
+
1273
+ Deletes a Planet.
1274
+
1275
+ **DELETE** `api/cosmic/planet/{planetId}`
1276
+
1277
+ Route parameters:
1278
+
1279
+ | Field | Type |
1280
+ | --- | --- |
1281
+ | `planetId` | `Guid` |
1282
+
1283
+ **Request**
1284
+
1285
+ Query parameters:
1286
+
1287
+ | Field | Type |
1288
+ | --- | --- |
1289
+ | `softDelete` | `bool (optional)` |
1290
+ | `providerType` | `ProviderType (optional)` |
1291
+
1292
+ **Response**
1293
+
1294
+ Standard `OASISResult` envelope (see top of this page) with:
1295
+
1296
+ `result` type: `IActionResult` (not part of the request/response payload).
1297
+
1298
+ **Example**
1299
+
1300
+ ```js
1301
+ const { isError, message, result } = await star.cosmic.deletePlanet({
1302
+ planetId: '<planetId>',
1303
+ softDelete: true,
1304
+ providerType: '<providerType>'
1305
+ });
1306
+ if (isError) throw new Error(message);
1307
+ console.log(result);
1308
+ ```
1309
+
1310
+ Example response:
1311
+
1312
+ ```json
1313
+ {
1314
+ "isError": false,
1315
+ "message": "",
1316
+ "result": null
1317
+ }
1318
+ ```
1319
+
1320
+ ---
1321
+
1322
+ ### `deletePortal`
1323
+
1324
+ Deletes a Portal.
1325
+
1326
+ **DELETE** `api/cosmic/portal/{portalId}`
1327
+
1328
+ Route parameters:
1329
+
1330
+ | Field | Type |
1331
+ | --- | --- |
1332
+ | `portalId` | `Guid` |
1333
+
1334
+ **Request**
1335
+
1336
+ Query parameters:
1337
+
1338
+ | Field | Type |
1339
+ | --- | --- |
1340
+ | `softDelete` | `bool (optional)` |
1341
+ | `providerType` | `ProviderType (optional)` |
1342
+
1343
+ **Response**
1344
+
1345
+ Standard `OASISResult` envelope (see top of this page) with:
1346
+
1347
+ `result` type: `IActionResult` (not part of the request/response payload).
1348
+
1349
+ **Example**
1350
+
1351
+ ```js
1352
+ const { isError, message, result } = await star.cosmic.deletePortal({
1353
+ portalId: '<portalId>',
1354
+ softDelete: true,
1355
+ providerType: '<providerType>'
1356
+ });
1357
+ if (isError) throw new Error(message);
1358
+ console.log(result);
1359
+ ```
1360
+
1361
+ Example response:
1362
+
1363
+ ```json
1364
+ {
1365
+ "isError": false,
1366
+ "message": "",
1367
+ "result": null
1368
+ }
1369
+ ```
1370
+
1371
+ ---
1372
+
1373
+ ### `deleteSolarSystem`
1374
+
1375
+ Deletes a SolarSystem.
1376
+
1377
+ **DELETE** `api/cosmic/solar-system/{solarSystemId}`
1378
+
1379
+ Route parameters:
1380
+
1381
+ | Field | Type |
1382
+ | --- | --- |
1383
+ | `solarSystemId` | `Guid` |
1384
+
1385
+ **Request**
1386
+
1387
+ Query parameters:
1388
+
1389
+ | Field | Type |
1390
+ | --- | --- |
1391
+ | `softDelete` | `bool (optional)` |
1392
+ | `providerType` | `ProviderType (optional)` |
1393
+
1394
+ **Response**
1395
+
1396
+ Standard `OASISResult` envelope (see top of this page) with:
1397
+
1398
+ `result` type: `IActionResult` (not part of the request/response payload).
1399
+
1400
+ **Example**
1401
+
1402
+ ```js
1403
+ const { isError, message, result } = await star.cosmic.deleteSolarSystem({
1404
+ solarSystemId: '<solarSystemId>',
1405
+ softDelete: true,
1406
+ providerType: '<providerType>'
1407
+ });
1408
+ if (isError) throw new Error(message);
1409
+ console.log(result);
1410
+ ```
1411
+
1412
+ Example response:
1413
+
1414
+ ```json
1415
+ {
1416
+ "isError": false,
1417
+ "message": "",
1418
+ "result": null
1419
+ }
1420
+ ```
1421
+
1422
+ ---
1423
+
1424
+ ### `deleteSpaceTimeAbnormally`
1425
+
1426
+ Deletes a SpaceTimeAbnormally.
1427
+
1428
+ **DELETE** `api/cosmic/spacetime-abnormally/{abnormallyId}`
1429
+
1430
+ Route parameters:
1431
+
1432
+ | Field | Type |
1433
+ | --- | --- |
1434
+ | `abnormallyId` | `Guid` |
1435
+
1436
+ **Request**
1437
+
1438
+ Query parameters:
1439
+
1440
+ | Field | Type |
1441
+ | --- | --- |
1442
+ | `softDelete` | `bool (optional)` |
1443
+ | `providerType` | `ProviderType (optional)` |
1444
+
1445
+ **Response**
1446
+
1447
+ Standard `OASISResult` envelope (see top of this page) with:
1448
+
1449
+ `result` type: `IActionResult` (not part of the request/response payload).
1450
+
1451
+ **Example**
1452
+
1453
+ ```js
1454
+ const { isError, message, result } = await star.cosmic.deleteSpaceTimeAbnormally({
1455
+ abnormallyId: '<abnormallyId>',
1456
+ softDelete: true,
1457
+ providerType: '<providerType>'
1458
+ });
1459
+ if (isError) throw new Error(message);
1460
+ console.log(result);
1461
+ ```
1462
+
1463
+ Example response:
1464
+
1465
+ ```json
1466
+ {
1467
+ "isError": false,
1468
+ "message": "",
1469
+ "result": null
1470
+ }
1471
+ ```
1472
+
1473
+ ---
1474
+
1475
+ ### `deleteSpaceTimeDistortion`
1476
+
1477
+ Deletes a SpaceTimeDistortion.
1478
+
1479
+ **DELETE** `api/cosmic/spacetime-distortion/{distortionId}`
1480
+
1481
+ Route parameters:
1482
+
1483
+ | Field | Type |
1484
+ | --- | --- |
1485
+ | `distortionId` | `Guid` |
1486
+
1487
+ **Request**
1488
+
1489
+ Query parameters:
1490
+
1491
+ | Field | Type |
1492
+ | --- | --- |
1493
+ | `softDelete` | `bool (optional)` |
1494
+ | `providerType` | `ProviderType (optional)` |
1495
+
1496
+ **Response**
1497
+
1498
+ Standard `OASISResult` envelope (see top of this page) with:
1499
+
1500
+ `result` type: `IActionResult` (not part of the request/response payload).
1501
+
1502
+ **Example**
1503
+
1504
+ ```js
1505
+ const { isError, message, result } = await star.cosmic.deleteSpaceTimeDistortion({
1506
+ distortionId: '<distortionId>',
1507
+ softDelete: true,
1508
+ providerType: '<providerType>'
1509
+ });
1510
+ if (isError) throw new Error(message);
1511
+ console.log(result);
1512
+ ```
1513
+
1514
+ Example response:
1515
+
1516
+ ```json
1517
+ {
1518
+ "isError": false,
1519
+ "message": "",
1520
+ "result": null
1521
+ }
1522
+ ```
1523
+
1524
+ ---
1525
+
1526
+ ### `deleteStar`
1527
+
1528
+ Deletes a Star.
1529
+
1530
+ **DELETE** `api/cosmic/star/{starId}`
1531
+
1532
+ Route parameters:
1533
+
1534
+ | Field | Type |
1535
+ | --- | --- |
1536
+ | `starId` | `Guid` |
1537
+
1538
+ **Request**
1539
+
1540
+ Query parameters:
1541
+
1542
+ | Field | Type |
1543
+ | --- | --- |
1544
+ | `softDelete` | `bool (optional)` |
1545
+ | `providerType` | `ProviderType (optional)` |
1546
+
1547
+ **Response**
1548
+
1549
+ Standard `OASISResult` envelope (see top of this page) with:
1550
+
1551
+ `result` type: `IActionResult` (not part of the request/response payload).
1552
+
1553
+ **Example**
1554
+
1555
+ ```js
1556
+ const { isError, message, result } = await star.cosmic.deleteStar({
1557
+ starId: '<starId>',
1558
+ softDelete: true,
1559
+ providerType: '<providerType>'
1560
+ });
1561
+ if (isError) throw new Error(message);
1562
+ console.log(result);
1563
+ ```
1564
+
1565
+ Example response:
1566
+
1567
+ ```json
1568
+ {
1569
+ "isError": false,
1570
+ "message": "",
1571
+ "result": null
1572
+ }
1573
+ ```
1574
+
1575
+ ---
1576
+
1577
+ ### `deleteStarDust`
1578
+
1579
+ Deletes a StarDust.
1580
+
1581
+ **DELETE** `api/cosmic/stardust/{starDustId}`
1582
+
1583
+ Route parameters:
1584
+
1585
+ | Field | Type |
1586
+ | --- | --- |
1587
+ | `starDustId` | `Guid` |
1588
+
1589
+ **Request**
1590
+
1591
+ Query parameters:
1592
+
1593
+ | Field | Type |
1594
+ | --- | --- |
1595
+ | `softDelete` | `bool (optional)` |
1596
+ | `providerType` | `ProviderType (optional)` |
1597
+
1598
+ **Response**
1599
+
1600
+ Standard `OASISResult` envelope (see top of this page) with:
1601
+
1602
+ `result` type: `IActionResult` (not part of the request/response payload).
1603
+
1604
+ **Example**
1605
+
1606
+ ```js
1607
+ const { isError, message, result } = await star.cosmic.deleteStarDust({
1608
+ starDustId: '<starDustId>',
1609
+ softDelete: true,
1610
+ providerType: '<providerType>'
1611
+ });
1612
+ if (isError) throw new Error(message);
1613
+ console.log(result);
1614
+ ```
1615
+
1616
+ Example response:
1617
+
1618
+ ```json
1619
+ {
1620
+ "isError": false,
1621
+ "message": "",
1622
+ "result": null
1623
+ }
1624
+ ```
1625
+
1626
+ ---
1627
+
1628
+ ### `deleteStarGate`
1629
+
1630
+ Deletes a StarGate.
1631
+
1632
+ **DELETE** `api/cosmic/stargate/{starGateId}`
1633
+
1634
+ Route parameters:
1635
+
1636
+ | Field | Type |
1637
+ | --- | --- |
1638
+ | `starGateId` | `Guid` |
1639
+
1640
+ **Request**
1641
+
1642
+ Query parameters:
1643
+
1644
+ | Field | Type |
1645
+ | --- | --- |
1646
+ | `softDelete` | `bool (optional)` |
1647
+ | `providerType` | `ProviderType (optional)` |
1648
+
1649
+ **Response**
1650
+
1651
+ Standard `OASISResult` envelope (see top of this page) with:
1652
+
1653
+ `result` type: `IActionResult` (not part of the request/response payload).
1654
+
1655
+ **Example**
1656
+
1657
+ ```js
1658
+ const { isError, message, result } = await star.cosmic.deleteStarGate({
1659
+ starGateId: '<starGateId>',
1660
+ softDelete: true,
1661
+ providerType: '<providerType>'
1662
+ });
1663
+ if (isError) throw new Error(message);
1664
+ console.log(result);
1665
+ ```
1666
+
1667
+ Example response:
1668
+
1669
+ ```json
1670
+ {
1671
+ "isError": false,
1672
+ "message": "",
1673
+ "result": null
1674
+ }
1675
+ ```
1676
+
1677
+ ---
1678
+
1679
+ ### `deleteSuperVerse`
1680
+
1681
+ Deletes a SuperVerse.
1682
+
1683
+ **DELETE** `api/cosmic/superverse/{superVerseId}`
1684
+
1685
+ Route parameters:
1686
+
1687
+ | Field | Type |
1688
+ | --- | --- |
1689
+ | `superVerseId` | `Guid` |
1690
+
1691
+ **Request**
1692
+
1693
+ Query parameters:
1694
+
1695
+ | Field | Type |
1696
+ | --- | --- |
1697
+ | `softDelete` | `bool (optional)` |
1698
+ | `providerType` | `ProviderType (optional)` |
1699
+
1700
+ **Response**
1701
+
1702
+ Standard `OASISResult` envelope (see top of this page) with:
1703
+
1704
+ `result` type: `IActionResult` (not part of the request/response payload).
1705
+
1706
+ **Example**
1707
+
1708
+ ```js
1709
+ const { isError, message, result } = await star.cosmic.deleteSuperVerse({
1710
+ superVerseId: '<superVerseId>',
1711
+ softDelete: true,
1712
+ providerType: '<providerType>'
1713
+ });
1714
+ if (isError) throw new Error(message);
1715
+ console.log(result);
1716
+ ```
1717
+
1718
+ Example response:
1719
+
1720
+ ```json
1721
+ {
1722
+ "isError": false,
1723
+ "message": "",
1724
+ "result": null
1725
+ }
1726
+ ```
1727
+
1728
+ ---
1729
+
1730
+ ### `deleteTemporalRift`
1731
+
1732
+ Deletes a TemporalRift.
1733
+
1734
+ **DELETE** `api/cosmic/temporal-rift/{riftId}`
1735
+
1736
+ Route parameters:
1737
+
1738
+ | Field | Type |
1739
+ | --- | --- |
1740
+ | `riftId` | `Guid` |
1741
+
1742
+ **Request**
1743
+
1744
+ Query parameters:
1745
+
1746
+ | Field | Type |
1747
+ | --- | --- |
1748
+ | `softDelete` | `bool (optional)` |
1749
+ | `providerType` | `ProviderType (optional)` |
1750
+
1751
+ **Response**
1752
+
1753
+ Standard `OASISResult` envelope (see top of this page) with:
1754
+
1755
+ `result` type: `IActionResult` (not part of the request/response payload).
1756
+
1757
+ **Example**
1758
+
1759
+ ```js
1760
+ const { isError, message, result } = await star.cosmic.deleteTemporalRift({
1761
+ riftId: '<riftId>',
1762
+ softDelete: true,
1763
+ providerType: '<providerType>'
1764
+ });
1765
+ if (isError) throw new Error(message);
1766
+ console.log(result);
1767
+ ```
1768
+
1769
+ Example response:
1770
+
1771
+ ```json
1772
+ {
1773
+ "isError": false,
1774
+ "message": "",
1775
+ "result": null
1776
+ }
1777
+ ```
1778
+
1779
+ ---
1780
+
1781
+ ### `deleteUniverse`
1782
+
1783
+ Deletes a Universe.
1784
+
1785
+ **DELETE** `api/cosmic/universe/{universeId}`
1786
+
1787
+ Route parameters:
1788
+
1789
+ | Field | Type |
1790
+ | --- | --- |
1791
+ | `universeId` | `Guid` |
1792
+
1793
+ **Request**
1794
+
1795
+ Query parameters:
1796
+
1797
+ | Field | Type |
1798
+ | --- | --- |
1799
+ | `softDelete` | `bool (optional)` |
1800
+ | `providerType` | `ProviderType (optional)` |
1801
+
1802
+ **Response**
1803
+
1804
+ Standard `OASISResult` envelope (see top of this page) with:
1805
+
1806
+ `result` type: `IActionResult` (not part of the request/response payload).
1807
+
1808
+ **Example**
1809
+
1810
+ ```js
1811
+ const { isError, message, result } = await star.cosmic.deleteUniverse({
1812
+ universeId: '<universeId>',
1813
+ softDelete: true,
1814
+ providerType: '<providerType>'
1815
+ });
1816
+ if (isError) throw new Error(message);
1817
+ console.log(result);
1818
+ ```
1819
+
1820
+ Example response:
1821
+
1822
+ ```json
1823
+ {
1824
+ "isError": false,
1825
+ "message": "",
1826
+ "result": null
1827
+ }
1828
+ ```
1829
+
1830
+ ---
1831
+
1832
+ ### `deleteWormHole`
1833
+
1834
+ Deletes a WormHole.
1835
+
1836
+ **DELETE** `api/cosmic/wormhole/{wormHoleId}`
1837
+
1838
+ Route parameters:
1839
+
1840
+ | Field | Type |
1841
+ | --- | --- |
1842
+ | `wormHoleId` | `Guid` |
1843
+
1844
+ **Request**
1845
+
1846
+ Query parameters:
1847
+
1848
+ | Field | Type |
1849
+ | --- | --- |
1850
+ | `softDelete` | `bool (optional)` |
1851
+ | `providerType` | `ProviderType (optional)` |
1852
+
1853
+ **Response**
1854
+
1855
+ Standard `OASISResult` envelope (see top of this page) with:
1856
+
1857
+ `result` type: `IActionResult` (not part of the request/response payload).
1858
+
1859
+ **Example**
1860
+
1861
+ ```js
1862
+ const { isError, message, result } = await star.cosmic.deleteWormHole({
1863
+ wormHoleId: '<wormHoleId>',
1864
+ softDelete: true,
1865
+ providerType: '<providerType>'
1866
+ });
1867
+ if (isError) throw new Error(message);
1868
+ console.log(result);
1869
+ ```
1870
+
1871
+ Example response:
1872
+
1873
+ ```json
1874
+ {
1875
+ "isError": false,
1876
+ "message": "",
1877
+ "result": null
1878
+ }
1879
+ ```
1880
+
1881
+ ---
1882
+
1883
+ ### `getChildrenForParent`
1884
+
1885
+ Gets children of a specific type for a parent holon.
1886
+
1887
+ **GET** `api/cosmic/children/{parentId}`
1888
+
1889
+ Route parameters:
1890
+
1891
+ | Field | Type |
1892
+ | --- | --- |
1893
+ | `parentId` | `Guid` |
1894
+
1895
+ **Request**
1896
+
1897
+ Query parameters:
1898
+
1899
+ | Field | Type |
1900
+ | --- | --- |
1901
+ | `parentHolonType` | `string` |
1902
+ | `childHolonType` | `string` |
1903
+
1904
+ **Response**
1905
+
1906
+ Standard `OASISResult` envelope (see top of this page) with:
1907
+
1908
+ `result` type: `IActionResult` (not part of the request/response payload).
1909
+
1910
+ **Example**
1911
+
1912
+ ```js
1913
+ const { isError, message, result } = await star.cosmic.getChildrenForParent({
1914
+ parentId: '<parentId>',
1915
+ parentHolonType: 'example string',
1916
+ childHolonType: 'example string'
1917
+ });
1918
+ if (isError) throw new Error(message);
1919
+ console.log(result);
1920
+ ```
1921
+
1922
+ Example response:
1923
+
1924
+ ```json
1925
+ {
1926
+ "isError": false,
1927
+ "message": "",
1928
+ "result": null
1929
+ }
1930
+ ```
1931
+
1932
+ ---
1933
+
1934
+ ### `getMoonsForGalaxy`
1935
+
1936
+ Gets all moons for a galaxy.
1937
+
1938
+ **GET** `api/cosmic/galaxy/{galaxyId}/moons`
1939
+
1940
+ Route parameters:
1941
+
1942
+ | Field | Type |
1943
+ | --- | --- |
1944
+ | `galaxyId` | `Guid` |
1945
+
1946
+ **Request**
1947
+
1948
+ No request body.
1949
+
1950
+ **Response**
1951
+
1952
+ Standard `OASISResult` envelope (see top of this page) with:
1953
+
1954
+ `result` type: `IActionResult` (not part of the request/response payload).
1955
+
1956
+ **Example**
1957
+
1958
+ ```js
1959
+ const { isError, message, result } = await star.cosmic.getMoonsForGalaxy({
1960
+ galaxyId: '<galaxyId>'
1961
+ });
1962
+ if (isError) throw new Error(message);
1963
+ console.log(result);
1964
+ ```
1965
+
1966
+ Example response:
1967
+
1968
+ ```json
1969
+ {
1970
+ "isError": false,
1971
+ "message": "",
1972
+ "result": null
1973
+ }
1974
+ ```
1975
+
1976
+ ---
1977
+
1978
+ ### `getOmniverse`
1979
+
1980
+ Gets the Omniverse instance.
1981
+
1982
+ **GET** `api/cosmic/omniverse`
1983
+
1984
+ **Request**
1985
+
1986
+ No request body.
1987
+
1988
+ **Response**
1989
+
1990
+ Standard `OASISResult` envelope (see top of this page) with:
1991
+
1992
+ `result` type: `IOmiverse`
1993
+
1994
+ | Field | Type |
1995
+ | --- | --- |
1996
+ | `GreatGrandSuperStar` | `IGreatGrandSuperStar` |
1997
+ | `Dimensions` | `IOmniverseDimensions` |
1998
+ | `Multiverses` | `List<IMultiverse>` |
1999
+
2000
+ **Example**
2001
+
2002
+ ```js
2003
+ const { isError, message, result } = await star.cosmic.getOmniverse({});
2004
+ if (isError) throw new Error(message);
2005
+ console.log(result);
2006
+ ```
2007
+
2008
+ Example response:
2009
+
2010
+ ```json
2011
+ {
2012
+ "isError": false,
2013
+ "message": "",
2014
+ "result": { "GreatGrandSuperStar": { }, "Dimensions": { "EighthDimension": { }, "NinthDimension": { }, "TenthDimension": { }, "EleventhDimension": { }, "TwelfthDimension": { }, "CustomDimensions": [{ "DimensionLevel": { } }] }, "Multiverses": [{ "GrandSuperStar": { "Stars": [ /* <I> */ ] }, "Dimensions": { "FirstDimension": { "Universe": { "Dimensions": [], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] } }] }
2015
+ }
2016
+ ```
2017
+
2018
+ ---
2019
+
2020
+ ### `getPlanetsForGalaxy`
2021
+
2022
+ Gets all planets for a galaxy.
2023
+
2024
+ **GET** `api/cosmic/galaxy/{galaxyId}/planets`
2025
+
2026
+ Route parameters:
2027
+
2028
+ | Field | Type |
2029
+ | --- | --- |
2030
+ | `galaxyId` | `Guid` |
2031
+
2032
+ **Request**
2033
+
2034
+ No request body.
2035
+
2036
+ **Response**
2037
+
2038
+ Standard `OASISResult` envelope (see top of this page) with:
2039
+
2040
+ `result` type: `IActionResult` (not part of the request/response payload).
2041
+
2042
+ **Example**
2043
+
2044
+ ```js
2045
+ const { isError, message, result } = await star.cosmic.getPlanetsForGalaxy({
2046
+ galaxyId: '<galaxyId>'
2047
+ });
2048
+ if (isError) throw new Error(message);
2049
+ console.log(result);
2050
+ ```
2051
+
2052
+ Example response:
2053
+
2054
+ ```json
2055
+ {
2056
+ "isError": false,
2057
+ "message": "",
2058
+ "result": null
2059
+ }
2060
+ ```
2061
+
2062
+ ---
2063
+
2064
+ ### `getPlanetsForSolarSystem`
2065
+
2066
+ Gets all planets for a solar system.
2067
+
2068
+ **GET** `api/cosmic/solar-system/{solarSystemId}/planets`
2069
+
2070
+ Route parameters:
2071
+
2072
+ | Field | Type |
2073
+ | --- | --- |
2074
+ | `solarSystemId` | `Guid` |
2075
+
2076
+ **Request**
2077
+
2078
+ No request body.
2079
+
2080
+ **Response**
2081
+
2082
+ Standard `OASISResult` envelope (see top of this page) with:
2083
+
2084
+ `result` type: `IActionResult` (not part of the request/response payload).
2085
+
2086
+ **Example**
2087
+
2088
+ ```js
2089
+ const { isError, message, result } = await star.cosmic.getPlanetsForSolarSystem({
2090
+ solarSystemId: '<solarSystemId>'
2091
+ });
2092
+ if (isError) throw new Error(message);
2093
+ console.log(result);
2094
+ ```
2095
+
2096
+ Example response:
2097
+
2098
+ ```json
2099
+ {
2100
+ "isError": false,
2101
+ "message": "",
2102
+ "result": null
2103
+ }
2104
+ ```
2105
+
2106
+ ---
2107
+
2108
+ ### `getSolarSystemsForGalaxy`
2109
+
2110
+ Gets all solar systems for a galaxy.
2111
+
2112
+ **GET** `api/cosmic/galaxy/{galaxyId}/solar-systems`
2113
+
2114
+ Route parameters:
2115
+
2116
+ | Field | Type |
2117
+ | --- | --- |
2118
+ | `galaxyId` | `Guid` |
2119
+
2120
+ **Request**
2121
+
2122
+ No request body.
2123
+
2124
+ **Response**
2125
+
2126
+ Standard `OASISResult` envelope (see top of this page) with:
2127
+
2128
+ `result` type: `IActionResult` (not part of the request/response payload).
2129
+
2130
+ **Example**
2131
+
2132
+ ```js
2133
+ const { isError, message, result } = await star.cosmic.getSolarSystemsForGalaxy({
2134
+ galaxyId: '<galaxyId>'
2135
+ });
2136
+ if (isError) throw new Error(message);
2137
+ console.log(result);
2138
+ ```
2139
+
2140
+ Example response:
2141
+
2142
+ ```json
2143
+ {
2144
+ "isError": false,
2145
+ "message": "",
2146
+ "result": null
2147
+ }
2148
+ ```
2149
+
2150
+ ---
2151
+
2152
+ ### `getStarsForGalaxy`
2153
+
2154
+ Gets all stars for a galaxy.
2155
+
2156
+ **GET** `api/cosmic/galaxy/{galaxyId}/stars`
2157
+
2158
+ Route parameters:
2159
+
2160
+ | Field | Type |
2161
+ | --- | --- |
2162
+ | `galaxyId` | `Guid` |
2163
+
2164
+ **Request**
2165
+
2166
+ No request body.
2167
+
2168
+ **Response**
2169
+
2170
+ Standard `OASISResult` envelope (see top of this page) with:
2171
+
2172
+ `result` type: `IActionResult` (not part of the request/response payload).
2173
+
2174
+ **Example**
2175
+
2176
+ ```js
2177
+ const { isError, message, result } = await star.cosmic.getStarsForGalaxy({
2178
+ galaxyId: '<galaxyId>'
2179
+ });
2180
+ if (isError) throw new Error(message);
2181
+ console.log(result);
2182
+ ```
2183
+
2184
+ Example response:
2185
+
2186
+ ```json
2187
+ {
2188
+ "isError": false,
2189
+ "message": "",
2190
+ "result": null
2191
+ }
2192
+ ```
2193
+
2194
+ ---
2195
+
2196
+ ### `saveOmniverse`
2197
+
2198
+ Saves an Omniverse.
2199
+
2200
+ **POST** `api/cosmic/omniverse`
2201
+
2202
+ **Request**
2203
+
2204
+ Body type: `IOmiverse`
2205
+
2206
+ | Field | Type |
2207
+ | --- | --- |
2208
+ | `GreatGrandSuperStar` | `IGreatGrandSuperStar` |
2209
+ | `Dimensions` | `IOmniverseDimensions` |
2210
+ | `Multiverses` | `List<IMultiverse>` |
2211
+
2212
+ **Response**
2213
+
2214
+ Standard `OASISResult` envelope (see top of this page) with:
2215
+
2216
+ `result` type: `IActionResult` (not part of the request/response payload).
2217
+
2218
+ **Example**
2219
+
2220
+ ```js
2221
+ const { isError, message, result } = await star.cosmic.saveOmniverse({
2222
+ greatGrandSuperStar: { },
2223
+ dimensions: { "EighthDimension": { }, "NinthDimension": { }, "TenthDimension": { }, "EleventhDimension": { }, "TwelfthDimension": { }, "CustomDimensions": [{ "DimensionLevel": { } }] },
2224
+ multiverses: [{ "GrandSuperStar": { "Stars": [ /* <I> */ ] }, "Dimensions": { "FirstDimension": { "Universe": { "Dimensions": [{ "DimensionLevel": { } }], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] } }]
2225
+ });
2226
+ if (isError) throw new Error(message);
2227
+ console.log(result);
2228
+ ```
2229
+
2230
+ Example response:
2231
+
2232
+ ```json
2233
+ {
2234
+ "isError": false,
2235
+ "message": "",
2236
+ "result": null
2237
+ }
2238
+ ```
2239
+
2240
+ ---
2241
+
2242
+ ### `searchChildrenForParent`
2243
+
2244
+ Searches children for a parent holon.
2245
+
2246
+ **GET** `api/cosmic/search-children`
2247
+
2248
+ **Request**
2249
+
2250
+ Query parameters:
2251
+
2252
+ | Field | Type |
2253
+ | --- | --- |
2254
+ | `searchTerm` | `string` |
2255
+ | `parentId` | `Guid` |
2256
+ | `parentHolonType` | `string` |
2257
+ | `childHolonType` | `string` |
2258
+
2259
+ **Response**
2260
+
2261
+ Standard `OASISResult` envelope (see top of this page) with:
2262
+
2263
+ `result` type: `IActionResult` (not part of the request/response payload).
2264
+
2265
+ **Example**
2266
+
2267
+ ```js
2268
+ const { isError, message, result } = await star.cosmic.searchChildrenForParent({
2269
+ searchTerm: 'example string',
2270
+ parentId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
2271
+ parentHolonType: 'example string',
2272
+ childHolonType: 'example string'
2273
+ });
2274
+ if (isError) throw new Error(message);
2275
+ console.log(result);
2276
+ ```
2277
+
2278
+ Example response:
2279
+
2280
+ ```json
2281
+ {
2282
+ "isError": false,
2283
+ "message": "",
2284
+ "result": null
2285
+ }
2286
+ ```
2287
+
2288
+ ---
2289
+
2290
+ ### `searchHolonsForParent`
2291
+
2292
+ Searches holons for a parent (async).
2293
+
2294
+ **GET** `api/cosmic/search-holons`
2295
+
2296
+ **Request**
2297
+
2298
+ Query parameters:
2299
+
2300
+ | Field | Type |
2301
+ | --- | --- |
2302
+ | `searchTerm` | `string` |
2303
+ | `parentId` | `Guid` |
2304
+ | `parentHolonType` | `string` |
2305
+ | `childHolonType` | `string` |
2306
+
2307
+ **Response**
2308
+
2309
+ Standard `OASISResult` envelope (see top of this page) with:
2310
+
2311
+ `result` type: `IActionResult` (not part of the request/response payload).
2312
+
2313
+ **Example**
2314
+
2315
+ ```js
2316
+ const { isError, message, result } = await star.cosmic.searchHolonsForParent({
2317
+ searchTerm: 'example string',
2318
+ parentId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
2319
+ parentHolonType: 'example string',
2320
+ childHolonType: 'example string'
2321
+ });
2322
+ if (isError) throw new Error(message);
2323
+ console.log(result);
2324
+ ```
2325
+
2326
+ Example response:
2327
+
2328
+ ```json
2329
+ {
2330
+ "isError": false,
2331
+ "message": "",
2332
+ "result": null
2333
+ }
2334
+ ```
2335
+
2336
+ ---
2337
+
2338
+ ### `searchHolonsForParentSync`
2339
+
2340
+ Searches holons for a parent (synchronous).
2341
+
2342
+ **GET** `api/cosmic/search-holons-sync`
2343
+
2344
+ **Request**
2345
+
2346
+ Query parameters:
2347
+
2348
+ | Field | Type |
2349
+ | --- | --- |
2350
+ | `searchTerm` | `string` |
2351
+ | `parentId` | `Guid` |
2352
+ | `parentHolonType` | `string` |
2353
+ | `childHolonType` | `string` |
2354
+ | `searchOnlyForCurrentAvatar` | `bool (optional)` |
2355
+ | `providerType` | `ProviderType (optional)` |
2356
+
2357
+ **Response**
2358
+
2359
+ Standard `OASISResult` envelope (see top of this page) with:
2360
+
2361
+ `result` type: `IHolon` (array)
2362
+
2363
+ | Field | Type |
2364
+ | --- | --- |
2365
+ | `CreatedOASISType` | `EnumValue<OASISType>` |
2366
+ | `CreatedProviderType` | `EnumValue<ProviderType>` |
2367
+ | `GlobalHolonData` | `GlobalHolonData` |
2368
+ | `InstanceSavedOnProviderType` | `EnumValue<ProviderType>` |
2369
+ | `IsChanged` | `bool` |
2370
+ | `IsNewHolon` | `bool` |
2371
+ | `IsSaving` | `bool` |
2372
+ | `Original` | `IHolon` |
2373
+ | `PreviousVersionId` | `Guid` |
2374
+ | `PreviousVersionProviderUniqueStorageKey` | `Dictionary<ProviderType, string>` |
2375
+ | `ProviderMetaData` | `Dictionary<ProviderType, Dictionary<string, string>>` |
2376
+ | `ProviderUniqueStorageKey` | `Dictionary<ProviderType, string>` |
2377
+ | `Nodes` | `IList<INode>` |
2378
+ | `ParentOmniverseId` | `Guid` |
2379
+ | `ParentOmniverse` | `IOmiverse` |
2380
+ | `ParentMultiverseId` | `Guid` |
2381
+ | `ParentMultiverse` | `IMultiverse` |
2382
+ | `ParentUniverseId` | `Guid` |
2383
+ | `ParentUniverse` | `IUniverse` |
2384
+ | `ParentDimensionId` | `Guid` |
2385
+ | `ParentDimension` | `IDimension` |
2386
+ | `DimensionLevel` | `DimensionLevel` |
2387
+ | `SubDimensionLevel` | `SubDimensionLevel` |
2388
+ | `ParentGalaxyClusterId` | `Guid` |
2389
+ | `ParentGalaxyCluster` | `IGalaxyCluster` |
2390
+ | `ParentGalaxyId` | `Guid` |
2391
+ | `ParentGalaxy` | `IGalaxy` |
2392
+ | `ParentSolarSystemId` | `Guid` |
2393
+ | `ParentSolarSystem` | `ISolarSystem` |
2394
+ | `ParentGreatGrandSuperStarId` | `Guid` |
2395
+ | `ParentGreatGrandSuperStar` | `IGreatGrandSuperStar` |
2396
+ | `ParentGrandSuperStarId` | `Guid` |
2397
+ | `ParentGrandSuperStar` | `IGrandSuperStar` |
2398
+ | `ParentSuperStarId` | `Guid` |
2399
+ | `ParentSuperStar` | `ISuperStar` |
2400
+ | `ParentStarId` | `Guid` |
2401
+ | `ParentStar` | `IStar` |
2402
+ | `ParentPlanetId` | `Guid` |
2403
+ | `ParentPlanet` | `IPlanet` |
2404
+ | `ParentMoonId` | `Guid` |
2405
+ | `ParentMoon` | `IMoon` |
2406
+ | `ParentCelestialSpaceId` | `Guid` |
2407
+ | `ParentCelestialSpace` | `ICelestialSpace` |
2408
+ | `ParentCelestialBodyId` | `Guid` |
2409
+ | `ParentCelestialBody` | `ICelestialBody` |
2410
+ | `ParentZomeId` | `Guid` |
2411
+ | `ParentZome` | `IZome` |
2412
+
2413
+ **Example**
2414
+
2415
+ ```js
2416
+ const { isError, message, result } = await star.cosmic.searchHolonsForParentSync({
2417
+ searchTerm: 'example string',
2418
+ parentId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
2419
+ parentHolonType: 'example string',
2420
+ childHolonType: 'example string',
2421
+ searchOnlyForCurrentAvatar: true,
2422
+ providerType: '<providerType>'
2423
+ });
2424
+ if (isError) throw new Error(message);
2425
+ console.log(result);
2426
+ ```
2427
+
2428
+ Example response:
2429
+
2430
+ ```json
2431
+ {
2432
+ "isError": false,
2433
+ "message": "",
2434
+ "result": [{ "CreatedOASISType": { "Score": 1.0 }, "CreatedProviderType": { "Score": 1.0 }, "GlobalHolonData": { }, "InstanceSavedOnProviderType": {}, "IsChanged": true, "IsNewHolon": true, "IsSaving": true, "Original": {}, "PreviousVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PreviousVersionProviderUniqueStorageKey": { "<ProviderType>": "example string" }, "ProviderMetaData": { "<ProviderType>": { "<string>": "example string" } }, "ProviderUniqueStorageKey": { "<ProviderType>": "example string" }, "Nodes": [{ "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Parent": {}, "NodeName": "example string", "NodeType": { } }], "ParentOmniverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentOmniverse": { "GreatGrandSuperStar": { }, "Dimensions": { "EighthDimension": { }, "NinthDimension": { }, "TenthDimension": { }, "EleventhDimension": { }, "TwelfthDimension": { }, "CustomDimensions": [{ "DimensionLevel": { } }] }, "Multiverses": [{ "GrandSuperStar": { "Stars": [ /* <I> */ ] }, "Dimensions": { "FirstDimension": { "Universe": { "Dimensions": [], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] } }] }, "ParentMultiverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentMultiverse": {}, "ParentUniverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentUniverse": {}, "ParentDimensionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentDimension": {}, "DimensionLevel": {}, "SubDimensionLevel": { }, "ParentGalaxyClusterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGalaxyCluster": {}, "ParentGalaxyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGalaxy": {}, "ParentSolarSystemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentSolarSystem": {}, "ParentGreatGrandSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGreatGrandSuperStar": {}, "ParentGrandSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGrandSuperStar": {}, "ParentSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentSuperStar": {}, "ParentStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentStar": {}, "ParentPlanetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentPlanet": {}, "ParentMoonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentMoon": {}, "ParentCelestialSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentCelestialSpace": { "NearestStar": {}, "CelestialBodies": /* <ReadOnlyCollection<ICelestialBody>> */, "CelestialSpaces": /* <ReadOnlyCollection<ICelestialSpace>> */, "Children": /* <new ReadOnlyCollection<IHolon>> */ }, "ParentCelestialBodyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentCelestialBody": { "CelestialBodyCore": { "Holons": [], "Zomes": [{ "HoloNETClient": { "WebSocket": /* <WebSocket.WebSocket> */, "Logger": /* <ILogger> */, "HolochainVersion": { } }, "ZomeName": "example string", "Holons": [{ "GlobalHolonData": {}, "ProviderUniqueStorageKey": { "<ProviderType>": "example string" }, "ProviderMetaData": { "<ProviderType>": { "<string>": "example string" } }, "CustomKey": "example string", "IsNewHolon": true, "IsSaving": true, "PreviousVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PreviousVersionProviderUniqueStorageKey": { "<ProviderType>": "example string" }, "CreatedProviderType": {}, "InstanceSavedOnProviderType": {}, "CreatedOASISType": {}, "Nodes": [], "ParentOmniverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentOmniverse": {}, "ParentMultiverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentMultiverse": {}, "ParentUniverseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentUniverse": {}, "ParentDimensionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentDimension": {}, "DimensionLevel": {}, "SubDimensionLevel": {}, "ParentGalaxyClusterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGalaxyCluster": {}, "ParentGalaxyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGalaxy": {}, "ParentSolarSystemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentSolarSystem": {}, "ParentGreatGrandSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGreatGrandSuperStar": {}, "ParentGrandSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentGrandSuperStar": {}, "ParentSuperStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentSuperStar": {}, "ParentStarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentStar": {}, "ParentPlanetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentPlanet": {}, "ParentMoonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentMoon": {}, "ParentCelestialSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentCelestialSpace": {}, "ParentCelestialBodyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentCelestialBody": {}, "ParentZomeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentZome": {} }] }] }, "CurrentOrbitAngleOfParentStar": 1, "Density": 1, "DistanceFromParentStarInMetres": 1, "GravitaionalPull": 1, "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Mass": 1, "NumberActiveAvatars": 1, "NumberRegisteredAvatars": 1, "OrbitPeriod": 1, "OrbitPositionFromParentStar": 1, "ProviderUniqueStorageKey": { "<ProviderType>": "example string" }, "RotationPeriod": 1, "RotationSpeed": 1, "TiltAngle": 1, "Weight": 1 }, "ParentZomeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ParentZome": {} }]
2435
+ }
2436
+ ```
2437
+
2438
+ ---
2439
+
2440
+ ### `updateAsteroid`
2441
+
2442
+ Updates an Asteroid.
2443
+
2444
+ **PUT** `api/cosmic/asteroid`
2445
+
2446
+ **Request**
2447
+
2448
+ Body type: `IAsteroid`
2449
+
2450
+ _No fields._
2451
+
2452
+ **Response**
2453
+
2454
+ Standard `OASISResult` envelope (see top of this page) with:
2455
+
2456
+ `result` type: `IActionResult` (not part of the request/response payload).
2457
+
2458
+ **Example**
2459
+
2460
+ ```js
2461
+ const { isError, message, result } = await star.cosmic.updateAsteroid({
2462
+ saveChildren: true,
2463
+ recursive: true,
2464
+ maxChildDepth: 1,
2465
+ continueOnError: true,
2466
+ saveChildrenOnProvider: true,
2467
+ providerType: '<providerType>'
2468
+ });
2469
+ if (isError) throw new Error(message);
2470
+ console.log(result);
2471
+ ```
2472
+
2473
+ Example response:
2474
+
2475
+ ```json
2476
+ {
2477
+ "isError": false,
2478
+ "message": "",
2479
+ "result": null
2480
+ }
2481
+ ```
2482
+
2483
+ ---
2484
+
2485
+ ### `updateBlackHole`
2486
+
2487
+ Updates a BlackHole.
2488
+
2489
+ **PUT** `api/cosmic/blackhole`
2490
+
2491
+ **Request**
2492
+
2493
+ Body type: `IBlackHole`
2494
+
2495
+ _No fields._
2496
+
2497
+ **Response**
2498
+
2499
+ Standard `OASISResult` envelope (see top of this page) with:
2500
+
2501
+ `result` type: `IActionResult` (not part of the request/response payload).
2502
+
2503
+ **Example**
2504
+
2505
+ ```js
2506
+ const { isError, message, result } = await star.cosmic.updateBlackHole({
2507
+ saveChildren: true,
2508
+ recursive: true,
2509
+ maxChildDepth: 1,
2510
+ continueOnError: true,
2511
+ saveChildrenOnProvider: true,
2512
+ providerType: '<providerType>'
2513
+ });
2514
+ if (isError) throw new Error(message);
2515
+ console.log(result);
2516
+ ```
2517
+
2518
+ Example response:
2519
+
2520
+ ```json
2521
+ {
2522
+ "isError": false,
2523
+ "message": "",
2524
+ "result": null
2525
+ }
2526
+ ```
2527
+
2528
+ ---
2529
+
2530
+ ### `updateComet`
2531
+
2532
+ Updates a Comet.
2533
+
2534
+ **PUT** `api/cosmic/comet`
2535
+
2536
+ **Request**
2537
+
2538
+ Body type: `IComet`
2539
+
2540
+ _No fields._
2541
+
2542
+ **Response**
2543
+
2544
+ Standard `OASISResult` envelope (see top of this page) with:
2545
+
2546
+ `result` type: `IActionResult` (not part of the request/response payload).
2547
+
2548
+ **Example**
2549
+
2550
+ ```js
2551
+ const { isError, message, result } = await star.cosmic.updateComet({
2552
+ saveChildren: true,
2553
+ recursive: true,
2554
+ maxChildDepth: 1,
2555
+ continueOnError: true,
2556
+ saveChildrenOnProvider: true,
2557
+ providerType: '<providerType>'
2558
+ });
2559
+ if (isError) throw new Error(message);
2560
+ console.log(result);
2561
+ ```
2562
+
2563
+ Example response:
2564
+
2565
+ ```json
2566
+ {
2567
+ "isError": false,
2568
+ "message": "",
2569
+ "result": null
2570
+ }
2571
+ ```
2572
+
2573
+ ---
2574
+
2575
+ ### `updateCosmicRay`
2576
+
2577
+ Updates a CosmicRay.
2578
+
2579
+ **PUT** `api/cosmic/cosmic-ray`
2580
+
2581
+ **Request**
2582
+
2583
+ Body type: `ICosmicRay`
2584
+
2585
+ _No fields._
2586
+
2587
+ **Response**
2588
+
2589
+ Standard `OASISResult` envelope (see top of this page) with:
2590
+
2591
+ `result` type: `IActionResult` (not part of the request/response payload).
2592
+
2593
+ **Example**
2594
+
2595
+ ```js
2596
+ const { isError, message, result } = await star.cosmic.updateCosmicRay({
2597
+ saveChildren: true,
2598
+ recursive: true,
2599
+ maxChildDepth: 1,
2600
+ continueOnError: true,
2601
+ saveChildrenOnProvider: true,
2602
+ providerType: '<providerType>'
2603
+ });
2604
+ if (isError) throw new Error(message);
2605
+ console.log(result);
2606
+ ```
2607
+
2608
+ Example response:
2609
+
2610
+ ```json
2611
+ {
2612
+ "isError": false,
2613
+ "message": "",
2614
+ "result": null
2615
+ }
2616
+ ```
2617
+
2618
+ ---
2619
+
2620
+ ### `updateCosmicWave`
2621
+
2622
+ Updates a CosmicWave.
2623
+
2624
+ **PUT** `api/cosmic/cosmic-wave`
2625
+
2626
+ **Request**
2627
+
2628
+ Body type: `ICosmicWave`
2629
+
2630
+ _No fields._
2631
+
2632
+ **Response**
2633
+
2634
+ Standard `OASISResult` envelope (see top of this page) with:
2635
+
2636
+ `result` type: `IActionResult` (not part of the request/response payload).
2637
+
2638
+ **Example**
2639
+
2640
+ ```js
2641
+ const { isError, message, result } = await star.cosmic.updateCosmicWave({
2642
+ saveChildren: true,
2643
+ recursive: true,
2644
+ maxChildDepth: 1,
2645
+ continueOnError: true,
2646
+ saveChildrenOnProvider: true,
2647
+ providerType: '<providerType>'
2648
+ });
2649
+ if (isError) throw new Error(message);
2650
+ console.log(result);
2651
+ ```
2652
+
2653
+ Example response:
2654
+
2655
+ ```json
2656
+ {
2657
+ "isError": false,
2658
+ "message": "",
2659
+ "result": null
2660
+ }
2661
+ ```
2662
+
2663
+ ---
2664
+
2665
+ ### `updateGalaxy`
2666
+
2667
+ Updates a Galaxy.
2668
+
2669
+ **PUT** `api/cosmic/galaxy`
2670
+
2671
+ **Request**
2672
+
2673
+ Body type: `IGalaxy`
2674
+
2675
+ | Field | Type |
2676
+ | --- | --- |
2677
+ | `SuperStar` | `ISuperStar` |
2678
+ | `SolarSystems` | `List<ISolarSystem>` |
2679
+ | `Nebulas` | `List<INebula>` |
2680
+ | `Stars` | `List<IStar>` |
2681
+ | `Planets` | `List<IPlanet>` |
2682
+ | `Asteroids` | `List<IAsteroid>` |
2683
+ | `Comets` | `List<IComet>` |
2684
+ | `Meteroids` | `List<IMeteroid>` |
2685
+
2686
+ **Response**
2687
+
2688
+ Standard `OASISResult` envelope (see top of this page) with:
2689
+
2690
+ `result` type: `IActionResult` (not part of the request/response payload).
2691
+
2692
+ **Example**
2693
+
2694
+ ```js
2695
+ const { isError, message, result } = await star.cosmic.updateGalaxy({
2696
+ saveChildren: true,
2697
+ recursive: true,
2698
+ maxChildDepth: 1,
2699
+ continueOnError: true,
2700
+ saveChildrenOnProvider: true,
2701
+ providerType: '<providerType>',
2702
+ superStar: { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] },
2703
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
2704
+ nebulas: [{ }],
2705
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
2706
+ planets: [{ "Moons": [{ }] }],
2707
+ asteroids: [{ }],
2708
+ comets: [{ }],
2709
+ meteroids: [{ }]
2710
+ });
2711
+ if (isError) throw new Error(message);
2712
+ console.log(result);
2713
+ ```
2714
+
2715
+ Example response:
2716
+
2717
+ ```json
2718
+ {
2719
+ "isError": false,
2720
+ "message": "",
2721
+ "result": null
2722
+ }
2723
+ ```
2724
+
2725
+ ---
2726
+
2727
+ ### `updateGalaxyCluster`
2728
+
2729
+ Updates a GalaxyCluster.
2730
+
2731
+ **PUT** `api/cosmic/galaxy-cluster`
2732
+
2733
+ **Request**
2734
+
2735
+ Body type: `IGalaxyCluster`
2736
+
2737
+ | Field | Type |
2738
+ | --- | --- |
2739
+ | `Galaxies` | `List<IGalaxy>` |
2740
+ | `SolarSystems` | `List<ISolarSystem>` |
2741
+ | `Stars` | `List<IStar>` |
2742
+ | `Planets` | `List<IPlanet>` |
2743
+ | `Asteroids` | `List<IAsteroid>` |
2744
+ | `Comets` | `List<IComet>` |
2745
+ | `Meteroids` | `List<IMeteroid>` |
2746
+ | `IsSuperCluster` | `bool` |
2747
+
2748
+ **Response**
2749
+
2750
+ Standard `OASISResult` envelope (see top of this page) with:
2751
+
2752
+ `result` type: `IActionResult` (not part of the request/response payload).
2753
+
2754
+ **Example**
2755
+
2756
+ ```js
2757
+ const { isError, message, result } = await star.cosmic.updateGalaxyCluster({
2758
+ saveChildren: true,
2759
+ recursive: true,
2760
+ maxChildDepth: 1,
2761
+ continueOnError: true,
2762
+ saveChildrenOnProvider: true,
2763
+ providerType: '<providerType>',
2764
+ galaxies: [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }],
2765
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
2766
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
2767
+ planets: [{ "Moons": [{ }] }],
2768
+ asteroids: [{ }],
2769
+ comets: [{ }],
2770
+ meteroids: [{ }],
2771
+ isSuperCluster: true
2772
+ });
2773
+ if (isError) throw new Error(message);
2774
+ console.log(result);
2775
+ ```
2776
+
2777
+ Example response:
2778
+
2779
+ ```json
2780
+ {
2781
+ "isError": false,
2782
+ "message": "",
2783
+ "result": null
2784
+ }
2785
+ ```
2786
+
2787
+ ---
2788
+
2789
+ ### `updateGravitationalWave`
2790
+
2791
+ Updates a GravitationalWave.
2792
+
2793
+ **PUT** `api/cosmic/gravitational-wave`
2794
+
2795
+ **Request**
2796
+
2797
+ Body type: `IGravitationalWave`
2798
+
2799
+ _No fields._
2800
+
2801
+ **Response**
2802
+
2803
+ Standard `OASISResult` envelope (see top of this page) with:
2804
+
2805
+ `result` type: `IActionResult` (not part of the request/response payload).
2806
+
2807
+ **Example**
2808
+
2809
+ ```js
2810
+ const { isError, message, result } = await star.cosmic.updateGravitationalWave({
2811
+ saveChildren: true,
2812
+ recursive: true,
2813
+ maxChildDepth: 1,
2814
+ continueOnError: true,
2815
+ saveChildrenOnProvider: true,
2816
+ providerType: '<providerType>'
2817
+ });
2818
+ if (isError) throw new Error(message);
2819
+ console.log(result);
2820
+ ```
2821
+
2822
+ Example response:
2823
+
2824
+ ```json
2825
+ {
2826
+ "isError": false,
2827
+ "message": "",
2828
+ "result": null
2829
+ }
2830
+ ```
2831
+
2832
+ ---
2833
+
2834
+ ### `updateMeteroid`
2835
+
2836
+ Updates a Meteroid.
2837
+
2838
+ **PUT** `api/cosmic/meteroid`
2839
+
2840
+ **Request**
2841
+
2842
+ Body type: `IMeteroid`
2843
+
2844
+ _No fields._
2845
+
2846
+ **Response**
2847
+
2848
+ Standard `OASISResult` envelope (see top of this page) with:
2849
+
2850
+ `result` type: `IActionResult` (not part of the request/response payload).
2851
+
2852
+ **Example**
2853
+
2854
+ ```js
2855
+ const { isError, message, result } = await star.cosmic.updateMeteroid({
2856
+ saveChildren: true,
2857
+ recursive: true,
2858
+ maxChildDepth: 1,
2859
+ continueOnError: true,
2860
+ saveChildrenOnProvider: true,
2861
+ providerType: '<providerType>'
2862
+ });
2863
+ if (isError) throw new Error(message);
2864
+ console.log(result);
2865
+ ```
2866
+
2867
+ Example response:
2868
+
2869
+ ```json
2870
+ {
2871
+ "isError": false,
2872
+ "message": "",
2873
+ "result": null
2874
+ }
2875
+ ```
2876
+
2877
+ ---
2878
+
2879
+ ### `updateMoon`
2880
+
2881
+ Updates a Moon.
2882
+
2883
+ **PUT** `api/cosmic/moon`
2884
+
2885
+ **Request**
2886
+
2887
+ Body type: `IMoon`
2888
+
2889
+ _No fields._
2890
+
2891
+ **Response**
2892
+
2893
+ Standard `OASISResult` envelope (see top of this page) with:
2894
+
2895
+ `result` type: `IActionResult` (not part of the request/response payload).
2896
+
2897
+ **Example**
2898
+
2899
+ ```js
2900
+ const { isError, message, result } = await star.cosmic.updateMoon({
2901
+ saveChildren: true,
2902
+ recursive: true,
2903
+ maxChildDepth: 1,
2904
+ continueOnError: true,
2905
+ saveChildrenOnProvider: true,
2906
+ providerType: '<providerType>'
2907
+ });
2908
+ if (isError) throw new Error(message);
2909
+ console.log(result);
2910
+ ```
2911
+
2912
+ Example response:
2913
+
2914
+ ```json
2915
+ {
2916
+ "isError": false,
2917
+ "message": "",
2918
+ "result": null
2919
+ }
2920
+ ```
2921
+
2922
+ ---
2923
+
2924
+ ### `updateMultiverse`
2925
+
2926
+ Updates a Multiverse.
2927
+
2928
+ **PUT** `api/cosmic/multiverse`
2929
+
2930
+ **Request**
2931
+
2932
+ Body type: `IMultiverse`
2933
+
2934
+ | Field | Type |
2935
+ | --- | --- |
2936
+ | `GrandSuperStar` | `IGrandSuperStar` |
2937
+ | `Dimensions` | `IMultiverseDimensions` |
2938
+
2939
+ **Response**
2940
+
2941
+ Standard `OASISResult` envelope (see top of this page) with:
2942
+
2943
+ `result` type: `IActionResult` (not part of the request/response payload).
2944
+
2945
+ **Example**
2946
+
2947
+ ```js
2948
+ const { isError, message, result } = await star.cosmic.updateMultiverse({
2949
+ saveChildren: true,
2950
+ recursive: true,
2951
+ maxChildDepth: 1,
2952
+ continueOnError: true,
2953
+ saveChildrenOnProvider: true,
2954
+ providerType: '<providerType>',
2955
+ grandSuperStar: { "Stars": [ /* <I> */ ] },
2956
+ dimensions: { "FirstDimension": { "Universe": { "Dimensions": [{ "DimensionLevel": { } }], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] }
2957
+ });
2958
+ if (isError) throw new Error(message);
2959
+ console.log(result);
2960
+ ```
2961
+
2962
+ Example response:
2963
+
2964
+ ```json
2965
+ {
2966
+ "isError": false,
2967
+ "message": "",
2968
+ "result": null
2969
+ }
2970
+ ```
2971
+
2972
+ ---
2973
+
2974
+ ### `updateNebula`
2975
+
2976
+ Updates a Nebula.
2977
+
2978
+ **PUT** `api/cosmic/nebula`
2979
+
2980
+ **Request**
2981
+
2982
+ Body type: `INebula`
2983
+
2984
+ _No fields._
2985
+
2986
+ **Response**
2987
+
2988
+ Standard `OASISResult` envelope (see top of this page) with:
2989
+
2990
+ `result` type: `IActionResult` (not part of the request/response payload).
2991
+
2992
+ **Example**
2993
+
2994
+ ```js
2995
+ const { isError, message, result } = await star.cosmic.updateNebula({
2996
+ saveChildren: true,
2997
+ recursive: true,
2998
+ maxChildDepth: 1,
2999
+ continueOnError: true,
3000
+ saveChildrenOnProvider: true,
3001
+ providerType: '<providerType>'
3002
+ });
3003
+ if (isError) throw new Error(message);
3004
+ console.log(result);
3005
+ ```
3006
+
3007
+ Example response:
3008
+
3009
+ ```json
3010
+ {
3011
+ "isError": false,
3012
+ "message": "",
3013
+ "result": null
3014
+ }
3015
+ ```
3016
+
3017
+ ---
3018
+
3019
+ ### `updateOmniverse`
3020
+
3021
+ Updates an Omniverse.
3022
+
3023
+ **PUT** `api/cosmic/omniverse`
3024
+
3025
+ **Request**
3026
+
3027
+ Body type: `IOmiverse`
3028
+
3029
+ | Field | Type |
3030
+ | --- | --- |
3031
+ | `GreatGrandSuperStar` | `IGreatGrandSuperStar` |
3032
+ | `Dimensions` | `IOmniverseDimensions` |
3033
+ | `Multiverses` | `List<IMultiverse>` |
3034
+
3035
+ **Response**
3036
+
3037
+ Standard `OASISResult` envelope (see top of this page) with:
3038
+
3039
+ `result` type: `IActionResult` (not part of the request/response payload).
3040
+
3041
+ **Example**
3042
+
3043
+ ```js
3044
+ const { isError, message, result } = await star.cosmic.updateOmniverse({
3045
+ saveChildren: true,
3046
+ recursive: true,
3047
+ maxChildDepth: 1,
3048
+ continueOnError: true,
3049
+ saveChildrenOnProvider: true,
3050
+ providerType: '<providerType>',
3051
+ greatGrandSuperStar: { },
3052
+ dimensions: { "EighthDimension": { }, "NinthDimension": { }, "TenthDimension": { }, "EleventhDimension": { }, "TwelfthDimension": { }, "CustomDimensions": [{ "DimensionLevel": { } }] },
3053
+ multiverses: [{ "GrandSuperStar": { "Stars": [ /* <I> */ ] }, "Dimensions": { "FirstDimension": { "Universe": { "Dimensions": [{ "DimensionLevel": { } }], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] } }, "SecondDimension": { "Universe": {} }, "ThirdDimension": { "UniversePrime": {}, "MagicVerse": {}, "ParallelUniverses": [] }, "FourthDimension": { "Universe": {} }, "FifthDimension": { "Universe": {} }, "SixthDimension": { "Universe": {} }, "SeventhDimension": { "Universe": {} }, "CustomDimensions": [] } }]
3054
+ });
3055
+ if (isError) throw new Error(message);
3056
+ console.log(result);
3057
+ ```
3058
+
3059
+ Example response:
3060
+
3061
+ ```json
3062
+ {
3063
+ "isError": false,
3064
+ "message": "",
3065
+ "result": null
3066
+ }
3067
+ ```
3068
+
3069
+ ---
3070
+
3071
+ ### `updatePlanet`
3072
+
3073
+ Updates a Planet.
3074
+
3075
+ **PUT** `api/cosmic/planet`
3076
+
3077
+ **Request**
3078
+
3079
+ Body type: `IPlanet`
3080
+
3081
+ | Field | Type |
3082
+ | --- | --- |
3083
+ | `Moons` | `List<IMoon>` |
3084
+
3085
+ **Response**
3086
+
3087
+ Standard `OASISResult` envelope (see top of this page) with:
3088
+
3089
+ `result` type: `IActionResult` (not part of the request/response payload).
3090
+
3091
+ **Example**
3092
+
3093
+ ```js
3094
+ const { isError, message, result } = await star.cosmic.updatePlanet({
3095
+ saveChildren: true,
3096
+ recursive: true,
3097
+ maxChildDepth: 1,
3098
+ continueOnError: true,
3099
+ saveChildrenOnProvider: true,
3100
+ providerType: '<providerType>',
3101
+ moons: [{ }]
3102
+ });
3103
+ if (isError) throw new Error(message);
3104
+ console.log(result);
3105
+ ```
3106
+
3107
+ Example response:
3108
+
3109
+ ```json
3110
+ {
3111
+ "isError": false,
3112
+ "message": "",
3113
+ "result": null
3114
+ }
3115
+ ```
3116
+
3117
+ ---
3118
+
3119
+ ### `updatePortal`
3120
+
3121
+ Updates a Portal.
3122
+
3123
+ **PUT** `api/cosmic/portal`
3124
+
3125
+ **Request**
3126
+
3127
+ Body type: `IPortal`
3128
+
3129
+ _No fields._
3130
+
3131
+ **Response**
3132
+
3133
+ Standard `OASISResult` envelope (see top of this page) with:
3134
+
3135
+ `result` type: `IActionResult` (not part of the request/response payload).
3136
+
3137
+ **Example**
3138
+
3139
+ ```js
3140
+ const { isError, message, result } = await star.cosmic.updatePortal({
3141
+ saveChildren: true,
3142
+ recursive: true,
3143
+ maxChildDepth: 1,
3144
+ continueOnError: true,
3145
+ saveChildrenOnProvider: true,
3146
+ providerType: '<providerType>'
3147
+ });
3148
+ if (isError) throw new Error(message);
3149
+ console.log(result);
3150
+ ```
3151
+
3152
+ Example response:
3153
+
3154
+ ```json
3155
+ {
3156
+ "isError": false,
3157
+ "message": "",
3158
+ "result": null
3159
+ }
3160
+ ```
3161
+
3162
+ ---
3163
+
3164
+ ### `updateSolarSystem`
3165
+
3166
+ Updates a SolarSystem.
3167
+
3168
+ **PUT** `api/cosmic/solar-system`
3169
+
3170
+ **Request**
3171
+
3172
+ Body type: `ISolarSystem`
3173
+
3174
+ | Field | Type |
3175
+ | --- | --- |
3176
+ | `Star` | `IStar` |
3177
+ | `Planets` | `List<IPlanet>` |
3178
+ | `Asteroids` | `List<IAsteroid>` |
3179
+ | `Comets` | `List<IComet>` |
3180
+ | `Meteroids` | `List<IMeteroid>` |
3181
+
3182
+ **Response**
3183
+
3184
+ Standard `OASISResult` envelope (see top of this page) with:
3185
+
3186
+ `result` type: `IActionResult` (not part of the request/response payload).
3187
+
3188
+ **Example**
3189
+
3190
+ ```js
3191
+ const { isError, message, result } = await star.cosmic.updateSolarSystem({
3192
+ saveChildren: true,
3193
+ recursive: true,
3194
+ maxChildDepth: 1,
3195
+ continueOnError: true,
3196
+ saveChildrenOnProvider: true,
3197
+ providerType: '<providerType>',
3198
+ star: { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } },
3199
+ planets: [{ "Moons": [{ }] }],
3200
+ asteroids: [{ }],
3201
+ comets: [{ }],
3202
+ meteroids: [{ }]
3203
+ });
3204
+ if (isError) throw new Error(message);
3205
+ console.log(result);
3206
+ ```
3207
+
3208
+ Example response:
3209
+
3210
+ ```json
3211
+ {
3212
+ "isError": false,
3213
+ "message": "",
3214
+ "result": null
3215
+ }
3216
+ ```
3217
+
3218
+ ---
3219
+
3220
+ ### `updateSpaceTimeAbnormally`
3221
+
3222
+ Updates a SpaceTimeAbnormally.
3223
+
3224
+ **PUT** `api/cosmic/spacetime-abnormally`
3225
+
3226
+ **Request**
3227
+
3228
+ Body type: `ISpaceTimeAbnormally`
3229
+
3230
+ _No fields._
3231
+
3232
+ **Response**
3233
+
3234
+ Standard `OASISResult` envelope (see top of this page) with:
3235
+
3236
+ `result` type: `IActionResult` (not part of the request/response payload).
3237
+
3238
+ **Example**
3239
+
3240
+ ```js
3241
+ const { isError, message, result } = await star.cosmic.updateSpaceTimeAbnormally({
3242
+ saveChildren: true,
3243
+ recursive: true,
3244
+ maxChildDepth: 1,
3245
+ continueOnError: true,
3246
+ saveChildrenOnProvider: true,
3247
+ providerType: '<providerType>'
3248
+ });
3249
+ if (isError) throw new Error(message);
3250
+ console.log(result);
3251
+ ```
3252
+
3253
+ Example response:
3254
+
3255
+ ```json
3256
+ {
3257
+ "isError": false,
3258
+ "message": "",
3259
+ "result": null
3260
+ }
3261
+ ```
3262
+
3263
+ ---
3264
+
3265
+ ### `updateSpaceTimeDistortion`
3266
+
3267
+ Updates a SpaceTimeDistortion.
3268
+
3269
+ **PUT** `api/cosmic/spacetime-distortion`
3270
+
3271
+ **Request**
3272
+
3273
+ Body type: `ISpaceTimeDistortion`
3274
+
3275
+ _No fields._
3276
+
3277
+ **Response**
3278
+
3279
+ Standard `OASISResult` envelope (see top of this page) with:
3280
+
3281
+ `result` type: `IActionResult` (not part of the request/response payload).
3282
+
3283
+ **Example**
3284
+
3285
+ ```js
3286
+ const { isError, message, result } = await star.cosmic.updateSpaceTimeDistortion({
3287
+ saveChildren: true,
3288
+ recursive: true,
3289
+ maxChildDepth: 1,
3290
+ continueOnError: true,
3291
+ saveChildrenOnProvider: true,
3292
+ providerType: '<providerType>'
3293
+ });
3294
+ if (isError) throw new Error(message);
3295
+ console.log(result);
3296
+ ```
3297
+
3298
+ Example response:
3299
+
3300
+ ```json
3301
+ {
3302
+ "isError": false,
3303
+ "message": "",
3304
+ "result": null
3305
+ }
3306
+ ```
3307
+
3308
+ ---
3309
+
3310
+ ### `updateStar`
3311
+
3312
+ Updates a Star.
3313
+
3314
+ **PUT** `api/cosmic/star`
3315
+
3316
+ **Request**
3317
+
3318
+ Body type: `IStar`
3319
+
3320
+ | Field | Type |
3321
+ | --- | --- |
3322
+ | `Luminosity` | `int` |
3323
+ | `StarType` | `StarType` |
3324
+ | `StarClassification` | `StarClassification` |
3325
+ | `StarBinaryType` | `StarBinaryType` |
3326
+
3327
+ **Response**
3328
+
3329
+ Standard `OASISResult` envelope (see top of this page) with:
3330
+
3331
+ `result` type: `IActionResult` (not part of the request/response payload).
3332
+
3333
+ **Example**
3334
+
3335
+ ```js
3336
+ const { isError, message, result } = await star.cosmic.updateStar({
3337
+ saveChildren: true,
3338
+ recursive: true,
3339
+ maxChildDepth: 1,
3340
+ continueOnError: true,
3341
+ saveChildrenOnProvider: true,
3342
+ providerType: '<providerType>',
3343
+ luminosity: 1,
3344
+ starType: { },
3345
+ starClassification: { },
3346
+ starBinaryType: { }
3347
+ });
3348
+ if (isError) throw new Error(message);
3349
+ console.log(result);
3350
+ ```
3351
+
3352
+ Example response:
3353
+
3354
+ ```json
3355
+ {
3356
+ "isError": false,
3357
+ "message": "",
3358
+ "result": null
3359
+ }
3360
+ ```
3361
+
3362
+ ---
3363
+
3364
+ ### `updateStarDust`
3365
+
3366
+ Updates a StarDust.
3367
+
3368
+ **PUT** `api/cosmic/stardust`
3369
+
3370
+ **Request**
3371
+
3372
+ Body type: `IStarDust`
3373
+
3374
+ _No fields._
3375
+
3376
+ **Response**
3377
+
3378
+ Standard `OASISResult` envelope (see top of this page) with:
3379
+
3380
+ `result` type: `IActionResult` (not part of the request/response payload).
3381
+
3382
+ **Example**
3383
+
3384
+ ```js
3385
+ const { isError, message, result } = await star.cosmic.updateStarDust({
3386
+ saveChildren: true,
3387
+ recursive: true,
3388
+ maxChildDepth: 1,
3389
+ continueOnError: true,
3390
+ saveChildrenOnProvider: true,
3391
+ providerType: '<providerType>'
3392
+ });
3393
+ if (isError) throw new Error(message);
3394
+ console.log(result);
3395
+ ```
3396
+
3397
+ Example response:
3398
+
3399
+ ```json
3400
+ {
3401
+ "isError": false,
3402
+ "message": "",
3403
+ "result": null
3404
+ }
3405
+ ```
3406
+
3407
+ ---
3408
+
3409
+ ### `updateStarGate`
3410
+
3411
+ Updates a StarGate.
3412
+
3413
+ **PUT** `api/cosmic/stargate`
3414
+
3415
+ **Request**
3416
+
3417
+ Body type: `IStarGate`
3418
+
3419
+ _No fields._
3420
+
3421
+ **Response**
3422
+
3423
+ Standard `OASISResult` envelope (see top of this page) with:
3424
+
3425
+ `result` type: `IActionResult` (not part of the request/response payload).
3426
+
3427
+ **Example**
3428
+
3429
+ ```js
3430
+ const { isError, message, result } = await star.cosmic.updateStarGate({
3431
+ saveChildren: true,
3432
+ recursive: true,
3433
+ maxChildDepth: 1,
3434
+ continueOnError: true,
3435
+ saveChildrenOnProvider: true,
3436
+ providerType: '<providerType>'
3437
+ });
3438
+ if (isError) throw new Error(message);
3439
+ console.log(result);
3440
+ ```
3441
+
3442
+ Example response:
3443
+
3444
+ ```json
3445
+ {
3446
+ "isError": false,
3447
+ "message": "",
3448
+ "result": null
3449
+ }
3450
+ ```
3451
+
3452
+ ---
3453
+
3454
+ ### `updateSuperVerse`
3455
+
3456
+ Updates a SuperVerse.
3457
+
3458
+ **PUT** `api/cosmic/superverse`
3459
+
3460
+ **Request**
3461
+
3462
+ Body type: `ISuperVerse`
3463
+
3464
+ | Field | Type |
3465
+ | --- | --- |
3466
+ | `Universes` | `List<IUniverse>` |
3467
+
3468
+ **Response**
3469
+
3470
+ Standard `OASISResult` envelope (see top of this page) with:
3471
+
3472
+ `result` type: `IActionResult` (not part of the request/response payload).
3473
+
3474
+ **Example**
3475
+
3476
+ ```js
3477
+ const { isError, message, result } = await star.cosmic.updateSuperVerse({
3478
+ saveChildren: true,
3479
+ recursive: true,
3480
+ maxChildDepth: 1,
3481
+ continueOnError: true,
3482
+ saveChildrenOnProvider: true,
3483
+ providerType: '<providerType>',
3484
+ universes: [{ "Dimensions": [{ "DimensionLevel": { } }], "GalaxyClusters": [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }], "SolarSystems": [], "Nebulas": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }]
3485
+ });
3486
+ if (isError) throw new Error(message);
3487
+ console.log(result);
3488
+ ```
3489
+
3490
+ Example response:
3491
+
3492
+ ```json
3493
+ {
3494
+ "isError": false,
3495
+ "message": "",
3496
+ "result": null
3497
+ }
3498
+ ```
3499
+
3500
+ ---
3501
+
3502
+ ### `updateTemporalRift`
3503
+
3504
+ Updates a TemporalRift.
3505
+
3506
+ **PUT** `api/cosmic/temporal-rift`
3507
+
3508
+ **Request**
3509
+
3510
+ Body type: `ITemporalRift`
3511
+
3512
+ _No fields._
3513
+
3514
+ **Response**
3515
+
3516
+ Standard `OASISResult` envelope (see top of this page) with:
3517
+
3518
+ `result` type: `IActionResult` (not part of the request/response payload).
3519
+
3520
+ **Example**
3521
+
3522
+ ```js
3523
+ const { isError, message, result } = await star.cosmic.updateTemporalRift({
3524
+ saveChildren: true,
3525
+ recursive: true,
3526
+ maxChildDepth: 1,
3527
+ continueOnError: true,
3528
+ saveChildrenOnProvider: true,
3529
+ providerType: '<providerType>'
3530
+ });
3531
+ if (isError) throw new Error(message);
3532
+ console.log(result);
3533
+ ```
3534
+
3535
+ Example response:
3536
+
3537
+ ```json
3538
+ {
3539
+ "isError": false,
3540
+ "message": "",
3541
+ "result": null
3542
+ }
3543
+ ```
3544
+
3545
+ ---
3546
+
3547
+ ### `updateUniverse`
3548
+
3549
+ Updates a Universe.
3550
+
3551
+ **PUT** `api/cosmic/universe`
3552
+
3553
+ **Request**
3554
+
3555
+ Body type: `IUniverse`
3556
+
3557
+ | Field | Type |
3558
+ | --- | --- |
3559
+ | `Dimensions` | `List<IDimension>` |
3560
+ | `GalaxyClusters` | `List<IGalaxyCluster>` |
3561
+ | `SolarSystems` | `List<ISolarSystem>` |
3562
+ | `Nebulas` | `List<INebula>` |
3563
+ | `Stars` | `List<IStar>` |
3564
+ | `Planets` | `List<IPlanet>` |
3565
+ | `Asteroids` | `List<IAsteroid>` |
3566
+ | `Comets` | `List<IComet>` |
3567
+ | `Meteroids` | `List<IMeteroid>` |
3568
+
3569
+ **Response**
3570
+
3571
+ Standard `OASISResult` envelope (see top of this page) with:
3572
+
3573
+ `result` type: `IActionResult` (not part of the request/response payload).
3574
+
3575
+ **Example**
3576
+
3577
+ ```js
3578
+ const { isError, message, result } = await star.cosmic.updateUniverse({
3579
+ saveChildren: true,
3580
+ recursive: true,
3581
+ maxChildDepth: 1,
3582
+ continueOnError: true,
3583
+ saveChildrenOnProvider: true,
3584
+ providerType: '<providerType>',
3585
+ dimensions: [{ "DimensionLevel": { } }],
3586
+ galaxyClusters: [{ "Galaxies": [{ "SuperStar": { "Stars": [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }] }, "SolarSystems": [{ "Star": {}, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }], "Nebulas": [{ }], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [] }], "SolarSystems": [], "Stars": [], "Planets": [], "Asteroids": [], "Comets": [], "Meteroids": [], "IsSuperCluster": true }],
3587
+ solarSystems: [{ "Star": { "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }, "Planets": [{ "Moons": [{ }] }], "Asteroids": [{ }], "Comets": [{ }], "Meteroids": [{ }] }],
3588
+ nebulas: [{ }],
3589
+ stars: [{ "Luminosity": 1, "StarType": { }, "StarClassification": { }, "StarBinaryType": { } }],
3590
+ planets: [{ "Moons": [{ }] }],
3591
+ asteroids: [{ }],
3592
+ comets: [{ }],
3593
+ meteroids: [{ }]
3594
+ });
3595
+ if (isError) throw new Error(message);
3596
+ console.log(result);
3597
+ ```
3598
+
3599
+ Example response:
3600
+
3601
+ ```json
3602
+ {
3603
+ "isError": false,
3604
+ "message": "",
3605
+ "result": null
3606
+ }
3607
+ ```
3608
+
3609
+ ---
3610
+
3611
+ ### `updateWormHole`
3612
+
3613
+ Updates a WormHole.
3614
+
3615
+ **PUT** `api/cosmic/wormhole`
3616
+
3617
+ **Request**
3618
+
3619
+ Body type: `IWormHole`
3620
+
3621
+ _No fields._
3622
+
3623
+ **Response**
3624
+
3625
+ Standard `OASISResult` envelope (see top of this page) with:
3626
+
3627
+ `result` type: `IActionResult` (not part of the request/response payload).
3628
+
3629
+ **Example**
3630
+
3631
+ ```js
3632
+ const { isError, message, result } = await star.cosmic.updateWormHole({
3633
+ saveChildren: true,
3634
+ recursive: true,
3635
+ maxChildDepth: 1,
3636
+ continueOnError: true,
3637
+ saveChildrenOnProvider: true,
3638
+ providerType: '<providerType>'
3639
+ });
3640
+ if (isError) throw new Error(message);
3641
+ console.log(result);
3642
+ ```
3643
+
3644
+ Example response:
3645
+
3646
+ ```json
3647
+ {
3648
+ "isError": false,
3649
+ "message": "",
3650
+ "result": null
3651
+ }
3652
+ ```
3653
+