@salesforce/lds-adapters-cdp-semantic-authoring 1.379.1 → 1.380.0-dev10

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 (28) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +723 -155
  2. package/dist/es/es2018/types/src/generated/adapters/getSemanticModel.d.ts +1 -0
  3. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsByModelApiNameOrId.d.ts +1 -0
  4. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsShallowByModelApiNameOrId.d.ts +1 -0
  5. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +7 -1
  6. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +7 -1
  7. package/dist/es/es2018/types/src/generated/types/SemanticDataObjectOutputRepresentation.d.ts +4 -1
  8. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +7 -1
  9. package/dist/es/es2018/types/src/generated/types/SemanticGoalOutputRepresentation.d.ts +4 -1
  10. package/dist/es/es2018/types/src/generated/types/SemanticGroupingOutputRepresentation.d.ts +7 -1
  11. package/dist/es/es2018/types/src/generated/types/SemanticInsightsSettingsInputRepresentation.d.ts +5 -1
  12. package/dist/es/es2018/types/src/generated/types/SemanticInsightsSettingsOutputRepresentation.d.ts +5 -1
  13. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewOutputRepresentation.d.ts +4 -1
  14. package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldOutputRepresentation.d.ts +4 -1
  15. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +7 -1
  16. package/dist/es/es2018/types/src/generated/types/SemanticMetricForecastConfigurationInputRepresentation.d.ts +29 -0
  17. package/dist/es/es2018/types/src/generated/types/SemanticMetricForecastConfigurationOutputRepresentation.d.ts +29 -0
  18. package/dist/es/es2018/types/src/generated/types/SemanticMetricOutputRepresentation.d.ts +4 -1
  19. package/dist/es/es2018/types/src/generated/types/SemanticModelExternalConnectionOutputRepresentation.d.ts +4 -1
  20. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +7 -1
  21. package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +4 -1
  22. package/dist/es/es2018/types/src/generated/types/SemanticParameterOutputRepresentation.d.ts +7 -1
  23. package/dist/es/es2018/types/src/generated/types/SemanticRelationshipOutputRepresentation.d.ts +4 -1
  24. package/dist/es/es2018/types/src/generated/types/SemanticSubMetricOutputRepresentation.d.ts +4 -1
  25. package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +4 -1
  26. package/package.json +3 -3
  27. package/sfdc/index.js +881 -313
  28. package/src/raml/api.raml +137 -1
package/src/raml/api.raml CHANGED
@@ -2,7 +2,7 @@
2
2
  securedBy:
3
3
  - OAuth2
4
4
  title: Salesforce Connect API
5
- version: '64.0'
5
+ version: '65.0'
6
6
  mediaType: application/json
7
7
  protocols:
8
8
  - https
@@ -68,6 +68,13 @@ types:
68
68
  enum:
69
69
  - Bin
70
70
  - Group
71
+ SemanticEntityIsQueryableEnum:
72
+ description: Indicates if the entity can be queried in semantic query engine
73
+ type: string
74
+ enum:
75
+ - NonQueryable
76
+ - Queryable
77
+ - Unknown
71
78
  TimeRangeTypeEnum:
72
79
  description: The type of the time range.
73
80
  type: string
@@ -630,6 +637,10 @@ types:
630
637
  id:
631
638
  description: The object ID of the semantic entity.
632
639
  type: string
640
+ isQueryable:
641
+ description: Indicates if the entity can be queried in semantic query engine
642
+ type: SemanticEntityIsQueryableEnum
643
+ required: false
633
644
  label:
634
645
  description: The display name of the semantic entity to be used in the ui.
635
646
  type: string
@@ -702,6 +713,10 @@ types:
702
713
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
703
714
  type: boolean
704
715
  required: false
716
+ externalDataType:
717
+ description: the external data type.
718
+ type: string
719
+ required: false
705
720
  SemanticCalculatedMeasurementCollectionOutputRepresentation:
706
721
  description: A collection of Semantic Calculated Measurements.
707
722
  type: object
@@ -832,6 +847,10 @@ types:
832
847
  id:
833
848
  description: The object ID of the semantic entity.
834
849
  type: string
850
+ isQueryable:
851
+ description: Indicates if the entity can be queried in semantic query engine
852
+ type: SemanticEntityIsQueryableEnum
853
+ required: false
835
854
  label:
836
855
  description: The display name of the semantic entity to be used in the ui.
837
856
  type: string
@@ -928,6 +947,10 @@ types:
928
947
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
929
948
  type: boolean
930
949
  required: false
950
+ externalDataType:
951
+ description: the external data type.
952
+ type: string
953
+ required: false
931
954
  SemanticModelExternalConnectionInputRepresentation:
932
955
  description: Represents a semantic model external connection.
933
956
  type: object
@@ -956,6 +979,10 @@ types:
956
979
  id:
957
980
  description: The object ID of the semantic entity.
958
981
  type: string
982
+ isQueryable:
983
+ description: Indicates if the entity can be queried in semantic query engine
984
+ type: SemanticEntityIsQueryableEnum
985
+ required: false
959
986
  label:
960
987
  description: The display name of the semantic entity to be used in the ui.
961
988
  type: string
@@ -1135,6 +1162,10 @@ types:
1135
1162
  id:
1136
1163
  description: The object ID of the semantic entity.
1137
1164
  type: string
1165
+ isQueryable:
1166
+ description: Indicates if the entity can be queried in semantic query engine
1167
+ type: SemanticEntityIsQueryableEnum
1168
+ required: false
1138
1169
  label:
1139
1170
  description: The display name of the semantic entity to be used in the ui.
1140
1171
  type: string
@@ -1371,6 +1402,10 @@ types:
1371
1402
  id:
1372
1403
  description: The object ID of the semantic entity.
1373
1404
  type: string
1405
+ isQueryable:
1406
+ description: Indicates if the entity can be queried in semantic query engine
1407
+ type: SemanticEntityIsQueryableEnum
1408
+ required: false
1374
1409
  label:
1375
1410
  description: The display name of the semantic entity to be used in the ui.
1376
1411
  type: string
@@ -1437,6 +1472,10 @@ types:
1437
1472
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
1438
1473
  type: boolean
1439
1474
  required: false
1475
+ externalDataType:
1476
+ description: the external data type.
1477
+ type: string
1478
+ required: false
1440
1479
  SemanticFieldReferenceInputRepresentation:
1441
1480
  description: Input representation field reference
1442
1481
  type: object
@@ -1595,6 +1634,10 @@ types:
1595
1634
  id:
1596
1635
  description: The object ID of the semantic entity.
1597
1636
  type: string
1637
+ isQueryable:
1638
+ description: Indicates if the entity can be queried in semantic query engine
1639
+ type: SemanticEntityIsQueryableEnum
1640
+ required: false
1598
1641
  label:
1599
1642
  description: The display name of the semantic entity to be used in the ui.
1600
1643
  type: string
@@ -1766,6 +1809,10 @@ types:
1766
1809
  id:
1767
1810
  description: The object ID of the semantic entity.
1768
1811
  type: string
1812
+ isQueryable:
1813
+ description: Indicates if the entity can be queried in semantic query engine
1814
+ type: SemanticEntityIsQueryableEnum
1815
+ required: false
1769
1816
  label:
1770
1817
  description: The display name of the semantic entity to be used in the ui.
1771
1818
  type: string
@@ -1797,6 +1844,10 @@ types:
1797
1844
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
1798
1845
  type: boolean
1799
1846
  required: false
1847
+ externalDataType:
1848
+ description: the external data type.
1849
+ type: string
1850
+ required: false
1800
1851
  SemanticIdentifyingDimensionInputRepresentation:
1801
1852
  description: Input representation for creating relationship between identifier and name dimensions
1802
1853
  type: object
@@ -1822,6 +1873,23 @@ types:
1822
1873
  description: Provides the naming for the identified dimension
1823
1874
  type: SemanticFieldReferenceOutputRepresentation
1824
1875
  required: false
1876
+ SemanticMetricForecastConfigurationInputRepresentation:
1877
+ description: Input representation for metric forecast configuration
1878
+ type: object
1879
+ properties:
1880
+ forecastMeasurementReference:
1881
+ description: Reference to the forecast measurement field
1882
+ type: SemanticFieldReferenceInputRepresentation
1883
+ required: false
1884
+ SemanticMetricForecastConfigurationOutputRepresentation:
1885
+ description: Output representation for metric forecast configuration.
1886
+ type: object
1887
+ additionalProperties: true
1888
+ properties:
1889
+ forecastMeasurementReference:
1890
+ description: Reference to the forecast measurement field
1891
+ type: SemanticFieldReferenceOutputRepresentation
1892
+ required: false
1825
1893
  SemanticInsightTypeInputRepresentation:
1826
1894
  description: Input representation for insight type
1827
1895
  type: object
@@ -1879,6 +1947,10 @@ types:
1879
1947
  description: Uses a singular noun to represent units.
1880
1948
  type: string
1881
1949
  required: false
1950
+ forecastConfiguration:
1951
+ description: Configuration for metric forecasting.
1952
+ type: SemanticMetricForecastConfigurationInputRepresentation
1953
+ required: false
1882
1954
  SemanticInsightsSettingsOutputRepresentation:
1883
1955
  description: Output representation for metrics insights settings
1884
1956
  type: object
@@ -1912,6 +1984,10 @@ types:
1912
1984
  description: Uses a singular noun to represent units.
1913
1985
  type: string
1914
1986
  required: false
1987
+ forecastConfiguration:
1988
+ description: Configuration for metric forecasting.
1989
+ type: SemanticMetricForecastConfigurationOutputRepresentation
1990
+ required: false
1915
1991
  SemanticLogicalViewCollectionOutputRepresentation:
1916
1992
  description: A representation of a collection of semantic logical views.
1917
1993
  type: object
@@ -2008,6 +2084,10 @@ types:
2008
2084
  id:
2009
2085
  description: The object ID of the semantic entity.
2010
2086
  type: string
2087
+ isQueryable:
2088
+ description: Indicates if the entity can be queried in semantic query engine
2089
+ type: SemanticEntityIsQueryableEnum
2090
+ required: false
2011
2091
  label:
2012
2092
  description: The display name of the semantic entity to be used in the ui.
2013
2093
  type: string
@@ -2178,6 +2258,10 @@ types:
2178
2258
  id:
2179
2259
  description: The object ID of the semantic entity.
2180
2260
  type: string
2261
+ isQueryable:
2262
+ description: Indicates if the entity can be queried in semantic query engine
2263
+ type: SemanticEntityIsQueryableEnum
2264
+ required: false
2181
2265
  label:
2182
2266
  description: The display name of the semantic entity to be used in the ui.
2183
2267
  type: string
@@ -2322,6 +2406,10 @@ types:
2322
2406
  id:
2323
2407
  description: The object ID of the semantic entity.
2324
2408
  type: string
2409
+ isQueryable:
2410
+ description: Indicates if the entity can be queried in semantic query engine
2411
+ type: SemanticEntityIsQueryableEnum
2412
+ required: false
2325
2413
  label:
2326
2414
  description: The display name of the semantic entity to be used in the ui.
2327
2415
  type: string
@@ -2408,6 +2496,10 @@ types:
2408
2496
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
2409
2497
  type: boolean
2410
2498
  required: false
2499
+ externalDataType:
2500
+ description: the external data type.
2501
+ type: string
2502
+ required: false
2411
2503
  SemanticMetricAdditionalDimensionInputRepresentation:
2412
2504
  description: Input representation for updating semantic metric with additional dimensions
2413
2505
  type: object
@@ -2560,6 +2652,10 @@ types:
2560
2652
  id:
2561
2653
  description: The object ID of the semantic entity.
2562
2654
  type: string
2655
+ isQueryable:
2656
+ description: Indicates if the entity can be queried in semantic query engine
2657
+ type: SemanticEntityIsQueryableEnum
2658
+ required: false
2563
2659
  label:
2564
2660
  description: The display name of the semantic entity to be used in the ui.
2565
2661
  type: string
@@ -2865,6 +2961,10 @@ types:
2865
2961
  id:
2866
2962
  description: The object ID of the semantic entity.
2867
2963
  type: string
2964
+ isQueryable:
2965
+ description: Indicates if the entity can be queried in semantic query engine
2966
+ type: SemanticEntityIsQueryableEnum
2967
+ required: false
2868
2968
  label:
2869
2969
  description: The display name of the semantic entity to be used in the ui.
2870
2970
  type: string
@@ -2900,6 +3000,10 @@ types:
2900
3000
  description: Is the model locked for edit/ delete.
2901
3001
  type: boolean
2902
3002
  required: false
3003
+ isPartialSdm:
3004
+ description: Indicates if the model is partial because of Data Gov.
3005
+ type: boolean
3006
+ required: false
2903
3007
  queryUnrelatedDataObjects:
2904
3008
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2905
3009
  type: SemanticQueryUnrelatedDataObjectsTypeEnum
@@ -3075,6 +3179,10 @@ types:
3075
3179
  id:
3076
3180
  description: The object ID of the semantic entity.
3077
3181
  type: string
3182
+ isQueryable:
3183
+ description: Indicates if the entity can be queried in semantic query engine
3184
+ type: SemanticEntityIsQueryableEnum
3185
+ required: false
3078
3186
  label:
3079
3187
  description: The display name of the semantic entity to be used in the ui.
3080
3188
  type: string
@@ -3369,6 +3477,10 @@ types:
3369
3477
  id:
3370
3478
  description: The object ID of the semantic entity.
3371
3479
  type: string
3480
+ isQueryable:
3481
+ description: Indicates if the entity can be queried in semantic query engine
3482
+ type: SemanticEntityIsQueryableEnum
3483
+ required: false
3372
3484
  label:
3373
3485
  description: The display name of the semantic entity to be used in the ui.
3374
3486
  type: string
@@ -3421,6 +3533,10 @@ types:
3421
3533
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
3422
3534
  type: boolean
3423
3535
  required: false
3536
+ externalDataType:
3537
+ description: the external data type.
3538
+ type: string
3539
+ required: false
3424
3540
  SemanticParameterListValueInputRepresentation:
3425
3541
  description: Input representation of an allowed list value for a semantic parameter .
3426
3542
  type: object
@@ -3578,6 +3694,10 @@ types:
3578
3694
  id:
3579
3695
  description: The object ID of the semantic entity.
3580
3696
  type: string
3697
+ isQueryable:
3698
+ description: Indicates if the entity can be queried in semantic query engine
3699
+ type: SemanticEntityIsQueryableEnum
3700
+ required: false
3581
3701
  label:
3582
3702
  description: The display name of the semantic entity to be used in the ui.
3583
3703
  type: string
@@ -3725,6 +3845,10 @@ types:
3725
3845
  id:
3726
3846
  description: The object ID of the semantic entity.
3727
3847
  type: string
3848
+ isQueryable:
3849
+ description: Indicates if the entity can be queried in semantic query engine
3850
+ type: SemanticEntityIsQueryableEnum
3851
+ required: false
3728
3852
  label:
3729
3853
  description: The display name of the semantic entity to be used in the ui.
3730
3854
  type: string
@@ -3904,6 +4028,10 @@ types:
3904
4028
  id:
3905
4029
  description: The object ID of the semantic entity.
3906
4030
  type: string
4031
+ isQueryable:
4032
+ description: Indicates if the entity can be queried in semantic query engine
4033
+ type: SemanticEntityIsQueryableEnum
4034
+ required: false
3907
4035
  label:
3908
4036
  description: The display name of the semantic entity to be used in the ui.
3909
4037
  type: string
@@ -4115,6 +4243,10 @@ types:
4115
4243
  description: Filters search results based on fields that contain a specific string in their label.
4116
4244
  type: string
4117
4245
  required: false
4246
+ fineGrainSecurity:
4247
+ description: Use fine grain security for partial SDM.
4248
+ type: boolean
4249
+ required: false
4118
4250
  includeModelContent:
4119
4251
  description: Enrich model with its content in response.
4120
4252
  type: boolean
@@ -5302,6 +5434,10 @@ types:
5302
5434
  description: Filters search results based on fields that contain a specific string in their label.
5303
5435
  type: string
5304
5436
  required: false
5437
+ fineGrainSecurity:
5438
+ description: Use fine grain security for partial SDM.
5439
+ type: boolean
5440
+ required: false
5305
5441
  includeModelContent:
5306
5442
  description: Enrich model with its content in response.
5307
5443
  type: boolean