Support Rich menu alias APIs (#332)

louis70109 · web-flow · commit 71474a6097e7 · 2021-08-11T10:15:32.000+08:00
* Create publish-to-pypi.yml

* Create python-package.yml

* Rename python-package.yml to ci.yml

* Update ci.yml

* Update ci.yml

* remove 2.7

* remove 3.4, 3.5

DEPRECATION: Python 3.4 support has been deprecated. pip 19.1 will be the last one supporting it. Please upgrade your Python as Python 3.4 won't be maintained after March 2019 (cf PEP 429).

* Update tox.ini

* Update tox.ini

* Update tox.ini

* Update README.rst

* Update README.rst

* Update README.rst

* Update ci.yml

* remove travis yml

* Rename ci.yml to auto-testing.yml

* fix python version to 3.x

* feat: add rich menu switch action

* feat: add alias models

* feat: add rich menu alias get/get list/update/delete api

* test: add rich menu alias switch action test

* test: add alias test cases

* fix lint

* fix typo

* fix lint

* fix document link error
diff --git a/linebot/api.py b/linebot/api.py
@@ -32,7 +32,7 @@
     AudienceGroup, ClickAudienceGroup, ImpAudienceGroup, GetAuthorityLevel, Audience,
     CreateAudienceGroup
 )
-from .models.responses import Group, UserIds
+from .models.responses import Group, UserIds, RichMenuAliasResponse, RichMenuAliasListResponse
 
 
 class LineBotApi(object):
@@ -657,7 +657,7 @@ def leave_room(self, room_id, timeout=None):
     def get_rich_menu(self, rich_menu_id, timeout=None):
         """Call get rich menu API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#get-rich-menu
+        https://developers.line.biz/en/reference/messaging-api/#get-rich-menu
 
         :param str rich_menu_id: ID of the rich menu
         :param timeout: (optional) How long to wait for the server
@@ -675,10 +675,49 @@ def get_rich_menu(self, rich_menu_id, timeout=None):
 
         return RichMenuResponse.new_from_json_dict(response.json)
 
+    def get_rich_menu_alias(self, rich_menu_alias_id=None, timeout=None):
+        """Call get rich menu alias API.
+
+        https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-by-id
+
+        :param str rich_menu_alias_id: ID of an uploaded rich menu alias.
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.RichMenuAliasResponse`
+        :return: RichMenuAliasResponse instance
+        """
+        response = self._get(
+            '/v2/bot/richmenu/alias/{rich_menu_id}'.format(rich_menu_id=rich_menu_alias_id),
+            timeout=timeout
+        )
+        return RichMenuAliasResponse.new_from_json_dict(response.json)
+
+    def get_rich_menu_alias_list(self, timeout=None):
+        """Call get rich menu alias list API.
+
+        https://developers.line.biz/en/reference/messaging-api/#update-rich-menu-alias
+
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.RichMenuAliasListResponse`
+        :return: RichMenuAliasListResponse instance
+        """
+        response = self._get(
+            '/v2/bot/richmenu/alias/list',
+            timeout=timeout
+        )
+        return RichMenuAliasListResponse.new_from_json_dict(response.json)
+
     def create_rich_menu(self, rich_menu, timeout=None):
         """Call create rich menu API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#create-rich-menu
+        https://developers.line.biz/en/reference/messaging-api/#create-rich-menu
 
         :param rich_menu: Inquired to create a rich menu object.
         :type rich_menu: T <= :py:class:`linebot.models.rich_menu.RichMenu`
@@ -696,10 +735,51 @@ def create_rich_menu(self, rich_menu, timeout=None):
 
         return response.json.get('richMenuId')
 
+    def create_rich_menu_alias(self, rich_menu_alias, timeout=None):
+        """Call create rich menu alias API.
+
+        https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias
+
+        :param rich_menu_alias: Inquired to create a rich menu alias object.
+        :type rich_menu_alias: T <= :py:class:`linebot.models.rich_menu.RichMenuAlias`
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: str
+        :return: rich menu id
+        """
+        self._post(
+            '/v2/bot/richmenu/alias', data=rich_menu_alias.as_json_string(), timeout=timeout
+        )
+
+    def update_rich_menu_alias(self, rich_menu_alias_id, rich_menu_alias, timeout=None):
+        """Call update rich menu alias API.
+
+        https://developers.line.biz/en/reference/messaging-api/#update-rich-menu-alias
+
+        :param str rich_menu_alias_id: ID of an uploaded rich menu alias.
+        :param rich_menu_alias: Inquired to create a rich menu alias object.
+        :type rich_menu_alias: T <= :py:class:`linebot.models.rich_menu.RichMenuAlias`
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: str
+        :return: rich menu id
+        """
+        self._post(
+            '/v2/bot/richmenu/alias/{rich_menu_id}'.format(rich_menu_id=rich_menu_alias_id),
+            data=rich_menu_alias.as_json_string(),
+            timeout=timeout
+        )
+
     def delete_rich_menu(self, rich_menu_id, timeout=None):
         """Call delete rich menu API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#delete-rich-menu
+        https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu
 
         :param str rich_menu_id: ID of an uploaded rich menu
         :param timeout: (optional) How long to wait for the server
@@ -713,10 +793,28 @@ def delete_rich_menu(self, rich_menu_id, timeout=None):
             timeout=timeout
         )
 
+    def delete_rich_menu_alias(self, rich_menu_alias_id, timeout=None):
+        """Call delete rich menu alias API.
+
+        https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias
+
+        :param str rich_menu_alias_id: ID of an uploaded rich menu alias.
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        """
+        self._delete(
+            '/v2/bot/richmenu/alias/{rich_menu_alias_id}'.format(
+                rich_menu_alias_id=rich_menu_alias_id),
+            timeout=timeout
+        )
+
     def get_rich_menu_id_of_user(self, user_id, timeout=None):
         """Call get rich menu ID of user API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#get-rich-menu-id-of-user
+        https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-id-of-user
 
         :param str user_id: IDs of the user
         :param timeout: (optional) How long to wait for the server
@@ -737,7 +835,7 @@ def get_rich_menu_id_of_user(self, user_id, timeout=None):
     def link_rich_menu_to_user(self, user_id, rich_menu_id, timeout=None):
         """Call link rich menu to user API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#link-rich-menu-to-user
+        https://developers.line.biz/en/reference/messaging-api/#link-rich-menu-to-user
 
         :param str user_id: ID of the user
         :param str rich_menu_id: ID of an uploaded rich menu
@@ -782,7 +880,7 @@ def link_rich_menu_to_users(self, user_ids, rich_menu_id, timeout=None):
     def unlink_rich_menu_from_user(self, user_id, timeout=None):
         """Call unlink rich menu from user API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#unlink-rich-menu-from-user
+        https://developers.line.biz/en/reference/messaging-api#unlink-rich-menu-from-user
 
         :param str user_id: ID of the user
         :param timeout: (optional) How long to wait for the server
@@ -821,7 +919,7 @@ def unlink_rich_menu_from_users(self, user_ids, timeout=None):
     def get_rich_menu_image(self, rich_menu_id, timeout=None):
         """Call download rich menu image API.
 
-        https://developers.line.me/en/docs/messaging-api/reference/#download-rich-menu-image
+        https://developers.line.biz/en/reference/messaging-api#download-rich-menu-image
 
         :param str rich_menu_id: ID of the rich menu with the image to be downloaded
         :param timeout: (optional) How long to wait for the server
@@ -1300,14 +1398,14 @@ def add_audiences_to_audience_group(self, audience_group_id, audiences,
         if audiences:
             audiences = [Audience.new_from_json_dict(audience) for audience in audiences]
         response = self._put(
-                '/v2/bot/audienceGroup/upload',
-                data=json.dumps({
-                    "audienceGroupId": audience_group_id,
-                    "audiences": [audience.as_json_dict() for audience in audiences],
-                    "uploadDescription": upload_description,
-                }),
-                timeout=timeout
-            )
+            '/v2/bot/audienceGroup/upload',
+            data=json.dumps({
+                "audienceGroupId": audience_group_id,
+                "audiences": [audience.as_json_dict() for audience in audiences],
+                "uploadDescription": upload_description,
+            }),
+            timeout=timeout
+        )
 
         return response.json
 
diff --git a/linebot/models/actions.py b/linebot/models/actions.py
@@ -34,6 +34,7 @@ def get_action(action):
             'camera': CameraAction,
             'cameraRoll': CameraRollAction,
             'location': LocationAction,
+            'richmenuswitch': RichMenuSwitchAction,
         }
     )
     return action_obj
@@ -270,3 +271,33 @@ def __init__(self, label=None, **kwargs):
 
         self.type = 'location'
         self.label = label
+
+
+class RichMenuSwitchAction(Action):
+    """RichMenuSwitchAction.
+
+    https://developers.line.biz/en/reference/messaging-api/#richmenu-switch-action
+
+    This action can be configured only with rich menus.
+    It can't be used for Flex Messages or quick replies.
+    When you tap a rich menu associated with this action,
+    you can switch between rich menus,
+    and a postback event including the rich menu alias ID selected
+     by the user is returned via a webhook.
+    """
+
+    def __init__(self, label=None, rich_menu_alias_id=None, data=None, **kwargs):
+        """__init__ method.
+
+        :param str label: Label for the action
+        :param str rich_menu_alias_id: Rich menu alias ID to switch to.
+        :param str data: String returned by the postback.data property
+         of the postback event via a webhook
+        :param kwargs:
+        """
+        super(RichMenuSwitchAction, self).__init__(**kwargs)
+
+        self.type = 'richmenuswitch'
+        self.label = label
+        self.rich_menu_alias_id = rich_menu_alias_id
+        self.data = data
diff --git a/linebot/models/responses.py b/linebot/models/responses.py
@@ -22,7 +22,7 @@
     GenderInsight, AreaInsight, MessageInsight, ClickInsight,
     MessageStatistics, JobInsight,
 )
-from .rich_menu import RichMenuSize, RichMenuArea
+from .rich_menu import RichMenuSize, RichMenuArea, RichMenuAlias
 
 
 class BroadcastResponse(object):
@@ -194,6 +194,48 @@ def __init__(self, rich_menu_id=None, size=None, selected=None, name=None,
         self.areas = new_areas
 
 
+class RichMenuAliasResponse(Base):
+    """RichMenuAliasResponse.
+
+    https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-by-id-response
+    """
+
+    def __init__(self, rich_menu_alias_id=None, rich_menu_id=None, **kwargs):
+        """__init__ method.
+
+        :param str rich_menu_alias_id: Rich menu alias ID.
+        :param str rich_menu_id: Rich menu ID.
+        :param kwargs:
+        """
+        super(RichMenuAliasResponse, self).__init__(**kwargs)
+
+        self.rich_menu_alias_id = rich_menu_alias_id
+        self.rich_menu_id = rich_menu_id
+
+
+class RichMenuAliasListResponse(Base):
+    """RichMenuAliasListResponse.
+
+    https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list-response
+    """
+
+    def __init__(self, aliases=None, **kwargs):
+        """__init__ method.
+
+        :param aliases: Array of rich menu alias objects
+        :type areas: list[T <= :py:class:`linebot.models.RichMenuAlias`]
+        :param kwargs:
+        """
+        super(RichMenuAliasListResponse, self).__init__(**kwargs)
+        new_aliases = []
+        if aliases:
+            for alias in aliases:
+                new_aliases.append(
+                    self.get_or_new_from_json_dict(alias, RichMenuAlias)
+                )
+        self.aliases = new_aliases
+
+
 class MessageQuotaResponse(Base):
     """MessageQuotaResponse.
 
diff --git a/linebot/models/rich_menu.py b/linebot/models/rich_menu.py
@@ -124,3 +124,23 @@ def __init__(self, x=None, y=None, width=None, height=None, **kwargs):
         self.y = y
         self.width = width
         self.height = height
+
+
+class RichMenuAlias(with_metaclass(ABCMeta, Base)):
+    """RichMenuAlias.
+
+    https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias
+    """
+
+    def __init__(self, rich_menu_alias_id=None, rich_menu_id=None, **kwargs):
+        """__init__ method.
+
+        :param string rich_menu_alias_id: Rich menu alias ID,
+         which can be any ID, unique for each channel.
+        :param string rich_menu_id: The rich menu ID to be associated with the rich menu alias.
+        :param kwargs:
+        """
+        super(RichMenuAlias, self).__init__(**kwargs)
+
+        self.rich_menu_alias_id = rich_menu_alias_id
+        self.rich_menu_id = rich_menu_id
diff --git a/tests/api/test_rich_menu.py b/tests/api/test_rich_menu.py
diff --git a/tests/api/test_rich_menu_alias.py b/tests/api/test_rich_menu_alias.py
