line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/webhook/model/unfollow_event.rb

@@ -0,0 +1,97 @@
+# 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.
+
+require_relative './event'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Event object for when your LINE Official Account is blocked.
+        class UnfollowEvent < Event
+          # @!attribute [r] type
+          #   @return [String] Type of the event
+          attr_reader :type
+          # @!attribute [rw] source
+          #   @return [Source,nil] 
+          attr_accessor :source
+          # @!attribute [rw] timestamp
+          #   @return [Integer] Time of the event in milliseconds.
+          attr_accessor :timestamp
+          # @!attribute [rw] mode
+          #   @return [String] ('active'|'standby') 
+          attr_accessor :mode
+          # @!attribute [rw] webhook_event_id
+          #   @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          attr_accessor :webhook_event_id
+          # @!attribute [rw] delivery_context
+          #   @return [DeliveryContext] 
+          attr_accessor :delivery_context
+
+          # @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: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            **dynamic_attributes
+          )
+            @type = "unfollow"
+            
+            @source = source.is_a?(Line::Bot::V2::Webhook::Source) || source.nil? ? source : Line::Bot::V2::Webhook::Source.create(**source) # steep:ignore
+            @timestamp = timestamp
+            @mode = mode
+            @webhook_event_id = webhook_event_id
+            @delivery_context = delivery_context.is_a?(Line::Bot::V2::Webhook::DeliveryContext) ? delivery_context : Line::Bot::V2::Webhook::DeliveryContext.create(**delivery_context) # steep:ignore
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/unlink_things_content.rb

@@ -0,0 +1,72 @@
+# 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.
+
+require_relative './things_content'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class UnlinkThingsContent < ThingsContent
+          # @!attribute [r] type
+          #   @return [String] Type
+          attr_reader :type
+          # @!attribute [rw] device_id
+          #   @return [String] Device ID of the device that has been linked with LINE.
+          attr_accessor :device_id
+
+          # @param device_id [String] Device ID of the device that has been linked with LINE.
+          def initialize(
+            device_id:,
+            **dynamic_attributes
+          )
+            @type = "unlink"
+            
+            @device_id = device_id
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/unsend_detail.rb

@@ -0,0 +1,66 @@
+# 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
+          # @!attribute [rw] message_id
+          #   @return [String] The message ID of the unsent message
+          attr_accessor :message_id
+
+          # @param message_id [String] The message ID of the unsent message
+          def initialize(
+            message_id:,
+            **dynamic_attributes
+          )
+            
+            @message_id = message_id
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/unsend_event.rb

@@ -0,0 +1,103 @@
+# 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.
+
+require_relative './event'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Event object for when the user unsends a message.
+        class UnsendEvent < Event
+          # @!attribute [r] type
+          #   @return [String] Type of the event
+          attr_reader :type
+          # @!attribute [rw] source
+          #   @return [Source,nil] 
+          attr_accessor :source
+          # @!attribute [rw] timestamp
+          #   @return [Integer] Time of the event in milliseconds.
+          attr_accessor :timestamp
+          # @!attribute [rw] mode
+          #   @return [String] ('active'|'standby') 
+          attr_accessor :mode
+          # @!attribute [rw] webhook_event_id
+          #   @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
+          attr_accessor :webhook_event_id
+          # @!attribute [rw] delivery_context
+          #   @return [DeliveryContext] 
+          attr_accessor :delivery_context
+          # @!attribute [rw] unsend
+          #   @return [UnsendDetail] 
+          attr_accessor :unsend
+
+          # @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: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            unsend:,
+            **dynamic_attributes
+          )
+            @type = "unsend"
+            
+            @source = source.is_a?(Line::Bot::V2::Webhook::Source) || source.nil? ? source : Line::Bot::V2::Webhook::Source.create(**source) # steep:ignore
+            @timestamp = timestamp
+            @mode = mode
+            @webhook_event_id = webhook_event_id
+            @delivery_context = delivery_context.is_a?(Line::Bot::V2::Webhook::DeliveryContext) ? delivery_context : Line::Bot::V2::Webhook::DeliveryContext.create(**delivery_context) # steep:ignore
+            @unsend = unsend.is_a?(Line::Bot::V2::Webhook::UnsendDetail) ? unsend : Line::Bot::V2::Webhook::UnsendDetail.create(**unsend) # steep:ignore
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/user_mentionee.rb

@@ -0,0 +1,91 @@
+# 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.
+
+require_relative './mentionee'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # Mentioned target is user
+        class UserMentionee < Mentionee
+          # @!attribute [r] type
+          #   @return [String] Mentioned target.
+          attr_reader :type
+          # @!attribute [rw] index
+          #   @return [Integer] Index position of the user mention for a character in text, with the first character being at position 0.
+          attr_accessor :index
+          # @!attribute [rw] length
+          #   @return [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length.
+          attr_accessor :length
+          # @!attribute [rw] user_id
+          #   @return [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.
+          attr_accessor :user_id
+          # @!attribute [rw] is_self
+          #   @return [Boolean,nil] Whether the mentioned user is the bot that receives the webhook.
+          attr_accessor :is_self
+
+          # @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 [Boolean,nil] Whether the mentioned user is the bot that receives the webhook.
+          def initialize(
+            index:,
+            length:,
+            user_id: nil,
+            is_self: nil,
+            **dynamic_attributes
+          )
+            @type = "user"
+            
+            @index = index
+            @length = length
+            @user_id = user_id
+            @is_self = is_self
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/user_source.rb

@@ -0,0 +1,72 @@
+# 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.
+
+require_relative './source'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class UserSource < Source
+          # @!attribute [r] type
+          #   @return [String] source type
+          attr_reader :type
+          # @!attribute [rw] user_id
+          #   @return [String,nil] ID of the source user
+          attr_accessor :user_id
+
+          # @param user_id [String,nil] ID of the source user
+          def initialize(
+            user_id: nil,
+            **dynamic_attributes
+          )
+            @type = "user"
+            
+            @user_id = user_id
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/video_message_content.rb

@@ -0,0 +1,90 @@
+# 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.
+
+require_relative './message_content'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class VideoMessageContent < MessageContent
+          # @!attribute [r] type
+          #   @return [String] Type
+          attr_reader :type
+          # @!attribute [rw] id
+          #   @return [String] Message ID
+          attr_accessor :id
+          # @!attribute [rw] duration
+          #   @return [Integer,nil] Length of video file (milliseconds)
+          attr_accessor :duration
+          # @!attribute [rw] content_provider
+          #   @return [ContentProvider] 
+          attr_accessor :content_provider
+          # @!attribute [rw] quote_token
+          #   @return [String] Quote token to quote this message. 
+          attr_accessor :quote_token
+
+          # @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:,
+            duration: nil,
+            content_provider:,
+            quote_token:,
+            **dynamic_attributes
+          )
+            @type = "video"
+            
+            @id = id
+            @duration = duration
+            @content_provider = content_provider.is_a?(Line::Bot::V2::Webhook::ContentProvider) ? content_provider : Line::Bot::V2::Webhook::ContentProvider.create(**content_provider) # steep:ignore
+            @quote_token = quote_token
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/webhook/model/video_play_complete.rb

@@ -0,0 +1,66 @@
+# 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
+          # @!attribute [rw] tracking_id
+          #   @return [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message.
+          attr_accessor :tracking_id
+
+          # @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:,
+            **dynamic_attributes
+          )
+            
+            @tracking_id = tracking_id
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # 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(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end