line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/insight/model/error_response.rb

@@ -0,0 +1,79 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        # @see https://developers.line.biz/en/reference/messaging-api/#error-responses
+        class ErrorResponse
+          # @!attribute [rw] message
+          #   @return [String] Message containing information about the error.
+          attr_accessor :message
+          # @!attribute [rw] details
+          #   @return [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response.
+          attr_accessor :details
+
+          # @param message [String] Message containing information about the error.
+          # @param details [Array[ErrorDetail, Hash[Symbol, untyped]],nil] An array of error details. If the array is empty, this property will not be included in the response.
+          def initialize(
+            message:,
+            details: nil,
+            **dynamic_attributes
+          )
+            
+            @message = message
+            @details = details&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::ErrorDetail.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::Insight::ErrorResponse] 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/insight/model/gender_tile.rb

@@ -0,0 +1,72 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        class GenderTile
+          # @!attribute [rw] gender
+          #   @return [String,nil] ('male'|'female'|'unknown') users' gender
+          attr_accessor :gender
+          # @!attribute [rw] percentage
+          #   @return [Float,nil] Percentage
+          attr_accessor :percentage
+
+          # @param gender [String,nil] ('male'|'female'|'unknown') users' gender
+          # @param percentage [Float,nil] Percentage
+          def initialize(
+            gender: nil,
+            percentage: nil,
+            **dynamic_attributes
+          )
+            
+            @gender = gender
+            @percentage = percentage
+
+            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::Insight::GenderTile] 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/insight/model/get_friends_demographics_response.rb

@@ -0,0 +1,128 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        # Get friend demographics
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
+        class GetFriendsDemographicsResponse
+          # @!attribute [rw] available
+          #   @return [Boolean,nil] true if friend demographic information is available.
+          attr_accessor :available
+          # @!attribute [rw] genders
+          #   @return [Array[GenderTile],nil] Percentage per gender.
+          attr_accessor :genders
+          # @!attribute [rw] ages
+          #   @return [Array[AgeTile],nil] Percentage per age group.
+          attr_accessor :ages
+          # @!attribute [rw] areas
+          #   @return [Array[AreaTile],nil] Percentage per area.
+          attr_accessor :areas
+          # @!attribute [rw] app_types
+          #   @return [Array[AppTypeTile],nil] Percentage by OS.
+          attr_accessor :app_types
+          # @!attribute [rw] subscription_periods
+          #   @return [Array[SubscriptionPeriodTile],nil] Percentage per friendship duration.
+          attr_accessor :subscription_periods
+
+          # @param available [Boolean,nil] true if friend demographic information is available.
+          # @param genders [Array[GenderTile, Hash[Symbol, untyped]],nil] Percentage per gender.
+          # @param ages [Array[AgeTile, Hash[Symbol, untyped]],nil] Percentage per age group.
+          # @param areas [Array[AreaTile, Hash[Symbol, untyped]],nil] Percentage per area.
+          # @param app_types [Array[AppTypeTile, Hash[Symbol, untyped]],nil] Percentage by OS.
+          # @param subscription_periods [Array[SubscriptionPeriodTile, Hash[Symbol, untyped]],nil] Percentage per friendship duration.
+          def initialize(
+            available: nil,
+            genders: nil,
+            ages: nil,
+            areas: nil,
+            app_types: nil,
+            subscription_periods: nil,
+            **dynamic_attributes
+          )
+            
+            @available = available
+            @genders = genders&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::GenderTile.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @ages = ages&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::AgeTile.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @areas = areas&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::AreaTile.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @app_types = app_types&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::AppTypeTile.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @subscription_periods = subscription_periods&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::SubscriptionPeriodTile.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::Insight::GetFriendsDemographicsResponse] 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/insight/model/get_message_event_response.rb

@@ -0,0 +1,92 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        # Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response
+        class GetMessageEventResponse
+          # @!attribute [rw] overview
+          #   @return [GetMessageEventResponseOverview,nil] 
+          attr_accessor :overview
+          # @!attribute [rw] messages
+          #   @return [Array[GetMessageEventResponseMessage],nil] Array of information about individual message bubbles.
+          attr_accessor :messages
+          # @!attribute [rw] clicks
+          #   @return [Array[GetMessageEventResponseClick],nil] Array of information about opened URLs in the message.
+          attr_accessor :clicks
+
+          # @param overview [GetMessageEventResponseOverview, Hash[Symbol, untyped], nil] 
+          # @param messages [Array[GetMessageEventResponseMessage, Hash[Symbol, untyped]],nil] Array of information about individual message bubbles.
+          # @param clicks [Array[GetMessageEventResponseClick, Hash[Symbol, untyped]],nil] Array of information about opened URLs in the message.
+          def initialize(
+            overview: nil,
+            messages: nil,
+            clicks: nil,
+            **dynamic_attributes
+          )
+            
+            @overview = overview.is_a?(Line::Bot::V2::Insight::GetMessageEventResponseOverview) || overview.nil? ? overview : Line::Bot::V2::Insight::GetMessageEventResponseOverview.create(**overview) # steep:ignore
+            @messages = messages&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::GetMessageEventResponseMessage.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @clicks = clicks&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Insight::GetMessageEventResponseClick.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::Insight::GetMessageEventResponse] 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/insight/model/get_message_event_response_click.rb

@@ -0,0 +1,90 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        class GetMessageEventResponseClick
+          # @!attribute [rw] seq
+          #   @return [Integer,nil] The URL's serial number.
+          attr_accessor :seq
+          # @!attribute [rw] url
+          #   @return [String,nil] URL.
+          attr_accessor :url
+          # @!attribute [rw] click
+          #   @return [Integer,nil] Number of times the URL was opened.
+          attr_accessor :click
+          # @!attribute [rw] unique_click
+          #   @return [Integer,nil] Number of users that opened the URL.
+          attr_accessor :unique_click
+          # @!attribute [rw] unique_click_of_request
+          #   @return [Integer,nil] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
+          attr_accessor :unique_click_of_request
+
+          # @param seq [Integer,nil] The URL's serial number.
+          # @param url [String,nil] URL.
+          # @param click [Integer,nil] Number of times the URL was opened.
+          # @param unique_click [Integer,nil] Number of users that opened the URL.
+          # @param unique_click_of_request [Integer,nil] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
+          def initialize(
+            seq: nil,
+            url: nil,
+            click: nil,
+            unique_click: nil,
+            unique_click_of_request: nil,
+            **dynamic_attributes
+          )
+            
+            @seq = seq
+            @url = url
+            @click = click
+            @unique_click = unique_click
+            @unique_click_of_request = unique_click_of_request
+
+            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::Insight::GetMessageEventResponseClick] 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/insight/model/get_message_event_response_message.rb

@@ -0,0 +1,132 @@
+# LINE Messaging API(Insight)
+# This document describes LINE Messaging API(Insight).
+#
+# 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 Insight
+        class GetMessageEventResponseMessage
+          # @!attribute [rw] seq
+          #   @return [Integer,nil] Bubble's serial number.
+          attr_accessor :seq
+          # @!attribute [rw] impression
+          #   @return [Integer,nil] Number of times the bubble was displayed.
+          attr_accessor :impression
+          # @!attribute [rw] media_played
+          #   @return [Integer,nil] Number of times audio or video in the bubble started playing.
+          attr_accessor :media_played
+          # @!attribute [rw] media_played25_percent
+          #   @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time.
+          attr_accessor :media_played25_percent
+          # @!attribute [rw] media_played50_percent
+          #   @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time.
+          attr_accessor :media_played50_percent
+          # @!attribute [rw] media_played75_percent
+          #   @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time.
+          attr_accessor :media_played75_percent
+          # @!attribute [rw] media_played100_percent
+          #   @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time.
+          attr_accessor :media_played100_percent
+          # @!attribute [rw] unique_media_played
+          #   @return [Integer,nil] Number of users that started playing audio or video in the bubble.
+          attr_accessor :unique_media_played
+          # @!attribute [rw] unique_media_played25_percent
+          #   @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time.
+          attr_accessor :unique_media_played25_percent
+          # @!attribute [rw] unique_media_played50_percent
+          #   @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time.
+          attr_accessor :unique_media_played50_percent
+          # @!attribute [rw] unique_media_played75_percent
+          #   @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time.
+          attr_accessor :unique_media_played75_percent
+          # @!attribute [rw] unique_media_played100_percent
+          #   @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time.
+          attr_accessor :unique_media_played100_percent
+
+          # @param seq [Integer,nil] Bubble's serial number.
+          # @param impression [Integer,nil] Number of times the bubble was displayed.
+          # @param media_played [Integer,nil] Number of times audio or video in the bubble started playing.
+          # @param media_played25_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time.
+          # @param media_played50_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time.
+          # @param media_played75_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time.
+          # @param media_played100_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time.
+          # @param unique_media_played [Integer,nil] Number of users that started playing audio or video in the bubble.
+          # @param unique_media_played25_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time.
+          # @param unique_media_played50_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time.
+          # @param unique_media_played75_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time.
+          # @param unique_media_played100_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time.
+          def initialize(
+            seq: nil,
+            impression: nil,
+            media_played: nil,
+            media_played25_percent: nil,
+            media_played50_percent: nil,
+            media_played75_percent: nil,
+            media_played100_percent: nil,
+            unique_media_played: nil,
+            unique_media_played25_percent: nil,
+            unique_media_played50_percent: nil,
+            unique_media_played75_percent: nil,
+            unique_media_played100_percent: nil,
+            **dynamic_attributes
+          )
+            
+            @seq = seq
+            @impression = impression
+            @media_played = media_played
+            @media_played25_percent = media_played25_percent
+            @media_played50_percent = media_played50_percent
+            @media_played75_percent = media_played75_percent
+            @media_played100_percent = media_played100_percent
+            @unique_media_played = unique_media_played
+            @unique_media_played25_percent = unique_media_played25_percent
+            @unique_media_played50_percent = unique_media_played50_percent
+            @unique_media_played75_percent = unique_media_played75_percent
+            @unique_media_played100_percent = unique_media_played100_percent
+
+            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::Insight::GetMessageEventResponseMessage] 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