@salesforce/lds-adapters-cms-orchestrator 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,261 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  ManagedContentOrchestrationDefinitionCollectionRepresentation:
+    description: Managed content orchestration definition collection representation.
+    type: object
+    properties:
+      currentPageUri:
+        description: Uri to the current page of Managed content orchestration definitions.
+        type: string
+      nextPageUri:
+        description: Uri to the next page of Managed content orchestration definitions.
+        type: string | nil
+      orchestrationDefinitions:
+        description: Managed content orchestration definitions.
+        type: array
+        items:
+          type: ManagedContentOrchestrationDefinitionRepresentation
+      previousPageUri:
+        description: Uri to the previous page of Managed content orchestration definitions.
+        type: string | nil
+      totalDefinitions:
+        description: Total number of Managed content orchestration definitions.
+        type: integer
+  ManagedContentOrchestrationDefinitionRepresentation:
+    description: Managed content orchestration definition representation.
+    type: object
+    properties:
+      definitionId:
+        description: Managed content orchestration definition ID.
+        type: string
+      description:
+        description: Managed content orchestration description.
+        type: string | nil
+      developerName:
+        description: Managed content orchestration developer name.
+        type: string
+      label:
+        description: Managed content orchestration label.
+        type: string
+      versionId:
+        description: Managed content orchestration version ID.
+        type: string
+  ManagedContentOrchestrationInstanceCollectionRepresentation:
+    description: Managed content orchestration instance collection representation.
+    type: object
+    properties:
+      orchestrationInstances:
+        description: Managed content orchestration instances.
+        type: array
+        items:
+          type: ManagedContentOrchestrationInstanceRepresentation
+  ManagedContentOrchestrationInstanceInputRepresentation:
+    description: Input representation for Managed Content Orchestration Instance.
+    type: object
+    properties:
+      managedContentVariantId:
+        description: Managed Content Variant Id.
+        type: string
+      orchestrationDefinitionDeveloperName:
+        description: Orchestration Definition Developer name.
+        type: string
+  ManagedContentOrchestrationInstanceRepresentation:
+    description: Managed content orchestration instance representation.
+    type: object
+    properties:
+      managedContentOrchestrationInstanceId:
+        description: Managed content orchestration instance ID.
+        type: string
+      managedContentVariantId:
+        description: Managed Content Variant ID.
+        type: string
+      orchestrationDefinition:
+        description: Managed content orchestration definition.
+        type: ManagedContentOrchestrationDefinitionRepresentation
+      orchestrationInstanceId:
+        description: Flow orchestration instance ID.
+        type: string
+  ManagedContentOrchestrationInstanceInputWrapperRepresentation: # TODO Hand-rolled W-8334626
+    description: Wrapper around input representation for Managed Content Orchestration Instance.
+    type: object
+    properties:
+      mContentOrchInstanceInput:
+        type: ManagedContentOrchestrationInstanceInputRepresentation
+  ManagedContentRunningOrchestrationHistoryEventCollectionRepresentation:
+    description: Managed content running orchestration history event collection representation.
+    type: object
+    properties:
+      historyEvents:
+        description: Managed content running orchestration history events
+        type: array
+        items:
+          type: ManagedContentRunningOrchestrationHistoryEventRepresentation
+  ManagedContentRunningOrchestrationHistoryEventRepresentation:
+    description: Managed content running orchestration history event representation.
+    type: object
+    properties:
+      actorEmail:
+        description: Actor Email
+        type: string | nil
+      actorName:
+        description: Actor Name
+        type: string | nil
+      assigneeDevNameOrEmail:
+        description: Assignee Dev Name or Email
+        type: string | nil
+      assigneeName:
+        description: Assignee Name
+        type: string | nil
+      assigneeType:
+        description: Assignee Type
+        type: string | nil
+        enum:
+          - CmsRole
+          - Group
+          - Queue
+          - User
+      comments:
+        description: Comments
+        type: string | nil
+      endTimestamp:
+        description: End Timestamp
+        type: string | nil
+      orchestrationName:
+        description: Orchestration Name
+        type: string
+      orchestrationVersion:
+        description: Orchestration Version
+        type: integer
+      stageDevName:
+        description: Stage Dev Name
+        type: string
+      stageLabel:
+        description: Stage Label
+        type: string
+      startTimestamp:
+        description: Start Timestamp
+        type: string
+      status:
+        description: Status
+        type: string
+        enum:
+          - Canceled
+          - Completed
+          - Failed
+          - InProgress
+      stepDevName:
+        description: Step Dev Name
+        type: string
+      stepLabel:
+        description: Step Label
+        type: string
+
+/connect:
+  /cms:
+    /contents:
+      /orchestration-definitions:
+        get:
+          description: Gets a collection of managed content orchestration definitions
+            compatible with the provided variant ID.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentOrchestrationDefinitionCollectionRepresentation
+          queryParameters:
+            managedContentVariantId:
+              type: string
+              required: false
+            page:
+              type: integer
+              required: false
+            pageSize:
+              type: integer
+              required: false
+      /orchestration-instances:
+        get:
+          description: Gets a collection of managed content orchestration instances
+            related to the specified variant.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentOrchestrationInstanceCollectionRepresentation
+          queryParameters:
+            managedContentVariantId:
+              type: string
+              required: false
+        post:
+          description: Creates a managed content orchestration instance for the
+            specified variant.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentOrchestrationInstanceRepresentation
+          body:
+            application/json:
+              type: ManagedContentOrchestrationInstanceInputWrapperRepresentation # TODO Hand-rolled W-8334626
+              #required: false # TODO hand rolled. W-10780573
+              (oas-body-name): mContentOrchInstanceInput
+      /orchestration-instances/{mContentOrchInstanceId}:
+        # TODO: hand rolled. W-13030581
+        get:
+          description: Gets a managed content orchestration instance related to the specified variant.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentOrchestrationInstanceRepresentation
+        delete:
+          description: Cancel a running managed content orchestration
+          responses:
+            '200':
+              description: Success
+        uriParameters:
+          mContentOrchInstanceId:
+            type: string
+            required: true
+      /orchestration-history-events:
+        get:
+          description: Gets a collection of the history of the managed content orchestration
+            running on the specified variant.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentRunningOrchestrationHistoryEventCollectionRepresentation
+          queryParameters:
+            managedContentVariantId:
+              type: string
+              required: false

package/src/raml/luvio.raml

@@ -0,0 +1,52 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CMSOrchestrator'
+
+types:
+  ManagedContentOrchestrationDefinitionCollectionRepresentation:
+    (luvio.ttl): 3600000
+  ManagedContentOrchestrationDefinitionRepresentation:
+    (luvio.ttl): 3600000
+    (luvio.key):
+      id: developerName
+  ManagedContentOrchestrationInstanceCollectionRepresentation:
+    (luvio.ttl): 100
+  ManagedContentOrchestrationInstanceRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: managedContentVariantId
+  ManagedContentRunningOrchestrationHistoryEventCollectionRepresentation:
+    (luvio.ttl): 100
+  ManagedContentRunningOrchestrationHistoryEventRepresentation:
+    (luvio.ttl): 1000
+
+/connect/cms/contents/orchestration-instances:
+  get:
+    (luvio.adapter):
+      name: getManagedContentOrchestrationInstances
+  post:
+    (luvio.adapter):
+      name: createManagedContentOrchestrationInstance
+/connect/cms/contents/orchestration-instances/{mContentOrchInstanceId}:
+  get:
+    (luvio.adapter):
+      name: getManagedContentOrchestrationInstance
+    (luvio.key):
+      id: urlParams.mContentOrchInstanceId
+  delete:
+    (luvio.adapter):
+      name: deleteManagedContentCancelOrchestrationInstance
+    (luvio.key):
+      id: urlParams.mContentOrchInstanceId
+/connect/cms/contents/orchestration-definitions:
+  get:
+    (luvio.adapter):
+      name: getManagedContentOrchestrationDefinitions
+/connect/cms/contents/orchestration-history-events:
+  get:
+    (luvio.adapter):
+      name: getManagedContentRunningOrchestrationHistoryEvents