line-bot-api 1.29.1 → 1.30.0

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

@@ -0,0 +1,97 @@
+# 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
+        # Object containing information about the membership plan.
+        class SubscribedMembershipPlan
+          # @!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
+
+          # @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.
+          def initialize(
+            membership_id:,
+            title:,
+            description:,
+            benefits:,
+            price:,
+            currency:,
+            **dynamic_attributes
+          )
+            
+            @membership_id = membership_id
+            @title = title
+            @description = description
+            @benefits = benefits
+            @price = price
+            @currency = currency
+
+            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::SubscribedMembershipPlan] 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/subscribed_membership_user.rb

@@ -0,0 +1,85 @@
+# 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
+        # Object containing user membership subscription information.
+        class SubscribedMembershipUser
+          # @!attribute [rw] membership_no
+          #   @return [Integer] The user's member number in the membership plan.
+          attr_accessor :membership_no
+          # @!attribute [rw] joined_time
+          #   @return [Integer] UNIX timestamp at which the user subscribed to the membership.
+          attr_accessor :joined_time
+          # @!attribute [rw] next_billing_date
+          #   @return [String] Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 
+          attr_accessor :next_billing_date
+          # @!attribute [rw] total_subscription_months
+          #   @return [Integer] The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.
+          attr_accessor :total_subscription_months
+
+          # @param membership_no [Integer] The user's member number in the membership plan.
+          # @param joined_time [Integer] UNIX timestamp at which the user subscribed to the membership.
+          # @param next_billing_date [String] Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 
+          # @param total_subscription_months [Integer] The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.
+          def initialize(
+            membership_no:,
+            joined_time:,
+            next_billing_date:,
+            total_subscription_months:,
+            **dynamic_attributes
+          )
+            
+            @membership_no = membership_no
+            @joined_time = joined_time
+            @next_billing_date = next_billing_date
+            @total_subscription_months = total_subscription_months
+
+            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::SubscribedMembershipUser] 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/subscription.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
+        # An array of memberships.
+        class Subscription
+          # @!attribute [rw] membership
+          #   @return [SubscribedMembershipPlan] 
+          attr_accessor :membership
+          # @!attribute [rw] user
+          #   @return [SubscribedMembershipUser] 
+          attr_accessor :user
+
+          # @param membership [SubscribedMembershipPlan, Hash[Symbol, untyped]] 
+          # @param user [SubscribedMembershipUser, Hash[Symbol, untyped]] 
+          def initialize(
+            membership:,
+            user:,
+            **dynamic_attributes
+          )
+            
+            @membership = membership.is_a?(Line::Bot::V2::MessagingApi::SubscribedMembershipPlan) ? membership : Line::Bot::V2::MessagingApi::SubscribedMembershipPlan.create(**membership) # steep:ignore
+            @user = user.is_a?(Line::Bot::V2::MessagingApi::SubscribedMembershipUser) ? user : Line::Bot::V2::MessagingApi::SubscribedMembershipUser.create(**user) # 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::Subscription] 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/subscription_period_demographic.rb

@@ -0,0 +1,20 @@
+# 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 SubscriptionPeriodDemographic
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.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 './demographic_filter'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class SubscriptionPeriodDemographicFilter < DemographicFilter
+          # @!attribute [r] type
+          #   @return [String,nil] Type of demographic filter
+          attr_reader :type
+          # @!attribute [rw] gte
+          #   @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') 
+          attr_accessor :gte
+          # @!attribute [rw] lt
+          #   @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') 
+          attr_accessor :lt
+
+          # @param gte [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') 
+          # @param lt [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') 
+          def initialize(
+            gte: nil,
+            lt: nil,
+            **dynamic_attributes
+          )
+            @type = "subscriptionPeriod"
+            
+            @gte = gte
+            @lt = lt
+
+            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::SubscriptionPeriodDemographicFilter] 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/substitution_object.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
+        # An object that defines the replacement value for a placeholder in the text.
+        class SubstitutionObject
+          # @!attribute [rw] type
+          #   @return [String] Type of substitution object
+          attr_accessor :type
+
+          # @param type [String] Type of substitution object
+          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::SubstitutionObject] 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:)
+            {
+              emoji: Line::Bot::V2::MessagingApi::EmojiSubstitutionObject,
+              mention: Line::Bot::V2::MessagingApi::MentionSubstitutionObject,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/template.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
+        class Template
+          # @!attribute [rw] type
+          #   @return [String] 
+          attr_accessor :type
+
+          # @param type [String] 
+          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::Template] 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:)
+            {
+              buttons: Line::Bot::V2::MessagingApi::ButtonsTemplate,
+              carousel: Line::Bot::V2::MessagingApi::CarouselTemplate,
+              confirm: Line::Bot::V2::MessagingApi::ConfirmTemplate,
+              image_carousel: Line::Bot::V2::MessagingApi::ImageCarouselTemplate,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/template_image_aspect_ratio.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
+        # Aspect ratio of the image. This is only for the `imageAspectRatio` in ButtonsTemplate. Specify one of the following values:  `rectangle`: 1.51:1 `square`: 1:1 
+        class TemplateImageAspectRatio
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/template_image_size.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
+        # Size of the image.  This is only for the `imageSize` in ButtonsTemplate. Specify one of the following values:  `cover`: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. `contain`: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. 
+        class TemplateImageSize
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/messaging_api/model/template_message.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.
+
+require_relative './message'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        # @see https://developers.line.biz/en/reference/messaging-api/#template-messages
+        class TemplateMessage < 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] alt_text
+          #   @return [String] 
+          attr_accessor :alt_text
+          # @!attribute [rw] template
+          #   @return [Template] 
+          attr_accessor :template
+
+          # @param quick_reply [QuickReply, Hash[Symbol, untyped], nil] 
+          # @param sender [Sender, Hash[Symbol, untyped], nil] 
+          # @param alt_text [String] 
+          # @param template [Template, Hash[Symbol, untyped]] 
+          def initialize(
+            quick_reply: nil,
+            sender: nil,
+            alt_text:,
+            template:,
+            **dynamic_attributes
+          )
+            @type = "template"
+            
+            @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
+            @alt_text = alt_text
+            @template = template.is_a?(Line::Bot::V2::MessagingApi::Template) ? template : Line::Bot::V2::MessagingApi::Template.create(**template) # 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::TemplateMessage] 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