line-bot-api 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36da29494cce63f76dcb86eeb598ee138cdac97c3e8d1b9a3cd630de77f969e
-  data.tar.gz: e44f44089b1047692f57a95733a7fe73aa6362f45838280eedb8e14286d832ee
+  metadata.gz: 17ed6a316ad332e424e59aa498c8e9ee3bc7062204f191ea3b78e44f74a623b0
+  data.tar.gz: 3a9cc6bbf3cbf658685873f4ea92c501cda4d73d6b6f969ec1620af4d34322ba
 SHA512:
-  metadata.gz: d1f110ae8342f09be0d07bc335ce8f982868d10e26b9bc3eef0c0a60b77b0c1a06dde346eab279250b0c521888978db673a50c6db17d070d1650608fc2fb080a
-  data.tar.gz: 7ab72e341fb0db004519df79eb2ef95e802f54da19fa90087d193c7bd493523fbb1069a70fd1c8b6be07ba7249491f1c4775fca298d8e6c4a97530ce9046279f
+  metadata.gz: 264355c41cc59a4063284d83902639df915df5dfa82b9787d1a4a973dfe4af2d729c171428c12b013e9f87ca6b667e1f8f0c41de5b93843a37040cafb1ea7f54
+  data.tar.gz: '08ef6e828069cf6a8d971450f054fc8c4a662b6244da697138cb33305b38e0a6711e0e75d82fccb9574f88b86e9f7bb8cf7cd13e247bab53c612c989572efc55'

data/lib/line/bot/api/version.rb

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.22.0"
+      VERSION = "1.23.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -166,14 +166,15 @@ module Line
       # @param user_id [String] User Id
       # @param messages [Hash or Array] Message Objects
       # @param headers [Hash] HTTP Headers
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def push_message(user_id, messages, headers: {})
+      def push_message(user_id, messages, headers: {}, payload: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/push'
-        payload = { to: user_id, messages: messages }.to_json
+        payload = payload.merge({ to: user_id, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
@@ -212,15 +213,16 @@ module Line
       # @param to [Array or String] Array of userIds
       # @param messages [Hash or Array] Message Objects
       # @param headers [Hash] HTTP Headers
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def multicast(to, messages, headers: {})
+      def multicast(to, messages, headers: {}, payload: {})
         channel_token_required
 
         to = [to] if to.is_a?(String)
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/multicast'
-        payload = { to: to, messages: messages }.to_json
+        payload = payload.merge({ to: to, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
@@ -331,15 +333,22 @@ module Line
 
       # Get user IDs of who added your LINE Official Account as a friend
       #
-      # @param continuation_token [String] Identifier to return next page
-      #                                   (next property to be included in the response)
+      # @param start [String] Identifier to return next page (next property to be included in the response)
+      # @param limit [Integer] The maximum number of user IDs to retrieve in a single request
       #
       # @return [Net::HTTPResponse]
-      def get_follower_ids(continuation_token = nil)
+      def get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil)
         channel_token_required
 
+        if deprecated_continuation_token
+          warn "continuation_token as the first argument is deprecated. Please use :start instead."
+          start = deprecated_continuation_token
+        end
+
+        params = { start: start, limit: limit }.compact
+
         endpoint_path = "/bot/followers/ids"
-        endpoint_path += "?start=#{continuation_token}" if continuation_token
+        endpoint_path += "?" + URI.encode_www_form(params) unless params.empty?
         get(endpoint, endpoint_path, credentials)
       end
 
@@ -990,6 +999,45 @@ module Line
         put(endpoint, endpoint_path, body.to_json, credentials)
       end
 
+      # Get the per-unit statistics of how users interact with push messages and multicast messages.
+      #
+      # @param unit [String] Case-sensitive name of aggregation unit specified when sending the message.
+      # @param from [String] Start date of aggregation period in UTC+9 with `yyyyMMdd` format
+      # @param to [String] End date of aggregation period in UTC+9 with `yyyyMMdd` format.
+      #
+      # @return [Net::HTTPResponse]
+      def get_statistics_per_unit(unit:, from:, to:)
+        channel_token_required
+
+        params = {customAggregationUnit: unit, from: from, to: to}
+        endpoint_path = "/bot/insight/message/event/aggregation?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the number of aggregation units used this month.
+      #
+      # @return [Net::HTTPResponse]
+      def get_aggregation_info
+        channel_token_required
+
+        endpoint_path = "/bot/message/aggregation/info"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the name list of units used this month for statistics aggregation.
+      #
+      # @param limit [Integer] Maximum number of aggregation units per request. Maximum: 100, Default: 100.
+      # @param start [String] Value of the continuation token found in the `next` property of the JSON object returned in the response.
+      #
+      # @return [Net::HTTPResponse]
+      def get_aggregation_list(limit: nil, start: nil)
+        channel_token_required
+
+        params = {limit: limit, start: start}.compact
+        endpoint_path = "/bot/message/aggregation/list?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Fetch data, get content of specified URL.
       #
       # @param endpoint_base [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable