line-bot-api 1.29.1 → 1.30.0

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

@@ -0,0 +1,74 @@
+# 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
+        # Limit of the Narrowcast
+        # @see https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
+        class Limit
+          # @!attribute [rw] max
+          #   @return [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. 
+          attr_accessor :max
+          # @!attribute [rw] up_to_remaining_quota
+          #   @return [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`.  Targets will be selected at random. 
+          attr_accessor :up_to_remaining_quota
+
+          # @param max [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. 
+          # @param up_to_remaining_quota [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`.  Targets will be selected at random. 
+          def initialize(
+            max: nil,
+            up_to_remaining_quota: false,
+            **dynamic_attributes
+          )
+            
+            @max = max
+            @up_to_remaining_quota = up_to_remaining_quota
+
+            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::Limit] 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/location_action.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.
+
+require_relative './action'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class LocationAction < 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
+
+          # @param label [String,nil] Label for the action.
+          def initialize(
+            label: nil,
+            **dynamic_attributes
+          )
+            @type = "location"
+            
+            @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::LocationAction] 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/location_message.rb

@@ -0,0 +1,103 @@
+# 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 './message'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#location-message
+        class LocationMessage < Message
+          # @!attribute [r] type
+          #   @return [String] Type of message
+          attr_reader :type
+          # @!attribute [rw] quick_reply
+          #   @return [QuickReply,nil] 
+          attr_accessor :quick_reply
+          # @!attribute [rw] sender
+          #   @return [Sender,nil] 
+          attr_accessor :sender
+          # @!attribute [rw] title
+          #   @return [String] 
+          attr_accessor :title
+          # @!attribute [rw] address
+          #   @return [String] 
+          attr_accessor :address
+          # @!attribute [rw] latitude
+          #   @return [Float] 
+          attr_accessor :latitude
+          # @!attribute [rw] longitude
+          #   @return [Float] 
+          attr_accessor :longitude
+
+          # @param quick_reply [QuickReply, Hash[Symbol, untyped], nil] 
+          # @param sender [Sender, Hash[Symbol, untyped], nil] 
+          # @param title [String] 
+          # @param address [String] 
+          # @param latitude [Float] 
+          # @param longitude [Float] 
+          def initialize(
+            quick_reply: nil,
+            sender: nil,
+            title:,
+            address:,
+            latitude:,
+            longitude:,
+            **dynamic_attributes
+          )
+            @type = "location"
+            
+            @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
+            @title = title
+            @address = address
+            @latitude = latitude
+            @longitude = longitude
+
+            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::LocationMessage] 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/mark_messages_as_read_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/partner-docs/#mark-messages-from-users-as-read
+        class MarkMessagesAsReadRequest
+          # @!attribute [rw] chat
+          #   @return [ChatReference] 
+          attr_accessor :chat
+
+          # @param chat [ChatReference, Hash[Symbol, untyped]] 
+          def initialize(
+            chat:,
+            **dynamic_attributes
+          )
+            
+            @chat = chat.is_a?(Line::Bot::V2::MessagingApi::ChatReference) ? chat : Line::Bot::V2::MessagingApi::ChatReference.create(**chat) # 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::MarkMessagesAsReadRequest] 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/members_ids_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 MembersIdsResponse
+          # @!attribute [rw] member_ids
+          #   @return [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`.
+          attr_accessor :member_ids
+          # @!attribute [rw] _next
+          #   @return [String,nil] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. 
+          attr_accessor :_next
+
+          # @param member_ids [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`.
+          # @param _next [String,nil] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. 
+          def initialize(
+            member_ids:,
+            _next: nil,
+            **dynamic_attributes
+          )
+            
+            @member_ids = member_ids
+            @_next = _next
+
+            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::MembersIdsResponse] 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/membership.rb

@@ -0,0 +1,120 @@
+# 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 Membership
+          # @!attribute [rw] membership_id
+          #   @return [Integer] Membership plan ID.
+          attr_accessor :membership_id
+          # @!attribute [rw] title
+          #   @return [String] Membership plan name.
+          attr_accessor :title
+          # @!attribute [rw] description
+          #   @return [String] Membership plan description.
+          attr_accessor :description
+          # @!attribute [rw] benefits
+          #   @return [Array[String]] List of membership plan perks.
+          attr_accessor :benefits
+          # @!attribute [rw] price
+          #   @return [Float] Monthly fee for membership plan. (e.g. 1500.00)
+          attr_accessor :price
+          # @!attribute [rw] currency
+          #   @return [String] ('JPY'|'TWD'|'THB') The currency of membership.price.
+          attr_accessor :currency
+          # @!attribute [rw] member_count
+          #   @return [Integer] Number of members subscribed to the membership plan.
+          attr_accessor :member_count
+          # @!attribute [rw] member_limit
+          #   @return [Integer] The upper limit of members who can subscribe. If no upper limit is set, it will be null.
+          attr_accessor :member_limit
+          # @!attribute [rw] is_in_app_purchase
+          #   @return [Boolean] Payment method for users who subscribe to a membership plan.
+          attr_accessor :is_in_app_purchase
+          # @!attribute [rw] is_published
+          #   @return [Boolean] Membership plan status.
+          attr_accessor :is_published
+
+          # @param membership_id [Integer] Membership plan ID.
+          # @param title [String] Membership plan name.
+          # @param description [String] Membership plan description.
+          # @param benefits [Array[String]] List of membership plan perks.
+          # @param price [Float] Monthly fee for membership plan. (e.g. 1500.00)
+          # @param currency [String] ('JPY'|'TWD'|'THB') The currency of membership.price.
+          # @param member_count [Integer] Number of members subscribed to the membership plan.
+          # @param member_limit [Integer] The upper limit of members who can subscribe. If no upper limit is set, it will be null.
+          # @param is_in_app_purchase [Boolean] Payment method for users who subscribe to a membership plan.
+          # @param is_published [Boolean] Membership plan status.
+          def initialize(
+            membership_id:,
+            title:,
+            description:,
+            benefits:,
+            price:,
+            currency:,
+            member_count:,
+            member_limit:,
+            is_in_app_purchase:,
+            is_published:,
+            **dynamic_attributes
+          )
+            
+            @membership_id = membership_id
+            @title = title
+            @description = description
+            @benefits = benefits
+            @price = price
+            @currency = currency
+            @member_count = member_count
+            @member_limit = member_limit
+            @is_in_app_purchase = is_in_app_purchase
+            @is_published = is_published
+
+            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::Membership] 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/membership_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
+        # List of memberships
+        class MembershipListResponse
+          # @!attribute [rw] memberships
+          #   @return [Array[Membership]] List of membership information
+          attr_accessor :memberships
+
+          # @param memberships [Array[Membership, Hash[Symbol, untyped]]] List of membership information
+          def initialize(
+            memberships:,
+            **dynamic_attributes
+          )
+            
+            @memberships = memberships.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::MessagingApi::Membership.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::MembershipListResponse] 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/mention_substitution_object.rb

@@ -0,0 +1,74 @@
+# 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 './substitution_object'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # An object representing a mention substitution.
+        # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mention-object
+        class MentionSubstitutionObject < SubstitutionObject
+          # @!attribute [r] type
+          #   @return [String] Type of substitution object
+          attr_reader :type
+          # @!attribute [rw] mentionee
+          #   @return [MentionTarget] 
+          attr_accessor :mentionee
+
+          # @param mentionee [MentionTarget, Hash[Symbol, untyped]] 
+          def initialize(
+            mentionee:,
+            **dynamic_attributes
+          )
+            @type = "mention"
+            
+            @mentionee = mentionee.is_a?(Line::Bot::V2::MessagingApi::MentionTarget) ? mentionee : Line::Bot::V2::MessagingApi::MentionTarget.create(**mentionee) # 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::MentionSubstitutionObject] 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