@salesforce/lds-adapters-industries-omnianalytics 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,377 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  OmniAnalyticsLogCreateRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      eventPublishStatus:
+        description: The platform event publish status if enabled
+        type: string
+        required: false
+      externalStatusMesg:
+        description: A descriptive status message from external analytics vendors
+          if enabled
+        type: string
+        required: false
+      internalEventId:
+        description: A 36 character unique identifier for the Omni Analytics log record
+          created for internal events if enabled
+        type: string
+        required: false
+      responseId:
+        description: A descriptive status message from external analytics vendors
+          if enabled
+        type: string
+  OmniAnalyticsLogDetailRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      applicationLogDate:
+        description: The date and time at which the Omni Analytics log was generated
+          by the application’s action
+        type: string
+      applicationName:
+        description: Specifies the name of the application.
+        type: string
+      componentId:
+        description: The record ID within the context of the associated application's
+          component that can be used to retrieve the omni analytics log
+        type: string
+      componentType:
+        description: Specifies the name of the component type.
+        type: string
+      eventType:
+        description: Specifies a component event type, such as a specific application
+          action like a page load or button clicked, of the associated application
+          component.
+        type: string
+      name:
+        description: A name to identify the Omni Analytics log record
+        type: string
+      omniAnalyticsLog:
+        description: The contents of the Omni Analytics log as a Json string
+        type: string
+  OmniAnalyticsLogInputRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      analyticsLog:
+        description: The contents of the Omni Analytics log as a Json string
+        type: string
+      analyticsLogDate:
+        description: The date and time at which the Omni Analytics log was generated
+          by the application’s action
+        type: string
+      analyticsLogOwnerId:
+        description: The 18 character Salesforce user id of the user who will own
+          the analytics log. If not specified, will default to the user in whose context
+          the call is being made.
+        type: string
+      componentId:
+        description: The record Id of the component like an Omniscript, Card or IntegrationProcedure
+          whose analytics logs are being written
+        type: string
+      eventType:
+        description: The event type generated by the component. This gets stored in
+          the primary filter field in DES for internal events
+        type: string
+  OmniAnalyticsLogsRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      actionLogs:
+        description: A list of OmniAnalyticsLogDetailRepresentation
+        type: array
+        items:
+          type: OmniAnalyticsLogDetailRepresentation
+      queryMore:
+        description: A string that can be passed to the next call to fetch the next
+          batch of OmniAnalytics Log records
+        type: string
+        required: false
+  OmniAnalyticsMetadataRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      omniAnalyticsSettings:
+        description: The list of org wide Omni Analytics settings
+        type: array
+        required: false
+        items:
+          type: OmniAnalyticsSettingRepresentation
+      trackingComponents:
+        description: A list of OmniAnalyticsTrackingComponentRepresentation
+        type: array
+        required: false
+        items:
+          type: OmniAnalyticsTrackingComponentRepresentation
+      trackingExternalDefintions:
+        description: A list of OmniAnalyticsTrackingExternalDefRepresentation
+        type: array
+        required: false
+        items:
+          type: OmniAnalyticsTrackingExternalDefRepresentation
+      trackingExternalEventDefintions:
+        description: A list of OmniAnalyticsTrackingExternalEventDefRepresentation
+        type: array
+        required: false
+        items:
+          type: OmniAnalyticsTrackingExternalEventDefRepresentation
+      trackingGroups:
+        description: A list of OmniAnalyticsTrackingGroupRepresentation
+        type: array
+        required: false
+        items:
+          type: OmniAnalyticsTrackingGroupRepresentation
+  OmniAnalyticsSettingRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      name:
+        description: Name of the Omni Analytics setting
+        type: string
+      value:
+        description: Value of the setting
+        type: string
+        required: false
+  OmniAnalyticsTrackingComponentRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      componentType:
+        description: Specifies the type of component being tracked, for example, OmniScript
+          or FlexCard.
+        type: string
+        required: false
+      componentVersion:
+        description: The version of the component that is being tracked.
+        type: string
+      identifier:
+        description: The 18 character Salesforce record Identifier
+        type: string
+      componentIdentifier:
+        description: The 18 character Salesforce record Identifier of the associated actual component like an Omniscript or Flexcard
+        type: string
+      name:
+        description: A unique name for the tracking component definition.
+        type: string
+      omniTrackingCompGroupId:
+        description: The parent tracking group definition identifier associated with
+          tracking component definition.
+        type: string
+        required: false
+      omniTrackingComponentDefKey:
+        description: A UUID generated internally by Salesforce to uniquely identify
+          a record across all orgs.
+        type: string
+        required: false
+  OmniAnalyticsTrackingExternalDefRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      description:
+        description: Description of the external tracking configuration
+        type: string
+      identifier:
+        description: The 18 character Salesforce record Identifier
+        type: string
+      isActive:
+        description: Indicates whether the External tracking configuration is active
+          (true) or not (false). The default value is true.
+        type: string
+        required: false
+      name:
+        description: The unique name for the External tracking configuration.
+        type: string
+      omniExtTrackingDefKey:
+        description: A UUID generated internally by Salesforce to uniquely identify
+          a record across all orgs.
+        type: string
+      trackingFrameworkInformation:
+        description: JSON format containing information about an external service,
+          such as the API call and input parameter names.
+        type: string
+        required: false
+      trackingServiceProvider:
+        description: The external tracking service provider doing the tracking. Google
+          is an example of an external tracking service provider that can consume
+          Omni Analytics data.
+        type: string
+        required: false
+  OmniAnalyticsTrackingExternalEventDefRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      componentType:
+        description: The component type being tracked
+        type: string
+        required: false
+      description:
+        description: Description of the external tracking configuration event type
+        type: string
+      identifier:
+        description: The 18 character Salesforce record Identifier
+        type: string
+      inclusionRule:
+        description: Rules for evaluating data from the event payload that decide
+          if the event is sent.
+        type: string
+      name:
+        description: Name of the external tracking configuration event type
+        type: string
+      omniExtTrackingDefId:
+        description: The parent external tracking configuration Identified
+        type: string
+        required: false
+      omniExtTrackingEventDefKey:
+        description: A UUID generated internally by Salesforce to uniquely identify
+          a record across all orgs
+        type: string
+        required: false
+      payloadTemplate:
+        description: The payload template structure with placeholders for runtime
+          data. This is used at runtime to generate the actual payload to be sent
+          to the external Analytics service.
+        type: string
+        required: false
+  OmniAnalyticsTrackingGroupRepresentation:
+    description: Mock Description
+    type: object
+    properties:
+      description:
+        description: Description of the Omni Analytics tracking group
+        type: string
+        required: false
+      endDate:
+        description: Date when the group became inactive and is ready for deletion
+        type: string
+        required: false
+      groupType:
+        description: 'The group type. Possible values: Internal, External'
+        type: string
+      identifier:
+        description: The 18 character Salesforce record Identifier
+        type: string
+      isActive:
+        description: Indicates whether the group is active (true) or not (false).
+          The default value is true.
+        type: string
+      maxAgeInDays:
+        description: The maximum number of days the group and its analytics data is
+          active beyond which the data is deleted.
+        type: string
+        required: false
+      name:
+        description: A unique name for the tracking group.
+        type: string
+      omniExtTrackingDefId:
+        description: The external tracking configuration definition Identifier associated
+          with the tracking group definition.
+        type: string
+        required: false
+      omniTrackingGroupKey:
+        description: A UUID generated internally by Salesforce to uniquely identify
+          a record across all orgs.
+        type: string
+      startDate:
+        description: Date when the group became active
+        type: string
+        required: false
+/connect/omni-analytics:
+  /analytics-logs:
+    post:
+      displayName: storeOmniAnalyticsLogs
+      description: Store Omni Analytics Logs
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: OmniAnalyticsLogCreateRepresentation
+      body:
+        application/json:
+          type: OmniAnalyticsLogInputRepresentation
+          (oas-body-name): omniAnalyticsLogDefinition
+  /analytics-metadata:
+    get:
+      displayName: fetchOmniAnalyticsMetadata
+      description: Retrieve Omni Analytics Metadata
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: OmniAnalyticsMetadataRepresentation
+      queryParameters:
+        externalTrackingDefName:
+          type: string
+          required: false
+        fetchSettings:
+          type: boolean
+          required: false
+        groupName:
+          type: string
+          required: false
+        isActive:
+          type: boolean
+          required: false
+  /get-analytics-logs:
+    get:
+      displayName: fetchOmniAnalyticsLogs
+      description: Retrieve Omni Analytics Logs
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: OmniAnalyticsLogsRepresentation
+      queryParameters:
+        applicationName:
+          type: string
+          required: false
+        componentId:
+          type: string
+          required: false
+        componentType:
+          type: string
+          required: false
+        createdAfter:
+          type: string
+          required: false
+        createdBefore:
+          type: string
+          required: false
+        eventType:
+          type: string
+          required: false
+        pagesize:
+          type: integer
+          required: false
+        queryMore:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,35 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'omnianalytics'
+
+types:
+  OmniAnalyticsLogCreateRepresentation:
+    (luvio.ttl): 10000
+    (luvio.key):
+      responseId: responseId
+
+  OmniAnalyticsMetadataRepresentation:
+    (luvio.ttl): 60000
+
+  OmniAnalyticsLogsRepresentation:
+    (luvio.ttl): 10000
+
+/connect/omni-analytics:
+  /get-analytics-logs:
+    get:
+      (luvio.adapter):
+        name: fetchOmniAnalyticsLogs
+
+  /analytics-logs:
+    post:
+      (luvio.adapter):
+        name: storeOmniAnalyticsLogs
+
+  /analytics-metadata:
+    get:
+      (luvio.adapter):
+        name: fetchOmniAnalyticsMetadata