Merge pull request #338 from imasahiro/issue-332-1

Supports an API to get number of messages sent this month

Author: Junpei Koyama

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClient.java

@@ -29,6 +29,7 @@
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
+import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
@@ -80,6 +81,15 @@ public interface LineMessagingClient {
      */
     CompletableFuture<MessageContentResponse> getMessageContent(String messageId);
 
+    /**
+     * Gets the number of messages sent in the current month. The number of messages retrieved by this
+     * operation includes the number of messages sent from LINE Official Account Manager. The number of
+     * messages retrieved by this operation is approximate. To get the correct number of sent messages,
+     * use LINE Official Account Manager or execute API operations for getting the number of sent messages.
+     * Note: LINE@ accounts cannot call this API endpoint.
+     */
+    CompletableFuture<QuotaConsumptionResponse> getMessageQuotaConsumption();
+
     /**
      * Gets the number of messages sent with the /bot/message/reply endpoint. Note that the number of messages
      * retrieved by this operation does not include the number of messages sent from LINE@ Manager.
@@ -107,6 +117,19 @@ public interface LineMessagingClient {
      */
     CompletableFuture<NumberOfMessagesResponse> getNumberOfSentMulticastMessages(String date);
 
+    /**
+     * Gets the number of messages sent with the {@code "/bot/message/broadcast"} endpoint. The number of
+     * messages retrieved by this operation does not include the number of messages sent from LINE Official
+     * Account Manager.
+     * Note: LINE@ accounts cannot call this API endpoint. Please migrate it to a LINE official account.
+     * For more information, see <a href="https://developers.line.biz/en/docs/messaging-api/migrating-line-at/">
+     * Migration of LINE@ accounts</a>.
+     *
+     * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
+     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     */
+    CompletableFuture<NumberOfMessagesResponse> getNumberOfSentBroadcastMessages(String date);
+
     /**
      * Get user profile information.
      *

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClientImpl.java

@@ -31,6 +31,7 @@
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
+import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
 import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
@@ -82,6 +83,11 @@ public CompletableFuture<MessageContentResponse> getMessageContent(final String
         return toMessageContentResponseFuture(retrofitImpl.getMessageContent(messageId));
     }
 
+    @Override
+    public CompletableFuture<QuotaConsumptionResponse> getMessageQuotaConsumption() {
+        return toFuture(retrofitImpl.getMessageQuotaConsumption());
+    }
+
     @Override
     public CompletableFuture<NumberOfMessagesResponse> getNumberOfSentReplyMessages(String date) {
         return toFuture(retrofitImpl.getNumberOfSentReplyMessages(date));
@@ -97,6 +103,11 @@ public CompletableFuture<NumberOfMessagesResponse> getNumberOfSentMulticastMessa
         return toFuture(retrofitImpl.getNumberOfSentMulticastMessages(date));
     }
 
+    @Override
+    public CompletableFuture<NumberOfMessagesResponse> getNumberOfSentBroadcastMessages(String date) {
+        return toFuture(retrofitImpl.getNumberOfSentBroadcastMessages(date));
+    }
+
     @Override
     public CompletableFuture<UserProfileResponse> getProfile(final String userId) {
         return toFuture(retrofitImpl.getProfile(userId));

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingService.java

@@ -26,6 +26,7 @@
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
+import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
 import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
@@ -82,6 +83,16 @@ interface LineMessagingService {
     @GET("v2/bot/message/{messageId}/content")
     Call<ResponseBody> getMessageContent(@Path("messageId") String messageId);
 
+    /**
+     * Gets the number of messages sent in the current month. The number of messages retrieved by this
+     * operation includes the number of messages sent from LINE Official Account Manager. The number of
+     * messages retrieved by this operation is approximate. To get the correct number of sent messages,
+     * use LINE Official Account Manager or execute API operations for getting the number of sent messages.
+     * Note: LINE@ accounts cannot call this API endpoint.
+     */
+    @GET("v2/bot/message/quota/consumption")
+    Call<QuotaConsumptionResponse> getMessageQuotaConsumption();
+
     /**
      * Gets the number of messages sent with the /bot/message/reply endpoint. Note that the number of messages
      * retrieved by this operation does not include the number of messages sent from LINE@ Manager.
@@ -112,6 +123,20 @@ interface LineMessagingService {
     @GET("v2/bot/message/delivery/multicast")
     Call<NumberOfMessagesResponse> getNumberOfSentMulticastMessages(@Query("date") String date);
 
+    /**
+     * Gets the number of messages sent with the {@code "/bot/message/broadcast"} endpoint. The number of
+     * messages retrieved by this operation does not include the number of messages sent from LINE Official
+     * Account Manager.
+     * Note: LINE@ accounts cannot call this API endpoint. Please migrate it to a LINE official account.
+     * For more information, see <a href="https://developers.line.biz/en/docs/messaging-api/migrating-line-at/">
+     * Migration of LINE@ accounts</a>.
+     *
+     * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
+     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     */
+    @GET("v2/bot/message/delivery/broadcast")
+    Call<NumberOfMessagesResponse> getNumberOfSentBroadcastMessages(String date);
+
     /**
      * Method for Retrofit.
      *

line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplTest.java

@@ -47,6 +47,7 @@
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse.Status;
+import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
 import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
@@ -137,6 +138,16 @@ public void getMessageContentTest() throws Exception {
         assertThat(contentResponse.getMimeType()).isEqualTo("image/jpeg");
     }
 
+    @Test
+    public void getMessageQuotaConsumption() {
+        whenCall(retrofitMock.getMessageQuotaConsumption(),
+                 new QuotaConsumptionResponse(1024));
+
+        QuotaConsumptionResponse response = target.getMessageQuotaConsumption().join();
+        verify(retrofitMock, only()).getMessageQuotaConsumption();
+        assertThat(response.getTotalUsage()).isEqualTo(1024);
+    }
+
     @Test
     public void getNumberOfSentReplyMessages() {
         whenCall(retrofitMock.getNumberOfSentReplyMessages(any()),
@@ -170,6 +181,17 @@ public void getNumberOfSentMulticastMessages() {
         assertThat(response.getSuccess()).isEqualTo(1024);
     }
 
+    @Test
+    public void getNumberOfSentBroadcastMessages() {
+        whenCall(retrofitMock.getNumberOfSentBroadcastMessages(any()),
+                 new NumberOfMessagesResponse(Status.Ready, 1024));
+
+        NumberOfMessagesResponse response = target.getNumberOfSentBroadcastMessages("20181231").join();
+        verify(retrofitMock, only()).getNumberOfSentBroadcastMessages("20181231");
+        assertThat(response.getStatus()).isEqualTo(Status.Ready);
+        assertThat(response.getSuccess()).isEqualTo(1024);
+    }
+
     @Test
     public void getProfileTest() throws Exception {
         final UserProfileResponse mockUserProfileResponse =

line-bot-model/src/main/java/com/linecorp/bot/model/response/QuotaConsumptionResponse.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.linecorp.bot.model.response;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@Value
+@AllArgsConstructor(onConstructor = @__(@JsonCreator))
+public class QuotaConsumptionResponse {
+    long totalUsage;
+}