Skip to content

Commit a83bc52

Browse files
committed
NO-ISSUE gen
1 parent 53ce341 commit a83bc52

12 files changed

Lines changed: 1018 additions & 326 deletions

File tree

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

Lines changed: 88 additions & 38 deletions
Large diffs are not rendered by default.

lib/line/bot/v2/insight/api/insight_client.rb

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,11 @@ def initialize(base_url: nil, channel_access_token:, http_options: {})
4646
end
4747

4848
# Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).
49+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/demographic</tt>
4950
#
5051
# @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
52+
# @return [response body, response status code, and response headers]
53+
# @return [Array<(Line::Bot::V2::Insight::GetFriendsDemographicsResponse, Integer, Hash{String => String})>] when HTTP status code is 200
5154
def get_friends_demographics_with_http_info(
5255
)
5356
path = "/v2/bot/insight/demographic"
@@ -71,8 +74,11 @@ def get_friends_demographics_with_http_info(
7174
end
7275

7376
# Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).
77+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/demographic</tt>
78+
# When you want to get HTTP status code or response headers, use {#get_friends_demographics_with_http_info} instead of this.
7479
#
7580
# @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
81+
# @return [Line::Bot::V2::Insight::GetFriendsDemographicsResponse] when HTTP status code is 200
7682
def get_friends_demographics(
7783
)
7884
response_body, _status_code, _headers = get_friends_demographics_with_http_info(
@@ -82,10 +88,12 @@ def get_friends_demographics(
8288
end
8389

8490
# Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
91+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/event</tt>
8592
#
86-
# @summary Get user interaction statistics
87-
# @param request_id Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
93+
# @param request_id [String] Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
8894
# @see https://developers.line.biz/en/reference/messaging-api/#get-message-event
95+
# @return [response body, response status code, and response headers]
96+
# @return [Array<(Line::Bot::V2::Insight::GetMessageEventResponse, Integer, Hash{String => String})>] when HTTP status code is 200
8997
def get_message_event_with_http_info(
9098
request_id:
9199
)
@@ -114,10 +122,12 @@ def get_message_event_with_http_info(
114122
end
115123

116124
# Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
125+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/event</tt>
126+
# When you want to get HTTP status code or response headers, use {#get_message_event_with_http_info} instead of this.
117127
#
118-
# @summary Get user interaction statistics
119-
# @param request_id Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
128+
# @param request_id [String] Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
120129
# @see https://developers.line.biz/en/reference/messaging-api/#get-message-event
130+
# @return [Line::Bot::V2::Insight::GetMessageEventResponse] when HTTP status code is 200
121131
def get_message_event(
122132
request_id:
123133
)
@@ -129,10 +139,12 @@ def get_message_event(
129139
end
130140

131141
# Returns the number of users who have added the LINE Official Account on or before a specified date.
142+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/followers</tt>
132143
#
133-
# @summary Get number of followers
134-
# @param date Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
144+
# @param date [String] Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
135145
# @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers
146+
# @return [response body, response status code, and response headers]
147+
# @return [Array<(Line::Bot::V2::Insight::GetNumberOfFollowersResponse, Integer, Hash{String => String})>] when HTTP status code is 200
136148
def get_number_of_followers_with_http_info(
137149
date: nil
138150
)
@@ -161,10 +173,12 @@ def get_number_of_followers_with_http_info(
161173
end
162174

163175
# Returns the number of users who have added the LINE Official Account on or before a specified date.
176+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/followers</tt>
177+
# When you want to get HTTP status code or response headers, use {#get_number_of_followers_with_http_info} instead of this.
164178
#
165-
# @summary Get number of followers
166-
# @param date Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
179+
# @param date [String] Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
167180
# @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers
181+
# @return [Line::Bot::V2::Insight::GetNumberOfFollowersResponse] when HTTP status code is 200
168182
def get_number_of_followers(
169183
date: nil
170184
)
@@ -176,10 +190,12 @@ def get_number_of_followers(
176190
end
177191

178192
# Returns the number of messages sent from LINE Official Account on a specified day.
193+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/delivery</tt>
179194
#
180-
# @summary Get number of message deliveries
181-
# @param date Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
195+
# @param date [String] Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
182196
# @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages
197+
# @return [response body, response status code, and response headers]
198+
# @return [Array<(Line::Bot::V2::Insight::GetNumberOfMessageDeliveriesResponse, Integer, Hash{String => String})>] when HTTP status code is 200
183199
def get_number_of_message_deliveries_with_http_info(
184200
date:
185201
)
@@ -208,10 +224,12 @@ def get_number_of_message_deliveries_with_http_info(
208224
end
209225

210226
# Returns the number of messages sent from LINE Official Account on a specified day.
227+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/delivery</tt>
228+
# When you want to get HTTP status code or response headers, use {#get_number_of_message_deliveries_with_http_info} instead of this.
211229
#
212-
# @summary Get number of message deliveries
213-
# @param date Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
230+
# @param date [String] Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
214231
# @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages
232+
# @return [Line::Bot::V2::Insight::GetNumberOfMessageDeliveriesResponse] when HTTP status code is 200
215233
def get_number_of_message_deliveries(
216234
date:
217235
)
@@ -223,11 +241,14 @@ def get_number_of_message_deliveries(
223241
end
224242

225243
# You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.
244+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/event/aggregation</tt>
226245
#
227-
# @param custom_aggregation_unit Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
228-
# @param from Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
229-
# @param to End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
246+
# @param custom_aggregation_unit [String] Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
247+
# @param from [String] Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
248+
# @param to [String] End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
230249
# @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit
250+
# @return [response body, response status code, and response headers]
251+
# @return [Array<(Line::Bot::V2::Insight::GetStatisticsPerUnitResponse, Integer, Hash{String => String})>] when HTTP status code is 200
231252
def get_statistics_per_unit_with_http_info(
232253
custom_aggregation_unit:,
233254
from:,
@@ -260,11 +281,14 @@ def get_statistics_per_unit_with_http_info(
260281
end
261282

262283
# You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.
284+
# This requests to <tt>GET https://api.line.me/v2/bot/insight/message/event/aggregation</tt>
285+
# When you want to get HTTP status code or response headers, use {#get_statistics_per_unit_with_http_info} instead of this.
263286
#
264-
# @param custom_aggregation_unit Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
265-
# @param from Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
266-
# @param to End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
287+
# @param custom_aggregation_unit [String] Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
288+
# @param from [String] Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
289+
# @param to [String] End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
267290
# @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit
291+
# @return [Line::Bot::V2::Insight::GetStatisticsPerUnitResponse] when HTTP status code is 200
268292
def get_statistics_per_unit(
269293
custom_aggregation_unit:,
270294
from:,

lib/line/bot/v2/liff/api/liff_client.rb

Lines changed: 50 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@ def initialize(base_url: nil, channel_access_token:, http_options: {})
4646
end
4747

4848
# Adding the LIFF app to a channel
49+
# This requests to <tt>POST https://api.line.me/liff/v1/apps</tt>
4950
#
50-
# @summary Create LIFF app
51-
# @param add_liff_app_request
51+
# @param add_liff_app_request [AddLiffAppRequest]
5252
# @see https://developers.line.biz/en/reference/liff-server/#add-liff-app
53+
# @return [response body, response status code, and response headers]
54+
# @return [Array<(Line::Bot::V2::Liff::AddLiffAppResponse, Integer, Hash{String => String})>] when HTTP status code is 200
55+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 400
56+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 401
5357
def add_liff_app_with_http_info(
5458
add_liff_app_request:
5559
)
@@ -79,10 +83,14 @@ def add_liff_app_with_http_info(
7983
end
8084

8185
# Adding the LIFF app to a channel
86+
# This requests to <tt>POST https://api.line.me/liff/v1/apps</tt>
87+
# When you want to get HTTP status code or response headers, use {#add_liff_app_with_http_info} instead of this.
8288
#
83-
# @summary Create LIFF app
84-
# @param add_liff_app_request
89+
# @param add_liff_app_request [AddLiffAppRequest]
8590
# @see https://developers.line.biz/en/reference/liff-server/#add-liff-app
91+
# @return [Line::Bot::V2::Liff::AddLiffAppResponse] when HTTP status code is 200
92+
# @return [Net::ReadAdapter | String] when HTTP status code is 400
93+
# @return [Net::ReadAdapter | String] when HTTP status code is 401
8694
def add_liff_app(
8795
add_liff_app_request:
8896
)
@@ -94,10 +102,14 @@ def add_liff_app(
94102
end
95103

96104
# Deletes a LIFF app from a channel.
105+
# This requests to <tt>DELETE https://api.line.me/liff/v1/apps/{liffId}</tt>
97106
#
98-
# @summary Delete LIFF app from a channel
99-
# @param liff_id ID of the LIFF app to be updated
107+
# @param liff_id [String] ID of the LIFF app to be updated
100108
# @see https://developers.line.biz/en/reference/liff-server/#delete-liff-app
109+
# @return [response body, response status code, and response headers]
110+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 200
111+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 401
112+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 404
101113
def delete_liff_app_with_http_info(
102114
liff_id:
103115
)
@@ -123,10 +135,14 @@ def delete_liff_app_with_http_info(
123135
end
124136

125137
# Deletes a LIFF app from a channel.
138+
# This requests to <tt>DELETE https://api.line.me/liff/v1/apps/{liffId}</tt>
139+
# When you want to get HTTP status code or response headers, use {#delete_liff_app_with_http_info} instead of this.
126140
#
127-
# @summary Delete LIFF app from a channel
128-
# @param liff_id ID of the LIFF app to be updated
141+
# @param liff_id [String] ID of the LIFF app to be updated
129142
# @see https://developers.line.biz/en/reference/liff-server/#delete-liff-app
143+
# @return [Net::ReadAdapter | String] when HTTP status code is 200
144+
# @return [Net::ReadAdapter | String] when HTTP status code is 401
145+
# @return [Net::ReadAdapter | String] when HTTP status code is 404
130146
def delete_liff_app(
131147
liff_id:
132148
)
@@ -138,9 +154,13 @@ def delete_liff_app(
138154
end
139155

140156
# Gets information on all the LIFF apps added to the channel.
157+
# This requests to <tt>GET https://api.line.me/liff/v1/apps</tt>
141158
#
142-
# @summary Get all LIFF apps
143159
# @see https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps
160+
# @return [response body, response status code, and response headers]
161+
# @return [Array<(Line::Bot::V2::Liff::GetAllLiffAppsResponse, Integer, Hash{String => String})>] when HTTP status code is 200
162+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 401
163+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 404
144164
def get_all_liff_apps_with_http_info(
145165
)
146166
path = "/liff/v1/apps"
@@ -168,9 +188,13 @@ def get_all_liff_apps_with_http_info(
168188
end
169189

170190
# Gets information on all the LIFF apps added to the channel.
191+
# This requests to <tt>GET https://api.line.me/liff/v1/apps</tt>
192+
# When you want to get HTTP status code or response headers, use {#get_all_liff_apps_with_http_info} instead of this.
171193
#
172-
# @summary Get all LIFF apps
173194
# @see https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps
195+
# @return [Line::Bot::V2::Liff::GetAllLiffAppsResponse] when HTTP status code is 200
196+
# @return [Net::ReadAdapter | String] when HTTP status code is 401
197+
# @return [Net::ReadAdapter | String] when HTTP status code is 404
174198
def get_all_liff_apps(
175199
)
176200
response_body, _status_code, _headers = get_all_liff_apps_with_http_info(
@@ -180,11 +204,16 @@ def get_all_liff_apps(
180204
end
181205

182206
# Update LIFF app settings
207+
# This requests to <tt>PUT https://api.line.me/liff/v1/apps/{liffId}</tt>
183208
#
184-
# @summary Update LIFF app from a channel
185-
# @param liff_id ID of the LIFF app to be updated
186-
# @param update_liff_app_request
209+
# @param liff_id [String] ID of the LIFF app to be updated
210+
# @param update_liff_app_request [UpdateLiffAppRequest]
187211
# @see https://developers.line.biz/en/reference/liff-server/#update-liff-app
212+
# @return [response body, response status code, and response headers]
213+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 200
214+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 400
215+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 401
216+
# @return [Array<(Net::ReadAdapter | String, Integer, Hash{String => String})>] when HTTP status code is 404
188217
def update_liff_app_with_http_info(
189218
liff_id:,
190219
update_liff_app_request:
@@ -214,11 +243,16 @@ def update_liff_app_with_http_info(
214243
end
215244

216245
# Update LIFF app settings
246+
# This requests to <tt>PUT https://api.line.me/liff/v1/apps/{liffId}</tt>
247+
# When you want to get HTTP status code or response headers, use {#update_liff_app_with_http_info} instead of this.
217248
#
218-
# @summary Update LIFF app from a channel
219-
# @param liff_id ID of the LIFF app to be updated
220-
# @param update_liff_app_request
249+
# @param liff_id [String] ID of the LIFF app to be updated
250+
# @param update_liff_app_request [UpdateLiffAppRequest]
221251
# @see https://developers.line.biz/en/reference/liff-server/#update-liff-app
252+
# @return [Net::ReadAdapter | String] when HTTP status code is 200
253+
# @return [Net::ReadAdapter | String] when HTTP status code is 400
254+
# @return [Net::ReadAdapter | String] when HTTP status code is 401
255+
# @return [Net::ReadAdapter | String] when HTTP status code is 404
222256
def update_liff_app(
223257
liff_id:,
224258
update_liff_app_request:

0 commit comments

Comments
 (0)