Add stream methods to client

slack-base/src/main/java/com/hubspot/slack/client/methods/SlackMethods.java

@@ -172,6 +172,21 @@ public enum SlackMethods implements SlackMethod {
     RateLimitingTiers.TIER_3,
     JsonStatus.ACCEPTS_JSON
   ),
+  chat_startStream(
+    MethodWriteMode.WRITE,
+    RateLimitingTiers.TIER_2,
+    JsonStatus.ACCEPTS_JSON
+  ),
+  chat_stopStream(
+    MethodWriteMode.WRITE,
+    RateLimitingTiers.TIER_2,
+    JsonStatus.ACCEPTS_JSON
+  ),
+  chat_appendStream(
+    MethodWriteMode.WRITE,
+    RateLimitingTiers.TIER_4,
+    JsonStatus.ACCEPTS_JSON
+  ),
 
   conversations_archive(
     MethodWriteMode.WRITE,

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/ChatAppendStreamParamsIF.java

@@ -0,0 +1,23 @@
+package com.hubspot.slack.client.methods.params.stream;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.google.common.base.Preconditions;
+import com.hubspot.immutables.style.HubSpotStyle;
+import org.immutables.value.Value.Check;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface ChatAppendStreamParamsIF extends StreamParams {
+  String getTs();
+
+  @Check
+  default void checkExactlyOnePresent() {
+    Preconditions.checkState(
+      getMarkdownText().isPresent() ^ !getChunks().isEmpty(),
+      "Exactly one of markdownText or chunks must be provided"
+    );
+  }
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/ChatStartStreamParamsIF.java

@@ -0,0 +1,43 @@
+package com.hubspot.slack.client.methods.params.stream;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.google.common.base.Preconditions;
+import com.hubspot.immutables.style.HubSpotStyle;
+import java.util.Optional;
+import org.immutables.value.Value.Check;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface ChatStartStreamParamsIF extends StreamParams {
+  String getThreadTs();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getRecipientUserId();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getRecipientTeamId();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getTaskDisplayMode();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getIconEmoji();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getIconUrl();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getUsername();
+
+  @Check
+  default void checkNotBothPresent() {
+    Preconditions.checkState(
+      !(getMarkdownText().isPresent() && !getChunks().isEmpty()),
+      "markdownText and chunks are mutually exclusive"
+    );
+  }
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/ChatStopStreamParamsIF.java

@@ -0,0 +1,23 @@
+package com.hubspot.slack.client.methods.params.stream;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.google.common.collect.ImmutableList;
+import com.hubspot.immutables.style.HubSpotStyle;
+import com.hubspot.slack.client.models.blocks.Block;
+import java.util.Optional;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface ChatStopStreamParamsIF extends StreamParams {
+  String getTs();
+
+  @JsonInclude(JsonInclude.Include.NON_EMPTY)
+  ImmutableList<Block> getBlocks();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<StreamMetadata> getMetadata();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/StreamMetadataIF.java

@@ -0,0 +1,16 @@
+package com.hubspot.slack.client.methods.params.stream;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.hubspot.immutables.style.HubSpotStyle;
+import java.util.Map;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface StreamMetadataIF {
+  String getEventType();
+
+  Map<String, Object> getEventPayload();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/StreamParams.java

@@ -0,0 +1,26 @@
+package com.hubspot.slack.client.methods.params.stream;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import com.hubspot.slack.client.methods.params.stream.chunks.StreamChunk;
+import java.util.Optional;
+import org.immutables.value.Value.Check;
+
+public interface StreamParams {
+  String getChannel();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getMarkdownText();
+
+  @JsonInclude(JsonInclude.Include.NON_EMPTY)
+  ImmutableList<StreamChunk> getChunks();
+
+  @Check
+  default void checkMutuallyExclusive() {
+    Preconditions.checkState(
+      !(getMarkdownText().isPresent() && !getChunks().isEmpty()),
+      "markdownText and chunks are mutually exclusive"
+    );
+  }
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/BlocksChunkIF.java

@@ -0,0 +1,21 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+import com.google.common.collect.ImmutableList;
+import com.hubspot.immutables.style.HubSpotStyle;
+import com.hubspot.slack.client.models.blocks.elements.BlockElement;
+import org.immutables.value.Value.Derived;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+public interface BlocksChunkIF extends StreamChunk {
+  String TYPE = "blocks";
+
+  @Override
+  @Derived
+  default String getType() {
+    return TYPE;
+  }
+
+  ImmutableList<BlockElement> getBlocks();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/MarkdownTextChunkIF.java

@@ -0,0 +1,19 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+import com.hubspot.immutables.style.HubSpotStyle;
+import org.immutables.value.Value.Derived;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+public interface MarkdownTextChunkIF extends StreamChunk {
+  String TYPE = "markdown_text";
+
+  @Override
+  @Derived
+  default String getType() {
+    return TYPE;
+  }
+
+  String getText();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/PlanUpdateChunkIF.java

@@ -0,0 +1,19 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+import com.hubspot.immutables.style.HubSpotStyle;
+import org.immutables.value.Value.Derived;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+public interface PlanUpdateChunkIF extends StreamChunk {
+  String TYPE = "plan_update";
+
+  @Override
+  @Derived
+  default String getType() {
+    return TYPE;
+  }
+
+  String getTitle();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/StreamChunk.java

@@ -0,0 +1,21 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+@JsonTypeInfo(
+  use = JsonTypeInfo.Id.NAME,
+  property = "type",
+  defaultImpl = UnknownStreamChunk.class
+)
+@JsonSubTypes(
+  {
+    @JsonSubTypes.Type(value = MarkdownTextChunk.class, name = MarkdownTextChunk.TYPE),
+    @JsonSubTypes.Type(value = TaskUpdateChunk.class, name = TaskUpdateChunk.TYPE),
+    @JsonSubTypes.Type(value = PlanUpdateChunk.class, name = PlanUpdateChunk.TYPE),
+    @JsonSubTypes.Type(value = BlocksChunk.class, name = BlocksChunk.TYPE),
+  }
+)
+public interface StreamChunk {
+  String getType();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/TaskUpdateChunkIF.java

@@ -0,0 +1,40 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.google.common.collect.ImmutableList;
+import com.hubspot.immutables.style.HubSpotStyle;
+import com.hubspot.slack.client.models.blocks.TaskCardBlockStatus;
+import com.hubspot.slack.client.models.blocks.elements.UrlSource;
+import java.util.Optional;
+import org.immutables.value.Value.Derived;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface TaskUpdateChunkIF extends StreamChunk {
+  String TYPE = "task_update";
+
+  @Override
+  @Derived
+  default String getType() {
+    return TYPE;
+  }
+
+  String getId();
+
+  String getTitle();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<TaskCardBlockStatus> getStatus();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getDetails();
+
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  Optional<String> getOutput();
+
+  ImmutableList<UrlSource> getSources();
+}

slack-base/src/main/java/com/hubspot/slack/client/methods/params/stream/chunks/UnknownStreamChunk.java

@@ -0,0 +1,13 @@
+package com.hubspot.slack.client.methods.params.stream.chunks;
+
+public class UnknownStreamChunk implements StreamChunk {
+
+  public static final String TYPE = "unknown";
+
+  protected UnknownStreamChunk() {}
+
+  @Override
+  public String getType() {
+    return TYPE;
+  }
+}

slack-base/src/main/java/com/hubspot/slack/client/models/response/chat/ChatStartStreamResponseIF.java

@@ -0,0 +1,13 @@
+package com.hubspot.slack.client.models.response.chat;
+
+import com.hubspot.immutables.style.HubSpotStyle;
+import com.hubspot.slack.client.models.response.SlackResponse;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+public interface ChatStartStreamResponseIF extends SlackResponse {
+  String getChannel();
+
+  String getTs();
+}

slack-base/src/main/java/com/hubspot/slack/client/models/response/chat/ChatStopStreamResponseIF.java

@@ -0,0 +1,19 @@
+package com.hubspot.slack.client.models.response.chat;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.hubspot.immutables.style.HubSpotStyle;
+import com.hubspot.slack.client.models.response.SlackResponse;
+import java.util.Map;
+import org.immutables.value.Value.Immutable;
+
+@Immutable
+@HubSpotStyle
+@JsonNaming(SnakeCaseStrategy.class)
+public interface ChatStopStreamResponseIF extends SlackResponse {
+  String getChannel();
+
+  String getTs();
+
+  Map<String, Object> getMessage();
+}