line-bot-api 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a902dcd5bceef1f010e251916c199f4ba52787191339ae9693ec8c978a75fc08
-  data.tar.gz: 6cbfdede37b9585586dd6fda6d57ec6a417fd65ff153cf672f90c20624e7ba4a
+  metadata.gz: b3acf96654a14ee4debeb4eb0c765e1b37ae8528dd885ac089a2622022334478
+  data.tar.gz: 0666c4e49938d1de7c635da1b88928acf60b071c60781840eea5ec2803989ffa
 SHA512:
-  metadata.gz: bb1485178aefac4be9af75152f97d173f65f2d179bbcd9e5af70561d056158649d46e1608a5615a1b94ad3efd13d387b5dee58d2fc3c3b166a20c78733fef914
-  data.tar.gz: 4fa37b4b42ee74cc0049ae77cec8957559ba5090a84d3a7eb456cb53d720b8e8652f3e0d1446e47e14dd0e96f4f8fd2022bb6f54de1d6ff457e25ba192ba7a59
+  metadata.gz: 86874a817aa198297c3a0d6c9d8b9cafb0bf9d9005c18e438bc28aeccb6cbcd5dbaba768d7d587a346fac414dbaffbb790626cbb7a928156fb4b1f0c3d9932af
+  data.tar.gz: bed15858b6124bbaab49eea34be519cc5e25041e6e220882cd3634a6d80649c7240bff91fb46c7d3675292d415ffa52ba7440859d68d7967be6ae99268fb1583

data/lib/line/bot/v2/channel_access_token/api/channel_access_token_client.rb

@@ -237,6 +237,10 @@ module Line
             response_body
           end
 
+          # @deprecated
+          # This is deprecated.
+          # Please use {#issue_stateless_channel_token_by_jwt_assertion_with_http_info} or {#issue_stateless_channel_token_by_client_secret_with_http_info} instead.
+          #
           # Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. 
           # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
           # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -284,6 +288,10 @@ module Line
             end
           end
 
+          # @deprecated
+          # This is deprecated.
+          # Please use {#issue_stateless_channel_token_by_jwt_assertion} or {#issue_stateless_channel_token_by_client_secret} instead.
+          #
           # Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. 
           # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
           # When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_with_http_info} instead of this.
@@ -303,7 +311,7 @@ module Line
             client_id: nil,
             client_secret: nil
           )
-            response_body, _status_code, _headers = issue_stateless_channel_token_with_http_info(
+            response_body, _status_code, _headers = issue_stateless_channel_token_with_http_info( # steep:ignore DeprecatedReference
               grant_type: grant_type,
               client_assertion_type: client_assertion_type,
               client_assertion: client_assertion,
@@ -526,6 +534,87 @@ module Line
 
             response_body
           end
+
+          # Issues a new stateless channel access token by JWT assertion, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for JWT assertion authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_by_jwt_assertion_with_http_info} instead of this.
+          #
+          # @param client_assertion [String] A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def issue_stateless_channel_token_by_jwt_assertion(
+            client_assertion:
+          )
+            issue_stateless_channel_token( # steep:ignore DeprecatedReference
+              grant_type: 'client_credentials',
+              client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+              client_assertion: client_assertion
+            )
+          end
+
+          # Issues a new stateless channel access token by client secret, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for client secret authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_by_client_secret_with_http_info} instead of this.
+          #
+          # @param client_id [String] Channel ID.
+          # @param client_secret [String] Channel secret.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def issue_stateless_channel_token_by_client_secret(
+            client_id:,
+            client_secret:
+          )
+            issue_stateless_channel_token( # steep:ignore DeprecatedReference
+              grant_type: 'client_credentials',
+              client_id: client_id,
+              client_secret: client_secret
+            )
+          end
+
+          # Issues a new stateless channel access token by JWT assertion, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for JWT assertion authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param client_assertion [String] A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, 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 issue_stateless_channel_token_by_jwt_assertion_with_http_info(
+            client_assertion:
+          )
+            issue_stateless_channel_token_with_http_info( # steep:ignore DeprecatedReference
+              grant_type: 'client_credentials',
+              client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+              client_assertion: client_assertion
+            )
+          end
+
+          # Issues a new stateless channel access token by client secret, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for client secret authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param client_id [String] Channel ID.
+          # @param client_secret [String] Channel secret.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, 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 issue_stateless_channel_token_by_client_secret_with_http_info(
+            client_id:,
+            client_secret:
+          )
+            issue_stateless_channel_token_with_http_info( # steep:ignore DeprecatedReference
+              grant_type: 'client_credentials',
+              client_id: client_id,
+              client_secret: client_secret
+            )
+          end
+
         end
       end
     end

data/lib/line/bot/version.rb

@@ -2,6 +2,6 @@ module Line
   module Bot
     # This version is updated before releasing a new version in the release process.
     # You don't have to update this version manually.
-    VERSION = "2.6.1"
+    VERSION = "2.7.0"
   end
 end

data/sig/line/bot/v2/channel_access_token/api/channel_access_token_client.rbs

@@ -159,6 +159,7 @@ module Line
           # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
           # @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, 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.
+          %a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion_with_http_info or #issue_stateless_channel_token_by_client_secret_with_http_info instead}
           def issue_stateless_channel_token_with_http_info: (
             ?grant_type: String?, 
             ?client_assertion_type: String?, 
@@ -182,6 +183,7 @@ module Line
           # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
           # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
           # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          %a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion or #issue_stateless_channel_token_by_client_secret instead}
           def issue_stateless_channel_token: (
             ?grant_type: String?, 
             ?client_assertion_type: String?, 
@@ -320,6 +322,75 @@ module Line
             VerifyChannelAccessTokenResponse # when HTTP status code is 200
             | String? # otherwise
           )
+
+          # Issues a new stateless channel access token by JWT assertion, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for JWT assertion authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_by_jwt_assertion_with_http_info} instead of this.
+          #
+          # @param client_assertion [String] A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def issue_stateless_channel_token_by_jwt_assertion: (
+            client_assertion: String
+          ) -> (
+            IssueStatelessChannelAccessTokenResponse # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Issues a new stateless channel access token by client secret, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for client secret authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_by_client_secret_with_http_info} instead of this.
+          #
+          # @param client_id [String] Channel ID.
+          # @param client_secret [String] Channel secret.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
+          def issue_stateless_channel_token_by_client_secret: (
+            client_id: String,
+            client_secret: String
+          ) -> (
+            IssueStatelessChannelAccessTokenResponse # when HTTP status code is 200
+            | String? # otherwise
+          )
+
+          # Issues a new stateless channel access token by JWT assertion, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for JWT assertion authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param client_assertion [String] A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, 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 issue_stateless_channel_token_by_jwt_assertion_with_http_info: (
+            client_assertion: String
+          ) -> (
+            [IssueStatelessChannelAccessTokenResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
+          # Issues a new stateless channel access token by client secret, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
+          # This is a convenience wrapper that only requires the parameters needed for client secret authentication.
+          # This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
+          #
+          # @param client_id [String] Channel ID.
+          # @param client_secret [String] Channel secret.
+          # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
+          # @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, 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 issue_stateless_channel_token_by_client_secret_with_http_info: (
+            client_id: String,
+            client_secret: String
+          ) -> (
+            [IssueStatelessChannelAccessTokenResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
+            | [String?, Integer, Hash[untyped, untyped]] # otherwise
+          )
+
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - LINE Corporation
@@ -760,7 +760,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: SDK of the LINE Messaging API for Ruby
 test_files: []