@salesforce/lds-adapters-cdp-semantic-authoring 1.332.0-dev2 → 1.332.0-dev21

package/src/raml/api.raml

@@ -76,11 +76,51 @@ types:
       - Quarter
       - Week
       - Year
+  SemanticLogicalViewTableTypeEnum:
+    description: Table Types for SDM query interpretation.
+    type: string
+    enum:
+      - Shared
+      - Standard
+  SemanticDataObjectTableTypeEnum:
+    description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+    type: string
+    enum:
+      - Shared
+      - Standard
   SemanticExpressionSyntaxTypeEnum:
     description: The syntax of the semantic expression.
     type: string
     enum:
       - Tua
+  SemanticMeasurementStorageDataTypeEnum:
+    description: The type of data stored in DC.
+    type: string
+    enum:
+      - Boolean
+      - Currency
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
+  SemanticDimensionStorageDataTypeEnum:
+    description: The storage type of data stored in the Data Cloud.
+    type: string
+    enum:
+      - Boolean
+      - Currency
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
   SemanticModelSourceCreationTypeEnum:
     description: The source type of which the model was created from.
     type: string
@@ -108,7 +148,7 @@ types:
     description: The semantic view types enum, relevant only for logicalView created by sql
     type: string
     enum:
-      - CustomSql
+      - CustomSQL
       - HardJoin
       - Union
   SemanticDataTypeEnum:
@@ -229,13 +269,50 @@ types:
       - LessThanOrEqual
       - NotEquals
       - NotEqualsIgnoreCase
-  SemanticGoalTypeEnum:
-    description: The Type property of the semantic metric goal.
+  SemanticGeoRoleEnum:
+    description: The geoRole type of the referenced dimension field.
+    type: string
+    enum:
+      - Airport
+      - AreaCode
+      - CbsaMsa
+      - City
+      - Congressional
+      - Country
+      - District
+      - Latitude
+      - Longitude
+      - Nuts
+      - Province
+      - Region
+      - State
+      - ZipCode
+  SemanticCalculatedFieldDefaultAggregationTypeEnum:
+    description: The semantic calculated field default aggregation type
+    type: string
+    enum:
+      - Auto
+      - Average
+      - Count
+      - CountDistinct
+      - First
+      - Last
+      - Max
+      - Median
+      - Min
+      - None
+      - StdDev
+      - StdDevP
+      - Sum
+      - UserAgg
+      - Var
+      - VarP
+  SemanticCalculatedFieldDataRoleEnum:
+    description: The semantic calculated field data role
     type: string
     enum:
-      - AtLeast
-      - AtMost
-      - Exact
+      - Dimension
+      - Measurement
   SemanticDirectionalityTypeEnum:
     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).
     type: string
@@ -301,9 +378,21 @@ types:
     type: string
     enum:
       - Cio
-      - CustomSql
+      - CustomSQL
       - Dlo
       - Dmo
+  SemanticGoalStatusConditionColorEnum:
+    description: The Color of the Goal Status Condition
+    type: string
+    enum:
+      - CloudBlue
+      - Green
+      - Indigo
+      - Pink
+      - Red
+      - Teal
+      - Violet
+      - Yellow
   SemanticDisplayCategoryEnum:
     description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
     type: string
@@ -604,6 +693,16 @@ types:
         required: false
         items:
           type: SemanticFilterOutputRepresentation
+      level:
+        description: The calculated measurement level
+        type: string
+        required: false
+        enum:
+          - AggregateFunction
+          - ContextDependent
+          - Lod
+          - Row
+          - TableCalc
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
@@ -796,6 +895,16 @@ types:
         required: false
         items:
           type: SemanticFilterOutputRepresentation
+      level:
+        description: The calculated measurement level
+        type: string
+        required: false
+        enum:
+          - AggregateFunction
+          - ContextDependent
+          - Lod
+          - Row
+          - TableCalc
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
@@ -883,6 +992,10 @@ types:
         description: Indicates whether all fields or only specific fields of the referenced data object should be included.
         type: boolean
         required: false
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticDataObjectTableTypeEnum
+        required: false
   SemanticDataObjectOutputRepresentation:
     description: Represents the output of a semantic data object.
     type: object
@@ -970,6 +1083,10 @@ types:
         description: Indicates whether all fields or only specific fields of the referenced data object should be included.
         type: boolean
         required: false
+      tableType:
+        description: Table Types for SDM query interpretation.
+        type: SemanticDataObjectTableTypeEnum
+        required: false
   SemanticDependencyCollectionInputRepresentation:
     description: An input representation to retrieve a list of dependencies.
     type: object
@@ -1178,6 +1295,10 @@ types:
         description: The key qualifier name of this field in data object in data cloud, if exists.
         type: string
         required: false
+      storageDataType:
+        description: The storage type of data stored in the Data Cloud.
+        type: SemanticDimensionStorageDataTypeEnum
+        required: false
   SemanticFieldReferenceInputRepresentation:
     description: Input representation field reference
     type: object
@@ -1237,49 +1358,171 @@ types:
         type: string
         required: false
   SemanticGoalDateRangeInputRepresentation:
-    description: Input representation for specifying a semantic metric goal date range
+    description: Input representation for specifying a semantic goal date range
     type: object
     properties:
       endDate:
-        description: The Value property of the semantic metric goal start date
+        description: The end date of the goal date range.
         type: string
         required: false
       startDate:
-        description: The Value property of the semantic metric goal start date
+        description: The start date of the goal date range.
         type: string
         required: false
   SemanticGoalDateRangeOutputRepresentation:
-    description: A semantic Metric Goal Date Range.
+    description: A semantic goal date range.
     type: object
     additionalProperties: true
     properties:
       endDate:
-        description: The end date of the semantic metric goal.
+        description: The end date of the goal date range.
         type: string
-        required: false
+        required: true
       startDate:
-        description: The start date of the semantic metric goal.
+        description: The start date of the goal date range.
+        type: string
+        required: true
+  SemanticGoalInputRepresentation:
+    description: Input representation for specifying a semantic goal
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+        required: false
+      description:
+        description: An optional description of the semantic entity.
+        type: string
+        required: false
+      label:
+        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.
         type: string
         required: false
-  SemanticGoalValueInputRepresentation:
-    description: Input representation for specifying a semantic metric goal value
+      dateRange:
+        description: The date range of the semantic goal.
+        type: SemanticGoalDateRangeInputRepresentation
+        required: true
+      forecasting:
+        description: The forecasting flag of the semantic goal.
+        type: boolean
+        required: false
+      statusConditions:
+        description: The Status Condition list of the semantic goal.
+        type: array
+        items:
+          type: SemanticGoalStatusConditionInputRepresentation
+        required: true
+      subMetricDefinitionApiName:
+        description: The API name of the semantic sub metric definition.
+        type: string
+        required: true
+  SemanticGoalOutputRepresentation:
+    description: A semantic Goal.
     type: object
+    additionalProperties: true
     properties:
-      staticValue:
-        description: The Static Value property of the semantic metric goal value
-        type: number
-        format: double
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      baseModelApiName:
+        description: The origin model of the semantic entity.
+        type: string
+        required: false
+      cacheKey:
+        description: The Canonical URL of the collection for caching purposes only.
+        type: string
         required: false
-  SemanticGoalValueOutputRepresentation:
-    description: A semantic goal value.
+      createdBy:
+        description: The user who created the semantic entity.
+        type: string
+      createdDate:
+        description: The date in which the semantic entity was created.
+        type: string
+      description:
+        description: The Description of the semantic entity.
+        type: string
+        required: false
+      id:
+        description: The object ID of the semantic entity.
+        type: string
+      label:
+        description: The display name of the semantic entity to be used in the ui.
+        type: string
+        required: false
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string
+        required: false
+      dateRange:
+        description: The date range of the semantic goal.
+        type: SemanticGoalDateRangeOutputRepresentation
+      forecasting:
+        description: The forecasting state of the semantic goal.
+        type: boolean
+      statusConditions:
+        description: The status condition list of the semantic goal.
+        type: array
+        items:
+          type: SemanticGoalStatusConditionOutputRepresentation
+      subMetricDefinitionApiName:
+        description: The API name of the semantic sub metric definition.
+        type: string
+  SemanticGoalStatusConditionInputRepresentation:
+    description: Input representation for specifying a semantic metric goal status condition
+    type: object
+    properties:
+      color:
+        description: The Color of the Goal Status Condition
+        type: SemanticGoalStatusConditionColorEnum
+        required: false
+      currencyIsoCode:
+        description: The Currency ISO code of the Goal Status Condition
+        type: string
+        required: false
+      operator:
+        description: The Operator of the Goal Status Condition
+        type: SemanticFilterOperatorTypeEnum
+        required: false
+      primary:
+        description: The Primary state of the Goal Status Condition
+        type: boolean
+        required: false
+      statusName:
+        description: The Status Name of the Goal Status Condition
+        type: string
+        required: false
+      value:
+        description: The Value of the Goal Status Condition
+        type: string
+        required: false
+  SemanticGoalStatusConditionOutputRepresentation:
+    description: Output representation for specifying a semantic metric goal status condition
     type: object
     additionalProperties: true
     properties:
-      staticValue:
-        description: The static value of the semantic metric goal value.
-        type: number
-        format: double
+      color:
+        description: The Color of the Goal Status Condition
+        type: SemanticGoalStatusConditionColorEnum
+      currencyIsoCode:
+        description: The Currency ISO code of the Goal Status Condition
+        type: string
         required: false
+      operator:
+        description: The Operator of the Goal Status Condition
+        type: SemanticFilterOperatorTypeEnum
+      primary:
+        description: The Primary state of the Goal Status Condition
+        type: boolean
+      statusName:
+        description: The Status Name of the Goal Status Condition
+        type: string
+      value:
+        description: The Value of the Goal Status Condition
+        type: string
   SemanticGroupingCollectionOutputRepresentation:
     description: Semantic groupings collection representation.
     type: object
@@ -1546,7 +1789,11 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
-      customSql:
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
+      customSQL:
         description: Represents the custom sql query.
         type: string
         required: false
@@ -1609,7 +1856,7 @@ types:
         description: The date in which the semantic entity was last modified.
         type: string
         required: false
-      customSql:
+      customSQL:
         description: The custom sql query, relevant only for logicalView created by sql
         type: string
         required: false
@@ -1645,6 +1892,10 @@ types:
         description: The semantic view types enum, relevant only for logicalView created by sql
         type: SemanticViewTypeEnum
         required: false
+      tableType:
+        description: Table Types for SDM query interpretation.
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
   SemanticLogicalViewPartialInputRepresentation:
     description: Limited input representation for patching a semantic logical view
     type: object
@@ -1671,6 +1922,10 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
   SemanticMappedFieldCollectionOutputRepresentation:
     description: Semantic mapped field collection representation.
     type: object
@@ -1803,7 +2058,7 @@ types:
         type: string
         required: false
       decimalPlace:
-        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
+        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio/dlo field.
         type: integer
         required: false
       displayCategory:
@@ -1947,6 +2202,10 @@ types:
         description: The key qualifier name of this field in data object in data cloud, if exists.
         type: string
         required: false
+      storageDataType:
+        description: The type of data stored in DC.
+        type: SemanticMeasurementStorageDataTypeEnum
+        required: false
   SemanticMetricAdditionalDimensionInputRepresentation:
     description: Input representation for updating semantic metric with additional dimensions
     type: object
@@ -1989,32 +2248,29 @@ types:
     description: Input representation for specifying a semantic metric goal
     type: object
     properties:
-      date:
-        description: The Date property of the semantic metric goal.
-        type: SemanticGoalDateRangeInputRepresentation
-        required: false
-      goalType:
-        description: The Type property of the semantic metric goal.
-        type: SemanticGoalTypeEnum
+      forecasting:
+        description: The forecasting state of the semantic metric goal.
+        type: boolean
         required: false
-      value:
-        description: The Value property of the semantic metric goal.
-        type: SemanticGoalValueInputRepresentation
+      statusConditions:
+        description: The Status Condition list of the semantic metric goal.
+        type: array
+        items:
+          type: SemanticGoalStatusConditionInputRepresentation
         required: false
   SemanticMetricGoalOutputRepresentation:
     description: A semantic Metric Goal.
     type: object
     additionalProperties: true
     properties:
-      date:
-        description: The Date range of the semantic metric goal.
-        type: SemanticGoalDateRangeOutputRepresentation
-      goalType:
-        description: The Goal Type of the semantic metric goal type.
-        type: SemanticGoalTypeEnum
-      value:
-        description: The API name of the semantic metric goal.
-        type: SemanticGoalValueOutputRepresentation
+      forecasting:
+        description: The forecasting state of the semantic metric goal.
+        type: boolean
+      statusConditions:
+        description: The status condition list of the semantic metric goal.
+        type: array
+        items:
+          type: SemanticGoalStatusConditionOutputRepresentation
   SemanticMetricInputRepresentation:
     description: Input representation for creating a semantic metric
     type: object
@@ -2782,6 +3038,12 @@ types:
         description: The API name of the semantic entity.
         type: string
         required: false
+      allowedValues:
+        description: The list allowedValues of the semantic parameter.
+        type: array
+        required: false
+        items:
+          type: object
       description:
         description: An optional description of the semantic entity.
         type: string
@@ -2828,6 +3090,12 @@ types:
       apiName:
         description: The API name of the semantic entity.
         type: string
+      allowedValues:
+        description: The allowed list values of the semantic parameter.
+        type: array
+        required: false
+        items:
+          type: SemanticParameterListValueOutputRepresentation
       baseModelApiName:
         description: The origin model of the semantic entity.
         type: string
@@ -2891,6 +3159,28 @@ types:
         required: false
         items:
           type: string
+  SemanticParameterListValueInputRepresentation:
+    description: Input representation of an allowed list value for a semantic parameter .
+    type: object
+    properties:
+      displayName:
+        description: The display name (Display As) of the allowed parameter value.
+        type: string
+      value:
+        description: The allowed value in the list of parameter allowed values.
+        type: string
+  SemanticParameterListValueOutputRepresentation:
+    description: Output representation of an allowed list value for a semantic parameter.
+    type: object
+    properties:
+      displayName:
+        description: The display name (Display As) of the allowed parameter value.
+        type: string
+        required: false
+      value:
+        description: The allowed value in the list of parameter allowed values.
+        type: string
+        required: false
   SemanticRelationshipCollectionOutputRepresentation:
     description: Semantic relationship collection representation.
     type: object
@@ -4121,6 +4411,119 @@ types:
             modelApiNameOrId:
               type: string
               required: true
+    /dependencies:
+      get:
+        displayName: getSemanticDependencyCollection
+        description: Obtains the dependencies of specific Semantic Definition types
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDependencyCollectionOutputRepresentation
+        queryParameters:
+          types:
+            description: Types of semantic objects to get dependencies for
+            type: array
+            required: false
+            items:
+              type: string
+              enum:
+                - CalculatedDimension
+                - CalculatedMeasurement
+                - DataObject
+                - Grouping
+                - LogicalView
+                - MappedField
+                - Metric
+                - Parameter
+                - Relationship
+              (oas-collectionFormat): csv
+    /goals:
+      delete:
+        displayName: deleteSemanticGoal
+        description: Deletes a specific Semantic Goal.
+        responses:
+          '200':
+            description: Success
+        queryParameters:
+          endDate:
+            description: The end date of the desired goal.
+            type: string
+            required: true
+          startDate:
+            description: The start date of the desired goal.
+            type: string
+            required: true
+          subMetricApiNameOrId:
+            description: The Semantic Sub Metric Id related to the desired goal.
+            type: string
+            required: true
+      get:
+        displayName: getSemanticGoal
+        description: Retrieves a specific Semantic Goal.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticGoalOutputRepresentation
+        queryParameters:
+          endDate:
+            description: The end date of the desired goal.
+            type: string
+            required: true
+          startDate:
+            description: The start date of the desired goal.
+            type: string
+            required: true
+          subMetricApiNameOrId:
+            description: The Semantic Sub Metric Id related to the desired goal.
+            type: string
+            required: true
+      post:
+        displayName: postSemanticGoal
+        description: Creates a new semantic goal
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticGoalOutputRepresentation
+        body:
+          application/json:
+            type: SemanticGoalInputRepresentation
+            (oas-body-name): inputName
+      put:
+        displayName: putSemanticGoal
+        description: Updates a Semantic Goal.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticGoalOutputRepresentation
+        queryParameters:
+          endDate:
+            description: The end date of the desired goal.
+            type: string
+            required: true
+          startDate:
+            description: The start date of the desired goal.
+            type: string
+            required: true
+          subMetricApiNameOrId:
+            description: The Semantic Sub Metric Id related to the desired goal.
+            type: string
+            required: true
+        body:
+          application/json:
+            type: SemanticGoalInputRepresentation
+            (oas-body-name): inputName
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+          required: true
     /groupings:
       get:
         displayName: getSemanticGroupingCollection
@@ -4645,6 +5048,11 @@ types:
             body:
               application/json:
                 type: SemanticSubMetricCollectionOutputRepresentation
+        queryParameters:
+          hasGoal:
+            description: Filters the list of Sub Metrics by having a goal in the sub metric.
+            type: boolean
+            required: false
       post:
         displayName: postSemanticSubMetricCollection
         description: Creates a new semantic sub metric
@@ -4707,13 +5115,13 @@ types:
             description: Success
       get:
         displayName: getSemanticMetricGoal
-        description: Retrieves all Semantic Sub Metrics having a Goal.
+        description: Retrieve Semantic Sub.
         responses:
           '200':
             description: Success
             body:
               application/json:
-                type: SemanticSubMetricCollectionOutputRepresentation
+                type: SemanticSubMetricOutputRepresentation
       patch:
         displayName: patchSemanticMetricGoal
         description: Creates a goal in Semantic Sub Metrics.
@@ -4744,6 +5152,15 @@ types:
           body:
             application/json:
               type: SemanticSubMetricCollectionOutputRepresentation
+      queryParameters:
+        sortBy:
+          description: Represents the field to sort by.
+          type: string
+          required: false
+        sortOrder:
+          description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+          type: SemanticSortOrderEnum
+          required: false
     uriParameters:
       subMetricIds:
         type: string