line-bot-api 1.22.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36da29494cce63f76dcb86eeb598ee138cdac97c3e8d1b9a3cd630de77f969e
-  data.tar.gz: e44f44089b1047692f57a95733a7fe73aa6362f45838280eedb8e14286d832ee
+  metadata.gz: d2b1b0e62ac703e48b3153c9214d0de1f7df4a394b485b1c1daf142744467ee4
+  data.tar.gz: 372be3bfd378274cc8f465ff1a16b41842110b9755d22a3bcfb5e4bd4323a6af
 SHA512:
-  metadata.gz: d1f110ae8342f09be0d07bc335ce8f982868d10e26b9bc3eef0c0a60b77b0c1a06dde346eab279250b0c521888978db673a50c6db17d070d1650608fc2fb080a
-  data.tar.gz: 7ab72e341fb0db004519df79eb2ef95e802f54da19fa90087d193c7bd493523fbb1069a70fd1c8b6be07ba7249491f1c4775fca298d8e6c4a97530ce9046279f
+  metadata.gz: b56beefbf79c9db2154e97be3e9cd82bcdea9833a17fda92e0f38c4ada37c05394ec8942e18190e8bcbbbb2566ba28a83ee81fee71bbdeb181b6f0e8326d5074
+  data.tar.gz: 2da6d7329e36b8da62e20da99669273ff12f1478e3c6f13d892b98cfc75970b62acdc47fbdecb689066e2450574179c6c224dcf305cfbaccf754ae0872945857

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

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

data/lib/line/bot/client.rb

@@ -145,6 +145,40 @@ module Line
         post(oauth_endpoint, endpoint_path, payload, headers)
       end
 
+      # Verify ID token
+      #
+      # @param id_token [String] ID token
+      # @param nonce [String] Expected nonce value. Use the nonce value provided in the authorization request. Omit if the nonce value was not specified in the authorization request.
+      # @param user_id [String] Expected user ID.
+      #
+      # @return [Net::HTTPResponse]
+      def verify_id_token(id_token, nonce: nil, user_id: nil)
+        channel_id_required
+
+        endpoint_path = '/oauth2/v2.1/verify'
+        payload = URI.encode_www_form({
+          client_id: channel_id,
+          id_token: id_token,
+          nonce: nonce,
+          user_id: user_id
+        }.compact)
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        post(oauth_endpoint, endpoint_path, payload, headers)
+      end
+
+      # Verify access token v2.1
+      #
+      # @param access_token [String] access token
+      #
+      # @return [Net::HTTPResponse]
+      def verify_access_token(access_token)
+        payload = URI.encode_www_form(
+          access_token: access_token
+        )
+        endpoint_path = "/oauth2/v2.1/verify?#{payload}"
+        get(oauth_endpoint, endpoint_path)
+      end
+
       # Get all valid channel access token key IDs v2.1
       #
       # @param jwt [String]
@@ -161,19 +195,33 @@ module Line
         get(oauth_endpoint, endpoint_path, headers)
       end
 
+      # Get user profile by access token
+      #
+      # @param access_token [String] access token
+      #
+      # @return [Net::HTTPResponse]
+      def get_profile_by_access_token(access_token)
+        headers = {
+          "Authorization" => "Bearer #{access_token}",
+        }
+        endpoint_path = "/v2/profile"
+        get(oauth_endpoint, endpoint_path, headers)
+      end
+
       # Push messages to a user using user_id.
       #
       # @param user_id [String] User Id
-      # @param messages [Hash or Array] Message Objects
+      # @param messages [Hash, 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
 
@@ -195,7 +243,7 @@ module Line
       #   client.reply_message(event['replyToken'], messages)
       #
       # @param token [String] Reply Token
-      # @param messages [Hash or Array] Message Objects
+      # @param messages [Hash, Array] Message Objects
       # @return [Net::HTTPResponse]
       def reply_message(token, messages)
         channel_token_required
@@ -209,24 +257,25 @@ module Line
 
       # Send messages to multiple users using userIds.
       #
-      # @param to [Array or String] Array of userIds
-      # @param messages [Hash or Array] Message Objects
+      # @param to [Array, String] Array of userIds
+      # @param messages [Hash, 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
 
       # Send messages to all friends.
       #
-      # @param messages [Hash or Array] Message Objects
+      # @param messages [Hash, Array] Message Objects
       # @param headers [Hash] HTTP Headers
       #
       # @return [Net::HTTPResponse]
@@ -245,7 +294,7 @@ module Line
       # API Documentation is here.
       # https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
       #
-      # @param messages [Hash or Array]
+      # @param messages [Hash, Array]
       # @param recipient [Hash]
       # @param filter [Hash]
       # @param limit [Hash]
@@ -331,15 +380,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
 
@@ -491,6 +547,18 @@ module Line
         post(endpoint, endpoint_path, rich_menu.to_json, credentials)
       end
 
+      # Validate a rich menu object
+      #
+      # @param rich_menu [Hash] The rich menu represented as a rich menu object
+      #
+      # @return [Net::HTTPResponse]
+      def validate_rich_menu_object(rich_menu)
+        channel_token_required
+
+        endpoint_path = '/bot/richmenu/validate'
+        post(endpoint, endpoint_path, rich_menu.to_json, credentials)
+      end
+
       # Delete a rich menu
       #
       # @param rich_menu_id [String] ID of an uploaded rich menu
@@ -990,6 +1058,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]
@@ -1006,7 +1113,7 @@ module Line
       #
       # @param endpoint_base [String]
       # @param endpoint_path [String]
-      # @param payload [String or NilClass]
+      # @param payload [String, NilClass]
       # @param headers [Hash]
       #
       # @return [Net::HTTPResponse]
@@ -1019,7 +1126,7 @@ module Line
       #
       # @param endpoint_base [String]
       # @param endpoint_path [String]
-      # @param payload [String or NilClass]
+      # @param payload [String, NilClass]
       # @param headers [Hash]
       #
       # @return [Net::HTTPResponse]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.25.0
 platform: ruby
 authors:
 - LINE Corporation
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -106,7 +106,7 @@ homepage: https://github.com/line/line-bot-sdk-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: SDK of the LINE Messaging API
 test_files: []