@salesforce/lds-adapters-cdp-semantic-authoring 1.332.0-dev3 → 1.332.0-dev5

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 (24) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +951 -692
  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 +19 -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/patchSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +3 -5
  11. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +4 -1
  12. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +4 -1
  13. package/dist/es/es2018/types/src/generated/types/SemanticGoalStatusConditionInputRepresentation.d.ts +43 -0
  14. package/dist/es/es2018/types/src/generated/types/SemanticGoalStatusConditionOutputRepresentation.d.ts +43 -0
  15. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalInputRepresentation.d.ts +8 -12
  16. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalOutputRepresentation.d.ts +8 -12
  17. package/package.json +3 -3
  18. package/sfdc/index.js +945 -680
  19. package/src/raml/api.raml +136 -57
  20. package/src/raml/luvio.raml +9 -0
  21. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeInputRepresentation.d.ts +0 -31
  22. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeOutputRepresentation.d.ts +0 -31
  23. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueInputRepresentation.d.ts +0 -28
  24. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueOutputRepresentation.d.ts +0 -28
package/src/raml/api.raml CHANGED
@@ -229,13 +229,50 @@ types:
229
229
  - LessThanOrEqual
230
230
  - NotEquals
231
231
  - NotEqualsIgnoreCase
232
- SemanticGoalTypeEnum:
233
- description: The Type property of the semantic metric goal.
232
+ SemanticGeoRoleEnum:
233
+ description: The geoRole type of the referenced dimension field.
234
234
  type: string
235
235
  enum:
236
- - AtLeast
237
- - AtMost
238
- - Exact
236
+ - Airport
237
+ - AreaCode
238
+ - CbsaMsa
239
+ - City
240
+ - Congressional
241
+ - Country
242
+ - District
243
+ - Latitude
244
+ - Longitude
245
+ - Nuts
246
+ - Province
247
+ - Region
248
+ - State
249
+ - ZipCode
250
+ SemanticCalculatedFieldDefaultAggregationTypeEnum:
251
+ description: The semantic calculated field default aggregation type
252
+ type: string
253
+ enum:
254
+ - Auto
255
+ - Average
256
+ - Count
257
+ - CountDistinct
258
+ - First
259
+ - Last
260
+ - Max
261
+ - Median
262
+ - Min
263
+ - None
264
+ - StdDev
265
+ - StdDevP
266
+ - Sum
267
+ - UserAgg
268
+ - Var
269
+ - VarP
270
+ SemanticCalculatedFieldDataRoleEnum:
271
+ description: The semantic calculated field data role
272
+ type: string
273
+ enum:
274
+ - Dimension
275
+ - Measurement
239
276
  SemanticDirectionalityTypeEnum:
240
277
  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).
241
278
  type: string
@@ -304,6 +341,18 @@ types:
304
341
  - CustomSQL
305
342
  - Dlo
306
343
  - Dmo
344
+ SemanticGoalStatusConditionColorEnum:
345
+ description: The Color of the Goal Status Condition
346
+ type: string
347
+ enum:
348
+ - CloudBlue
349
+ - Green
350
+ - Indigo
351
+ - Pink
352
+ - Red
353
+ - Teal
354
+ - Violet
355
+ - Yellow
307
356
  SemanticDisplayCategoryEnum:
308
357
  description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
309
358
  type: string
@@ -604,6 +653,16 @@ types:
604
653
  required: false
605
654
  items:
606
655
  type: SemanticFilterOutputRepresentation
656
+ level:
657
+ description: The calculated measurement level
658
+ type: string
659
+ required: false
660
+ enum:
661
+ - AggregateFunction
662
+ - ContextDependent
663
+ - Lod
664
+ - Row
665
+ - TableCalc
607
666
  syntax:
608
667
  description: The syntax of the semantic expression.
609
668
  type: SemanticExpressionSyntaxTypeEnum
@@ -796,6 +855,16 @@ types:
796
855
  required: false
797
856
  items:
798
857
  type: SemanticFilterOutputRepresentation
858
+ level:
859
+ description: The calculated measurement level
860
+ type: string
861
+ required: false
862
+ enum:
863
+ - AggregateFunction
864
+ - ContextDependent
865
+ - Lod
866
+ - Row
867
+ - TableCalc
799
868
  syntax:
800
869
  description: The syntax of the semantic expression.
801
870
  type: SemanticExpressionSyntaxTypeEnum
@@ -1236,50 +1305,58 @@ types:
1236
1305
  description: The string representation of the value to filter against.
1237
1306
  type: string
1238
1307
  required: false
1239
- SemanticGoalDateRangeInputRepresentation:
1240
- description: Input representation for specifying a semantic metric goal date range
1308
+ SemanticGoalStatusConditionInputRepresentation:
1309
+ description: Input representation for specifying a semantic metric goal status condition
1241
1310
  type: object
1242
1311
  properties:
1243
- endDate:
1244
- description: The Value property of the semantic metric goal start date
1245
- type: string
1312
+ color:
1313
+ description: The Color of the Goal Status Condition
1314
+ type: SemanticGoalStatusConditionColorEnum
1246
1315
  required: false
1247
- startDate:
1248
- description: The Value property of the semantic metric goal start date
1316
+ currencyIsoCode:
1317
+ description: The Currency ISO code of the Goal Status Condition
1249
1318
  type: string
1250
1319
  required: false
1251
- SemanticGoalDateRangeOutputRepresentation:
1252
- description: A semantic Metric Goal Date Range.
1253
- type: object
1254
- additionalProperties: true
1255
- properties:
1256
- endDate:
1257
- description: The end date of the semantic metric goal.
1258
- type: string
1320
+ operator:
1321
+ description: The Operator of the Goal Status Condition
1322
+ type: SemanticFilterOperatorTypeEnum
1259
1323
  required: false
1260
- startDate:
1261
- description: The start date of the semantic metric goal.
1324
+ primary:
1325
+ description: The Primary state of the Goal Status Condition
1326
+ type: boolean
1327
+ required: false
1328
+ statusName:
1329
+ description: The Status Name of the Goal Status Condition
1262
1330
  type: string
1263
1331
  required: false
1264
- SemanticGoalValueInputRepresentation:
1265
- description: Input representation for specifying a semantic metric goal value
1266
- type: object
1267
- properties:
1268
- staticValue:
1269
- description: The Static Value property of the semantic metric goal value
1270
- type: number
1271
- format: double
1332
+ value:
1333
+ description: The Value of the Goal Status Condition
1334
+ type: string
1272
1335
  required: false
1273
- SemanticGoalValueOutputRepresentation:
1274
- description: A semantic goal value.
1336
+ SemanticGoalStatusConditionOutputRepresentation:
1337
+ description: Output representation for specifying a semantic metric goal status condition
1275
1338
  type: object
1276
1339
  additionalProperties: true
1277
1340
  properties:
1278
- staticValue:
1279
- description: The static value of the semantic metric goal value.
1280
- type: number
1281
- format: double
1341
+ color:
1342
+ description: The Color of the Goal Status Condition
1343
+ type: SemanticGoalStatusConditionColorEnum
1344
+ currencyIsoCode:
1345
+ description: The Currency ISO code of the Goal Status Condition
1346
+ type: string
1282
1347
  required: false
1348
+ operator:
1349
+ description: The Operator of the Goal Status Condition
1350
+ type: SemanticFilterOperatorTypeEnum
1351
+ primary:
1352
+ description: The Primary state of the Goal Status Condition
1353
+ type: boolean
1354
+ statusName:
1355
+ description: The Status Name of the Goal Status Condition
1356
+ type: string
1357
+ value:
1358
+ description: The Value of the Goal Status Condition
1359
+ type: string
1283
1360
  SemanticGroupingCollectionOutputRepresentation:
1284
1361
  description: Semantic groupings collection representation.
1285
1362
  type: object
@@ -1989,32 +2066,29 @@ types:
1989
2066
  description: Input representation for specifying a semantic metric goal
1990
2067
  type: object
1991
2068
  properties:
1992
- date:
1993
- description: The Date property of the semantic metric goal.
1994
- type: SemanticGoalDateRangeInputRepresentation
1995
- required: false
1996
- goalType:
1997
- description: The Type property of the semantic metric goal.
1998
- type: SemanticGoalTypeEnum
2069
+ forecasting:
2070
+ description: The forecasting state of the semantic metric goal.
2071
+ type: boolean
1999
2072
  required: false
2000
- value:
2001
- description: The Value property of the semantic metric goal.
2002
- type: SemanticGoalValueInputRepresentation
2073
+ statusConditions:
2074
+ description: The Status Condition list of the semantic metric goal.
2075
+ type: array
2076
+ items:
2077
+ type: SemanticGoalStatusConditionInputRepresentation
2003
2078
  required: false
2004
2079
  SemanticMetricGoalOutputRepresentation:
2005
2080
  description: A semantic Metric Goal.
2006
2081
  type: object
2007
2082
  additionalProperties: true
2008
2083
  properties:
2009
- date:
2010
- description: The Date range of the semantic metric goal.
2011
- type: SemanticGoalDateRangeOutputRepresentation
2012
- goalType:
2013
- description: The Goal Type of the semantic metric goal type.
2014
- type: SemanticGoalTypeEnum
2015
- value:
2016
- description: The API name of the semantic metric goal.
2017
- type: SemanticGoalValueOutputRepresentation
2084
+ forecasting:
2085
+ description: The forecasting state of the semantic metric goal.
2086
+ type: boolean
2087
+ statusConditions:
2088
+ description: The status condition list of the semantic metric goal.
2089
+ type: array
2090
+ items:
2091
+ type: SemanticGoalStatusConditionOutputRepresentation
2018
2092
  SemanticMetricInputRepresentation:
2019
2093
  description: Input representation for creating a semantic metric
2020
2094
  type: object
@@ -4645,6 +4719,11 @@ types:
4645
4719
  body:
4646
4720
  application/json:
4647
4721
  type: SemanticSubMetricCollectionOutputRepresentation
4722
+ queryParameters:
4723
+ hasGoal:
4724
+ description: Filters the list of Sub Metrics by having a goal in the sub metric.
4725
+ type: boolean
4726
+ required: false
4648
4727
  post:
4649
4728
  displayName: postSemanticSubMetricCollection
4650
4729
  description: Creates a new semantic sub metric
@@ -4707,13 +4786,13 @@ types:
4707
4786
  description: Success
4708
4787
  get:
4709
4788
  displayName: getSemanticMetricGoal
4710
- description: Retrieves all Semantic Sub Metrics having a Goal.
4789
+ description: Retrieve Semantic Sub.
4711
4790
  responses:
4712
4791
  '200':
4713
4792
  description: Success
4714
4793
  body:
4715
4794
  application/json:
4716
- type: SemanticSubMetricCollectionOutputRepresentation
4795
+ type: SemanticSubMetricOutputRepresentation
4717
4796
  patch:
4718
4797
  displayName: patchSemanticMetricGoal
4719
4798
  description: Creates a goal in Semantic Sub Metrics.
@@ -113,3 +113,12 @@ types:
113
113
  name: urlParams.subMetricNameOrId
114
114
  (luvio.adapter):
115
115
  name: deleteSemanticSubMetric
116
+ /sub-metrics/{subMetricNameOrId}/goal:
117
+ patch:
118
+ (luvio.adapter):
119
+ name: patchSemanticMetricGoal
120
+ delete:
121
+ (luvio.key):
122
+ name: urlParams.subMetricNameOrId
123
+ (luvio.adapter):
124
+ name: deleteGoalFromSubMetric
@@ -1,31 +0,0 @@
1
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
- export declare const VERSION = "5fc934831301f8d8d38f498c3016f5f4";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- export declare function normalize(input: SemanticGoalDateRangeInputRepresentation, existing: SemanticGoalDateRangeInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SemanticGoalDateRangeInputRepresentationNormalized;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: SemanticGoalDateRangeInputRepresentationNormalized, incoming: SemanticGoalDateRangeInputRepresentationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SemanticGoalDateRangeInputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
10
- /**
11
- * Input representation for specifying a semantic metric goal date range
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface SemanticGoalDateRangeInputRepresentationNormalized {
17
- /** The Value property of the semantic metric goal start date */
18
- endDate?: string;
19
- /** The Value property of the semantic metric goal start date */
20
- startDate?: string;
21
- }
22
- /**
23
- * Input representation for specifying a semantic metric goal date range
24
- *
25
- * Keys:
26
- * (none)
27
- */
28
- export interface SemanticGoalDateRangeInputRepresentation {
29
- endDate?: string;
30
- startDate?: string;
31
- }
@@ -1,31 +0,0 @@
1
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
- export declare const VERSION = "fab01ba4d87279437902114875229b17";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- export declare function normalize(input: SemanticGoalDateRangeOutputRepresentation, existing: SemanticGoalDateRangeOutputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SemanticGoalDateRangeOutputRepresentationNormalized;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: SemanticGoalDateRangeOutputRepresentationNormalized, incoming: SemanticGoalDateRangeOutputRepresentationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SemanticGoalDateRangeOutputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
10
- /**
11
- * A semantic Metric Goal Date Range.
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface SemanticGoalDateRangeOutputRepresentationNormalized {
17
- /** The end date of the semantic metric goal. */
18
- endDate?: string;
19
- /** The start date of the semantic metric goal. */
20
- startDate?: string;
21
- }
22
- /**
23
- * A semantic Metric Goal Date Range.
24
- *
25
- * Keys:
26
- * (none)
27
- */
28
- export interface SemanticGoalDateRangeOutputRepresentation {
29
- endDate?: string;
30
- startDate?: string;
31
- }
@@ -1,28 +0,0 @@
1
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
- export declare const VERSION = "ff91598c8f9f42c2ec9c9e526a2cce75";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- export declare function normalize(input: SemanticGoalValueInputRepresentation, existing: SemanticGoalValueInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SemanticGoalValueInputRepresentationNormalized;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: SemanticGoalValueInputRepresentationNormalized, incoming: SemanticGoalValueInputRepresentationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SemanticGoalValueInputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
10
- /**
11
- * Input representation for specifying a semantic metric goal value
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface SemanticGoalValueInputRepresentationNormalized {
17
- /** The Static Value property of the semantic metric goal value */
18
- staticValue?: number;
19
- }
20
- /**
21
- * Input representation for specifying a semantic metric goal value
22
- *
23
- * Keys:
24
- * (none)
25
- */
26
- export interface SemanticGoalValueInputRepresentation {
27
- staticValue?: number;
28
- }
@@ -1,28 +0,0 @@
1
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
- export declare const VERSION = "7d5ee6baae643c44b82c6114e8cba70c";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- export declare function normalize(input: SemanticGoalValueOutputRepresentation, existing: SemanticGoalValueOutputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SemanticGoalValueOutputRepresentationNormalized;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: SemanticGoalValueOutputRepresentationNormalized, incoming: SemanticGoalValueOutputRepresentationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SemanticGoalValueOutputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
10
- /**
11
- * A semantic goal value.
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface SemanticGoalValueOutputRepresentationNormalized {
17
- /** The static value of the semantic metric goal value. */
18
- staticValue?: number;
19
- }
20
- /**
21
- * A semantic goal value.
22
- *
23
- * Keys:
24
- * (none)
25
- */
26
- export interface SemanticGoalValueOutputRepresentation {
27
- staticValue?: number;
28
- }