@sassoftware/vi-api 0.0.29

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 (140) hide show
  1. package/alert-reps/index.d.ts +677 -0
  2. package/alert-reps/package.json +5 -0
  3. package/component/bindings.d.ts +85 -0
  4. package/component/bindings.js +1 -0
  5. package/component/index.d.ts +49 -0
  6. package/component/index.js +16 -0
  7. package/component/package.json +9 -0
  8. package/component/public-api.d.ts +1 -0
  9. package/component/public-api.js +1 -0
  10. package/config/config-api.d.ts +92 -0
  11. package/config/config-api.js +6 -0
  12. package/config/package.json +9 -0
  13. package/config/public-api.d.ts +1 -0
  14. package/config/public-api.js +1 -0
  15. package/control/control-api.d.ts +450 -0
  16. package/control/control-api.js +1 -0
  17. package/control/data-types.d.ts +9 -0
  18. package/control/data-types.js +1 -0
  19. package/control/events.d.ts +75 -0
  20. package/control/events.js +5 -0
  21. package/control/file.d.ts +14 -0
  22. package/control/file.js +1 -0
  23. package/control/image.d.ts +14 -0
  24. package/control/image.js +1 -0
  25. package/control/package.json +9 -0
  26. package/control/page.d.ts +55 -0
  27. package/control/page.js +1 -0
  28. package/control/public-api.d.ts +8 -0
  29. package/control/public-api.js +8 -0
  30. package/control/restrictions.d.ts +33 -0
  31. package/control/restrictions.js +1 -0
  32. package/control/toolbar-property-api.d.ts +16 -0
  33. package/control/toolbar-property-api.js +1 -0
  34. package/current-user/currentUser-api.d.ts +65 -0
  35. package/current-user/currentUser-api.js +11 -0
  36. package/current-user/package.json +9 -0
  37. package/current-user/public-api.d.ts +1 -0
  38. package/current-user/public-api.js +1 -0
  39. package/event/event-api.d.ts +57 -0
  40. package/event/event-api.js +26 -0
  41. package/event/package.json +9 -0
  42. package/event/public-api.d.ts +1 -0
  43. package/event/public-api.js +1 -0
  44. package/file/file-api.d.ts +44 -0
  45. package/file/file-api.js +1 -0
  46. package/file/package.json +9 -0
  47. package/file/public-api.d.ts +1 -0
  48. package/file/public-api.js +1 -0
  49. package/http/index.d.ts +364 -0
  50. package/http/index.js +45 -0
  51. package/http/package.json +9 -0
  52. package/http/public-api.d.ts +1 -0
  53. package/http/public-api.js +1 -0
  54. package/index.d.ts +65 -0
  55. package/index.js +1 -0
  56. package/localization/localization-api.d.ts +26 -0
  57. package/localization/localization-api.js +1 -0
  58. package/localization/package.json +9 -0
  59. package/localization/public-api.d.ts +1 -0
  60. package/localization/public-api.js +1 -0
  61. package/metadata/admin/admin-metadata-api.d.ts +18 -0
  62. package/metadata/admin/admin-metadata-api.js +1 -0
  63. package/metadata/metadata-api.d.ts +237 -0
  64. package/metadata/metadata-api.js +1 -0
  65. package/metadata/package.json +9 -0
  66. package/metadata/public-api.d.ts +2 -0
  67. package/metadata/public-api.js +2 -0
  68. package/object/object-api.d.ts +507 -0
  69. package/object/object-api.js +13 -0
  70. package/object/package.json +9 -0
  71. package/object/public-api.d.ts +1 -0
  72. package/object/public-api.js +1 -0
  73. package/package.json +14 -0
  74. package/page-admin/package.json +9 -0
  75. package/page-admin/page-admin-api.d.ts +29 -0
  76. package/page-admin/page-admin-api.js +11 -0
  77. package/page-admin/public-api.d.ts +1 -0
  78. package/page-admin/public-api.js +1 -0
  79. package/page-model/package.json +9 -0
  80. package/page-model/page-model-api.d.ts +126 -0
  81. package/page-model/page-model-api.js +11 -0
  82. package/page-model/public-api.d.ts +1 -0
  83. package/page-model/public-api.js +1 -0
  84. package/page-state/package.json +9 -0
  85. package/page-state/page-state-api.d.ts +59 -0
  86. package/page-state/page-state-api.js +1 -0
  87. package/page-state/public-api.d.ts +1 -0
  88. package/page-state/public-api.js +1 -0
  89. package/property/package.json +9 -0
  90. package/property/property-api.d.ts +46 -0
  91. package/property/property-api.js +17 -0
  92. package/property/public-api.d.ts +1 -0
  93. package/property/public-api.js +1 -0
  94. package/public-api.d.ts +1 -0
  95. package/public-api.js +1 -0
  96. package/reference-data/package.json +9 -0
  97. package/reference-data/public-api.d.ts +1 -0
  98. package/reference-data/public-api.js +1 -0
  99. package/reference-data/refData.d.ts +72 -0
  100. package/reference-data/refData.js +1 -0
  101. package/resource/package.json +9 -0
  102. package/resource/public-api.d.ts +1 -0
  103. package/resource/public-api.js +1 -0
  104. package/resource/resource-api.d.ts +17 -0
  105. package/resource/resource-api.js +1 -0
  106. package/score-reps/index.d.ts +133 -0
  107. package/score-reps/package.json +5 -0
  108. package/search/client/client-search-api.d.ts +159 -0
  109. package/search/client/client-search-api.js +14 -0
  110. package/search/package.json +9 -0
  111. package/search/public-api.d.ts +2 -0
  112. package/search/public-api.js +2 -0
  113. package/search/search-api.d.ts +72 -0
  114. package/search/search-api.js +1 -0
  115. package/sheet/package.json +9 -0
  116. package/sheet/public-api.d.ts +1 -0
  117. package/sheet/public-api.js +1 -0
  118. package/sheet/sheet-api.d.ts +184 -0
  119. package/sheet/sheet-api.js +1 -0
  120. package/svi-datahub/index.d.ts +4514 -0
  121. package/svi-datahub/package.json +5 -0
  122. package/svi-sand/index.d.ts +1057 -0
  123. package/svi-sand/package.json +5 -0
  124. package/tab/package.json +9 -0
  125. package/tab/public-api.d.ts +1 -0
  126. package/tab/public-api.js +1 -0
  127. package/tab/tab-api.d.ts +33 -0
  128. package/tab/tab-api.js +1 -0
  129. package/theme/package.json +9 -0
  130. package/theme/public-api.d.ts +1 -0
  131. package/theme/public-api.js +1 -0
  132. package/theme/theme-api.d.ts +35 -0
  133. package/theme/theme-api.js +17 -0
  134. package/time-slider/index.d.ts +35 -0
  135. package/time-slider/index.js +17 -0
  136. package/traversal/package.json +9 -0
  137. package/traversal/public-api.d.ts +1 -0
  138. package/traversal/public-api.js +1 -0
  139. package/traversal/traversal-api.d.ts +34 -0
  140. package/traversal/traversal-api.js +1 -0
@@ -0,0 +1,1057 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ // Generated using typescript-generator version 2.15.527 on 2022-01-30 09:30:50.
4
+
5
+ export interface ApplicationSetting extends ResponsesErrorResponse {
6
+ name?: string;
7
+ value?: any;
8
+ links?: Link[];
9
+ }
10
+
11
+ export interface SandConfig {
12
+ types?: { [index: string]: SandType };
13
+ links?: Link[];
14
+ }
15
+
16
+ export interface SandField {
17
+ displayName?: string;
18
+ type?: FieldType;
19
+ options?: { [index: string]: any };
20
+ innerFields?: { [index: string]: SandField };
21
+ }
22
+
23
+ export interface SandIndex {
24
+ type?: string;
25
+ name?: string;
26
+ links?: Link[];
27
+ }
28
+
29
+ export interface SandType extends ResponsesErrorResponse {
30
+ solution?: string;
31
+ name?: string;
32
+ displayName?: string;
33
+ category?: TypeCategory;
34
+ fields?: { [index: string]: SandField };
35
+ options?: { [index: string]: any };
36
+ config?: SandConfiguration;
37
+ version?: number;
38
+ links?: Link[];
39
+ }
40
+
41
+ export interface Analyzer {
42
+ solution?: string;
43
+ name?: string;
44
+ displayName?: string;
45
+ links?: Link[];
46
+ }
47
+
48
+ export interface AnalyzerConfiguration extends Serializable {
49
+ search?: string;
50
+ facet?: string;
51
+ sort?: string;
52
+ languageTags?: string[];
53
+ icuFilter?: string;
54
+ minShingleSize?: number;
55
+ maxShingleSize?: number;
56
+ phoneticEncoder?: string;
57
+ synonymsPath?: string;
58
+ synonyms?: string[];
59
+ }
60
+
61
+ export interface Synonym {
62
+ terms?: string;
63
+ }
64
+
65
+ export interface AnalyticsLocale {
66
+ name?: string;
67
+ nativeName?: string;
68
+ tag?: string;
69
+ }
70
+
71
+ export interface AnalyticsResult extends Serializable {
72
+ phrase?: string;
73
+ frequencyCount?: number;
74
+ weight?: number;
75
+ objectIds?: ObjectId[];
76
+ aliases?: AnalyticsResult[];
77
+ }
78
+
79
+ export interface ExplorationLevel {
80
+ category?: ResultCategory;
81
+ phrase?: string;
82
+ nextLevel?: ExplorationLevel;
83
+ }
84
+
85
+ export interface Identity extends Serializable {
86
+ name?: string;
87
+ frequencyCount?: number;
88
+ aliases?: Identity[];
89
+ }
90
+
91
+ export interface SankeyLink {
92
+ fromNode?: number;
93
+ toNode?: number;
94
+ frequencyCount?: number;
95
+ objectIds?: ObjectId[];
96
+ }
97
+
98
+ export interface SankeyNode extends AnalyticsResult {
99
+ identifier?: number;
100
+ category?: ResultCategory;
101
+ }
102
+
103
+ export interface EventConfiguration {
104
+ root?: string;
105
+ fields?: Fields;
106
+ requiredFields?: string[];
107
+ }
108
+
109
+ export interface Fields {
110
+ category?: string;
111
+ label?: string;
112
+ description?: string;
113
+ longitude?: string;
114
+ latitude?: string;
115
+ geoJson?: string;
116
+ pointTimestamp?: string;
117
+ intervalStartTimestamp?: string;
118
+ intervalEndTimestamp?: string;
119
+ }
120
+
121
+ export interface FieldsConfiguration {
122
+ fields?: string[];
123
+ }
124
+
125
+ export interface LabelConfiguration {
126
+ template?: string;
127
+ values?: string[];
128
+ }
129
+
130
+ export interface SandConfiguration {
131
+ summary?: SummaryConfiguration;
132
+ graph?: FieldsConfiguration;
133
+ table?: FieldsConfiguration;
134
+ facets?: FacetConfigUnion[];
135
+ textAnalytics?: TextAnalyticsConfiguration;
136
+ events?: EventConfiguration[];
137
+ label?: LabelConfiguration;
138
+ description?: LabelConfiguration;
139
+ }
140
+
141
+ export interface SummaryConfiguration extends FieldsConfiguration {
142
+ highlighting?: { [index: string]: HighlightingConfiguration };
143
+ }
144
+
145
+ export interface HighlightingConfiguration {
146
+ highlighter?: string;
147
+ fragments?: number;
148
+ fragmentSize?: number;
149
+ }
150
+
151
+ export interface TextAnalyticsConfiguration extends FieldsConfiguration {
152
+ fromField?: string;
153
+ toFields?: string[];
154
+ }
155
+
156
+ export interface DateRangeFacetConfig extends FacetConfig {
157
+ type: "dateRange";
158
+ accuracy?: DateTimeAccuracy;
159
+ filter?: RangeFilterConfig;
160
+ ranges?: DateRange[];
161
+ }
162
+
163
+ export interface FacetConfig {
164
+ type: "dateRange" | "range" | "terms" | "type";
165
+ field?: string;
166
+ }
167
+
168
+ export interface NumericalRangeFacetConfig extends FacetConfig {
169
+ type: "range";
170
+ filter?: RangeFilterConfig;
171
+ ranges?: NumericalRange[];
172
+ }
173
+
174
+ export interface RangeFilterConfig {
175
+ displayFormat?: string;
176
+ allowExact?: boolean;
177
+ allowRange?: boolean;
178
+ fromType?: FromType;
179
+ toType?: ToType;
180
+ }
181
+
182
+ export interface TermsFacetConfig extends FacetConfig {
183
+ type: "terms" | "type";
184
+ limit?: number;
185
+ displayLimit?: number;
186
+ minDocCount?: number;
187
+ orderBy?: string;
188
+ orderDirection?: string;
189
+ }
190
+
191
+ export interface TypeFacetConfig extends TermsFacetConfig {
192
+ type: "type";
193
+ }
194
+
195
+ export interface AbstractFacet {
196
+ type: "dateRange" | "range" | "terms" | "type";
197
+ hitCount?: number;
198
+ selectedHitCount?: number;
199
+ }
200
+
201
+ export interface AbstractFacetWithField extends AbstractFacet {
202
+ type: "dateRange" | "range" | "terms";
203
+ field?: string;
204
+ fieldLabel?: string;
205
+ }
206
+
207
+ export interface DateRangeFacet extends AbstractFacetWithField {
208
+ type: "dateRange";
209
+ min?: string;
210
+ max?: string;
211
+ accuracy?: DateTimeAccuracy;
212
+ filter?: RangeFilterConfig;
213
+ userEnteredFilters?: DateRangeFilter[];
214
+ ranges?: DateFacetRange[];
215
+ }
216
+
217
+ export interface DateFacetRange extends DateRange {
218
+ hitCount?: number;
219
+ selectedHitCount?: number;
220
+ selected?: boolean;
221
+ }
222
+
223
+ export interface FacetVisitor<T> {
224
+ }
225
+
226
+ export interface NumericalRangeFacet extends AbstractFacetWithField {
227
+ type: "range";
228
+ min?: number;
229
+ max?: number;
230
+ filter?: RangeFilterConfig;
231
+ userEnteredFilters?: NumericalRangeFilter[];
232
+ ranges?: NumericalFacetRange[];
233
+ }
234
+
235
+ export interface NumericalFacetRange extends NumericalRange {
236
+ hitCount?: number;
237
+ selectedHitCount?: number;
238
+ selected?: boolean;
239
+ }
240
+
241
+ export interface TermsFacet extends AbstractFacetWithField {
242
+ type: "terms";
243
+ buckets?: TermsBucket[];
244
+ displayLimit?: number;
245
+ }
246
+
247
+ export interface TermsBucket {
248
+ term?: any;
249
+ hitCount?: number;
250
+ selectedHitCount?: number;
251
+ selected?: boolean;
252
+ }
253
+
254
+ export interface TypeFacet extends AbstractFacet {
255
+ type: "type";
256
+ buckets?: TypeBucket[];
257
+ displayLimit?: number;
258
+ }
259
+
260
+ export interface TypeBucket {
261
+ type?: string;
262
+ typeLabel?: string;
263
+ hitCount?: number;
264
+ selectedHitCount?: number;
265
+ selected?: boolean;
266
+ }
267
+
268
+ export interface AbstractCompositeFilter extends AbstractFilter {
269
+ type: "and" | "or";
270
+ filters?: AbstractFilterUnion[];
271
+ }
272
+
273
+ export interface AbstractFilter {
274
+ type: "and" | "or" | "dateRange" | "range" | "box" | "polygon" | "radius" | "shape" | "not" | "query" | "terms" | "type";
275
+ }
276
+
277
+ export interface AbstractRangeFilter<V> extends AbstractFilter {
278
+ type: "dateRange" | "range";
279
+ field?: string;
280
+ gt?: V;
281
+ gte?: V;
282
+ lt?: V;
283
+ lte?: V;
284
+ }
285
+
286
+ export interface AndFilter extends AbstractCompositeFilter {
287
+ type: "and";
288
+ }
289
+
290
+ export interface DateRangeFilter extends AbstractRangeFilter<string> {
291
+ type: "dateRange";
292
+ accuracy?: DateTimeAccuracy;
293
+ }
294
+
295
+ export interface FilterVisitor<T> {
296
+ }
297
+
298
+ export interface MapBoundedBoxFilter extends AbstractFilter {
299
+ type: "box";
300
+ coordinates?: number[][];
301
+ bottomRight?: Coordinate;
302
+ topLeft?: Coordinate;
303
+ }
304
+
305
+ export interface MapBoundedPolygonFilter extends AbstractFilter {
306
+ type: "polygon";
307
+ coordinates?: number[][];
308
+ points?: Coordinate[];
309
+ }
310
+
311
+ export interface MapRadiusFilter extends AbstractFilter {
312
+ type: "radius";
313
+ radius?: string;
314
+ coordinates?: number[];
315
+ centre?: Coordinate;
316
+ }
317
+
318
+ export interface MapShapeFilter extends AbstractFilter {
319
+ type: "shape";
320
+ relation?: MapRelation;
321
+ shape?: { [index: string]: any };
322
+ id?: string;
323
+ }
324
+
325
+ export interface NotFilter extends AbstractFilter {
326
+ type: "not";
327
+ filter?: AbstractFilterUnion;
328
+ }
329
+
330
+ export interface NumericalRangeFilter extends AbstractRangeFilter<number> {
331
+ type: "range";
332
+ }
333
+
334
+ export interface OrFilter extends AbstractCompositeFilter {
335
+ type: "or";
336
+ }
337
+
338
+ export interface QueryFilter extends AbstractFilter {
339
+ type: "query";
340
+ query?: AbstractQueryUnion;
341
+ }
342
+
343
+ export interface TermsFilter extends AbstractFilter {
344
+ type: "terms";
345
+ field?: string;
346
+ terms?: any[];
347
+ objectType?: string;
348
+ }
349
+
350
+ export interface TypeFilter extends AbstractFilter {
351
+ type: "type";
352
+ types?: string[];
353
+ }
354
+
355
+ export interface Coordinate {
356
+ longitude?: number;
357
+ latitude?: number;
358
+ }
359
+
360
+ export interface MapCluster {
361
+ geohash?: string;
362
+ count?: number;
363
+ selectedCount?: number;
364
+ bounds?: number[][];
365
+ }
366
+
367
+ export interface MapShape {
368
+ solution?: string;
369
+ id?: string;
370
+ name?: string;
371
+ group?: string;
372
+ shape?: { [index: string]: any };
373
+ links?: Link[];
374
+ }
375
+
376
+ export interface Edge extends Endpoint {
377
+ endpointType: "Edge";
378
+ endpoints?: EndpointUnion[];
379
+ subtype?: string;
380
+ label?: string;
381
+ validFrom?: Date;
382
+ validTo?: Date;
383
+ fields?: SummaryFieldValue[];
384
+ style?: RelationshipStyle;
385
+ }
386
+
387
+ export interface Endpoint {
388
+ endpointType: "Edge" | "Extended";
389
+ type?: string;
390
+ id?: string;
391
+ compoundValues?: string[];
392
+ }
393
+
394
+ export interface ExtendedVertex extends Vertex {
395
+ vertexType: "Extended";
396
+ adjacent?: number;
397
+ degree?: number;
398
+ fields?: SummaryFieldValue[];
399
+ selected?: boolean;
400
+ adjacentByType?: { [index: string]: number };
401
+ degreeByType?: { [index: string]: number };
402
+ }
403
+
404
+ export interface Graph extends ResponsesErrorResponse {
405
+ counts?: Counts;
406
+ vertices?: VertexUnion[];
407
+ edges?: Edge[];
408
+ expansionLimit?: number;
409
+ expansionLimitExceeded?: ObjectId[];
410
+ }
411
+
412
+ export interface Counts {
413
+ vertices?: number;
414
+ edges?: number;
415
+ }
416
+
417
+ export interface Path {
418
+ endpoints?: EndpointUnion[];
419
+ }
420
+
421
+ export interface Vertex extends Endpoint {
422
+ vertexType: "Extended";
423
+ typeLabel?: string;
424
+ label?: string;
425
+ attachmentsCount?: number;
426
+ validFrom?: Date;
427
+ validTo?: Date;
428
+ style?: EntityStyle;
429
+ }
430
+
431
+ export interface ChildEntityHighlighting extends ChildEntityHighlightingParameters {
432
+ count?: number;
433
+ childObjects?: ChildObjectHighlighting[];
434
+ }
435
+
436
+ export interface ChildEntityHighlightingParameters {
437
+ start?: number;
438
+ limit?: number;
439
+ }
440
+
441
+ export interface ChildObjectHighlighting {
442
+ id?: string;
443
+ name?: string;
444
+ highlighting?: { [index: string]: any[] };
445
+ }
446
+
447
+ export interface ObjectId extends Serializable {
448
+ type?: string;
449
+ id?: string;
450
+ }
451
+
452
+ export interface TypeName extends Serializable {
453
+ name?: string;
454
+ systemType?: boolean;
455
+ }
456
+
457
+ export interface DocOrder extends Order {
458
+ type: "doc";
459
+ direction?: OrderDirection;
460
+ }
461
+
462
+ export interface FieldOrder extends Order {
463
+ type: "field";
464
+ fields?: Field[];
465
+ }
466
+
467
+ export interface Field {
468
+ name?: string;
469
+ entityType?: string;
470
+ direction?: OrderDirection;
471
+ }
472
+
473
+ export interface Order {
474
+ type: "doc" | "field" | "score";
475
+ }
476
+
477
+ export interface ScoreOrder extends Order {
478
+ type: "score";
479
+ direction?: OrderDirection;
480
+ }
481
+
482
+ export interface AbstractQuery {
483
+ type: "and" | "compound" | "endpoint" | "object" | "or" | "text";
484
+ }
485
+
486
+ export interface AndQuery extends AbstractQuery {
487
+ type: "and";
488
+ queries?: AbstractQueryUnion[];
489
+ }
490
+
491
+ export interface CompoundQuery extends AbstractQuery {
492
+ type: "compound";
493
+ compoundValues?: string[];
494
+ }
495
+
496
+ export interface EndpointQuery extends AbstractQuery {
497
+ type: "endpoint";
498
+ endpoints?: ObjectId[];
499
+ }
500
+
501
+ export interface ObjectQuery extends AbstractQuery {
502
+ type: "object";
503
+ objectIds?: ObjectId[];
504
+ }
505
+
506
+ export interface OrQuery extends AbstractQuery {
507
+ type: "or";
508
+ queries?: AbstractQueryUnion[];
509
+ }
510
+
511
+ export interface QueryVisitor<T> {
512
+ }
513
+
514
+ export interface TextQuery extends AbstractQuery {
515
+ type: "text";
516
+ text?: string;
517
+ language?: string;
518
+ modes?: QueryMode[];
519
+ }
520
+
521
+ export interface DateRange extends Range<string> {
522
+ }
523
+
524
+ export interface DateRangeBuilder {
525
+ }
526
+
527
+ export interface NumericalRange extends Range<number> {
528
+ }
529
+
530
+ export interface NumericalRangeBuilder {
531
+ }
532
+
533
+ export interface Range<V> {
534
+ description?: string;
535
+ gt?: V;
536
+ gte?: V;
537
+ lt?: V;
538
+ lte?: V;
539
+ }
540
+
541
+ export interface AnalyticsExploreRepresentation {
542
+ level?: ExplorationLevel;
543
+ }
544
+
545
+ export interface AnalyticsRepresentation extends QueryRepresentation {
546
+ categories?: ResultCategory[];
547
+ fields?: string[];
548
+ fromField?: string;
549
+ toFields?: string[];
550
+ excludes?: { [index: string]: string[] };
551
+ identities?: { [index: string]: Identity[] };
552
+ maxResultsPerCategory?: number;
553
+ locale?: string;
554
+ }
555
+
556
+ export interface AnalyticsSankeyRepresentation extends AnalyticsExploreRepresentation {
557
+ fromCategory?: ResultCategory;
558
+ toCategory?: ResultCategory;
559
+ fromAndTo?: boolean;
560
+ maxLinks?: number;
561
+ }
562
+
563
+ export interface GraphRepresentation {
564
+ vertexTypes?: string[];
565
+ edgeTypes?: string[];
566
+ query?: AbstractQueryUnion;
567
+ filter?: AbstractFilterUnion;
568
+ selection?: Selection;
569
+ }
570
+
571
+ export interface HighlightRepresentation {
572
+ type?: string;
573
+ id?: string;
574
+ query?: AbstractQueryUnion;
575
+ includeFieldHighlighting?: boolean;
576
+ defaultChildEntityLimit?: number;
577
+ childEntityHighlightingParameters?: { [index: string]: ChildEntityHighlightingParameters };
578
+ }
579
+
580
+ export interface OperationRepresentation {
581
+ operation?: OperationType;
582
+ parameters?: { [index: string]: any };
583
+ }
584
+
585
+ export interface PathsRepresentation {
586
+ type?: string;
587
+ id?: string;
588
+ nextLevel?: PathLevelRepresentation;
589
+ }
590
+
591
+ export interface PathLevelRepresentation {
592
+ vertexTypes?: string[];
593
+ edgeTypes?: string[];
594
+ vertexFilter?: AbstractFilterUnion;
595
+ edgeFilter?: AbstractFilterUnion;
596
+ nextLevel?: PathLevelRepresentation;
597
+ }
598
+
599
+ export interface QueryRepresentation {
600
+ types?: string[];
601
+ query?: AbstractQueryUnion;
602
+ }
603
+
604
+ export interface SearchRepresentation extends QueryRepresentation {
605
+ filter?: AbstractFilterUnion;
606
+ selection?: Selection;
607
+ visualizations?: { [index: string]: VisualizationRepresentationUnion };
608
+ }
609
+
610
+ export interface TraversalRepresentation {
611
+ vertexTypes?: string[];
612
+ edgeTypes?: string[];
613
+ query?: AbstractQueryUnion;
614
+ filter?: AbstractFilterUnion;
615
+ vertexFilter?: AbstractFilterUnion;
616
+ edgeFilter?: AbstractFilterUnion;
617
+ depth?: number;
618
+ extendedFormat?: boolean;
619
+ graphCompoundValues?: string[];
620
+ graphObjectIds?: ObjectId[];
621
+ }
622
+
623
+ export interface AnalyticsCategoriesResponse extends ResponsesErrorResponse {
624
+ identifier?: string;
625
+ level?: ExplorationLevel;
626
+ categories?: ResultCategory[];
627
+ fromAndTo?: boolean;
628
+ links?: Link[];
629
+ }
630
+
631
+ export interface AnalyticsIdentitiesResponse extends ResponsesErrorResponse {
632
+ identifier?: string;
633
+ identities?: { [index: string]: Identity[] };
634
+ links?: Link[];
635
+ }
636
+
637
+ export interface AnalyticsJobResponse extends ResponsesErrorResponse {
638
+ identifier?: string;
639
+ state?: JobState;
640
+ types?: string[];
641
+ query?: AbstractQueryUnion;
642
+ categories?: ResultCategory[];
643
+ fields?: string[];
644
+ fromField?: string;
645
+ toFields?: string[];
646
+ excludes?: { [index: string]: string[] };
647
+ identities?: { [index: string]: Identity[] };
648
+ maxResultsPerCategory?: number;
649
+ locale?: string;
650
+ links?: Link[];
651
+ }
652
+
653
+ export interface AnalyticsResultsResponse {
654
+ identifier?: string;
655
+ level?: ExplorationLevel;
656
+ results?: AnalyticsResult[];
657
+ links?: Link[];
658
+ }
659
+
660
+ export interface AnalyticsSankeyResponse {
661
+ identifier?: string;
662
+ level?: ExplorationLevel;
663
+ fromCategory?: ResultCategory;
664
+ toCategory?: ResultCategory;
665
+ fromAndTo?: boolean;
666
+ maxLinks?: number;
667
+ sankeyNodes?: SankeyNode[];
668
+ sankeyLinks?: SankeyLink[];
669
+ links?: Link[];
670
+ }
671
+
672
+ export interface ResponsesErrorResponse {
673
+ errors?: RepresentationsErrorResponse[];
674
+ }
675
+
676
+ export interface HighlightResponse extends ResponsesErrorResponse {
677
+ type?: string;
678
+ id?: string;
679
+ query?: AbstractQueryUnion;
680
+ includeFieldHighlighting?: boolean;
681
+ defaultChildEntityLimit?: number;
682
+ fieldHighlighting?: { [index: string]: any[] };
683
+ childEntityHighlighting?: { [index: string]: ChildEntityHighlighting };
684
+ }
685
+
686
+ export interface OperationResponse extends OperationRepresentation {
687
+ results?: { [index: string]: any };
688
+ }
689
+
690
+ export interface SearchResponse extends ResponsesErrorResponse {
691
+ types?: string[];
692
+ query?: AbstractQueryUnion;
693
+ visualizations?: { [index: string]: VisualizationResponseUnion };
694
+ }
695
+
696
+ export interface SynonymCollectionResponse extends ResourceCollection<Synonym> {
697
+ errors?: RepresentationsErrorResponse[];
698
+ }
699
+
700
+ export interface Selection {
701
+ filter?: AbstractFilterUnion;
702
+ include?: ManualSelection;
703
+ exclude?: ManualSelection;
704
+ }
705
+
706
+ export interface ManualSelection {
707
+ query?: string;
708
+ compoundValues?: string[];
709
+ objectIds?: ObjectId[];
710
+ }
711
+
712
+ export interface EntityStyle {
713
+ iconName?: string;
714
+ markerColor?: string;
715
+ backgroundColor?: string;
716
+ shape?: string;
717
+ scale?: number;
718
+ additionalLabel?: string;
719
+ borderWidth?: number;
720
+ borderColor?: string;
721
+ indicatorIcons?: IndicatorIcon[];
722
+ }
723
+
724
+ export interface IndicatorIcon {
725
+ name?: string;
726
+ position?: string;
727
+ }
728
+
729
+ export interface RelationshipStyle {
730
+ color?: string;
731
+ width?: number;
732
+ dashType?: string;
733
+ }
734
+
735
+ export interface EntitySummary extends ResultSummary {
736
+ summaryType: "object";
737
+ attachmentsCount?: number;
738
+ }
739
+
740
+ export interface ResolvedEntitySummary extends ResultSummary {
741
+ summaryType: "entity";
742
+ compoundValues?: string[];
743
+ }
744
+
745
+ export interface ResultSummary {
746
+ summaryType: "object" | "entity";
747
+ id?: string;
748
+ type?: string;
749
+ typeLabel?: string;
750
+ label?: string;
751
+ fields?: SummaryFieldValue[];
752
+ highlighting?: { [index: string]: string[] };
753
+ selected?: boolean;
754
+ }
755
+
756
+ export interface SummaryFieldValue {
757
+ name?: string;
758
+ type?: FieldType;
759
+ value?: any;
760
+ }
761
+
762
+ export interface TableColumnHeading {
763
+ field?: string;
764
+ label?: string;
765
+ type?: FieldType;
766
+ }
767
+
768
+ export interface ClusterSwimLaneEntry extends SwimLaneEntry {
769
+ entryType: "cluster";
770
+ label?: string;
771
+ }
772
+
773
+ export interface ObjectSwimLaneEntry extends SwimLaneEntry {
774
+ entryType: "object";
775
+ eventId?: string;
776
+ eventCategory?: string;
777
+ eventLabel?: string;
778
+ eventDescription?: string;
779
+ }
780
+
781
+ export interface SwimLane {
782
+ id?: Id;
783
+ label?: string;
784
+ description?: string;
785
+ attachmentsCount?: number;
786
+ objectTypeLabel?: string;
787
+ selected?: boolean;
788
+ objectId?: string;
789
+ objectType?: string;
790
+ }
791
+
792
+ export interface Id extends ObjectId {
793
+ }
794
+
795
+ export interface SwimLaneEntry {
796
+ entryType: "cluster" | "object";
797
+ group?: Id;
798
+ startTimestamp?: Date;
799
+ endTimestamp?: Date;
800
+ }
801
+
802
+ export interface TimebarInterval {
803
+ start?: Date;
804
+ hitCount?: number;
805
+ }
806
+
807
+ export interface RestClientUtil {
808
+ }
809
+
810
+ export interface FacetsVisualizationRepresentation extends VisualizationRepresentation {
811
+ type: "facets";
812
+ mode?: FacetMode;
813
+ types?: string[];
814
+ }
815
+
816
+ export interface FacetsVisualizationResponse extends VisualizationResponse {
817
+ type: "facets";
818
+ mode?: FacetMode;
819
+ facets?: TypeSpecificFacets[];
820
+ include?: ManualSelection;
821
+ exclude?: ManualSelection;
822
+ }
823
+
824
+ export interface TypeSpecificFacets {
825
+ objectType?: string;
826
+ objectTypeLabel?: string;
827
+ facets?: AbstractFacetUnion[];
828
+ userEnteredFilters?: AbstractFilterUnion[];
829
+ }
830
+
831
+ export interface HitsVisualizationRepresentation extends VisualizationRepresentation {
832
+ type: "hits";
833
+ }
834
+
835
+ export interface HitsVisualizationResponse extends VisualizationResponse {
836
+ type: "hits";
837
+ hitCount?: number;
838
+ hitsPerType?: TypeBucket[];
839
+ }
840
+
841
+ export interface MapClusterVisualizationResponse extends MapVisualizationResponse {
842
+ type: "mapCluster";
843
+ clusters?: MapCluster[];
844
+ }
845
+
846
+ export interface MapFeatureVisualizationRepresentation extends VisualizationRepresentation {
847
+ type: "mapFeature";
848
+ lat?: number;
849
+ lon?: number;
850
+ maxEvents?: number;
851
+ }
852
+
853
+ export interface MapFeatureVisualizationResponse extends VisualizationResponse {
854
+ type: "mapFeature";
855
+ lat?: number;
856
+ lon?: number;
857
+ maxEvents?: number;
858
+ features?: { [index: string]: any };
859
+ }
860
+
861
+ export interface MapVisualizationRepresentation extends VisualizationRepresentation {
862
+ type: "map";
863
+ view?: number[][];
864
+ maxFeatures?: number;
865
+ maxEvents?: number;
866
+ }
867
+
868
+ export interface MapVisualizationResponse extends VisualizationResponse {
869
+ type: "map" | "mapCluster";
870
+ view?: number[][];
871
+ maxFeatures?: number;
872
+ maxEvents?: number;
873
+ serviceMode?: MapServiceMode;
874
+ hitCount?: number;
875
+ eventCount?: number;
876
+ featureCount?: number;
877
+ approxGlobalFeatureCount?: number;
878
+ features?: { [index: string]: any };
879
+ }
880
+
881
+ export interface PagedVisualizationRepresentation extends VisualizationRepresentation {
882
+ type: "PagedVisualizationRepresentation" | "summary" | "table" | "timeline";
883
+ order?: OrderUnion;
884
+ start?: number;
885
+ limit?: number;
886
+ }
887
+
888
+ export interface PagedVisualizationResponse extends VisualizationResponse {
889
+ type: "PagedVisualizationResponse" | "summary" | "table" | "timeline";
890
+ start?: number;
891
+ limit?: number;
892
+ order?: OrderUnion;
893
+ hitCount?: number;
894
+ }
895
+
896
+ export interface SummaryVisualizationRepresentation extends PagedVisualizationRepresentation {
897
+ type: "summary";
898
+ }
899
+
900
+ export interface SummaryVisualizationResponse extends PagedVisualizationResponse {
901
+ type: "summary";
902
+ results?: ResultSummaryUnion[];
903
+ }
904
+
905
+ export interface TableVisualizationRepresentation extends PagedVisualizationRepresentation {
906
+ type: "table";
907
+ }
908
+
909
+ export interface TableVisualizationResponse extends PagedVisualizationResponse {
910
+ type: "table";
911
+ columnHeadings?: TableColumnHeading[];
912
+ data?: { [index: string]: any }[];
913
+ }
914
+
915
+ export interface TimebarVisualizationRepresentation extends VisualizationRepresentation {
916
+ type: "timebar";
917
+ startTimestamp?: Date;
918
+ endTimestamp?: Date;
919
+ intervalCount?: number;
920
+ geoEventsRequired?: boolean;
921
+ }
922
+
923
+ export interface TimebarVisualizationResponse extends VisualizationResponse {
924
+ type: "timebar";
925
+ intervalCount?: number;
926
+ geoEventsRequired?: boolean;
927
+ hitCount?: number;
928
+ eventCount?: number;
929
+ globalMinTime?: Date;
930
+ globalMaxTime?: Date;
931
+ interval?: string;
932
+ intervalSize?: number;
933
+ timebarIntervals?: TimebarInterval[];
934
+ }
935
+
936
+ export interface TimelineVisualizationRepresentation extends PagedVisualizationRepresentation {
937
+ type: "timeline";
938
+ startTimestamp?: Date;
939
+ endTimestamp?: Date;
940
+ intervalCount?: number;
941
+ minimumClusterSize?: number;
942
+ paddingFactor?: number;
943
+ }
944
+
945
+ export interface TimelineVisualizationResponse extends PagedVisualizationResponse {
946
+ type: "timeline";
947
+ intervalCount?: number;
948
+ minimumClusterSize?: number;
949
+ paddingFactor?: number;
950
+ eventCount?: number;
951
+ globalMinTime?: Date;
952
+ globalMaxTime?: Date;
953
+ minTime?: Date;
954
+ maxTime?: Date;
955
+ interval?: DateTimeInterval;
956
+ swimLanes?: SwimLane[];
957
+ swimLaneEntries?: SwimLaneEntryUnion[];
958
+ }
959
+
960
+ export interface VisualizationRepresentation {
961
+ type: "facets" | "hits" | "mapFeature" | "map" | "PagedVisualizationRepresentation" | "summary" | "table" | "timeline" | "timebar";
962
+ }
963
+
964
+ export interface VisualizationResponse {
965
+ type: "facets" | "hits" | "mapFeature" | "map" | "mapCluster" | "PagedVisualizationResponse" | "summary" | "table" | "timeline" | "timebar";
966
+ }
967
+
968
+ export interface RepresentationsErrorResponse extends Serializable {
969
+ errorCode?: number;
970
+ message?: string;
971
+ details?: string[];
972
+ remediation?: string;
973
+ errors?: RepresentationsErrorResponse[];
974
+ id?: string;
975
+ links?: Link[];
976
+ version?: number;
977
+ httpStatusCode?: number;
978
+ targetUri?: string;
979
+ }
980
+
981
+ export interface Link extends Serializable {
982
+ method?: string;
983
+ rel?: string;
984
+ href?: string;
985
+ uri?: string;
986
+ type?: string;
987
+ responseType?: string;
988
+ itemType?: string;
989
+ responseItemType?: string;
990
+ title?: string;
991
+ }
992
+
993
+ export interface Serializable {
994
+ }
995
+
996
+ export interface ResourceCollection<T> extends Serializable {
997
+ links?: Link[];
998
+ name?: string;
999
+ accept?: string;
1000
+ start?: number;
1001
+ count?: number;
1002
+ items?: T[];
1003
+ limit?: number;
1004
+ version?: number;
1005
+ }
1006
+
1007
+ export type OperationType = "refreshConfiguration" | "makeIndexSearchable" | "refreshSecurityRules";
1008
+
1009
+ export type JobState = "pending" | "running" | "completed" | "completedWithErrors" | "cancelled" | "failed";
1010
+
1011
+ export type ResultCategory = "unigram" | "bigram" | "trigram" | "person" | "organization" | "location" | "significantTerm" | "topic" | "invalid";
1012
+
1013
+ export type FromType = "gt" | "gte";
1014
+
1015
+ export type ToType = "lt" | "lte";
1016
+
1017
+ export type DateTimeAccuracy = "oneHundredYear" | "fiftyYear" | "tenYear" | "year" | "month" | "day" | "hour" | "minute" | "second" | "millisecond";
1018
+
1019
+ export type DateTimeInterval = "oneHundredYear" | "fiftyYear" | "tenYear" | "year" | "quarter" | "month" | "week" | "day" | "hour" | "minute" | "second";
1020
+
1021
+ export type FieldType = "boolean" | "date" | "double" | "float" | "geoPoint" | "geoShape" | "integer" | "long" | "nested" | "object" | "text";
1022
+
1023
+ export type TextFieldFeature = "search" | "facet" | "sort" | "html" | "email";
1024
+
1025
+ export type MapRelation = "contains" | "disjoint" | "intersects" | "within";
1026
+
1027
+ export type MapServiceMode = "global" | "viewport" | "clusters" | "clustersPostQuery";
1028
+
1029
+ export type TypeCategory = "alert" | "entity" | "entityRelationship" | "resolvedEntity" | "resolvedEntityRelationship" | "shape" | "socialRelationship" | "transactionRelationship";
1030
+
1031
+ export type OrderDirection = "ascending" | "descending";
1032
+
1033
+ export type QueryMode = "standard" | "phonetic" | "synonym";
1034
+
1035
+ export type FacetMode = "filter" | "selection";
1036
+
1037
+ export type FacetConfigUnion = TermsFacetConfig | NumericalRangeFacetConfig | DateRangeFacetConfig | TypeFacetConfig;
1038
+
1039
+ export type AbstractFacetUnion = TypeFacet | TermsFacet | NumericalRangeFacet | DateRangeFacet;
1040
+
1041
+ export type AbstractFilterUnion = TermsFilter | NumericalRangeFilter | DateRangeFilter | TypeFilter | MapRadiusFilter | MapBoundedBoxFilter | MapBoundedPolygonFilter | MapShapeFilter | QueryFilter | AndFilter | OrFilter | NotFilter;
1042
+
1043
+ export type EndpointUnion = Edge | Vertex | ExtendedVertex;
1044
+
1045
+ export type VertexUnion = ExtendedVertex;
1046
+
1047
+ export type OrderUnion = ScoreOrder | DocOrder | FieldOrder;
1048
+
1049
+ export type AbstractQueryUnion = TextQuery | ObjectQuery | AndQuery | OrQuery | EndpointQuery | CompoundQuery;
1050
+
1051
+ export type ResultSummaryUnion = EntitySummary | ResolvedEntitySummary;
1052
+
1053
+ export type SwimLaneEntryUnion = ClusterSwimLaneEntry | ObjectSwimLaneEntry;
1054
+
1055
+ export type VisualizationRepresentationUnion = HitsVisualizationRepresentation | SummaryVisualizationRepresentation | TableVisualizationRepresentation | TimelineVisualizationRepresentation | TimebarVisualizationRepresentation | MapVisualizationRepresentation | MapFeatureVisualizationRepresentation | FacetsVisualizationRepresentation;
1056
+
1057
+ export type VisualizationResponseUnion = HitsVisualizationResponse | SummaryVisualizationResponse | TableVisualizationResponse | TimelineVisualizationResponse | TimebarVisualizationResponse | MapVisualizationResponse | MapFeatureVisualizationResponse | MapClusterVisualizationResponse | FacetsVisualizationResponse;