@salesforce/lds-adapters-service-serviceplan 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,351 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '65.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  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 #handRolled
+      status:
+        description: The status of the Service Plan Details
+        type: string
+        enum:
+          - Error
+          - Success
+  ServicePlanDetailsRepresentation:
+    description: Service Plan representation
+    type: object
+    properties:
+      clientFeatureId:
+        description: ClientFeature ID
+        type: string | nil #handRolled
+      createdDate:
+        description: Created Date
+        type: string | nil #handRolled
+      executionStatus:
+        description: Execution Status
+        type: string | nil #handRolled
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      feedbackId:
+        description: Feedback ID
+        type: string | nil #handRolled
+      hasContextChanged:
+        description: Has Context Changed
+        type: boolean
+      planHeader:
+        description: PlanHeader
+        type: string | nil #handRolled
+      planId:
+        description: Plan ID
+        type: string | nil #handRolled
+      servicePlanSteps:
+        description: Service Plan Steps
+        type: array
+        items:
+          type: ServicePlanStepDetailsRepresentation
+      topic:
+        description: Topic
+        type: string | nil #handRolled
+  ServicePlanExecutionInputRepresentation:
+    description: Represents a generated service plan input context required for service plan execution
+    type: object
+    properties:
+      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:
+      executionStatus:
+        description: The Status of the service plan execution request job
+        type: string
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      planSteps:
+        description: All the step status
+        type: array
+        items:
+          type: ServicePlanStepExecutionStatusRepresentation
+  ServicePlanGenerationInputMapRepresentation:
+    description: Represents a request for generating a service plan
+    type: object
+    properties:
+      map:
+        description: Additional context for the plan generation request
+        type: object
+        properties:
+          //:
+            type: string
+  ServicePlanGenerationInputParamRepresentation:
+    description: Represents a request for generating a service plan
+    type: object
+    properties:
+      additionalContext:
+        description: Additional context for the plan generation request
+        type: object
+        properties:
+          //:
+            type: string
+      generationMode:
+        description: Plan generation mode
+        type: string
+        enum:
+          - NoSave
+          - Save
+      source:
+        description: Origin for the plan generation request
+        type: string
+  ServicePlanGenerationOutputRepresentation:
+    description: Represent the service plan generation result
+    type: object
+    properties:
+      errorCode:
+        description: Error code to identify the error
+        type: string | nil #handRolled: success have no error code
+      errorMessage:
+        description: Details related to the Error Reason, if any
+        type: string | nil #handRolled
+      id:
+        description: The generated request ID
+        type: string | nil #handRolled: NoSave Mode have no id
+      reason:
+        description: The reason of the service plan creation request job failure
+        type: string
+        enum:
+          - CannotGeneratePlan
+          - NoEligibilityConfig
+          - NoPlanGenerated
+          - None
+          - PlanAlreadyExists
+          - PlanEmpty
+          - PlanEmptyInsufficientData
+          - ThresholdError
+          - ThresholdNotMet
+      recordId:
+        description: The record this plan generation was requested for
+        type: string
+      status:
+        description: The Status of the service plan creation request job
+        type: string
+        enum:
+          - Error
+          - InProgress
+          - Incomplete
+          - Success
+      type:
+        description: Service Plan generation request type
+        type: string
+        enum:
+          - Generation
+          - GenerationPreview
+          - Summary
+  ServicePlanReferenceDetailsRepresentation:
+    description: Service Plan reference representation
+    type: object
+    properties:
+      id:
+        description: Reference ID
+        type: string
+      label:
+        description: Reference name
+        type: string
+      type:
+        description: Reference type
+        type: string
+  ServicePlanStepCitationSourceRepresentation:
+    description: Service Plan citations representation
+    type: object
+    properties:
+      recordId:
+        description: Citation RecordId, if any
+        type: string | nil #handRolled
+      sourceObjectName:
+        description: Citation source type
+        type: string | nil #handRolled
+      url:
+        description: Citation URL
+        type: string | nil #handRolled
+  ServicePlanStepDetailsRepresentation:
+    description: Service Plan step representation
+    type: object
+    properties:
+      citations:
+        description: Step citations
+        type: array
+        items:
+          type: ServicePlanStepCitationSourceRepresentation
+        required: false # Hand-Rolled W-18566464
+      executionStatus:
+        description: Step execution state
+        type: string
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      groupName:
+        description: Group Name
+        type: string | nil #handRolled
+      isSuggested:
+        description: Suggested step
+        type: boolean
+      order:
+        description: Step order
+        type: integer
+      references:
+        description: Step references
+        type: array
+        items:
+          type: ServicePlanReferenceDetailsRepresentation
+        required: false # Hand-Rolled W-18566464
+      stepId:
+        description: Step ID
+        type: string
+      stepName:
+        description: Step name
+        type: string
+      stepSummary:
+        description: Step summary
+        type: string
+  ServicePlanStepExecutionStatusRepresentation:
+    description: Represents the execution status of a Service Plan Step
+    type: object
+    properties:
+      executionStatus:
+        description: executionStatus
+        type: string
+        enum:
+          - Completed
+          - Failed
+          - InProgress
+          - New
+      stepId:
+        description: stepId
+        type: string | nil #handRolled
+/connect/service-plan:
+  /execute/{planOrStepId}:
+    put:
+      displayName: putServicePlanExecution
+      description: Executes a service plan or a step
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanExecutionOutputRepresentation
+      body:
+        application/json:
+          type: ServicePlanExecutionInputRepresentation
+          (oas-body-name): servicePlanExecutionInputRepresentation
+    uriParameters:
+      planOrStepId:
+        type: string
+        required: true
+  /generationRequests:
+    post:
+      displayName: postServicePlanGenerationPostable
+      description: Trigger the generation of a service plan for a case
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanGenerationOutputRepresentation
+      queryParameters:
+        processingMode:
+          type: string
+          required: false
+          enum:
+            - Async
+            - Sync
+        recordId:
+          type: string
+          required: false
+        regenerate:
+          type: boolean
+          required: false
+          default: false
+        useCase:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: ServicePlanGenerationInputParamRepresentation
+          (oas-body-name): servicePlanGenerationRequest
+  /generationRequests/{requestId}:
+    get:
+      displayName: getServicePlanGenerationGettable
+      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

@@ -0,0 +1,57 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'ServicePlan'
+(luvio.ttl): 500
+
+types:
+  ServicePlanGenerationOutputRepresentation:
+    (luvio.key):
+      id: id
+    (luvio.ttl): 1000
+    (luvio.updateAvailable):
+      name: notifyServicePlanGenerationUpdateAvailable
+      parameters:
+        id: id
+  ServicePlanStepExecutionStatusRepresentation:
+    (luvio.opaque): true
+  ServicePlanExecutionOutputRepresentation:
+    (luvio.key):
+      id: executionStatus
+  ServicePlanDetailsRepresentation:
+    (luvio.opaque): true
+  ServicePlanStepDetailsRepresentation:
+    (luvio.opaque): true
+  ServicePlanDetailsOutputRepresentation:
+    (luvio.key):
+      id: planRequestId
+    (luvio.ttl): 1000
+    (luvio.updateAvailable):
+      name: notifyServicePlanDetailsUpdateAvailable
+      parameters:
+        id: id
+
+/connect/service-plan:
+  /execute/{planOrStepId}:
+    put:
+      (luvio.adapter):
+        name: executeServicePlan
+  /generationRequests:
+    post:
+      (luvio.adapter):
+        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