line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_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-rich-menu-alias-list
+        class RichMenuAliasListResponse
+          # @!attribute [rw] aliases
+          #   @return [Array[RichMenuAliasResponse]] Rich menu aliases.
+          attr_accessor :aliases
+
+          # @param aliases [Array[RichMenuAliasResponse, Hash[Symbol, untyped]]] Rich menu aliases.
+          def initialize(
+            aliases:,
+            **dynamic_attributes
+          )
+            
+            @aliases = aliases.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::RichMenuAliasResponse.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::MessagingApi::RichMenuAliasListResponse] 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/rich_menu_alias_response.rb

@@ -0,0 +1,72 @@
+# 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 RichMenuAliasResponse
+          # @!attribute [rw] rich_menu_alias_id
+          #   @return [String] Rich menu alias ID.
+          attr_accessor :rich_menu_alias_id
+          # @!attribute [rw] rich_menu_id
+          #   @return [String] The rich menu ID associated with the rich menu alias.
+          attr_accessor :rich_menu_id
+
+          # @param rich_menu_alias_id [String] Rich menu alias ID.
+          # @param rich_menu_id [String] The rich menu ID associated with the rich menu alias.
+          def initialize(
+            rich_menu_alias_id:,
+            rich_menu_id:,
+            **dynamic_attributes
+          )
+            
+            @rich_menu_alias_id = rich_menu_alias_id
+            @rich_menu_id = rich_menu_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::MessagingApi::RichMenuAliasResponse] 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/rich_menu_area.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
+        # Rich menu area
+        class RichMenuArea
+          # @!attribute [rw] bounds
+          #   @return [RichMenuBounds,nil] 
+          attr_accessor :bounds
+          # @!attribute [rw] action
+          #   @return [Action,nil] 
+          attr_accessor :action
+
+          # @param bounds [RichMenuBounds, Hash[Symbol, untyped], nil] 
+          # @param action [Action, Hash[Symbol, untyped], nil] 
+          def initialize(
+            bounds: nil,
+            action: nil,
+            **dynamic_attributes
+          )
+            
+            @bounds = bounds.is_a?(Line::Bot::V2::MessagingApi::RichMenuBounds) || bounds.nil? ? bounds : Line::Bot::V2::MessagingApi::RichMenuBounds.create(**bounds) # steep:ignore
+            @action = action.is_a?(Line::Bot::V2::MessagingApi::Action) || action.nil? ? action : Line::Bot::V2::MessagingApi::Action.create(**action) # 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::RichMenuArea] 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/rich_menu_batch_link_operation.rb

@@ -0,0 +1,79 @@
+# 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 './rich_menu_batch_operation'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # Replace the rich menu with the rich menu specified in the `to` property for all users linked to the rich menu specified in the `from` property.
+        class RichMenuBatchLinkOperation < RichMenuBatchOperation
+          # @!attribute [r] type
+          #   @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll.
+          attr_reader :type
+          # @!attribute [rw] from
+          #   @return [String] 
+          attr_accessor :from
+          # @!attribute [rw] to
+          #   @return [String] 
+          attr_accessor :to
+
+          # @param from [String] 
+          # @param to [String] 
+          def initialize(
+            from:,
+            to:,
+            **dynamic_attributes
+          )
+            @type = "link"
+            
+            @from = from
+            @to = to
+
+            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::RichMenuBatchLinkOperation] 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/rich_menu_batch_operation.rb

@@ -0,0 +1,80 @@
+# 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
+        # Rich menu operation object represents the batch operation to the rich menu linked to the user.
+        # @see https://developers.line.biz/en/reference/messaging-api/#batch-control-rich-menus-of-users-operations
+        class RichMenuBatchOperation
+          # @!attribute [rw] type
+          #   @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll.
+          attr_accessor :type
+
+          # @param type [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll.
+          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::RichMenuBatchOperation] 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:)
+            {
+              link: Line::Bot::V2::MessagingApi::RichMenuBatchLinkOperation,
+              unlinkAll: Line::Bot::V2::MessagingApi::RichMenuBatchUnlinkAllOperation,
+              unlink: Line::Bot::V2::MessagingApi::RichMenuBatchUnlinkOperation,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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
+        # The current status. One of:  `ongoing`: Rich menu batch control is in progress. `succeeded`: Rich menu batch control is complete. `failed`: Rich menu batch control failed.           This means that the rich menu for one or more users couldn't be controlled.           There may also be users whose operations have been successfully completed. 
+        class RichMenuBatchProgressPhase
+          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# 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-batch-control-rich-menus-progress-status-response
+        class RichMenuBatchProgressResponse
+          # @!attribute [rw] phase
+          #   @return [String] ('ongoing'|'succeeded'|'failed') 
+          attr_accessor :phase
+          # @!attribute [rw] accepted_time
+          #   @return [String] The accepted time in milliseconds of the request of batch control the rich menu.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC 
+          attr_accessor :accepted_time
+          # @!attribute [rw] completed_time
+          #   @return [String,nil] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC 
+          attr_accessor :completed_time
+
+          # @param phase [String] ('ongoing'|'succeeded'|'failed') 
+          # @param accepted_time [String] The accepted time in milliseconds of the request of batch control the rich menu.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC 
+          # @param completed_time [String,nil] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC 
+          def initialize(
+            phase:,
+            accepted_time:,
+            completed_time: nil,
+            **dynamic_attributes
+          )
+            
+            @phase = phase
+            @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::RichMenuBatchProgressResponse] 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/rich_menu_batch_request.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.
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class RichMenuBatchRequest
+          # @!attribute [rw] operations
+          #   @return [Array[RichMenuBatchOperation]] Array of Rich menu operation object...
+          attr_accessor :operations
+          # @!attribute [rw] resume_request_key
+          #   @return [String,nil] Key for retry. Key value is a string matching the regular expression pattern
+          attr_accessor :resume_request_key
+
+          # @param operations [Array[RichMenuBatchOperation, Hash[Symbol, untyped]]] Array of Rich menu operation object...
+          # @param resume_request_key [String,nil] Key for retry. Key value is a string matching the regular expression pattern
+          def initialize(
+            operations:,
+            resume_request_key: nil,
+            **dynamic_attributes
+          )
+            
+            @operations = operations.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::RichMenuBatchOperation.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @resume_request_key = resume_request_key
+
+            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::RichMenuBatchRequest] 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/rich_menu_batch_unlink_all_operation.rb

@@ -0,0 +1,67 @@
+# 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 './rich_menu_batch_operation'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # Unlink the rich menu from all users linked to the rich menu.
+        class RichMenuBatchUnlinkAllOperation < RichMenuBatchOperation
+          # @!attribute [r] type
+          #   @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll.
+          attr_reader :type
+
+          def initialize(
+            **dynamic_attributes
+          )
+            @type = "unlinkAll"
+            
+
+            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::RichMenuBatchUnlinkAllOperation] 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