@salesforce/lds-adapters-sfap-analytics-insights 1.309.0-dev12 → 1.309.0-dev13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/es2018/sfap-analytics-insights.js +1355 -198
- package/dist/es/es2018/types/src/generated/adapters/createInsightsBatch.d.ts +2 -1
- package/dist/es/es2018/types/src/generated/adapters/generateInsights.d.ts +4 -2
- package/dist/es/es2018/types/src/generated/adapters/getMetricFilterValues.d.ts +2 -1
- package/dist/es/es2018/types/src/generated/resources/postAnalyticsInsightsV1Batches.d.ts +2 -1
- package/dist/es/es2018/types/src/generated/resources/postAnalyticsInsightsV1FilterValues.d.ts +2 -1
- package/dist/es/es2018/types/src/generated/resources/postAnalyticsInsightsV1GenerateBundle.d.ts +4 -2
- package/dist/es/es2018/types/src/generated/types/BatchOptions.d.ts +7 -5
- package/dist/es/es2018/types/src/generated/types/Filter.d.ts +11 -9
- package/dist/es/es2018/types/src/generated/types/GenerateInsightBatchRequest.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/GenerateInsightBatchResponse.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/GenerateInsightBundleRequest.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/GenerateInsightBundleResponse.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/GetFilterValuesRequest.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/GetInsightBatchResponse.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/Insight.d.ts +5 -8
- package/dist/es/es2018/types/src/generated/types/MeasurementPeriod.d.ts +7 -9
- package/dist/es/es2018/types/src/generated/types/MetricDefinition.d.ts +4 -4
- package/dist/es/es2018/types/src/generated/types/MetricInstance.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/Overview.d.ts +3 -6
- package/dist/es/es2018/types/src/generated/types/Summary.d.ts +9 -9
- package/package.json +3 -3
- package/sfdc/index.js +1466 -309
- package/src/raml/api.raml +34 -56
package/src/raml/api.raml
CHANGED
|
@@ -89,10 +89,10 @@ types:
|
|
|
89
89
|
type: string
|
|
90
90
|
required: false
|
|
91
91
|
viz:
|
|
92
|
-
type:
|
|
92
|
+
type: any
|
|
93
93
|
required: false
|
|
94
94
|
facts:
|
|
95
|
-
type:
|
|
95
|
+
type: any
|
|
96
96
|
required: false
|
|
97
97
|
characterization:
|
|
98
98
|
enum:
|
|
@@ -113,10 +113,6 @@ types:
|
|
|
113
113
|
type: string
|
|
114
114
|
required: false
|
|
115
115
|
insightFeedbackMetadata: InsightFeedbackMetadata
|
|
116
|
-
vegaLiteViz:
|
|
117
|
-
description: vegaLiteViz will be removed in the future
|
|
118
|
-
type: object
|
|
119
|
-
required: false
|
|
120
116
|
Error:
|
|
121
117
|
type: object
|
|
122
118
|
properties:
|
|
@@ -148,9 +144,7 @@ types:
|
|
|
148
144
|
required: false
|
|
149
145
|
semanticFilter:
|
|
150
146
|
description: The 'filters' and 'semantic_filters' will be ANDed together
|
|
151
|
-
|
|
152
|
-
- FlattenFilter
|
|
153
|
-
type: any
|
|
147
|
+
type: FlattenFilter
|
|
154
148
|
required: false
|
|
155
149
|
MeasurementPeriod:
|
|
156
150
|
type: object
|
|
@@ -160,15 +154,11 @@ types:
|
|
|
160
154
|
Server side, we validate that :
|
|
161
155
|
1. the filter type is 'range' or 'relative-date'
|
|
162
156
|
2. the field is date or date-time field on the SDM
|
|
163
|
-
|
|
164
|
-
- Filter
|
|
165
|
-
type: any
|
|
157
|
+
type: Filter
|
|
166
158
|
required: false
|
|
167
159
|
relativePeriod:
|
|
168
160
|
description: Define the measurement period with a granularity and a range
|
|
169
|
-
|
|
170
|
-
- RelativePeriod
|
|
171
|
-
type: any
|
|
161
|
+
type: RelativePeriod
|
|
172
162
|
required: false
|
|
173
163
|
RelativeDate:
|
|
174
164
|
type: object
|
|
@@ -302,9 +292,7 @@ types:
|
|
|
302
292
|
required: true
|
|
303
293
|
summary:
|
|
304
294
|
description: If a cached summary exists, return the summary immediately
|
|
305
|
-
|
|
306
|
-
- SummaryResponse
|
|
307
|
-
type: any
|
|
295
|
+
type: SummaryResponse
|
|
308
296
|
required: false
|
|
309
297
|
timestamp:
|
|
310
298
|
description: |-
|
|
@@ -325,7 +313,9 @@ types:
|
|
|
325
313
|
type: array
|
|
326
314
|
items: Filter
|
|
327
315
|
required: false
|
|
328
|
-
semanticFilter:
|
|
316
|
+
semanticFilter: # TODO delete this?
|
|
317
|
+
type: FlattenFilter
|
|
318
|
+
required: false
|
|
329
319
|
BatchInput:
|
|
330
320
|
type: object
|
|
331
321
|
properties:
|
|
@@ -396,15 +386,11 @@ types:
|
|
|
396
386
|
required: false
|
|
397
387
|
input:
|
|
398
388
|
description: The input to the bundle type
|
|
399
|
-
|
|
400
|
-
- InsightBundleInput
|
|
401
|
-
type: any
|
|
389
|
+
type: InsightBundleInput
|
|
402
390
|
required: false
|
|
403
391
|
options:
|
|
404
392
|
description: Options affecting the generation of the bundle
|
|
405
|
-
|
|
406
|
-
- InsightBundleOptions
|
|
407
|
-
type: any
|
|
393
|
+
type: InsightBundleOptions
|
|
408
394
|
required: false
|
|
409
395
|
FlattenFilter:
|
|
410
396
|
description: |-
|
|
@@ -440,9 +426,7 @@ types:
|
|
|
440
426
|
Note that it is possible that we encountered some errors but were still
|
|
441
427
|
able to compute part of the result. In that case, the result key will be
|
|
442
428
|
present, and there will be errors at the appropriate level inside
|
|
443
|
-
|
|
444
|
-
- InsightBundle
|
|
445
|
-
type: any
|
|
429
|
+
type: InsightBundle
|
|
446
430
|
required: false
|
|
447
431
|
error:
|
|
448
432
|
type: Error
|
|
@@ -579,19 +563,13 @@ types:
|
|
|
579
563
|
required: false
|
|
580
564
|
summary:
|
|
581
565
|
description: Summary generated by GAI
|
|
582
|
-
|
|
583
|
-
- SummaryResponse
|
|
584
|
-
type: any
|
|
566
|
+
type: SummaryResponse
|
|
585
567
|
required: false
|
|
586
568
|
Overview:
|
|
587
569
|
type: object
|
|
588
570
|
properties:
|
|
589
571
|
viz:
|
|
590
|
-
type:
|
|
591
|
-
required: false
|
|
592
|
-
vegaLiteViz:
|
|
593
|
-
description: Vega-lite spec giving a summary viz
|
|
594
|
-
type: object
|
|
572
|
+
type: any
|
|
595
573
|
required: false
|
|
596
574
|
RelativeDateFilterOptions:
|
|
597
575
|
type: object
|
|
@@ -636,15 +614,11 @@ types:
|
|
|
636
614
|
properties:
|
|
637
615
|
bundle:
|
|
638
616
|
description: Options to apply to each insight bundle
|
|
639
|
-
|
|
640
|
-
- InsightBundleOptions
|
|
641
|
-
type: any
|
|
617
|
+
type: InsightBundleOptions
|
|
642
618
|
required: false
|
|
643
619
|
summarization:
|
|
644
620
|
description: Options to apply to desired summary
|
|
645
|
-
|
|
646
|
-
- SummarizationOptions
|
|
647
|
-
type: any
|
|
621
|
+
type: SummarizationOptions
|
|
648
622
|
required: false
|
|
649
623
|
skipCache:
|
|
650
624
|
description: Option to skip checking for batch/summary in cache
|
|
@@ -660,10 +634,9 @@ types:
|
|
|
660
634
|
required: false
|
|
661
635
|
options:
|
|
662
636
|
description: Options to apply to the entire batch
|
|
663
|
-
|
|
664
|
-
- BatchOptions
|
|
665
|
-
type: any
|
|
637
|
+
type: BatchOptions
|
|
666
638
|
required: false
|
|
639
|
+
# TODO make these more strict
|
|
667
640
|
Filter:
|
|
668
641
|
type: object
|
|
669
642
|
properties:
|
|
@@ -675,10 +648,21 @@ types:
|
|
|
675
648
|
'relative-date'
|
|
676
649
|
type: string
|
|
677
650
|
required: false
|
|
678
|
-
field:
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
651
|
+
field:
|
|
652
|
+
type: FieldId
|
|
653
|
+
required: false
|
|
654
|
+
fieldId:
|
|
655
|
+
type: FieldId
|
|
656
|
+
required: false
|
|
657
|
+
categoricalFilterOptions:
|
|
658
|
+
type: CategoricalFilterOptions
|
|
659
|
+
required: false
|
|
660
|
+
rangeFilterOptions:
|
|
661
|
+
type: RangeFilterOptions
|
|
662
|
+
required: false
|
|
663
|
+
relativeDateFilterOptions:
|
|
664
|
+
type: RelativeDateFilterOptions
|
|
665
|
+
required: false
|
|
682
666
|
GetFilterValuesRequest:
|
|
683
667
|
type: object
|
|
684
668
|
properties:
|
|
@@ -702,9 +686,7 @@ types:
|
|
|
702
686
|
required: false
|
|
703
687
|
semanticFilter:
|
|
704
688
|
description: The 'filters' and 'semantic_filter' will be ANDed together
|
|
705
|
-
|
|
706
|
-
- FlattenFilter
|
|
707
|
-
type: any
|
|
689
|
+
type: FlattenFilter
|
|
708
690
|
required: false
|
|
709
691
|
SemanticFilter:
|
|
710
692
|
description: Message representing Semantic Filter.
|
|
@@ -788,19 +770,15 @@ types:
|
|
|
788
770
|
- SUMMARIZATION_STRATEGY_DIGEST
|
|
789
771
|
type: string
|
|
790
772
|
(amf-format): enum
|
|
791
|
-
required: false
|
|
792
773
|
markup:
|
|
793
774
|
description: Text for the summary
|
|
794
775
|
type: string
|
|
795
|
-
required: false
|
|
796
776
|
generationId:
|
|
797
777
|
description: ID of the Einstein GPT generation request.
|
|
798
778
|
type: string
|
|
799
|
-
required: false
|
|
800
779
|
timestamp:
|
|
801
780
|
description: Timestamp of the summary generation in UTC
|
|
802
781
|
type: string
|
|
803
|
-
required: false
|
|
804
782
|
Measure:
|
|
805
783
|
type: object
|
|
806
784
|
properties:
|