line-bot-api 1.29.1 → 1.30.0

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

@@ -0,0 +1,79 @@
+# 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
+        # Provider of the media file.
+        class ContentProvider
+          # @!attribute [rw] type
+          #   @return [String] ('line'|'external') Provider of the image file.
+          attr_accessor :type
+          # @!attribute [rw] original_content_url
+          #   @return [String,nil] URL of the image file. Only included when contentProvider.type is external.
+          attr_accessor :original_content_url
+          # @!attribute [rw] preview_image_url
+          #   @return [String,nil] URL of the preview image. Only included when contentProvider.type is external.
+          attr_accessor :preview_image_url
+
+          # @param type [String] ('line'|'external') Provider of the image file.
+          # @param original_content_url [String,nil] URL of the image file. Only included when contentProvider.type is external.
+          # @param preview_image_url [String,nil] URL of the preview image. Only included when contentProvider.type is external.
+          def initialize(
+            type:,
+            original_content_url: nil,
+            preview_image_url: nil,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @original_content_url = original_content_url
+            @preview_image_url = preview_image_url
+
+            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::ContentProvider] 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/deactivated_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
+        # This event indicates that the module channel has been switched to Standby Channel by calling Acquire Control API or Release Control API. Sent to the webhook URL server of the module channel.
+        class DeactivatedEvent < 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 = "deactivated"
+            
+            @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::DeactivatedEvent] 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/delivery_context.rb

@@ -0,0 +1,67 @@
+# 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
+        # webhook's delivery context information
+        class DeliveryContext
+          # @!attribute [rw] is_redelivery
+          #   @return [Boolean] Whether the webhook event is a redelivered one or not.
+          attr_accessor :is_redelivery
+
+          # @param is_redelivery [Boolean] Whether the webhook event is a redelivered one or not.
+          def initialize(
+            is_redelivery:,
+            **dynamic_attributes
+          )
+            
+            @is_redelivery = is_redelivery
+
+            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::DeliveryContext] 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/detached_module_content.rb

@@ -0,0 +1,78 @@
+# 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 './module_content'
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class DetachedModuleContent < ModuleContent
+          # @!attribute [r] type
+          #   @return [String] Type
+          attr_reader :type
+          # @!attribute [rw] bot_id
+          #   @return [String] Detached LINE Official Account bot user ID
+          attr_accessor :bot_id
+          # @!attribute [rw] reason
+          #   @return [String] ('bot_deleted') Reason for detaching
+          attr_accessor :reason
+
+          # @param bot_id [String] Detached LINE Official Account bot user ID
+          # @param reason [String] ('bot_deleted') Reason for detaching
+          def initialize(
+            bot_id:,
+            reason:,
+            **dynamic_attributes
+          )
+            @type = "detached"
+            
+            @bot_id = bot_id
+            @reason = reason
+
+            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::DetachedModuleContent] 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/emoji.rb

@@ -0,0 +1,84 @@
+# 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 Emoji
+          # @!attribute [rw] index
+          #   @return [Integer] Index position 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 LINE emoji string. For LINE emoji (hello), 7 is the length.
+          attr_accessor :length
+          # @!attribute [rw] product_id
+          #   @return [String] Product ID for a LINE emoji set.
+          attr_accessor :product_id
+          # @!attribute [rw] emoji_id
+          #   @return [String] ID for a LINE emoji inside a set.
+          attr_accessor :emoji_id
+
+          # @param index [Integer] Index position for a character in text, with the first character being at position 0.
+          # @param length [Integer] The length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
+          # @param product_id [String] Product ID for a LINE emoji set.
+          # @param emoji_id [String] ID for a LINE emoji inside a set.
+          def initialize(
+            index:,
+            length:,
+            product_id:,
+            emoji_id:,
+            **dynamic_attributes
+          )
+            
+            @index = index
+            @length = length
+            @product_id = product_id
+            @emoji_id = emoji_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::Emoji] 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/event.rb

@@ -0,0 +1,126 @@
+# 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
+        # Webhook event
+        class Event
+          # @!attribute [rw] type
+          #   @return [String] Type of the event
+          attr_accessor :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 type [String] Type of the event
+          # @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(
+            type:,
+            source: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @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::Event] Instance of the class
+          def self.create(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            klass = detect_class(type: symbolized_args[:type])
+            return klass.new(**symbolized_args) if klass # steep:ignore
+            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
+
+          private
+
+          def self.detect_class(type:)
+            {
+              accountLink: Line::Bot::V2::Webhook::AccountLinkEvent,
+              activated: Line::Bot::V2::Webhook::ActivatedEvent,
+              beacon: Line::Bot::V2::Webhook::BeaconEvent,
+              botResumed: Line::Bot::V2::Webhook::BotResumedEvent,
+              botSuspended: Line::Bot::V2::Webhook::BotSuspendedEvent,
+              deactivated: Line::Bot::V2::Webhook::DeactivatedEvent,
+              follow: Line::Bot::V2::Webhook::FollowEvent,
+              join: Line::Bot::V2::Webhook::JoinEvent,
+              leave: Line::Bot::V2::Webhook::LeaveEvent,
+              memberJoined: Line::Bot::V2::Webhook::MemberJoinedEvent,
+              memberLeft: Line::Bot::V2::Webhook::MemberLeftEvent,
+              membership: Line::Bot::V2::Webhook::MembershipEvent,
+              message: Line::Bot::V2::Webhook::MessageEvent,
+              module: Line::Bot::V2::Webhook::ModuleEvent,
+              delivery: Line::Bot::V2::Webhook::PnpDeliveryCompletionEvent,
+              postback: Line::Bot::V2::Webhook::PostbackEvent,
+              things: Line::Bot::V2::Webhook::ThingsEvent,
+              unfollow: Line::Bot::V2::Webhook::UnfollowEvent,
+              unsend: Line::Bot::V2::Webhook::UnsendEvent,
+              videoPlayComplete: Line::Bot::V2::Webhook::VideoPlayCompleteEvent,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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
+        # Channel state.
+        class EventMode
+          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# 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 FileMessageContent < MessageContent
+          # @!attribute [r] type
+          #   @return [String] Type
+          attr_reader :type
+          # @!attribute [rw] id
+          #   @return [String] Message ID
+          attr_accessor :id
+          # @!attribute [rw] file_name
+          #   @return [String] File name
+          attr_accessor :file_name
+          # @!attribute [rw] file_size
+          #   @return [Integer] File size in bytes
+          attr_accessor :file_size
+
+          # @param id [String] Message ID
+          # @param file_name [String] File name
+          # @param file_size [Integer] File size in bytes
+          def initialize(
+            id:,
+            file_name:,
+            file_size:,
+            **dynamic_attributes
+          )
+            @type = "file"
+            
+            @id = id
+            @file_name = file_name
+            @file_size = file_size
+
+            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::FileMessageContent] 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