line-bot-api 1.29.1 → 1.30.0

data/sig/line/bot/v2/manage_audience/model/get_audience_data_response.rbs

@@ -0,0 +1,47 @@
+# 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
+        # Get audience data
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group
+        class GetAudienceDataResponse
+          attr_accessor audience_group: AudienceGroup?
+          attr_accessor jobs: Array[AudienceGroupJob]?
+          attr_accessor adaccount: Adaccount?
+          
+
+          # @param audience_group [AudienceGroup, Hash[Symbol, untyped], nil] 
+          # @param jobs [Array[AudienceGroupJob, Hash[Symbol, untyped]],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 
+          # @param adaccount [Adaccount, Hash[Symbol, untyped], nil] 
+          def initialize: (
+            ?audience_group: AudienceGroup?| Hash[Symbol, untyped]?,
+            ?jobs: Array[AudienceGroupJob| Hash[Symbol, untyped]]?,
+            ?adaccount: Adaccount?| Hash[Symbol, untyped]?,
+            **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::ManageAudience::GetAudienceDataResponse] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> GetAudienceDataResponse
+
+          # @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/model/get_audience_groups_response.rbs

@@ -0,0 +1,56 @@
+# 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
+        # Gets data for more than one audience.
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups
+        class GetAudienceGroupsResponse
+          attr_accessor audience_groups: Array[AudienceGroup]?
+          attr_accessor has_next_page: bool?
+          attr_accessor total_count: Integer?
+          attr_accessor read_write_audience_group_total_count: Integer?
+          attr_accessor page: Integer?
+          attr_accessor size: Integer?
+          
+
+          # @param audience_groups [Array[AudienceGroup, Hash[Symbol, untyped]],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
+          # @param has_next_page [bool,nil] true when this is not the last page.
+          # @param total_count [Integer,nil] The total number of audiences that can be returned with the specified filter.
+          # @param read_write_audience_group_total_count [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
+          # @param page [Integer,nil] The current page number.
+          # @param size [Integer,nil] The maximum number of audiences on the current page.
+          def initialize: (
+            ?audience_groups: Array[AudienceGroup| Hash[Symbol, untyped]]?,
+            ?has_next_page: bool?,
+            ?total_count: Integer?,
+            ?read_write_audience_group_total_count: Integer?,
+            ?page: Integer?,
+            ?size: Integer?,
+            **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::ManageAudience::GetAudienceGroupsResponse] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> GetAudienceGroupsResponse
+
+          # @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/model/get_shared_audience_data_response.rbs

@@ -0,0 +1,47 @@
+# 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
+        # Get audience data
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group
+        class GetSharedAudienceDataResponse
+          attr_accessor audience_group: AudienceGroup?
+          attr_accessor jobs: Array[AudienceGroupJob]?
+          attr_accessor owner: DetailedOwner?
+          
+
+          # @param audience_group [AudienceGroup, Hash[Symbol, untyped], nil] 
+          # @param jobs [Array[AudienceGroupJob, Hash[Symbol, untyped]],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 
+          # @param owner [DetailedOwner, Hash[Symbol, untyped], nil] 
+          def initialize: (
+            ?audience_group: AudienceGroup?| Hash[Symbol, untyped]?,
+            ?jobs: Array[AudienceGroupJob| Hash[Symbol, untyped]]?,
+            ?owner: DetailedOwner?| Hash[Symbol, untyped]?,
+            **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::ManageAudience::GetSharedAudienceDataResponse] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> GetSharedAudienceDataResponse
+
+          # @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/model/get_shared_audience_groups_response.rbs

@@ -0,0 +1,56 @@
+# 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
+        # Gets data for more than one audience.
+        # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups
+        class GetSharedAudienceGroupsResponse
+          attr_accessor audience_groups: Array[AudienceGroup]?
+          attr_accessor has_next_page: bool?
+          attr_accessor total_count: Integer?
+          attr_accessor read_write_audience_group_total_count: Integer?
+          attr_accessor page: Integer?
+          attr_accessor size: Integer?
+          
+
+          # @param audience_groups [Array[AudienceGroup, Hash[Symbol, untyped]],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
+          # @param has_next_page [bool,nil] true when this is not the last page.
+          # @param total_count [Integer,nil] The total number of audiences that can be returned with the specified filter.
+          # @param read_write_audience_group_total_count [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
+          # @param page [Integer,nil] The current page number.
+          # @param size [Integer,nil] The maximum number of audiences on the current page.
+          def initialize: (
+            ?audience_groups: Array[AudienceGroup| Hash[Symbol, untyped]]?,
+            ?has_next_page: bool?,
+            ?total_count: Integer?,
+            ?read_write_audience_group_total_count: Integer?,
+            ?page: Integer?,
+            ?size: Integer?,
+            **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::ManageAudience::GetSharedAudienceGroupsResponse] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> GetSharedAudienceGroupsResponse
+
+          # @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/model/update_audience_group_description_request.rbs

@@ -0,0 +1,41 @@
+# 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
+        # Rename an audience
+        # @see https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group
+        class UpdateAudienceGroupDescriptionRequest
+          attr_accessor description: String?
+          
+
+          # @param description [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 
+          def initialize: (
+            ?description: String?,
+            **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::ManageAudience::UpdateAudienceGroupDescriptionRequest] Instance of the class
+          def self.create: (Hash[Symbol, untyped]) -> UpdateAudienceGroupDescriptionRequest
+
+          # @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/messaging_api/api/messaging_api_blob_client.rbs

@@ -0,0 +1,196 @@
+# 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 ApiBlobClient
+          @http_client: HttpClient
+          # Initializes a new {Line::Bot::V2::MessagingApi::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::MessagingApi::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
+
+          # Download image, video, and audio data sent from users.
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param message_id [String] Message ID of video or audio
+          # @see https://developers.line.biz/en/reference/messaging-api/#get-content
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def get_message_content_with_http_info: (
+            message_id: String
+          ) -> (
+            [String?, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Download image, video, and audio data sent from users.
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content</code>
+          # When you want to get HTTP status code or response headers, use {#get_message_content_with_http_info} instead of this.
+          #
+          # @param message_id [String] Message ID of video or audio
+          # @see https://developers.line.biz/en/reference/messaging-api/#get-content
+          # @return [String, nil] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def get_message_content: (
+            message_id: String
+          ) -> (
+            String? # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Get a preview image of the image or video
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param message_id [String] Message ID of image or video
+          # @see https://developers.line.biz/en/reference/messaging-api/#get-image-or-video-preview
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def get_message_content_preview_with_http_info: (
+            message_id: String
+          ) -> (
+            [String?, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Get a preview image of the image or video
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview</code>
+          # When you want to get HTTP status code or response headers, use {#get_message_content_preview_with_http_info} instead of this.
+          #
+          # @param message_id [String] Message ID of image or video
+          # @see https://developers.line.biz/en/reference/messaging-api/#get-image-or-video-preview
+          # @return [String, nil] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def get_message_content_preview: (
+            message_id: String
+          ) -> (
+            String? # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Verify the preparation status of a video or audio for getting
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param message_id [String] Message ID of video or audio
+          # @see https://developers.line.biz/en/reference/messaging-api/#verify-video-or-audio-preparation-status
+          # @return [Array(Line::Bot::V2::MessagingApi::GetMessageContentTranscodingResponse, Integer, Hash{String => String})] when HTTP status code is 200
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def get_message_content_transcoding_by_message_id_with_http_info: (
+            message_id: String
+          ) -> (
+            [GetMessageContentTranscodingResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Verify the preparation status of a video or audio for getting
+          # This requests to <code>GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding</code>
+          # When you want to get HTTP status code or response headers, use {#get_message_content_transcoding_by_message_id_with_http_info} instead of this.
+          #
+          # @param message_id [String] Message ID of video or audio
+          # @see https://developers.line.biz/en/reference/messaging-api/#verify-video-or-audio-preparation-status
+          # @return [Line::Bot::V2::MessagingApi::GetMessageContentTranscodingResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def get_message_content_transcoding_by_message_id: (
+            message_id: String
+          ) -> (
+            GetMessageContentTranscodingResponse # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Download rich menu image.
+          # This requests to <code>GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param rich_menu_id [String] ID of the rich menu with the image to be downloaded
+          # @see https://developers.line.biz/en/reference/messaging-api/#download-rich-menu-image
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def get_rich_menu_image_with_http_info: (
+            rich_menu_id: String
+          ) -> (
+            [String?, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Download rich menu image.
+          # This requests to <code>GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content</code>
+          # When you want to get HTTP status code or response headers, use {#get_rich_menu_image_with_http_info} instead of this.
+          #
+          # @param rich_menu_id [String] ID of the rich menu with the image to be downloaded
+          # @see https://developers.line.biz/en/reference/messaging-api/#download-rich-menu-image
+          # @return [String, nil] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def get_rich_menu_image: (
+            rich_menu_id: String
+          ) -> (
+            String? # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Upload rich menu image
+          # This requests to <code>POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param rich_menu_id [String] The ID of the rich menu to attach the image to
+          # @param body [File, nil] 
+          # @see https://developers.line.biz/en/reference/messaging-api/#upload-rich-menu-image
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
+          def set_rich_menu_image_with_http_info: (
+            rich_menu_id: String, 
+            ?body: File?
+          ) -> (
+            [String?, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Upload rich menu image
+          # This requests to <code>POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content</code>
+          # When you want to get HTTP status code or response headers, use {#set_rich_menu_image_with_http_info} instead of this.
+          #
+          # @param rich_menu_id [String] The ID of the rich menu to attach the image to
+          # @param body [File, nil] 
+          # @see https://developers.line.biz/en/reference/messaging-api/#upload-rich-menu-image
+          # @return [String, nil] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def set_rich_menu_image: (
+            rich_menu_id: String, 
+            ?body: File?
+          ) -> (
+            String? # when HTTP status code is 200
+            | String? # otherwise
+          )
+        end
+      end
+    end
+  end
+end