line-bot-api 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4665d3f64bd345493bbd462ff4a69f14089803a0ccbfa2af4a33ddba6dde87
-  data.tar.gz: ff297dbf91d2f862384a4e56a44496f28e6639dc90be48dffcd1f5e026195dea
+  metadata.gz: cc272a376d9eb4be79d9c92ee485737c6474f652c0873923010f5b25d1d78c1a
+  data.tar.gz: 4beb042559850867763cec2920ac0715877c2b2a7b5538c8a749bd226de2571e
 SHA512:
-  metadata.gz: 6a15e26e9071d289cbf00238cc4e15a50923db911a538f2756be9503f800a53ed8518da5435717f49b714d0c2a44b51be67a5ab2a0ff16405c5e2583483f20d3
-  data.tar.gz: e282f0efc0ffa2ae259de6ebdcb9cd7b9a650dad7d979ceaf13c8bdff4056695207850e7ed8195d03065509eabe9b712ebcfb62fbfc0b77ae40dd49ffc5170ed
+  metadata.gz: 6ca96d2225493a374bc23497b075a740ff95f469d4b2b832143083c96a1d4d319482ccb1c7b4a4f6bc0dbd93774bd49a6425c3dbc0a4d552b6afa6795125061e
+  data.tar.gz: 1809fa4bbadda5065d2f8ec1e8d4bc7fd266c1f0014623bd4606488ba6266cc8e4321fe498edf2aa63c8f6cab3bb397094d0c2aff12c37dad9c9bd5be5dfd439

data/README.md

@@ -13,6 +13,10 @@ See the official API documentation for more information
 - English: https://developers.line.biz/en/docs/messaging-api/overview/
 - Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
 
+Also, generated documentation by YARD is available.
+
+- https://rubydoc.info/gems/line-bot-api
+
 ## Installation
 
 Add this line to your application's Gemfile:

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

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.13.0"
+      VERSION = "1.14.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -19,6 +19,13 @@ require 'uri'
 
 module Line
   module Bot
+    # API Client of LINE Bot SDK Ruby
+    #
+    #   @client ||= Line::Bot::Client.new do |config|
+    #     config.channel_id = ENV["LINE_CHANNEL_ID"]
+    #     config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
+    #     config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
+    #   end
     class Client
       #  @return [String]
       attr_accessor :channel_token, :channel_id, :channel_secret, :endpoint, :blob_endpoint
@@ -29,10 +36,9 @@ module Line
       # @return [Hash]
       attr_accessor :http_options
 
-      # Initialize a new Bot Client.
+      # Initialize a new client.
       #
       # @param options [Hash]
-      #
       # @return [Line::Bot::Client]
       def initialize(options = {})
         options.each do |key, value|
@@ -96,11 +102,10 @@ module Line
         post(endpoint, endpoint_path, payload, headers)
       end
 
-      # Push messages to line server and to user.
-      #
-      # @param user_id [String] User's identifiers
-      # @param messages [Hash or Array]
+      # Push messages to a user using user_id.
       #
+      # @param user_id [String] User Id
+      # @param messages [Hash or Array] Message Objects
       # @return [Net::HTTPResponse]
       def push_message(user_id, messages)
         channel_token_required
@@ -112,11 +117,25 @@ module Line
         post(endpoint, endpoint_path, payload, credentials)
       end
 
-      # Reply messages to line server and to users.
+      # Reply messages to a user using replyToken.
       #
-      # @param token [String]
-      # @param messages [Hash or Array]
+      # @example Send a balloon to a user.
+      #   message = {
+      #     type: 'text',
+      #     text: 'Hello, World!'
+      #   }
+      #   client.reply_message(event['replyToken'], message)
+      #
+      # @example Send multiple balloons to a user.
       #
+      #   messages = [
+      #    {type: 'text', text: 'Message1'},
+      #    {type: 'text', text: 'Message2'}
+      #   ]
+      #   client.reply_message(event['replyToken'], messages)
+      #
+      # @param token [String] Reply Token
+      # @param messages [Hash or Array] Message Objects
       # @return [Net::HTTPResponse]
       def reply_message(token, messages)
         channel_token_required
@@ -128,11 +147,10 @@ module Line
         post(endpoint, endpoint_path, payload, credentials)
       end
 
-      # Multicast messages to line server and to users.
-      #
-      # @param to [Array or String]
-      # @param messages [Hash or Array]
+      # Send messages to multiple users using userIds.
       #
+      # @param to [Array or String] Array of userIds
+      # @param messages [Hash or Array] Message Objects
       # @return [Net::HTTPResponse]
       def multicast(to, messages)
         channel_token_required
@@ -145,10 +163,9 @@ module Line
         post(endpoint, endpoint_path, payload, credentials)
       end
 
-      # Broadcast messages to users
-      #
-      # @param messages [Hash or Array]
+      # Send messages to all friends.
       #
+      # @param messages [Hash or Array] Message Objects
       # @return [Net::HTTPResponse]
       def broadcast(messages)
         channel_token_required
@@ -160,6 +177,32 @@ module Line
         post(endpoint, endpoint_path, payload, credentials)
       end
 
+      # Narrowcast messages to users
+      #
+      # API Documentation is here.
+      # https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
+      #
+      # @param messages [Hash or Array]
+      # @param recipient [Hash]
+      # @param filter [Hash]
+      # @param limit [Hash]
+      #
+      # @return [Net::HTTPResponse]
+      def narrowcast(messages, recipient: nil, filter: nil, limit: nil)
+        channel_token_required
+
+        messages = [messages] if messages.is_a?(Hash)
+
+        endpoint_path = '/bot/message/narrowcast'
+        payload = {
+          messages: messages,
+          recipient: recipient,
+          filter: filter,
+          limit: limit
+        }.to_json
+        post(endpoint, endpoint_path, payload, credentials)
+      end
+
       def leave_group(group_id)
         channel_token_required
 
@@ -177,7 +220,6 @@ module Line
       # Get message content.
       #
       # @param identifier [String] Message's identifier
-      #
       # @return [Net::HTTPResponse]
       def get_message_content(identifier)
         channel_token_required
@@ -188,8 +230,7 @@ module Line
 
       # Get an user's profile.
       #
-      # @param user_id [String] User's identifier
-      #
+      # @param user_id [String] User Id user_id
       # @return [Net::HTTPResponse]
       def get_profile(user_id)
         channel_token_required
@@ -201,7 +242,7 @@ module Line
       # Get an user's profile of a group.
       #
       # @param group_id [String] Group's identifier
-      # @param user_id [String] User's identifier
+      # @param user_id [String] User Id user_id
       #
       # @return [Net::HTTPResponse]
       def get_group_member_profile(group_id, user_id)
@@ -214,7 +255,7 @@ module Line
       # Get an user's profile of a room.
       #
       # @param room_id [String] Room's identifier
-      # @param user_id [String] User's identifier
+      # @param user_id [String] User Id user_id
       #
       # @return [Net::HTTPResponse]
       def get_room_member_profile(room_id, user_id)
@@ -241,7 +282,7 @@ module Line
 
       # Get user IDs of a room
       #
-      # @param group_id [String] Room's identifier
+      # @param room_id [String] Room's identifier
       # @param continuation_token [String] Identifier to return next page
       #                                   (next property to be included in the response)
       #
@@ -394,6 +435,9 @@ module Line
 
       # Link a rich menu to a user
       #
+      # If you want to link a rich menu to multiple users,
+      # please consider to use bulk_link_rich_menus.
+      #
       # @param user_id [String] ID of the user
       # @param rich_menu_id [String] ID of an uploaded rich menu
       #
@@ -519,6 +563,18 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
+      # Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
+      #
+      # @param [String] request_id
+      #
+      # @return [Net::HTTPResponse]
+      def get_user_interaction_statistics(request_id)
+        channel_token_required
+
+        endpoint_path = "/bot/insight/message/event?requestId=#{request_id}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Returns the number of followers
       #
       # @param [String] date (Format:yyyyMMdd, Example:20191231)
@@ -531,7 +587,7 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
-      # Retrieves the demographic attributes for a bot's friends.
+      # Get the demographic attributes for a bot's friends.
       #
       # @return [Net::HTTPResponse]
       def get_friend_demographics
@@ -596,7 +652,9 @@ module Line
         end
       end
 
-      # Validate signature
+      # Validate signature of a webhook event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#signature-validation
       #
       # @param content [String] Request's body
       # @param channel_signature [String] Request'header 'X-LINE-Signature' # HTTP_X_LINE_SIGNATURE

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

@@ -15,11 +15,16 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user has linked his/her LINE account with a provider's service account.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#account-link-event
       class AccountLink < Base
+        # @return [String]
         def result
           @src['link']['result']
         end
 
+        # @return [String]
         def nonce
           @src['link']['nonce']
         end

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

@@ -15,15 +15,21 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user enters the range of a LINE Beacon.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#beacon-event
       class Beacon < Base
+        # @return [String]
         def type
           @src['beacon']['type']
         end
 
+        # @return [String]
         def hwid
           @src['beacon']['hwid']
         end
 
+        # @return [String]
         def deviceMessage
           [@src['beacon']['dm']].pack('H*')
         end

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

@@ -15,6 +15,10 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account is added as a friend (or unblocked).
+      # You can reply to follow events.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#follow-event
       class Follow < Base
       end
     end

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

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account joins a group or room.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#join-event
       class Join < Base
       end
     end

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

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user removes your LINE official account from a group or when your LINE official account leaves a group or room.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#leave-event
       class Leave < Base
       end
     end

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

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user joins a group or room that the LINE official account is in.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#member-joined-event
       class MemberJoined < Base
       end
     end

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

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user leaves a group or room that the LINE official account is in.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#member-left-event
       class MemberLeft < Base
       end
     end

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

@@ -26,6 +26,9 @@ module Line
         Unsupport = 'unsupport'
       end
 
+      # Webhook event object which contains the sent message.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#message-event
       class Message < Base
         def type
           Line::Bot::Event::MessageType.const_get(@src['message']['type'].capitalize)

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

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user performs a postback action which initiates a postback.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#postback-event
       class Postback < Base
       end
     end

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

@@ -22,6 +22,11 @@ module Line
         Unsupport = 'unsupport'
       end
 
+      # LINE Things API related events.
+      #
+      # * https://developers.line.biz/en/reference/messaging-api/#device-link-event
+      # * https://developers.line.biz/en/reference/messaging-api/#device-unlink-event
+      # * https://developers.line.biz/en/reference/messaging-api/#scenario-result-event
       class Things < Base
         def type
           Line::Bot::Event::ThingsType.const_get(Line::Bot::Util.camelize(@src['things']['type']))

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

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account is blocked.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#unfollow-event
       class Unfollow < Base
       end
     end

data/lib/line/bot/httpclient.rb

@@ -19,7 +19,7 @@ require 'uri'
 module Line
   module Bot
     class HTTPClient
-      #  @return [Hash]
+      # @return [Hash]
       attr_accessor :http_options
 
       # Initialize a new HTTPClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -119,7 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SDK of the LINE Messaging API