@salesforce/lds-adapters-cdp-semantic-authoring 1.309.0-dev16 → 1.309.0-dev18

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 (23) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +903 -539
  2. package/dist/es/es2018/types/src/generated/adapters/deleteGoalFromSubMetric.d.ts +15 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getSemanticSubMetrics.d.ts +1 -0
  4. package/dist/es/es2018/types/src/generated/adapters/patchSemanticMetricGoal.d.ts +21 -0
  5. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +3 -1
  7. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +1 -0
  8. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsSubMetricsByModelApiNameOrId.d.ts +3 -0
  9. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +4 -4
  10. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticPermissions.d.ts +12 -0
  11. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +2 -1
  12. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsByModelApiNameOrId.d.ts +2 -1
  13. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +2 -1
  14. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedFieldInputRepresentation.d.ts +46 -0
  15. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewInputRepresentation.d.ts +7 -4
  16. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewOutputRepresentation.d.ts +9 -4
  17. package/dist/es/es2018/types/src/generated/types/SemanticModelInfoOutputRepresentation.d.ts +34 -0
  18. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +5 -1
  19. package/dist/es/es2018/types/src/generated/types/SemanticPermissionOutputRepresentation.d.ts +39 -0
  20. package/package.json +3 -3
  21. package/sfdc/index.js +881 -511
  22. package/src/raml/api.raml +128 -5
  23. package/src/raml/luvio.raml +9 -0
package/src/raml/api.raml CHANGED
@@ -234,6 +234,32 @@ types:
234
234
  - AtLeast
235
235
  - AtMost
236
236
  - Exact
237
+ SemanticCalculatedFieldDefaultAggregationTypeEnum:
238
+ description: The semantic calculated field default aggregation type
239
+ type: string
240
+ enum:
241
+ - Auto
242
+ - Average
243
+ - Count
244
+ - CountDistinct
245
+ - First
246
+ - Last
247
+ - Max
248
+ - Median
249
+ - Min
250
+ - None
251
+ - StdDev
252
+ - StdDevP
253
+ - Sum
254
+ - UserAgg
255
+ - Var
256
+ - VarP
257
+ SemanticCalculatedFieldDataRoleEnum:
258
+ description: The semantic calculated field data role
259
+ type: string
260
+ enum:
261
+ - Dimension
262
+ - Measurement
237
263
  SemanticDirectionalityTypeEnum:
238
264
  description: Indicates the directionality of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (Up) or negative (Down).
239
265
  type: string
@@ -300,7 +326,6 @@ types:
300
326
  enum:
301
327
  - Cio
302
328
  - CustomSql
303
- - Dlo
304
329
  - Dmo
305
330
  SemanticDisplayCategoryEnum:
306
331
  description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
@@ -606,6 +631,38 @@ types:
606
631
  description: The syntax of the semantic expression.
607
632
  type: SemanticExpressionSyntaxTypeEnum
608
633
  required: false
634
+ SemanticCalculatedFieldInputRepresentation:
635
+ description: Input representation for creating semantic calculated field
636
+ type: object
637
+ properties:
638
+ fieldDataRole:
639
+ description: The semantic calculated field data role
640
+ type: SemanticCalculatedFieldDataRoleEnum
641
+ required: false
642
+ fieldDataType:
643
+ description: The semantic calculated field data type
644
+ type: string
645
+ required: false
646
+ fieldDecimalPlace:
647
+ description: The semantic calculated field decimal place
648
+ type: integer
649
+ required: false
650
+ fieldDefaultAggregationType:
651
+ description: The semantic calculated field default aggregation type
652
+ type: SemanticCalculatedFieldDefaultAggregationTypeEnum
653
+ required: false
654
+ fieldDescription:
655
+ description: The semantic calculated field description
656
+ type: string
657
+ required: false
658
+ fieldFormula:
659
+ description: The semantic calculated field formula
660
+ type: string
661
+ required: false
662
+ fieldLabel:
663
+ description: The semantic calculated field label
664
+ type: string
665
+ required: false
609
666
  SemanticCalculatedMeasurementCollectionOutputRepresentation:
610
667
  description: A collection of Semantic Calculated Measurements.
611
668
  type: object
@@ -1544,10 +1601,16 @@ types:
1544
1601
  items:
1545
1602
  type: SemanticFilterInputRepresentation
1546
1603
  required: false
1547
- customSql:
1604
+ CustomSql:
1548
1605
  description: Represents the custom sql query.
1549
1606
  type: string
1550
1607
  required: false
1608
+ referenceIntegritySemanticDataObjects:
1609
+ description: The semantic data object references within the logical view.
1610
+ type: array
1611
+ items:
1612
+ type: SemanticDataObjectInputRepresentation
1613
+ required: false
1551
1614
  semanticDataObjects:
1552
1615
  description: The semantic data objects within the logical view.
1553
1616
  type: array
@@ -1607,7 +1670,7 @@ types:
1607
1670
  description: The date in which the semantic entity was last modified.
1608
1671
  type: string
1609
1672
  required: false
1610
- customSql:
1673
+ CustomSql:
1611
1674
  description: The custom sql query, relevant only for logicalView created by sql
1612
1675
  type: string
1613
1676
  required: false
@@ -1621,6 +1684,12 @@ types:
1621
1684
  required: false
1622
1685
  items:
1623
1686
  type: SemanticFilterOutputRepresentation
1687
+ referenceIntegritySemanticDataObjects:
1688
+ description: The list of the referenced semantic data objects used for reference integrity.
1689
+ type: array
1690
+ required: false
1691
+ items:
1692
+ type: SemanticDataObjectOutputRepresentation
1624
1693
  semanticDataObjects:
1625
1694
  description: The list of the referenced semantic data objects.
1626
1695
  type: array
@@ -2210,6 +2279,20 @@ types:
2210
2279
  total:
2211
2280
  description: The total amount of results in all the pages.
2212
2281
  type: integer
2282
+ SemanticModelInfoOutputRepresentation:
2283
+ description: Output representation of model info.
2284
+ type: object
2285
+ additionalProperties: true
2286
+ properties:
2287
+ definitionsCount:
2288
+ description: The number of definition in model.
2289
+ type: integer
2290
+ maxDefinitionCount:
2291
+ description: The max definition in model.
2292
+ type: integer
2293
+ modelHierarchyDepth:
2294
+ description: The extensibility depth in model
2295
+ type: integer
2213
2296
  SemanticModelInputRepresentation:
2214
2297
  description: Input representation for creating semantic model
2215
2298
  type: object
@@ -2490,6 +2573,10 @@ types:
2490
2573
  required: false
2491
2574
  items:
2492
2575
  type: SemanticMetricOutputRepresentation
2576
+ semanticModelInfo:
2577
+ description: Model info.
2578
+ type: SemanticModelInfoOutputRepresentation
2579
+ required: false
2493
2580
  semanticParameters:
2494
2581
  description: The list of parameters belonging to the semantic model.
2495
2582
  type: array
@@ -2889,6 +2976,27 @@ types:
2889
2976
  required: false
2890
2977
  items:
2891
2978
  type: string
2979
+ SemanticPermissionOutputRepresentation:
2980
+ description: The output representation of semantic permissions
2981
+ type: object
2982
+ additionalProperties: true
2983
+ properties:
2984
+ semanticObjectPermissions:
2985
+ description: Object perms.
2986
+ type: object
2987
+ properties:
2988
+ //:
2989
+ type: array
2990
+ items:
2991
+ type: string
2992
+ required: false
2993
+ semanticOrgPermissions:
2994
+ description: Org perms.
2995
+ type: object
2996
+ properties:
2997
+ //:
2998
+ type: boolean
2999
+ required: false
2892
3000
  SemanticRelationshipCollectionOutputRepresentation:
2893
3001
  description: Semantic relationship collection representation.
2894
3002
  type: object
@@ -4634,6 +4742,11 @@ types:
4634
4742
  body:
4635
4743
  application/json:
4636
4744
  type: SemanticSubMetricCollectionOutputRepresentation
4745
+ queryParameters:
4746
+ hasGoal:
4747
+ description: Filters the list of Sub Metrics by having a goal in the sub metric.
4748
+ type: boolean
4749
+ required: false
4637
4750
  post:
4638
4751
  displayName: postSemanticSubMetricCollection
4639
4752
  description: Creates a new semantic sub metric
@@ -4696,13 +4809,13 @@ types:
4696
4809
  description: Success
4697
4810
  get:
4698
4811
  displayName: getSemanticMetricGoal
4699
- description: Retrieves all Semantic Sub Metrics having a Goal.
4812
+ description: Retrieve Semantic Sub.
4700
4813
  responses:
4701
4814
  '200':
4702
4815
  description: Success
4703
4816
  body:
4704
4817
  application/json:
4705
- type: SemanticSubMetricCollectionOutputRepresentation
4818
+ type: SemanticSubMetricOutputRepresentation
4706
4819
  patch:
4707
4820
  displayName: patchSemanticMetricGoal
4708
4821
  description: Creates a goal in Semantic Sub Metrics.
@@ -4723,6 +4836,16 @@ types:
4723
4836
  subMetricNameOrId:
4724
4837
  type: string
4725
4838
  required: true
4839
+ /permissions:
4840
+ get:
4841
+ displayName: getSemanticPermission
4842
+ description: Gets the semantic permissions.
4843
+ responses:
4844
+ '200':
4845
+ description: Success
4846
+ body:
4847
+ application/json:
4848
+ type: SemanticPermissionOutputRepresentation
4726
4849
  /sub-metrics/{subMetricIds}:
4727
4850
  get:
4728
4851
  displayName: getSemanticSubMetricsWithoutModel
@@ -108,3 +108,12 @@ types:
108
108
  name: urlParams.subMetricNameOrId
109
109
  (luvio.adapter):
110
110
  name: deleteSemanticSubMetric
111
+ /sub-metrics/{subMetricNameOrId}/goal:
112
+ patch:
113
+ (luvio.adapter):
114
+ name: patchSemanticMetricGoal
115
+ delete:
116
+ (luvio.key):
117
+ name: urlParams.subMetricNameOrId
118
+ (luvio.adapter):
119
+ name: deleteGoalFromSubMetric