@salesforce/lds-adapters-cdp-engmt-config 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,543 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '64.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:
+  EngagementSignalCollectionRepresentation:
+    description: Engagement Signal Collection Output Representation
+    type: object
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string
+      engagementSignals:
+        description: Engagement signals
+        type: array
+        items:
+          type: any
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+        required: false
+      totalSize:
+        description: Total size of collection
+        type: integer
+  EngagementSignalCompoundMetricCollectionInputRepresentation:
+    description: Engagement Signal Compound Metric Collection Input Representation
+    type: object
+    properties:
+      compoundMetrics:
+        description: Engagement Signal Compound Metrics
+        type: array
+        items:
+          type: any
+  EngagementSignalCompoundMetricInputRepresentation:
+    description: Engagement Signal Compound Metric Input Representation
+    type: object
+    properties:
+      denominatorMetric:
+        description: Engagement Signal Compound Metric Denominator
+        type: any
+      description:
+        description: Engagement Signal Compound Metric description
+        type: string
+      label:
+        description: Engagement Signal Compound Metric label
+        type: string
+      name:
+        description: Engagement Signal Compound Metric API name
+        type: string
+      numeratorMetric:
+        description: Engagement Signal Compound Metric Numerator
+        type: any
+      operator:
+        description: Engagement Signal Compound Metric Operator
+        type: string
+        enum:
+          - Ratio
+  EngagementSignalCompoundMetricRepresentation:
+    description: Engagement Signal Compound Metric output representation
+    type: object
+    properties:
+      denominatorMetric:
+        description: Engagement Signal Compound Metric Denominator
+        type: EngagementSignalMetricFieldRepresentation
+      description:
+        description: Engagement Signal Compound Metric description
+        type: string
+      id:
+        description: The 18 character ID of the record
+        type: string
+      label:
+        description: Engagement Signal Compound Metric Label
+        type: string
+      name:
+        description: Engagement Signal Compound Metric Name
+        type: string
+      numeratorMetric:
+        description: Engagement Signal Compound Metric Numerator
+        type: EngagementSignalMetricFieldRepresentation
+      operator:
+        description: Engagement Signal Compound Metric Operator
+        type: string
+        enum:
+          - Ratio
+  EngagementSignalFilterGroupCollectionInputRepresentation:
+    description: Engagement Signal Filter Group Collection Input Representation
+    type: object
+    properties:
+      filterGroups:
+        description: Engagement Signal Filter Groups
+        type: array
+        items:
+          type: array
+          items:
+            type: any
+  EngagementSignalFilterGroupInputRepresentation:
+    description: Engagement Signal Filter Group Input Representation
+    type: object
+    properties:
+      conjunctiveOperator:
+        description: Engagement Signal Filter Group Condition
+        type: string
+        enum:
+          - And
+          - Or
+      filters:
+        description: Engagement Signal Filter Group Filters
+        type: array
+        items:
+          type: any
+  EngagementSignalFilterGroupRepresentation:
+    description: Engagement Signal Filter Group output representation
+    type: object
+    properties:
+      conjunctiveOperator:
+        description: Engagement Signal Filter Group Condition
+        type: string
+        enum:
+          - And
+          - Or
+      filters:
+        description: Engagement Signal Filter Group Filters
+        type: array
+        items:
+          type: any
+  EngagementSignalFilterInputRepresentation:
+    description: Engagement Signal Filter Input Representation
+    type: object
+    properties:
+      action:
+        description: Engagement Signal Filter Action
+        type: string
+        enum:
+          - Excludes
+          - Includes
+      field:
+        description: Engagement Signal Filter Field
+        type: any
+      operator:
+        description: Engagement Signal Filter Operator
+        type: string
+        enum:
+          - Equals
+      values:
+        description: Engagement Signal Filter Values
+        type: array
+        items:
+          type: string
+  EngagementSignalFilterRepresentation:
+    description: Engagement Signal Filter output representation
+    type: object
+    properties:
+      action:
+        description: Engagement Signal Filter Action
+        type: string
+        enum:
+          - Excludes
+          - Includes
+      field:
+        description: Engagement Signal Filter Field
+        type: any
+      operator:
+        description: Engagement Signal Filter Operator
+        type: string
+        enum:
+          - Equals
+      values:
+        description: Engagement Signal Filter Values
+        type: array
+        items:
+          type: string
+  EngagementSignalInputRepresentation:
+    description: Engagement Signal Input Representation
+    type: object
+    properties:
+      catalogIdField:
+        description: Engagement Signal Catalog Id Field
+        type: any
+        required: false
+      compoundMetrics:
+        description: Engagement Signal Compound Metrics
+        type: array
+        required: false
+        items:
+          type: any
+      dataSpaceName:
+        description: Engagement Signal Data Space Name
+        type: string
+      description:
+        description: Engagement Signal description
+        type: string
+        required: false
+      distinctFields:
+        description: Engagement Signal Distinct On
+        type: array
+        required: false
+        items:
+          type: any
+      filterGroups:
+        description: Engagement Signal Filter Groups
+        type: array
+        required: false
+        items:
+          type: any
+      label:
+        description: Engagement Signal label
+        type: string
+      metrics:
+        description: Engagement Signal Metrics
+        type: array
+        required: false
+        items:
+          type: any
+      name:
+        description: Engagement Signal API name
+        type: string
+      objectName:
+        description: Engagement Signal Object Name
+        type: string
+      timestampField:
+        description: Engagement Signal Timestamp Field
+        type: any
+      uniqueIdentifier:
+        description: Engagement Signal Unique Identifier
+        type: any
+      userIdField:
+        description: Engagement Signal User Id Field
+        type: any
+  EngagementSignalMetricCollectionInputRepresentation:
+    description: Engagement Signal Metric Collection Input Representation
+    type: object
+    properties:
+      metrics:
+        description: Engagement Signal Metrics
+        type: array
+        items:
+          type: any
+  EngagementSignalMetricFieldInputRepresentation:
+    description: Input representation for a engagement signal metricfield
+    type: object
+    properties:
+      engagementSignalMetricName:
+        description: Engagement Signal Metric Name
+        type: string
+      engagementSignalName:
+        description: Engagement Signal Name
+        type: string
+  EngagementSignalMetricFieldRepresentation:
+    description: Output representation for a Engagement Signal Metric field
+    type: object
+    properties:
+      engagementSignalMetricName:
+        description: Name of the Engagement Signal Metric
+        type: string
+      engagementSignalName:
+        description: Name of the Engagement Signal
+        type: string
+  EngagementSignalMetricInputRepresentation:
+    description: Engagement Signal Metric Input Representation
+    type: object
+    properties:
+      aggregateFunction:
+        description: Engagement Signal Metric Aggregate Function
+        type: string
+        enum:
+          - Average
+          - Count
+          - Distinct
+          - Select
+          - Sum
+      description:
+        description: Engagement Signal Metric description
+        type: string
+        required: false
+      field:
+        description: Engagement Signal Metric Field Name
+        type: any
+      label:
+        description: Engagement Signal Metric label
+        type: string
+        required: false
+      name:
+        description: Engagement Signal Metric API name
+        type: string
+  EngagementSignalMetricRepresentation:
+    description: Engagement Signal Metric output representation
+    type: object
+    properties:
+      aggregateFunction:
+        description: Engagement Signal Metric Aggregate Function
+        type: string
+        enum:
+          - Average
+          - Count
+          - Distinct
+          - Select
+          - Sum
+      field:
+        description: Engagement Signal Metric Field
+        type: any
+      id:
+        description: The 18 character ID of the record
+        type: string
+      name:
+        description: Engagement Signal Metric Name
+        type: string
+  EngagementSignalRepresentation:
+    description: Engagement Signal Output Representation
+    type: object
+    properties:
+      catalogIdField:
+        description: Engagement Signal Catalog Field
+        type: any
+        required: false
+      compoundMetrics:
+        description: Engagement Signal Compound Metrics
+        type: array
+        required: false
+        items:
+          type: EngagementSignalCompoundMetricRepresentation
+      dataSpaceName:
+        description: Engagement Signal DataSPace
+        type: string
+      distinctFields:
+        description: Engagement Signal Distinct Fields
+        type: array
+        required: false
+        items:
+          type: any
+      filterGroups:
+        description: Engagement Signal Filter Groups
+        type: array
+        required: false
+        items:
+          type: EngagementSignalFilterGroupRepresentation
+      id:
+        description: The 18 character ID of the record
+        type: string
+      label:
+        description: Engagement Signal Label
+        type: string
+      metrics:
+        description: Engagement Signal Metrics
+        type: array
+        required: false
+        items:
+          type: EngagementSignalMetricRepresentation
+      name:
+        description: Engagement Signal Name
+        type: string
+      objectName:
+        description: Engagement Signal Object
+        type: string
+      timestampField:
+        description: Engagement Signal Timestamp Field
+        type: any
+      uniqueIdentifier:
+        description: Engagement Signal Unique Identifier
+        type: any
+      userIdField:
+        description: Engagement Signal UserId Field
+        type: any
+  FieldInputRepresentation:
+    description: Input representation for a field
+    type: object
+    properties:
+      name:
+        description: Name of the field
+        type: string
+      objectName:
+        description: DMO name of the field
+        type: string
+  FieldRepresentation:
+    description: Output representation for a field
+    type: object
+    properties:
+      label:
+        description: Label of the field
+        type: string
+      name:
+        description: Name of the field
+        type: string
+      objectName:
+        description: DMO name of the field
+        type: string
+/personalization/engagement-signals:
+  get:
+    displayName: getEngagementSignalCollection
+    description: Get Engagement Signals
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalCollectionRepresentation
+    queryParameters:
+      dataspaceName:
+        type: string
+        required: false
+      limit:
+        type: integer
+        required: false
+      offset:
+        type: integer
+        required: false
+      profileDataGraphName:
+        type: string
+        required: false
+  post:
+    displayName: postEngagementSignalCollection
+    description: Create an Engagement Signal
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalRepresentation
+    body:
+      application/json:
+        type: EngagementSignalInputRepresentation
+        # required: false
+        (oas-body-name): input
+/personalization/engagement-signals/{engagementSignalId}:
+  delete:
+    displayName: deleteEngagementSignal
+    description: Delete an Engagement Signal
+    responses:
+      '200':
+        description: Success
+  get:
+    displayName: getEngagementSignal
+    description: Get an Engagement Signal
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalRepresentation
+  uriParameters:
+    engagementSignalId:
+      type: string
+      required: true
+/personalization/engagement-signals/{engagementSignalId}/metrics:
+  post:
+    displayName: postEngagementSignalMetricCollection
+    description: Create an Engagement Signal Metric
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalMetricRepresentation
+    body:
+      application/json:
+        type: EngagementSignalMetricInputRepresentation
+        # required: false
+        (oas-body-name): input
+  uriParameters:
+    engagementSignalId:
+      type: string
+      required: true
+/personalization/compound-metrics:
+  post:
+    displayName: postCompoundMetricCollection
+    description: Create an Compound Metric
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalCompoundMetricRepresentation
+    body:
+      application/json:
+        type: EngagementSignalCompoundMetricInputRepresentation
+        # required: false
+        (oas-body-name): input
+
+/personalization/engagement-signals/{engagementSignalId}/metrics/{engagementSignalMetricId}:
+  delete:
+    displayName: deleteEngagementSignalMetric
+    description: Delete an Engagement Signal Metric
+    responses:
+      '200':
+        description: Success
+  get:
+    displayName: getEngagementSignalMetric
+    description: Get an Engagement Signal Metric
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalMetricRepresentation
+  uriParameters:
+    engagementSignalId:
+      type: string
+      required: true
+    engagementSignalMetricId:
+      type: string
+      required: true
+
+/personalization/compound-metrics/{compoundMetricIdOrName}:
+  delete:
+    displayName: deleteCompoundMetric
+    description: Delete an Compound Metric
+    responses:
+      '200':
+        description: Success
+  get:
+    displayName: getCompoundMetric
+    description: Get an Compound Metric
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: EngagementSignalCompoundMetricRepresentation
+  uriParameters:
+    compoundMetricIdOrName:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,85 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'engmt-config'
+
+types:
+  EngagementSignalRepresentation:
+    (luvio.key):
+      id: id
+    type: object
+    (luvio.ttl): 6000
+
+  EngagementSignalCollectionRepresentation:
+    type: object
+    (luvio.ttl): 6000
+
+  EngagementSignalMetricRepresentation:
+    (luvio.key):
+      id: id
+    type: object
+    (luvio.ttl): 6000
+  EngagementSignalCompoundMetricRepresentation:
+    (luvio.key):
+      id: id
+    type: object
+    (luvio.ttl): 6000
+/personalization/engagement-signals:
+  post:
+    (luvio.adapter):
+      name: createEngagementSignal
+  get:
+    (luvio.adapter):
+      name: getEngagementSignals
+
+/personalization/engagement-signals/{engagementSignalId}:
+  get:
+    (luvio.adapter):
+      name: getEngagementSignal
+    (luvio.key):
+      id: urlParams.engagementSignalId
+
+  delete:
+    (luvio.adapter):
+      name: deleteEngagementSignal
+    (luvio.key):
+      id: urlParams.engagementSignalId
+
+/personalization/engagement-signals/{engagementSignalId}/metrics:
+  post:
+    (luvio.adapter):
+      name: createEngagementSignalMetric
+
+/personalization/engagement-signals/{engagementSignalId}/metrics/{engagementSignalMetricId}:
+  get:
+    (luvio.adapter):
+      name: getEngagementSignalMetric
+    (luvio.key):
+      id: urlParams.engagementSignalMetricId
+
+  delete:
+    (luvio.adapter):
+      name: deleteEngagementSignalMetric
+    (luvio.key):
+      id: urlParams.engagementSignalMetricId
+
+/personalization/compound-metrics:
+  post:
+    (luvio.adapter):
+      name: createEngagementSignalCompoundMetric
+
+/personalization/compound-metrics/{compoundMetricIdOrName}:
+  get:
+    (luvio.adapter):
+      name: getCompoundMetric
+    (luvio.key):
+      id: urlParams.compoundMetricIdOrName
+
+  delete:
+    (luvio.adapter):
+      name: deleteCompoundMetric
+    (luvio.key):
+      id: urlParams.compoundMetricIdOrName