Add an API that gets the target limit for additional messages

Author: imasahiro

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

@@ -28,6 +28,7 @@
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
+import com.linecorp.bot.model.response.MessageQuotaResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -81,6 +82,15 @@ public interface LineMessagingClient {
      */
     CompletableFuture<MessageContentResponse> getMessageContent(String messageId);
 
+    /**
+     * Gets the target limit for additional messages in the current month. The number of messages retrieved by
+     * this operation includes the number of messages sent from LINE Official Account Manager.
+     * Set a target limit with LINE Official Account Manager. For the procedures, refer to the LINE Official
+     * Account Manager manual.
+     * Note: LINE@ accounts cannot call this API endpoint.
+     */
+    CompletableFuture<MessageQuotaResponse> getMessageQuota();
+
     /**
      * 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

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

@@ -30,6 +30,7 @@
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
+import com.linecorp.bot.model.response.MessageQuotaResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -83,6 +84,11 @@ public CompletableFuture<MessageContentResponse> getMessageContent(final String
         return toMessageContentResponseFuture(retrofitImpl.getMessageContent(messageId));
     }
 
+    @Override
+    public CompletableFuture<MessageQuotaResponse> getMessageQuota() {
+        return toFuture(retrofitImpl.getMessageQuota());
+    }
+
     @Override
     public CompletableFuture<QuotaConsumptionResponse> getMessageQuotaConsumption() {
         return toFuture(retrofitImpl.getMessageQuotaConsumption());

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

@@ -25,6 +25,7 @@
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
+import com.linecorp.bot.model.response.MessageQuotaResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -83,6 +84,16 @@ interface LineMessagingService {
     @GET("v2/bot/message/{messageId}/content")
     Call<ResponseBody> getMessageContent(@Path("messageId") String messageId);
 
+    /**
+     * Gets the target limit for additional messages in the current month. The number of messages retrieved by
+     * this operation includes the number of messages sent from LINE Official Account Manager.
+     * Set a target limit with LINE Official Account Manager. For the procedures, refer to the LINE Official
+     * Account Manager manual.
+     * Note: LINE@ accounts cannot call this API endpoint.
+     */
+    @GET("v2/bot/message/quota")
+    Call<MessageQuotaResponse> getMessageQuota();
+
     /**
      * 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

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

@@ -45,6 +45,8 @@
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
+import com.linecorp.bot.model.response.MessageQuotaResponse;
+import com.linecorp.bot.model.response.MessageQuotaResponse.QuotaType;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse.Status;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
@@ -138,6 +140,32 @@ public void getMessageContentTest() throws Exception {
         assertThat(contentResponse.getMimeType()).isEqualTo("image/jpeg");
     }
 
+    @Test
+    public void getMessageQuota() {
+        whenCall(retrofitMock.getMessageQuota(),
+                 MessageQuotaResponse.builder()
+                                     .type(QuotaType.none)
+                                     .build());
+
+        MessageQuotaResponse response = target.getMessageQuota().join();
+        verify(retrofitMock, only()).getMessageQuota();
+        assertThat(response.getType()).isEqualTo(QuotaType.none);
+    }
+
+    @Test
+    public void getMessageQuota_limited() {
+        whenCall(retrofitMock.getMessageQuota(),
+                 MessageQuotaResponse.builder()
+                                     .type(QuotaType.limited)
+                                     .value(100)
+                                     .build());
+
+        MessageQuotaResponse response = target.getMessageQuota().join();
+        verify(retrofitMock, only()).getMessageQuota();
+        assertThat(response.getType()).isEqualTo(QuotaType.limited);
+        assertThat(response.getValue()).isEqualTo(100);
+    }
+
     @Test
     public void getMessageQuotaConsumption() {
         whenCall(retrofitMock.getMessageQuotaConsumption(),

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

@@ -0,0 +1,57 @@
+/*
+ * 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.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.response.MessageQuotaResponse.MessageQuotaResponseBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = MessageQuotaResponseBuilder.class)
+public class MessageQuotaResponse {
+    /**
+     * Indicates whether a target limit is set or not.
+     */
+    QuotaType type;
+
+    /**
+     * The target limit for additional messages in the current month. This property is set when the type
+     * property has a value of limited.
+     */
+    long value;
+
+    public enum QuotaType {
+        /**
+         * Indicates that a target limit is not set.
+         */
+        none,
+
+        /**
+         * Indicates that a target limit is set.
+         */
+        limited
+    }
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class MessageQuotaResponseBuilder {
+    }
+}