@salesforce/lds-adapters-cdp-semantic-authoring 1.344.0 → 1.346.0

package/src/raml/api.raml

@@ -108,7 +108,7 @@ types:
     description: The semantic view types enum, relevant only for logicalView created by sql
     type: string
     enum:
-      - CustomSql
+      - CustomSQL
       - HardJoin
       - Union
   SemanticDataTypeEnum:
@@ -294,7 +294,7 @@ types:
     type: string
     enum:
       - Cio
-      - CustomSql
+      - CustomSQL
       - Dlo
       - Dmo
   SemanticGoalStatusConditionColorEnum:
@@ -1241,6 +1241,120 @@ types:
         description: The string representation of the value to filter against.
         type: string
         required: false
+  SemanticGoalDateRangeInputRepresentation:
+    description: Input representation for specifying a semantic goal date range
+    type: object
+    properties:
+      endDate:
+        description: The end date of the goal date range.
+        type: string
+        required: false
+      startDate:
+        description: The start date of the goal date range.
+        type: string
+        required: false
+  SemanticGoalDateRangeOutputRepresentation:
+    description: A semantic goal date range.
+    type: object
+    additionalProperties: true
+    properties:
+      endDate:
+        description: The end date of the goal date range.
+        type: string
+        required: false
+      startDate:
+        description: The start date of the goal date range.
+        type: string
+        required: false
+  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
+      dateRange:
+        description: The date range of the semantic goal.
+        type: SemanticGoalDateRangeInputRepresentation
+        required: false
+      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: false
+      subMetricDefinitionApiName:
+        description: The API name of the semantic sub metric definition.
+        type: string
+        required: false
+  SemanticGoalOutputRepresentation:
+    description: A semantic Goal.
+    type: object
+    additionalProperties: true
+    properties:
+      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
+      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
@@ -1559,7 +1673,7 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
-      customSql:
+      customSQL:
         description: Represents the custom sql query.
         type: string
         required: false
@@ -1622,7 +1736,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
@@ -2020,6 +2134,11 @@ types:
       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
@@ -4188,6 +4307,46 @@ types:
                 - Parameter
                 - Relationship
               (oas-collectionFormat): csv
+    /goals:
+      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: false
+          startDate:
+            description: The start date of the desired goal.
+            type: string
+            required: false
+          subMetricApiNameOrId:
+            description: The Semantic Sub Metric Id related to the desired goal.
+            type: string
+            required: false
+      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
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+          required: true
     /groupings:
       get:
         displayName: getSemanticGroupingCollection

package/src/raml/luvio.raml

@@ -53,6 +53,9 @@ types:
   SemanticGroupingOutputRepresentation:
     (luvio.key):
       name: id
+  SemanticGoalOutputRepresentation:
+    (luvio.key):
+      name: id
 
 /ssot/semantic/models:
   get:
@@ -126,3 +129,12 @@ types:
     get:
       (luvio.adapter):
         name: getLeafDependenciesByTypes
+  /goals:
+    get:
+      (luvio.key):
+        name: urlParams.modelApiNameOrId
+      (luvio.adapter):
+        name: getSemanticGoal
+    post:
+      (luvio.adapter):
+        name: createSemanticGoal