@salesforce/lds-adapters-platform-slack-bridge 1.332.0-dev2 → 1.332.0-dev20

package/src/raml/api.raml

@@ -53,7 +53,7 @@ types:
         type: string
       filetype:
         description: File type of the Content Version record
-        type: SlackBridgeFileTypeOutputRepresentation
+        type: SlackBridgeFileTypeOutputRepresentation | nil
       id:
         description: Id of the Content Version record
         type: string
@@ -65,7 +65,7 @@ types:
         type: string
       versionUrl:
         description: Version URL for the Content Version record
-        type: string
+        type: string | nil
   SlackBridgeConversationHistoryOutputRepresentation:
     description: Contains the details of segment of a Slack conversation's history
     type: object
@@ -91,34 +91,34 @@ types:
         type: string
       isArchived:
         description: Is this conversation archived?
-        type: boolean
+        type: boolean | nil
       isChannel:
         description: Is this a channel?
-        type: boolean
+        type: boolean | nil
       isCustomEmojiSupported:
         description: Is Custom Emoji supported?
         type: boolean | nil
       isGroup:
         description: Is this a group?
-        type: boolean
+        type: boolean | nil
       isIm:
         description: Is this IM?
-        type: boolean
+        type: boolean | nil
       isMember:
         description: Is the context User a member of this Conversation?
-        type: boolean
+        type: boolean | nil
       isOpen:
         description: Is this conversation open?
-        type: boolean
+        type: boolean | nil
       isPrivate:
         description: Is this conversation private?
-        type: boolean
+        type: boolean | nil
       isReadOnly:
         description: Is this conversation read-only?
-        type: boolean
+        type: boolean | nil
       isThreadOnly:
         description: Is this conversation thread-only?
-        type: boolean
+        type: boolean | nil
       name:
         description: Name of the Conversation
         type: string
@@ -128,6 +128,10 @@ types:
       shouldCacheCustomEmoji:
         description: Should the Custom Emojis be cached?
         type: boolean | nil
+      url:
+        description: The URL to the channel
+        required: false
+        type: string
   SlackBridgeConversationInfosOutputRepresentation:
     description: Contains the list of Slack Conversation Information
     type: object
@@ -139,7 +143,63 @@ types:
           type: SlackBridgeConversationInfoOutputRepresentation
       searchString:
         description: String used to search this list of conversations (Optional)
+        type: string | nil
+  SlackBridgeConversationInputRepresentation:
+    description: Representation of a Slack conversation
+    type: object
+    properties:
+      isPrivate:
+        description: Flag indicating if the conversation is private
+        type: boolean
+      name:
+        description: Name of the conversation
+        type: string
+  SlackBridgeConversationMarkOutputRepresentation:
+    description: Representation of a successful call to update the read cursor in
+      a slack channel.
+    type: object
+    properties:
+      channelId:
+        description: Id of the Channel to which this message belongs
+        type: string
+      messageTs:
+        description: The timestamp of the message that was marked read
+        type: string
+  SlackBridgeConversationMemberOutputRepresentation:
+    description: Contains the details of a Slack member for the Slack conversation
+    type: object
+    properties:
+      channelId:
+        description: Id of the Channel to which this message belong to
+        type: string
+      slackUserId:
+        description: The Slack user Id of the member of the Slack conversation
+        type: string
+  SlackBridgeConversationMembersInputRepresentation:
+    description: Contains the parameters to post Slack conversation members requests
+    type: object
+    properties:
+      slackUserIds:
+        description: List of Slack user ids
+        type: array
+        items:
+          type: string
+  SlackBridgeConversationMembersOutputRepresentation:
+    description: Contains the details of Slack members for the Slack conversation
+    type: object
+    properties:
+      channelId:
+        description: Id of the Channel to which this message belong to
         type: string
+      nextCursor:
+        description: Used to paginate to the next page by passing this value as the
+          cursor parameter in a subsequent request
+        type: string | nil
+      slackUserIds:
+        description: The Slack user Ids of the members of the Slack conversation
+        type: array
+        items:
+          type: string
   SlackBridgeConversationOutputRepresentation:
     description: Contains the details of a Slack Conversation
     type: object
@@ -178,40 +238,45 @@ types:
         description: The websocket URL to subscribe to RTM topics associated with
           the conversation
         type: string | nil
-  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
+    description: Contains the details of a Slack Emoji
     type: object
     properties:
-      altText:
-        description: Alt text for the Slack Emoji
-        type: string
-      isCustom:
-        description: Is this a custom Slack Emoji?
+      alias:
+        description: The alias for the emoji
+        type: string | nil
+      collectionId:
+        description: Ties the emoji back to its collection, if it came from one
+        type: string | nil
+      isAlias:
+        description: Is the emoji an alias
         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
+        description: Indicates the name of the emoji, and doubles as an ID when looking
+          it up, as name is unique across a team/org
         type: string
+      updated:
+        description: The last date the emoji name was updated
+        type: string | nil
+      value:
+        description: Value of the Slack Emoji. This is either a URL string, an alias
+          string, or an object containing both Apple and Google URL strings
+        type: SlackBridgeEmojiValueOutputRepresentation | nil
+  SlackBridgeEmojiValueOutputRepresentation:
+    description: Contains the details of a Slack emoji value
+    type: object
+    properties:
+      appleUrl:
+        description: Url of the emoji with Apple styles
+        type: string | nil
+      defaultValue:
+        description: Url of the emoji if specific Apple and Google urls are not provided
+        type: string | nil
+      googleUrl:
+        description: Url of the emoji with Google styles
+        type: string | nil
   SlackBridgeEmojisOutputRepresentation:
-    description: Contains the list of Slack Emoji
+    description: Contains the list of Slack Emojis
     type: object
     properties:
       emojis:
@@ -219,9 +284,6 @@ types:
         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
@@ -260,7 +322,7 @@ types:
     properties:
       contentDocument:
         description: Content Document data
-        type: SlackBridgeContentDocumentOutputRepresentation
+        type: SlackBridgeContentDocumentOutputRepresentation | nil
       filetype:
         description: Type of the File
         type: string
@@ -275,7 +337,7 @@ types:
         type: string
       size:
         description: Size of the File
-        type: integer
+        type: integer | nil
       slackPermalink:
         description: Slack Permalink for the File
         type: string
@@ -284,13 +346,13 @@ types:
         type: string
       token:
         description: Token used for the File
-        type: string
+        type: string | nil
       uniqueKey:
         description: Unique Key for the File
-        type: string
+        type: string | nil
       url:
         description: Slack web URL for the File
-        type: string
+        type: string | nil
   SlackBridgeFileTypeOutputRepresentation:
     description: Contains the details of FileType
     type: object
@@ -319,6 +381,25 @@ types:
     description: Contains the details of Slack Message
     type: object
     properties:
+      attachments:
+        description: Message attachments
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+      blocks:
+        description: Message blocks
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+      channelId:
+        description: Id of the Channel to which this message belong to
+        type: string | nil
       files:
         description: List of files attached to this message
         type: array
@@ -329,13 +410,13 @@ types:
         type: boolean | nil
       isBroadcast:
         description: Is this a reply also sent to the Channel?
-        type: boolean
+        type: boolean | nil
       isEditable:
         description: Can this message be edited?
         type: boolean
       isEdited:
         description: Is this an edited message?
-        type: boolean
+        type: boolean | nil
       latestReplyTimestamp:
         description: Latest Reply timestamp
         type: string | nil
@@ -372,7 +453,7 @@ types:
         type: string | nil
       type:
         description: Type of Message
-        type: string
+        type: string | nil
       url:
         description: Url for this message
         type: string
@@ -425,7 +506,7 @@ types:
     properties:
       count:
         description: Number of reactions
-        type: integer
+        type: integer | nil
       name:
         description: Name of the reaction
         type: string
@@ -456,6 +537,47 @@ types:
         description: The id of the Slack team (Workspace or Enterprise Org) where
           this conversation exists
         type: string
+  SlackBridgeRecordChannelInfoInputRepresentation:
+    description: Representation of a Slack record channel
+    type: object
+    properties:
+      conversationInfo:
+        description: The conversation info associated with the record
+        type: object
+        properties:
+          isPrivate:
+            description: Is this conversation private?
+            type: boolean
+      relatedRecordId:
+        description: The ID of the Salesforce record associated with the conversation
+        type: string
+  SlackBridgeRecordChannelInfoOutputRepresentation:
+    description: Representation of a Slack record channel
+    type: object
+    properties:
+      conversationInfo:
+        description: The conversation info associated with the record
+        type: SlackBridgeConversationInfoOutputRepresentation
+      relatedRecordId:
+        description: The ID of the Salesforce record associated with the conversation
+        type: string
+      teamId:
+        description: The Slack ID of the Slack team
+        type: string
+  SlackBridgeRelatedThreadsOutputRepresentation:
+    description: Contains the Slack Related Threads
+    type: object
+    properties:
+      conversations:
+        description: List of Slack conversation information
+        type: array
+        items:
+          type: SlackBridgeConversationInfoOutputRepresentation
+      messages:
+        description: List of Slack messages
+        type: array
+        items:
+          type: SlackBridgeMessageOutputRepresentation
   SlackBridgeUpdateMessageInputRepresentation:
     description: Contains the parameters to update a message to Slack
     type: object
@@ -472,13 +594,21 @@ types:
         type: boolean
       displayName:
         description: Display Name of the Slack User
-        type: string
+        type: string | nil
+      email:
+        description: Email of the Slack User
+        type: string | nil
       image24:
         description: 24x24 version of the Slack User image
-        type: string
+        required: false
+        type: string | nil
       imageOriginal:
         description: Original version of the Slack User image
         type: string | nil
+      profileImage:
+        description: Profile image used for this Slack user
+        required: false
+        type: string | nil
       inHuddle:
         description: Is this Slack User currently in a Huddle?
         type: boolean | nil
@@ -488,6 +618,10 @@ types:
       isExternal:
         description: Is Slack User external?
         type: boolean | nil
+      isWorkflowBot:
+        description: Is this a Workflow Bot?
+        required: false
+        type: boolean
       name:
         description: Name of the Slack User
         type: string
@@ -496,7 +630,7 @@ types:
         type: string | nil
       realName:
         description: Real Name of the Slack User
-        type: string
+        type: string | nil
       salesforceUserId:
         description: Id of the related Salesforce User mapped to the Slack User
         type: string | nil
@@ -508,17 +642,20 @@ types:
         type: SlackBridgeEmojiOutputRepresentation | nil
       statusMessage:
         description: Status message of the Slack User
-        type: string
+        type: string | nil
       teamId:
         description: Slack Workspace Id
         type: string
+      title:
+        description: Title of the Slack User
+        type: string | nil
   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
+        type: string | nil
       userInfos:
         description: List of Slack User Information
         type: array
@@ -603,113 +740,293 @@ types:
         application/json:
           type: SlackBridgeFileInputRepresentation
           (oas-body-name): slackFileUploadRequest
+  /record_channels:
+    post:
+      displayName: postSlackRecordChannelInfos
+      description: Create a Slack record channel
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgeRecordChannelInfoOutputRepresentation
+      body:
+        application/json:
+          type: SlackBridgeRecordChannelInfoInputRepresentation
+          (oas-body-name): slackRecordChannelInfo
+  /record_channels/{relatedRecordId}:
+    get:
+      displayName: getSlackRecordChannelInfo
+      description: Get Slack conversation from the given Workspace and Channel
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgeRecordChannelInfoOutputRepresentation
+    uriParameters:
+      relatedRecordId:
+        description: Id of the record to which the Slack Conversation is related.
+        type: string
+        required: true
+  /related_threads/entity/{entityId}:
+    get:
+      displayName: getSlackRelatedThreads
+      description: Request to get Related Threads
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SlackBridgeRelatedThreadsOutputRepresentation
+    uriParameters:
+      entityId:
+        description: Entity ID to get related threads
+        type: string
+        required: true
   /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
+    /channel/{channelId}:
+      /mark:
+        post:
+          displayName: postSlackConversationMark
+          description: Request to set the read marker on a slack conversation
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeConversationMarkOutputRepresentation
+          queryParameters:
+            messageTs:
+              description: The timestamp of the message being marked read.
+              type: string
+              #override connect api generated value
+              required: true
+        uriParameters:
+          channelId:
+            description: Id of the Slack channel where the message exists
+            type: string
+            required: true
+          teamId:
+            description: Id of the Slack team where the conversation exists
+            type: string
+            required: true
+      /members:
+        get:
+          displayName: getSlackConversationMembers
+          description: Request to get the members of a Slack conversation
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeConversationMembersOutputRepresentation
+        post:
+          displayName: postSlackConversationMembers
+          description: Request to join the current Slack user or invite other Slack
+            users to a Slack conversation
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeConversationMembersOutputRepresentation
+          body:
+            application/json:
+              type: SlackBridgeConversationMembersInputRepresentation
+              (oas-body-name): slackConversationMembersPostRequest
+        uriParameters:
+          channelId:
+            description: Id of the Slack channel where the message exists
+            type: string
+            required: true
+          teamId:
+            description: Id of the Slack team where the conversation exists
+            type: string
+            required: true
+      /members/{slackUserId}:
+        delete:
+          displayName: deleteSlackConversationMember
+          description: Request to leave a Slack conversation or kick a member from
+            a Slack conversation
+          responses:
+            '200':
+              description: Success
+        get:
+          displayName: getSlackConversationMember
+          description: Request to get a member of a Slack conversation
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeConversationMemberOutputRepresentation
+        uriParameters:
+          channelId:
+            description: Id of the Slack channel where the message exists
+            type: string
+            required: true
+          slackUserId:
+            description: Id of the Slack member to leave or kick from the conversation
+            type: string
+            required: true
+          teamId:
+            description: Id of the Slack team where the conversation exists
+            type: string
+            required: true
+      /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
+      /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 add
+              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: false
+            required: true
+    /emojis:
       get:
-        displayName: getSlackMessageReactions
-        description: Request to get a reaction on a Slack message
+        displayName: getSlackEmojis
+        description: Get Slack Emojis
         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
+                type: SlackBridgeEmojisOutputRepresentation
         queryParameters:
-          name:
-            description: The name of the reaction to add
-            type: string
-            required: false
+          slackEmojiIds:
+            description: List of Emoji Ids
+            type: array
+            required: true
+            items:
+              type: string
+              (oas-collectionFormat): csv
       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
+          description: Team or Workspace
           type: string
           required: true
-    /emojis:
+    /emojis/{slackEmojiId}:
       get:
-        displayName: getSlackCustomEmoji
-        description: Get Slack Custom Emojis
+        displayName: getSlackEmoji
+        description: Get info about a Slack Emoji given a Team Id and Emoji Id
         responses:
           '200':
             description: Success
             body:
               application/json:
-                type: SlackBridgeCustomEmojisOutputRepresentation
+                type: SlackBridgeEmojiOutputRepresentation
       uriParameters:
+        slackEmojiId:
+          description: Id of the Slack Emoji
+          type: string
+          required: true
         teamId:
           description: Team or Workspace
           type: string
           required: true
     /search:
+      /conversations:
+        get:
+          displayName: getSlackSearchConversation
+          description: Search Slack Conversations
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlackBridgeConversationInfosOutputRepresentation
+          queryParameters:
+            search:
+              description: Search String
+              type: string
+              required: false
+        uriParameters:
+          teamId:
+            description: Team or Workspace
+            type: string
+            required: true
       /emojis:
         get:
           displayName: getSlackSearchEmoji
@@ -741,6 +1058,21 @@ types:
                 application/json:
                   type: SlackBridgeUserInfosOutputRepresentation
           queryParameters:
+            channels:
+              type: array
+              required: false
+              items:
+                type: string
+                (oas-collectionFormat): csv
+            filter:
+              type: string
+              required: false
+            not_in_channels:
+              type: array
+              required: false
+              items:
+                type: string
+                (oas-collectionFormat): csv
             search:
               description: Search String
               type: string