line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/messaging_api/model/mention_target.rb

@@ -0,0 +1,77 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 MessagingApi
+        class MentionTarget
+          # @!attribute [rw] type
+          #   @return [String] Target to be mentioned
+          attr_accessor :type
+
+          # @param type [String] Target to be mentioned
+          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::MessagingApi::MentionTarget] 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::MessagingApi::AllMentionTarget,
+              user: Line::Bot::V2::MessagingApi::UserMentionTarget,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/message.rb

@@ -0,0 +1,98 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#message-common-properties
+        class Message
+          # @!attribute [rw] type
+          #   @return [String] Type of message
+          attr_accessor :type
+          # @!attribute [rw] quick_reply
+          #   @return [QuickReply,nil] 
+          attr_accessor :quick_reply
+          # @!attribute [rw] sender
+          #   @return [Sender,nil] 
+          attr_accessor :sender
+
+          # @param type [String] Type of message
+          # @param quick_reply [QuickReply, Hash[Symbol, untyped], nil] 
+          # @param sender [Sender, Hash[Symbol, untyped], nil] 
+          def initialize(
+            type:,
+            quick_reply: nil,
+            sender: nil,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @quick_reply = quick_reply.is_a?(Line::Bot::V2::MessagingApi::QuickReply) || quick_reply.nil? ? quick_reply : Line::Bot::V2::MessagingApi::QuickReply.create(**quick_reply) # steep:ignore
+            @sender = sender.is_a?(Line::Bot::V2::MessagingApi::Sender) || sender.nil? ? sender : Line::Bot::V2::MessagingApi::Sender.create(**sender) # 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::MessagingApi::Message] 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::MessagingApi::AudioMessage,
+              flex: Line::Bot::V2::MessagingApi::FlexMessage,
+              image: Line::Bot::V2::MessagingApi::ImageMessage,
+              imagemap: Line::Bot::V2::MessagingApi::ImagemapMessage,
+              location: Line::Bot::V2::MessagingApi::LocationMessage,
+              sticker: Line::Bot::V2::MessagingApi::StickerMessage,
+              template: Line::Bot::V2::MessagingApi::TemplateMessage,
+              text: Line::Bot::V2::MessagingApi::TextMessage,
+              textV2: Line::Bot::V2::MessagingApi::TextMessageV2,
+              video: Line::Bot::V2::MessagingApi::VideoMessage,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/message_action.rb

@@ -0,0 +1,78 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 './action'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class MessageAction < Action
+          # @!attribute [r] type
+          #   @return [String,nil] Type of action
+          attr_reader :type
+          # @!attribute [rw] label
+          #   @return [String,nil] Label for the action.
+          attr_accessor :label
+          # @!attribute [rw] text
+          #   @return [String,nil] 
+          attr_accessor :text
+
+          # @param label [String,nil] Label for the action.
+          # @param text [String,nil] 
+          def initialize(
+            label: nil,
+            text: nil,
+            **dynamic_attributes
+          )
+            @type = "message"
+            
+            @label = label
+            @text = text
+
+            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::MessagingApi::MessageAction] 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/messaging_api/model/message_imagemap_action.rb

@@ -0,0 +1,84 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 './imagemap_action'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class MessageImagemapAction < ImagemapAction
+          # @!attribute [r] type
+          #   @return [String] 
+          attr_reader :type
+          # @!attribute [rw] area
+          #   @return [ImagemapArea] 
+          attr_accessor :area
+          # @!attribute [rw] text
+          #   @return [String] 
+          attr_accessor :text
+          # @!attribute [rw] label
+          #   @return [String,nil] 
+          attr_accessor :label
+
+          # @param area [ImagemapArea, Hash[Symbol, untyped]] 
+          # @param text [String] 
+          # @param label [String,nil] 
+          def initialize(
+            area:,
+            text:,
+            label: nil,
+            **dynamic_attributes
+          )
+            @type = "message"
+            
+            @area = area.is_a?(Line::Bot::V2::MessagingApi::ImagemapArea) ? area : Line::Bot::V2::MessagingApi::ImagemapArea.create(**area) # steep:ignore
+            @text = text
+            @label = label
+
+            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::MessagingApi::MessageImagemapAction] 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/messaging_api/model/message_quota_response.rb

@@ -0,0 +1,73 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-quota
+        class MessageQuotaResponse
+          # @!attribute [rw] type
+          #   @return [String] ('none'|'limited') 
+          attr_accessor :type
+          # @!attribute [rw] value
+          #   @return [Integer,nil] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. 
+          attr_accessor :value
+
+          # @param type [String] ('none'|'limited') 
+          # @param value [Integer,nil] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. 
+          def initialize(
+            type:,
+            value: nil,
+            **dynamic_attributes
+          )
+            
+            @type = type
+            @value = value
+
+            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::MessagingApi::MessageQuotaResponse] 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/messaging_api/model/multicast_request.rb

@@ -0,0 +1,91 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#send-multicast-message
+        class MulticastRequest
+          # @!attribute [rw] messages
+          #   @return [Array[Message]] Messages to send
+          attr_accessor :messages
+          # @!attribute [rw] to
+          #   @return [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
+          attr_accessor :to
+          # @!attribute [rw] notification_disabled
+          #   @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. 
+          attr_accessor :notification_disabled
+          # @!attribute [rw] custom_aggregation_units
+          #   @return [Array[String],nil] Name of aggregation unit. Case-sensitive.
+          attr_accessor :custom_aggregation_units
+
+          # @param messages [Array[Message, Hash[Symbol, untyped]]] Messages to send
+          # @param to [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
+          # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. 
+          # @param custom_aggregation_units [Array[String],nil] Name of aggregation unit. Case-sensitive.
+          def initialize(
+            messages:,
+            to:,
+            notification_disabled: false,
+            custom_aggregation_units: nil,
+            **dynamic_attributes
+          )
+            
+            @messages = messages.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::Message.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @to = to
+            @notification_disabled = notification_disabled
+            @custom_aggregation_units = custom_aggregation_units
+
+            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::MessagingApi::MulticastRequest] 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/messaging_api/model/narrowcast_progress_response.rb

@@ -0,0 +1,109 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# 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 MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status
+        class NarrowcastProgressResponse
+          # @!attribute [rw] phase
+          #   @return [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of:  `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. 
+          attr_accessor :phase
+          # @!attribute [rw] success_count
+          #   @return [Integer,nil] The number of users who successfully received the message.
+          attr_accessor :success_count
+          # @!attribute [rw] failure_count
+          #   @return [Integer,nil] The number of users who failed to send the message.
+          attr_accessor :failure_count
+          # @!attribute [rw] target_count
+          #   @return [Integer,nil] The number of intended recipients of the message.
+          attr_accessor :target_count
+          # @!attribute [rw] failed_description
+          #   @return [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
+          attr_accessor :failed_description
+          # @!attribute [rw] error_code
+          #   @return [Integer,nil] Error summary. This is only included with a phase property value of failed. One of:  `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. 
+          attr_accessor :error_code
+          # @!attribute [rw] accepted_time
+          #   @return [String] Narrowcast message request accepted time in milliseconds.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC 
+          attr_accessor :accepted_time
+          # @!attribute [rw] completed_time
+          #   @return [String,nil] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC 
+          attr_accessor :completed_time
+
+          # @param phase [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of:  `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. 
+          # @param success_count [Integer,nil] The number of users who successfully received the message.
+          # @param failure_count [Integer,nil] The number of users who failed to send the message.
+          # @param target_count [Integer,nil] The number of intended recipients of the message.
+          # @param failed_description [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
+          # @param error_code [Integer,nil] Error summary. This is only included with a phase property value of failed. One of:  `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. 
+          # @param accepted_time [String] Narrowcast message request accepted time in milliseconds.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC 
+          # @param completed_time [String,nil] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC 
+          def initialize(
+            phase:,
+            success_count: nil,
+            failure_count: nil,
+            target_count: nil,
+            failed_description: nil,
+            error_code: nil,
+            accepted_time:,
+            completed_time: nil,
+            **dynamic_attributes
+          )
+            
+            @phase = phase
+            @success_count = success_count
+            @failure_count = failure_count
+            @target_count = target_count
+            @failed_description = failed_description
+            @error_code = error_code
+            @accepted_time = accepted_time
+            @completed_time = completed_time
+
+            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::MessagingApi::NarrowcastProgressResponse] 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