@salesforce/lds-adapters-sfap-analytics-insights 1.332.0-dev2 → 1.332.0-dev21

package/src/raml/api.raml

@@ -77,6 +77,44 @@ types:
       insightType:
         type: string
         required: false
+  GoalMetadata_StatusCondition:
+    type: object
+    properties:
+      statusName:
+        type: string
+        required: false
+      value:
+        type: string
+        required: false
+      operator:
+        enum:
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - LessThan
+          - LessThanOrEqualTo
+          - Equals
+        type: string
+        (amf-format): enum
+        required: false
+      color:
+        enum:
+          - CloudBlue
+          - Green
+          - Indigo
+          - Pink
+          - Red
+          - Teal
+          - Violet
+          - Yellow
+        type: string
+        (amf-format): enum
+        required: false
+      currencyIsoCode:
+        type: string
+        required: false
+      primary:
+        type: boolean
+        required: false
   Insight:
     type: object
     properties:
@@ -138,6 +176,7 @@ types:
       timeDimension: TimeDimension
       comparison: CompareConfig
       filters:
+        description: DEPRECATED Please don't use this field.
         type: array
         items: Filter
         required: false
@@ -153,15 +192,26 @@ types:
     properties:
       filter:
         description: |-
+          DEPRECATED Please don't use this field.
           Server side, we validate that :
              1. the filter type is 'range' or 'relative-date'
              2. the field is date or date-time field on the SDM
         type: Filter
         required: false
       relativePeriod:
-        description: Define the measurement period with a granularity and a range
+        description: |-
+          DEPRECATED Please don't use this field.
+          Define the measurement period with a granularity and a range
         type: RelativePeriod
         required: false
+      semanticFilter:
+        description: |-
+          We do not yet have support for fiscal year
+            We do not yet have support for unbounded time ranges (less than/greater than/all time)
+        (amf-and):
+          - FlattenFilter
+        type: any
+        required: false
   RelativeDate:
     type: object
     properties:
@@ -197,6 +247,7 @@ types:
         format: int32
         required: false
   RelativePeriod:
+    description: The old insights time filter
     type: object
     properties:
       granularity:
@@ -309,13 +360,19 @@ types:
   MetricInstance:
     type: object
     properties:
-      measurementPeriod: MeasurementPeriod
+      measurementPeriod:
+        (amf-and):
+          - MeasurementPeriod
+        type: any
+        required: false
       filters:
-        description: The 'filters' and 'semantic_filters' will be ANDed together
+        description: |-
+          DEPRECATED Please don't use this field.
+          The 'filters' and 'semantic_filters' will be ANDed together
         type: array
         items: Filter
         required: false
-      semanticFilter: # TODO delete this?
+      semanticFilter:
         type: FlattenFilter
         required: false
   BatchInput:
@@ -344,6 +401,9 @@ types:
       extensionOptions: ExtensionOptions
       representationOptions: RepresentationOptions
       insightsOptions: InsightsOptions
+      goals:
+        type: GoalMetadata
+        required: false
   TimeDimension:
     type: object
     properties:
@@ -443,6 +503,9 @@ types:
       sdm:
         type: string
         required: true
+      measurementPeriod:
+        type: UnifiedFilter
+        required: false
   CategoricalFilterOptions:
     type: object
     properties:
@@ -519,6 +582,9 @@ types:
       sdmId:
         type: string
         required: true
+      measurementPeriod:
+        type: UnifiedFilter
+        required: false
   RepresentationOptions_NumberUnits:
     type: object
     properties:
@@ -638,7 +704,6 @@ types:
         description: Options to apply to the entire batch
         type: BatchOptions
         required: false
-  # TODO make these more strict
   Filter:
     type: object
     properties:
@@ -665,6 +730,95 @@ types:
       relativeDateFilterOptions:
         type: RelativeDateFilterOptions
         required: false
+  GoalMetadata:
+    type: object
+    properties:
+      statusConditions:
+        type: array
+        items: GoalMetadata_StatusCondition
+        required: false
+      forecasting:
+        type: boolean
+        required: false
+  UnifiedFilter:
+    description: Message representing the Unified Filter.
+    type: object
+    properties:
+      fieldName:
+        description: tableName.ColumnName or calcFieldName
+        type: string
+        required: false
+      operator:
+        enum:
+          - Equals
+          - DoesNotEquals
+          - EqualsIgnoreCase
+          - DoesNotEqualsIgnoreCase
+          - Between
+          - LessThan
+          - LessThanOrEqualTo
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - IsEmpty
+          - IsNotEmpty
+          - Contains
+          - ContainsIgnoreCase
+          - NotContains
+          - NotContainsIgnoreCase
+          - StartsWith
+          - StartsWithIgnoreCase
+          - DoesNotStartWith
+          - DoesNotStartWithIgnoreCase
+          - EndsWith
+          - EndsWithIgnoreCase
+          - DoesNotEndWith
+          - DoesNotEndWithIgnoreCase
+          - IsNull
+          - IsNotNull
+          - LastNDays
+          - NextNDays
+          - PreviousWeek
+          - CurrentWeek
+          - NextWeek
+          - PreviousMonth
+          - CurrentMonth
+          - NextMonth
+          - PreviousQuarter
+          - CurrentQuarter
+          - NextQuarter
+          - PreviousYear
+          - CurrentYear
+          - NextYear
+          - PreviousFiscalQuarter
+          - CurrentFiscalQuarter
+          - NextFiscalQuarter
+          - PreviousFiscalYear
+          - CurrentFiscalYear
+          - NextFiscalYear
+          - PreviousMonthToDate
+          - CurrentMonthToDate
+          - PreviousQuarterToDate
+          - CurrentQuarterToDate
+          - PreviousYearToDate
+          - CurrentYearToDate
+          - PreviousFiscalQuarterToDate
+          - CurrentFiscalQuarterToDate
+          - PreviousFiscalYearToDate
+          - CurrentFiscalYearToDate
+          - Values
+        type: string
+        (amf-format): enum
+        required: false
+      values:
+        description: An array of values. All values must be of the same type. We support  strings, numbers, and booleans.
+        type: array
+        items:
+          (amf-xone):
+            - type: number
+            - type: string
+            - type: boolean
+          type: any
+        required: false
   GetFilterValuesRequest:
     type: object
     properties:
@@ -703,7 +857,7 @@ types:
           - Equals
           - DoesNotEquals
           - EqualsIgnoreCase
-          - NotEqualsToIgnoreCase
+          - DoesNotEqualsIgnoreCase
           - Between
           - LessThan
           - LessThanOrEqualTo
@@ -792,25 +946,26 @@ types:
           - QUALIFIER_HIGH
           - QUALIFIER_LOW
           - QUALIFIER_EXPECTED
-          - QUALIFIER_IN_PROGRESS
           - QUALIFIER_ON_TRACK
           - QUALIFIER_OFF_TRACK
           - QUALIFIER_ON_TRACK_TO_GOAL
           - QUALIFIER_OFF_TRACK_TO_GOAL
           - QUALIFIER_GOAL_CONDITION
+          - QUALIFIER_NO_STATUS
         type: string
         (amf-format): enum
         required: false
       sentiment:
         description: |-
           Represents a sentiment towards metric status.
-           Sentiment is determined based on the metric directionality and status qualifier
+           Status sentiment is determined based on metric sentiment (e.g. up is good) and status qualifier
         enum:
           - SENTIMENT_UNSPECIFIED
           - SENTIMENT_POSITIVE
           - SENTIMENT_NEGATIVE
           - SENTIMENT_NEUTRAL
           - SENTIMENT_CUSTOM
+          - SENTIMENT_NO_SENTIMENT
         type: string
         (amf-format): enum
         required: false