@salesforce/lds-adapters-cdp-personalization-service 1.299.0

package/src/raml/api.raml

@@ -0,0 +1,458 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.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:
+  ABnExperimentCohortInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: ABn Experiment Cohort Input Representation
+    type: object
+    properties:
+      description:
+        description: Personalization Base description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization Base label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization Point API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      allocationWeight:
+        description: Number between 0 and 10000 (basis points) for traffic percent
+          allocation
+        type: integer
+      attributeValues:
+        description: Personalization Attribute Values associated with a Cohort
+        type: array
+        items:
+          type: object
+      isControl:
+        description: Whether or not this is the control Cohort
+        type: boolean
+      personalizerName:
+        description: The API name of the Personalizer associated with a Cohort
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  ABnExperimentInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: ABn Experiment Input Representation
+    type: object
+    properties:
+      description:
+        description: Personalization Base description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization Base label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization Point API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      cohorts:
+        description: List of Cohorts associated with the Experiment
+        type: array
+        items:
+          type: array
+          items:
+            type: object
+      dataSpaceName:
+        description: The API name of the Data Space associated with the Experiment
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      profileDataGraphName:
+        description: The API name of the Profile Data Graph associated with the Experiment
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      schemaEnum:
+        description: A schema enum associated with the Experiment if it has a standard
+          schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - ExperienceVariation
+          - FlowPath
+      schemaName:
+        description: An API name of a Schema associated with the Experiment if it
+          has a custom schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      source:
+        description: Experiment source
+        type: string
+        enum:
+          - BlockBuilder
+          - ExperienceBuilder
+          - PersonalizationApp
+  ABnExperimentRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: ABn Experiment Output Representation
+    type: object
+    properties:
+      createdById:
+        description: Created by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      createdDate:
+        description: Created date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      id:
+        description: The 18 character ID of the record
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization base output label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedById:
+        description: Last modified by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedDate:
+        description: Last modified date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization base output API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      url:
+        description: Url
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      dataSpaceName:
+        description: The API name of the Data Space associated with the Experiment
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      description:
+        description: Experiment description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      profileDataGraphName:
+        description: The API name of the Profile Data Graph associated with the Experiment
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      schemaEnum:
+        description: A schema enum associated with the Experiment if it has a standard
+          schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - ExperienceVariation
+          - FlowPath
+      schemaName:
+        description: An API name of a Schema associated with the Experiment if it
+          has a custom schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      source:
+        description: Where this experiment was created
+        type: string
+        enum:
+          - BlockBuilder
+          - ExperienceBuilder
+          - PersonalizationApp
+      startedDate:
+        description: Started date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      state:
+        description: Experiment state
+        type: string
+        enum:
+          - Archived
+          - Created
+          - Started
+          - Stopped
+      status:
+        description: Experiment off-core sync status
+        type: string
+        enum:
+          - Active
+          - CreateError
+          - DeleteError
+          - Deleting
+          - EditError
+          - Processing
+      stoppedDate:
+        description: Stopped date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  PersonalizationAttributeValueInputRepresentation:
+    description: Personalization Attribute Value Input Representation
+    type: object
+    properties:
+      attributeEnum:
+        description: Attribute enum if it is assigning a custom attribute
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - FlowPath
+          - Variation
+      attributeName:
+        description: Attribute API name of the Personalization Attribute if it is
+          assigning a custom attribute
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      value:
+        description: Personalization Attribute Value
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  PersonalizationAttributeValueRepresentation:
+    description: Personalization Attribute Value Output Representation
+    type: object
+    properties:
+      attributeEnum:
+        description: A standard attribute that the value is being assigned to
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - FlowPath
+          - Variation
+      attributeName:
+        description: An API name of a custom attribute the value is being assigned
+          to
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      value:
+        description: The value of the Personalization Attribute Value
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  PersonalizationDecisionInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: Personalization Decision Input Representation
+    type: object
+    properties:
+      description:
+        description: Personalization Base description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization Base label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization Point API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      attributeValues:
+        description: Personalization Attribute Values associated with a Personalization
+          Decision
+        type: array
+        items:
+          type: PersonalizationAttributeValueInputRepresentation #Hand-rolled issue #21 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      criteria:
+        description: Personalization Decision criteria
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      personalizerName:
+        description: The API name of the Personalizer associated with a Personalization
+          Decision
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  PersonalizationDecisionRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: Personalization Decision Output Representation
+    type: object
+    properties:
+      createdById:
+        description: Created by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      createdDate:
+        description: Created date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      id:
+        description: The 18 character ID of the record
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization base output label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedById:
+        description: Last modified by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedDate:
+        description: Last modified date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization base output API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      url:
+        description: Url
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      attributeValues:
+        description: List of PersonalizationAttributeValues associated with the Personalization
+          Decision
+        type: array
+        items:
+          type: PersonalizationAttributeValueRepresentation
+      criteria:
+        description: The criteria of the Personalization Decision
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      description:
+        description: Personalization Decision description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      personalizerName:
+        description: The API name of the Personalizer associated with the Personalization
+          Decision
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  PersonalizationPointInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: Personalization Point Input Representation
+    type: object
+    properties:
+      description:
+        description: Personalization Base description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization Base label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization Point API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      abnExperimentName:
+        description: The API name of an ABn Experiment to associated with the Personalization
+          Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      dataSpaceName:
+        description: The API name of the Data Space associated with the Personalization
+          Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      decisions:
+        description: List of PersonalizationDecisions associated with the Personalization
+          Point
+        type: array
+        items:
+          type: PersonalizationDecisionInputRepresentation #Hand-rolled issue #21 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      profileDataGraphName:
+        description: The API name of the Profile Data Graph associated with the Personalization
+          Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      schemaEnum:
+        description: A schema enum associated with the Personalization Point if it
+          has a standard schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - ExperienceVariation
+          - FlowPath
+      schemaName:
+        description: An API name of a Schema associated with the Personalization Point
+          if it has a custom schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      source:
+        description: Personalization Point source
+        type: string
+        enum:
+          - BlockBuilder
+          - ExperienceBuilder
+          - PersonalizationApp
+  PersonalizationPointRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+    description: Personalization Point Output Representation
+    type: object
+    properties:
+      createdById:
+        description: Created by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      createdDate:
+        description: Created date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      id:
+        description: The 18 character ID of the record
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      label:
+        description: Personalization base output label
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedById:
+        description: Last modified by id
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lastModifiedDate:
+        description: Last modified date
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      name:
+        description: Personalization base output API name
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      url:
+        description: Url
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      abnExperimentName:
+        description: The API name of an optional ABn Experiment associated with the
+          Personalization Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      dataSpaceName:
+        description: The API name of the Data Space associated with the Personalization
+          Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      decisions:
+        description: List of PersonalizationDecisions associated with the Personalization
+          Point
+        type: array
+        items:
+          type: PersonalizationDecisionRepresentation
+      description:
+        description: Personalization Point description
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      profileDataGraphName:
+        description: The API name of the Profile Data Graph associated with the Personalization
+          Point
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      schemaEnum:
+        description: A schema enum associated with the Personalization Point if it
+          has a standard schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        enum:
+          - ExperienceVariation
+          - FlowPath
+      schemaName:
+        description: An API name of a Schema associated with the Personalization Point
+          if it has a custom schema
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      source:
+        description: Personalization Point source
+        type: string
+        enum:
+          - BlockBuilder
+          - ExperienceBuilder
+          - PersonalizationApp
+      status:
+        description: Personalization Point status
+        type: string
+        enum:
+          - Active
+          - CreateError
+          - DeleteError
+          - Deleting
+          - EditError
+          - Processing
+/personalization:
+  /personalization-points:
+    post:
+      displayName: postPersonalizationPointCollection
+      description: Create a Personalization Point
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationPointRepresentation
+      body:
+        application/json:
+          type: PersonalizationPointInputRepresentation
+          # required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+          (oas-body-name): input
+  /personalization-points/{idOrName}:
+    delete:
+      displayName: deletePersonalizationPoint
+      description: Delete a Personalization Point
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getPersonalizationPoint
+      description: Get a Personalization Point
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationPointRepresentation
+    put:
+      displayName: putPersonalizationPoint
+      description: Update a Personalization Point
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationPointRepresentation
+      body:
+        application/json:
+          type: PersonalizationPointInputRepresentation
+          # required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+          (oas-body-name): input
+    uriParameters:
+      idOrName:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,34 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'personalization-service'
+
+types:
+  PersonalizationPointRepresentation:
+    (luvio.key):
+      id: name
+    type: object
+    (luvio.ttl): 600
+
+/personalization/personalization-points:
+  post:
+    (luvio.adapter):
+      name: createPersonalizationPoint
+
+/personalization/personalization-points/{idOrName}:
+  get:
+    (luvio.adapter):
+      name: getPersonalizationPoint
+    (luvio.key):
+      id: urlParams.idOrName
+  delete:
+    (luvio.adapter):
+      name: deletePersonalizationPoint
+    (luvio.key):
+      id: urlParams.idOrName
+  put:
+    (luvio.adapter):
+      name: updatePersonalizationPoint