@salesforce/lds-adapters-platform-interaction-orchestrator 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,244 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '52.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:
+  FlowOrchestrationInstanceCollectionRepresentation:
+    description: Information about a collection of Orchestration instances.
+    type: object
+    properties:
+      instances:
+        description: Collection of Orchestration instances
+        type: array
+        items:
+          type: FlowOrchestrationInstanceRepresentation
+  FlowOrchestrationInstanceRepresentation:
+    description: Information about an Orchestration instance.
+    type: object
+    properties:
+      flowDefinitionDeveloperName:
+        description: Developer name of the flow definition
+        type: string | nil
+      flowDefinitionId:
+        description: Id of the flow definition
+        type: string | nil
+      flowDefinitionName:
+        description: Name of the flow definition
+        type: string | nil
+      id:
+        description: Orchestrator instance id
+        type: string
+      interviewId:
+        description: Id of the interview to resume
+        type: string | nil
+      stageInstances:
+        description: The Orchestrator Instance stages
+        type: array
+        items:
+          type: FlowOrchestrationStageInstanceRepresentation
+      status:
+        description: The Orchestrator Instance status
+        type: string
+        enum:
+          - Canceled
+          - Completed
+          - Discontinued
+          - Error
+          - InProgress
+          - NotStarted
+          - Suspended
+  FlowOrchestrationStageInstanceRepresentation:
+    description: Information about an Orchestration stage instance.
+    type: object
+    properties:
+      completionTime:
+        description: Orchestration stage instance completion time in seconds
+        type: string | nil
+      id:
+        description: Orchestration stage instance id
+        type: string
+      label:
+        description: Orchestration stage instance label
+        type: string | nil
+      name:
+        description: Orchestration stage instance name
+        type: string | nil
+      status:
+        description: The Orchestration Stage Instance status
+        type: string
+        enum:
+          - Canceled
+          - Completed
+          - Discontinued
+          - Error
+          - InProgress
+          - NotStarted
+          - Suspended
+      stepInstances:
+        description: Orchestration stage instance steps
+        type: array
+        items:
+          type: FlowOrchestrationStepInstanceRepresentation
+  FlowOrchestrationStepInstanceRepresentation:
+    description: Information about an Orchestration step instance.
+    type: object
+    properties:
+      assignedTo:
+        description: Orchestration step assignee
+        type: string | nil
+      assigneeType:
+        description: Orchestration step assignee type
+        type: string | nil
+      comments:
+        description: Orchestration step instance comments
+        type: string | nil
+      completedBy:
+        description: Orchestration step completed by
+        type: string | nil
+      completionTime:
+        description: Orchestration step instance completion time in seconds
+        type: string | nil
+      description:
+        description: Orchestration step instance description
+        type: string | nil
+      id:
+        description: Orchestration step instance id
+        type: string
+      label:
+        description: Orchestration step instance label
+        type: string | nil
+      name:
+        description: Orchestration step instance name
+        type: string | nil
+      status:
+        description: The Orchestration Step Instance status
+        type: string
+        enum:
+          - Canceled
+          - Completed
+          - Discontinued
+          - Error
+          - InProgress
+          - NotStarted
+          - Suspended
+      stepType:
+        description: The Orchestration Step Instance step type
+        type: string
+        enum:
+          - ApprovalStep
+          - AsynchronousBackgroundStep
+          - BackgroundStep
+          - InteractiveStep
+          - ManagedContentRoleInteractiveStep
+          - ManagedContentVariantAutoPublishBackgroundStep
+          - ManagedContentVariantAutoUnpublishBackgroundStep
+          - ManagedContentVariantSetLockBackgroundStep
+          - ManagedContentVariantSetReadyBackgroundStep
+      workItems:
+        description: Orchestration step instance work items
+        type: array
+        items:
+          type: FlowOrchestrationWorkItemRepresentation
+  FlowOrchestrationWorkAssignmentRepresentation:
+    description: Information about an Orchestration work assignment.
+    type: object
+    properties: {}
+  FlowOrchestrationWorkItemRepresentation:
+    description: Information about an Orchestration work item.
+    type: object
+    properties:
+      assigneeId:
+        description: The assignee for this Orchestrator work item
+        type: string
+      createdDate:
+        description: Date the work item was created
+        type: string
+      description:
+        description: Description for this Orchestration work item
+        type: string | nil
+      flowType:
+        description: The flow type of the orchestration that created the orchestration work item
+        type: string | nil
+      id:
+        description: Orchestration work item id
+        type: string
+      label:
+        description: Label key for this work item
+        type: string | nil
+      lastModifiedDate:
+        description: Date the work item was last modified
+        type: string
+      relatedRecordId:
+        description: The record this work item is related to
+        type: string | nil
+      screenFlowDeveloperName:
+        description: Developer name of the screen flow to start when assignees work
+          on this work item
+        type: string
+      screenFlowId:
+        description: Id of the screen flow to start when assignees work on this work
+          item
+        type: string
+      screenFlowInputs:
+        description: Input parameters for the screen flow
+        type: string
+      status:
+        description: This work item status
+        type: string
+        enum:
+          - Assigned
+          - Completed
+          - InProgress
+          - NotStarted
+/connect/interaction/orchestration:
+  /instance/detail:
+    get:
+      description: Retrieves run details of an Orchestration instance
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FlowOrchestrationInstanceRepresentation
+      queryParameters:
+        instanceId:
+          type: string
+          required: false
+  /instances:
+    get:
+      description: Retrieves a collection of Orchestration instances
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FlowOrchestrationInstanceCollectionRepresentation
+      queryParameters:
+        contextRecordId:
+          type: string
+          required: false
+        relatedRecordId:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,29 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'InteractionOrchestrator'
+(luvio.ttl): 2592000000
+
+types:
+  FlowOrchestrationInstanceRepresentation:
+    (luvio.ttl): 100
+  FlowOrchestrationInstanceCollectionRepresentation:
+    (luvio.ttl): 100
+
+/connect/interaction/orchestration:
+  /instance/detail:
+    get:
+      (luvio.adapter):
+        name: getOrchestrationInstance
+        oneOfParams:
+          - instanceId
+  /instances:
+    get:
+      (luvio.adapter):
+        name: getOrchestrationInstanceCollection
+        oneOfParams:
+          - relatedRecordId
+          #in 234 add optional params here