line-bot-api 1.29.1 → 1.30.0

data/sig/line/bot/v2/webhook/model/things_event.rbs

@@ -0,0 +1,59 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Indicates that a user linked a device with LINE.
+        class ThingsEvent < Event
+          attr_reader type: String
+          attr_accessor source: Source?
+          attr_accessor timestamp: Integer
+          attr_accessor mode: 'active'|'standby'
+          attr_accessor webhook_event_id: String
+          attr_accessor delivery_context: DeliveryContext
+          attr_accessor reply_token: String
+          attr_accessor things: ThingsContent
+          
+
+          # @param source [Source, Hash[Symbol, untyped], nil] 
+          # @param timestamp [Integer] Time of the event in milliseconds.
+          # @param mode [String] ('active'|'standby') 
+          # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          # @param delivery_context [DeliveryContext, Hash[Symbol, untyped]] 
+          # @param reply_token [String] Reply token used to send reply message to this event
+          # @param things [ThingsContent, Hash[Symbol, untyped]] 
+          def initialize: (
+            ?source: Source?| Hash[Symbol, untyped]?,
+            timestamp: Integer,
+            mode: 'active'|'standby',
+            webhook_event_id: String,
+            delivery_context: DeliveryContext| Hash[Symbol, untyped],
+            reply_token: String,
+            things: ThingsContent| Hash[Symbol, untyped],
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::ThingsEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> ThingsEvent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/unfollow_event.rbs

@@ -0,0 +1,53 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Event object for when your LINE Official Account is blocked.
+        class UnfollowEvent < Event
+          attr_reader type: String
+          attr_accessor source: Source?
+          attr_accessor timestamp: Integer
+          attr_accessor mode: 'active'|'standby'
+          attr_accessor webhook_event_id: String
+          attr_accessor delivery_context: DeliveryContext
+          
+
+          # @param source [Source, Hash[Symbol, untyped], nil] 
+          # @param timestamp [Integer] Time of the event in milliseconds.
+          # @param mode [String] ('active'|'standby') 
+          # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          # @param delivery_context [DeliveryContext, Hash[Symbol, untyped]] 
+          def initialize: (
+            ?source: Source?| Hash[Symbol, untyped]?,
+            timestamp: Integer,
+            mode: 'active'|'standby',
+            webhook_event_id: String,
+            delivery_context: DeliveryContext| Hash[Symbol, untyped],
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UnfollowEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UnfollowEvent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/unlink_things_content.rbs

@@ -0,0 +1,40 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class UnlinkThingsContent < ThingsContent
+          attr_reader type: String
+          attr_accessor device_id: String
+          
+
+          # @param device_id [String] Device ID of the device that has been linked with LINE.
+          def initialize: (
+            device_id: String,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UnlinkThingsContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UnlinkThingsContent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/unsend_detail.rbs

@@ -0,0 +1,39 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class UnsendDetail
+          attr_accessor message_id: String
+          
+
+          # @param message_id [String] The message ID of the unsent message
+          def initialize: (
+            message_id: String,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UnsendDetail] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UnsendDetail
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/unsend_event.rbs

@@ -0,0 +1,56 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Event object for when the user unsends a message.
+        class UnsendEvent < Event
+          attr_reader type: String
+          attr_accessor source: Source?
+          attr_accessor timestamp: Integer
+          attr_accessor mode: 'active'|'standby'
+          attr_accessor webhook_event_id: String
+          attr_accessor delivery_context: DeliveryContext
+          attr_accessor unsend: UnsendDetail
+          
+
+          # @param source [Source, Hash[Symbol, untyped], nil] 
+          # @param timestamp [Integer] Time of the event in milliseconds.
+          # @param mode [String] ('active'|'standby') 
+          # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          # @param delivery_context [DeliveryContext, Hash[Symbol, untyped]] 
+          # @param unsend [UnsendDetail, Hash[Symbol, untyped]] 
+          def initialize: (
+            ?source: Source?| Hash[Symbol, untyped]?,
+            timestamp: Integer,
+            mode: 'active'|'standby',
+            webhook_event_id: String,
+            delivery_context: DeliveryContext| Hash[Symbol, untyped],
+            unsend: UnsendDetail| Hash[Symbol, untyped],
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UnsendEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UnsendEvent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/user_mentionee.rbs

@@ -0,0 +1,50 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Mentioned target is user
+        class UserMentionee < Mentionee
+          attr_reader type: String
+          attr_accessor index: Integer
+          attr_accessor length: Integer
+          attr_accessor user_id: String?
+          attr_accessor is_self: bool?
+          
+
+          # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0.
+          # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length.
+          # @param user_id [String,nil] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information.
+          # @param is_self [bool,nil] Whether the mentioned user is the bot that receives the webhook.
+          def initialize: (
+            index: Integer,
+            length: Integer,
+            ?user_id: String?,
+            ?is_self: bool?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UserMentionee] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UserMentionee
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/user_source.rbs

@@ -0,0 +1,40 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class UserSource < Source
+          attr_reader type: String
+          attr_accessor user_id: String?
+          
+
+          # @param user_id [String,nil] ID of the source user
+          def initialize: (
+            ?user_id: String?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::UserSource] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UserSource
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/video_message_content.rbs

@@ -0,0 +1,49 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class VideoMessageContent < MessageContent
+          attr_reader type: String
+          attr_accessor id: String
+          attr_accessor duration: Integer?
+          attr_accessor content_provider: ContentProvider
+          attr_accessor quote_token: String
+          
+
+          # @param id [String] Message ID
+          # @param duration [Integer,nil] Length of video file (milliseconds)
+          # @param content_provider [ContentProvider, Hash[Symbol, untyped]] 
+          # @param quote_token [String] Quote token to quote this message. 
+          def initialize: (
+            id: String,
+            ?duration: Integer?,
+            content_provider: ContentProvider| Hash[Symbol, untyped],
+            quote_token: String,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::VideoMessageContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> VideoMessageContent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/video_play_complete.rbs

@@ -0,0 +1,39 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class VideoPlayComplete
+          attr_accessor tracking_id: String
+          
+
+          # @param tracking_id [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message.
+          def initialize: (
+            tracking_id: String,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::VideoPlayComplete] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> VideoPlayComplete
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook/model/video_play_complete_event.rbs

@@ -0,0 +1,59 @@
+# Webhook Type Definition
+# Webhook event definition of the LINE Messaging API
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
+        class VideoPlayCompleteEvent < Event
+          attr_reader type: String
+          attr_accessor source: Source?
+          attr_accessor timestamp: Integer
+          attr_accessor mode: 'active'|'standby'
+          attr_accessor webhook_event_id: String
+          attr_accessor delivery_context: DeliveryContext
+          attr_accessor reply_token: String
+          attr_accessor video_play_complete: VideoPlayComplete
+          
+
+          # @param source [Source, Hash[Symbol, untyped], nil] 
+          # @param timestamp [Integer] Time of the event in milliseconds.
+          # @param mode [String] ('active'|'standby') 
+          # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          # @param delivery_context [DeliveryContext, Hash[Symbol, untyped]] 
+          # @param reply_token [String] Reply token used to send reply message to this event
+          # @param video_play_complete [VideoPlayComplete, Hash[Symbol, untyped]] 
+          def initialize: (
+            ?source: Source?| Hash[Symbol, untyped]?,
+            timestamp: Integer,
+            mode: 'active'|'standby',
+            webhook_event_id: String,
+            delivery_context: DeliveryContext| Hash[Symbol, untyped],
+            reply_token: String,
+            video_play_complete: VideoPlayComplete| Hash[Symbol, untyped],
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Webhook::VideoPlayCompleteEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> VideoPlayCompleteEvent
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/webhook_parser.rbs

@@ -0,0 +1,26 @@
+module Line
+  module Bot
+    module V2
+      class WebhookParser
+        class InvalidSignatureError < ::StandardError
+        end
+        @channel_secret: String
+
+        def initialize: (channel_secret: String) -> void
+
+        def parse: (
+            body: String,
+            signature: String
+          ) -> Array[Webhook::Event]
+
+        private
+
+        def verify_signature: (body: String, signature: String) -> bool
+
+        def variable_secure_compare: (String, String) -> bool
+
+        def secure_compare: (String, String) -> bool
+      end
+    end
+  end
+end

data/sig/line/bot/version.rbs

@@ -0,0 +1,5 @@
+module Line
+  module Bot
+    VERSION: String
+  end
+end