@salesforce/lds-adapters-sfap-analytics-insights 1.314.0 → 1.316.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/es2018/sfap-analytics-insights.js +1276 -139
- 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/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/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 +1416 -279
- package/src/raml/api.raml +16 -51
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: |-
|
|
@@ -386,6 +374,7 @@ types:
|
|
|
386
374
|
- INSIGHT_BUNDLE_TYPE_BAN
|
|
387
375
|
- INSIGHT_BUNDLE_TYPE_SPRINGBOARD
|
|
388
376
|
- INSIGHT_BUNDLE_TYPE_DETAIL
|
|
377
|
+
- INSIGHT_BUNDLE_TYPE_BASIC
|
|
389
378
|
type: string
|
|
390
379
|
(amf-format): enum
|
|
391
380
|
required: false
|
|
@@ -396,15 +385,11 @@ types:
|
|
|
396
385
|
required: false
|
|
397
386
|
input:
|
|
398
387
|
description: The input to the bundle type
|
|
399
|
-
|
|
400
|
-
- InsightBundleInput
|
|
401
|
-
type: any
|
|
388
|
+
type: InsightBundleInput
|
|
402
389
|
required: false
|
|
403
390
|
options:
|
|
404
391
|
description: Options affecting the generation of the bundle
|
|
405
|
-
|
|
406
|
-
- InsightBundleOptions
|
|
407
|
-
type: any
|
|
392
|
+
type: InsightBundleOptions
|
|
408
393
|
required: false
|
|
409
394
|
FlattenFilter:
|
|
410
395
|
description: |-
|
|
@@ -440,9 +425,7 @@ types:
|
|
|
440
425
|
Note that it is possible that we encountered some errors but were still
|
|
441
426
|
able to compute part of the result. In that case, the result key will be
|
|
442
427
|
present, and there will be errors at the appropriate level inside
|
|
443
|
-
|
|
444
|
-
- InsightBundle
|
|
445
|
-
type: any
|
|
428
|
+
type: InsightBundle
|
|
446
429
|
required: false
|
|
447
430
|
error:
|
|
448
431
|
type: Error
|
|
@@ -579,19 +562,13 @@ types:
|
|
|
579
562
|
required: false
|
|
580
563
|
summary:
|
|
581
564
|
description: Summary generated by GAI
|
|
582
|
-
|
|
583
|
-
- SummaryResponse
|
|
584
|
-
type: any
|
|
565
|
+
type: SummaryResponse
|
|
585
566
|
required: false
|
|
586
567
|
Overview:
|
|
587
568
|
type: object
|
|
588
569
|
properties:
|
|
589
570
|
viz:
|
|
590
|
-
type:
|
|
591
|
-
required: false
|
|
592
|
-
vegaLiteViz:
|
|
593
|
-
description: Vega-lite spec giving a summary viz
|
|
594
|
-
type: object
|
|
571
|
+
type: any
|
|
595
572
|
required: false
|
|
596
573
|
RelativeDateFilterOptions:
|
|
597
574
|
type: object
|
|
@@ -636,15 +613,11 @@ types:
|
|
|
636
613
|
properties:
|
|
637
614
|
bundle:
|
|
638
615
|
description: Options to apply to each insight bundle
|
|
639
|
-
|
|
640
|
-
- InsightBundleOptions
|
|
641
|
-
type: any
|
|
616
|
+
type: InsightBundleOptions
|
|
642
617
|
required: false
|
|
643
618
|
summarization:
|
|
644
619
|
description: Options to apply to desired summary
|
|
645
|
-
|
|
646
|
-
- SummarizationOptions
|
|
647
|
-
type: any
|
|
620
|
+
type: SummarizationOptions
|
|
648
621
|
required: false
|
|
649
622
|
skipCache:
|
|
650
623
|
description: Option to skip checking for batch/summary in cache
|
|
@@ -660,9 +633,7 @@ types:
|
|
|
660
633
|
required: false
|
|
661
634
|
options:
|
|
662
635
|
description: Options to apply to the entire batch
|
|
663
|
-
|
|
664
|
-
- BatchOptions
|
|
665
|
-
type: any
|
|
636
|
+
type: BatchOptions
|
|
666
637
|
required: false
|
|
667
638
|
Filter:
|
|
668
639
|
type: object
|
|
@@ -702,9 +673,7 @@ types:
|
|
|
702
673
|
required: false
|
|
703
674
|
semanticFilter:
|
|
704
675
|
description: The 'filters' and 'semantic_filter' will be ANDed together
|
|
705
|
-
|
|
706
|
-
- FlattenFilter
|
|
707
|
-
type: any
|
|
676
|
+
type: FlattenFilter
|
|
708
677
|
required: false
|
|
709
678
|
SemanticFilter:
|
|
710
679
|
description: Message representing Semantic Filter.
|
|
@@ -788,19 +757,15 @@ types:
|
|
|
788
757
|
- SUMMARIZATION_STRATEGY_DIGEST
|
|
789
758
|
type: string
|
|
790
759
|
(amf-format): enum
|
|
791
|
-
required: false
|
|
792
760
|
markup:
|
|
793
761
|
description: Text for the summary
|
|
794
762
|
type: string
|
|
795
|
-
required: false
|
|
796
763
|
generationId:
|
|
797
764
|
description: ID of the Einstein GPT generation request.
|
|
798
765
|
type: string
|
|
799
|
-
required: false
|
|
800
766
|
timestamp:
|
|
801
767
|
description: Timestamp of the summary generation in UTC
|
|
802
768
|
type: string
|
|
803
|
-
required: false
|
|
804
769
|
Measure:
|
|
805
770
|
type: object
|
|
806
771
|
properties:
|