line-bot-api 1.14.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d265a003f523763063653537df89119ee79f3fc1c987640fbd78090d081045ca
-  data.tar.gz: a5fd82fa00d302b4b804432b87fde84034492e7245a9665d4ab9f480a0fd12df
+  metadata.gz: a8864bff59b1e7a50a3f63bd2aef939319c9731b9facbb4116d0aa4bb7894101
+  data.tar.gz: df898ac583f61824837b3e92f98867be4aafb74fbdc5b89ad094edf164e098ee
 SHA512:
-  metadata.gz: 6d89224a7a2eae22ff20ff38e08d472d595500356b54c6836cdf0af9e7345edeb42c6a6fcfb3c4500402c76635cd8e4d3e932526a0718e403fc5fa2d858b2d48
-  data.tar.gz: f2de6de836fa6f95a93f98acb88021a1206506dfebabd7f734c38747b6bbb141c59d3bebd6b7c2cc3743564dc498b929f700bdf33dada17d65a1953972dbe9eb
+  metadata.gz: 921d2f1896c8c60759eeccbd3ca40a57bd2d401558a1d5d5bedceb967f00d1be6d56b1d886987e7883cd9b2b43541b555ec895759607235265accd787aed6653
+  data.tar.gz: 3a50ac3a250aa087eb7285a7a1144e4f64c15443acaca6d28e747f979198902ef887bc589fad8e31aa74fb526820ebc3eff1e4413f83460b227caa327021e172

data/lib/line/bot/api.rb

@@ -19,6 +19,7 @@ module Line
     module API
       DEFAULT_ENDPOINT = "https://api.line.me/v2"
       DEFAULT_BLOB_ENDPOINT = "https://api-data.line.me/v2"
+      DEFAULT_LIFF_ENDPOINT = "https://api.line.me/liff/v1"
 
       DEFAULT_HEADERS = {
         'Content-Type' => 'application/json; charset=UTF-8',

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

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.14.1"
+      VERSION = "1.19.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -66,6 +66,10 @@ module Line
                          end
       end
 
+      def liff_endpoint
+        @liff_endpoint ||= API::DEFAULT_LIFF_ENDPOINT
+      end
+
       # @return [Hash]
       def credentials
         {
@@ -106,15 +110,16 @@ module Line
       #
       # @param user_id [String] User Id
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
       # @return [Net::HTTPResponse]
-      def push_message(user_id, messages)
+      def push_message(user_id, messages, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/push'
         payload = { to: user_id, messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Reply messages to a user using replyToken.
@@ -151,8 +156,9 @@ module Line
       #
       # @param to [Array or String] Array of userIds
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
       # @return [Net::HTTPResponse]
-      def multicast(to, messages)
+      def multicast(to, messages, headers: {})
         channel_token_required
 
         to = [to] if to.is_a?(String)
@@ -160,21 +166,23 @@ module Line
 
         endpoint_path = '/bot/message/multicast'
         payload = { to: to, messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Send messages to all friends.
       #
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
+      #
       # @return [Net::HTTPResponse]
-      def broadcast(messages)
+      def broadcast(messages, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/broadcast'
         payload = { messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Narrowcast messages to users
@@ -186,9 +194,10 @@ module Line
       # @param recipient [Hash]
       # @param filter [Hash]
       # @param limit [Hash]
+      # @param headers [Hash] HTTP Headers
       #
       # @return [Net::HTTPResponse]
-      def narrowcast(messages, recipient: nil, filter: nil, limit: nil)
+      def narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
@@ -200,7 +209,7 @@ module Line
           filter: filter,
           limit: limit
         }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       def leave_group(group_id)
@@ -265,6 +274,20 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
+      # 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)
+      #
+      # @return [Net::HTTPResponse]
+      def get_follower_ids(continuation_token = nil)
+        channel_token_required
+
+        endpoint_path = "/bot/followers/ids"
+        endpoint_path += "?start=#{continuation_token}" if continuation_token
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Get user IDs of a group
       #
       # @param group_id [String] Group's identifier
@@ -295,6 +318,42 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
+      # Gets the group ID, group name, and group icon URL of a group where the LINE Official Account is a member.
+      #
+      # @param group_id [String] Group's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_group_summary(group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/group/#{group_id}/summary"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets the user IDs of the members of a group that the bot is in.
+      #
+      # @param group_id [String] Group's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_group_members_count(group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/group/#{group_id}/members/count"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets the count of members in a room.
+      #
+      # @param room_id [String] Room's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_room_members_count(room_id)
+        channel_token_required
+
+        endpoint_path = "/bot/room/#{room_id}/members/count"
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Get a list of all uploaded rich menus
       #
       # @return [Net::HTTPResponse]
@@ -590,6 +649,232 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
+      # Gets a bot's basic information.
+      #
+      # @return [Net::HTTPResponse]
+      def get_bot_info
+        channel_token_required
+
+        endpoint_path = '/bot/info'
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets information on a webhook endpoint.
+      #
+      # @return [Net::HTTPResponse]
+      def get_webhook_endpoint
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/endpoint'
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Sets the webhook endpoint URL.
+      #
+      # @param webhook_endpoint [String]
+      #
+      # @return [Net::HTTPResponse]
+      def set_webhook_endpoint(webhook_endpoint)
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/endpoint'
+        body = {endpoint: webhook_endpoint}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      # Checks if the configured webhook endpoint can receive a test webhook event.
+      #
+      # @param webhook_endpoint [String] options
+      #
+      # @return [Net::HTTPResponse]
+      def test_webhook_endpoint(webhook_endpoint = nil)
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/test'
+        body = if webhook_endpoint.nil?
+                 {}
+               else
+                 {endpoint: webhook_endpoint}
+               end
+        post(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      def get_liff_apps
+        channel_token_required
+
+        endpoint_path = '/apps'
+        get(liff_endpoint, endpoint_path, credentials)
+      end
+
+      def create_liff_app(app)
+        channel_token_required
+
+        endpoint_path = '/apps'
+        post(liff_endpoint, endpoint_path, app.to_json, credentials)
+      end
+
+      def update_liff_app(liff_id, app)
+        channel_token_required
+
+        endpoint_path = "/apps/#{liff_id}"
+        put(liff_endpoint, endpoint_path, app.to_json, credentials)
+      end
+
+      def delete_liff_app(liff_id)
+        channel_token_required
+
+        endpoint_path = "/apps/#{liff_id}"
+        delete(liff_endpoint, endpoint_path, credentials)
+      end
+
+      # Create an audience group by uploading user_ids
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_user_id_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/upload'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Update an audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def update_user_id_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/upload'
+        put(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Create an audience group of users that clicked a URL in a message sent in the past
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_click_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/click'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Create an audience group of users that opened a message sent in the past
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_impression_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/imp'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Rename an existing audience group
+      #
+      # @param audience_group_id [Integer]
+      # @param description [String]
+      #
+      # @return [Net::HTTPResponse]
+      def rename_audience(audience_group_id, description)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}/updateDescription"
+        body = {description: description}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      # Delete an existing audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#delete-audience-group
+      #
+      # @param audience_group_id [Integer]
+      #
+      # @return [Net::HTTPResponse]
+      def delete_audience(audience_group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}"
+        delete(endpoint, endpoint_path, credentials)
+      end
+
+      # Get audience group data
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-audience-group
+      #
+      # @param audience_group_id [Integer]
+      #
+      # @return [Net::HTTPResponse]
+      def get_audience(audience_group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get data for more than one audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-audience-groups
+      #
+      # @param params [Hash] key name `page` is required
+      #
+      # @return [Net::HTTPResponse]
+      def get_audiences(params)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/list?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the authority level of the audience
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-authority-level
+      #
+      # @return [Net::HTTPResponse]
+      def get_audience_authority_level
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/authorityLevel"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Change the authority level of the audience
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#change-authority-level
+      #
+      # @param authority_level [String] value must be `PUBLIC` or `PRIVATE`
+      #
+      # @return [Net::HTTPResponse]
+      def update_audience_authority_level(authority_level)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/authorityLevel"
+        body = {authorityLevel: authority_level}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
       # Fetch data, get content of specified URL.
       #
       # @param endpoint_base [String]
@@ -615,6 +900,19 @@ module Line
         httpclient.post(endpoint_base + endpoint_path, payload, headers)
       end
 
+      # Put data, get content of specified URL.
+      #
+      # @param endpoint_base [String]
+      # @param endpoint_path [String]
+      # @param payload [String or NilClass]
+      # @param headers [Hash]
+      #
+      # @return [Net::HTTPResponse]
+      def put(endpoint_base, endpoint_path, payload = nil, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.put(endpoint_base + endpoint_path, payload, headers)
+      end
+
       # Delete content of specified URL.
       #
       # @param endpoint_base [String]

data/lib/line/bot/event.rb

@@ -21,6 +21,8 @@ require 'line/bot/event/leave'
 require 'line/bot/event/message'
 require 'line/bot/event/postback'
 require 'line/bot/event/unfollow'
+require 'line/bot/event/unsend'
 require 'line/bot/event/member_joined'
 require 'line/bot/event/member_left'
 require 'line/bot/event/things'
+require 'line/bot/event/video_play_complete'

data/lib/line/bot/event/base.rb

@@ -23,6 +23,10 @@ module Line
         def [](key)
           @src[key]
         end
+
+        def to_hash
+          @src
+        end
       end
     end
   end

data/lib/line/bot/event/unsend.rb

@@ -0,0 +1,27 @@
+# Copyright 2016 LINE
+#
+# 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.
+
+module Line
+  module Bot
+    module Event
+      # Event object for when the user unsends a message in a group or room.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#unsend-event
+      class Unsend < Base
+      end
+    end
+  end
+end

data/lib/line/bot/event/video_play_complete.rb

@@ -0,0 +1,25 @@
+# Copyright 2016 LINE
+#
+# 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.
+
+module Line
+  module Bot
+    module Event
+      # Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete
+      class VideoPlayComplete < Base
+      end
+    end
+  end
+end

data/lib/line/bot/httpclient.rb

@@ -57,6 +57,11 @@ module Line
         http(uri).post(uri.request_uri, payload, header)
       end
 
+      def put(url, payload, header = {})
+        uri = URI(url)
+        http(uri).put(uri.request_uri, payload, header)
+      end
+
       def delete(url, header = {})
         uri = URI(url)
         http(uri).delete(uri.request_uri, header)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.19.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -97,6 +97,8 @@ files:
 - lib/line/bot/event/postback.rb
 - lib/line/bot/event/things.rb
 - lib/line/bot/event/unfollow.rb
+- lib/line/bot/event/unsend.rb
+- lib/line/bot/event/video_play_complete.rb
 - lib/line/bot/httpclient.rb
 - lib/line/bot/util.rb
 - line-bot-api.gemspec