fix richmenu alias api type & add postback params (#294)

Author: xingoxu

docs/api-reference/client.md

@@ -50,11 +50,11 @@ class Client {
   getRichMenu(richMenuId: string): Promise<RichMenuResponse>
   createRichMenu(richMenu: RichMenu): Promise<string>
   deleteRichMenu(richMenuId: string): Promise<any>
-  getRichMenuAliasList(): Promise<any>
-  getRichMenuAlias(richMenuAliasId: string): Promise<any>
-  createRichMenuAlias(richMenuId: string, richMenuAliasId: string): Promise<any>
-  deleteRichMenuAlias(richMenuAliasId: string): Promise<any>
-  updateRichMenuAlias(richMenuAliasId: string, richMenuId: string): Promise<any>
+  getRichMenuAliasList(): Promise<Types.GetRichMenuAliasListResponse>
+  getRichMenuAlias(richMenuAliasId: string): Promise<Types.GetRichMenuAliasResponse>>
+  createRichMenuAlias(richMenuId: string, richMenuAliasId: string): Promise<{}>
+  deleteRichMenuAlias(richMenuAliasId: string): Promise<{}>
+  updateRichMenuAlias(richMenuAliasId: string, richMenuId: string): Promise<{}>
   getRichMenuIdOfUser(userId: string): Promise<string>
   linkRichMenuToUser(userId: string, richMenuId: string): Promise<any>
   unlinkRichMenuFromUser(userId: string, richMenuId: string): Promise<any>

lib/client.ts

@@ -285,15 +285,17 @@ export default class Client {
     return this.http.delete(`${MESSAGING_API_PREFIX}/richmenu/${richMenuId}`);
   }
 
-  public async getRichMenuAliasList(): Promise<any> {
-    const res = await this.http.get<any>(
+  public async getRichMenuAliasList(): Promise<Types.GetRichMenuAliasListResponse> {
+    const res = await this.http.get<Types.GetRichMenuAliasListResponse>(
       `${MESSAGING_API_PREFIX}/richmenu/alias/list`,
     );
     return ensureJSON(res);
   }
 
-  public async getRichMenuAlias(richMenuAliasId: string): Promise<any> {
-    const res = await this.http.get<any>(
+  public async getRichMenuAlias(
+    richMenuAliasId: string,
+  ): Promise<Types.GetRichMenuAliasResponse> {
+    const res = await this.http.get<Types.GetRichMenuAliasResponse>(
       `${MESSAGING_API_PREFIX}/richmenu/alias/${richMenuAliasId}`,
     );
     return ensureJSON(res);
@@ -302,8 +304,8 @@ export default class Client {
   public async createRichMenuAlias(
     richMenuId: string,
     richMenuAliasId: string,
-  ): Promise<any> {
-    const res = await this.http.post<any>(
+  ): Promise<{}> {
+    const res = await this.http.post<{}>(
       `${MESSAGING_API_PREFIX}/richmenu/alias`,
       {
         richMenuId,
@@ -313,16 +315,17 @@ export default class Client {
     return ensureJSON(res);
   }
 
-  public async deleteRichMenuAlias(richMenuAliasId: string): Promise<any> {
-    return this.http.delete(
+  public async deleteRichMenuAlias(richMenuAliasId: string): Promise<{}> {
+    const res = this.http.delete<{}>(
       `${MESSAGING_API_PREFIX}/richmenu/alias/${richMenuAliasId}`,
     );
+    return ensureJSON(res);
   }
 
   public async updateRichMenuAlias(
     richMenuAliasId: string,
     richMenuId: string,
-  ): Promise<any> {
+  ): Promise<{}> {
     const res = await this.http.put<{}>(
       `${MESSAGING_API_PREFIX}/richmenu/alias/${richMenuAliasId}`,
       {

lib/types.ts

@@ -508,28 +508,43 @@ export type StickerEventMessage = {
 
 export type Postback = {
   data: string;
+  params?: DateTimePostback | RichMenuSwitchPostback;
+};
+
+/**
+ * Object with the date and time selected by a user through a
+ * [datetime picker action](https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action).
+ * Only returned for postback actions via a
+ * [datetime picker action](https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action).
+ * The `full-date`, `time-hour`, and `time-minute` formats follow the
+ * [RFC3339 protocol](https://www.ietf.org/rfc/rfc3339.txt).
+ */
+type DateTimePostback = {
   /**
-   * Object with the date and time selected by a user through a
-   * [datetime picker action](https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action).
-   * Only returned for postback actions via a
-   * [datetime picker action](https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action).
-   * The `full-date`, `time-hour`, and `time-minute` formats follow the
-   * [RFC3339 protocol](https://www.ietf.org/rfc/rfc3339.txt).
+   * Date selected by user. Only included in the `date` mode.
    */
-  params?: {
-    /**
-     * Date selected by user. Only included in the `date` mode.
-     */
-    date?: string;
-    /**
-     * Time selected by the user. Only included in the `time` mode.
-     */
-    time?: string;
-    /**
-     * Date and time selected by the user. Only included in the `datetime` mode.
-     */
-    datetime?: string;
-  };
+  date?: string;
+  /**
+   * Time selected by the user. Only included in the `time` mode.
+   */
+  time?: string;
+  /**
+   * Date and time selected by the user. Only included in the `datetime` mode.
+   */
+  datetime?: string;
+};
+
+/**
+ * Object with rich menu alias ID selected by user via rich menu switch action.
+ * https://developers.line.biz/en/reference/messaging-api/#postback-params-object-for-richmenu-switch-action
+ */
+type RichMenuSwitchPostback = {
+  newRichMenuAliasId: string;
+  status:
+    | "SUCCESS"
+    | "RICHMENU_ALIAS_ID_NOTFOUND"
+    | "RICHMENU_NOTFOUND"
+    | "FAILED";
 };
 
 /**
@@ -2657,6 +2672,15 @@ export type MembersCountResponse = {
   count: number;
 };
 
+export type GetRichMenuAliasResponse = {
+  richMenuAliasId: string;
+  richMenuId: string;
+};
+
+export type GetRichMenuAliasListResponse = {
+  aliases: GetRichMenuAliasResponse[];
+};
+
 /**
  * Response body of get bot info.
  *