@salesforce/lds-adapters-platform-slack-bridge 1.329.0

package/src/raml/api.raml

@@ -0,0 +1,778 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v63.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:
+  SlackBridgeContentDocumentOutputRepresentation:
+    description: Contains the details of Content Document
+    type: object
+    properties:
+      filetype:
+        description: File type of the Content Document record
+        type: SlackBridgeFileTypeOutputRepresentation
+      id:
+        description: Id of the Content Document record
+        type: string
+      latestPublishedVersion:
+        description: Document URL for the Content Document record
+        type: SlackBridgeContentVersionOutputRepresentation
+      size:
+        description: Size of the Content Document record
+        type: integer
+      title:
+        description: Title of the Content Document record
+        type: string
+  SlackBridgeContentVersionOutputRepresentation:
+    description: Contains the details of Content Version
+    type: object
+    properties:
+      attachmentUrl:
+        description: Attachment URL for the Content Version record
+        type: string
+      filetype:
+        description: File type of the Content Version record
+        type: SlackBridgeFileTypeOutputRepresentation
+      id:
+        description: Id of the Content Version record
+        type: string
+      size:
+        description: Size of the Content Version record
+        type: integer
+      title:
+        description: Title of the Content Version record
+        type: string
+      versionUrl:
+        description: Version URL for the Content Version record
+        type: string
+  SlackBridgeConversationHistoryOutputRepresentation:
+    description: Contains the details of segment of a Slack conversation's history
+    type: object
+    properties:
+      hasMore:
+        description: Does this conversation have more messages to retrieve?
+        type: boolean
+      messages:
+        description: List of Slack messages
+        type: array
+        items:
+          type: SlackBridgeMessageOutputRepresentation
+      nextCursor:
+        description: Used to paginate to the next page by passing this value as the
+          cursor parameter in a subsequent request
+        type: string | nil
+  SlackBridgeConversationInfoOutputRepresentation:
+    description: Contains the conversation info
+    type: object
+    properties:
+      id:
+        description: Id of the Conversation
+        type: string
+      isArchived:
+        description: Is this conversation archived?
+        type: boolean
+      isChannel:
+        description: Is this a channel?
+        type: boolean
+      isCustomEmojiSupported:
+        description: Is Custom Emoji supported?
+        type: boolean | nil
+      isGroup:
+        description: Is this a group?
+        type: boolean
+      isIm:
+        description: Is this IM?
+        type: boolean
+      isMember:
+        description: Is the context User a member of this Conversation?
+        type: boolean
+      isOpen:
+        description: Is this conversation open?
+        type: boolean
+      isPrivate:
+        description: Is this conversation private?
+        type: boolean
+      isReadOnly:
+        description: Is this conversation read-only?
+        type: boolean
+      isThreadOnly:
+        description: Is this conversation thread-only?
+        type: boolean
+      name:
+        description: Name of the Conversation
+        type: string
+      numOfMembers:
+        description: Number of members in the Conversation
+        type: integer | nil
+      shouldCacheCustomEmoji:
+        description: Should the Custom Emojis be cached?
+        type: boolean | nil
+  SlackBridgeConversationInfosOutputRepresentation:
+    description: Contains the list of Slack Conversation Information
+    type: object
+    properties:
+      conversationInfos:
+        description: List of Slack Conversation Information
+        type: array
+        items:
+          type: SlackBridgeConversationInfoOutputRepresentation
+      searchString:
+        description: String used to search this list of conversations (Optional)
+        type: string
+  SlackBridgeConversationOutputRepresentation:
+    description: Contains the details of a Slack Conversation
+    type: object
+    properties:
+      channelId:
+        description: The id of the Slack channel
+        type: string
+      channelUrl:
+        description: The URL to the Slack channel
+        type: string
+      contextUserInfo:
+        description: The Slack user information of the related context Salesforce
+          User who is viewing this Conversation
+        type: SlackBridgeUserInfoOutputRepresentation | nil
+      conversationInfo:
+        description: The full information describing this conversation
+        type: SlackBridgeConversationInfoOutputRepresentation | nil
+      history:
+        description: A segment of this conversation's message history, either part
+          of the top-level conversation or a single message's thread of replies
+        type: SlackBridgeConversationHistoryOutputRepresentation
+      teamId:
+        description: The id of the Slack team (Workspace or Enterprise Org) where
+          this conversation exists
+        type: string
+      threadTs:
+        description: The timestamp of a single message in the conversation whose threaded
+          replies should be loaded
+        type: string | nil
+      userInfos:
+        description: A list of Slack users that are associated with this Conversation
+        type: array
+        items:
+          type: SlackBridgeUserInfoOutputRepresentation
+  SlackBridgeCustomEmojisOutputRepresentation:
+    description: Contains the Slack Custom emojis
+    type: object
+    properties:
+      customEmojis:
+        description: Custom emojis for the given Team (Slack Workspace)
+        type: object
+        properties:
+          //:
+            type: string
+      teamId:
+        description: Id of the Team (Workspace)
+        type: string
+  SlackBridgeEmojiOutputRepresentation:
+    description: Contains the details of Slack Emoji
+    type: object
+    properties:
+      altText:
+        description: Alt text for the Slack Emoji
+        type: string
+      isCustom:
+        description: Is this a custom Slack Emoji?
+        type: boolean | nil
+      name:
+        description: Name of the Slack Emoji
+        type: string
+      unicode:
+        description: Unicode for the Slack Emoji
+        type: string
+      url:
+        description: Url of the Slack Emoji
+        type: string
+  SlackBridgeEmojisOutputRepresentation:
+    description: Contains the list of Slack Emoji
+    type: object
+    properties:
+      emojis:
+        description: List of Slack Emoji
+        type: array
+        items:
+          type: SlackBridgeEmojiOutputRepresentation
+      searchString:
+        description: String used to search this list of conversations (Optional)
+        type: string
+  SlackBridgeFileInputRepresentation:
+    description: Contains the parameters to upload a file to Slack
+    type: object
+    properties:
+      base64EncodedFileData:
+        description: File contents via `multipart/form-data`. If omitting this parameter,
+          you must submit `content`.
+        type: string
+      channels:
+        description: Comma-separated list of channel names or IDs where the file will
+          be shared.
+        type: array
+        items:
+          type: string
+      fileName:
+        description: Filename of file.
+        type: string
+      fileType:
+        description: A [file type](https://api.slack.com/types/file#file_types) identifier.
+        type: string
+      initialComment:
+        description: Initial comment to add to file.
+        type: string
+      teamId:
+        description: Workspace where the message should be posted
+        type: string
+      threadTs:
+        description: Time stamp of the Parent message (in case of reply)
+        type: string
+      title:
+        description: Title of file.
+        type: string
+  SlackBridgeFileOutputRepresentation:
+    description: Contains the details of files attached to the Slack Message
+    type: object
+    properties:
+      contentDocument:
+        description: Content Document data
+        type: SlackBridgeContentDocumentOutputRepresentation
+      filetype:
+        description: Type of the File
+        type: string
+      id:
+        description: Slack Id of the File
+        type: string
+      mimetype:
+        description: Mime type of the File
+        type: string
+      name:
+        description: Name of the File
+        type: string
+      size:
+        description: Size of the File
+        type: integer
+      slackPermalink:
+        description: Slack Permalink for the File
+        type: string
+      title:
+        description: Title of the File
+        type: string
+      token:
+        description: Token used for the File
+        type: string
+      uniqueKey:
+        description: Unique Key for the File
+        type: string
+      url:
+        description: Slack web URL for the File
+        type: string
+  SlackBridgeFileTypeOutputRepresentation:
+    description: Contains the details of FileType
+    type: object
+    properties:
+      extension:
+        description: Extension of the File
+        type: string
+      iconName:
+        description: Icon Name of the File
+        type: string
+  SlackBridgeMessageFragmentOutputRepresentation:
+    description: Dummy used for RAML generation and LDS consumption
+    type: object
+    properties:
+      channelId:
+        description: The id of the Slack channel
+        type: string
+      messageTs:
+        description: Timestamp of the Message
+        type: string
+      teamId:
+        description: The id of the Slack team (Workspace or Enterprise Org) where
+          this conversation exists
+        type: string
+  SlackBridgeMessageOutputRepresentation:
+    description: Contains the details of Slack Message
+    type: object
+    properties:
+      files:
+        description: List of files attached to this message
+        type: array
+        items:
+          type: SlackBridgeFileOutputRepresentation
+      includesCustomEmoji:
+        description: Does this message includes Custom emoji?
+        type: boolean | nil
+      isBroadcast:
+        description: Is this a reply also sent to the Channel?
+        type: boolean
+      isEditable:
+        description: Can this message be edited?
+        type: boolean
+      isEdited:
+        description: Is this an edited message?
+        type: boolean
+      latestReplyTimestamp:
+        description: Latest Reply timestamp
+        type: string | nil
+      message:
+        description: Content of the Message
+        type: string
+      messageTs:
+        description: Timestamp of the Message
+        type: string
+      reactions:
+        description: List of reactions added to this message
+        type: array
+        items:
+          type: SlackBridgeReactionOutputRepresentation
+      replyCount:
+        description: Number of replies for this message
+        type: integer | nil
+      replyUsers:
+        description: List of Users who replied to this message
+        type: array
+        items:
+          type: string
+      replyUsersCount:
+        description: Number of users who replied to this message
+        type: integer | nil
+      slackUserId:
+        description: Details of the Slack User who posted this message
+        type: string
+      subtype:
+        description: Sub-type of Message
+        type: string | nil
+      threadTs:
+        description: Timestamp of the thread to which this message belong to
+        type: string | nil
+      type:
+        description: Type of Message
+        type: string
+      url:
+        description: Url for this message
+        type: string
+  SlackBridgePostMessageInputRepresentation:
+    description: Contains the parameters to post a message to Slack
+    type: object
+    properties:
+      channelId:
+        description: Channel where the message should be posted
+        type: string
+      linkNames:
+        description: Find and link channel names and usernames using the Slack ID
+        type: boolean
+      replyBroadcast:
+        description: Used in conjunction with `thread_ts` and indicates whether reply
+          should be made visible to everyone in the channel or conversation
+        type: boolean
+      teamId:
+        description: Workspace where the message should be posted
+        type: string
+      text:
+        description: Content of the message
+        type: string
+      threadTs:
+        description: Time stamp of the Parent message (in case of reply)
+        type: string
+  SlackBridgePostMessageOutputRepresentation:
+    description: Contains the details of message posted to Slack
+    type: object
+    properties:
+      channelId:
+        description: Id of the Channel to which this message belong to
+        type: string
+      postedMessage:
+        description: Message posted to Slack
+        type: SlackBridgeMessageOutputRepresentation
+      timestamp:
+        description: Timestamp of the message posted to Slack
+        type: string
+  SlackBridgePostMessageReactionInputRepresentation:
+    description: Contains the parameters to post or delete a reaction on Slack message
+    type: object
+    properties:
+      name:
+        description: Name of the reaction
+        type: string
+  SlackBridgeReactionOutputRepresentation:
+    description: Contains the details of Slack reaction
+    type: object
+    properties:
+      count:
+        description: Number of reactions
+        type: integer
+      name:
+        description: Name of the reaction
+        type: string
+      reactedUsers:
+        description: Slack user ids of users who made this reaction
+        type: array
+        items:
+          type: string
+      url:
+        description: Url for the reaction
+        type: string | nil
+  SlackBridgeReactionsOutputRepresentation:
+    description: Contains the details of Slack reactions for the Slack Message
+    type: object
+    properties:
+      channelId:
+        description: The id of the Slack channel
+        type: string
+      messageTs:
+        description: Timestamp of the Slack message
+        type: string
+      reactions:
+        description: List of reactions
+        type: array
+        items:
+          type: SlackBridgeReactionOutputRepresentation
+      teamId:
+        description: The id of the Slack team (Workspace or Enterprise Org) where
+          this conversation exists
+        type: string
+  SlackBridgeUpdateMessageInputRepresentation:
+    description: Contains the parameters to update a message to Slack
+    type: object
+    properties:
+      text:
+        description: Content of the message
+        type: string
+  SlackBridgeUpdatedMessageOutputRepresentation:
+    description: Contains the details of updated Slack message
+    type: object
+    properties:
+      channelId:
+        description: Id of the Channel to which this message belong to
+        type: string
+      timestamp:
+        description: Timestamp of the message posted to Slack
+        type: string
+      updatedMessage:
+        description: Updated Message from Slack
+        type: SlackBridgeMessageOutputRepresentation
+  SlackBridgeUserInfoOutputRepresentation:
+    description: Contains the details of Slack User
+    type: object
+    properties:
+      bot:
+        description: Is this a Bot User?
+        type: boolean
+      displayName:
+        description: Display Name of the Slack User
+        type: string
+      image24:
+        description: 24x24 version of the Slack User image
+        type: string
+      imageOriginal:
+        description: Original version of the Slack User image
+        type: string | nil
+      inHuddle:
+        description: Is this Slack User currently in a Huddle?
+        type: boolean | nil
+      isActive:
+        description: Is this Slack User currently active?
+        type: boolean | nil
+      isExternal:
+        description: Is Slack User external?
+        type: boolean | nil
+      name:
+        description: Name of the Slack User
+        type: string
+      profileUrl:
+        description: User Profile url
+        type: string | nil
+      realName:
+        description: Real Name of the Slack User
+        type: string
+      salesforceUserId:
+        description: Id of the related Salesforce User mapped to the Slack User
+        type: string | nil
+      slackUserId:
+        description: Id of the Slack User
+        type: string
+      statusEmoji:
+        description: Status emoji of the Slack User
+        type: SlackBridgeEmojiOutputRepresentation | nil
+      statusMessage:
+        description: Status message of the Slack User
+        type: string
+      teamId:
+        description: Slack Workspace Id
+        type: string
+  SlackBridgeUserInfosOutputRepresentation:
+    description: Contains the list of Slack User Information
+    type: object
+    properties:
+      searchString:
+        description: String used to search this list of conversations (Optional)
+        type: string
+      userInfos:
+        description: List of Slack User Information
+        type: array
+        items:
+          type: SlackBridgeUserInfoOutputRepresentation
+/connect/slackbridge:
+  /conversation/messages:
+    get:
+      displayName: getSlackConversation
+      description: Get Slack conversation from the given Workspace and Channel
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgeConversationOutputRepresentation
+      queryParameters:
+        channelId:
+          description: Channel where the conversation exist
+          type: string
+          required: false
+        includeView:
+          description: Include the full view of the conversation.
+          type: boolean
+          required: false
+        inclusive:
+          description: Include messages with latest or oldest timestamp in results.
+            Ignored unless either timestamp is specified.
+          type: boolean
+          required: false
+        latestMessageTs:
+          description: Only messages before this Unix timestamp will be included in
+            results. Default is the current time.
+          type: string
+          required: false
+        limit:
+          description: The maximum number of messages to return. Fewer than the requested
+            number of messages may be returned.
+          type: integer
+          required: false
+        oldestMessageTs:
+          description: Only messages after this Unix timestamp will be included in
+            results. Default is the current time.
+          type: string
+          required: false
+        parentMessageTs:
+          description: Parent Message timestamp (if the message(s) belongs to a thread)
+          type: string
+          required: false
+        relatedRecordId:
+          description: Id of the record to which the Slack Conversation is related.
+          type: string
+          required: false
+        teamId:
+          description: Team or Workspace where the conversation exist
+          type: string
+          required: false
+    post:
+      displayName: postSlackConversation
+      description: Request to create a Slack post
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgePostMessageOutputRepresentation
+      body:
+        application/json:
+          type: SlackBridgePostMessageInputRepresentation
+          (oas-body-name): slackMessagePostRequest
+  /files:
+    post:
+      displayName: postSlackFile
+      description: Request to upload a file to the given Slack Conversation or Thread
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgeFileOutputRepresentation
+      body:
+        application/json:
+          type: SlackBridgeFileInputRepresentation
+          (oas-body-name): slackFileUploadRequest
+  /team/{teamId}:
+    /channel/{channelId}/messages/{messageTs}:
+      delete:
+        displayName: deleteSlackMessage
+        description: Request to delete a Slack post
+        responses:
+          '200':
+            description: Success
+      get:
+        displayName: getSlackMessage
+        description: Get Slack message from the given Channel
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeMessageFragmentOutputRepresentation
+      patch:
+        displayName: patchSlackMessage
+        description: Request to update a Slack post
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeMessageFragmentOutputRepresentation
+        body:
+          application/json:
+            type: SlackBridgeUpdateMessageInputRepresentation
+            (oas-body-name): slackMessageUpdateRequest
+      uriParameters:
+        channelId:
+          description: Id of the Slack channel where the message exists
+          type: string
+          required: true
+        messageTs:
+          description: The timestamp of the Slack message
+          type: string
+          required: true
+        teamId:
+          description: Id of the Slack team where the conversation exists
+          type: string
+          required: true
+    /channel/{channelId}/messages/{messageTs}/reactions:
+      delete:
+        displayName: deleteSlackMessageReactions
+        description: Request to delete a reaction on Slack message
+        responses:
+          '200':
+            description: Success
+        queryParameters:
+          name:
+            description: The name of the reaction to delete
+            type: string
+            required: false
+      get:
+        displayName: getSlackMessageReactions
+        description: Request to get a reaction on a Slack message
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeReactionsOutputRepresentation
+      post:
+        displayName: postSlackMessageReactions
+        description: Request to post a reaction on Slack message
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeReactionsOutputRepresentation
+        queryParameters:
+          name:
+            description: The name of the reaction to delete
+            type: string
+            required: false
+      uriParameters:
+        channelId:
+          description: Id of the Slack channel where the message exists
+          type: string
+          required: true
+        messageTs:
+          description: The timestamp of the Slack message
+          type: string
+          required: true
+        teamId:
+          description: Id of the Slack team where the conversation exists
+          type: string
+          required: true
+    /emojis:
+      get:
+        displayName: getSlackCustomEmoji
+        description: Get Slack Custom Emojis
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeCustomEmojisOutputRepresentation
+      uriParameters:
+        teamId:
+          description: Team or Workspace
+          type: string
+          required: true
+    /search:
+      /emojis:
+        get:
+          displayName: getSlackSearchEmoji
+          description: Search Slack Emoji
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeEmojisOutputRepresentation
+          queryParameters:
+            search:
+              description: Search String
+              type: string
+              required: false
+        uriParameters:
+          teamId:
+            description: Team or Workspace
+            type: string
+            required: true
+      /users:
+        get:
+          displayName: getSlackSearchUser
+          description: Search Slack User
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeUserInfosOutputRepresentation
+          queryParameters:
+            search:
+              description: Search String
+              type: string
+              required: false
+        uriParameters:
+          teamId:
+            description: Team or Workspace
+            type: string
+            required: true
+    /user/{slackUserId}:
+      get:
+        displayName: getSlackUser
+        description: Get Slack User
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackBridgeUserInfoOutputRepresentation
+      uriParameters:
+        slackUserId:
+          type: string
+          required: true
+        teamId:
+          type: string
+          required: true