Support new Membership API and Webhook (#758)

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]

line-openapi

@@ -98,6 +98,7 @@
 from linebot.v3.messaging.models.get_aggregation_unit_name_list_response import GetAggregationUnitNameListResponse
 from linebot.v3.messaging.models.get_aggregation_unit_usage_response import GetAggregationUnitUsageResponse
 from linebot.v3.messaging.models.get_followers_response import GetFollowersResponse
+from linebot.v3.messaging.models.get_joined_membership_users_response import GetJoinedMembershipUsersResponse
 from linebot.v3.messaging.models.get_membership_subscription_response import GetMembershipSubscriptionResponse
 from linebot.v3.messaging.models.get_message_content_transcoding_response import GetMessageContentTranscodingResponse
 from linebot.v3.messaging.models.get_webhook_endpoint_response import GetWebhookEndpointResponse

linebot/v3/messaging/__init__.py

@@ -20,7 +20,7 @@
 from typing_extensions import Annotated
 from typing import overload, Optional, Union, Awaitable
 
-from pydantic.v1 import Field, StrictStr, conint, constr, validator
+from pydantic.v1 import Field, StrictInt, StrictStr, conint, constr, validator
 
 from typing import Any, Dict, Optional
 
@@ -30,6 +30,7 @@
 from linebot.v3.messaging.models.get_aggregation_unit_name_list_response import GetAggregationUnitNameListResponse
 from linebot.v3.messaging.models.get_aggregation_unit_usage_response import GetAggregationUnitUsageResponse
 from linebot.v3.messaging.models.get_followers_response import GetFollowersResponse
+from linebot.v3.messaging.models.get_joined_membership_users_response import GetJoinedMembershipUsersResponse
 from linebot.v3.messaging.models.get_membership_subscription_response import GetMembershipSubscriptionResponse
 from linebot.v3.messaging.models.get_webhook_endpoint_response import GetWebhookEndpointResponse
 from linebot.v3.messaging.models.group_member_count_response import GroupMemberCountResponse
@@ -2374,6 +2375,175 @@ def get_group_summary_with_http_info(self, group_id : Annotated[StrictStr, Field
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @overload
+    async def get_joined_membership_users(self, membership_id : Annotated[StrictInt, Field(..., description="Membership plan ID.")], start : Annotated[Optional[StrictStr], Field(description="A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). ")] = None, limit : Annotated[Optional[conint(strict=True, le=1000, ge=1)], Field(description="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. ")] = None, **kwargs) -> GetJoinedMembershipUsersResponse:  # noqa: E501
+        ...
+
+    @overload
+    def get_joined_membership_users(self, membership_id : Annotated[StrictInt, Field(..., description="Membership plan ID.")], start : Annotated[Optional[StrictStr], Field(description="A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). ")] = None, limit : Annotated[Optional[conint(strict=True, le=1000, ge=1)], Field(description="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. ")] = None, async_req: Optional[bool]=True, **kwargs) -> GetJoinedMembershipUsersResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def get_joined_membership_users(self, membership_id : Annotated[StrictInt, Field(..., description="Membership plan ID.")], start : Annotated[Optional[StrictStr], Field(description="A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). ")] = None, limit : Annotated[Optional[conint(strict=True, le=1000, ge=1)], Field(description="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. ")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetJoinedMembershipUsersResponse, Awaitable[GetJoinedMembershipUsersResponse]]:  # noqa: E501
+        """get_joined_membership_users  # noqa: E501
+
+        Get a list of user IDs who joined the membership.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_joined_membership_users(membership_id, start, limit, async_req=True)
+        >>> result = thread.get()
+
+        :param membership_id: Membership plan ID. (required)
+        :type membership_id: int
+        :param start: A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). 
+        :type start: str
+        :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. 
+        :type limit: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: GetJoinedMembershipUsersResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            raise ValueError("Error! Please call the get_joined_membership_users_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
+        if async_req is not None:
+            kwargs['async_req'] = async_req
+        return self.get_joined_membership_users_with_http_info(membership_id, start, limit, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def get_joined_membership_users_with_http_info(self, membership_id : Annotated[StrictInt, Field(..., description="Membership plan ID.")], start : Annotated[Optional[StrictStr], Field(description="A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). ")] = None, limit : Annotated[Optional[conint(strict=True, le=1000, ge=1)], Field(description="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. ")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """get_joined_membership_users  # noqa: E501
+
+        Get a list of user IDs who joined the membership.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_joined_membership_users_with_http_info(membership_id, start, limit, async_req=True)
+        >>> result = thread.get()
+
+        :param membership_id: Membership plan ID. (required)
+        :type membership_id: int
+        :param start: A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds). 
+        :type start: str
+        :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. 
+        :type limit: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(GetJoinedMembershipUsersResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _host = self.line_base_path
+        _params = locals()
+
+        _all_params = [
+            'membership_id',
+            'start',
+            'limit'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_joined_membership_users" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['membership_id']:
+            _path_params['membershipId'] = _params['membership_id']
+
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('start') is not None:  # noqa: E501
+            _query_params.append(('start', _params['start']))
+
+        if _params.get('limit') is not None:  # noqa: E501
+            _query_params.append(('limit', _params['limit']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['Bearer']  # noqa: E501
+
+        _response_types_map = {
+            '200': "GetJoinedMembershipUsersResponse",
+            '400': "ErrorResponse",
+            '404': "ErrorResponse",
+        }
+
+        return self.api_client.call_api(
+            '/v2/bot/membership/{membershipId}/users/ids', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            _host=_host,
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @overload
     async def get_membership_list(self, **kwargs) -> MembershipListResponse:  # noqa: E501
         ...