Support Messaging API update for June 2020 (#228)

* fix #227

Author: cm-nakamura-yuki

docs/api-reference/client.md

@@ -33,11 +33,14 @@ class Client {
   getProfile(userId: string): Promise<Profile>
 
   // Group
+  getGroupSummary(groupId: string): Promise<GroupSummary>
+  getGroupMembersCount(groupId: string): Promise<MemberCountResponse>
   getGroupMemberProfile(groupId: string, userId: string): Promise<Profile>
   getGroupMemberIds(groupId: string): Promise<string[]>
   leaveGroup(groupId: string): Promise<any>
 
   // Room
+  getRoomMembersCount(roomId: string): Promise<MemberCountResponse>
   getRoomMemberProfile(roomId: string, userId: string): Promise<Profile>
   getRoomMemberIds(roomId: string): Promise<string[]>
   leaveRoom(roomId: string): Promise<any>
@@ -269,6 +272,29 @@ client.getProfile('user_id').then((profile) => {
 ```
 
 ### Group
+#### `getGroupSummary(groupId: string): Promise<GroupSummary>`
+
+It corresponds to the [Group Summary](https://developers.line.biz/en/reference/messaging-api/#get-group-summary) API.
+
+The argument is a group ID.
+
+``` js
+client.getGroupSummary('group_id').then((summary) => {
+  console.log(summary)
+})
+```
+
+#### `getGroupMembersCount(groupId: string): Promise<MemberCountResponse>`
+
+It corresponds to the [Group Members Count](https://developers.line.biz/en/reference/messaging-api/#get-members-group-count) API.
+
+The argument is a group ID.
+
+``` js
+client.getGroupMembersCount('group_id').then((count) => {
+  console.log(count)
+})
+```
 
 #### `getGroupMemberProfile(groupId: string, userId: string): Promise<Profile>`
 
@@ -308,6 +334,17 @@ client.leaveGroup('group_id')
 ```
 
 ### Room
+#### `getRoomMembersCount(roomId: string): Promise<MembersCountResponse>`
+
+It corresponds to the [Room Members Count](https://developers.line.biz/en/reference/messaging-api/#get-members-room-count) API.
+
+The argument is a room ID.
+
+``` js
+client.getRoomMembersCount('room_id').then((count) => {
+  console.log(count)
+})
+```
 
 #### `getRoomMemberProfile(roomId: string, userId: string): Promise<Profile>`
 

lib/client.ts

@@ -200,6 +200,33 @@ export default class Client {
     return this.getChatMemberIds("room", roomId);
   }
 
+  public async getGroupMembersCount(
+    groupId: string,
+  ): Promise<Types.MembersCountResponse> {
+    const groupMemberCount = await this.http.get<Types.MembersCountResponse>(
+      `${MESSAGING_API_PREFIX}/group/${groupId}/members/count`,
+    );
+    return ensureJSON(groupMemberCount);
+  }
+
+  public async getRoomMembersCount(
+    roomId: string,
+  ): Promise<Types.MembersCountResponse> {
+    const roomMemberCount = await this.http.get<Types.MembersCountResponse>(
+      `${MESSAGING_API_PREFIX}/room/${roomId}/members/count`,
+    );
+    return ensureJSON(roomMemberCount);
+  }
+
+  public async getGroupSummary(
+    groupId: string,
+  ): Promise<Types.GroupSummaryResponse> {
+    const groupSummary = await this.http.get<Types.GroupSummaryResponse>(
+      `${MESSAGING_API_PREFIX}/group/${groupId}/summary`,
+    );
+    return ensureJSON(groupSummary);
+  }
+
   public async getMessageContent(messageId: string): Promise<Readable> {
     return this.http.getStream(
       `${DATA_API_PREFIX}/message/${messageId}/content`,

lib/types.ts

@@ -2425,3 +2425,24 @@ export type AudienceGroup = _AudienceGroup & {
 export type AudienceGroups = _AudienceGroup[];
 
 export type AudienceGroupAuthorityLevel = "PUBLIC" | "PRIVATE";
+
+/**
+ * Response body of get group summary.
+ *
+ * @see [Get group summary](https://developers.line.biz/ja/reference/messaging-api/#get-group-summary)
+ */
+export type GroupSummaryResponse = {
+  groupId: string;
+  groupName: string;
+  pictureUrl: string;
+};
+
+/**
+ * Response body of get members in group count and get members in room count.
+ *
+ * @see [Get members in group count](https://developers.line.biz/en/reference/messaging-api/#get-members-group-count)
+ * @see [Get members in room count](https://developers.line.biz/en/reference/messaging-api/#get-members-room-count)
+ */
+export type MembersCountResponse = {
+  count: number;
+};

test/client.spec.ts

@@ -361,6 +361,36 @@ describe("client", () => {
     ]);
   });
 
+  it("getGroupMembersCount", async () => {
+    const groupId = "groupId";
+    const scope = mockGet(
+      MESSAGING_API_PREFIX,
+      `/group/${groupId}/members/count`,
+    );
+
+    await client.getGroupMembersCount(groupId);
+    equal(scope.isDone(), true);
+  });
+
+  it("getRoomMembersCount", async () => {
+    const roomId = "roomId";
+    const scope = mockGet(
+      MESSAGING_API_PREFIX,
+      `/room/${roomId}/members/count`,
+    );
+
+    await client.getRoomMembersCount(roomId);
+    equal(scope.isDone(), true);
+  });
+
+  it("getGroupSummary", async () => {
+    const groupId = "groupId";
+    const scope = mockGet(MESSAGING_API_PREFIX, `/group/${groupId}/summary`);
+
+    await client.getGroupSummary(groupId);
+    equal(scope.isDone(), true);
+  });
+
   it("getMessageContent", async () => {
     const scope = mockGet(DATA_API_PREFIX, "/message/test_message_id/content");