Get number of messages sent #115 (#116)

* Get number of messages sent #115

• Get number of sent reply messages
• Get number of sent push messages
• Get number of sent multicast messages

* Update docs

* Update docs

Author: SombreroElGringo

docs/api-reference/client.md

@@ -46,6 +46,11 @@ class Client {
 
   // Account link
   getLinkToken(userId: string): Promise<string>
+
+  // Get number of messages sent
+  getNumberOfSentReplyMessages(date: string): Promise<NumberOfMessagesSentResponse>
+  getNumberOfSentPushMessages(date: string): Promise<NumberOfMessagesSentResponse>
+  getNumberOfSentMulticastMessages(date: string): Promise<NumberOfMessagesSentResponse>
 }
 ```
 
@@ -362,8 +367,49 @@ It corresponds to the [Cancel default rich menu](https://developers.line.me/en/r
 
 #### `getLinkToken(userId: string): Promise<string>`
 
-Send an HTTP POST request to the `/bot/user/{userId}/linkToken` endpoint, 
+Send an HTTP POST request to the `/bot/user/{userId}/linkToken` endpoint,
 and [issue a link token](https://developers.line.me/en/reference/messaging-api/#issue-link-token) for the user you are attempting to link.
 
-If the request succeeds, a link token will be returned. 
+If the request succeeds, a link token will be returned.
 Link tokens are valid for 10 minutes and can only be used once.
+
+### Get number of messages sent
+
+#### `getNumberOfSentReplyMessages(date: string): Promise<NumberOfMessagesSentResponse>`
+
+Gets the number of messages sent with the `/bot/message/reply` endpoint.
+
+The number of messages retrieved by this operation does not include
+the number of messages sent from LINE@ Manager.
+
+``` js
+client.getNumberOfSentReplyMessages('20191231').then((response) => {
+  console.log(response);
+})
+```
+
+#### `getNumberOfSentPushMessages(date: string): Promise<NumberOfMessagesSentResponse>`
+
+Gets the number of messages sent with the `/bot/message/push` endpoint.
+
+The number of messages retrieved by this operation does not include
+the number of messages sent from LINE@ Manager.
+
+``` js
+client.getNumberOfSentPushMessages('20191231').then((response) => {
+  console.log(response);
+})
+```
+
+#### `getNumberOfSentMulticastMessages(date: string): Promise<NumberOfMessagesSentResponse>`
+
+Gets the number of messages sent with the `/bot/message/multicast` endpoint.
+
+The number of messages retrieved by this operation does not include
+the number of messages sent from LINE@ Manager.
+
+``` js
+client.getNumberOfSentMulticastMessages('20191231').then((response) => {
+  console.log(response);
+})
+```

lib/client.ts

@@ -213,4 +213,34 @@ export default class Client {
       .then(checkJSON)
       .then(res => res.linkToken);
   }
+
+  public getNumberOfSentReplyMessages(
+    date: string,
+  ): Promise<Types.NumberOfMessagesSentResponse> {
+    return this.http
+      .get<Types.NumberOfMessagesSentResponse>(
+        `/message/delivery/reply?date=${date}`,
+      )
+      .then(checkJSON);
+  }
+
+  public getNumberOfSentPushMessages(
+    date: string,
+  ): Promise<Types.NumberOfMessagesSentResponse> {
+    return this.http
+      .get<Types.NumberOfMessagesSentResponse>(
+        `/message/delivery/push?date=${date}`,
+      )
+      .then(checkJSON);
+  }
+
+  public getNumberOfSentMulticastMessages(
+    date: string,
+  ): Promise<Types.NumberOfMessagesSentResponse> {
+    return this.http
+      .get<Types.NumberOfMessagesSentResponse>(
+        `/message/delivery/multicast?date=${date}`,
+      )
+      .then(checkJSON);
+  }
 }

lib/types.ts

@@ -1603,3 +1603,19 @@ export type RichMenu = {
 };
 
 export type RichMenuResponse = { richMenuId: string } & RichMenu;
+
+export type NumberOfMessagesSentResponse = {
+  /**
+   * Status of the counting process. One of the following values is returned:
+   *  - `ready`: You can get the number of messages.
+   *  - `unready`: The message counting process for the date specified in date has not been completed yet.
+   *    Retry your request later. Normally, the counting process is completed within the next day.
+   *  - `out_of_service`: The date specified in date is earlier than March 31, 2018, when the operation of the counting system started.
+   */
+  status: "ready" | "unready" | "out_of_service";
+  /**
+   * The number of messages sent with the Messaging API on the date specified in date.
+   * The response has this property only when the value of status is `ready`.
+   */
+  success?: number;
+};

test/client.spec.ts

@@ -332,4 +332,37 @@ describe("client", () => {
       equal(req.method, "POST");
     });
   });
+
+  it("getNumberOfSentReplyMessages", () => {
+    const date = "20191231";
+    return client.getNumberOfSentReplyMessages(date).then(() => {
+      const req = getRecentReq();
+      equal(req.headers.authorization, "Bearer test_channel_access_token");
+      equal(req.path, "/message/delivery/reply");
+      equal(req.query.date, date);
+      equal(req.method, "GET");
+    });
+  });
+
+  it("getNumberOfSentPushMessages", () => {
+    const date = "20191231";
+    return client.getNumberOfSentPushMessages(date).then(() => {
+      const req = getRecentReq();
+      equal(req.headers.authorization, "Bearer test_channel_access_token");
+      equal(req.path, "/message/delivery/push");
+      equal(req.query.date, date);
+      equal(req.method, "GET");
+    });
+  });
+
+  it("getNumberOfSentMulticastMessages", () => {
+    const date = "20191231";
+    return client.getNumberOfSentMulticastMessages(date).then(() => {
+      const req = getRecentReq();
+      equal(req.headers.authorization, "Bearer test_channel_access_token");
+      equal(req.path, "/message/delivery/multicast");
+      equal(req.query.date, date);
+      equal(req.method, "GET");
+    });
+  });
 });