@salesforce/lds-adapters-service-einstein-copilot-bot 1.266.0-dev17 → 1.266.0-dev19

package/src/raml/api.raml

@@ -32,9 +32,11 @@ types:
       data:
         description: Data for the collect message.
         type: EsTypeMessageRepresentation
+        required: false
       targetProperty:
         description: Target property for the collect message.
         type: string | nil
+        required: false
       targetType:
         description: Target type for the collect message.
         type: string
@@ -56,12 +58,24 @@ types:
         description: Message ID that this message is replying to
         type: string
         required: false
+      intent:
+        description: Intent
+        type: string
+        required: false
       messageType:
         description: Message type
         type: string
         required: false
         enum:
           - Reply
+      planId:
+        description: PlanId
+        type: string
+        required: false
+      planTemplateVariables:
+        description: Additional Plan Templates Variables
+        type: any
+        required: false
       reply:
         description: Reply
         type: array
@@ -79,8 +93,13 @@ types:
         enum:
           - Cancel
           - EsMessage
+          - PlanTemplate
           - SetVariables
           - Text
+      userUtterance:
+        description: UserUtterance
+        type: string
+        required: false
       variables:
         description: Variables
         type: array
@@ -122,6 +141,7 @@ types:
       feedbackId:
         description: Feedback ID for this generated message.
         type: string | nil
+        required: false
       id:
         description: Unique id of this message
         type: string
@@ -136,6 +156,7 @@ types:
       planId:
         description: Plan ID for the generated plan.
         type: string | nil
+        required: false
       result:
         description: The result response for an Inform message.
         type: array
@@ -214,6 +235,7 @@ types:
       property:
         description: Property for the ES type message.
         type: string | nil
+        required: false
       type:
         description: Type for the ES type message.
         type: string
@@ -230,6 +252,48 @@ types:
       value:
         description: Value of the variable
         type: string
+        required: false
+  PlanTemplateRepresentation:
+    description: Represents a plan template which can be executed by a Copilot client.
+    type: object
+    properties:
+      intent:
+        description: Intent used by Planner when executing this plan template.
+        type: string
+      label:
+        description: Label to display when rendering this plan template in a Copilot
+          client.
+        type: string
+      planTemplateId:
+        description: ID of a plan template.
+        type: string
+      userUtterance:
+        description: User utterance to be recorded in conversation history by Planner
+          when executing this plan template.
+        type: string
+      variables:
+        description: Variables for executing this plan template.
+        type: object
+        properties:
+          //:
+            type: string
+  RecommendedPlanTemplatesRepresentation:
+    description: Represents the result of a get recommended plan templates request.
+    type: object
+    properties:
+      errorMessage:
+        description: Error message for the failed get operation.
+        type: string
+        required: false
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      planTemplates:
+        description: Recommended plan templates.
+        type: array
+        items:
+          type: PlanTemplateRepresentation
+
 /connect:
   /conversation-runtime-proxy:
     get:
@@ -267,3 +331,20 @@ types:
         application/json:
           type: ConversationRuntimeProxyInputRepresentation
           (oas-body-name): postBody
+  /recommended-plan-templates/{pageType}/{objectType}:
+    get:
+      displayName: getRecommendedPlanTemplates
+      description: Gets a list of recommended plan templates based on the page/app
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecommendedPlanTemplatesRepresentation
+    uriParameters:
+      pageType:
+        type: string
+        required: true
+      objectType:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -25,6 +25,10 @@ types:
     (luvio.ttl): 30000
   VariableRepresentation:
     (luvio.ttl): 30000
+  PlanTemplateRepresentation:
+    (luvio.ttl): 900000
+  RecommendedPlanTemplatesRepresentation:
+    (luvio.ttl): 900000
 
 /connect:
   /conversation-runtime-proxy:
@@ -34,3 +38,7 @@ types:
     post:
       (luvio.adapter):
         name: sendMessage
+  /recommended-plan-templates/{pageType}/{objectType}:
+    get:
+      (luvio.adapter):
+        name: getRecommendedPlanTemplates