Skip to content

Commit 6ba2162

Browse files
committed
fix externalDocs in model.mustache
1 parent cc816c4 commit 6ba2162

File tree

94 files changed

+641
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+641
-3
lines changed

generator/src/main/resources/line-bot-sdk-nodejs-generator/model.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export type {{classname}}{{#discriminator}}Base{{/discriminator}} = {{#parent}}{
3838
{{#description}}
3939
* {{{.}}}
4040
{{/description}}
41-
{{#externalDocs}}
41+
{{#externalDocumentation}}
4242
* {{description}}
43-
* @see <a href="{{url}}">{{summary}} Documentation</a>
44-
{{/externalDocs}}
43+
* @see <a href="{{url}}">{{name}} Documentation</a>
44+
{{/externalDocumentation}}
4545
*/
4646
'{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}/*{{#defaultValue}} = {{#isEnum}}{{classname}}.{{/isEnum}}{{{.}}}{{/defaultValue}}*/;
4747
{{/vars}}

lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
export type ChannelAccessTokenKeyIdsResponse = {
1717
/**
1818
* Array of channel access token key IDs.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-all-valid-channel-access-token-key-ids-v2-1">kids Documentation</a>
1921
*/
2022
kids: Array<string> /**/;
2123
};

lib/channel-access-token/model/issueChannelAccessTokenResponse.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,26 @@
1616
export type IssueChannelAccessTokenResponse = {
1717
/**
1818
* Channel access token.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1">accessToken Documentation</a>
1921
*/
2022
accessToken: string /**/;
2123
/**
2224
* Amount of time in seconds from issue to expiration of the channel access token
25+
*
26+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1">expiresIn Documentation</a>
2327
*/
2428
expiresIn: number /**/;
2529
/**
2630
* A token type.
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1">tokenType Documentation</a>
2733
*/
2834
tokenType: string /* = 'Bearer'*/;
2935
/**
3036
* Unique key ID for identifying the channel access token.
37+
*
38+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1">keyId Documentation</a>
3139
*/
3240
keyId: string /**/;
3341
};

lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,20 @@
1616
export type IssueShortLivedChannelAccessTokenResponse = {
1717
/**
1818
* A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token">accessToken Documentation</a>
1921
*/
2022
accessToken: string /**/;
2123
/**
2224
* Time until channel access token expires in seconds from time the token is issued.
25+
*
26+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token">expiresIn Documentation</a>
2327
*/
2428
expiresIn: number /**/;
2529
/**
2630
* Token type. The value is always `Bearer`.
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token">tokenType Documentation</a>
2733
*/
2834
tokenType: string /* = 'Bearer'*/;
2935
};

lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,20 @@
1616
export type IssueStatelessChannelAccessTokenResponse = {
1717
/**
1818
* 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.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token">accessToken Documentation</a>
1921
*/
2022
accessToken: string /**/;
2123
/**
2224
* Duration in seconds after which the issued access token expires
25+
*
26+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token">expiresIn Documentation</a>
2327
*/
2428
expiresIn: number /**/;
2529
/**
2630
* Token type. The value is always `Bearer`.
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token">tokenType Documentation</a>
2733
*/
2834
tokenType: string /* = 'Bearer'*/;
2935
};

lib/insight/model/errorResponse.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,14 @@ import { ErrorDetail } from "./errorDetail";
1414
export type ErrorResponse = {
1515
/**
1616
* Message containing information about the error.
17+
*
18+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#error-responses">message Documentation</a>
1719
*/
1820
message: string /**/;
1921
/**
2022
* An array of error details. If the array is empty, this property will not be included in the response.
23+
*
24+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#error-responses">details Documentation</a>
2125
*/
2226
details?: Array<ErrorDetail> /**/;
2327
};

lib/insight/model/getFriendsDemographicsResponse.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,38 @@ import { SubscriptionPeriodTile } from "./subscriptionPeriodTile";
2121
export type GetFriendsDemographicsResponse = {
2222
/**
2323
* true if friend demographic information is available.
24+
*
25+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">available Documentation</a>
2426
*/
2527
available?: boolean /**/;
2628
/**
2729
* Percentage per gender.
30+
*
31+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">genders Documentation</a>
2832
*/
2933
genders?: Array<GenderTile> /**/;
3034
/**
3135
* Percentage per age group.
36+
*
37+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">ages Documentation</a>
3238
*/
3339
ages?: Array<AgeTile> /**/;
3440
/**
3541
* Percentage per area.
42+
*
43+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">areas Documentation</a>
3644
*/
3745
areas?: Array<AreaTile> /**/;
3846
/**
3947
* Percentage by OS.
48+
*
49+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">appTypes Documentation</a>
4050
*/
4151
appTypes?: Array<AppTypeTile> /**/;
4252
/**
4353
* Percentage per friendship duration.
54+
*
55+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic">subscriptionPeriods Documentation</a>
4456
*/
4557
subscriptionPeriods?: Array<SubscriptionPeriodTile> /**/;
4658
};

lib/insight/model/getMessageEventResponse.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,20 @@ import { GetMessageEventResponseOverview } from "./getMessageEventResponseOvervi
1818
*/
1919
export type GetMessageEventResponse = {
2020
/**
21+
*
22+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response">overview Documentation</a>
2123
*/
2224
overview?: GetMessageEventResponseOverview /**/;
2325
/**
2426
* Array of information about individual message bubbles.
27+
*
28+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response">messages Documentation</a>
2529
*/
2630
messages?: Array<GetMessageEventResponseMessage> /**/;
2731
/**
2832
* Array of information about opened URLs in the message.
33+
*
34+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response">clicks Documentation</a>
2935
*/
3036
clicks?: Array<GetMessageEventResponseClick> /**/;
3137
};

lib/insight/model/getNumberOfFollowersResponse.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,26 @@
1616
export type GetNumberOfFollowersResponse = {
1717
/**
1818
* Calculation status.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">status Documentation</a>
1921
*/
2022
status?: GetNumberOfFollowersResponse.StatusEnum /**/;
2123
/**
2224
* The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn\'t decrease even if a user later blocks the account or when they delete their LINE account.
25+
*
26+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">followers Documentation</a>
2327
*/
2428
followers?: number /**/;
2529
/**
2630
* The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">targetedReaches Documentation</a>
2733
*/
2834
targetedReaches?: number /**/;
2935
/**
3036
* The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.
37+
*
38+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">blocks Documentation</a>
3139
*/
3240
blocks?: number /**/;
3341
};

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,46 +16,68 @@
1616
export type GetNumberOfMessageDeliveriesResponse = {
1717
/**
1818
* Status of the counting process.
19+
*
20+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">status Documentation</a>
1921
*/
2022
status?: GetNumberOfMessageDeliveriesResponse.StatusEnum /**/;
2123
/**
2224
* Number of messages sent to all of this LINE Official Account\'s friends (broadcast messages).
25+
*
26+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">broadcast Documentation</a>
2327
*/
2428
broadcast?: number /**/;
2529
/**
2630
* Number of messages sent to some of this LINE Official Account\'s friends, based on specific attributes (targeted messages).
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">targeting Documentation</a>
2733
*/
2834
targeting?: number /**/;
2935
/**
3036
* Number of auto-response messages sent.
37+
*
38+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">autoResponse Documentation</a>
3139
*/
3240
autoResponse?: number /**/;
3341
/**
3442
* Number of greeting messages sent.
43+
*
44+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">welcomeResponse Documentation</a>
3545
*/
3646
welcomeResponse?: number /**/;
3747
/**
3848
* Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese).
49+
*
50+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">chat Documentation</a>
3951
*/
4052
chat?: number /**/;
4153
/**
4254
* Number of broadcast messages sent with the `Send broadcast message` Messaging API operation.
55+
*
56+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">apiBroadcast Documentation</a>
4357
*/
4458
apiBroadcast?: number /**/;
4559
/**
4660
* Number of push messages sent with the `Send push message` Messaging API operation.
61+
*
62+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">apiPush Documentation</a>
4763
*/
4864
apiPush?: number /**/;
4965
/**
5066
* Number of multicast messages sent with the `Send multicast message` Messaging API operation.
67+
*
68+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">apiMulticast Documentation</a>
5169
*/
5270
apiMulticast?: number /**/;
5371
/**
5472
* Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation.
73+
*
74+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">apiNarrowcast Documentation</a>
5575
*/
5676
apiNarrowcast?: number /**/;
5777
/**
5878
* Number of replies sent with the `Send reply message` Messaging API operation.
79+
*
80+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">apiReply Documentation</a>
5981
*/
6082
apiReply?: number /**/;
6183
};

0 commit comments

Comments
 (0)