feat: create separate team update request (#145)

* feat: create separate team update request

* feat: change string to array list

* feat: update from arraylist to list

Author: ebk45

src/main/java/com/spotify/github/v3/clients/TeamClient.java

@@ -32,6 +32,7 @@
 import com.spotify.github.v3.orgs.TeamInvitation;
 import com.spotify.github.v3.orgs.requests.MembershipCreate;
 import com.spotify.github.v3.orgs.requests.TeamCreate;
+import com.spotify.github.v3.orgs.requests.TeamUpdate;
 import java.lang.invoke.MethodHandles;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -107,7 +108,7 @@ public CompletableFuture<List<Team>> listTeams() {
    * @param slug slug of the team name
    * @return team
    */
-  public CompletableFuture<Team> updateTeam(final TeamCreate request, final String slug) {
+  public CompletableFuture<Team> updateTeam(final TeamUpdate request, final String slug) {
     final String path = String.format(TEAM_SLUG_TEMPLATE, org, slug);
     log.debug("Updating team in: " + path);
     return github.patch(path, github.json().toJsonUnchecked(request), Team.class);

src/main/java/com/spotify/github/v3/orgs/requests/TeamCreate.java

@@ -22,6 +22,7 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.spotify.github.GithubStyle;
+import java.util.List;
 import java.util.Optional;
 import javax.annotation.Nullable;
 import org.immutables.value.Value;
@@ -40,17 +41,40 @@ public interface TeamCreate {
   /** The description of the team. */
   Optional<String> description();
 
+  /**
+   * The level of privacy this team should have.
+   * For a non-nested team:
+   * secret - only visible to organization owners and members of this team.
+   * closed - visible to all members of this organization.
+   * Default: secret
+   * For a parent or child team:
+   * closed - visible to all members of this organization.
+   * Default for child team: closed
+   * Can be one of: secret, closed
+   */
+  Optional<String> privacy();
+
+  /**
+   * The notification setting the team has chosen. The options are:
+   * notifications_enabled - team members receive notifications when the team is @mentioned.
+   * notifications_disabled - no one receives notifications.
+   * Default: notifications_enabled
+   * Can be one of: notifications_enabled, notifications_disabled
+   */
+  @SuppressWarnings("checkstyle:methodname")
+  Optional<String> notification_setting();
+
   /**
    * List GitHub IDs for organization members who will
    * become team maintainers.
    */
-  Optional<String> maintainers();
+  Optional<List<String>> maintainers();
 
   /** The full name (e.g., "organization-name/repository-name")
    * of repositories to add the team to.
    */
   @SuppressWarnings("checkstyle:methodname")
-  Optional<String> repo_names();
+  Optional<List<String>> repo_names();
 
   /** The ID of a team to set as the parent team. */
   @SuppressWarnings("checkstyle:methodname")

src/main/java/com/spotify/github/v3/orgs/requests/TeamUpdate.java

@@ -0,0 +1,70 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2020 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+package com.spotify.github.v3.orgs.requests;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.spotify.github.GithubStyle;
+import java.util.Optional;
+import javax.annotation.Nullable;
+import org.immutables.value.Value;
+
+/** Request to create a team within a given organisation */
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutableTeamUpdate.class)
+@JsonDeserialize(as = ImmutableTeamUpdate.class)
+public interface TeamUpdate {
+
+  /** The name of the team. */
+  @Nullable
+  String name();
+
+  /** The description of the team. */
+  Optional<String> description();
+
+  /**
+   * The level of privacy this team should have.
+   * For a non-nested team:
+   * secret - only visible to organization owners and members of this team.
+   * closed - visible to all members of this organization.
+   * Default: secret
+   * For a parent or child team:
+   * closed - visible to all members of this organization.
+   * Default for child team: closed
+   * Can be one of: secret, closed
+   */
+  Optional<String> privacy();
+
+  /**
+   * The notification setting the team has chosen. The options are:
+   * notifications_enabled - team members receive notifications when the team is @mentioned.
+   * notifications_disabled - no one receives notifications.
+   * Default: notifications_enabled
+   * Can be one of: notifications_enabled, notifications_disabled
+   */
+  @SuppressWarnings("checkstyle:methodname")
+  Optional<String> notification_setting();
+
+
+  /** The ID of a team to set as the parent team. */
+  @SuppressWarnings("checkstyle:methodname")
+  Optional<String> parent_team_id();
+}

src/test/java/com/spotify/github/v3/clients/TeamClientTest.java

@@ -42,6 +42,7 @@
 import com.spotify.github.v3.orgs.TeamInvitation;
 import com.spotify.github.v3.orgs.requests.MembershipCreate;
 import com.spotify.github.v3.orgs.requests.TeamCreate;
+import com.spotify.github.v3.orgs.requests.TeamUpdate;
 import java.io.IOException;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -127,16 +128,16 @@ public void createTeam() throws Exception {
 
   @Test
   public void updateTeam() throws Exception {
-    final TeamCreate teamCreateRequest =
+    final TeamUpdate teamUpdateRequest =
         json.fromJson(
             getFixture("teams_patch.json"),
-            TeamCreate.class);
+            TeamUpdate.class);
 
     final CompletableFuture<Team> fixtureResponse = completedFuture(json.fromJson(
         getFixture("teams_patch_response.json"),
         Team.class));
     when(github.patch(any(), any(), eq(Team.class))).thenReturn(fixtureResponse);
-    final CompletableFuture<Team> actualResponse = teamClient.updateTeam(teamCreateRequest, "justice-league");
+    final CompletableFuture<Team> actualResponse = teamClient.updateTeam(teamUpdateRequest, "justice-league");
 
     assertThat(actualResponse.get().name(), is("Justice League2"));
   }