@salesforce/lds-adapters-service-slack 1.291.0

package/src/raml/api.raml

@@ -0,0 +1,731 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.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:
+  EmptyRepresentation: # copied from lds-adapters-service-knowledege
+    description: Represents empty response
+    type: object
+    properties:
+      fakeKey: string
+  ContentDocumentOutputRepresentation:
+    description: Contains the details of Content Document
+    type: object
+    properties:
+      filetype:
+        description: File type of the Content Document record
+        type: FileTypeOutputRepresentation
+      id:
+        description: Id of the Content Document record
+        type: string
+      latestPublishedVersion:
+        description: Document URL for the Content Document record
+        type: ContentVersionOutputRepresentation
+      size:
+        description: Size of the Content Document record
+        type: integer
+      title:
+        description: Title of the Content Document record
+        type: string
+  ContentVersionOutputRepresentation:
+    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: FileTypeOutputRepresentation
+      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
+  FileTypeOutputRepresentation:
+    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
+  SlackConversationInfoOutputRepresentation:
+    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
+      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
+      shouldCacheCustomEmoji:
+        description: Should the Custom Emojis be cached?
+        type: boolean
+  SlackConversationOutputRepresentation:
+    description: Contains the details of Slack Conversation
+    type: object
+    properties:
+      appId:
+        description: Id of the Slack App
+        type: string
+      channelId:
+        description: Id of the Channel where this Conversation exist
+        type: string
+      contextUserInfo:
+        description: Slack User information of the related context Salesforce User
+          who is viewing this Conversation
+        type: SlackUserInfoOutputRepresentation
+      hasMore:
+        description: Does this conversation have more messages to retrieve?
+        type: boolean
+      latestMessageTs:
+        description: Timestamp of the most recent message in this list of messages
+        type: string
+      messages:
+        description: List of Slack messages
+        type: array
+        items:
+          type: SlackMessageOutputRepresentation
+      oldestMessageTs:
+        description: Timestamp of the oldest message in this list of messages
+        type: string
+      teamId:
+        description: Id of the Team (Workspace) where this Conversation exist
+        type: string
+      threadTs:
+        description: Thread Timestamp for this conversation
+        type: string
+  SlackCustomEmojisOutputRepresentation:
+    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
+  SlackFileInputRepresentation:
+    description: Contains the parameters to upload a file to Slack
+    type: object
+    properties:
+      appId:
+        description: Slack App Id
+        type: string
+      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
+  SlackFileOutputRepresentation:
+    description: Contains the details of files attached to the Slack Message
+    type: object
+    properties:
+      contentDocument:
+        description: Content Document data
+        type: ContentDocumentOutputRepresentation
+      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
+  SlackMessageOutputRepresentation:
+    description: Contains the details of Slack Message
+    type: object
+    properties:
+      appId:
+        description: Id of the Slack App
+        type: string
+      broadcastThreadTs:
+        description: Thread where the reply belong to (if this message is a broadcasted
+          reply)
+        type: string
+      channelId:
+        description: Id of the Channel to which this message belong to
+        type: string
+      files:
+        description: List of files attached to this message
+        type: array
+        items:
+          type: SlackFileOutputRepresentation
+      includesCustomEmoji:
+        description: Does this message includes Custom emoji?
+        type: boolean
+      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
+      isFileReadAllowed:
+        description: Does the App contains required scopes to read Slack files?
+        type: boolean
+      latestReplyTimestamp:
+        description: Latest Reply timestamp
+        type: string
+      message:
+        description: Content of the Message
+        type: string
+      messageEpochMillisecond:
+        description: Epoch (Millisecond) Timestamp of the Message
+        format: double
+        type: number
+      outbound:
+        description: Is this a message sent by the context User?
+        type: boolean
+      reactions:
+        description: List of reactions added to this message
+        type: array
+        items:
+          type: SlackReactionOutputRepresentation
+      replyCount:
+        description: Number of replies for this message
+        type: integer
+      replyUsers:
+        description: List of Users who replied to this message
+        type: array
+        items:
+          type: SlackUserInfoOutputRepresentation
+      replyUsersCount:
+        description: Number of users who replied to this message
+        type: integer
+      slackMessageTs:
+        description: Timestamp of the Message
+        type: string
+      subtype:
+        description: Sub-type of Message
+        type: string
+      teamId:
+        description: Id of the Team to which this message belong to
+        type: string
+      threadTs:
+        description: Timestamp of the thread to which this message belong to
+        type: string
+      type:
+        description: Type of Message
+        type: string
+      uniqueKey:
+        description: Unique Key for this message
+        type: string
+      url:
+        description: Url for this message
+        type: string
+      userInfo:
+        description: Details of the Slack User who posted this message
+        type: SlackUserInfoOutputRepresentation
+  SlackPostMessageInputRepresentation:
+    description: Contains the parameters to post a message to Slack
+    type: object
+    properties:
+      appId:
+        description: Slack App Id
+        type: string
+      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
+  SlackPostMessageOutputRepresentation:
+    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: SlackMessageOutputRepresentation
+      timestamp:
+        description: Timestamp of the message posted to Slack
+        type: string
+  SlackPostMessageReactionInputRepresentation:
+    description: Contains the parameters to post or delete a reaction on Slack message
+    type: object
+    properties:
+      appId:
+        description: Slack App Id
+        type: string
+      channelId:
+        description: Channel where the message reaction should be posted
+        type: string
+      name:
+        description: Name of the reaction
+        type: string
+      teamId:
+        description: Workspace where the message reaction should be posted
+        type: string
+  SlackReactionOutputRepresentation:
+    description: Contains the details of Slack reaction
+    type: object
+    properties:
+      count:
+        description: Number of reactions
+        type: integer
+      hasUserReacted:
+        description: Has the context user reacted?
+        type: boolean
+      isCustomEmoji:
+        description: Is this a custom emoji?
+        type: boolean
+      messageTs:
+        description: Timestamp of the Slack message where this reaction was made
+        type: string
+      name:
+        description: Name of the reaction
+        type: string
+      reactedUsers:
+        description: Users who made this reaction
+        type: array
+        items:
+          type: SlackUserInfoOutputRepresentation
+      unicode:
+        description: Unicode for the reaction
+        type: string
+      uniqueKey:
+        description: Unique Key for this reaction specific to a particular Slack message
+        type: string
+      url:
+        description: Url for the reaction
+        type: string
+  SlackUpdateMessageInputRepresentation:
+    description: Contains the parameters to update a message to Slack
+    type: object
+    properties:
+      appId:
+        description: Slack App Id
+        type: string
+      channelId:
+        description: Channel, private group, or IM channel where the message exists
+        type: string
+      teamId:
+        description: Workspace where the message exists
+        type: string
+      text:
+        description: Content of the updated Slack message
+        type: string
+  SlackUpdatedMessageOutputRepresentation:
+    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: SlackMessageOutputRepresentation
+  SlackUserInfoOutputRepresentation:
+    description: Contains the details of Slack User
+    type: object
+    properties:
+      bot:
+        description: Is this a Bot User?
+        type: boolean
+      profileUrl:
+        description: User Profile url
+        type: string
+      salesforceUserId:
+        description: Id of the related Salesforce User mapped to the Slack User
+        type: string
+      slackUserId:
+        description: Id of the Slack User
+        type: string
+      slackUserImageUrl:
+        description: Url of the Slack User Image
+        type: string
+      slackUsername:
+        description: Name of the Slack User
+        type: string
+      teamId:
+        description: Slack Workspace Id
+        type: string
+/connect/swarming:
+  /conversation:
+    /emojis:
+      get:
+        displayName: getSlackCustomEmoji
+        description: Get Slack Custom Emojis
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackCustomEmojisOutputRepresentation
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          teamId:
+            description: Team or Workspace
+            type: string
+            required: false
+    /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: SlackFileOutputRepresentation
+        body:
+          application/json:
+            type: SlackFileInputRepresentation
+            (oas-body-name): slackFileUploadRequest
+    /messages:
+      get:
+        displayName: getSlackConversation
+        description: Get Slack conversation from the given Workspace and Channel
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackConversationOutputRepresentation
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          channelId:
+            description: Channel where the conversation exist
+            type: string
+            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 items to return. Fewer than the requested
+              number of items may be returned, even if the end of the users list hasn't
+              been reached.
+            type: integer
+            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 Conversations are 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: SlackPostMessageOutputRepresentation
+        body:
+          application/json:
+            type: SlackPostMessageInputRepresentation
+            (oas-body-name): slackMessagePostRequest
+    /messages/{messageTimestamp}:
+      delete:
+        displayName: deleteSlackMessage
+        description: Request to delete a Slack post
+        responses:
+          '200':
+            description: Success
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          channelId:
+            description: Channel where the message exist
+            type: string
+            required: false
+          teamId:
+            description: Team or Workspace where the message exist
+            type: string
+            required: false
+      get:
+        displayName: getSlackMessage
+        description: Get Slack message from the given Channel
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackMessageOutputRepresentation
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          channelId:
+            description: Channel where the message exist
+            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 Conversations are related.
+            type: string
+            required: false
+          teamId:
+            description: Team or Workspace where the message exist
+            type: string
+            required: false
+      patch:
+        displayName: patchSlackMessage
+        description: Request to update a Slack post
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackUpdatedMessageOutputRepresentation
+        body:
+          application/json:
+            type: SlackUpdateMessageInputRepresentation
+            (oas-body-name): slackMessageUpdateRequest
+      uriParameters:
+        messageTimestamp:
+          type: string
+          required: true
+    /messages/{messageTimestamp}/reactions:
+      delete:
+        displayName: deleteSlackMessageReactions
+        description: Request to delete a reaction on Slack message
+        responses:
+          '200':
+            description: Success
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          channelId:
+            description: Channel where the message exist
+            type: string
+            required: false
+          name:
+            description: Name of the reaction
+            type: string
+            required: false
+          teamId:
+            description: Team or Workspace where the message exist
+            type: string
+            required: false
+      get:
+        # No implementation in connect api
+        # GET resource is required to allow DELETE resource with key annotation (messageTimestamp)
+        responses:
+          '200':
+            body:
+              application/json:
+                type: EmptyRepresentation
+      post:
+        displayName: postSlackMessageReactions
+        description: Request to post a reaction on Slack message
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EmptyRepresentation
+        body:
+          application/json:
+            type: SlackPostMessageReactionInputRepresentation
+            (oas-body-name): slackMessageReactionPostRequest
+      uriParameters:
+        messageTimestamp:
+          type: string
+          required: true
+    /user/{userId}:
+      get:
+        displayName: getSlackUser
+        description: Get Slack User
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SlackUserInfoOutputRepresentation
+        queryParameters:
+          appId:
+            description: Slack App Id
+            type: string
+            required: false
+          teamId:
+            description: Team or Workspace where the message exist
+            type: string
+            required: false
+      uriParameters:
+        userId:
+          type: string
+          required: true
+  /slack/conversation/info:
+    get:
+      displayName: getSlackConversationInfo
+      description: Get Slack Conversation information.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackConversationInfoOutputRepresentation
+      queryParameters:
+        appId:
+          description: Slack App Id
+          type: string
+          required: false
+        channelId:
+          description: Channel Id for the conversation
+          type: string
+          required: false
+        teamId:
+          description: Team where the Conversation exist
+          type: string
+          required: false