@salesforce/lds-adapters-cdp-semantic-authoring 1.334.0 → 1.335.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.
Files changed (22) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +870 -716
  2. package/dist/es/es2018/types/src/generated/adapters/deleteGoalFromSubMetric.d.ts +15 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getSemanticMetricsByIds.d.ts +2 -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/getSsotSemanticMetricsByMetricIds.d.ts +4 -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/SemanticGoalStatusConditionInputRepresentation.d.ts +43 -0
  12. package/dist/es/es2018/types/src/generated/types/SemanticGoalStatusConditionOutputRepresentation.d.ts +43 -0
  13. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalInputRepresentation.d.ts +8 -12
  14. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalOutputRepresentation.d.ts +4 -12
  15. package/package.json +3 -3
  16. package/sfdc/index.js +818 -658
  17. package/src/raml/api.raml +74 -60
  18. package/src/raml/luvio.raml +9 -0
  19. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeInputRepresentation.d.ts +0 -31
  20. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeOutputRepresentation.d.ts +0 -31
  21. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueInputRepresentation.d.ts +0 -28
  22. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueOutputRepresentation.d.ts +0 -28
package/src/raml/api.raml CHANGED
@@ -6,7 +6,7 @@ version: '63.0'
6
6
  mediaType: application/json
7
7
  protocols:
8
8
  - https
9
- baseUri: /services/data/v63.0
9
+ baseUri: /services/data/v64.0
10
10
  securitySchemes:
11
11
  OAuth2:
12
12
  type: OAuth 2.0
@@ -229,13 +229,6 @@ types:
229
229
  - LessThanOrEqual
230
230
  - NotEquals
231
231
  - NotEqualsIgnoreCase
232
- SemanticGoalTypeEnum:
233
- description: The Type property of the semantic metric goal.
234
- type: string
235
- enum:
236
- - AtLeast
237
- - AtMost
238
- - Exact
239
232
  SemanticDirectionalityTypeEnum:
240
233
  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
234
  type: string
@@ -304,6 +297,18 @@ types:
304
297
  - CustomSql
305
298
  - Dlo
306
299
  - Dmo
300
+ SemanticGoalStatusConditionColorEnum:
301
+ description: The Color of the Goal Status Condition
302
+ type: string
303
+ enum:
304
+ - CloudBlue
305
+ - Green
306
+ - Indigo
307
+ - Pink
308
+ - Red
309
+ - Teal
310
+ - Violet
311
+ - Yellow
307
312
  SemanticDisplayCategoryEnum:
308
313
  description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
309
314
  type: string
@@ -1236,50 +1241,58 @@ types:
1236
1241
  description: The string representation of the value to filter against.
1237
1242
  type: string
1238
1243
  required: false
1239
- SemanticGoalDateRangeInputRepresentation:
1240
- description: Input representation for specifying a semantic metric goal date range
1244
+ SemanticGoalStatusConditionInputRepresentation:
1245
+ description: Input representation for specifying a semantic metric goal status condition
1241
1246
  type: object
1242
1247
  properties:
1243
- endDate:
1244
- description: The Value property of the semantic metric goal start date
1245
- type: string
1248
+ color:
1249
+ description: The Color of the Goal Status Condition
1250
+ type: SemanticGoalStatusConditionColorEnum
1246
1251
  required: false
1247
- startDate:
1248
- description: The Value property of the semantic metric goal start date
1252
+ currencyIsoCode:
1253
+ description: The Currency ISO code of the Goal Status Condition
1249
1254
  type: string
1250
1255
  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
1256
+ operator:
1257
+ description: The Operator of the Goal Status Condition
1258
+ type: SemanticFilterOperatorTypeEnum
1259
1259
  required: false
1260
- startDate:
1261
- description: The start date of the semantic metric goal.
1260
+ primary:
1261
+ description: The Primary state of the Goal Status Condition
1262
+ type: boolean
1263
+ required: false
1264
+ statusName:
1265
+ description: The Status Name of the Goal Status Condition
1262
1266
  type: string
1263
1267
  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
1268
+ value:
1269
+ description: The Value of the Goal Status Condition
1270
+ type: string
1272
1271
  required: false
1273
- SemanticGoalValueOutputRepresentation:
1274
- description: A semantic goal value.
1272
+ SemanticGoalStatusConditionOutputRepresentation:
1273
+ description: Output representation for specifying a semantic metric goal status condition
1275
1274
  type: object
1276
1275
  additionalProperties: true
1277
1276
  properties:
1278
- staticValue:
1279
- description: The static value of the semantic metric goal value.
1280
- type: number
1281
- format: double
1277
+ color:
1278
+ description: The Color of the Goal Status Condition
1279
+ type: SemanticGoalStatusConditionColorEnum
1280
+ currencyIsoCode:
1281
+ description: The Currency ISO code of the Goal Status Condition
1282
+ type: string
1282
1283
  required: false
1284
+ operator:
1285
+ description: The Operator of the Goal Status Condition
1286
+ type: SemanticFilterOperatorTypeEnum
1287
+ primary:
1288
+ description: The Primary state of the Goal Status Condition
1289
+ type: boolean
1290
+ statusName:
1291
+ description: The Status Name of the Goal Status Condition
1292
+ type: string
1293
+ value:
1294
+ description: The Value of the Goal Status Condition
1295
+ type: string
1283
1296
  SemanticGroupingCollectionOutputRepresentation:
1284
1297
  description: Semantic groupings collection representation.
1285
1298
  type: object
@@ -1989,32 +2002,24 @@ types:
1989
2002
  description: Input representation for specifying a semantic metric goal
1990
2003
  type: object
1991
2004
  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
2005
+ forecasting:
2006
+ description: The forecasting state of the semantic metric goal.
2007
+ type: boolean
1999
2008
  required: false
2000
- value:
2001
- description: The Value property of the semantic metric goal.
2002
- type: SemanticGoalValueInputRepresentation
2009
+ statusConditions:
2010
+ description: The Status Condition list of the semantic metric goal.
2011
+ type: array
2012
+ items:
2013
+ type: SemanticGoalStatusConditionInputRepresentation
2003
2014
  required: false
2004
2015
  SemanticMetricGoalOutputRepresentation:
2005
2016
  description: A semantic Metric Goal.
2006
2017
  type: object
2007
2018
  additionalProperties: true
2008
2019
  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
2020
+ forecasting:
2021
+ description: The forecasting state of the semantic metric goal.
2022
+ type: boolean
2018
2023
  SemanticMetricInputRepresentation:
2019
2024
  description: Input representation for creating a semantic metric
2020
2025
  type: object
@@ -3442,6 +3447,15 @@ types:
3442
3447
  body:
3443
3448
  application/json:
3444
3449
  type: SemanticMetricCollectionOutputRepresentation
3450
+ queryParameters:
3451
+ sortBy:
3452
+ description: Represents the field to sort by.
3453
+ type: string
3454
+ required: false
3455
+ sortOrder:
3456
+ description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
3457
+ type: SemanticSortOrderEnum
3458
+ required: false
3445
3459
  uriParameters:
3446
3460
  metricIds:
3447
3461
  type: string
@@ -4698,13 +4712,13 @@ types:
4698
4712
  description: Success
4699
4713
  get:
4700
4714
  displayName: getSemanticMetricGoal
4701
- description: Retrieves all Semantic Sub Metrics having a Goal.
4715
+ description: Retrieve Semantic Sub.
4702
4716
  responses:
4703
4717
  '200':
4704
4718
  description: Success
4705
4719
  body:
4706
4720
  application/json:
4707
- type: SemanticSubMetricCollectionOutputRepresentation
4721
+ type: SemanticSubMetricOutputRepresentation
4708
4722
  patch:
4709
4723
  displayName: patchSemanticMetricGoal
4710
4724
  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
- }