@xyo-network/api-models 2.42.13 → 2.42.14

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 (2) hide show
  1. package/package.json +2 -5
  2. package/dist/docs.json +0 -1699
package/dist/docs.json DELETED
@@ -1,1699 +0,0 @@
1
- {
2
- "id": 0,
3
- "name": "@xyo-network/api-models",
4
- "kind": 1,
5
- "kindString": "Project",
6
- "flags": {},
7
- "originalName": "",
8
- "children": [
9
- {
10
- "id": 1,
11
- "name": "XyoApiConfig",
12
- "kind": 256,
13
- "kindString": "Interface",
14
- "flags": {},
15
- "children": [
16
- {
17
- "id": 2,
18
- "name": "apiDomain",
19
- "kind": 1024,
20
- "kindString": "Property",
21
- "flags": {},
22
- "comment": {
23
- "summary": [],
24
- "blockTags": [
25
- {
26
- "tag": "@description",
27
- "content": [
28
- {
29
- "kind": "text",
30
- "text": "The domain where the api is located"
31
- }
32
- ]
33
- }
34
- ]
35
- },
36
- "sources": [
37
- {
38
- "fileName": "Config.ts",
39
- "line": 5,
40
- "character": 2,
41
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L5"
42
- }
43
- ],
44
- "type": {
45
- "type": "intrinsic",
46
- "name": "string"
47
- }
48
- },
49
- {
50
- "id": 3,
51
- "name": "apiKey",
52
- "kind": 1024,
53
- "kindString": "Property",
54
- "flags": {
55
- "isOptional": true
56
- },
57
- "comment": {
58
- "summary": [],
59
- "blockTags": [
60
- {
61
- "tag": "@description",
62
- "content": [
63
- {
64
- "kind": "text",
65
- "text": "The apiKey used for authentication"
66
- }
67
- ]
68
- }
69
- ]
70
- },
71
- "sources": [
72
- {
73
- "fileName": "Config.ts",
74
- "line": 8,
75
- "character": 2,
76
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L8"
77
- }
78
- ],
79
- "type": {
80
- "type": "intrinsic",
81
- "name": "string"
82
- }
83
- },
84
- {
85
- "id": 4,
86
- "name": "compressionThreshold",
87
- "kind": 1024,
88
- "kindString": "Property",
89
- "flags": {
90
- "isOptional": true
91
- },
92
- "comment": {
93
- "summary": [],
94
- "blockTags": [
95
- {
96
- "tag": "@description",
97
- "content": [
98
- {
99
- "kind": "text",
100
- "text": "Threshold for Content-Size to cause automatic gzip of request body [default = 1024]"
101
- }
102
- ]
103
- }
104
- ]
105
- },
106
- "sources": [
107
- {
108
- "fileName": "Config.ts",
109
- "line": 11,
110
- "character": 2,
111
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L11"
112
- }
113
- ],
114
- "type": {
115
- "type": "intrinsic",
116
- "name": "number"
117
- }
118
- },
119
- {
120
- "id": 5,
121
- "name": "jwtToken",
122
- "kind": 1024,
123
- "kindString": "Property",
124
- "flags": {
125
- "isOptional": true
126
- },
127
- "comment": {
128
- "summary": [],
129
- "blockTags": [
130
- {
131
- "tag": "@description",
132
- "content": [
133
- {
134
- "kind": "text",
135
- "text": "The jwtToken of the currently logged in user"
136
- }
137
- ]
138
- }
139
- ]
140
- },
141
- "sources": [
142
- {
143
- "fileName": "Config.ts",
144
- "line": 14,
145
- "character": 2,
146
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L14"
147
- }
148
- ],
149
- "type": {
150
- "type": "intrinsic",
151
- "name": "string"
152
- }
153
- },
154
- {
155
- "id": 12,
156
- "name": "onError",
157
- "kind": 1024,
158
- "kindString": "Property",
159
- "flags": {
160
- "isOptional": true
161
- },
162
- "sources": [
163
- {
164
- "fileName": "Reportable.ts",
165
- "line": 5,
166
- "character": 2,
167
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L5"
168
- }
169
- ],
170
- "type": {
171
- "type": "reflection",
172
- "declaration": {
173
- "id": 13,
174
- "name": "__type",
175
- "kind": 65536,
176
- "kindString": "Type literal",
177
- "flags": {},
178
- "sources": [
179
- {
180
- "fileName": "Reportable.ts",
181
- "line": 5,
182
- "character": 12,
183
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L5"
184
- }
185
- ],
186
- "signatures": [
187
- {
188
- "id": 14,
189
- "name": "__type",
190
- "kind": 4096,
191
- "kindString": "Call signature",
192
- "flags": {},
193
- "parameters": [
194
- {
195
- "id": 15,
196
- "name": "error",
197
- "kind": 32768,
198
- "kindString": "Parameter",
199
- "flags": {},
200
- "type": {
201
- "type": "reference",
202
- "id": 40,
203
- "typeArguments": [
204
- {
205
- "type": "intrinsic",
206
- "name": "any"
207
- },
208
- {
209
- "type": "intrinsic",
210
- "name": "any"
211
- }
212
- ],
213
- "name": "XyoApiError"
214
- }
215
- },
216
- {
217
- "id": 16,
218
- "name": "depth",
219
- "kind": 32768,
220
- "kindString": "Parameter",
221
- "flags": {},
222
- "type": {
223
- "type": "intrinsic",
224
- "name": "number"
225
- }
226
- }
227
- ],
228
- "type": {
229
- "type": "intrinsic",
230
- "name": "void"
231
- }
232
- }
233
- ]
234
- }
235
- },
236
- "inheritedFrom": {
237
- "type": "reference",
238
- "id": 45,
239
- "name": "XyoApiReportable.onError"
240
- }
241
- },
242
- {
243
- "id": 17,
244
- "name": "onFailure",
245
- "kind": 1024,
246
- "kindString": "Property",
247
- "flags": {
248
- "isOptional": true
249
- },
250
- "sources": [
251
- {
252
- "fileName": "Reportable.ts",
253
- "line": 7,
254
- "character": 2,
255
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L7"
256
- }
257
- ],
258
- "type": {
259
- "type": "reflection",
260
- "declaration": {
261
- "id": 18,
262
- "name": "__type",
263
- "kind": 65536,
264
- "kindString": "Type literal",
265
- "flags": {},
266
- "sources": [
267
- {
268
- "fileName": "Reportable.ts",
269
- "line": 7,
270
- "character": 14,
271
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L7"
272
- }
273
- ],
274
- "signatures": [
275
- {
276
- "id": 19,
277
- "name": "__type",
278
- "kind": 4096,
279
- "kindString": "Call signature",
280
- "flags": {},
281
- "parameters": [
282
- {
283
- "id": 20,
284
- "name": "response",
285
- "kind": 32768,
286
- "kindString": "Parameter",
287
- "flags": {},
288
- "type": {
289
- "type": "reference",
290
- "id": 60,
291
- "typeArguments": [
292
- {
293
- "type": "intrinsic",
294
- "name": "unknown"
295
- },
296
- {
297
- "type": "intrinsic",
298
- "name": "unknown"
299
- }
300
- ],
301
- "name": "XyoApiResponse"
302
- }
303
- },
304
- {
305
- "id": 21,
306
- "name": "depth",
307
- "kind": 32768,
308
- "kindString": "Parameter",
309
- "flags": {},
310
- "type": {
311
- "type": "intrinsic",
312
- "name": "number"
313
- }
314
- }
315
- ],
316
- "type": {
317
- "type": "intrinsic",
318
- "name": "void"
319
- }
320
- }
321
- ]
322
- }
323
- },
324
- "inheritedFrom": {
325
- "type": "reference",
326
- "id": 50,
327
- "name": "XyoApiReportable.onFailure"
328
- }
329
- },
330
- {
331
- "id": 22,
332
- "name": "onSuccess",
333
- "kind": 1024,
334
- "kindString": "Property",
335
- "flags": {
336
- "isOptional": true
337
- },
338
- "sources": [
339
- {
340
- "fileName": "Reportable.ts",
341
- "line": 9,
342
- "character": 2,
343
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L9"
344
- }
345
- ],
346
- "type": {
347
- "type": "reflection",
348
- "declaration": {
349
- "id": 23,
350
- "name": "__type",
351
- "kind": 65536,
352
- "kindString": "Type literal",
353
- "flags": {},
354
- "sources": [
355
- {
356
- "fileName": "Reportable.ts",
357
- "line": 9,
358
- "character": 14,
359
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L9"
360
- }
361
- ],
362
- "signatures": [
363
- {
364
- "id": 24,
365
- "name": "__type",
366
- "kind": 4096,
367
- "kindString": "Call signature",
368
- "flags": {},
369
- "parameters": [
370
- {
371
- "id": 25,
372
- "name": "response",
373
- "kind": 32768,
374
- "kindString": "Parameter",
375
- "flags": {},
376
- "type": {
377
- "type": "reference",
378
- "id": 60,
379
- "typeArguments": [
380
- {
381
- "type": "intrinsic",
382
- "name": "unknown"
383
- },
384
- {
385
- "type": "intrinsic",
386
- "name": "unknown"
387
- }
388
- ],
389
- "name": "XyoApiResponse"
390
- }
391
- },
392
- {
393
- "id": 26,
394
- "name": "depth",
395
- "kind": 32768,
396
- "kindString": "Parameter",
397
- "flags": {},
398
- "type": {
399
- "type": "intrinsic",
400
- "name": "number"
401
- }
402
- }
403
- ],
404
- "type": {
405
- "type": "intrinsic",
406
- "name": "void"
407
- }
408
- }
409
- ]
410
- }
411
- },
412
- "inheritedFrom": {
413
- "type": "reference",
414
- "id": 55,
415
- "name": "XyoApiReportable.onSuccess"
416
- }
417
- },
418
- {
419
- "id": 6,
420
- "name": "query",
421
- "kind": 1024,
422
- "kindString": "Property",
423
- "flags": {
424
- "isOptional": true
425
- },
426
- "comment": {
427
- "summary": [],
428
- "blockTags": [
429
- {
430
- "tag": "@description",
431
- "content": [
432
- {
433
- "kind": "text",
434
- "text": "The query string, if any, that is added to the end of every request"
435
- }
436
- ]
437
- }
438
- ]
439
- },
440
- "sources": [
441
- {
442
- "fileName": "Config.ts",
443
- "line": 17,
444
- "character": 2,
445
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L17"
446
- }
447
- ],
448
- "type": {
449
- "type": "intrinsic",
450
- "name": "string"
451
- }
452
- },
453
- {
454
- "id": 7,
455
- "name": "reportableParent",
456
- "kind": 1024,
457
- "kindString": "Property",
458
- "flags": {
459
- "isOptional": true
460
- },
461
- "comment": {
462
- "summary": [],
463
- "blockTags": [
464
- {
465
- "tag": "@description",
466
- "content": [
467
- {
468
- "kind": "text",
469
- "text": "Parent that should also report events from this api"
470
- }
471
- ]
472
- }
473
- ]
474
- },
475
- "sources": [
476
- {
477
- "fileName": "Config.ts",
478
- "line": 20,
479
- "character": 2,
480
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L20"
481
- }
482
- ],
483
- "type": {
484
- "type": "reference",
485
- "id": 44,
486
- "name": "XyoApiReportable"
487
- }
488
- },
489
- {
490
- "id": 8,
491
- "name": "root",
492
- "kind": 1024,
493
- "kindString": "Property",
494
- "flags": {
495
- "isOptional": true
496
- },
497
- "comment": {
498
- "summary": [],
499
- "blockTags": [
500
- {
501
- "tag": "@description",
502
- "content": [
503
- {
504
- "kind": "text",
505
- "text": "The location in the API tree where this API object is mounted"
506
- }
507
- ]
508
- }
509
- ]
510
- },
511
- "sources": [
512
- {
513
- "fileName": "Config.ts",
514
- "line": 23,
515
- "character": 2,
516
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L23"
517
- }
518
- ],
519
- "type": {
520
- "type": "intrinsic",
521
- "name": "string"
522
- }
523
- },
524
- {
525
- "id": 9,
526
- "name": "throwError",
527
- "kind": 1024,
528
- "kindString": "Property",
529
- "flags": {
530
- "isOptional": true
531
- },
532
- "comment": {
533
- "summary": [],
534
- "blockTags": [
535
- {
536
- "tag": "@description",
537
- "content": [
538
- {
539
- "kind": "text",
540
- "text": "Throw on error"
541
- }
542
- ]
543
- }
544
- ]
545
- },
546
- "sources": [
547
- {
548
- "fileName": "Config.ts",
549
- "line": 26,
550
- "character": 2,
551
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L26"
552
- }
553
- ],
554
- "type": {
555
- "type": "intrinsic",
556
- "name": "boolean"
557
- }
558
- },
559
- {
560
- "id": 10,
561
- "name": "throwFailure",
562
- "kind": 1024,
563
- "kindString": "Property",
564
- "flags": {
565
- "isOptional": true
566
- },
567
- "comment": {
568
- "summary": [],
569
- "blockTags": [
570
- {
571
- "tag": "@description",
572
- "content": [
573
- {
574
- "kind": "text",
575
- "text": "Throw on failures"
576
- }
577
- ]
578
- }
579
- ]
580
- },
581
- "sources": [
582
- {
583
- "fileName": "Config.ts",
584
- "line": 29,
585
- "character": 2,
586
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L29"
587
- }
588
- ],
589
- "type": {
590
- "type": "intrinsic",
591
- "name": "boolean"
592
- }
593
- },
594
- {
595
- "id": 11,
596
- "name": "userid",
597
- "kind": 1024,
598
- "kindString": "Property",
599
- "flags": {
600
- "isOptional": true
601
- },
602
- "comment": {
603
- "summary": [],
604
- "blockTags": [
605
- {
606
- "tag": "@deprecated",
607
- "content": [
608
- {
609
- "kind": "text",
610
- "text": "use the jwtToken instead"
611
- }
612
- ]
613
- }
614
- ]
615
- },
616
- "sources": [
617
- {
618
- "fileName": "Config.ts",
619
- "line": 32,
620
- "character": 2,
621
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L32"
622
- }
623
- ],
624
- "type": {
625
- "type": "intrinsic",
626
- "name": "string"
627
- }
628
- }
629
- ],
630
- "groups": [
631
- {
632
- "title": "Properties",
633
- "children": [
634
- 2,
635
- 3,
636
- 4,
637
- 5,
638
- 12,
639
- 17,
640
- 22,
641
- 6,
642
- 7,
643
- 8,
644
- 9,
645
- 10,
646
- 11
647
- ]
648
- }
649
- ],
650
- "sources": [
651
- {
652
- "fileName": "Config.ts",
653
- "line": 3,
654
- "character": 10,
655
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Config.ts#L3"
656
- }
657
- ],
658
- "extendedTypes": [
659
- {
660
- "type": "reference",
661
- "id": 44,
662
- "name": "XyoApiReportable"
663
- }
664
- ]
665
- },
666
- {
667
- "id": 27,
668
- "name": "XyoApiEnvelopeBase",
669
- "kind": 256,
670
- "kindString": "Interface",
671
- "flags": {},
672
- "children": [
673
- {
674
- "id": 28,
675
- "name": "warning",
676
- "kind": 1024,
677
- "kindString": "Property",
678
- "flags": {
679
- "isOptional": true
680
- },
681
- "sources": [
682
- {
683
- "fileName": "Envelope.ts",
684
- "line": 5,
685
- "character": 2,
686
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L5"
687
- }
688
- ],
689
- "type": {
690
- "type": "array",
691
- "elementType": {
692
- "type": "reference",
693
- "name": "Error",
694
- "qualifiedName": "Error",
695
- "package": "typescript"
696
- }
697
- }
698
- }
699
- ],
700
- "groups": [
701
- {
702
- "title": "Properties",
703
- "children": [
704
- 28
705
- ]
706
- }
707
- ],
708
- "sources": [
709
- {
710
- "fileName": "Envelope.ts",
711
- "line": 4,
712
- "character": 17,
713
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L4"
714
- }
715
- ],
716
- "extendedBy": [
717
- {
718
- "type": "reference",
719
- "id": 29,
720
- "name": "XyoApiEnvelopeSuccess"
721
- },
722
- {
723
- "type": "reference",
724
- "id": 34,
725
- "name": "XyoApiEnvelopeError"
726
- }
727
- ]
728
- },
729
- {
730
- "id": 34,
731
- "name": "XyoApiEnvelopeError",
732
- "kind": 256,
733
- "kindString": "Interface",
734
- "flags": {},
735
- "children": [
736
- {
737
- "id": 35,
738
- "name": "data",
739
- "kind": 1024,
740
- "kindString": "Property",
741
- "flags": {},
742
- "sources": [
743
- {
744
- "fileName": "Envelope.ts",
745
- "line": 14,
746
- "character": 2,
747
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L14"
748
- }
749
- ],
750
- "type": {
751
- "type": "intrinsic",
752
- "name": "never"
753
- }
754
- },
755
- {
756
- "id": 36,
757
- "name": "error",
758
- "kind": 1024,
759
- "kindString": "Property",
760
- "flags": {},
761
- "sources": [
762
- {
763
- "fileName": "Envelope.ts",
764
- "line": 15,
765
- "character": 2,
766
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L15"
767
- }
768
- ],
769
- "type": {
770
- "type": "array",
771
- "elementType": {
772
- "type": "reference",
773
- "id": 40,
774
- "typeArguments": [
775
- {
776
- "type": "intrinsic",
777
- "name": "any"
778
- },
779
- {
780
- "type": "intrinsic",
781
- "name": "any"
782
- }
783
- ],
784
- "name": "XyoApiError"
785
- }
786
- }
787
- },
788
- {
789
- "id": 37,
790
- "name": "warning",
791
- "kind": 1024,
792
- "kindString": "Property",
793
- "flags": {
794
- "isOptional": true
795
- },
796
- "sources": [
797
- {
798
- "fileName": "Envelope.ts",
799
- "line": 5,
800
- "character": 2,
801
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L5"
802
- }
803
- ],
804
- "type": {
805
- "type": "array",
806
- "elementType": {
807
- "type": "reference",
808
- "name": "Error",
809
- "qualifiedName": "Error",
810
- "package": "typescript"
811
- }
812
- },
813
- "inheritedFrom": {
814
- "type": "reference",
815
- "id": 28,
816
- "name": "XyoApiEnvelopeBase.warning"
817
- }
818
- }
819
- ],
820
- "groups": [
821
- {
822
- "title": "Properties",
823
- "children": [
824
- 35,
825
- 36,
826
- 37
827
- ]
828
- }
829
- ],
830
- "sources": [
831
- {
832
- "fileName": "Envelope.ts",
833
- "line": 13,
834
- "character": 17,
835
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L13"
836
- }
837
- ],
838
- "extendedTypes": [
839
- {
840
- "type": "reference",
841
- "id": 27,
842
- "name": "XyoApiEnvelopeBase"
843
- }
844
- ]
845
- },
846
- {
847
- "id": 29,
848
- "name": "XyoApiEnvelopeSuccess",
849
- "kind": 256,
850
- "kindString": "Interface",
851
- "flags": {},
852
- "children": [
853
- {
854
- "id": 30,
855
- "name": "data",
856
- "kind": 1024,
857
- "kindString": "Property",
858
- "flags": {},
859
- "sources": [
860
- {
861
- "fileName": "Envelope.ts",
862
- "line": 9,
863
- "character": 2,
864
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L9"
865
- }
866
- ],
867
- "type": {
868
- "type": "reference",
869
- "id": 33,
870
- "name": "T"
871
- }
872
- },
873
- {
874
- "id": 31,
875
- "name": "error",
876
- "kind": 1024,
877
- "kindString": "Property",
878
- "flags": {},
879
- "sources": [
880
- {
881
- "fileName": "Envelope.ts",
882
- "line": 10,
883
- "character": 2,
884
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L10"
885
- }
886
- ],
887
- "type": {
888
- "type": "intrinsic",
889
- "name": "never"
890
- }
891
- },
892
- {
893
- "id": 32,
894
- "name": "warning",
895
- "kind": 1024,
896
- "kindString": "Property",
897
- "flags": {
898
- "isOptional": true
899
- },
900
- "sources": [
901
- {
902
- "fileName": "Envelope.ts",
903
- "line": 5,
904
- "character": 2,
905
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L5"
906
- }
907
- ],
908
- "type": {
909
- "type": "array",
910
- "elementType": {
911
- "type": "reference",
912
- "name": "Error",
913
- "qualifiedName": "Error",
914
- "package": "typescript"
915
- }
916
- },
917
- "inheritedFrom": {
918
- "type": "reference",
919
- "id": 28,
920
- "name": "XyoApiEnvelopeBase.warning"
921
- }
922
- }
923
- ],
924
- "groups": [
925
- {
926
- "title": "Properties",
927
- "children": [
928
- 30,
929
- 31,
930
- 32
931
- ]
932
- }
933
- ],
934
- "sources": [
935
- {
936
- "fileName": "Envelope.ts",
937
- "line": 8,
938
- "character": 17,
939
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L8"
940
- }
941
- ],
942
- "typeParameters": [
943
- {
944
- "id": 33,
945
- "name": "T",
946
- "kind": 131072,
947
- "kindString": "Type parameter",
948
- "flags": {}
949
- }
950
- ],
951
- "extendedTypes": [
952
- {
953
- "type": "reference",
954
- "id": 27,
955
- "name": "XyoApiEnvelopeBase"
956
- }
957
- ]
958
- },
959
- {
960
- "id": 40,
961
- "name": "XyoApiError",
962
- "kind": 256,
963
- "kindString": "Interface",
964
- "flags": {},
965
- "children": [
966
- {
967
- "id": 41,
968
- "name": "isXyoError",
969
- "kind": 1024,
970
- "kindString": "Property",
971
- "flags": {},
972
- "sources": [
973
- {
974
- "fileName": "Error.ts",
975
- "line": 5,
976
- "character": 2,
977
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Error.ts#L5"
978
- }
979
- ],
980
- "type": {
981
- "type": "literal",
982
- "value": true
983
- }
984
- }
985
- ],
986
- "groups": [
987
- {
988
- "title": "Properties",
989
- "children": [
990
- 41
991
- ]
992
- }
993
- ],
994
- "sources": [
995
- {
996
- "fileName": "Error.ts",
997
- "line": 4,
998
- "character": 17,
999
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Error.ts#L4"
1000
- }
1001
- ],
1002
- "typeParameters": [
1003
- {
1004
- "id": 42,
1005
- "name": "T",
1006
- "kind": 131072,
1007
- "kindString": "Type parameter",
1008
- "flags": {},
1009
- "default": {
1010
- "type": "intrinsic",
1011
- "name": "any"
1012
- }
1013
- },
1014
- {
1015
- "id": 43,
1016
- "name": "D",
1017
- "kind": 131072,
1018
- "kindString": "Type parameter",
1019
- "flags": {},
1020
- "default": {
1021
- "type": "intrinsic",
1022
- "name": "any"
1023
- }
1024
- }
1025
- ],
1026
- "extendedTypes": [
1027
- {
1028
- "type": "reference",
1029
- "typeArguments": [
1030
- {
1031
- "type": "reference",
1032
- "id": 42,
1033
- "name": "T"
1034
- },
1035
- {
1036
- "type": "reference",
1037
- "id": 43,
1038
- "name": "D"
1039
- }
1040
- ],
1041
- "name": "AxiosError",
1042
- "qualifiedName": "AxiosError",
1043
- "package": "axios"
1044
- }
1045
- ]
1046
- },
1047
- {
1048
- "id": 44,
1049
- "name": "XyoApiReportable",
1050
- "kind": 256,
1051
- "kindString": "Interface",
1052
- "flags": {},
1053
- "children": [
1054
- {
1055
- "id": 45,
1056
- "name": "onError",
1057
- "kind": 1024,
1058
- "kindString": "Property",
1059
- "flags": {
1060
- "isOptional": true
1061
- },
1062
- "sources": [
1063
- {
1064
- "fileName": "Reportable.ts",
1065
- "line": 5,
1066
- "character": 2,
1067
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L5"
1068
- }
1069
- ],
1070
- "type": {
1071
- "type": "reflection",
1072
- "declaration": {
1073
- "id": 46,
1074
- "name": "__type",
1075
- "kind": 65536,
1076
- "kindString": "Type literal",
1077
- "flags": {},
1078
- "sources": [
1079
- {
1080
- "fileName": "Reportable.ts",
1081
- "line": 5,
1082
- "character": 12,
1083
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L5"
1084
- }
1085
- ],
1086
- "signatures": [
1087
- {
1088
- "id": 47,
1089
- "name": "__type",
1090
- "kind": 4096,
1091
- "kindString": "Call signature",
1092
- "flags": {},
1093
- "parameters": [
1094
- {
1095
- "id": 48,
1096
- "name": "error",
1097
- "kind": 32768,
1098
- "kindString": "Parameter",
1099
- "flags": {},
1100
- "type": {
1101
- "type": "reference",
1102
- "id": 40,
1103
- "typeArguments": [
1104
- {
1105
- "type": "intrinsic",
1106
- "name": "any"
1107
- },
1108
- {
1109
- "type": "intrinsic",
1110
- "name": "any"
1111
- }
1112
- ],
1113
- "name": "XyoApiError"
1114
- }
1115
- },
1116
- {
1117
- "id": 49,
1118
- "name": "depth",
1119
- "kind": 32768,
1120
- "kindString": "Parameter",
1121
- "flags": {},
1122
- "type": {
1123
- "type": "intrinsic",
1124
- "name": "number"
1125
- }
1126
- }
1127
- ],
1128
- "type": {
1129
- "type": "intrinsic",
1130
- "name": "void"
1131
- }
1132
- }
1133
- ]
1134
- }
1135
- }
1136
- },
1137
- {
1138
- "id": 50,
1139
- "name": "onFailure",
1140
- "kind": 1024,
1141
- "kindString": "Property",
1142
- "flags": {
1143
- "isOptional": true
1144
- },
1145
- "sources": [
1146
- {
1147
- "fileName": "Reportable.ts",
1148
- "line": 7,
1149
- "character": 2,
1150
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L7"
1151
- }
1152
- ],
1153
- "type": {
1154
- "type": "reflection",
1155
- "declaration": {
1156
- "id": 51,
1157
- "name": "__type",
1158
- "kind": 65536,
1159
- "kindString": "Type literal",
1160
- "flags": {},
1161
- "sources": [
1162
- {
1163
- "fileName": "Reportable.ts",
1164
- "line": 7,
1165
- "character": 14,
1166
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L7"
1167
- }
1168
- ],
1169
- "signatures": [
1170
- {
1171
- "id": 52,
1172
- "name": "__type",
1173
- "kind": 4096,
1174
- "kindString": "Call signature",
1175
- "flags": {},
1176
- "parameters": [
1177
- {
1178
- "id": 53,
1179
- "name": "response",
1180
- "kind": 32768,
1181
- "kindString": "Parameter",
1182
- "flags": {},
1183
- "type": {
1184
- "type": "reference",
1185
- "id": 60,
1186
- "typeArguments": [
1187
- {
1188
- "type": "intrinsic",
1189
- "name": "unknown"
1190
- },
1191
- {
1192
- "type": "intrinsic",
1193
- "name": "unknown"
1194
- }
1195
- ],
1196
- "name": "XyoApiResponse"
1197
- }
1198
- },
1199
- {
1200
- "id": 54,
1201
- "name": "depth",
1202
- "kind": 32768,
1203
- "kindString": "Parameter",
1204
- "flags": {},
1205
- "type": {
1206
- "type": "intrinsic",
1207
- "name": "number"
1208
- }
1209
- }
1210
- ],
1211
- "type": {
1212
- "type": "intrinsic",
1213
- "name": "void"
1214
- }
1215
- }
1216
- ]
1217
- }
1218
- }
1219
- },
1220
- {
1221
- "id": 55,
1222
- "name": "onSuccess",
1223
- "kind": 1024,
1224
- "kindString": "Property",
1225
- "flags": {
1226
- "isOptional": true
1227
- },
1228
- "sources": [
1229
- {
1230
- "fileName": "Reportable.ts",
1231
- "line": 9,
1232
- "character": 2,
1233
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L9"
1234
- }
1235
- ],
1236
- "type": {
1237
- "type": "reflection",
1238
- "declaration": {
1239
- "id": 56,
1240
- "name": "__type",
1241
- "kind": 65536,
1242
- "kindString": "Type literal",
1243
- "flags": {},
1244
- "sources": [
1245
- {
1246
- "fileName": "Reportable.ts",
1247
- "line": 9,
1248
- "character": 14,
1249
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L9"
1250
- }
1251
- ],
1252
- "signatures": [
1253
- {
1254
- "id": 57,
1255
- "name": "__type",
1256
- "kind": 4096,
1257
- "kindString": "Call signature",
1258
- "flags": {},
1259
- "parameters": [
1260
- {
1261
- "id": 58,
1262
- "name": "response",
1263
- "kind": 32768,
1264
- "kindString": "Parameter",
1265
- "flags": {},
1266
- "type": {
1267
- "type": "reference",
1268
- "id": 60,
1269
- "typeArguments": [
1270
- {
1271
- "type": "intrinsic",
1272
- "name": "unknown"
1273
- },
1274
- {
1275
- "type": "intrinsic",
1276
- "name": "unknown"
1277
- }
1278
- ],
1279
- "name": "XyoApiResponse"
1280
- }
1281
- },
1282
- {
1283
- "id": 59,
1284
- "name": "depth",
1285
- "kind": 32768,
1286
- "kindString": "Parameter",
1287
- "flags": {},
1288
- "type": {
1289
- "type": "intrinsic",
1290
- "name": "number"
1291
- }
1292
- }
1293
- ],
1294
- "type": {
1295
- "type": "intrinsic",
1296
- "name": "void"
1297
- }
1298
- }
1299
- ]
1300
- }
1301
- }
1302
- }
1303
- ],
1304
- "groups": [
1305
- {
1306
- "title": "Properties",
1307
- "children": [
1308
- 45,
1309
- 50,
1310
- 55
1311
- ]
1312
- }
1313
- ],
1314
- "sources": [
1315
- {
1316
- "fileName": "Reportable.ts",
1317
- "line": 4,
1318
- "character": 17,
1319
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Reportable.ts#L4"
1320
- }
1321
- ],
1322
- "extendedBy": [
1323
- {
1324
- "type": "reference",
1325
- "id": 1,
1326
- "name": "XyoApiConfig"
1327
- }
1328
- ]
1329
- },
1330
- {
1331
- "id": 38,
1332
- "name": "XyoApiEnvelope",
1333
- "kind": 4194304,
1334
- "kindString": "Type alias",
1335
- "flags": {},
1336
- "sources": [
1337
- {
1338
- "fileName": "Envelope.ts",
1339
- "line": 18,
1340
- "character": 12,
1341
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Envelope.ts#L18"
1342
- }
1343
- ],
1344
- "typeParameters": [
1345
- {
1346
- "id": 39,
1347
- "name": "T",
1348
- "kind": 131072,
1349
- "kindString": "Type parameter",
1350
- "flags": {}
1351
- }
1352
- ],
1353
- "type": {
1354
- "type": "union",
1355
- "types": [
1356
- {
1357
- "type": "reference",
1358
- "id": 29,
1359
- "typeArguments": [
1360
- {
1361
- "type": "reference",
1362
- "id": 39,
1363
- "name": "T"
1364
- }
1365
- ],
1366
- "name": "XyoApiEnvelopeSuccess"
1367
- },
1368
- {
1369
- "type": "reference",
1370
- "id": 34,
1371
- "name": "XyoApiEnvelopeError"
1372
- }
1373
- ]
1374
- }
1375
- },
1376
- {
1377
- "id": 60,
1378
- "name": "XyoApiResponse",
1379
- "kind": 4194304,
1380
- "kindString": "Type alias",
1381
- "flags": {},
1382
- "sources": [
1383
- {
1384
- "fileName": "Response.ts",
1385
- "line": 5,
1386
- "character": 12,
1387
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Response.ts#L5"
1388
- }
1389
- ],
1390
- "typeParameters": [
1391
- {
1392
- "id": 61,
1393
- "name": "T",
1394
- "kind": 131072,
1395
- "kindString": "Type parameter",
1396
- "flags": {},
1397
- "default": {
1398
- "type": "intrinsic",
1399
- "name": "unknown"
1400
- }
1401
- },
1402
- {
1403
- "id": 62,
1404
- "name": "D",
1405
- "kind": 131072,
1406
- "kindString": "Type parameter",
1407
- "flags": {},
1408
- "default": {
1409
- "type": "intrinsic",
1410
- "name": "unknown"
1411
- }
1412
- }
1413
- ],
1414
- "type": {
1415
- "type": "reference",
1416
- "typeArguments": [
1417
- {
1418
- "type": "reference",
1419
- "id": 61,
1420
- "name": "T"
1421
- },
1422
- {
1423
- "type": "reference",
1424
- "id": 62,
1425
- "name": "D"
1426
- }
1427
- ],
1428
- "name": "AxiosResponse",
1429
- "qualifiedName": "AxiosResponse",
1430
- "package": "axios"
1431
- }
1432
- },
1433
- {
1434
- "id": 63,
1435
- "name": "XyoApiResponseBody",
1436
- "kind": 4194304,
1437
- "kindString": "Type alias",
1438
- "flags": {},
1439
- "sources": [
1440
- {
1441
- "fileName": "Response.ts",
1442
- "line": 7,
1443
- "character": 12,
1444
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Response.ts#L7"
1445
- }
1446
- ],
1447
- "typeParameters": [
1448
- {
1449
- "id": 64,
1450
- "name": "T",
1451
- "kind": 131072,
1452
- "kindString": "Type parameter",
1453
- "flags": {}
1454
- }
1455
- ],
1456
- "type": {
1457
- "type": "union",
1458
- "types": [
1459
- {
1460
- "type": "reference",
1461
- "id": 64,
1462
- "name": "T"
1463
- },
1464
- {
1465
- "type": "intrinsic",
1466
- "name": "undefined"
1467
- }
1468
- ]
1469
- }
1470
- },
1471
- {
1472
- "id": 65,
1473
- "name": "XyoApiResponseTuple",
1474
- "kind": 4194304,
1475
- "kindString": "Type alias",
1476
- "flags": {},
1477
- "sources": [
1478
- {
1479
- "fileName": "Response.ts",
1480
- "line": 9,
1481
- "character": 12,
1482
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Response.ts#L9"
1483
- }
1484
- ],
1485
- "typeParameters": [
1486
- {
1487
- "id": 66,
1488
- "name": "T",
1489
- "kind": 131072,
1490
- "kindString": "Type parameter",
1491
- "flags": {}
1492
- }
1493
- ],
1494
- "type": {
1495
- "type": "tuple",
1496
- "elements": [
1497
- {
1498
- "type": "union",
1499
- "types": [
1500
- {
1501
- "type": "reference",
1502
- "id": 66,
1503
- "name": "T"
1504
- },
1505
- {
1506
- "type": "intrinsic",
1507
- "name": "undefined"
1508
- }
1509
- ]
1510
- },
1511
- {
1512
- "type": "reference",
1513
- "id": 38,
1514
- "typeArguments": [
1515
- {
1516
- "type": "union",
1517
- "types": [
1518
- {
1519
- "type": "reference",
1520
- "id": 66,
1521
- "name": "T"
1522
- },
1523
- {
1524
- "type": "intrinsic",
1525
- "name": "undefined"
1526
- }
1527
- ]
1528
- }
1529
- ],
1530
- "name": "XyoApiEnvelope"
1531
- },
1532
- {
1533
- "type": "reference",
1534
- "id": 60,
1535
- "typeArguments": [
1536
- {
1537
- "type": "reference",
1538
- "id": 38,
1539
- "typeArguments": [
1540
- {
1541
- "type": "union",
1542
- "types": [
1543
- {
1544
- "type": "reference",
1545
- "id": 66,
1546
- "name": "T"
1547
- },
1548
- {
1549
- "type": "intrinsic",
1550
- "name": "undefined"
1551
- }
1552
- ]
1553
- }
1554
- ],
1555
- "name": "XyoApiEnvelope"
1556
- }
1557
- ],
1558
- "name": "XyoApiResponse"
1559
- }
1560
- ]
1561
- }
1562
- },
1563
- {
1564
- "id": 67,
1565
- "name": "XyoApiResponseTupleOrBody",
1566
- "kind": 4194304,
1567
- "kindString": "Type alias",
1568
- "flags": {},
1569
- "sources": [
1570
- {
1571
- "fileName": "Response.ts",
1572
- "line": 11,
1573
- "character": 12,
1574
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Response.ts#L11"
1575
- }
1576
- ],
1577
- "typeParameters": [
1578
- {
1579
- "id": 68,
1580
- "name": "T",
1581
- "kind": 131072,
1582
- "kindString": "Type parameter",
1583
- "flags": {}
1584
- }
1585
- ],
1586
- "type": {
1587
- "type": "union",
1588
- "types": [
1589
- {
1590
- "type": "reference",
1591
- "id": 65,
1592
- "typeArguments": [
1593
- {
1594
- "type": "reference",
1595
- "id": 68,
1596
- "name": "T"
1597
- }
1598
- ],
1599
- "name": "XyoApiResponseTuple"
1600
- },
1601
- {
1602
- "type": "reference",
1603
- "id": 63,
1604
- "typeArguments": [
1605
- {
1606
- "type": "reference",
1607
- "id": 68,
1608
- "name": "T"
1609
- }
1610
- ],
1611
- "name": "XyoApiResponseBody"
1612
- }
1613
- ]
1614
- }
1615
- },
1616
- {
1617
- "id": 69,
1618
- "name": "XyoApiResponseType",
1619
- "kind": 4194304,
1620
- "kindString": "Type alias",
1621
- "flags": {},
1622
- "sources": [
1623
- {
1624
- "fileName": "Response.ts",
1625
- "line": 13,
1626
- "character": 12,
1627
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Response.ts#L13"
1628
- }
1629
- ],
1630
- "type": {
1631
- "type": "union",
1632
- "types": [
1633
- {
1634
- "type": "literal",
1635
- "value": "body"
1636
- },
1637
- {
1638
- "type": "literal",
1639
- "value": "tuple"
1640
- }
1641
- ]
1642
- }
1643
- },
1644
- {
1645
- "id": 70,
1646
- "name": "XyoApiWarning",
1647
- "kind": 4194304,
1648
- "kindString": "Type alias",
1649
- "flags": {},
1650
- "sources": [
1651
- {
1652
- "fileName": "Warning.ts",
1653
- "line": 1,
1654
- "character": 12,
1655
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/Warning.ts#L1"
1656
- }
1657
- ],
1658
- "type": {
1659
- "type": "reference",
1660
- "name": "Error",
1661
- "qualifiedName": "Error",
1662
- "package": "typescript"
1663
- }
1664
- }
1665
- ],
1666
- "groups": [
1667
- {
1668
- "title": "Interfaces",
1669
- "children": [
1670
- 1,
1671
- 27,
1672
- 34,
1673
- 29,
1674
- 40,
1675
- 44
1676
- ]
1677
- },
1678
- {
1679
- "title": "Type Aliases",
1680
- "children": [
1681
- 38,
1682
- 60,
1683
- 63,
1684
- 65,
1685
- 67,
1686
- 69,
1687
- 70
1688
- ]
1689
- }
1690
- ],
1691
- "sources": [
1692
- {
1693
- "fileName": "index.ts",
1694
- "line": 1,
1695
- "character": 0,
1696
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/43abfbcd1/packages/sdk/packages/api-models/src/index.ts#L1"
1697
- }
1698
- ]
1699
- }