@salesforce/lds-adapters-cdp-calculated-insights 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,412 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  CdpCalculatedInsightCollectionDataRepresentation:
+    description: Container data representation.
+    type: object
+    properties:
+      count:
+        description: The number of results returned in this page.
+        type: integer
+      currentPageToken:
+        description: Support for server side pagination - Current page token (base64
+          of the query parameters). Use this in token request parameter.
+        type: string
+      currentPageUrl:
+        description: Support for server side pagination - Current page absolute url
+          with query parameters.
+        type: string
+      items:
+        description: List of calculatedInsights.
+        type: array
+        items:
+          type: CdpCalculatedInsightRepresentation
+      nextPageToken:
+        description: Support for server side pagination - Next page token (base64
+          of the query parameters). Use this in token request parameter.
+        type: string | nil # TODO hand rolled. W-15546181
+      nextPageUrl:
+        description: Support for server side pagination - Next page absolute url with
+          query parameters.
+        type: string | nil # TODO hand rolled. W-15546181
+      previousPageToken:
+        description: Support for server side pagination - Previous page token (base64
+          of the query parameters). Use this in token request parameter.
+        type: string | nil # TODO hand rolled. W-15546181
+      previousPageUrl:
+        description: Support for server side pagination - Previous page absolute url
+          with query parameters.
+        type: string | nil # TODO hand rolled. W-15546181
+      total:
+        description: Total row count of calculatedInsights.
+        type: integer
+  CdpCalculatedInsightCollectionRepresentation:
+    description: Container of a calculated insights page.
+    type: object
+    properties:
+      collection:
+        description: Collection Data Representation. Following standard API format.
+        type: CdpCalculatedInsightCollectionDataRepresentation
+  CdpCalculatedInsightDataSourceRepresentation:
+    description: A calculated insight data source.
+    type: object
+    properties:
+      sourceApiName:
+        description: Source Api Name
+        type: string
+      type:
+        description: Type
+        type: string
+  CdpCalculatedInsightDimensionRepresentation:
+    description: A calculated insight dimension.
+    type: object
+    properties:
+      apiName:
+        description: Api Name
+        type: string
+      creationType:
+        description: Creation Type
+        type: string
+      dataSource:
+        description: Data Source
+        type: CdpCalculatedInsightDataSourceRepresentation
+      dataType:
+        description: Data Type
+        type: string
+      dateGranularity:
+        description: Date Granularity
+        type: string | nil # TODO hand rolled. W-15546181
+      displayName:
+        description: Display Name
+        type: string
+      fieldRole:
+        description: Field Role
+        type: string
+      formula:
+        description: Formula
+        type: string
+  CdpCalculatedInsightErrorResponseRepresentation:
+    description: Calculated Insight error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error code
+        type: string
+      message:
+        description: Error message
+        type: string
+  CdpCalculatedInsightMeasureRepresentation:
+    description: A calculated insight measure.
+    type: object
+    properties:
+      apiName:
+        description: Api Name
+        type: string
+      creationType:
+        description: Creation Type
+        type: string
+      dataSource:
+        description: Data Source
+        type: CdpCalculatedInsightDataSourceRepresentation
+      dataType:
+        description: Data Type
+        type: string
+      displayName:
+        description: Display Name
+        type: string
+      fieldAggregationType:
+        description: Field Aggregation Type
+        type: string
+      fieldRole:
+        description: Field Role
+        type: string
+      formula:
+        description: Formula
+        type: string
+  CdpCalculatedInsightRepresentation:
+    description: A calculated insight.
+    type: object
+    properties:
+      apiName:
+        description: Api Name
+        type: string
+      calculatedInsightStatus:
+        description: Calculated Insight Status
+        type: string
+      creationType:
+        description: Creation Type
+        type: string
+      dataSpace:
+        description: Data Space
+        type: string
+      definitionStatus:
+        description: Definition Status
+        type: string
+      definitionType:
+        description: Definition Type
+        type: string
+      description:
+        description: Description
+        type: string | nil # TODO hand rolled. W-15546181
+      dimensions:
+        description: Dimensions
+        type: array
+        items:
+          type: CdpCalculatedInsightDimensionRepresentation
+      displayName:
+        description: Display Name
+        type: string
+      expression:
+        description: Expression
+        type: string
+      isEnabled:
+        description: Is Enabled
+        type: boolean
+      lastCalcInsightStatusDateTime:
+        description: Last Calc Insight Status Date Time
+        type: string
+      lastCalcInsightStatusErrorCode:
+        description: Last Calc Insight Status Error Code
+        type: string | nil # TODO hand rolled. W-15546181
+      lastRunDateTime:
+        description: Last Run Date Time
+        type: string | nil # TODO hand rolled. W-15546181
+      lastRunStatus:
+        description: Last Run Status
+        type: string | nil # TODO hand rolled. W-15546181
+      lastRunStatusDateTime:
+        description: Last Run Status Date Time
+        type: string | nil # TODO hand rolled. W-15546181
+      lastRunStatusErrorCode:
+        description: Last Run Status Error Code
+        type: string | nil # TODO hand rolled. W-15546181
+      measures:
+        description: Measures
+        type: array
+        items:
+          type: CdpCalculatedInsightMeasureRepresentation
+      publishScheduleEndDate:
+        description: 'Publish Schedule End Date Expected format: Expected: yyyy-MM-dd'
+        type: string | nil # TODO hand rolled. W-15546181
+      publishScheduleInterval:
+        description: Publish Schedule Interval NOT_SCHEDULED, SIX, TWELVE, TWENTY_FOUR
+        type: string
+      publishScheduleStartDateTime:
+        description: 'Publish Schedule Start Date Time Expected format: Expected:
+          yyyy-MM-ddTHH:mm'
+        type: string | nil # TODO hand rolled. W-15546181
+  CdpQueryMetadataItemRepresentation:
+    description: Represents Cdp Metadata Item
+    type: object
+    properties:
+      placeInOrder:
+        description: Attribute place order in the result
+        type: integer
+      type:
+        description: Metadata Type for Column
+        type: string
+      typeCode:
+        description: Metadata Type Code
+        type: integer
+  CdpQueryMetadataOutputRepresentation:
+    description: Represents Cdp Query Metadata Output
+    type: object
+    properties:
+      metadata:
+        description: Result metadata set
+        type: array
+        items:
+          type: object
+  CdpQueryOutputRepresentation:
+    description: Represents Cdp Query output
+    type: object
+    properties:
+      data:
+        description: Result data set
+        type: array
+        items:
+          type: object
+          properties: # TODO hand rolled. W-15546181
+            //:
+              type: any
+      done:
+        description: Query start time
+        type: boolean
+      endTime?: # TODO hand rolled. W-15546181
+        description: Query end time
+        type: string
+      metadata:
+        description: Query start time
+        type: object
+        properties:
+          //:
+            type: any # TODO hand rolled. W-15546181
+      queryId?: # TODO hand rolled. W-15546181
+        description: Query Id
+        type: string
+      rowCount?: # TODO hand rolled. W-15546181
+        description: Query start time
+        type: integer
+      startTime?: # TODO hand rolled. W-15546181
+        description: Query start time
+        type: string
+/ssot:
+  /calculated-insights:
+    get:
+      displayName: getCdpCalculatedInsightCollection
+      description: Gets a page result of calculated insights
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpCalculatedInsightCollectionRepresentation
+      queryParameters:
+        batchSize:
+          type: integer
+          required: false
+        dataspace:
+          type: string
+          required: false
+        definitionType:
+          type: string
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderby:
+          type: string
+          required: false
+        pageToken:
+          type: string
+          required: false
+    /{apiName}:
+      get:
+        displayName: getCdpCalculatedInsight
+        description: Gets the calculated insight.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpCalculatedInsightRepresentation
+      uriParameters:
+        apiName:
+          type: string
+          required: true
+  /insight:
+    /calculated-insights/{ciName}:
+      get:
+        displayName: getCdpInsightsQuery
+        description: Queries Calculated Insights Data
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpQueryOutputRepresentation
+        queryParameters:
+          batchSize:
+            type: integer
+            required: false
+          dataspace:
+            type: string
+            required: false
+          dimensions:
+            type: string
+            required: false
+          filters:
+            type: string
+            required: false
+          measures:
+            type: string
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderby:
+            type: string
+            required: false
+          timeGranularity:
+            type: string
+            required: false
+      uriParameters:
+        ciName:
+          type: string
+          required: true
+  /profile:
+    /{dataModelName}/{id}/calculated-insights/{ciName}:
+      get:
+        displayName: getCdpProfileApiQuery
+        description: Query Profile Data
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpQueryOutputRepresentation
+        queryParameters:
+          batchSize:
+            type: integer
+            required: false
+          dataspace:
+            type: string
+            required: false
+          dimensions:
+            type: string
+            required: false
+          fields:
+            type: string
+            required: false
+          filters:
+            type: string
+            required: false
+          measures:
+            type: string
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderby:
+            type: string
+            required: false
+          searchKey:
+            type: string
+            required: false
+          timeGranularity:
+            type: string
+            required: false
+      uriParameters:
+        ciName:
+          type: string
+          required: true
+        dataModelName:
+          type: string
+          required: true
+        id:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,56 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'calculated-insights'
+(luvio.ttl): 3000000
+
+types:
+  CdpCalculatedInsightCollectionDataRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      id: currentPageToken
+  CdpCalculatedInsightCollectionRepresentation:
+    (luvio.opaque): true
+  CdpCalculatedInsightDataSourceRepresentation:
+    (luvio.opaque): true
+  CdpCalculatedInsightDimensionRepresentation:
+    (luvio.opaque): true
+  CdpCalculatedInsightErrorResponseRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      message: message
+  CdpCalculatedInsightMeasureRepresentation:
+    (luvio.opaque): true
+  CdpCalculatedInsightRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      apiName: apiName
+  CdpQueryOutputRepresentation:
+    (luvio.opaque): true
+
+/ssot:
+  /calculated-insights:
+    get:
+      (luvio.adapter):
+        name: getCalculatedInsightsMetadata
+    /{apiName}:
+      get:
+        (luvio.adapter):
+          name: getCalculatedInsightMetadata
+        (luvio.key):
+          apiName: urlParams.apiName
+  /insight:
+    /calculated-insights/{ciName}:
+      get:
+        (luvio.adapter):
+          name: queryCalculatedInsight
+      uriParameters:
+        ciName:
+  /profile:
+    /{dataModelName}/{id}/calculated-insights/{ciName}:
+      get:
+        (luvio.adapter):
+          name: queryProfileCalculatedInsight