@salesforce/lds-adapters-service-serviceplan 1.308.0-dev1 → 1.308.0-dev3

package/src/raml/api.raml

@@ -25,43 +25,48 @@ annotationTypes:
     type: string
     allowedTargets: TypeDeclaration
 types:
+  ServicePlanDataInputRepresentation:
+    description: Represents the Input for gathering the record details required to
+      generate the Service Plan
+    type: object
+    properties:
+      recordId:
+        description: Record ID
+        type: string
+  ServicePlanDataOutputRepresentation:
+    description: Represent the service plan data
+    type: object
+    properties:
+      recordDetails:
+        description: The Record details
+        type: string
   ServicePlanExecutionInputRepresentation:
     description: Represents a generated service plan input context required for service
       plan execution
     type: object
     properties:
-      intent:
-        description: Intent
-        type: string
-      planId:
-        description: Copilot planId
-        type: string
-      sessionId:
-        description: Copilot SessionId
+      action:
+        description: Action to be performed by the API
         type: string
+        enum:
+          - MarkCompleted
+          - MarkUncompleted
   ServicePlanExecutionOutputRepresentation:
     description: Represent the service plan execution result
     type: object
     properties:
-      reason:
-        description: The reason of the service plan execution request job failure
-        type: string
-        enum:
-          - CannotExecutePlan
-          - None
-      reasonDetails:
-        description: The details of the service plan execution request job failure
-        type: string
-      servicePlan:
-        description: The generated service plan
-        type: ServicePlanExecutionSummaryRepresentation
-      status:
+      executionStatus:
         description: The Status of the service plan execution request job
         type: string
         enum:
-          - Error
+          - Completed
+          - Failed
           - InProgress
-          - Success
+      planSteps:
+        description: All the step status
+        type: array
+        items:
+          type: ServicePlanStepExecutionStatusRepresentation
   ServicePlanExecutionSummaryRepresentation:
     description: Represents the execution summary of a Service Plan
     type: object # TODO Hand-rolled W-15545227
@@ -110,28 +115,37 @@ types:
     description: Represent the session information of a Service Plan Generation
     type: object
     properties:
-      botId:
-        description: Bot id used for invoking the planner service
-        type: string
-      botVersionId:
-        description: Bot id used for invoking the planner service
-        type: string
-      clientFeatureId:
-        description: Client Feature Id used for feedback on the plan generation
-        type: string
-      generationsId:
-        description: Generations Id used for feedback on the plan generation
-        type: string
-      planId:
-        description: Plan id used for plan execution or plan modification
-        type: string
-      sessionId:
-        description: Session id used for plan execution or plan modification
-        type: string
+      clientFeatureKey:
+        description: Client Feature Key used for feedback on the plan generation
+        type: string | nil
+      feedbackKey:
+        description: Feedback Key used for feedback on the plan generation
+        type: string | nil
+      planKey:
+        description: Plan Key used for plan execution or plan modification
+        type: string | nil
+      sessionKey:
+        description: Session Key used to communicate with LLM
+        type: string | nil
   ServicePlanGenerationSyncOutputRepresentation:
     description: Represent the service plan generation result
     type: object
     properties:
+      copilotId:
+        description: The Copilot used for this service plan generation request
+        type: string | nil
+      copilotName:
+        description: Name of the Copilot used for this service plan generation request
+        type: string | nil
+      errorMessage:
+        description: Details related to the Error Reason, if any
+        type: string | nil
+      id:
+        description: The generated request ID
+        type: string | nil
+      plan:
+        description: The generated service plan
+        type: ServicePlanOutputRepresentation
       reason:
         description: The reason of the service plan creation request job failure
         type: string
@@ -143,10 +157,10 @@ types:
           - ThresholdNotMet
       reasonDetails:
         description: The details of the service plan creation request job failure
+        type: string | nil
+      recordId:
+        description: The record this plan generation was requested for
         type: string
-      servicePlan:
-        description: The generated service plan
-        type: ServicePlanOutputRepresentation
       status:
         description: The Status of the service plan creation request job
         type: string
@@ -154,38 +168,53 @@ types:
           - Error
           - InProgress
           - Success
+      type:
+        description: Service Plan generation request type
+        type: string
+        enum:
+          - Generation
+          - Summary
   ServicePlanOutputRepresentation:
     description: Represent the generated Service Plan
     type: object
     properties:
-      copilot:
-        description: The copilot used to generate the service plan
-        type: string
+      copilotSessionInfo:
+        description: The session information related to the copilot generating the
+          plan
+        type: ServicePlanGenerationSessionInformationOutputRepresentation | nil
       createdDate:
         description: The created date of the service plan
-        type: string
-      generatedPlanId:
+        type: string | nil
+      id:
         description: The Id of the plan record
-        type: string
-      rawPlan:
+        type: string | nil
+      intent:
+        description: The intent detected for this Service Plan generation request
+        type: string | nil
+      plan:
         description: The raw plan generated by the copilot
-        type: string
-      sessionInformation:
-        description: The session information related to the copilot generating the
-          plan
-        type: ServicePlanGenerationSessionInformationOutputRepresentation
+        type: string | nil
       steps:
         description: The steps of the service plan
         type: array
         items:
-          type: object
-      topic:
-        description: The topic identified when generating the service plan
-        type: string
+          type: ServicePlanStepRepresentation
       topicDescription:
         description: The description of topic identified when generating the service
           plan
-        type: string
+        type: string | nil
+      topicId:
+        description: The topic identified when generating the service plan
+        type: string | nil
+      topicName:
+        description: Name of the topic identified when generating the service plan
+        type: string | nil
+      type:
+        description: Type of the Generated Plan
+        type: string | nil
+        enum:
+          - ExecutablePlan
+          - SummaryPlan
   ServicePlanRepresentation:
     description: Service Plan representation
     type: object
@@ -208,19 +237,24 @@ types:
       topicDescription:
         description: Topic Description
         type: string
-  ServicePlanStepAttributeRepresentation:
-    description: Represent an attribute in a step of a generated Service Plan
+  ServicePlanStepExecutionStatusRepresentation:
+    description: Represents the execution status of a Service Plan Step
     type: object
     properties:
-      name:
-        description: The name of the step attribute
-        type: string
-      value:
-        description: The value of the step attribute
+      executionStatus:
+        description: executionStatus
         type: string
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      stepId:
+        description: stepId
+        type: string | nil
   ServicePlanStepExecutionSummaryRepresentation:
     description: Represents the execution summary of a Service Plan Step
-    type: object # TODO Hand-rolled W-15545227
+    type: object # TODO Hand-rolled W-16160721
     properties:
       message:
         description: Message
@@ -232,25 +266,23 @@ types:
     description: Represent a step of a generated Service Plan
     type: object
     properties:
-      description:
-        description: The description of the service plan step
-        type: string
+      actionOrder:
+        description: Order in which this action will be executed
+        type: integer
       functionName:
         description: The name of the service plan step
         type: string
-      inputs:
-        description: The list of inputs of the service plan step
-        type: array
-        items:
-          type: ServicePlanStepAttributeRepresentation
-      outputCollection:
-        description: The output collection of the service plan step
+      id:
+        description: Generated Plan Step ID
+        type: string
+      relatedActionId:
+        description: ID of the action related to this generated plan step
         type: string
-      outputVariable:
-        description: The output variable of the service plan step
+      summary:
+        description: The description of the service plan step
         type: string
 /connect/service-plan:
-  /execute/{generatedPlanId}:
+  /execute/{planOrStepId}:
     get:
       displayName: getServicePlanExecution
       description: Returns Service Plan execution summary
@@ -262,7 +294,7 @@ types:
               type: ServicePlanExecutionOutputRepresentation
     put:
       displayName: putServicePlanExecution
-      description: Executes a Service Plan
+      description: Executes a Service Plan or a step
       responses:
         '200':
           description: Success
@@ -272,12 +304,12 @@ types:
       body:
         application/json:
           type: ServicePlanExecutionInputRepresentation
-          (oas-body-name): servicePlanInputRepresentation
+          (oas-body-name): servicePlanExecutionInputRepresentation
     uriParameters:
-      generatedPlanId:
+      planOrStepId:
         type: string
         required: true
-  /generateSync/{recordId}:
+  /generationRequests:
     post:
       displayName: postServicePlanGenerationSync
       description: Synchronously trigger the generation of a service plan for a case
@@ -287,11 +319,11 @@ types:
           body:
             application/json:
               type: ServicePlanGenerationSyncOutputRepresentation
+      queryParameters:
+        recordId:
+          type: string
+          required: false
       body:
         application/json:
           type: ServicePlanGenerationInputParamRepresentation
           (oas-body-name): servicePlanGenerationRequest
-    uriParameters:
-      recordId:
-        type: string
-        required: true

package/src/raml/luvio.raml

@@ -8,7 +8,9 @@ uses:
 (luvio.ttl): 500
 
 types:
-  ServicePlanGenerationInputParamRepresentation:
+  ServicePlanDataOutputRepresentation:
+    (luvio.opaque): true
+  ServicePlanExecutionSummaryRepresentation:
     (luvio.opaque): true
   ServicePlanGenerationSessionInformationOutputRepresentation:
     (luvio.opaque): true
@@ -26,16 +28,18 @@ types:
     (luvio.opaque): true
   ServicePlanStepRepresentation:
     (luvio.opaque): true
+  ServicePlanStepExecutionStatusRepresentation:
+    (luvio.opaque): true
   ServicePlanExecutionOutputRepresentation:
     (luvio.key):
-      id: reason
+      id: executionStatus
 
 /connect/service-plan:
-  /execute/{generatedPlanId}:
+  /execute/{planOrStepId}:
     put:
       (luvio.adapter):
         name: executeServicePlan
-  /generateSync/{recordId}:
+  /generationRequests:
     post:
       (luvio.adapter):
         name: generateSync

package/dist/es/es2018/types/src/generated/types/ServicePlanStepAttributeRepresentation.d.ts

@@ -1,31 +0,0 @@
-import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, BaseFragment as $64$luvio_engine_BaseFragment, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "99042f82adcd3c8da3dff5222960ee32";
-export declare function validate(obj: any, path?: string): TypeError | null;
-export declare const RepresentationType: string;
-export declare function normalize(input: ServicePlanStepAttributeRepresentation, existing: ServicePlanStepAttributeRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): ServicePlanStepAttributeRepresentationNormalized;
-export declare const select: () => $64$luvio_engine_BaseFragment;
-export declare function equals(existing: ServicePlanStepAttributeRepresentationNormalized, incoming: ServicePlanStepAttributeRepresentationNormalized): boolean;
-export declare const ingest: $64$luvio_engine_ResourceIngest;
-export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: ServicePlanStepAttributeRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
-/**
- * Represent an attribute in a step of a generated Service Plan
- *
- * Keys:
- *    (none)
- */
-export interface ServicePlanStepAttributeRepresentationNormalized {
-    /** The name of the step attribute */
-    name: string;
-    /** The value of the step attribute */
-    value: string;
-}
-/**
- * Represent an attribute in a step of a generated Service Plan
- *
- * Keys:
- *    (none)
- */
-export interface ServicePlanStepAttributeRepresentation {
-    name: string;
-    value: string;
-}