@salesforce/lds-adapters-sfap-einstein-copilot-bot 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,369 @@
+#%RAML 1.0
+title: Einstein Bots API
+version: 5.3.0
+baseUri: api.salesforce.com
+types:
+  Status:
+    properties:
+      status:
+        description: Health status of Einstein Bots API.
+        enum:
+          - UP
+          - DOWN
+        type: string
+        required: true
+  Error:
+    properties:
+      status:
+        description: HTTP status.
+        type: number
+        required: true
+      path:
+        description: Request path.
+        type: string
+        required: true
+      requestId:
+        description: Request ID. A UUID in string format to help with request tracking.
+        type: string
+        required: true
+      error:
+        description: Error class name.
+        type: string
+        required: true
+      message:
+        description: Exception message.
+        type: string
+        required: true
+      timestamp:
+        description: Unix timestamp.
+        type: number
+        required: true
+
+  InitMessageEnvelope:
+    type: object
+    additionalProperties: false
+    properties:
+      externalSessionKey: string
+      message?: TextInitMessage
+      forceConfig: ForceConfig
+      responseOptions?: ResponseOptions
+      tz?:
+        example:
+          strict: false
+          value: America/Los_Angeles
+        (nullable): true
+        type: string | nil
+      variables?:
+        type: array
+        items:
+          type: any
+      richContentCapabilities: RichContentCapability
+      referrers?:
+        (nullable): true
+        type: array
+        items:
+          type: Referrer
+  TextInitMessage:
+    type: object
+    additionalProperties: false
+    properties:
+      text?:
+        description: Initial message from the customer to the bot to begin a session.
+        example:
+          strict: false
+          value: Hello
+        type: string
+  ForceConfig:
+    description: API configuration parameters.
+    type: object
+    additionalProperties: true
+    properties:
+      endpoint:
+        description: Instance URL of your Salesforce org. You can find the value in the **ForceConfig Endpoint** field of the **Add Connection** dialog when you add the connected app to the bot (see [Get Started with Einstein Bot API](https://developer.salesforce.com/docs/service/einstein-bot-api/guide/prerequisites.html)).
+        example:
+          strict: false
+          value: https://d5e000009s7bceah-dev-ed.my.salesforce.com/
+        type: string
+        required: true
+  ResponseOptions:
+    description: Configuration of additional information returned in the response payload.
+    type: object
+    additionalProperties: false
+    properties:
+      variables?: ResponseOptionsVariables
+      metrics?:
+        description: Indicates whether to include metrics in the response.
+        type: boolean
+      intents?:
+        description: Indicates whether to include all intents detected when processing the current request.
+        type: boolean
+      entities?:
+        description: Indicates whether to include all entities detected when processing the current request.
+        type: boolean
+  RichContentCapability:
+    type: object
+    properties:
+      messageTypes:
+        type: array
+        items: MessageTypeCapability
+        required: true
+  Referrer:
+    type: object
+    properties:
+      type:
+        description: Referrer type.
+        enum:
+          - Salesforce:Core:Bot:Id
+          - Salesforce:BotRuntime:Session:Id
+        example:
+          strict: false
+          value: Salesforce:Core:Bot:Id
+        type: string
+        required: true
+      value:
+        description: ID of referrer.
+        example:
+          strict: false
+          value: string
+        type: string
+        required: true
+  ResponseEnvelope:
+    type: object
+    additionalProperties: false
+    properties:
+      sessionId: string
+      botVersion: string
+      processedSequenceIds:
+        description: Sequence IDs of messages that the bot processed. Except for the initial request to start the session, all requests require a `sequenceId`.
+        type: array
+        items:
+          example:
+            strict: false
+            value: 1
+          type: number
+        required: true
+      messages:
+        description: Messages from the bot.
+        type: array
+        items:
+          (amf-xone):
+            - InquireResponseMessage
+            - ErrorResponseMessage
+            - ConfirmResponseMessage
+            - InformResponseMessage
+            - TextResponseMessage
+            - ChoicesResponseMessage
+            - EscalateResponseMessage
+            - SessionEndedResponseMessage
+          type: any
+        required: true
+      variables?:
+        type: array
+        items:
+          type: any
+      metrics?:
+        description: Session metrics.
+        type: object
+        additionalProperties: true
+      intents?:
+        type: array
+        items:
+          type: NormalizedIntent
+      entities?:
+        type: array
+        items:
+          type: NormalizedEntity
+      _links: Links
+  NormalizedEntity:
+    type: object
+    additionalProperties: false
+    properties:
+      confidenceScore:
+        description: Probability number that the AI assigns to this entity.
+        example:
+          strict: false
+          value: 0.40
+        type: number
+        required: true
+      value:
+        description: Value of the entity that the customer enters.
+        example:
+          strict: false
+          value: USD 30.0
+        type: string
+        required: true
+      type: string
+      entitySource?: string
+  Links:
+    description: List of Einstein Bots API endpoints for HATEOS compliancy.
+    type: object
+    additionalProperties: false
+    properties:
+      self: HyperLink
+      messages?: HyperLink
+      session?: HyperLink
+      feedback?: HyperLink
+  HyperLink:
+    description: Hyperlink object included in the Links schema
+    type: object
+    properties:
+      href?:
+        description: Link to the endpoint
+        example:
+          strict: false
+          value: https://runtime-api-ap-east.prod.chatbots.sfdc.sh/v5.0.0/sessions
+        type: string
+  NormalizedIntent:
+    type: object
+    additionalProperties: false
+    properties:
+      label:
+        description: Name or ID of the intent.
+        example:
+          strict: false
+          value: Password help
+        type: string
+        required: true
+      confidenceScore:
+        description: Probability number that the AI assigns to this intent.
+        example:
+          strict: false
+          value: 0.78
+        type: number
+        required: true
+      intentSource: string
+  ResponseOptionsVariables:
+    description: Variables returned in the response.
+    type: object
+    additionalProperties: false
+    properties:
+      include:
+        description: Indicates whether to include variables in the response.
+        example:
+          strict: false
+          value: true
+        type: boolean
+        required: true
+      filter?:
+        example:
+          strict: false
+          value:
+            - OrderQty
+            - OrderType
+        type: array
+        items:
+          type: string
+      onlyChanged:
+        description: Indicates whether the response contains only changed variables.
+        example:
+          strict: false
+          value: true
+        type: boolean
+        required: true
+  MessageTypeCapability:
+    type: object
+    properties:
+      messageType: string
+      formatTypes:
+        type: array
+        items: FormatTypeCapability
+        required: true
+  FormatTypeCapability:
+    type: object
+    properties:
+      formatType: string
+/einstein/bots/v1/status:
+  get:
+    displayName: checkHealthStatus
+    description: Returns whether the status of Einstein Bots API is up or down.
+    (amf-summary): Check the health status
+    (amf-tags):
+      - health
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json:
+            type: Status
+      '500':
+        description: Something went wrong
+        body:
+          application/json:
+            type: Error
+/einstein/bots/v1/v5.3.0/bots/{botId}/sessions:
+  post:
+    displayName: startSession
+    description: Send a message to the bots API to start a new session.
+    headers:
+      X-Org-Id:
+        description: 18-character org ID of the Salesforce org associated with the bot.
+        required: true
+        example:
+          strict: false
+          value: 00Dx0000000ALskEAG
+        type: string
+      X-Request-ID:
+        description: Request ID. A UUID in string format created by you to help with request tracking.
+        required: false
+        example:
+          strict: false
+          value: 36a73651-a46d-4d16-9a8a-fd436ed62e1a
+        type: string
+    body:
+      application/json: InitMessageEnvelope
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json:
+            type: ResponseEnvelope
+      '400':
+        description: Bad Request
+        body:
+          application/json:
+            type: Error
+      '401':
+        description: Access bearer token is missing or invalid
+        body:
+          application/json:
+            type: Error
+      '403':
+        description: User forbidden from accessing the resource
+        body:
+          application/json:
+            type: Error
+      '404':
+        description: Resource not found
+        body:
+          application/json:
+            type: Error
+      '422':
+        description: Any exception that occurred during the request execution
+        body:
+          application/json:
+            type: Error
+      '423':
+        description: Server is busy and cannot process the request at this time
+        body:
+          application/json:
+            type: Error
+      '429':
+        description: Too many requests for the server to handle
+        body:
+          application/json:
+            type: Error
+      '503':
+        description: Service is unavailable possibly because Apex or Flow calls timed out
+        body:
+          application/json:
+            type: Error
+      '500':
+        description: Something went wrong
+        body:
+          application/json:
+            type: Error
+  uriParameters:
+    botId:
+      description: ID of the Einstein Bot that you want to interact with.
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,25 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'einstein-copilot-bot'
+
+# Almost no-cache
+(luvio.ttl): 500
+
+types:
+  ResponseEnvelope:
+    (luvio.ttl): 500
+    (luvio.key):
+      id: sessionId
+
+/einstein/bots/v1/status:
+  get:
+    (luvio.adapter):
+      name: getStatus
+/einstein/bots/v1/v5.3.0/bots/{botId}/sessions:
+  post:
+    (luvio.adapter):
+      name: startSession