Support new Membership API and Webhook (#1548)

line/line-openapi#86

# Support new Membership API and Webhook

We have implemented and supported new API and Webhook about Membership.

## API to get a list of users who joined the membership

You can obtain a list of user IDs for users who have joined the
membership of your LINE Official Account by calling
`client.getJoinedMembershipUsers(...)`.

Documents:
https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids

## Membership Webhook 

We have introduced new Webhook events `MembershipEvent` that indicates
that a user has joined, left or renewed a membership of your LINE
Official Account.

Documents:
https://developers.line.biz/en/reference/messaging-api/#membership-event

## For more details
 
For more details, check out the announcement:
https://developers.line.biz/en/news/2025/02/13/membership-api/

Co-authored-by: github-actions <[email protected]>

Author: github-actions[bot]

clients/line-bot-messaging-api-client/.openapi-generator/FILES

@@ -63,6 +63,7 @@ src/main/java/com/linecorp/bot/messaging/model/GenderDemographicFilter.java
 src/main/java/com/linecorp/bot/messaging/model/GetAggregationUnitNameListResponse.java
 src/main/java/com/linecorp/bot/messaging/model/GetAggregationUnitUsageResponse.java
 src/main/java/com/linecorp/bot/messaging/model/GetFollowersResponse.java
+src/main/java/com/linecorp/bot/messaging/model/GetJoinedMembershipUsersResponse.java
 src/main/java/com/linecorp/bot/messaging/model/GetMembershipSubscriptionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/GetMessageContentTranscodingResponse.java
 src/main/java/com/linecorp/bot/messaging/model/GetWebhookEndpointResponse.java

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/client/MessagingApiClient.java

@@ -29,6 +29,7 @@
 import com.linecorp.bot.messaging.model.GetAggregationUnitNameListResponse;
 import com.linecorp.bot.messaging.model.GetAggregationUnitUsageResponse;
 import com.linecorp.bot.messaging.model.GetFollowersResponse;
+import com.linecorp.bot.messaging.model.GetJoinedMembershipUsersResponse;
 import com.linecorp.bot.messaging.model.GetMembershipSubscriptionResponse;
 import com.linecorp.bot.messaging.model.GetWebhookEndpointResponse;
 import com.linecorp.bot.messaging.model.GroupMemberCountResponse;
@@ -251,6 +252,24 @@ CompletableFuture<Result<MembersIdsResponse>> getGroupMembersIds(
   @GET("/v2/bot/group/{groupId}/summary")
   CompletableFuture<Result<GroupSummaryResponse>> getGroupSummary(@Path("groupId") String groupId);
 
+  /**
+   * Get a list of user IDs who joined the membership.
+   *
+   * @param membershipId Membership plan ID. (required)
+   * @param start A continuation token to get next remaining membership user IDs. Returned only when
+   *     there are remaining user IDs that weren&#39;t returned in the userIds property in the
+   *     previous request. The continuation token expires in 24 hours (86,400 seconds). (optional)
+   * @param limit The max number of items to return for this API call. The value is set to 300 by
+   *     default, but the max acceptable value is 1000. (optional, default to 300)
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids">
+   *     Documentation</a>
+   */
+  @GET("/v2/bot/membership/{membershipId}/users/ids")
+  CompletableFuture<Result<GetJoinedMembershipUsersResponse>> getJoinedMembershipUsers(
+      @Path("membershipId") Integer membershipId,
+      @Query("start") String start,
+      @Query("limit") Integer limit);
+
   /**
    * Get a list of memberships.
    *

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/model/GetJoinedMembershipUsersResponse.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you 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.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.messaging.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+
+/**
+ * List of users who have joined the membership
+ *
+ * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids">
+ *     Documentation</a>
+ */
+@JsonInclude(Include.NON_NULL)
+@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
+public record GetJoinedMembershipUsersResponse(
+    /**
+     * A list of user IDs who joined the membership. Users who have not agreed to the bot user
+     * agreement, are not following the bot, or are not active will be excluded. If there are no
+     * users in the membership, an empty list will be returned.
+     */
+    @JsonProperty("userIds") List<String> userIds,
+    /**
+     * A continuation token to get next remaining membership user IDs. Returned only when there are
+     * remaining user IDs that weren&#39;t returned in the userIds property in the previous request.
+     * The continuation token expires in 24 hours (86,400 seconds).
+     */
+    @JsonProperty("next") String next) {
+
+  public static class Builder {
+    private List<String> userIds;
+    private String next;
+
+    public Builder(List<String> userIds) {
+
+      this.userIds = userIds;
+    }
+
+    public Builder next(String next) {
+      this.next = next;
+      return this;
+    }
+
+    public GetJoinedMembershipUsersResponse build() {
+      return new GetJoinedMembershipUsersResponse(userIds, next);
+    }
+  }
+}

clients/line-bot-messaging-api-client/src/test/java/com/linecorp/bot/messaging/client/MessagingApiClientTest.java

@@ -38,6 +38,7 @@
 import com.linecorp.bot.messaging.model.GetAggregationUnitNameListResponse;
 import com.linecorp.bot.messaging.model.GetAggregationUnitUsageResponse;
 import com.linecorp.bot.messaging.model.GetFollowersResponse;
+import com.linecorp.bot.messaging.model.GetJoinedMembershipUsersResponse;
 import com.linecorp.bot.messaging.model.GetMembershipSubscriptionResponse;
 import com.linecorp.bot.messaging.model.GetWebhookEndpointResponse;
 import com.linecorp.bot.messaging.model.GroupMemberCountResponse;
@@ -540,6 +541,57 @@ public void getGroupSummaryTest() {
     // TODO: test validations
   }
 
+  @Test
+  public void getJoinedMembershipUsersTest() {
+    stubFor(
+        get(urlPathTemplate("/v2/bot/membership/{membershipId}/users/ids"))
+            .willReturn(
+                aResponse()
+                    .withStatus(200)
+                    .withHeader("content-type", "application/json")
+                    .withBody("{}")));
+
+    Integer membershipId =
+        Arranger.some(
+            Integer.class,
+            Map.of(
+                "message",
+                () -> new TextMessage("hello"),
+                "recipient",
+                () -> null,
+                "filter",
+                () -> null));
+
+    String start =
+        Arranger.some(
+            String.class,
+            Map.of(
+                "message",
+                () -> new TextMessage("hello"),
+                "recipient",
+                () -> null,
+                "filter",
+                () -> null));
+
+    Integer limit =
+        Arranger.some(
+            Integer.class,
+            Map.of(
+                "message",
+                () -> new TextMessage("hello"),
+                "recipient",
+                () -> null,
+                "filter",
+                () -> null));
+
+    GetJoinedMembershipUsersResponse response =
+        api.getJoinedMembershipUsers(membershipId, start, limit).join().body();
+
+    assertThat(response).isNotNull();
+
+    // TODO: test validations
+  }
+
   @Test
   public void getMembershipListTest() {
     stubFor(

line-bot-webhook/.openapi-generator/FILES

@@ -25,13 +25,17 @@ src/main/java/com/linecorp/bot/webhook/model/ImageMessageContent.java
 src/main/java/com/linecorp/bot/webhook/model/ImageSet.java
 src/main/java/com/linecorp/bot/webhook/model/JoinEvent.java
 src/main/java/com/linecorp/bot/webhook/model/JoinedMembers.java
+src/main/java/com/linecorp/bot/webhook/model/JoinedMembershipContent.java
 src/main/java/com/linecorp/bot/webhook/model/LeaveEvent.java
 src/main/java/com/linecorp/bot/webhook/model/LeftMembers.java
+src/main/java/com/linecorp/bot/webhook/model/LeftMembershipContent.java
 src/main/java/com/linecorp/bot/webhook/model/LinkContent.java
 src/main/java/com/linecorp/bot/webhook/model/LinkThingsContent.java
 src/main/java/com/linecorp/bot/webhook/model/LocationMessageContent.java
 src/main/java/com/linecorp/bot/webhook/model/MemberJoinedEvent.java
 src/main/java/com/linecorp/bot/webhook/model/MemberLeftEvent.java
+src/main/java/com/linecorp/bot/webhook/model/MembershipContent.java
+src/main/java/com/linecorp/bot/webhook/model/MembershipEvent.java
 src/main/java/com/linecorp/bot/webhook/model/Mention.java
 src/main/java/com/linecorp/bot/webhook/model/Mentionee.java
 src/main/java/com/linecorp/bot/webhook/model/MessageContent.java
@@ -42,6 +46,7 @@ src/main/java/com/linecorp/bot/webhook/model/PnpDelivery.java
 src/main/java/com/linecorp/bot/webhook/model/PnpDeliveryCompletionEvent.java
 src/main/java/com/linecorp/bot/webhook/model/PostbackContent.java
 src/main/java/com/linecorp/bot/webhook/model/PostbackEvent.java
+src/main/java/com/linecorp/bot/webhook/model/RenewedMembershipContent.java
 src/main/java/com/linecorp/bot/webhook/model/RoomSource.java
 src/main/java/com/linecorp/bot/webhook/model/ScenarioResult.java
 src/main/java/com/linecorp/bot/webhook/model/ScenarioResultThingsContent.java

line-bot-webhook/src/main/java/com/linecorp/bot/webhook/model/Event.java

@@ -39,6 +39,7 @@
   @JsonSubTypes.Type(value = LeaveEvent.class, name = "leave"),
   @JsonSubTypes.Type(value = MemberJoinedEvent.class, name = "memberJoined"),
   @JsonSubTypes.Type(value = MemberLeftEvent.class, name = "memberLeft"),
+  @JsonSubTypes.Type(value = MembershipEvent.class, name = "membership"),
   @JsonSubTypes.Type(value = MessageEvent.class, name = "message"),
   @JsonSubTypes.Type(value = ModuleEvent.class, name = "module"),
   @JsonSubTypes.Type(value = PostbackEvent.class, name = "postback"),

line-bot-webhook/src/main/java/com/linecorp/bot/webhook/model/JoinedMembershipContent.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you 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.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.webhook.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+
+/** JoinedMembershipContent */
+@JsonTypeName("joined")
+@JsonInclude(Include.NON_NULL)
+@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
+public record JoinedMembershipContent(
+    /** The ID of the membership that the user joined. This is defined for each membership. */
+    @JsonProperty("membershipId") Integer membershipId) implements MembershipContent {
+
+  public static class Builder {
+    private Integer membershipId;
+
+    public Builder(Integer membershipId) {
+
+      this.membershipId = membershipId;
+    }
+
+    public JoinedMembershipContent build() {
+      return new JoinedMembershipContent(membershipId);
+    }
+  }
+}

line-bot-webhook/src/main/java/com/linecorp/bot/webhook/model/LeftMembershipContent.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you 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.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.webhook.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+
+/** LeftMembershipContent */
+@JsonTypeName("left")
+@JsonInclude(Include.NON_NULL)
+@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
+public record LeftMembershipContent(
+    /** The ID of the membership that the user left. This is defined for each membership. */
+    @JsonProperty("membershipId") Integer membershipId) implements MembershipContent {
+
+  public static class Builder {
+    private Integer membershipId;
+
+    public Builder(Integer membershipId) {
+
+      this.membershipId = membershipId;
+    }
+
+    public LeftMembershipContent build() {
+      return new LeftMembershipContent(membershipId);
+    }
+  }
+}

line-bot-webhook/src/main/java/com/linecorp/bot/webhook/model/MembershipContent.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you 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.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.webhook.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+/** Content of the membership event. */
+@JsonSubTypes({
+  @JsonSubTypes.Type(value = JoinedMembershipContent.class, name = "joined"),
+  @JsonSubTypes.Type(value = LeftMembershipContent.class, name = "left"),
+  @JsonSubTypes.Type(value = RenewedMembershipContent.class, name = "renewed"),
+})
+@JsonTypeInfo(
+    use = JsonTypeInfo.Id.NAME,
+    include = JsonTypeInfo.As.PROPERTY,
+    property = "type",
+    visible = true)
+public interface MembershipContent {}