line-bot-api 1.29.1 → 1.30.0

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

@@ -0,0 +1,73 @@
+# Channel Access Token API
+# This document describes Channel Access Token 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 ChannelAccessToken
+        # Error response of the Channel access token
+        class ErrorResponse
+          # @!attribute [rw] error
+          #   @return [String,nil] Error summary
+          attr_accessor :error
+          # @!attribute [rw] error_description
+          #   @return [String,nil] Details of the error. Not returned in certain situations.
+          attr_accessor :error_description
+
+          # @param error [String,nil] Error summary
+          # @param error_description [String,nil] Details of the error. Not returned in certain situations.
+          def initialize(
+            error: nil,
+            error_description: nil,
+            **dynamic_attributes
+          )
+            
+            @error = error
+            @error_description = error_description
+
+            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::ChannelAccessToken::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/channel_access_token/model/issue_channel_access_token_response.rb

@@ -0,0 +1,86 @@
+# Channel Access Token API
+# This document describes Channel Access Token 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 ChannelAccessToken
+        # Issued channel access token
+        # @see https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1
+        class IssueChannelAccessTokenResponse
+          # @!attribute [rw] access_token
+          #   @return [String] Channel access token. 
+          attr_accessor :access_token
+          # @!attribute [rw] expires_in
+          #   @return [Integer] Amount of time in seconds from issue to expiration of the channel access token
+          attr_accessor :expires_in
+          # @!attribute [rw] token_type
+          #   @return [String] A token type.
+          attr_accessor :token_type
+          # @!attribute [rw] key_id
+          #   @return [String] Unique key ID for identifying the channel access token.
+          attr_accessor :key_id
+
+          # @param access_token [String] Channel access token. 
+          # @param expires_in [Integer] Amount of time in seconds from issue to expiration of the channel access token
+          # @param token_type [String] A token type.
+          # @param key_id [String] Unique key ID for identifying the channel access token.
+          def initialize(
+            access_token:,
+            expires_in:,
+            token_type: 'Bearer',
+            key_id:,
+            **dynamic_attributes
+          )
+            
+            @access_token = access_token
+            @expires_in = expires_in
+            @token_type = token_type
+            @key_id = key_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::ChannelAccessToken::IssueChannelAccessTokenResponse] 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/channel_access_token/model/issue_short_lived_channel_access_token_response.rb

@@ -0,0 +1,80 @@
+# Channel Access Token API
+# This document describes Channel Access Token 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 ChannelAccessToken
+        # Issued short-lived channel access token
+        # @see https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token
+        class IssueShortLivedChannelAccessTokenResponse
+          # @!attribute [rw] access_token
+          #   @return [String] A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. 
+          attr_accessor :access_token
+          # @!attribute [rw] expires_in
+          #   @return [Integer] Time until channel access token expires in seconds from time the token is issued.
+          attr_accessor :expires_in
+          # @!attribute [rw] token_type
+          #   @return [String] Token type. The value is always `Bearer`.
+          attr_accessor :token_type
+
+          # @param access_token [String] A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. 
+          # @param expires_in [Integer] Time until channel access token expires in seconds from time the token is issued.
+          # @param token_type [String] Token type. The value is always `Bearer`.
+          def initialize(
+            access_token:,
+            expires_in:,
+            token_type: 'Bearer',
+            **dynamic_attributes
+          )
+            
+            @access_token = access_token
+            @expires_in = expires_in
+            @token_type = token_type
+
+            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::ChannelAccessToken::IssueShortLivedChannelAccessTokenResponse] 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/channel_access_token/model/issue_stateless_channel_access_token_response.rb

@@ -0,0 +1,80 @@
+# Channel Access Token API
+# This document describes Channel Access Token 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 ChannelAccessToken
+        # Issued stateless channel access token
+        # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+        class IssueStatelessChannelAccessTokenResponse
+          # @!attribute [rw] access_token
+          #   @return [String] A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. 
+          attr_accessor :access_token
+          # @!attribute [rw] expires_in
+          #   @return [Integer] Duration in seconds after which the issued access token expires
+          attr_accessor :expires_in
+          # @!attribute [rw] token_type
+          #   @return [String] Token type. The value is always `Bearer`.
+          attr_accessor :token_type
+
+          # @param access_token [String] A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. 
+          # @param expires_in [Integer] Duration in seconds after which the issued access token expires
+          # @param token_type [String] Token type. The value is always `Bearer`.
+          def initialize(
+            access_token:,
+            expires_in:,
+            token_type: 'Bearer',
+            **dynamic_attributes
+          )
+            
+            @access_token = access_token
+            @expires_in = expires_in
+            @token_type = token_type
+
+            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::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] 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/channel_access_token/model/verify_channel_access_token_response.rb

@@ -0,0 +1,79 @@
+# Channel Access Token API
+# This document describes Channel Access Token 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 ChannelAccessToken
+        # Verification result
+        class VerifyChannelAccessTokenResponse
+          # @!attribute [rw] client_id
+          #   @return [String] The channel ID for which the channel access token was issued.
+          attr_accessor :client_id
+          # @!attribute [rw] expires_in
+          #   @return [Integer] Number of seconds before the channel access token expires.
+          attr_accessor :expires_in
+          # @!attribute [rw] scope
+          #   @return [String,nil] Permissions granted to the channel access token.
+          attr_accessor :scope
+
+          # @param client_id [String] The channel ID for which the channel access token was issued.
+          # @param expires_in [Integer] Number of seconds before the channel access token expires.
+          # @param scope [String,nil] Permissions granted to the channel access token.
+          def initialize(
+            client_id:,
+            expires_in:,
+            scope: nil,
+            **dynamic_attributes
+          )
+            
+            @client_id = client_id
+            @expires_in = expires_in
+            @scope = scope
+
+            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::ChannelAccessToken::VerifyChannelAccessTokenResponse] 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/http_client.rb

@@ -0,0 +1,165 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'net/http/post/multipart'
+require 'line/bot/version'
+
+module Line
+  module Bot
+    module V2
+      # This class is not intended for line-bot-sdk-ruby users. Breaking changes may occur; use at your own risk.
+
+      class HttpClient
+        # Initializes a new HttpClient instance.
+        #
+        # @param base_url [String] The base URL for requests.
+        # @param http_headers [Hash] The default HTTP headers.
+        # @param http_options [Hash] The HTTP options (same as Net::HTTP options).
+        # https://docs.ruby-lang.org/en/3.4/Net/HTTP.html#method-i-options
+        #
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def initialize(base_url:, http_headers: {}, http_options: {})
+          @base_url = base_url
+          @http_headers = { 'User-Agent': "LINE-BotSDK-Ruby/#{Line::Bot::VERSION}" }.merge(normalize_headers(headers: http_headers))
+          @http_options = http_options
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def get(path:, query_params: nil, headers: nil)
+          request = build_request(http_class: Net::HTTP::Get, path: path, query_params: query_params, headers: headers)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def post(path:, query_params: nil, body_params: nil, headers: nil)
+          request = build_request(http_class: Net::HTTP::Post, path: path, query_params: query_params, headers: headers, body_params: body_params)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def put(path:, query_params: nil, body_params: nil, headers: nil)
+          request = build_request(http_class: Net::HTTP::Put, path: path, query_params: query_params, headers: headers, body_params: body_params)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def delete(path:, query_params: nil, headers: nil)
+          request = build_request(http_class: Net::HTTP::Delete, path: path, query_params: query_params, headers: headers)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def post_form(path:, query_params: nil, form_params: nil, headers: nil)
+          request = build_form_request(http_class: Net::HTTP::Post, path: path, query_params: query_params, form_params: form_params, headers: headers)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def post_form_multipart(path:, query_params: nil, form_params: nil, headers: nil)
+          request = build_multipart_request(http_class: Net::HTTP::Post::Multipart, path: path, query_params: query_params, form_params: form_params, headers: headers)
+          perform_request(request: request)
+        end
+
+        # NOTE: line-bot-sdk-ruby users should not use this. Breaking changes may occur, so use at your own risk.
+        def put_form_multipart(path:, query_params: nil, form_params: nil, headers: nil)
+          request = build_multipart_request(http_class: Net::HTTP::Put::Multipart, path: path, query_params: query_params, form_params: form_params, headers: headers)
+          perform_request(request: request)
+        end
+
+        private
+
+        def build_request(http_class:, path:, query_params:, headers:, body_params: nil)
+          request_url = build_url(path: path, query_params: query_params)
+          request_headers = build_headers(headers: headers)
+          request = http_class.new(request_url, request_headers)
+
+          if body_params
+            if body_params.is_a?(File)
+              request['Content-Type'] = determine_content_type(file: body_params)
+              request.body = body_params.read
+            else
+              request['Content-Type'] = 'application/json'
+              request.body = Line::Bot::V2::Utils.deep_compact(
+                Line::Bot::V2::Utils.deep_camelize(
+                  Line::Bot::V2::Utils.deep_to_hash(body_params)
+                )
+              ).to_json
+            end
+          end
+
+          request
+        end
+
+        def build_form_request(http_class:, path:, query_params:, form_params:, headers:)
+          request_url = build_url(path: path, query_params: query_params)
+          request_headers = build_headers(headers: headers)
+          request = http_class.new(request_url, request_headers)
+
+          if form_params
+            request['Content-Type'] = 'application/x-www-form-urlencoded'
+            request.body = URI.encode_www_form(Line::Bot::V2::Utils.deep_to_hash(form_params))
+          end
+
+          request
+        end
+
+        def build_multipart_request(http_class:, path:, query_params:, form_params:, headers:)
+          request_url = build_url(path: path, query_params: query_params)
+          request_headers = build_headers(headers: headers)
+
+          file_params, non_file_params = form_params.partition { |_, value| value.is_a?(File) }.map(&:to_h) # steep:ignore NoMethod
+          params = Line::Bot::V2::Utils.deep_to_hash(non_file_params).merge(
+            file_params.transform_values { |value| UploadIO.new(value, 'text/plain', File.basename(value.path)) }
+          )
+
+          http_class.new(request_url, params, request_headers)
+        end
+
+        def build_url(path:, query_params:)
+          uri = URI.join(@base_url, path)
+          uri.query = URI.encode_www_form(query_params) unless query_params.nil?
+          uri
+        end
+
+        def build_headers(headers: nil)
+          return @http_headers if headers.nil?
+
+          @http_headers.merge(normalize_headers(headers: headers))
+        end
+
+        def perform_request(request:)
+          Net::HTTP.start(request.uri.hostname, request.uri.port, use_ssl: request.uri.scheme == 'https') do |http| # steep:ignore ArgumentTypeMismatch
+            @http_options.each do |key, value|
+              http.send("#{key}=", value)
+            end if @http_options
+
+            http.request(request)
+          end
+        end
+
+        def determine_content_type(file:)
+          case File.extname(path=file.path).downcase
+          when '.txt'
+            'text/plain'
+          when '.jpg', '.jpeg'
+            'image/jpeg'
+          when '.png'
+            'image/png'
+          when '.gif'
+            'image/gif'
+          else
+            'application/octet-stream'
+          end
+        end
+
+        def normalize_headers(headers:)
+          return {} if headers.nil?
+
+          headers
+            .transform_keys(&:to_sym)
+            .transform_values(&:to_s)
+        end
+      end
+    end
+  end
+end