line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.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.
+
+require_relative './rich_menu_batch_operation'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # Unlink the rich menu for all users linked to the rich menu specified in the `from` property.
+        class RichMenuBatchUnlinkOperation < 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
+
+          # @param from [String] 
+          def initialize(
+            from:,
+            **dynamic_attributes
+          )
+            @type = "unlink"
+            
+            @from = from
+
+            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::RichMenuBatchUnlinkOperation] 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_bounds.rb

@@ -0,0 +1,86 @@
+# 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 bounds
+        # @see https://developers.line.biz/en/reference/messaging-api/#bounds-object
+        class RichMenuBounds
+          # @!attribute [rw] x
+          #   @return [Integer,nil] Horizontal position relative to the top-left corner of the area.
+          attr_accessor :x
+          # @!attribute [rw] y
+          #   @return [Integer,nil] Vertical position relative to the top-left corner of the area.
+          attr_accessor :y
+          # @!attribute [rw] width
+          #   @return [Integer,nil] Width of the area.
+          attr_accessor :width
+          # @!attribute [rw] height
+          #   @return [Integer,nil] Height of the area.
+          attr_accessor :height
+
+          # @param x [Integer,nil] Horizontal position relative to the top-left corner of the area.
+          # @param y [Integer,nil] Vertical position relative to the top-left corner of the area.
+          # @param width [Integer,nil] Width of the area.
+          # @param height [Integer,nil] Height of the area.
+          def initialize(
+            x: nil,
+            y: nil,
+            width: nil,
+            height: nil,
+            **dynamic_attributes
+          )
+            
+            @x = x
+            @y = y
+            @width = width
+            @height = height
+
+            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::RichMenuBounds] 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_bulk_link_request.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/#link-rich-menu-to-users
+        class RichMenuBulkLinkRequest
+          # @!attribute [rw] rich_menu_id
+          #   @return [String] ID of a rich menu
+          attr_accessor :rich_menu_id
+          # @!attribute [rw] user_ids
+          #   @return [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
+          attr_accessor :user_ids
+
+          # @param rich_menu_id [String] ID of a rich menu
+          # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
+          def initialize(
+            rich_menu_id:,
+            user_ids:,
+            **dynamic_attributes
+          )
+            
+            @rich_menu_id = rich_menu_id
+            @user_ids = user_ids
+
+            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::RichMenuBulkLinkRequest] 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_bulk_unlink_request.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.
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#unlink-rich-menu-from-users
+        class RichMenuBulkUnlinkRequest
+          # @!attribute [rw] user_ids
+          #   @return [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
+          attr_accessor :user_ids
+
+          # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
+          def initialize(
+            user_ids:,
+            **dynamic_attributes
+          )
+            
+            @user_ids = user_ids
+
+            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::RichMenuBulkUnlinkRequest] 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_id_response.rb

@@ -0,0 +1,66 @@
+# 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 RichMenuIdResponse
+          # @!attribute [rw] rich_menu_id
+          #   @return [String] Rich menu ID
+          attr_accessor :rich_menu_id
+
+          # @param rich_menu_id [String] Rich menu ID
+          def initialize(
+            rich_menu_id:,
+            **dynamic_attributes
+          )
+            
+            @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::RichMenuIdResponse] 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_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-list
+        class RichMenuListResponse
+          # @!attribute [rw] richmenus
+          #   @return [Array[RichMenuResponse]] Rich menus
+          attr_accessor :richmenus
+
+          # @param richmenus [Array[RichMenuResponse, Hash[Symbol, untyped]]] Rich menus
+          def initialize(
+            richmenus:,
+            **dynamic_attributes
+          )
+            
+            @richmenus = richmenus.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::RichMenuResponse.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::RichMenuListResponse] 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_request.rb

@@ -0,0 +1,96 @@
+# 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 RichMenuRequest
+          # @!attribute [rw] size
+          #   @return [RichMenuSize,nil] 
+          attr_accessor :size
+          # @!attribute [rw] selected
+          #   @return [Boolean,nil] `true` to display the rich menu by default. Otherwise, `false`.
+          attr_accessor :selected
+          # @!attribute [rw] name
+          #   @return [String,nil] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
+          attr_accessor :name
+          # @!attribute [rw] chat_bar_text
+          #   @return [String,nil] Text displayed in the chat bar
+          attr_accessor :chat_bar_text
+          # @!attribute [rw] areas
+          #   @return [Array[RichMenuArea],nil] Array of area objects which define the coordinates and size of tappable areas
+          attr_accessor :areas
+
+          # @param size [RichMenuSize, Hash[Symbol, untyped], nil] 
+          # @param selected [Boolean,nil] `true` to display the rich menu by default. Otherwise, `false`.
+          # @param name [String,nil] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
+          # @param chat_bar_text [String,nil] Text displayed in the chat bar
+          # @param areas [Array[RichMenuArea, Hash[Symbol, untyped]],nil] Array of area objects which define the coordinates and size of tappable areas
+          def initialize(
+            size: nil,
+            selected: nil,
+            name: nil,
+            chat_bar_text: nil,
+            areas: nil,
+            **dynamic_attributes
+          )
+            
+            @size = size.is_a?(Line::Bot::V2::MessagingApi::RichMenuSize) || size.nil? ? size : Line::Bot::V2::MessagingApi::RichMenuSize.create(**size) # steep:ignore
+            @selected = selected
+            @name = name
+            @chat_bar_text = chat_bar_text
+            @areas = areas&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::RichMenuArea.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::RichMenuRequest] 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_response.rb

@@ -0,0 +1,102 @@
+# 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 RichMenuResponse
+          # @!attribute [rw] rich_menu_id
+          #   @return [String] ID of a rich menu
+          attr_accessor :rich_menu_id
+          # @!attribute [rw] size
+          #   @return [RichMenuSize] 
+          attr_accessor :size
+          # @!attribute [rw] selected
+          #   @return [Boolean] `true` to display the rich menu by default. Otherwise, `false`.
+          attr_accessor :selected
+          # @!attribute [rw] name
+          #   @return [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
+          attr_accessor :name
+          # @!attribute [rw] chat_bar_text
+          #   @return [String] Text displayed in the chat bar
+          attr_accessor :chat_bar_text
+          # @!attribute [rw] areas
+          #   @return [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas
+          attr_accessor :areas
+
+          # @param rich_menu_id [String] ID of a rich menu
+          # @param size [RichMenuSize, Hash[Symbol, untyped]] 
+          # @param selected [Boolean] `true` to display the rich menu by default. Otherwise, `false`.
+          # @param name [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
+          # @param chat_bar_text [String] Text displayed in the chat bar
+          # @param areas [Array[RichMenuArea, Hash[Symbol, untyped]]] Array of area objects which define the coordinates and size of tappable areas
+          def initialize(
+            rich_menu_id:,
+            size:,
+            selected:,
+            name:,
+            chat_bar_text:,
+            areas:,
+            **dynamic_attributes
+          )
+            
+            @rich_menu_id = rich_menu_id
+            @size = size.is_a?(Line::Bot::V2::MessagingApi::RichMenuSize) ? size : Line::Bot::V2::MessagingApi::RichMenuSize.create(**size) # steep:ignore
+            @selected = selected
+            @name = name
+            @chat_bar_text = chat_bar_text
+            @areas = areas.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::RichMenuArea.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::RichMenuResponse] 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