Skip to content

Commit adaebbd

Browse files
authored
Implement wrapper method of issue_stateless_channel_token (#814)
## Summary - Add wrapper functions for the stateless channel access token API - The original `issueStatelessChannelToken` accepts all parameters for two different authentication patterns (JWT assertion and client secret), making it unclear which parameters to pass for each pattern. These wrappers make the distinction explicit through their names and signatures. - Supported variants: - `issueStatelessChannelTokenByJWTAssertion` / `issueStatelessChannelTokenByClientSecret` - `*WithHttpInfo` - `*Async` - `*AsyncWithHttpInfo` - The original methods (`issueStatelessChannelToken`, `issueStatelessChannelTokenWithHttpInfo`, `issueStatelessChannelTokenAsync`, `issueStatelessChannelTokenAsyncWithHttpInfo`) are marked as `@deprecated` with references to the new wrappers. ## Test plan - [x] Added tests for `issueStatelessChannelTokenByJWTAssertion` - [x] Added tests for `issueStatelessChannelTokenByClientSecret` - [x] Added tests for `issueStatelessChannelTokenByJWTAssertionAsync` - [x] Added tests for `issueStatelessChannelTokenByClientSecretAsync` - [x] Added tests for `issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo` - [x] Added tests for `issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo`
1 parent 6f2b7cd commit adaebbd

6 files changed

Lines changed: 1510 additions & 72 deletions

File tree

docs/classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html

Lines changed: 847 additions & 71 deletions
Large diffs are not rendered by default.

docs/js/searchIndex.js

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,46 @@ Search.appendIndex(
230230
"name": "createHttpClientOption",
231231
"summary": "Create\u0020http\u0020client\u0020option",
232232
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_createHttpClientOption"
233+
}, {
234+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByJWTAssertion\u0028\u0029",
235+
"name": "issueStatelessChannelTokenByJWTAssertion",
236+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020JWT\u0020assertion.",
237+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertion"
238+
}, {
239+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByClientSecret\u0028\u0029",
240+
"name": "issueStatelessChannelTokenByClientSecret",
241+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020client\u0020secret.",
242+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecret"
243+
}, {
244+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByJWTAssertionWithHttpInfo\u0028\u0029",
245+
"name": "issueStatelessChannelTokenByJWTAssertionWithHttpInfo",
246+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020JWT\u0020assertion\u0020\u0028with\u0020HTTP\u0020info\u0029.",
247+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionWithHttpInfo"
248+
}, {
249+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByClientSecretWithHttpInfo\u0028\u0029",
250+
"name": "issueStatelessChannelTokenByClientSecretWithHttpInfo",
251+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020client\u0020secret\u0020\u0028with\u0020HTTP\u0020info\u0029.",
252+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretWithHttpInfo"
253+
}, {
254+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByJWTAssertionAsync\u0028\u0029",
255+
"name": "issueStatelessChannelTokenByJWTAssertionAsync",
256+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020JWT\u0020assertion\u0020\u0028async\u0029.",
257+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionAsync"
258+
}, {
259+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByClientSecretAsync\u0028\u0029",
260+
"name": "issueStatelessChannelTokenByClientSecretAsync",
261+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020client\u0020secret\u0020\u0028async\u0029.",
262+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretAsync"
263+
}, {
264+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo\u0028\u0029",
265+
"name": "issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo",
266+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020JWT\u0020assertion\u0020\u0028async,\u0020with\u0020HTTP\u0020info\u0029.",
267+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo"
268+
}, {
269+
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AissueStatelessChannelTokenByClientSecretAsyncWithHttpInfo\u0028\u0029",
270+
"name": "issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo",
271+
"summary": "Issue\u0020a\u0020stateless\u0020channel\u0020access\u0020token\u0020by\u0020client\u0020secret\u0020\u0028async,\u0020with\u0020HTTP\u0020info\u0029.",
272+
"url": "classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo"
233273
}, {
234274
"fqsen": "\\LINE\\Clients\\ChannelAccessToken\\Api\\ChannelAccessTokenApi\u003A\u003AcontentTypes",
235275
"name": "contentTypes",

docs/reports/deprecated.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,46 @@ <h2 class="phpdocumentor-content__title">Deprecated</h2>
135135
<h3>Table of Contents</h3>
136136
<table class="phpdocumentor-table_of_contents">
137137
<tr>
138+
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/clients/channel-access-token/lib/Api/ChannelAccessTokenApi.php">src/clients/channel-access-token/lib/Api/ChannelAccessTokenApi.php</a></td>
139+
</tr>
140+
<tr>
138141
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/constants/StickerResourceType.php">src/constants/StickerResourceType.php</a></td>
139142
</tr>
140143
</table>
141144

145+
<a id="src/clients/channel-access-token/lib/Api/ChannelAccessTokenApi.php"></a>
146+
<h3><abbr title="src/clients/channel-access-token/lib/Api/ChannelAccessTokenApi.php">ChannelAccessTokenApi.php</abbr></h3>
147+
<table>
148+
<tr>
149+
<th class="phpdocumentor-heading">Line</th>
150+
<th class="phpdocumentor-heading">Element</th>
151+
<th class="phpdocumentor-heading">Reason</th>
152+
</tr>
153+
<tr>
154+
<td class="phpdocumentor-cell">1190</td>
155+
<td class="phpdocumentor-cell"><a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelToken"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelToken()">ChannelAccessTokenApi::issueStatelessChannelToken()</abbr></a></td>
156+
<td class="phpdocumentor-cell"><p>Use <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertion"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertion()">ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertion()</abbr></a> or <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecret"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecret()">ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecret()</abbr></a> instead.</p>
157+
</td>
158+
</tr>
159+
<tr>
160+
<td class="phpdocumentor-cell">1212</td>
161+
<td class="phpdocumentor-cell"><a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenWithHttpInfo()</abbr></a></td>
162+
<td class="phpdocumentor-cell"><p>Use <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionWithHttpInfo()</abbr></a> or <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretWithHttpInfo()</abbr></a> instead.</p>
163+
</td>
164+
</tr>
165+
<tr>
166+
<td class="phpdocumentor-cell">1340</td>
167+
<td class="phpdocumentor-cell"><a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenAsync"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenAsync()">ChannelAccessTokenApi::issueStatelessChannelTokenAsync()</abbr></a></td>
168+
<td class="phpdocumentor-cell"><p>Use <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionAsync"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionAsync()">ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionAsync()</abbr></a> or <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretAsync"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretAsync()">ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretAsync()</abbr></a> instead.</p>
169+
</td>
170+
</tr>
171+
<tr>
172+
<td class="phpdocumentor-cell">1365</td>
173+
<td class="phpdocumentor-cell"><a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenAsyncWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenAsyncWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenAsyncWithHttpInfo()</abbr></a></td>
174+
<td class="phpdocumentor-cell"><p>Use <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenByJWTAssertionAsyncWithHttpInfo()</abbr></a> or <a href="classes/LINE-Clients-ChannelAccessToken-Api-ChannelAccessTokenApi.html#method_issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo"><abbr title="\LINE\Clients\ChannelAccessToken\Api\ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo()">ChannelAccessTokenApi::issueStatelessChannelTokenByClientSecretAsyncWithHttpInfo()</abbr></a> instead.</p>
175+
</td>
176+
</tr>
177+
</table>
142178
<a id="src/constants/StickerResourceType.php"></a>
143179
<h3><abbr title="src/constants/StickerResourceType.php">StickerResourceType.php</abbr></h3>
144180
<table>

0 commit comments

Comments
 (0)