@salesforce/lds-adapters-cdp-semantic-authoring 1.380.0-dev2 → 1.380.0-dev22

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 (26) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +1334 -672
  2. package/dist/es/es2018/types/src/generated/adapters/createSemanticModel.d.ts +2 -0
  3. package/dist/es/es2018/types/src/generated/adapters/patchSemanticModel.d.ts +2 -0
  4. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsModelFiltersByFilterNameOrIdAndModelApiNameOrId.d.ts +12 -0
  5. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsModelFiltersByFilterNameOrIdAndModelApiNameOrId.d.ts +16 -0
  6. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsModelFiltersByModelApiNameOrId.d.ts +15 -0
  7. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  8. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModels.d.ts +2 -0
  9. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsModelFiltersByModelApiNameOrId.d.ts +22 -0
  10. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  11. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsModelFiltersByFilterNameOrIdAndModelApiNameOrId.d.ts +23 -0
  12. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +4 -1
  13. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +4 -1
  14. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +4 -1
  15. package/dist/es/es2018/types/src/generated/types/SemanticGroupingOutputRepresentation.d.ts +4 -1
  16. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +4 -1
  17. package/dist/es/es2018/types/src/generated/types/SemanticModelFilterCollectionOutputRepresentation.d.ts +38 -0
  18. package/dist/es/es2018/types/src/generated/types/SemanticModelFilterInputRepresentation.d.ts +47 -0
  19. package/dist/es/es2018/types/src/generated/types/SemanticModelFilterOutputRepresentation.d.ts +80 -0
  20. package/dist/es/es2018/types/src/generated/types/SemanticModelInputRepresentation.d.ts +4 -1
  21. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +7 -1
  22. package/dist/es/es2018/types/src/generated/types/SemanticParameterOutputRepresentation.d.ts +4 -1
  23. package/package.json +3 -3
  24. package/sfdc/index.js +1330 -668
  25. package/src/raml/api.raml +206 -0
  26. package/src/raml/luvio.raml +3 -0
package/src/raml/api.raml CHANGED
@@ -392,6 +392,7 @@ types:
392
392
  - ManyToOne
393
393
  - OneToMany
394
394
  - OneToOne
395
+ - Unspecified
395
396
  SemanticAggregationTypeEnum:
396
397
  description: A function that computes numerical calculations on data, allowing the query to return summarized information about the expression results. Valid values are Sum, Average, Min, Max, Median, Count Distinct, Count, Stddev, Stddevp, Var, Varp, Last, First, UserAgg, and None.
397
398
  type: string
@@ -713,6 +714,10 @@ types:
713
714
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
714
715
  type: boolean
715
716
  required: false
717
+ externalDataType:
718
+ description: the external data type.
719
+ type: string
720
+ required: false
716
721
  SemanticCalculatedMeasurementCollectionOutputRepresentation:
717
722
  description: A collection of Semantic Calculated Measurements.
718
723
  type: object
@@ -943,6 +948,10 @@ types:
943
948
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
944
949
  type: boolean
945
950
  required: false
951
+ externalDataType:
952
+ description: the external data type.
953
+ type: string
954
+ required: false
946
955
  SemanticModelExternalConnectionInputRepresentation:
947
956
  description: Represents a semantic model external connection.
948
957
  type: object
@@ -1464,6 +1473,10 @@ types:
1464
1473
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
1465
1474
  type: boolean
1466
1475
  required: false
1476
+ externalDataType:
1477
+ description: the external data type.
1478
+ type: string
1479
+ required: false
1467
1480
  SemanticFieldReferenceInputRepresentation:
1468
1481
  description: Input representation field reference
1469
1482
  type: object
@@ -1832,6 +1845,10 @@ types:
1832
1845
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
1833
1846
  type: boolean
1834
1847
  required: false
1848
+ externalDataType:
1849
+ description: the external data type.
1850
+ type: string
1851
+ required: false
1835
1852
  SemanticIdentifyingDimensionInputRepresentation:
1836
1853
  description: Input representation for creating relationship between identifier and name dimensions
1837
1854
  type: object
@@ -2480,6 +2497,10 @@ types:
2480
2497
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
2481
2498
  type: boolean
2482
2499
  required: false
2500
+ externalDataType:
2501
+ description: the external data type.
2502
+ type: string
2503
+ required: false
2483
2504
  SemanticMetricAdditionalDimensionInputRepresentation:
2484
2505
  description: Input representation for updating semantic metric with additional dimensions
2485
2506
  type: object
@@ -2852,6 +2873,10 @@ types:
2852
2873
  items:
2853
2874
  type: SemanticMetricInputRepresentation
2854
2875
  required: false
2876
+ semanticModelFilter:
2877
+ description: Semantic model filter within the model.
2878
+ type: SemanticModelFilterInputRepresentation
2879
+ required: false
2855
2880
  semanticParameters:
2856
2881
  description: Semantic parameters within the model.
2857
2882
  type: array
@@ -2864,6 +2889,114 @@ types:
2864
2889
  items:
2865
2890
  type: SemanticRelationshipInputRepresentation
2866
2891
  required: false
2892
+ SemanticModelFilterCollectionOutputRepresentation:
2893
+ description: Semantic model filter collection representation.
2894
+ type: object
2895
+ additionalProperties: true
2896
+ properties:
2897
+ items:
2898
+ description: A list of semantic model filters.
2899
+ type: array
2900
+ required: false
2901
+ items:
2902
+ type: SemanticModelFilterOutputRepresentation
2903
+ SemanticModelFilterInputRepresentation:
2904
+ description: Represents the input structure used to define a filter in a semantic model.
2905
+ type: object
2906
+ properties:
2907
+ apiName:
2908
+ description: The API name of the semantic entity.
2909
+ type: string
2910
+ required: false
2911
+ description:
2912
+ description: An optional description of the semantic entity.
2913
+ type: string
2914
+ required: false
2915
+ externalConnectionApiName:
2916
+ description: The externalConnectionApiName property references the external connection details for external definition
2917
+ type: string
2918
+ required: false
2919
+ externalId:
2920
+ description: The external ID of the semantic entity from the external data source
2921
+ type: string
2922
+ required: false
2923
+ label:
2924
+ description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
2925
+ type: string
2926
+ required: false
2927
+ filterLogic:
2928
+ description: The filter logic expression that defines how the filters are combined.
2929
+ type: string
2930
+ required: false
2931
+ filters:
2932
+ description: The list of filters to be applied.
2933
+ type: array
2934
+ items:
2935
+ type: SemanticFilterInputRepresentation
2936
+ required: false
2937
+ SemanticModelFilterOutputRepresentation:
2938
+ description: Output representation for a semantic model filter
2939
+ type: object
2940
+ additionalProperties: true
2941
+ properties:
2942
+ apiName:
2943
+ description: The API name of the semantic entity.
2944
+ type: string
2945
+ baseModelApiName:
2946
+ description: The origin model of the semantic entity.
2947
+ type: string
2948
+ required: false
2949
+ cacheKey:
2950
+ description: The Canonical URL of the collection for caching purposes only.
2951
+ type: string
2952
+ required: false
2953
+ createdBy:
2954
+ description: The user who created the semantic entity.
2955
+ type: string
2956
+ createdDate:
2957
+ description: The date in which the semantic entity was created.
2958
+ type: string
2959
+ description:
2960
+ description: The Description of the semantic entity.
2961
+ type: string
2962
+ required: false
2963
+ externalConnectionApiName:
2964
+ description: The externalConnectionApiName property references the external connection details for external definition
2965
+ type: string
2966
+ required: false
2967
+ externalId:
2968
+ description: The external ID of the semantic entity from the external data source
2969
+ type: string
2970
+ required: false
2971
+ id:
2972
+ description: The object ID of the semantic entity.
2973
+ type: string
2974
+ isQueryable:
2975
+ description: Indicates if the entity can be queried in semantic query engine
2976
+ type: SemanticEntityIsQueryableEnum
2977
+ required: false
2978
+ label:
2979
+ description: The display name of the semantic entity to be used in the ui.
2980
+ type: string
2981
+ required: false
2982
+ lastModifiedBy:
2983
+ description: The user who last modified the semantic entity.
2984
+ type: string
2985
+ required: false
2986
+ lastModifiedDate:
2987
+ description: The date in which the semantic entity was last modified.
2988
+ type: string
2989
+ required: false
2990
+ filterLogic:
2991
+ description: The filter logic expression that defines how the filters are combined.
2992
+ type: string
2993
+ required: false
2994
+ filters:
2995
+ description: The list of filters to be applied.
2996
+ type: array
2997
+ required: false
2998
+ items:
2999
+ type: SemanticFilterOutputRepresentation
2867
3000
  SemanticModelObjectCoordinateCollectionInputRepresentation:
2868
3001
  description: Represents a collection of Semantic Model Object Coordinate
2869
3002
  type: object
@@ -3068,6 +3201,12 @@ types:
3068
3201
  required: false
3069
3202
  items:
3070
3203
  type: SemanticMetricOutputRepresentation
3204
+ semanticModelFilters:
3205
+ description: The semantic model filters belonging to this model.
3206
+ type: array
3207
+ required: false
3208
+ items:
3209
+ type: SemanticModelFilterOutputRepresentation
3071
3210
  semanticParameters:
3072
3211
  description: The list of parameters belonging to the semantic model.
3073
3212
  type: array
@@ -3513,6 +3652,10 @@ types:
3513
3652
  description: The unmapped property indicates whether a semantic definition is based on an unmapped field
3514
3653
  type: boolean
3515
3654
  required: false
3655
+ externalDataType:
3656
+ description: the external data type.
3657
+ type: string
3658
+ required: false
3516
3659
  SemanticParameterListValueInputRepresentation:
3517
3660
  description: Input representation of an allowed list value for a semantic parameter .
3518
3661
  type: object
@@ -5234,6 +5377,69 @@ types:
5234
5377
  modelApiNameOrId:
5235
5378
  type: string
5236
5379
  required: true
5380
+ /model-filters:
5381
+ get:
5382
+ displayName: getSemanticModelFilterCollection
5383
+ description: Retrieves a list of Semantic Model Filters in a specific Semantic Model.
5384
+ responses:
5385
+ '200':
5386
+ description: Success
5387
+ body:
5388
+ application/json:
5389
+ type: SemanticModelFilterCollectionOutputRepresentation
5390
+ post:
5391
+ displayName: postSemanticModelFilterCollection
5392
+ description: Creates a new Semantic Model Filter in a specific Semantic Model.
5393
+ responses:
5394
+ '200':
5395
+ description: Success
5396
+ body:
5397
+ application/json:
5398
+ type: SemanticModelFilterOutputRepresentation
5399
+ body:
5400
+ application/json:
5401
+ type: SemanticModelFilterInputRepresentation
5402
+ (oas-body-name): inputName
5403
+ uriParameters:
5404
+ modelApiNameOrId:
5405
+ type: string
5406
+ required: true
5407
+ /model-filters/{filterNameOrId}:
5408
+ delete:
5409
+ displayName: deleteSemanticModelFilter
5410
+ description: Deletes a specific Semantic Model Filter in a specific Semantic Model.
5411
+ responses:
5412
+ '200':
5413
+ description: Success
5414
+ get:
5415
+ displayName: getSemanticModelFilter
5416
+ description: Retrieves the attributes of a specific Semantic Model Filter in a specific Semantic Model.
5417
+ responses:
5418
+ '200':
5419
+ description: Success
5420
+ body:
5421
+ application/json:
5422
+ type: SemanticModelFilterOutputRepresentation
5423
+ put:
5424
+ displayName: putSemanticModelFilter
5425
+ description: Updates the attributes of a specific Semantic Model Filter in a specific Semantic Model.
5426
+ responses:
5427
+ '200':
5428
+ description: Success
5429
+ body:
5430
+ application/json:
5431
+ type: SemanticModelFilterOutputRepresentation
5432
+ body:
5433
+ application/json:
5434
+ type: SemanticModelFilterInputRepresentation
5435
+ (oas-body-name): inputName
5436
+ uriParameters:
5437
+ filterNameOrId:
5438
+ type: string
5439
+ required: true
5440
+ modelApiNameOrId:
5441
+ type: string
5442
+ required: true
5237
5443
  /override:
5238
5444
  put:
5239
5445
  displayName: putSemanticModelOverride
@@ -27,6 +27,9 @@ types:
27
27
  SemanticCalculatedDimensionOutputRepresentation:
28
28
  (luvio.key):
29
29
  name: id
30
+ SemanticModelFilterOutputRepresentation:
31
+ (luvio.key):
32
+ name: id
30
33
  SemanticParameterOutputRepresentation:
31
34
  (luvio.key):
32
35
  name: id