@salesforce/lds-adapters-industries-integration-orchestrator 1.284.0

package/src/raml/api.raml

@@ -0,0 +1,157 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v61.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:
+  AdditionalPropertiesRepresentation:
+    description: Output representation of the Additional Properties.
+    type: object
+    properties:
+      flexCardName:
+        description: Name of the flexcard defined in the Integration Definition setup
+          record.
+        type: string
+      manual:
+        description: Type of integration (manual or not). Fetched from Integration
+          Definition setup record.
+        type: boolean
+      sync:
+        description: Type of integration (sync or async). Fetched from Integration
+          Definition setup record.
+        type: boolean
+  FulfillmentContextsOutputRepresentation:
+    description: Output representation of the FulfillmentContexts connect api
+    type: object
+    properties:
+      fulfillmentContexts:
+        description: Contains list of contexts.
+        type: array
+        items:
+          type: FulfillmentContextsRepresentation
+  FulfillmentContextsRepresentation:
+    description: Output representation of the FulfillmentContexts.
+    type: object
+    properties:
+      id:
+        description: Id of the context record.
+        type: string
+      name:
+        description: Name of the context record.
+        type: string
+      objectApiName:
+        description: Object api name of the context record.
+        type: string
+  FulfillmentStepsOutputRepresentation:
+    description: Output representation of the FulfillmentSteps connect api
+    type: object
+    properties:
+      completedCount:
+        description: Count of fulfillmentSteps which have completed.
+        type: integer
+      failedCount:
+        description: Count of fulfillmentSteps which have failed.
+        type: integer
+      fatallyFailedCount:
+        description: Count of fulfillmentSteps which have fatally failed.
+        type: integer
+      fulfillmentSteps:
+        description: Contains list of Fulfillment Steps with additional properties.
+        type: array
+        items:
+          type: FulfillmentStepsRepresentation
+      inProgressCount:
+        description: Count of fulfillmentSteps which are in progress.
+        type: integer
+      pendingCount:
+        description: Count of fulfillmentSteps which are in pending state.
+        type: integer
+      readyCount:
+        description: Count of fulfillmentSteps which are in ready state.
+        type: integer
+      skippedCount:
+        description: Count of fulfillmentSteps which have been skipped.
+        type: integer
+      totalCount:
+        description: Total count of fulfillmentSteps.
+        type: integer
+  FulfillmentStepsRepresentation:
+    description: Output representation of the Fulfillment Steps.
+    type: object
+    properties:
+      additionalProperties:
+        description: Contains some additional properties.
+        type: AdditionalPropertiesRepresentation
+      id:
+        description: Id of the fulfillmentStep record.
+        type: string
+      lastModifiedDate:
+        description: LastModifiedDate of the fulfillmentStep record.
+        type: string
+      name:
+        description: Name of the fulfillmentStep record.
+        type: string
+      state:
+        description: State of the fulfillmentStep record.
+        type: string
+/connect:
+  /fulfillmentContexts/{recordId}:
+    get:
+      displayName: getFulfillmentContexts
+      description: Fetch Fulfillment Contexts
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FulfillmentContextsOutputRepresentation
+    uriParameters:
+      recordId:
+        description: Record Id.
+        type: string
+        required: true
+  /fulfillmentSteps/{recordId}:
+    get:
+      displayName: getFulfillmentSteps
+      description: Fetch Fulfillment Steps
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FulfillmentStepsOutputRepresentation
+      queryParameters:
+        contextId:
+          description: Context Id.
+          type: string
+          required: false
+        stepType:
+          description: Step Type of the Fulfillment Step.
+          type: string
+          required: false
+    uriParameters:
+      recordId:
+        description: Record Id.
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,26 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'integration-orchestrator-connect-api'
+
+types:
+  FulfillmentStepsOutputRepresentation:
+    (luvio.ttl): 10000
+    (luvio.opaque): true
+
+  FulfillmentContextsOutputRepresentation:
+    (luvio.ttl): 10000
+    (luvio.opaque): true
+
+/connect:
+  /fulfillmentContexts/{recordId}:
+    get:
+      (luvio.adapter):
+        name: fulfillmentContexts
+  /fulfillmentSteps/{recordId}:
+    get:
+      (luvio.adapter):
+        name: fulfillmentSteps