line-bot-api 1.29.1 → 1.30.0

data/lib/line/bot/v2/module/model/get_modules_response.rb

@@ -0,0 +1,80 @@
+# 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 Module
+        # List of bots to which the module is attached
+        # @see https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api
+        class GetModulesResponse
+          # @!attribute [rw] bots
+          #   @return [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot.
+          attr_accessor :bots
+          # @!attribute [rw] _next
+          #   @return [String,nil] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. 
+          attr_accessor :_next
+
+          # @param bots [Array[ModuleBot, Hash[Symbol, untyped]]] Array of Bot list Item objects representing basic information about the bot.
+          # @param _next [String,nil] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. 
+          def initialize(
+            bots:,
+            _next: nil,
+            **dynamic_attributes
+          )
+            
+            @bots = bots.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::Module::ModuleBot.create(**item) # steep:ignore InsufficientKeywordArguments
+              else
+                item
+              end
+            end
+            @_next = _next
+
+            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::Module::GetModulesResponse] 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/module/model/module_bot.rb

@@ -0,0 +1,92 @@
+# 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 Module
+        # basic information about the bot.
+        # @see https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api
+        class ModuleBot
+          # @!attribute [rw] user_id
+          #   @return [String] Bot's user ID
+          attr_accessor :user_id
+          # @!attribute [rw] basic_id
+          #   @return [String] Bot's basic ID
+          attr_accessor :basic_id
+          # @!attribute [rw] premium_id
+          #   @return [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set.
+          attr_accessor :premium_id
+          # @!attribute [rw] display_name
+          #   @return [String] Bot's display name
+          attr_accessor :display_name
+          # @!attribute [rw] picture_url
+          #   @return [String,nil] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image.
+          attr_accessor :picture_url
+
+          # @param user_id [String] Bot's user ID
+          # @param basic_id [String] Bot's basic ID
+          # @param premium_id [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set.
+          # @param display_name [String] Bot's display name
+          # @param picture_url [String,nil] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image.
+          def initialize(
+            user_id:,
+            basic_id:,
+            premium_id: nil,
+            display_name:,
+            picture_url: nil,
+            **dynamic_attributes
+          )
+            
+            @user_id = user_id
+            @basic_id = basic_id
+            @premium_id = premium_id
+            @display_name = display_name
+            @picture_url = picture_url
+
+            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::Module::ModuleBot] 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/module_attach/api/line_module_attach_client.rb

@@ -0,0 +1,160 @@
+# 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 'json'
+
+require 'line/bot/v2/http_client'
+require 'line/bot/v2/reserved_words'
+require 'line/bot/v2/utils'
+
+module Line
+  module Bot
+    module V2
+      module ModuleAttach
+        class ApiClient
+          # Initializes a new {Line::Bot::V2::ModuleAttach::ApiClient} instance.
+          #
+          # @param base_url [String] The base URL for requests (optional).
+          #   Defaults to 'https://manager.line.biz' if none is provided.
+          #   You can override this for testing or to use a mock server.
+          # @param channel_id [String] The channel ID for Basic authentication.
+          # @param channel_secret [String] The channel secret for Basic authentication.
+          # @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::ModuleAttach::ApiClient.new(
+          #     channel_id: "YOUR_CHANNEL_ID",
+          #     channel_secret: "YOUR_CHANNEL_SECRET",
+          #     http_options: {
+          #       open_timeout: 5,
+          #       read_timeout: 5,
+          #     }
+          #   )
+          def initialize(base_url: nil, channel_id:, channel_secret:, http_options: {})
+            @http_client = HttpClient.new(
+              base_url: base_url || 'https://manager.line.biz',
+              http_headers: {
+                Authorization: 'Basic ' + Base64.encode64("#{channel_id}:#{channel_secret}")
+              },
+              http_options: http_options
+            )
+          end
+
+          # Attach by operation of the module channel provider
+          # This requests to <code>POST https://manager.line.biz/module/auth/v1/token</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param grant_type [String] authorization_code
+          # @param code [String] Authorization code received from the LINE Platform.
+          # @param redirect_uri [String] Specify the redirect_uri specified in the URL for authentication and authorization.
+          # @param code_verifier [String, nil] Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
+          # @param client_id [String, nil] Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console. 
+          # @param client_secret [String, nil] Instead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console. 
+          # @param region [String, nil] If you specified a value for region in the URL for authentication and authorization, specify the same value. 
+          # @param basic_search_id [String, nil] If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
+          # @param scope [String, nil] If you specified a value for scope in the URL for authentication and authorization, specify the same value.
+          # @param brand_type [String, nil] If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.
+          # @see https://developers.line.biz/en/reference/partner-docs/#link-attach-by-operation-module-channel-provider
+          # @return [Array(Line::Bot::V2::ModuleAttach::AttachModuleResponse, 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 attach_module_with_http_info( # steep:ignore MethodBodyTypeMismatch 
+            grant_type:, 
+            code:, 
+            redirect_uri:, 
+            code_verifier: nil, 
+            client_id: nil, 
+            client_secret: nil, 
+            region: nil, 
+            basic_search_id: nil, 
+            scope: nil, 
+            brand_type: nil
+          )
+            path = "/module/auth/v1/token"
+
+            form_params = {
+              "grant_type": grant_type,
+              "code": code,
+              "redirect_uri": redirect_uri,
+              "code_verifier": code_verifier,
+              "client_id": client_id,
+              "client_secret": client_secret,
+              "region": region,
+              "basic_search_id": basic_search_id,
+              "scope": scope,
+              "brand_type": brand_type
+            }.compact
+
+            response = @http_client.post_form(
+              path: path,
+              form_params: form_params,
+            )
+
+            case response.code.to_i
+            when 200
+              json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
+              json.transform_keys! do |key|
+                Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
+              end
+              response_body = Line::Bot::V2::ModuleAttach::AttachModuleResponse.create(json) # steep:ignore InsufficientKeywordArguments
+              [response_body, 200, response.each_header.to_h]
+            else
+              [response.body, response.code.to_i, response.each_header.to_h]
+            end
+          end
+
+          # Attach by operation of the module channel provider
+          # This requests to <code>POST https://manager.line.biz/module/auth/v1/token</code>
+          # When you want to get HTTP status code or response headers, use {#attach_module_with_http_info} instead of this.
+          #
+          # @param grant_type [String] authorization_code
+          # @param code [String] Authorization code received from the LINE Platform.
+          # @param redirect_uri [String] Specify the redirect_uri specified in the URL for authentication and authorization.
+          # @param code_verifier [String, nil] Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
+          # @param client_id [String, nil] Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console. 
+          # @param client_secret [String, nil] Instead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console. 
+          # @param region [String, nil] If you specified a value for region in the URL for authentication and authorization, specify the same value. 
+          # @param basic_search_id [String, nil] If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
+          # @param scope [String, nil] If you specified a value for scope in the URL for authentication and authorization, specify the same value.
+          # @param brand_type [String, nil] If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.
+          # @see https://developers.line.biz/en/reference/partner-docs/#link-attach-by-operation-module-channel-provider
+          # @return [Line::Bot::V2::ModuleAttach::AttachModuleResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def attach_module(
+            grant_type:,
+            code:,
+            redirect_uri:,
+            code_verifier: nil,
+            client_id: nil,
+            client_secret: nil,
+            region: nil,
+            basic_search_id: nil,
+            scope: nil,
+            brand_type: nil
+          )
+            response_body, _status_code, _headers = attach_module_with_http_info(
+              grant_type: grant_type,
+              code: code,
+              redirect_uri: redirect_uri,
+              code_verifier: code_verifier,
+              client_id: client_id,
+              client_secret: client_secret,
+              region: region,
+              basic_search_id: basic_search_id,
+              scope: scope,
+              brand_type: brand_type
+            )
+
+            response_body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/module_attach/core.rb

@@ -0,0 +1,15 @@
+
+# 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.
+
+# Models
+require_relative './model/attach_module_response'
+
+# APIs
+require_relative './api/line_module_attach_client'

data/lib/line/bot/v2/module_attach/model/attach_module_response.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 ModuleAttach
+        # Attach by operation of the module channel provider
+        class AttachModuleResponse
+          # @!attribute [rw] bot_id
+          #   @return [String] User ID of the bot on the LINE Official Account.
+          attr_accessor :bot_id
+          # @!attribute [rw] scopes
+          #   @return [Array[String]] Permissions (scope) granted by the LINE Official Account admin.
+          attr_accessor :scopes
+
+          # @param bot_id [String] User ID of the bot on the LINE Official Account.
+          # @param scopes [Array[String]] Permissions (scope) granted by the LINE Official Account admin.
+          def initialize(
+            bot_id:,
+            scopes:,
+            **dynamic_attributes
+          )
+            
+            @bot_id = bot_id
+            @scopes = scopes
+
+            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::ModuleAttach::AttachModuleResponse] 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/reserved_words.rb

@@ -0,0 +1,50 @@
+module Line
+  module Bot
+    module V2
+      # CodeGen add _ prefix to reserved words
+      # see: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractRubyCodegen.java
+      RESERVED_WORDS = %i[
+        __FILE__
+        and
+        def
+        end
+        in
+        or
+        self
+        unless
+        __LINE__
+        begin
+        defined?
+        ensure
+        module
+        redo
+        super
+        until
+        BEGIN
+        break
+        do
+        false
+        next
+        rescue
+        then
+        when
+        END
+        case
+        else
+        for
+        nil
+        retry
+        true
+        while
+        alias
+        class
+        elsif
+        if
+        not
+        return
+        undef
+        yield
+      ]
+    end
+  end
+end

data/lib/line/bot/v2/shop/api/shop_client.rb

@@ -0,0 +1,95 @@
+# Mission Stickers API
+# This document describes LINE Mission Stickers 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 'json'
+
+require 'line/bot/v2/http_client'
+require 'line/bot/v2/reserved_words'
+require 'line/bot/v2/utils'
+
+module Line
+  module Bot
+    module V2
+      module Shop
+        class ApiClient
+          # Initializes a new {Line::Bot::V2::Shop::ApiClient} instance.
+          #
+          # @param base_url [String] The base URL for requests (optional).
+          #   Defaults to 'https://api.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::Shop::ApiClient.new(
+          #     channel_access_token: "YOUR_CHANNEL_ACCESS_TOKEN",
+          #     http_options: {
+          #       open_timeout: 5,
+          #       read_timeout: 5,
+          #     }
+          #   )
+          def initialize(base_url: nil, channel_access_token:, http_options: {})
+            @http_client = HttpClient.new(
+              base_url: base_url || 'https://api.line.me',
+              http_headers: {
+                Authorization: "Bearer #{channel_access_token}"
+              },
+              http_options: http_options
+            )
+          end
+
+          # Sends a mission sticker.
+          # This requests to <code>POST https://api.line.me/shop/v3/mission</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param mission_sticker_request [MissionStickerRequest] 
+          # @see https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3
+          # @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 mission_sticker_v3_with_http_info( # steep:ignore MethodBodyTypeMismatch 
+            mission_sticker_request:
+          )
+            path = "/shop/v3/mission"
+
+            response = @http_client.post(
+              path: path,
+              body_params: mission_sticker_request,
+            )
+
+            case response.code.to_i
+            when 200
+              [response.body, 200, response.each_header.to_h]
+            else
+              [response.body, response.code.to_i, response.each_header.to_h]
+            end
+          end
+
+          # Sends a mission sticker.
+          # This requests to <code>POST https://api.line.me/shop/v3/mission</code>
+          # When you want to get HTTP status code or response headers, use {#mission_sticker_v3_with_http_info} instead of this.
+          #
+          # @param mission_sticker_request [MissionStickerRequest] 
+          # @see https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3
+          # @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 mission_sticker_v3(
+            mission_sticker_request:
+          )
+            response_body, _status_code, _headers = mission_sticker_v3_with_http_info(
+              mission_sticker_request: mission_sticker_request
+            )
+
+            response_body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/bot/v2/shop/core.rb

@@ -0,0 +1,16 @@
+
+# Mission Stickers API
+# This document describes LINE Mission Stickers 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.
+
+# Models
+require_relative './model/error_response'
+require_relative './model/mission_sticker_request'
+
+# APIs
+require_relative './api/shop_client'

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

@@ -0,0 +1,67 @@
+# Mission Stickers API
+# This document describes LINE Mission Stickers 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 Shop
+        # @see https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3
+        class ErrorResponse
+          # @!attribute [rw] message
+          #   @return [String] Message containing information about the error.
+          attr_accessor :message
+
+          # @param message [String] Message containing information about the error.
+          def initialize(
+            message:,
+            **dynamic_attributes
+          )
+            
+            @message = message
+
+            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::Shop::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