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

package/src/raml/api.raml

@@ -0,0 +1,873 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  CollectMessageRepresentation:
+    description: Represents a collect message
+    type: object
+    properties:
+      data:
+        description: Data for the collect message.
+        type: EsTypeMessageRepresentation
+        required: false
+      targetProperty:
+        description: Target property for the collect message.
+        type: string | nil
+        required: false
+      targetType:
+        description: Target type for the collect message.
+        type: string
+  ConversationRuntimeProxyChoiceRepresentation:
+    description: Represents a choice from the bot
+    type: object
+    properties:
+      alias:
+        description: Alias to be used if menu/button ui elements cannot be used.
+        type: string
+      label:
+        description: Label for the choice menu/button text.
+        type: string
+  ConversationRuntimeProxyInputRepresentation:
+    description: Bot conversation input
+    type: object
+    properties:
+      inReplyToMessageId:
+        description: Message ID that this message is replying to
+        type: string
+        required: false
+      intent:
+        description: Intent
+        type: string
+        required: false
+      messageType:
+        description: Message type
+        type: string
+        required: false
+        enum:
+          - Reply
+      planId:
+        description: PlanId
+        type: string
+        required: false
+      planTemplateVariables:
+        description: Additional Plan Templates Variables
+        type: any
+        required: false
+      reply:
+        description: Reply
+        type: array
+        required: false
+        items:
+          type: EsTypeMessageRepresentation
+      text:
+        description: Text
+        type: string
+        required: false
+      type:
+        description: Type
+        type: string
+        required: false
+        enum:
+          - Cancel
+          - EsMessage
+          - PlanTemplate
+          - SetVariables
+          - Text
+      variables:
+        description: Variables
+        type: array
+        required: false
+        items:
+          type: VariableRepresentation
+      userUtterance:
+        description: UserUtterance
+        type: string
+        required: false
+  ConversationRuntimeProxyMessageRepresentation:
+    description: Represents a message from the bot
+    type: object
+    properties:
+      choices:
+        description: The choices for this message, if applicable for the type.
+        type: array
+        required: false
+        items:
+          type: ConversationRuntimeProxyChoiceRepresentation
+      collect:
+        description: The collect response for an Inquire message.
+        type: array
+        required: false
+        items:
+          type: CollectMessageRepresentation
+      confirm:
+        description: The confirm response for a Confirm message.
+        type: array
+        required: false
+        items:
+          type: EsTypeMessageRepresentation
+      errors:
+        description: The errors for a Failure message.
+        type: array
+        required: false
+        items:
+          type: string
+      failureCode:
+        description: The failure code for a Failure message.
+        type: string | nil
+        required: false
+      feedbackId:
+        description: Feedback ID for this generated message.
+        type: string | nil
+        required: false
+      id:
+        description: Unique id of this message
+        type: string
+      message:
+        description: The message for an ES Type message.
+        type: string | nil
+        required: false
+      messageType:
+        description: The message type for an ES Type message.
+        type: string | nil
+        required: false
+      planId:
+        description: Plan ID for the generated plan.
+        type: string | nil
+        required: false
+      result:
+        description: The result response for an Inform message.
+        type: array
+        required: false
+        items:
+          type: EsTypeMessageRepresentation
+      text:
+        description: The message text, if applicable for the type.
+        type: string | nil
+        required: false
+      type:
+        description: Type of the message
+        type: string
+        required: false
+        enum:
+          - Choices
+          - EsType
+          - Escalate
+          - MessageDefinition
+          - SessionEnded
+          - Text
+      widget:
+        description: Which widget, if the type is a choice.
+        type: string | nil
+        required: false
+        enum:
+          - Buttons
+          - Menu
+      isContentSafe:
+        description: Flag to indicate if content is safe
+        type: boolean
+        required: false
+  ConversationRuntimeProxyRepresentation:
+    description: Represents the results of a conversation runtime proxy message request
+    type: object
+    properties:
+      botId:
+        description: BotId of the bot the runtime is using for this conversation.
+        type: string
+      botVersion:
+        description: BotVersion id of the bot version the runtime is using for this
+          conversation.
+        type: string
+      messages:
+        description: Messages returned by the bot for this request.
+        type: array
+        items:
+          type: ConversationRuntimeProxyMessageRepresentation
+      processedSequenceIds:
+        description: SequenceIds that were processed in this transaction.
+        type: array
+        items:
+          type: string
+      requestId:
+        description: Request ID for this request.
+        type: string
+      sessionId:
+        description: SessionId to be used in future messages sent to the runtime engine.
+          Allows continuing a conversation.
+        type: string
+  CopilotBotInfoRepresentation:
+    description: Represents the results of a get internal copilot bot id request
+    type: object
+    properties:
+      botId:
+        description: ID of the internal Copilot bot ID - used in the URL when starting agent sessions
+        type: string
+        required: false
+      tenantGuid:
+        description: Core C2C tenant GUID - pass through x-sfdc-tenant-id header for SFAP
+        type: string
+        required: false
+      targetRegion:
+        description: Target runtime region - pass through x-salesforce-region header for SFAP
+        type: string
+        required: false
+      apiEndpoint:
+        description: Target runtime API endpoint - send traffic here. can be a targeted MESH endpoint, or an SFAP URL
+        type: string
+        required: false
+      errorMessage:
+        description: Error message for the failed get operation.
+        type: string
+        required: false
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+  CopilotFollowUpActionsRepresentation:
+    description: Copilot FollowUp Actions resource output
+    type: object
+    properties:
+      actions:
+        description: list of actions. position in this list matches position of query in input FollowUpActionsListInputRepresentation. nil unless isSuccess = true.
+        type: array
+        items: FollowUpActionsRepresentation
+      isSuccess:
+        type: boolean
+        description: indicates success or failure
+      errorMessage:
+        type: string
+        required: false
+        description: optional error message. present only if isSuccess = false.
+  CopilotLLMFeedbackInputRepresentation:
+    description: Copilot LLM feedback input
+    type: object
+    properties:
+      details:
+        description: details
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-886340
+      feedback:
+        description: Structured feedback enum, thumbs up/down, good/bad
+        type: string
+        enum:
+          - Bad
+          - Good
+      feedbackId:
+        description: Feedback ID
+        type: string
+      sessionId:
+        description: Session ID
+        type: string
+      text:
+        description: User provided long-form feedback
+        type: string
+  CopilotLLMFeedbackOutputRepresentation:
+    description: CopilotLLMFeedback
+    type: object
+    properties:
+      submitFeedbackStatus:
+        description: Bot Runtime feedback response
+        type: string
+  CopilotObjectInfoRepresentation:
+    description: Object information, includes object api name and label
+    type: object
+    properties:
+      apiName:
+        description: The object API name
+        type: string
+      label:
+        description: The object label
+        type: string
+  CopilotObjectListRepresentation:
+    description: List of objects that can be used within UI API end-points
+    type: object
+    properties:
+      objects:
+        description: List of objects
+        type: array
+        items:
+          type: CopilotObjectInfoRepresentation
+  CopilotQuickActionRepresentation:
+    description: Represents a Copilot QuickAction which can be executed by a Copilot client.
+    type: object
+    properties:
+      type:
+        description: Type of Copilot QuickAction.
+        type: string
+        required: false
+      label:
+        description: Label to display when rendering Copilot QuickAction.
+        type: string
+        required: false
+      icon:
+        description: Icon name for the Recommended Action to be used by the client when rendering the QuickAction in the UI.
+        type: string
+        required: false
+      description:
+        description: Description of Copilot QuickAction.
+        type: string
+        required: false
+      planTemplateId:
+        description: Plan TemplateId associated to the Copilot QuickAction.
+        type: string
+        required: false
+      intent:
+        description: Intent associated to the Copilot QuickAction which is used by the planner.
+        type: string
+        required: false
+      userUtterance:
+        description: User utterance to be recorded in conversation history by Planner when executing this Copilot Quick Action.
+        type: string
+        required: false
+      actionApiName:
+        description: Api name of Copilot QuickAction.
+        type: string
+        required: false
+      createdDate:
+        description: Creation date of Copilot QuickAction.
+        type: string
+        required: false
+      lastModifiedDate:
+        description: Last Modified date of Copilot QuickAction
+        type: string
+        required: false
+      isGlobal:
+        description: Is the copilot QuickAction global or not.
+        type: boolean
+        required: false
+      planTemplateInput:
+        description: Input Variables for executing this plan template.
+        type: object
+        required: false
+        properties:
+          //:
+            type: string
+      isStandard:
+        description: Is the Copilot QuickAction a standard Action.
+        type: boolean
+        required: false
+      orgAccess:
+        description: Level of Org access required for this QuickAction to be visible for the org.
+        type: string
+        required: false
+      namespace:
+        description: Namespace of the Copilot QuickAction
+        type: string
+        required: false
+  FollowUpActionsRepresentation:
+    description: basic output item type of /connect/follow-up-actions endpoint
+    type: object
+    properties:
+      descriptor:
+        type: string
+        required: false
+      actions:
+        type: any
+      blockRenderers:
+        type: any
+  FollowUpActionsListInputRepresentation:
+    description: top-level input type to FollowUp Actions endpoint
+    type: object
+    properties:
+      language:
+        required: false
+        type: string
+        description: human language to localize to
+      followUpActionsInputs:
+        required: true
+        type: array
+        items: FollowUpActionsInputRepresentation
+        description: list of queries for actions
+  FollowUpActionsInputRepresentation:
+    description: a query to EM getType for follow-up actions
+    type: object
+    properties:
+      descriptor:
+        type: string
+        required: true
+        description: query descriptor for EM getType call
+      sourceDescriptor:
+        type: FollowUpActionsSourceDescriptorRepresentation
+        required: false
+        description: similar to ExperienceModelSourceDescriptorRepresentation
+      schemaConfig:
+        type: FollowUpActionsSchemaConfigRepresentation
+        required: false
+        description: similar to ExperienceModelSchemaConfigRepresentation
+      designConfig:
+        type: FollowUpActionsDesignConfigRepresentation
+        required: false
+        description: mutually exclusive with renditionConfig. only one can be present and one or the other must be present. similar to ExperienceModelDesignConfigRepresentation.
+      renditionConfig:
+        type: FollowUpActionsRenditionConfigRepresentation
+        required: false
+        description: mutually exclusive with designConfig. only one can be present and one or the other must be present. similar to ExperienceModelRenditionConfigRepresentation.
+  FollowUpActionsFilterConfigRepresentation:
+    description: similar to ExperienceModelFilterConfigRepresentation.
+    type: object
+    properties:
+      propertyNames:
+        type: array
+        required: false
+        items: string
+        description: list of fields
+  FollowUpActionsSchemaConfigRepresentation:
+    description: similar to ExperienceModelSchemaConfig
+    type: object
+    properties:
+      subSchemaDefinitions:
+        type: boolean
+        required: false
+        description: whether to include sub-schema definitions or not
+      filterConfig:
+        type: FollowUpActionsFilterConfigRepresentation
+        required: false
+  FollowUpActionsSourceDescriptorRepresentation:
+    description: similar to ExperienceModelSourceDescriptorRepresentation
+    type: object
+    properties:
+      descriptor:
+        type: string
+        required: false
+      propertyName:
+        type: string
+        required: false
+  FollowUpActionsDesignConfigRepresentation:
+    description: similar to ExperienceModelDesignConfigRendition
+    type: object
+    properties:
+      target:
+        type: string
+        required: false
+      subViewDefinitions:
+        type: boolean
+        required: false
+  FollowUpActionsRenditionConfigRepresentation:
+    description: similar to ExperienceModelRenditiionConfigRendition
+    type: object
+    properties:
+      target:
+        type: string
+        required: false
+      subViewDefinitions:
+        type: boolean
+        required: false
+  RecommendedActionsRepresentation:
+    description: Represents the result of a get recommended actions request.
+    type: object
+    properties:
+      copilotQuickActions:
+        description: Recommended copilot Quick Actions.
+        type: array
+        items:
+          type: CopilotQuickActionRepresentation
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      errorMessage:
+        description: Error message for the failed get operation
+        type: string
+        required: false
+  RecommendedUtterancesRepresentation:
+    description: Represents the result of a get recommended utterances request.
+    type: object
+    properties:
+      utterances:
+        description: Recommended utterances.
+        type: array
+        items:
+          type: string
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      errorMessage:
+        description: Error message for the failed get operation
+        type: string
+        required: false
+  WelcomeTopicSuggestedUtterancesRepresentation:
+    description: A single topic and utterances suggested for that topic.
+    properties:
+      topicApiName:
+        type: string
+        description: The API Name of the Topic
+      utterances:
+        type: array
+        items:
+          type: string
+  WelcomeUtterancesRepresentation:
+    description: Represents the result of a get welcome-utterances request.
+    type: object
+    properties:
+      topicsAndSuggestedUtterances:
+        description: List of topics and their corresponding suggested utterances.
+        type: array
+        items:
+          type: WelcomeTopicSuggestedUtterancesRepresentation
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      errorMessage:
+        description: Error message for the failed get operation
+        type: string
+        required: false
+  EsTypeMessageRepresentation:
+    description: Represents a ES type message
+    type: object
+    properties:
+      property:
+        description: Property for the ES type message.
+        type: string | nil
+        required: false
+      type:
+        description: Type for the ES type message.
+        type: string
+      value:
+        description: Value for the ES type message.
+        type: any
+  VariableRepresentation:
+    description: Represents a single variable for an operation to set variables
+    type: object
+    properties:
+      name:
+        description: Name of the variable
+        type: string
+      type:
+        description: Type of the variable
+        type: string
+      value:
+        description: Value of the variable
+        type: any
+        required: false
+  PlanTemplateRepresentation:
+    description: Represents a plan template which can be executed by a Copilot client.
+    type: object
+    properties:
+      intent:
+        description: Intent used by Planner when executing this plan template.
+        type: string
+      label:
+        description: Label to display when rendering this plan template in a Copilot
+          client.
+        type: string
+      planTemplateId:
+        description: ID of a plan template.
+        type: string
+      userUtterance:
+        description: User utterance to be recorded in conversation history by Planner
+          when executing this plan template.
+        type: string
+      variables:
+        description: Variables for executing this plan template.
+        type: object
+        properties:
+          //:
+            type: string
+  RecommendedPlanTemplatesRepresentation:
+    description: Represents the result of a get recommended plan templates request.
+    type: object
+    properties:
+      errorMessage:
+        description: Error message for the failed get operation.
+        type: string
+        required: false
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      planTemplates:
+        description: Recommended plan templates.
+        type: array
+        items:
+          type: PlanTemplateRepresentation
+  AgentforceAgentBotInfoRepresentation:
+    description: User defined Agent metadata per agent type
+    type: object
+    properties:
+      errorMessage:
+        description: Error message for the failed get operation.
+        type: string
+        required: false
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      botId:
+        description: ID of the internal Copilot bot ID - used in the URL when starting agent sessions
+        type: string
+        required: false
+      label:
+        description: display label of the agent
+        type: string
+        required: false
+      description:
+        description: display description of the agent
+        type: string
+        required: false
+      agentType:
+        description: internal agent type api name
+        type: string
+        required: false
+      isDefault:
+        description: Indicates weather the Agent is default
+        type: boolean
+        required: false
+      stopRecPrompts:
+        description: Indicates whether the Agent will show Recommended prompts
+        type: boolean
+        required: false
+      stopWelcomePrompts:
+        description: Indicates whether the Agent will show Welcome prompts
+        type: boolean
+        required: false
+  AgentforceAgentBotInfoListRepresentation:
+    description: Represents the resultant list with agents per agent type including bot metadata
+    type: object
+    properties:
+      tenantGuid:
+        description: Core C2C tenant GUID - pass through x-sfdc-tenant-id header for SFAP
+        type: string
+        required: false
+      targetRegion:
+        description: Target runtime region - pass through x-salesforce-region header for SFAP
+        type: string
+        required: false
+      apiEndpoint:
+        description: Target runtime API endpoint - send traffic here. can be a targeted MESH endpoint, or an SFAP URL
+        type: string
+        required: false
+      errorMessage:
+        description: Error message for the failed get operation.
+        type: string
+        required: false
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+        required: true
+      falconInstance:
+        description: Indicates the falcon instance region code
+        type: string
+        required: false
+      sfapUrl:
+        description: Indicates the SFAP Url
+        type: string
+        required: false
+      agents:
+        description: List of agents
+        type: array
+        items:
+          type: AgentforceAgentBotInfoRepresentation
+
+/connect:
+  /conversation-runtime-proxy:
+    get:
+      displayName: getBotId
+      description: Get internal Copilot bot ID.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CopilotBotInfoRepresentation
+      queryParameters:
+        agentType:
+          description: agent type of the bot
+          type: string
+          required: false
+    post:
+      displayName: sendMessage
+      description: Send messages to the chatbot runtime.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConversationRuntimeProxyRepresentation
+      queryParameters:
+        botId:
+          type: string
+          required: false
+        botVersionId:
+          type: string
+          required: false
+        message:
+          type: string
+          required: false
+        sessionId:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: ConversationRuntimeProxyInputRepresentation
+          (oas-body-name): postBody
+  /recommended-plan-templates/{pageType}/{objectType}:
+    get:
+      displayName: getRecommendedPlanTemplates
+      description: Gets a list of recommended plan templates based on the page/app
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecommendedPlanTemplatesRepresentation
+    uriParameters:
+      pageType:
+        type: string
+        required: true
+      objectType:
+        type: string
+        required: true
+  /copilot:
+    /feedback:
+      post:
+        displayName: postConversationLLMFeedback
+        description: Submit feedback to the chatbot runtime.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CopilotLLMFeedbackOutputRepresentation
+        body:
+          application/json:
+            type: CopilotLLMFeedbackInputRepresentation
+            (oas-body-name): submitFeedback
+    /objects:
+      get:
+        displayName: getCopilotObjects
+        description: Provides the list of ui-api objects to be used in record picker
+          in copilot
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CopilotObjectListRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          searchTerm:
+            type: string
+            required: false
+  /follow-up-actions:
+    post:
+      displayName: getFollowUpActions
+      description: Provides a list of FollowUp Actions based on the EM getType() calls for criteria passed in.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CopilotFollowUpActionsRepresentation
+      body:
+        application/json:
+          type: FollowUpActionsListInputRepresentation
+          (oas-body-name): postBody
+  /recommended-utterances:
+    get:
+      displayName: getRecommendedUtterances
+      description: Provide a list of recommended utterances based on the criteria passed in.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecommendedUtterancesRepresentation
+      queryParameters:
+        agentId:
+          type: string
+          required: false
+        sessionId:
+          type: string
+          required: true
+  /recommended-actions:
+    get:
+      displayName: getRecommendedActions
+      description: Provides a list of recommended actions based on the criteria passed in.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecommendedActionsRepresentation
+      queryParameters:
+        agentId:
+          type: string
+          required: false
+        pageName:
+          type: string
+          required: false
+        pageType:
+          type: string
+          required: true
+        actionName:
+          type: string
+          required: false
+        objectApiName:
+          type: string
+          required: false
+        customApplicationName:
+          type: string
+          required: true
+        sessionId:
+          type: string
+          required: true
+        formFactor:
+          type: string
+          required: true
+          enum:
+            - Large
+            - Medium
+            - Small
+  /welcome-utterances:
+    get:
+      displayName: getWelcomeUtterances
+      description: Provides a list of recommended utterances for users to try out copilot capabilities from the welcome screen.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: WelcomeUtterancesRepresentation
+      queryParameters:
+        sessionId:
+          type: string
+          required: false
+  /agentforce-agent-info:
+    get:
+      displayName: getAgents
+      description: Provides a list of Agentforce agents using the given list of agent types.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AgentforceAgentBotInfoListRepresentation
+      queryParameters:
+        agentType:
+          type: string
+          required: true
+        appName:
+          type: string
+          required: false