line-bot-api 1.29.1 → 1.30.0

data/sig/line/bot/v2/liff/model/liff_features.rbs

@@ -0,0 +1,42 @@
+# LIFF server API
+# LIFF Server API.
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# 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 Liff
+        class LiffFeatures
+          attr_accessor ble: bool?
+          attr_accessor qr_code: bool?
+          
+
+          # @param ble [bool,nil] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. 
+          # @param qr_code [bool,nil] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. 
+          def initialize: (
+            ?ble: bool?,
+            ?qr_code: bool?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Liff::LiffFeatures] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> LiffFeatures
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/liff/model/liff_scope.rbs

@@ -0,0 +1,21 @@
+# LIFF server API
+# LIFF Server API.
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# 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 Liff
+        # Array of scopes required for some LIFF SDK methods to function. The default value is `[\"profile\", \"chat_message.write\"]`.  
+        class LiffScope
+          
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/liff/model/liff_view.rbs

@@ -0,0 +1,46 @@
+# LIFF server API
+# LIFF Server API.
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# 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 Liff
+        # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app
+        class LiffView
+          attr_accessor type: 'compact'|'tall'|'full'
+          attr_accessor url: String
+          attr_accessor module_mode: bool?
+          
+
+          # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full 
+          # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. 
+          # @param module_mode [bool,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. 
+          def initialize: (
+            type: 'compact'|'tall'|'full',
+            url: String,
+            ?module_mode: bool?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Liff::LiffView] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> LiffView
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/liff/model/update_liff_app_request.rbs

@@ -0,0 +1,55 @@
+# LIFF server API
+# LIFF Server API.
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# 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 Liff
+        # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app
+        class UpdateLiffAppRequest
+          attr_accessor view: UpdateLiffView?
+          attr_accessor description: String?
+          attr_accessor features: LiffFeatures?
+          attr_accessor permanent_link_pattern: String?
+          attr_accessor scope: Array['openid'|'email'|'profile'|'chat_message.write']?
+          attr_accessor bot_prompt: 'normal'|'aggressive'|'none'?
+          
+
+          # @param view [UpdateLiffView, Hash[Symbol, untyped], nil] 
+          # @param description [String,nil] Name of the LIFF app.  The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. 
+          # @param features [LiffFeatures, Hash[Symbol, untyped], nil] 
+          # @param permanent_link_pattern [String,nil] How additional information in LIFF URLs is handled. Specify `concat`. 
+          # @param scope [Array['openid','email','profile','chat_message.write'],nil] 
+          # @param bot_prompt [String,nil] ('normal'|'aggressive'|'none') 
+          def initialize: (
+            ?view: UpdateLiffView?| Hash[Symbol, untyped]?,
+            ?description: String?,
+            ?features: LiffFeatures?| Hash[Symbol, untyped]?,
+            ?permanent_link_pattern: String?,
+            ?scope: Array['openid'|'email'|'profile'|'chat_message.write']?,
+            ?bot_prompt: 'normal'|'aggressive'|'none'?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Liff::UpdateLiffAppRequest] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UpdateLiffAppRequest
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/liff/model/update_liff_view.rbs

@@ -0,0 +1,46 @@
+# LIFF server API
+# LIFF Server API.
+#
+# The version of the OpenAPI document: 1.0.0
+#
+# 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 Liff
+        # @see https://developers.line.biz/en/reference/liff-server/#update-liff-app
+        class UpdateLiffView
+          attr_accessor type: 'compact'|'tall'|'full'?
+          attr_accessor url: String?
+          attr_accessor module_mode: bool?
+          
+
+          # @param type [String,nil] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full 
+          # @param url [String,nil] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. 
+          # @param module_mode [bool,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. 
+          def initialize: (
+            ?type: 'compact'|'tall'|'full'?,
+            ?url: String?,
+            ?module_mode: bool?,
+            **untyped dynamic_attributes
+          ) -> void
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Liff::UpdateLiffView] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UpdateLiffView
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==: (untyped other) -> bool
+
+          # @return [Integer] Hash code of the object
+          def hash: () -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/line/bot/v2/manage_audience/api/manage_audience_blob_client.rbs

@@ -0,0 +1,122 @@
+# 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
+        class ApiBlobClient
+          @http_client: HttpClient
+          # Initializes a new {Line::Bot::V2::ManageAudience::ApiBlobClient} instance.
+          #
+          # @param base_url [String] The base URL for requests (optional).
+          #   Defaults to 'https://api-data.line.me' if none is provided.
+          #   You can override this for testing or to use a mock server.
+          # @param channel_access_token [String] The channel access token for authorization.
+          # @param http_options [Hash] HTTP options (same as Net::HTTP options).
+          #   See: https://docs.ruby-lang.org/en/3.4/Net/HTTP.html to understand the options.
+          #
+          # @example
+          #   @client ||= Line::Bot::V2::ManageAudience::ApiBlobClient.new(
+          #     channel_access_token: "YOUR_CHANNEL_ACCESS_TOKEN",
+          #     http_options: {
+          #       open_timeout: 5,
+          #       read_timeout: 5,
+          #     }
+          #   )
+          def initialize: (
+            ?base_url: String?,
+            channel_access_token: String,
+            ?http_options: Hash[String|Symbol, untyped]
+          ) -> void
+
+          # Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
+          # This requests to <code>PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param file [File] A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 
+          # @param audience_group_id [Integer, nil] The audience ID.
+          # @param upload_description [String, nil] The description to register with the job
+          # @see https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 202
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def add_user_ids_to_audience_with_http_info: (
+            file: File, 
+            ?audience_group_id: Integer?, 
+            ?upload_description: String?
+          ) -> (
+            [String?, 202, Hash[untyped, untyped]] # when HTTP status code is 202
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
+          # This requests to <code>PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile</code>
+          # When you want to get HTTP status code or response headers, use {#add_user_ids_to_audience_with_http_info} instead of this.
+          #
+          # @param file [File] A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 
+          # @param audience_group_id [Integer, nil] The audience ID.
+          # @param upload_description [String, nil] The description to register with the job
+          # @see https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file
+          # @return [String, nil] when HTTP status code is 202
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def add_user_ids_to_audience: (
+            file: File, 
+            ?audience_group_id: Integer?, 
+            ?upload_description: String?
+          ) -> (
+            String? # when HTTP status code is 202
+            | String? # otherwise
+          )
+
+          # Create audience for uploading user IDs (by file).
+          # This requests to <code>POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param file [File] A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 
+          # @param description [String, nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 
+          # @param is_ifa_audience [bool, nil] To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. 
+          # @param upload_description [String, nil] The description to register for the job (in `jobs[].description`). 
+          # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group-by-file
+          # @return [Array(Line::Bot::V2::ManageAudience::CreateAudienceGroupResponse, Integer, Hash{String => String})] when HTTP status code is 202
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def create_audience_for_uploading_user_ids_with_http_info: (
+            file: File, 
+            ?description: String?, 
+            ?is_ifa_audience: bool?, 
+            ?upload_description: String?
+          ) -> (
+            [CreateAudienceGroupResponse, 202, Hash[untyped, untyped]] # when HTTP status code is 202
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Create audience for uploading user IDs (by file).
+          # This requests to <code>POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile</code>
+          # When you want to get HTTP status code or response headers, use {#create_audience_for_uploading_user_ids_with_http_info} instead of this.
+          #
+          # @param file [File] A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 
+          # @param description [String, nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 
+          # @param is_ifa_audience [bool, nil] To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. 
+          # @param upload_description [String, nil] The description to register for the job (in `jobs[].description`). 
+          # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group-by-file
+          # @return [Line::Bot::V2::ManageAudience::CreateAudienceGroupResponse] when HTTP status code is 202
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def create_audience_for_uploading_user_ids: (
+            file: File, 
+            ?description: String?, 
+            ?is_ifa_audience: bool?, 
+            ?upload_description: String?
+          ) -> (
+            CreateAudienceGroupResponse # when HTTP status code is 202
+            | String? # otherwise
+          )
+        end
+      end
+    end
+  end
+end