line-bot-api 1.29.1 → 1.30.0

data/sig/line/bot/v2/webhook/model/module_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
+        # This event indicates that the module channel has been attached to the LINE Official Account. Sent to the webhook URL server of the module channel.
+        class ModuleEvent < 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 _module: ModuleContent
+          
+
+          # @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 _module [ModuleContent, 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],
+            _module: ModuleContent| 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::ModuleEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> ModuleEvent
+
+          # @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/pnp_delivery.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
+        # A delivery object containing a hashed phone number string or a string specified by `X-Line-Delivery-Tag` header
+        class PnpDelivery
+          attr_accessor data: String
+          
+
+          # @param data [String] A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header
+          def initialize: (
+            data: 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::PnpDelivery] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> PnpDelivery
+
+          # @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/pnp_delivery_completion_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
+        # When a request is made to the LINE notification messages API and delivery of the LINE notification message to the user is completed, a dedicated webhook event (delivery completion event) is sent from the LINE Platform to the webhook URL of the bot server.
+        class PnpDeliveryCompletionEvent < 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 delivery: PnpDelivery
+          
+
+          # @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 delivery [PnpDelivery, 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],
+            delivery: PnpDelivery| 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::PnpDeliveryCompletionEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> PnpDeliveryCompletionEvent
+
+          # @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/postback_content.rbs

@@ -0,0 +1,42 @@
+# 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 PostbackContent
+          attr_accessor data: String
+          attr_accessor params: Object?
+          
+
+          # @param data [String] Postback data
+          # @param params [Object,nil] 
+          def initialize: (
+            data: String,
+            ?params: Object?,
+            **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::PostbackContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> PostbackContent
+
+          # @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/postback_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 object for when a user performs a postback action which initiates a postback. You can reply to postback events.
+        class PostbackEvent < 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 postback: PostbackContent
+          
+
+          # @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,nil] Reply token used to send reply message to this event
+          # @param postback [PostbackContent, 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?,
+            postback: PostbackContent| 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::PostbackEvent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> PostbackEvent
+
+          # @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/renewed_membership_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 RenewedMembershipContent < MembershipContent
+          attr_reader type: String
+          attr_accessor membership_id: Integer
+          
+
+          # @param membership_id [Integer] The ID of the membership that the user renewed. This is defined for each membership.
+          def initialize: (
+            membership_id: Integer,
+            **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::RenewedMembershipContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> RenewedMembershipContent
+
+          # @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/room_source.rbs

@@ -0,0 +1,43 @@
+# 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 RoomSource < Source
+          attr_reader type: String
+          attr_accessor user_id: String?
+          attr_accessor room_id: String
+          
+
+          # @param user_id [String,nil] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId.
+          # @param room_id [String] Room ID of the source multi-person chat
+          def initialize: (
+            ?user_id: String?,
+            room_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::RoomSource] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> RoomSource
+
+          # @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/scenario_result.rbs

@@ -0,0 +1,61 @@
+# 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
+        # @see https://developers.line.biz/en/reference/messaging-api/#scenario-result-event
+        class ScenarioResult
+          attr_accessor scenario_id: String?
+          attr_accessor revision: Integer?
+          attr_accessor start_time: Integer
+          attr_accessor end_time: Integer
+          attr_accessor result_code: String
+          attr_accessor action_results: Array[ActionResult]?
+          attr_accessor ble_notification_payload: String?
+          attr_accessor error_reason: String?
+          
+
+          # @param scenario_id [String,nil] Scenario ID executed
+          # @param revision [Integer,nil] Revision number of the scenario set containing the executed scenario
+          # @param start_time [Integer] Timestamp for when execution of scenario action started (milliseconds, LINE app time)
+          # @param end_time [Integer] Timestamp for when execution of scenario was completed (milliseconds, LINE app time)
+          # @param result_code [String] Scenario execution completion status
+          # @param action_results [Array[ActionResult, Hash[Symbol, untyped]],nil] Execution result of individual operations specified in action. Only included when things.result.resultCode is success.
+          # @param ble_notification_payload [String,nil] Data contained in notification.
+          # @param error_reason [String,nil] Error reason.
+          def initialize: (
+            ?scenario_id: String?,
+            ?revision: Integer?,
+            start_time: Integer,
+            end_time: Integer,
+            result_code: String,
+            ?action_results: Array[ActionResult| Hash[Symbol, untyped]]?,
+            ?ble_notification_payload: String?,
+            ?error_reason: 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::ScenarioResult] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> ScenarioResult
+
+          # @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/scenario_result_things_content.rbs

@@ -0,0 +1,43 @@
+# 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 ScenarioResultThingsContent < ThingsContent
+          attr_reader type: String
+          attr_accessor device_id: String
+          attr_accessor result: ScenarioResult
+          
+
+          # @param device_id [String] Device ID of the device that has been linked with LINE.
+          # @param result [ScenarioResult, Hash[Symbol, untyped]] 
+          def initialize: (
+            device_id: String,
+            result: ScenarioResult| 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::ScenarioResultThingsContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> ScenarioResultThingsContent
+
+          # @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/source.rbs

@@ -0,0 +1,45 @@
+# 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
+        # the source of the event.
+        # @see https://developers.line.biz/en/reference/messaging-api/#source-user
+        class Source
+          attr_accessor type: String
+          
+
+          # @param type [String] source type
+          def initialize: (
+            type: 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::Source] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> Source
+
+          # @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
+
+          private
+
+          def self.detect_class: (type: String) -> Class?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# 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
+        # @see https://developers.line.biz/en/reference/messaging-api/#wh-sticker
+        class StickerMessageContent < MessageContent
+          attr_reader type: String
+          attr_accessor id: String
+          attr_accessor package_id: String
+          attr_accessor sticker_id: String
+          attr_accessor sticker_resource_type: 'STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT'
+          attr_accessor keywords: Array[String]?
+          attr_accessor text: String?
+          attr_accessor quote_token: String
+          attr_accessor quoted_message_id: String?
+          
+
+          # @param id [String] Message ID
+          # @param package_id [String] Package ID
+          # @param sticker_id [String] Sticker ID
+          # @param sticker_resource_type [String] ('STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT') 
+          # @param keywords [Array[String],nil] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. 
+          # @param text [String,nil] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 
+          # @param quote_token [String] Quote token to quote this message. 
+          # @param quoted_message_id [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message.  
+          def initialize: (
+            id: String,
+            package_id: String,
+            sticker_id: String,
+            sticker_resource_type: 'STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT',
+            ?keywords: Array[String]?,
+            ?text: String?,
+            quote_token: String,
+            ?quoted_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::StickerMessageContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> StickerMessageContent
+
+          # @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/text_message_content.rbs

@@ -0,0 +1,55 @@
+# 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 TextMessageContent < MessageContent
+          attr_reader type: String
+          attr_accessor id: String
+          attr_accessor text: String
+          attr_accessor emojis: Array[Emoji]?
+          attr_accessor mention: Mention?
+          attr_accessor quote_token: String
+          attr_accessor quoted_message_id: String?
+          
+
+          # @param id [String] Message ID
+          # @param text [String] Message text.
+          # @param emojis [Array[Emoji, Hash[Symbol, untyped]],nil] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji.
+          # @param mention [Mention, Hash[Symbol, untyped], nil] 
+          # @param quote_token [String] Quote token to quote this message. 
+          # @param quoted_message_id [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message.
+          def initialize: (
+            id: String,
+            text: String,
+            ?emojis: Array[Emoji| Hash[Symbol, untyped]]?,
+            ?mention: Mention?| Hash[Symbol, untyped]?,
+            quote_token: String,
+            ?quoted_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::TextMessageContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> TextMessageContent
+
+          # @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/things_content.rbs

@@ -0,0 +1,43 @@
+# 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 ThingsContent
+          attr_accessor type: String
+          
+
+          # @param type [String] Type
+          def initialize: (
+            type: 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::ThingsContent] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> ThingsContent
+
+          # @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
+
+          private
+
+          def self.detect_class: (type: String) -> Class?
+        end
+      end
+    end
+  end
+end