@salesforce/lds-adapters-cdp-personalization-service 1.354.0-dev2 → 1.354.0-dev20

package/src/raml/api.raml

@@ -1167,6 +1167,25 @@ types:
         description: Error message
         type: string
         required: false
+  PersonalizationDataMlModelInputFeatureRepresentation:
+    description: Represents Personalization Data Ml Model Input
+    type: object
+    properties:
+      inputField:
+        description: CDP ES model Input Feature
+        type: any
+      personalizationField:
+        description: Path or Name to the personalization field
+        type: any
+      type:
+        description: Personalization Field Type
+        type: string
+        enum:
+          - CalculatedInsights
+          - Contextual
+          - Direct
+          - Related
+          - Segment
   PersonalizationDataMlModelCollectionRepresentation:
     description: Represent Personalization Data Ml Model Collection
     type: object
@@ -1177,23 +1196,182 @@ types:
         items:
           type: PersonalizationDataMlModelRepresentation
   PersonalizationDataMlModelRepresentation:
-    description: Personalization Data Ml Model Representation.
+    description: Represent Personalization Data Ml Model
+    type: object
+    properties:
+      id:
+        description: The 18 character ID of the record
+        type: string
+      label:
+        description: label of the model mapping
+        type: string
+      name:
+        description: Name of the model mapping
+        type: string
+      dataMlModelInputs:
+        description: Personalization Input mappings to ES model
+        type: array
+        items:
+          type: PersonalizationDataMlModelInputFeatureRepresentation
+      dataSpaceName:
+        description: DataSpace Name
+        type: string
+      mlConfiguredModel:
+        description: Einstein Studio Configured Model
+        type: any
+      profileDataGraphInfo:
+        description: Profile Data Graph Info
+        type: any
+      status:
+        description: status of the model mapping
+        type: string
+        enum:
+          - Active
+          - CreateError
+          - DeleteError
+          - Deleting
+          - EditError
+          - Processing
+  PersonalizationExperienceConfigCollectionInputRepresentation:
+    description: Personalization Experience Config Collection Input Representation
+    type: object
+    properties:
+      personalizationExperienceConfigs:
+        description: List of Personalization Experience Configs
+        type: array
+        items:
+          type: array
+          items:
+            type: object
+  PersonalizationExperienceConfigCollectionRepresentation:
+    description: Personalization Experience Config Collection Output Representation
+    type: PersonalizationPaginatedResponseBaseRepresentation
+    properties:
+      personalizationExperienceConfigs:
+        description: List of Personalization Experience Configs
+        type: array
+        items:
+          type: PersonalizationExperienceConfigRepresentation
+  PersonalizationExperienceConfigInputRepresentation:
+    description: Personalization Experience Config Input Representation
     type: object
     properties:
-      dataSpaceId:
-        description: Data space Id
+      dataProvider:
+        description: What is supplying the data for this Personalization Experience?
+        type: any
+      description:
+        description: Description of the Personalization Experience Config
         type: string
-      esModelDefinitionId:
-        description: Einstein studio model Id
+      displayUrl:
+        description: When editing this configuration on the Website which page of
+          the website should this configuration be displayed on if not the current
+          page.
         type: string
-      personalizationDataMlModelInputList:
-        description: Personalization data ML model Input feature
+      isEnabled:
+        description: Whether or not this particular configuration is enabled.
+        type: boolean
+      label:
+        description: Label of the Personalization Experience Config
+        type: string
+      lastModifiedDate:
+        description: The datetime when this Personalization Experience Config was
+          last modified.
+        type: string
+        required: false
+      name:
+        description: Name of the Personalization Experience Config
+        type: string
+      publishedDate:
+        description: The datetime when this Personalization Experience Config was
+          last published.
+        type: string
+        required: false
+      sourceMatchers:
+        description: How to find the source where this personalization will occur
+          which for web is which web pages.
         type: array
         items:
           type: any
-      profileDataGraphId:
-        description: Profile Data Graph Id
+      transformationConfig:
+        description: How will the data provided by the Data Provider be transformed?
+        type: any
+  PersonalizationPaginatedResponseBaseRepresentation:
+    description: Base paginated response representation
+    type: object
+    discriminator: nextPageUrl
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string
+      totalSize:
+        description: Total size of collection
+        type: integer
+  PersonalizationExperienceConfigRepresentation:
+    description: Personalization Experience Config Output Representation
+    type: object
+    properties:
+      createdById:
+        description: Id of the user who created this Personalization Experience Config
+        type: string
+        required: false
+      createdDate:
+        description: The datetime when this Personalization Experience Config was
+          created.
+        type: string
+        required: false
+      dataProvider:
+        description: What is supplying the data for this Personalization Experience?
+        type: any
+      description:
+        description: Description of the Personalization Experience Config
+        type: string
+        required: false
+      displayUrl:
+        description: When editing this configuration on the Website which page of
+          the website should this configuration be displayed on if not the current
+          page.
+        type: string
+      id:
+        description: Id of the Personalization Experience Config
         type: string
+        required: false
+      isEnabled:
+        description: Whether or not this particular configuration is enabled.
+        type: boolean
+      label:
+        description: Label of the Personalization Experience Config
+        type: string
+        required: false
+      lastModifiedById:
+        description: Id of the user who last modified this Personalization Experience
+          Config
+        type: string
+        required: false
+      lastModifiedDate:
+        description: The datetime when this Personalization Experience Config was
+          last modified.
+        type: string
+        required: false
+      name:
+        description: Name of the Personalization Experience Config
+        type: string
+      publishedDate:
+        description: The datetime when this Personalization Experience Config was
+          last published.
+        type: string
+        required: false
+      sourceMatchers:
+        description: How to find the source where this personalization will occur
+          which for web is which web pages.
+        type: array
+        items:
+          type: any
+      transformationConfig:
+        description: How will the data provided by the Data Provider be transformed?
+        type: any
 
 /personalization:
   /personalization-points:
@@ -1321,10 +1499,10 @@ types:
         idOrName:
           type: string
           required: true
-  /einstein-studio/model-mapping:
+  /data-ml-models:
     get:
       displayName: getP13nEsMlModelCollection
-      description: Get Es model mappings in Personalisation
+      description: Get Es model mappings in Personalization
       responses:
         '200':
           description: Success
@@ -1332,15 +1510,101 @@ types:
             application/json:
               type: PersonalizationDataMlModelCollectionRepresentation
       queryParameters:
-        dataspaceIdOrName:
+        dataSpaceName:
           type: string
           required: false
         limit:
           type: integer
           required: false
+        mlConfiguredModelName:
+          type: string
+          required: false
         offset:
           type: integer
           required: false
-        profileDataGraphIdOrName:
+        profileDataGraphName:
           type: string
           required: false
+        status:
+          type: string
+          required: false
+          enum:
+            - Active
+            - CreateError
+            - DeleteError
+            - Deleting
+            - EditError
+            - Processing
+
+  /external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs:
+    get:
+      displayName: getPersonalizationExperienceConfigCollection
+      description: Gets a list of Personalization Experience Configs
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationExperienceConfigCollectionRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+    post:
+      displayName: postPersonalizationExperienceConfigCollection
+      description: Create a Personalization Experience Config
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationExperienceConfigRepresentation
+      body:
+        application/json:
+          type: PersonalizationExperienceConfigInputRepresentation
+          # required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+          (oas-body-name): input
+    uriParameters:
+      idOrAppSourceIdOrName:
+        type: string
+        required: true
+  /external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs/{nameParam}:
+    delete:
+      displayName: deletePersonalizationExperienceConfig
+      description: Delete a Personalization Experience Config
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getPersonalizationExperienceConfig
+      description: Get a Personalization Experience Config
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationExperienceConfigRepresentation
+    put:
+      displayName: putPersonalizationExperienceConfig
+      description: Updates a Personalization Experience Config
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PersonalizationExperienceConfigRepresentation
+      body:
+        application/json:
+          type: PersonalizationExperienceConfigInputRepresentation
+          # required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+          (oas-body-name): input
+    uriParameters:
+      idOrAppSourceIdOrName:
+        type: string
+        required: true
+      nameParam:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -28,6 +28,18 @@ types:
   PersonalizationDataMlModelCollectionRepresentation:
     type: object
     (luvio.ttl): 600
+  PersonalizationExperienceConfigCollectionRepresentation:
+    (luvio.opaque): true
+  PersonalizationExperienceConfigRepresentation:
+    (luvio.key):
+      id: name
+    type: object
+    (luvio.ttl): 600
+  PersonalizationExperienceConfigInputRepresentation:
+    type: object
+    (luvio.ttl): 600
+  PersonalizationPaginatedResponseBaseRepresentation:
+    (luvio.ttl): 600
 
 /personalization/personalization-points:
   post:
@@ -77,7 +89,30 @@ types:
         name: postPersonalizationRecommenderSimulateAction
       (luvio.method): get
 
-/personalization/einstein-studio/model-mapping:
+/personalization/data-ml-models:
   get:
     (luvio.adapter):
       name: getPersonalizationEsModelMapping
+
+/personalization/external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs:
+  get:
+    (luvio.adapter):
+      name: getPersonalizationExperiencesConfigs
+  post:
+    (luvio.adapter):
+      name: createPersonalizationExperiencesConfig
+
+/personalization/external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs/{nameParam}:
+  delete:
+    (luvio.adapter):
+      name: deletePersonalizationExperienceConfig
+    (luvio.key):
+      id: urlParams.nameParam
+  get:
+    (luvio.adapter):
+      name: getPersonalizationExperienceConfig
+    (luvio.key):
+      id: urlParams.nameParam
+  put:
+    (luvio.adapter):
+      name: updatePersonalizationExperienceConfig