fix: javadoc (#164)

* fix: javadoc

* feat: run javadoc on pr

* fix: remove prints

* feat: add querying for archived channels in tests

Author: shaljam

.github/workflows/ci.yml

@@ -25,4 +25,5 @@ jobs:
           STREAM_SECRET: ${{ secrets.STREAM_SECRET }}
         run: |
           ./gradlew spotlessCheck --no-daemon
+          ./gradlew javadoc --no-daemon
           ./gradlew jacocoTestReport --no-daemon

src/main/java/io/getstream/chat/java/models/Flag.java

@@ -452,6 +452,7 @@ public static QueryFlagReportsRequest queryFlagReports() {
   /**
    * Creates a review flag report request
    *
+   * @param id the flag report id
    * @return the created request
    */
   @NotNull

src/main/java/io/getstream/chat/java/models/Moderation.java

@@ -190,22 +190,33 @@ protected Call<ConfigGetResponse> generateCall(Client client) {
   }
 
   /**
-   * Creates a get or create request
+   * Creates an upsert config request
    *
-   * @param type the channel type
-   * @param id the channel id
+   * @param key the moderation config key
    * @return the created request
    */
   @NotNull
   public static UpsertConfigRequest upsertConfig(@NotNull String key) {
     return new UpsertConfigRequest(key);
   }
 
+  /**
+   * Creates a delete config request
+   *
+   * @param key the moderation config key
+   * @return the created request
+   */
   @NotNull
   public static DeleteConfigRequest deleteConfig(@NotNull String key) {
     return new DeleteConfigRequest(key);
   }
 
+  /*
+   * Creates a get config request
+   *
+   * @param key the moderation config key
+   * @return the created request
+   */
   @NotNull
   public static ConfigGetRequest getConfig(@NotNull String key) {
     return new ConfigGetRequest(key);

src/main/java/io/getstream/chat/java/models/UnreadCounts.java

@@ -145,6 +145,7 @@ protected Call<UnreadCountsBatchResponse> generateCall(Client client) {
   /**
    * Creates a get request.
    *
+   * @param userId the user id
    * @return the created request
    */
   @NotNull

src/main/java/io/getstream/chat/java/models/framework/StreamRequest.java

@@ -46,6 +46,7 @@ public void requestAsync(
    * Use custom client implementation to execute requests
    *
    * @param client the client implementation
+   * @return the request
    */
   public StreamRequest<T> withClient(Client client) {
     this.client = client;

src/test/java/io/getstream/chat/java/ChannelTest.java

@@ -446,7 +446,6 @@ void whenUpdatingChannelMemberPartially_thenIsUpdated() {
                     .setValue("channel_role", "channel_moderator")
                     .request());
 
-    System.out.println(channelMemberResponse.getMember());
     Assertions.assertEquals(
         "custom_value", channelMemberResponse.getMember().getAdditionalFields().get("custom_key"));
     Assertions.assertEquals(
@@ -494,8 +493,6 @@ void whenPinningAndUnpinningAChannelUsingUnset_thenIsPinnedAndUnpinned() {
             () ->
                 Channel.pin(channel.getType(), channel.getId(), testUserRequestObject.getId())
                     .request());
-    System.out.println(channelMemberResponse.getMember());
-    System.out.println(channelMemberResponse.getMember().getPinnedAt());
     Assertions.assertNotNull(channelMemberResponse.getMember().getPinnedAt());
 
     channelMemberResponse =
@@ -519,6 +516,17 @@ void whenArchivingChannel_thenIsArchived() {
                     .request());
     Assertions.assertNotNull(channelMemberResponse.getMember().getArchivedAt());
 
+    ChannelListResponse channelListResponse =
+        Assertions.assertDoesNotThrow(
+            () ->
+                Channel.list()
+                    .userId(testUserRequestObject.getId())
+                    .filterCondition("archived", true)
+                    .request());
+    Assertions.assertEquals(1, channelListResponse.getChannels().size());
+    Assertions.assertEquals(
+        channel.getId(), channelListResponse.getChannels().get(0).getChannel().getId());
+
     channelMemberResponse =
         Assertions.assertDoesNotThrow(
             () ->