@salesforce/lds-adapters-service-serviceplan 1.308.0-dev5 → 1.308.0-dev6

package/src/raml/api.raml

@@ -82,6 +82,87 @@ types:
         type: array
         items:
           type: ServicePlanStepExecutionSummaryRepresentation
+  ServicePlanDetailsOutputRepresentation:
+    description: Represent the service plan details
+    type: object
+    properties:
+      plan:
+        description: The Service Plan Details
+        type: ServicePlanDetailsRepresentation
+      planRequestId:
+        description: The record ID of plan request passed to this Connect API
+        type: string
+      reason:
+        description: The reason of the Service Plan Details
+        type: string
+        enum:
+          - CannotGetPlanDetails
+          - None
+      reasonDetails:
+        description: The reason details of the Service Plan Details
+        type: string | nil
+      status:
+        description: The status of the Service Plan Details
+        type: string
+        enum:
+          - Error
+          - Success
+  ServicePlanDetailsRepresentation:
+    description: Service Plan representation
+    type: object
+    properties:
+      createdDate:
+        description: Created Date
+        type: string | nil
+      executionStatus:
+        description: Execution Status
+        type: string | nil
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      feedbackId:
+        description: Feedback ID
+        type: string | nil
+      clientFeatureId:
+        description: clientFeature ID
+        type: string | nil
+      planId:
+        description: Plan ID
+        type: string | nil
+      servicePlanSteps:
+        description: Service Plan Steps
+        type: array
+        items:
+          type: ServicePlanStepDetailsRepresentation
+      topic:
+        description: Topic
+        type: string | nil
+  ServicePlanStepDetailsRepresentation:
+    description: Service Plan step representation
+    type: object
+    properties:
+      executionStatus:
+        description: Step execution state
+        type: string
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      groupName:
+        description: Group Name
+        type: string | nil
+      order:
+        description: Step order
+        type: integer
+      stepId:
+        description: Step ID
+        type: string
+      stepName:
+        description: Step name
+        type: string
   ServicePlanGenerationInputMapRepresentation:
     description: Represents a request for generating a service plan
     type: object
@@ -102,7 +183,7 @@ types:
         properties:
           //:
             type: string
-      mode:
+      generationMode:
         description: Plan generation mode
         type: string
         enum:
@@ -127,7 +208,7 @@ types:
       sessionKey:
         description: Session Key used to communicate with LLM
         type: string | nil
-  ServicePlanGenerationSyncOutputRepresentation:
+  ServicePlanGenerationOutputRepresentation:
     description: Represent the service plan generation result
     type: object
     properties:
@@ -145,7 +226,7 @@ types:
         type: string | nil
       plan:
         description: The generated service plan
-        type: ServicePlanOutputRepresentation
+        type: ServicePlanOutputRepresentation | nil
       reason:
         description: The reason of the service plan creation request job failure
         type: string
@@ -155,9 +236,6 @@ types:
           - None
           - ThresholdError
           - 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
@@ -266,21 +344,18 @@ types:
     description: Represent a step of a generated Service Plan
     type: object
     properties:
-      actionOrder:
-        description: Order in which this action will be executed
-        type: integer
-      functionName:
-        description: The name of the service plan step
-        type: string
+      groupName:
+        description: The group name of service plan step
+        type: string | nil
       id:
         description: Generated Plan Step ID
         type: string
-      relatedActionId:
-        description: ID of the action related to this generated plan step
-        type: string
-      summary:
-        description: The description of the service plan step
-        type: string
+      name:
+        description: The name of service plan step
+        type: string | nil
+      order:
+        description: Order in which this action will be executed
+        type: integer
 /connect/service-plan:
   /execute/{planOrStepId}:
     get:
@@ -311,15 +386,21 @@ types:
         required: true
   /generationRequests:
     post:
-      displayName: postServicePlanGenerationSync
-      description: Synchronously trigger the generation of a service plan for a case
+      displayName: postServicePlanGeneration
+      description: Trigger the generation of a service plan for a case
       responses:
         '200':
           description: Success
           body:
             application/json:
-              type: ServicePlanGenerationSyncOutputRepresentation
+              type: ServicePlanGenerationOutputRepresentation
       queryParameters:
+        processingMode:
+          type: string
+          required: false
+          enum:
+            - Async
+            - Sync
         recordId:
           type: string
           required: false
@@ -327,3 +408,31 @@ types:
         application/json:
           type: ServicePlanGenerationInputParamRepresentation
           (oas-body-name): servicePlanGenerationRequest
+  /generationRequests/{requestId}:
+    get:
+      displayName: getServicePlanGenerationRequest
+      description: Retrieve the status of a service plan generation request
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanGenerationOutputRepresentation
+    uriParameters:
+      requestId:
+        type: string
+        required: true
+  /servicePlanDetails/{recordId}:
+    get:
+      displayName: getServicePlanDetails
+      description: Returns Service Plan details
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanDetailsOutputRepresentation
+    uriParameters:
+      recordId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -14,9 +14,9 @@ types:
     (luvio.opaque): true
   ServicePlanGenerationSessionInformationOutputRepresentation:
     (luvio.opaque): true
-  ServicePlanGenerationSyncOutputRepresentation:
+  ServicePlanGenerationOutputRepresentation:
     (luvio.key):
-      id: reason
+      id: id
     (luvio.ttl): 1000
   ServicePlanOutputRepresentation:
     (luvio.opaque): true
@@ -33,6 +33,14 @@ types:
   ServicePlanExecutionOutputRepresentation:
     (luvio.key):
       id: executionStatus
+  ServicePlanDetailsRepresentation:
+    (luvio.opaque): true
+  ServicePlanStepDetailsRepresentation:
+    (luvio.opaque): true
+  ServicePlanDetailsOutputRepresentation:
+    (luvio.key):
+      id: planRequestId
+    (luvio.ttl): 1000
 
 /connect/service-plan:
   /execute/{planOrStepId}:
@@ -42,4 +50,16 @@ types:
   /generationRequests:
     post:
       (luvio.adapter):
-        name: generateSync
+        name: generateServicePlan
+  /generationRequests/{requestId}:
+    get:
+      (luvio.adapter):
+        name: getGenerationRequest
+      (luvio.key):
+        id: urlParams.requestId
+  /servicePlanDetails/{recordId}:
+    get:
+      (luvio.adapter):
+        name: getServicePlan
+      (luvio.key):
+        id: urlParams.recordId

package/dist/es/es2018/types/src/generated/adapters/generateSync.d.ts

@@ -1,20 +0,0 @@
-import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
-import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
-import { ResourceRequestConfig as resources_postConnectServicePlanGenerationRequests_ResourceRequestConfig } from '../resources/postConnectServicePlanGenerationRequests';
-import { ServicePlanGenerationSyncOutputRepresentation as types_ServicePlanGenerationSyncOutputRepresentation_ServicePlanGenerationSyncOutputRepresentation } from '../types/ServicePlanGenerationSyncOutputRepresentation';
-export declare const adapterName = "generateSync";
-export declare const generateSync_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
-export declare const generateSync_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
-export interface GenerateSyncConfig {
-    recordId?: string;
-    additionalContext: {
-        [key: string]: string;
-    };
-    mode: string;
-    source: string;
-}
-export declare const createResourceParams: (config: GenerateSyncConfig) => resources_postConnectServicePlanGenerationRequests_ResourceRequestConfig;
-export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GenerateSyncConfig>): adapter$45$utils_Untrusted<GenerateSyncConfig>;
-export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GenerateSyncConfig | null;
-export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GenerateSyncConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<import("@luvio/engine").FulfilledSnapshot<types_ServicePlanGenerationSyncOutputRepresentation_ServicePlanGenerationSyncOutputRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_ServicePlanGenerationSyncOutputRepresentation_ServicePlanGenerationSyncOutputRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_ServicePlanGenerationSyncOutputRepresentation_ServicePlanGenerationSyncOutputRepresentation, any>>;
-export declare const generateSyncAdapterFactory: $64$luvio_engine_AdapterFactory<GenerateSyncConfig, types_ServicePlanGenerationSyncOutputRepresentation_ServicePlanGenerationSyncOutputRepresentation>;