line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/manage_audience/model/adaccount.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 ManageAudience
+        # Adaccount
+        class Adaccount
+          # @!attribute [rw] name
+          #   @return [String,nil] Ad account name.
+          attr_accessor :name
+
+          # @param name [String,nil] Ad account name.
+          def initialize(
+            name: nil,
+            **dynamic_attributes
+          )
+            
+            @name = name
+
+            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::ManageAudience::Adaccount] 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/manage_audience/model/add_audience_to_audience_group_request.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 ManageAudience
+        # Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
+        # @see https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group
+        class AddAudienceToAudienceGroupRequest
+          # @!attribute [rw] audience_group_id
+          #   @return [Integer,nil] The audience ID.
+          attr_accessor :audience_group_id
+          # @!attribute [rw] upload_description
+          #   @return [String,nil] The audience's name.
+          attr_accessor :upload_description
+          # @!attribute [rw] audiences
+          #   @return [Array[Audience],nil] An array of up to 10,000 user IDs or IFAs.
+          attr_accessor :audiences
+
+          # @param audience_group_id [Integer,nil] The audience ID.
+          # @param upload_description [String,nil] The audience's name.
+          # @param audiences [Array[Audience, Hash[Symbol, untyped]],nil] An array of up to 10,000 user IDs or IFAs.
+          def initialize(
+            audience_group_id: nil,
+            upload_description: nil,
+            audiences: nil,
+            **dynamic_attributes
+          )
+            
+            @audience_group_id = audience_group_id
+            @upload_description = upload_description
+            @audiences = audiences&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::ManageAudience::Audience.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::ManageAudience::AddAudienceToAudienceGroupRequest] 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/manage_audience/model/audience.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 ManageAudience
+        # Audience
+        class Audience
+          # @!attribute [rw] id
+          #   @return [String,nil] A user ID or IFA. You can specify an empty array.
+          attr_accessor :id
+
+          # @param id [String,nil] A user ID or IFA. You can specify an empty array.
+          def initialize(
+            id: nil,
+            **dynamic_attributes
+          )
+            
+            @id = 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::ManageAudience::Audience] 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/manage_audience/model/audience_group.rb

@@ -0,0 +1,133 @@
+# 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 ManageAudience
+        # Audience group
+        class AudienceGroup
+          # @!attribute [rw] audience_group_id
+          #   @return [Integer,nil] The audience ID.
+          attr_accessor :audience_group_id
+          # @!attribute [rw] type
+          #   @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') 
+          attr_accessor :type
+          # @!attribute [rw] description
+          #   @return [String,nil] The audience's name.
+          attr_accessor :description
+          # @!attribute [rw] status
+          #   @return [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') 
+          attr_accessor :status
+          # @!attribute [rw] failed_type
+          #   @return [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') 
+          attr_accessor :failed_type
+          # @!attribute [rw] audience_count
+          #   @return [Integer,nil] The number of users included in the audience.
+          attr_accessor :audience_count
+          # @!attribute [rw] created
+          #   @return [Integer,nil] When the audience was created (in UNIX time).
+          attr_accessor :created
+          # @!attribute [rw] request_id
+          #   @return [String,nil] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. 
+          attr_accessor :request_id
+          # @!attribute [rw] click_url
+          #   @return [String,nil] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. 
+          attr_accessor :click_url
+          # @!attribute [rw] is_ifa_audience
+          #   @return [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. 
+          attr_accessor :is_ifa_audience
+          # @!attribute [rw] permission
+          #   @return [String,nil] ('READ'|'READ_WRITE') 
+          attr_accessor :permission
+          # @!attribute [rw] create_route
+          #   @return [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') 
+          attr_accessor :create_route
+
+          # @param audience_group_id [Integer,nil] The audience ID.
+          # @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') 
+          # @param description [String,nil] The audience's name.
+          # @param status [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') 
+          # @param failed_type [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') 
+          # @param audience_count [Integer,nil] The number of users included in the audience.
+          # @param created [Integer,nil] When the audience was created (in UNIX time).
+          # @param request_id [String,nil] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. 
+          # @param click_url [String,nil] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. 
+          # @param is_ifa_audience [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. 
+          # @param permission [String,nil] ('READ'|'READ_WRITE') 
+          # @param create_route [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') 
+          def initialize(
+            audience_group_id: nil,
+            type: nil,
+            description: nil,
+            status: nil,
+            failed_type: nil,
+            audience_count: nil,
+            created: nil,
+            request_id: nil,
+            click_url: nil,
+            is_ifa_audience: nil,
+            permission: nil,
+            create_route: nil,
+            **dynamic_attributes
+          )
+            
+            @audience_group_id = audience_group_id
+            @type = type
+            @description = description
+            @status = status
+            @failed_type = failed_type
+            @audience_count = audience_count
+            @created = created
+            @request_id = request_id
+            @click_url = click_url
+            @is_ifa_audience = is_ifa_audience
+            @permission = permission
+            @create_route = create_route
+
+            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::ManageAudience::AudienceGroup] 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/manage_audience/model/audience_group_create_route.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 ManageAudience
+        # How the audience was created. One of:  - `OA_MANAGER`: Audience created with [LINE Official Account Manager](https://manager.line.biz/). - `MESSAGING_API`: Audience created with Messaging API. - `POINT_AD`: Audience created with [LINE Points Ads](https://www.linebiz.com/jp/service/line-point-ad/) (Japanese only). - `AD_MANAGER`: Audience created with [LINE Ads](https://admanager.line.biz/). 
+        class AudienceGroupCreateRoute
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_failed_type.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 ManageAudience
+        # Failed type
+        class AudienceGroupFailedType
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_job.rb

@@ -0,0 +1,110 @@
+# 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 ManageAudience
+        # Audience group job
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group
+        class AudienceGroupJob
+          # @!attribute [rw] audience_group_job_id
+          #   @return [Integer,nil] A job ID.
+          attr_accessor :audience_group_job_id
+          # @!attribute [rw] audience_group_id
+          #   @return [Integer,nil] An audience ID.
+          attr_accessor :audience_group_id
+          # @!attribute [rw] description
+          #   @return [String,nil] The job's description.
+          attr_accessor :description
+          # @!attribute [rw] type
+          #   @return [String,nil] ('DIFF_ADD') 
+          attr_accessor :type
+          # @!attribute [rw] job_status
+          #   @return [String,nil] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') 
+          attr_accessor :job_status
+          # @!attribute [rw] failed_type
+          #   @return [String,nil] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') 
+          attr_accessor :failed_type
+          # @!attribute [rw] audience_count
+          #   @return [Integer,nil] The number of accounts (recipients) that were added or removed.
+          attr_accessor :audience_count
+          # @!attribute [rw] created
+          #   @return [Integer,nil] When the job was created (in UNIX time).
+          attr_accessor :created
+
+          # @param audience_group_job_id [Integer,nil] A job ID.
+          # @param audience_group_id [Integer,nil] An audience ID.
+          # @param description [String,nil] The job's description.
+          # @param type [String,nil] ('DIFF_ADD') 
+          # @param job_status [String,nil] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') 
+          # @param failed_type [String,nil] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') 
+          # @param audience_count [Integer,nil] The number of accounts (recipients) that were added or removed.
+          # @param created [Integer,nil] When the job was created (in UNIX time).
+          def initialize(
+            audience_group_job_id: nil,
+            audience_group_id: nil,
+            description: nil,
+            type: nil,
+            job_status: nil,
+            failed_type: nil,
+            audience_count: nil,
+            created: nil,
+            **dynamic_attributes
+          )
+            
+            @audience_group_job_id = audience_group_job_id
+            @audience_group_id = audience_group_id
+            @description = description
+            @type = type
+            @job_status = job_status
+            @failed_type = failed_type
+            @audience_count = audience_count
+            @created = created
+
+            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::ManageAudience::AudienceGroupJob] 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/manage_audience/model/audience_group_job_failed_type.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 ManageAudience
+        # Failed type
+        class AudienceGroupJobFailedType
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_job_status.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 ManageAudience
+        # Job status
+        class AudienceGroupJobStatus
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_job_type.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 ManageAudience
+        # Job Type
+        class AudienceGroupJobType
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_permission.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 ManageAudience
+        # Permission
+        class AudienceGroupPermission
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_status.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 ManageAudience
+        # Status
+        class AudienceGroupStatus
+          
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/manage_audience/model/audience_group_type.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 ManageAudience
+        # Audience group type
+        class AudienceGroupType
+          
+        end
+      end
+    end
+  end
+end