line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/webhook/model/member_left_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 a user leaves a group chat or multi-person chat that the LINE Official Account is in.
+        class MemberLeftEvent < 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] left
+          #   @return [LeftMembers] 
+          attr_accessor :left
+
+          # @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 left [LeftMembers, Hash[Symbol, untyped]] 
+          def initialize(
+            source: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            left:,
+            **dynamic_attributes
+          )
+            @type = "memberLeft"
+            
+            @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
+            @left = left.is_a?(Line::Bot::V2::Webhook::LeftMembers) ? left : Line::Bot::V2::Webhook::LeftMembers.create(**left) # 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::MemberLeftEvent] 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/membership_content.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
+        # Content of the membership event.
+        class MembershipContent
+          # @!attribute [rw] type
+          #   @return [String] Type of membership event.
+          attr_accessor :type
+
+          # @param type [String] Type of membership event.
+          def initialize(
+            type:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+
+            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::MembershipContent] 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:)
+            {
+              joined: Line::Bot::V2::Webhook::JoinedMembershipContent,
+              left: Line::Bot::V2::Webhook::LeftMembershipContent,
+              renewed: Line::Bot::V2::Webhook::RenewedMembershipContent,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# 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 a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership.
+        class MembershipEvent < 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] reply_token
+          #   @return [String] Reply token used to send reply message to this event
+          attr_accessor :reply_token
+          # @!attribute [rw] membership
+          #   @return [MembershipContent] 
+          attr_accessor :membership
+
+          # @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 membership [MembershipContent, Hash[Symbol, untyped]] 
+          def initialize(
+            source: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            reply_token:,
+            membership:,
+            **dynamic_attributes
+          )
+            @type = "membership"
+            
+            @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
+            @reply_token = reply_token
+            @membership = membership.is_a?(Line::Bot::V2::Webhook::MembershipContent) ? membership : Line::Bot::V2::Webhook::MembershipContent.create(**membership) # 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::MembershipEvent] 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/mention.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.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        class Mention
+          # @!attribute [rw] mentionees
+          #   @return [Array[Mentionee]] Array of one or more mention objects. Max: 20 mentions
+          attr_accessor :mentionees
+
+          # @param mentionees [Array[Mentionee, Hash[Symbol, untyped]]] Array of one or more mention objects. Max: 20 mentions
+          def initialize(
+            mentionees:,
+            **dynamic_attributes
+          )
+            
+            @mentionees = mentionees.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Webhook::Mentionee.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+
+            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::Mention] 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/mentionee.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.
+
+module Line
+  module Bot
+    module V2
+      module Webhook
+        # @see https://developers.line.biz/en/reference/messaging-api/#wh-text
+        class Mentionee
+          # @!attribute [rw] type
+          #   @return [String] Mentioned target.
+          attr_accessor :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
+
+          # @param type [String] Mentioned target.
+          # @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.
+          def initialize(
+            type:,
+            index:,
+            length:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @index = index
+            @length = length
+
+            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::Mentionee] 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:)
+            {
+              all: Line::Bot::V2::Webhook::AllMentionee,
+              user: Line::Bot::V2::Webhook::UserMentionee,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# 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/#message-event
+        class MessageContent
+          # @!attribute [rw] type
+          #   @return [String] Type
+          attr_accessor :type
+          # @!attribute [rw] id
+          #   @return [String] Message ID
+          attr_accessor :id
+
+          # @param type [String] Type
+          # @param id [String] Message ID
+          def initialize(
+            type:,
+            id:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @id = 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::MessageContent] 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:)
+            {
+              audio: Line::Bot::V2::Webhook::AudioMessageContent,
+              file: Line::Bot::V2::Webhook::FileMessageContent,
+              image: Line::Bot::V2::Webhook::ImageMessageContent,
+              location: Line::Bot::V2::Webhook::LocationMessageContent,
+              sticker: Line::Bot::V2::Webhook::StickerMessageContent,
+              text: Line::Bot::V2::Webhook::TextMessageContent,
+              video: Line::Bot::V2::Webhook::VideoMessageContent,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# 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
+        # Webhook event object which contains the sent message.
+        class MessageEvent < 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] reply_token
+          #   @return [String,nil] 
+          attr_accessor :reply_token
+          # @!attribute [rw] message
+          #   @return [MessageContent] 
+          attr_accessor :message
+
+          # @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] 
+          # @param message [MessageContent, Hash[Symbol, untyped]] 
+          def initialize(
+            source: nil,
+            timestamp:,
+            mode:,
+            webhook_event_id:,
+            delivery_context:,
+            reply_token: nil,
+            message:,
+            **dynamic_attributes
+          )
+            @type = "message"
+            
+            @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
+            @reply_token = reply_token
+            @message = message.is_a?(Line::Bot::V2::Webhook::MessageContent) ? message : Line::Bot::V2::Webhook::MessageContent.create(**message) # 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::MessageEvent] 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