Class: Line::Bot::V2::MessagingApi::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/api/messaging_api_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(base_url: nil, channel_access_token:, http_options: {}) ⇒ ApiClient

Initializes a new Line::Bot::V2::MessagingApi::ApiClient instance.

Examples:

@client ||= Line::Bot::V2::MessagingApi::ApiClient.new(
  channel_access_token: "YOUR_CHANNEL_ACCESS_TOKEN",
  http_options: {
    open_timeout: 5,
    read_timeout: 5,
  }
)

Parameters:

  • base_url (String) (defaults to: nil) —

    The base URL for requests (optional). Defaults to ‘api.line.me’ if none is provided. You can override this for testing or to use a mock server.

  • channel_access_token (String) —

    The channel access token for authorization.

  • http_options (Hash) (defaults to: {}) —

    HTTP options (same as Net::HTTP options). See: docs.ruby-lang.org/en/3.4/Net/HTTP.html to understand the options.



38
39
40
41
42
43
44
45
46
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 38

def initialize(base_url: nil, channel_access_token:, http_options: {})
  @http_client = HttpClient.new(
    base_url: base_url || 'https://api.line.me',
    http_headers: {
      Authorization: "Bearer #{channel_access_token}"
    },
    http_options: http_options
  )
end

Instance Method Details

#broadcast(broadcast_request:, x_line_retry_key: nil) ⇒ String, ...

Sends a message to multiple users at any time. This requests to POST https://api.line.me/v2/bot/message/broadcast When you want to get HTTP status code or response headers, use #broadcast_with_http_info instead of this.

Parameters:

  • broadcast_request (BroadcastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 125

def broadcast(
  broadcast_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = broadcast_with_http_info(
    broadcast_request: broadcast_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end

#broadcast_with_http_info(broadcast_request:, x_line_retry_key: nil) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Sends a message to multiple users at any time. This requests to POST https://api.line.me/v2/bot/message/broadcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • broadcast_request (BroadcastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 61

def broadcast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  broadcast_request:, 
  x_line_retry_key: nil
)
  path = "/v2/bot/message/broadcast"
  header_params = {
    "X-Line-Retry-Key": x_line_retry_key
  }.compact

  response = @http_client.post(
    path: path,
    body_params: broadcast_request,
    headers: header_params
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 403
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 403, response.each_header.to_h]
  when 409
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 409, response.each_header.to_h]
  when 429
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 429, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#cancel_default_rich_menu ⇒ String?

Cancel default rich menu This requests to DELETE https://api.line.me/v2/bot/user/all/richmenu When you want to get HTTP status code or response headers, use #cancel_default_rich_menu_with_http_info instead of this.

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



167
168
169
170
171
172
173
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 167

def cancel_default_rich_menu(
)
  response_body, _status_code, _headers = cancel_default_rich_menu_with_http_info(
  )

  response_body
end

#cancel_default_rich_menu_with_http_info ⇒ Array((String|nil), Integer, Hash{String => String})

Cancel default rich menu This requests to DELETE https://api.line.me/v2/bot/user/all/richmenu This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 144

def cancel_default_rich_menu_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/user/all/richmenu"

  response = @http_client.delete(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#create_rich_menu(rich_menu_request:) ⇒ Line::Bot::V2::MessagingApi::RichMenuIdResponse, ...

Create rich menu This requests to POST https://api.line.me/v2/bot/richmenu When you want to get HTTP status code or response headers, use #create_rich_menu_with_http_info instead of this.

Parameters:

Returns:

See Also:



214
215
216
217
218
219
220
221
222
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 214

def create_rich_menu(
  rich_menu_request:
)
  response_body, _status_code, _headers = create_rich_menu_with_http_info(
    rich_menu_request: rich_menu_request
  )

  response_body
end

#create_rich_menu_alias(create_rich_menu_alias_request:) ⇒ String, ...

Create rich menu alias This requests to POST https://api.line.me/v2/bot/richmenu/alias When you want to get HTTP status code or response headers, use #create_rich_menu_alias_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (Line::Bot::V2::MessagingApi::ErrorResponse) —

    when HTTP status code is 400

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



267
268
269
270
271
272
273
274
275
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 267

def create_rich_menu_alias(
  create_rich_menu_alias_request:
)
  response_body, _status_code, _headers = create_rich_menu_alias_with_http_info(
    create_rich_menu_alias_request: create_rich_menu_alias_request
  )

  response_body
end

#create_rich_menu_alias_with_http_info(create_rich_menu_alias_request:) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Create rich menu alias This requests to POST https://api.line.me/v2/bot/richmenu/alias This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 400

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 233

def create_rich_menu_alias_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  create_rich_menu_alias_request:
)
  path = "/v2/bot/richmenu/alias"

  response = @http_client.post(
    path: path,
    body_params: create_rich_menu_alias_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#create_rich_menu_with_http_info(rich_menu_request:) ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Create rich menu This requests to POST https://api.line.me/v2/bot/richmenu This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 183

def create_rich_menu_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_request:
)
  path = "/v2/bot/richmenu"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_request,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuIdResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#delete_rich_menu(rich_menu_id:) ⇒ String?

Deletes a rich menu. This requests to DELETE https://api.line.me/v2/bot/richmenu/{richMenuId} When you want to get HTTP status code or response headers, use #delete_rich_menu_with_http_info instead of this.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



311
312
313
314
315
316
317
318
319
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 311

def delete_rich_menu(
  rich_menu_id:
)
  response_body, _status_code, _headers = delete_rich_menu_with_http_info(
    rich_menu_id: rich_menu_id
  )

  response_body
end

#delete_rich_menu_alias(rich_menu_alias_id:) ⇒ String, ...

Delete rich menu alias This requests to DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} When you want to get HTTP status code or response headers, use #delete_rich_menu_alias_with_http_info instead of this.

Parameters:

  • rich_menu_alias_id (String) —

    Rich menu alias ID that you want to delete.

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (Line::Bot::V2::MessagingApi::ErrorResponse) —

    when HTTP status code is 400

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



364
365
366
367
368
369
370
371
372
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 364

def delete_rich_menu_alias(
  rich_menu_alias_id:
)
  response_body, _status_code, _headers = delete_rich_menu_alias_with_http_info(
    rich_menu_alias_id: rich_menu_alias_id
  )

  response_body
end

#delete_rich_menu_alias_with_http_info(rich_menu_alias_id:) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Delete rich menu alias This requests to DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_alias_id (String) —

    Rich menu alias ID that you want to delete.

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 400

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 330

def delete_rich_menu_alias_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_alias_id:
)
  path = "/v2/bot/richmenu/alias/{richMenuAliasId}"
    .gsub(/{richMenuAliasId}/, rich_menu_alias_id.to_s)

  response = @http_client.delete(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#delete_rich_menu_with_http_info(rich_menu_id:) ⇒ Array((String|nil), Integer, Hash{String => String})

Deletes a rich menu. This requests to DELETE https://api.line.me/v2/bot/richmenu/{richMenuId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 285

def delete_rich_menu_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_id:
)
  path = "/v2/bot/richmenu/{richMenuId}"
    .gsub(/{richMenuId}/, rich_menu_id.to_s)

  response = @http_client.delete(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_aggregation_unit_name_list(limit: nil, start: nil) ⇒ Line::Bot::V2::MessagingApi::GetAggregationUnitNameListResponse, ...

Get name list of units used this month This requests to GET https://api.line.me/v2/bot/message/aggregation/list When you want to get HTTP status code or response headers, use #get_aggregation_unit_name_list_with_http_info instead of this.

Parameters:

  • limit (String, nil) (defaults to: nil) —

    The maximum number of aggregation units you can get per request.

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the next property of the JSON object returned in the response. If you can’t get all the aggregation units in one request, include this parameter to get the remaining array.

Returns:

See Also:



420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 420

def get_aggregation_unit_name_list(
  limit: nil,
  start: nil
)
  response_body, _status_code, _headers = get_aggregation_unit_name_list_with_http_info(
    limit: limit,
    start: start
  )

  response_body
end

#get_aggregation_unit_name_list_with_http_info(limit: nil, start: nil) ⇒ Array(Line::Bot::V2::MessagingApi::GetAggregationUnitNameListResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get name list of units used this month This requests to GET https://api.line.me/v2/bot/message/aggregation/list This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • limit (String, nil) (defaults to: nil) —

    The maximum number of aggregation units you can get per request.

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the next property of the JSON object returned in the response. If you can’t get all the aggregation units in one request, include this parameter to get the remaining array.

Returns:

See Also:



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 383

def get_aggregation_unit_name_list_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  limit: nil, 
  start: nil
)
  path = "/v2/bot/message/aggregation/list"
  query_params = {
    "limit": limit,
    "start": start
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetAggregationUnitNameListResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_aggregation_unit_usage ⇒ Line::Bot::V2::MessagingApi::GetAggregationUnitUsageResponse, ...

Get number of units used this month This requests to GET https://api.line.me/v2/bot/message/aggregation/info When you want to get HTTP status code or response headers, use #get_aggregation_unit_usage_with_http_info instead of this.

Returns:

See Also:



467
468
469
470
471
472
473
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 467

def get_aggregation_unit_usage(
)
  response_body, _status_code, _headers = get_aggregation_unit_usage_with_http_info(
  )

  response_body
end

#get_aggregation_unit_usage_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::GetAggregationUnitUsageResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of units used this month This requests to GET https://api.line.me/v2/bot/message/aggregation/info This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

See Also:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 439

def get_aggregation_unit_usage_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/message/aggregation/info"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetAggregationUnitUsageResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_bot_info ⇒ Line::Bot::V2::MessagingApi::BotInfoResponse, ...

Get bot info This requests to GET https://api.line.me/v2/bot/info When you want to get HTTP status code or response headers, use #get_bot_info_with_http_info instead of this.

Returns:

See Also:



510
511
512
513
514
515
516
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 510

def get_bot_info(
)
  response_body, _status_code, _headers = get_bot_info_with_http_info(
  )

  response_body
end

#get_bot_info_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::BotInfoResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get bot info This requests to GET https://api.line.me/v2/bot/info This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::BotInfoResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 482

def get_bot_info_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/info"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::BotInfoResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_default_rich_menu_id ⇒ Line::Bot::V2::MessagingApi::RichMenuIdResponse, ...

Gets the ID of the default rich menu set with the Messaging API. This requests to GET https://api.line.me/v2/bot/user/all/richmenu When you want to get HTTP status code or response headers, use #get_default_rich_menu_id_with_http_info instead of this.

Returns:

See Also:



553
554
555
556
557
558
559
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 553

def get_default_rich_menu_id(
)
  response_body, _status_code, _headers = get_default_rich_menu_id_with_http_info(
  )

  response_body
end

#get_default_rich_menu_id_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Gets the ID of the default rich menu set with the Messaging API. This requests to GET https://api.line.me/v2/bot/user/all/richmenu This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 525

def get_default_rich_menu_id_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/user/all/richmenu"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuIdResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_followers(start: nil, limit: nil) ⇒ Line::Bot::V2::MessagingApi::GetFollowersResponse, ...

Get a list of users who added your LINE Official Account as a friend This requests to GET https://api.line.me/v2/bot/followers/ids When you want to get HTTP status code or response headers, use #get_followers_with_http_info instead of this.

Parameters:

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.

  • limit (Integer, nil) (defaults to: nil) —

    The maximum number of user IDs to retrieve in a single request.

Returns:

See Also:



607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 607

def get_followers(
  start: nil,
  limit: nil
)
  response_body, _status_code, _headers = get_followers_with_http_info(
    start: start,
    limit: limit
  )

  response_body
end

#get_followers_with_http_info(start: nil, limit: nil) ⇒ Array(Line::Bot::V2::MessagingApi::GetFollowersResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get a list of users who added your LINE Official Account as a friend This requests to GET https://api.line.me/v2/bot/followers/ids This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.

  • limit (Integer, nil) (defaults to: nil) —

    The maximum number of user IDs to retrieve in a single request.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::GetFollowersResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 570

def get_followers_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  start: nil, 
  limit: nil
)
  path = "/v2/bot/followers/ids"
  query_params = {
    "start": start,
    "limit": limit
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetFollowersResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_group_member_count(group_id:) ⇒ Line::Bot::V2::MessagingApi::GroupMemberCountResponse, ...

Get number of users in a group chat This requests to GET https://api.line.me/v2/bot/group/{groupId}/members/count When you want to get HTTP status code or response headers, use #get_group_member_count_with_http_info instead of this.

Parameters:

  • group_id (String) —

    Group ID

Returns:

See Also:



658
659
660
661
662
663
664
665
666
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 658

def get_group_member_count(
  group_id:
)
  response_body, _status_code, _headers = get_group_member_count_with_http_info(
    group_id: group_id
  )

  response_body
end

#get_group_member_count_with_http_info(group_id:) ⇒ Array(Line::Bot::V2::MessagingApi::GroupMemberCountResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of users in a group chat This requests to GET https://api.line.me/v2/bot/group/{groupId}/members/count This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • group_id (String) —

    Group ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::GroupMemberCountResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 627

def get_group_member_count_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  group_id:
)
  path = "/v2/bot/group/{groupId}/members/count"
    .gsub(/{groupId}/, group_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GroupMemberCountResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_group_member_profile(group_id:, user_id:) ⇒ Line::Bot::V2::MessagingApi::GroupUserProfileResponse, ...

Get group chat member profile This requests to GET https://api.line.me/v2/bot/group/{groupId}/member/{userId} When you want to get HTTP status code or response headers, use #get_group_member_profile_with_http_info instead of this.

Parameters:

  • group_id (String) —

    Group ID

  • user_id (String) —

    User ID

Returns:

See Also:



711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 711

def get_group_member_profile(
  group_id:,
  user_id:
)
  response_body, _status_code, _headers = get_group_member_profile_with_http_info(
    group_id: group_id,
    user_id: user_id
  )

  response_body
end

#get_group_member_profile_with_http_info(group_id:, user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::GroupUserProfileResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get group chat member profile This requests to GET https://api.line.me/v2/bot/group/{groupId}/member/{userId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • group_id (String) —

    Group ID

  • user_id (String) —

    User ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::GroupUserProfileResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 677

def get_group_member_profile_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  group_id:, 
  user_id:
)
  path = "/v2/bot/group/{groupId}/member/{userId}"
    .gsub(/{groupId}/, group_id.to_s)
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GroupUserProfileResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_group_members_ids(group_id:, start: nil) ⇒ Line::Bot::V2::MessagingApi::MembersIdsResponse, ...

Get group chat member user IDs This requests to GET https://api.line.me/v2/bot/group/{groupId}/members/ids When you want to get HTTP status code or response headers, use #get_group_members_ids_with_http_info instead of this.

Parameters:

  • group_id (String) —

    Group ID

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the ‘next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns:

See Also:



769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 769

def get_group_members_ids(
  group_id:,
  start: nil
)
  response_body, _status_code, _headers = get_group_members_ids_with_http_info(
    group_id: group_id,
    start: start
  )

  response_body
end

#get_group_members_ids_with_http_info(group_id:, start: nil) ⇒ Array(Line::Bot::V2::MessagingApi::MembersIdsResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get group chat member user IDs This requests to GET https://api.line.me/v2/bot/group/{groupId}/members/ids This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • group_id (String) —

    Group ID

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the ‘next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::MembersIdsResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 732

def get_group_members_ids_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  group_id:, 
  start: nil
)
  path = "/v2/bot/group/{groupId}/members/ids"
    .gsub(/{groupId}/, group_id.to_s)
  query_params = {
    "start": start
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::MembersIdsResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_group_summary(group_id:) ⇒ Line::Bot::V2::MessagingApi::GroupSummaryResponse, ...

Get group chat summary This requests to GET https://api.line.me/v2/bot/group/{groupId}/summary When you want to get HTTP status code or response headers, use #get_group_summary_with_http_info instead of this.

Parameters:

  • group_id (String) —

    Group ID

Returns:

See Also:



820
821
822
823
824
825
826
827
828
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 820

def get_group_summary(
  group_id:
)
  response_body, _status_code, _headers = get_group_summary_with_http_info(
    group_id: group_id
  )

  response_body
end

#get_group_summary_with_http_info(group_id:) ⇒ Array(Line::Bot::V2::MessagingApi::GroupSummaryResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get group chat summary This requests to GET https://api.line.me/v2/bot/group/{groupId}/summary This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • group_id (String) —

    Group ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::GroupSummaryResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 789

def get_group_summary_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  group_id:
)
  path = "/v2/bot/group/{groupId}/summary"
    .gsub(/{groupId}/, group_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GroupSummaryResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_joined_membership_users(membership_id:, start: nil, limit: nil) ⇒ Line::Bot::V2::MessagingApi::GetJoinedMembershipUsersResponse, ...

Get a list of user IDs who joined the membership. This requests to GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids When you want to get HTTP status code or response headers, use #get_joined_membership_users_with_http_info instead of this.

Parameters:

  • membership_id (Integer) —

    Membership plan ID.

  • start (String, nil) (defaults to: nil) —

    A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren’t returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).

  • limit (Integer, nil) (defaults to: nil) —

    The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.

Returns:

See Also:



898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 898

def get_joined_membership_users(
  membership_id:,
  start: nil,
  limit: nil
)
  response_body, _status_code, _headers = get_joined_membership_users_with_http_info(
    membership_id: membership_id,
    start: start,
    limit: limit
  )

  response_body
end

#get_joined_membership_users_with_http_info(membership_id:, start: nil, limit: nil) ⇒ Array(Line::Bot::V2::MessagingApi::GetJoinedMembershipUsersResponse, Integer, Hash{String => String}), ...

Get a list of user IDs who joined the membership. This requests to GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • membership_id (Integer) —

    Membership plan ID.

  • start (String, nil) (defaults to: nil) —

    A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren’t returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).

  • limit (Integer, nil) (defaults to: nil) —

    The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.

Returns:

See Also:



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 842

def get_joined_membership_users_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  membership_id:, 
  start: nil, 
  limit: nil
)
  path = "/v2/bot/membership/{membershipId}/users/ids"
    .gsub(/{membershipId}/, membership_id.to_s)
  query_params = {
    "start": start,
    "limit": limit
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetJoinedMembershipUsersResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 404
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 404, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_membership_list ⇒ Line::Bot::V2::MessagingApi::MembershipListResponse, ...

Get a list of memberships. This requests to GET https://api.line.me/v2/bot/membership/list When you want to get HTTP status code or response headers, use #get_membership_list_with_http_info instead of this.

Returns:

See Also:



956
957
958
959
960
961
962
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 956

def get_membership_list(
)
  response_body, _status_code, _headers = get_membership_list_with_http_info(
  )

  response_body
end

#get_membership_list_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::MembershipListResponse, Integer, Hash{String => String}), ...

Get a list of memberships. This requests to GET https://api.line.me/v2/bot/membership/list This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

See Also:



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 920

def get_membership_list_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/membership/list"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::MembershipListResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  when 404
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 404, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_membership_subscription(user_id:) ⇒ Line::Bot::V2::MessagingApi::GetMembershipSubscriptionResponse, ...

Get a user’s membership subscription. This requests to GET https://api.line.me/v2/bot/membership/subscription/{userId} When you want to get HTTP status code or response headers, use #get_membership_subscription_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID

Returns:

See Also:



1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1021

def get_membership_subscription(
  user_id:
)
  response_body, _status_code, _headers = get_membership_subscription_with_http_info(
    user_id: user_id
  )

  response_body
end

#get_membership_subscription_with_http_info(user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::GetMembershipSubscriptionResponse, Integer, Hash{String => String}), ...

Get a user’s membership subscription. This requests to GET https://api.line.me/v2/bot/membership/subscription/{userId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID

Returns:

See Also:



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 974

def get_membership_subscription_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:
)
  path = "/v2/bot/membership/subscription/{userId}"
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetMembershipSubscriptionResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 404
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 404, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_message_quota ⇒ Line::Bot::V2::MessagingApi::MessageQuotaResponse, ...

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. This requests to GET https://api.line.me/v2/bot/message/quota When you want to get HTTP status code or response headers, use #get_message_quota_with_http_info instead of this.

Returns:

See Also:



1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1066

def get_message_quota(
)
  response_body, _status_code, _headers = get_message_quota_with_http_info(
  )

  response_body
end

#get_message_quota_consumption ⇒ Line::Bot::V2::MessagingApi::QuotaConsumptionResponse, ...

Gets the number of messages sent in the current month. This requests to GET https://api.line.me/v2/bot/message/quota/consumption When you want to get HTTP status code or response headers, use #get_message_quota_consumption_with_http_info instead of this.

Returns:

See Also:



1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1109

def get_message_quota_consumption(
)
  response_body, _status_code, _headers = get_message_quota_consumption_with_http_info(
  )

  response_body
end

#get_message_quota_consumption_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::QuotaConsumptionResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Gets the number of messages sent in the current month. This requests to GET https://api.line.me/v2/bot/message/quota/consumption This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::QuotaConsumptionResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1081

def get_message_quota_consumption_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/message/quota/consumption"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::QuotaConsumptionResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_message_quota_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::MessageQuotaResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. This requests to GET https://api.line.me/v2/bot/message/quota This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::MessageQuotaResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1038

def get_message_quota_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/message/quota"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::MessageQuotaResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_narrowcast_progress(request_id:) ⇒ Line::Bot::V2::MessagingApi::NarrowcastProgressResponse, ...

Gets the status of a narrowcast message. This requests to GET https://api.line.me/v2/bot/message/progress/narrowcast When you want to get HTTP status code or response headers, use #get_narrowcast_progress_with_http_info instead of this.

Parameters:

  • request_id (String) —

    The narrowcast message’s request ID. Each Messaging API request has a request ID.

Returns:

See Also:



1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1159

def get_narrowcast_progress(
  request_id:
)
  response_body, _status_code, _headers = get_narrowcast_progress_with_http_info(
    request_id: request_id
  )

  response_body
end

#get_narrowcast_progress_with_http_info(request_id:) ⇒ Array(Line::Bot::V2::MessagingApi::NarrowcastProgressResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Gets the status of a narrowcast message. This requests to GET https://api.line.me/v2/bot/message/progress/narrowcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • request_id (String) —

    The narrowcast message’s request ID. Each Messaging API request has a request ID.

Returns:

See Also:



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1125

def get_narrowcast_progress_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  request_id:
)
  path = "/v2/bot/message/progress/narrowcast"
  query_params = {
    "requestId": request_id
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NarrowcastProgressResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_number_of_sent_broadcast_messages(date:) ⇒ Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, ...

Get number of sent broadcast messages This requests to GET https://api.line.me/v2/bot/message/delivery/broadcast When you want to get HTTP status code or response headers, use #get_number_of_sent_broadcast_messages_with_http_info instead of this.

Parameters:

  • date (String) —

    Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns:

See Also:



1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1211

def get_number_of_sent_broadcast_messages(
  date:
)
  response_body, _status_code, _headers = get_number_of_sent_broadcast_messages_with_http_info(
    date: date
  )

  response_body
end

#get_number_of_sent_broadcast_messages_with_http_info(date:) ⇒ Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of sent broadcast messages This requests to GET https://api.line.me/v2/bot/message/delivery/broadcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • date (String) —

    Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns:

  • (Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1177

def get_number_of_sent_broadcast_messages_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  date:
)
  path = "/v2/bot/message/delivery/broadcast"
  query_params = {
    "date": date
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NumberOfMessagesResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_number_of_sent_multicast_messages(date:) ⇒ Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, ...

Get number of sent multicast messages This requests to GET https://api.line.me/v2/bot/message/delivery/multicast When you want to get HTTP status code or response headers, use #get_number_of_sent_multicast_messages_with_http_info instead of this.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

See Also:



1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1263

def get_number_of_sent_multicast_messages(
  date:
)
  response_body, _status_code, _headers = get_number_of_sent_multicast_messages_with_http_info(
    date: date
  )

  response_body
end

#get_number_of_sent_multicast_messages_with_http_info(date:) ⇒ Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of sent multicast messages This requests to GET https://api.line.me/v2/bot/message/delivery/multicast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

  • (Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1229

def get_number_of_sent_multicast_messages_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  date:
)
  path = "/v2/bot/message/delivery/multicast"
  query_params = {
    "date": date
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NumberOfMessagesResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_number_of_sent_push_messages(date:) ⇒ Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, ...

Get number of sent push messages This requests to GET https://api.line.me/v2/bot/message/delivery/push When you want to get HTTP status code or response headers, use #get_number_of_sent_push_messages_with_http_info instead of this.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

See Also:



1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1315

def get_number_of_sent_push_messages(
  date:
)
  response_body, _status_code, _headers = get_number_of_sent_push_messages_with_http_info(
    date: date
  )

  response_body
end

#get_number_of_sent_push_messages_with_http_info(date:) ⇒ Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of sent push messages This requests to GET https://api.line.me/v2/bot/message/delivery/push This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

  • (Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1281

def get_number_of_sent_push_messages_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  date:
)
  path = "/v2/bot/message/delivery/push"
  query_params = {
    "date": date
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NumberOfMessagesResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_number_of_sent_reply_messages(date:) ⇒ Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, ...

Get number of sent reply messages This requests to GET https://api.line.me/v2/bot/message/delivery/reply When you want to get HTTP status code or response headers, use #get_number_of_sent_reply_messages_with_http_info instead of this.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

See Also:



1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1367

def get_number_of_sent_reply_messages(
  date:
)
  response_body, _status_code, _headers = get_number_of_sent_reply_messages_with_http_info(
    date: date
  )

  response_body
end

#get_number_of_sent_reply_messages_with_http_info(date:) ⇒ Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of sent reply messages This requests to GET https://api.line.me/v2/bot/message/delivery/reply This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • date (String) —

    Date the messages were sent Format: ‘yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Returns:

  • (Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1333

def get_number_of_sent_reply_messages_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  date:
)
  path = "/v2/bot/message/delivery/reply"
  query_params = {
    "date": date
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NumberOfMessagesResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_pnp_message_statistics(date:) ⇒ Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, ...

Get number of sent LINE notification messages　This requests to GET https://api.line.me/v2/bot/message/delivery/pnp When you want to get HTTP status code or response headers, use #get_pnp_message_statistics_with_http_info instead of this.

Parameters:

  • date (String) —

    Date the message was sent Format: ‘yyyyMMdd` (Example:`20211231`) Time zone: UTC+9

Returns:

See Also:



1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1419

def get_pnp_message_statistics(
  date:
)
  response_body, _status_code, _headers = get_pnp_message_statistics_with_http_info(
    date: date
  )

  response_body
end

#get_pnp_message_statistics_with_http_info(date:) ⇒ Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of sent LINE notification messages　This requests to GET https://api.line.me/v2/bot/message/delivery/pnp This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • date (String) —

    Date the message was sent Format: ‘yyyyMMdd` (Example:`20211231`) Time zone: UTC+9

Returns:

  • (Array(Line::Bot::V2::MessagingApi::NumberOfMessagesResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1385

def get_pnp_message_statistics_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  date:
)
  path = "/v2/bot/message/delivery/pnp"
  query_params = {
    "date": date
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::NumberOfMessagesResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_profile(user_id:) ⇒ Line::Bot::V2::MessagingApi::UserProfileResponse, ...

Get profile This requests to GET https://api.line.me/v2/bot/profile/{userId} When you want to get HTTP status code or response headers, use #get_profile_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID

Returns:

See Also:



1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1468

def get_profile(
  user_id:
)
  response_body, _status_code, _headers = get_profile_with_http_info(
    user_id: user_id
  )

  response_body
end

#get_profile_with_http_info(user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::UserProfileResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get profile This requests to GET https://api.line.me/v2/bot/profile/{userId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::UserProfileResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1437

def get_profile_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:
)
  path = "/v2/bot/profile/{userId}"
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::UserProfileResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu(rich_menu_id:) ⇒ Line::Bot::V2::MessagingApi::RichMenuResponse, ...

Gets a rich menu via a rich menu ID. This requests to GET https://api.line.me/v2/bot/richmenu/{richMenuId} When you want to get HTTP status code or response headers, use #get_rich_menu_with_http_info instead of this.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

See Also:



1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1517

def get_rich_menu(
  rich_menu_id:
)
  response_body, _status_code, _headers = get_rich_menu_with_http_info(
    rich_menu_id: rich_menu_id
  )

  response_body
end

#get_rich_menu_alias(rich_menu_alias_id:) ⇒ Line::Bot::V2::MessagingApi::RichMenuAliasResponse, ...

Get rich menu alias information This requests to GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} When you want to get HTTP status code or response headers, use #get_rich_menu_alias_with_http_info instead of this.

Parameters:

  • rich_menu_alias_id (String) —

    The rich menu alias ID whose information you want to obtain.

Returns:

See Also:



1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1566

def get_rich_menu_alias(
  rich_menu_alias_id:
)
  response_body, _status_code, _headers = get_rich_menu_alias_with_http_info(
    rich_menu_alias_id: rich_menu_alias_id
  )

  response_body
end

#get_rich_menu_alias_list ⇒ Line::Bot::V2::MessagingApi::RichMenuAliasListResponse, ...

Get list of rich menu alias This requests to GET https://api.line.me/v2/bot/richmenu/alias/list When you want to get HTTP status code or response headers, use #get_rich_menu_alias_list_with_http_info instead of this.

Returns:

See Also:



1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1611

def get_rich_menu_alias_list(
)
  response_body, _status_code, _headers = get_rich_menu_alias_list_with_http_info(
  )

  response_body
end

#get_rich_menu_alias_list_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuAliasListResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get list of rich menu alias This requests to GET https://api.line.me/v2/bot/richmenu/alias/list This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

See Also:



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1583

def get_rich_menu_alias_list_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/richmenu/alias/list"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuAliasListResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu_alias_with_http_info(rich_menu_alias_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuAliasResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get rich menu alias information This requests to GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_alias_id (String) —

    The rich menu alias ID whose information you want to obtain.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuAliasResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1535

def get_rich_menu_alias_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_alias_id:
)
  path = "/v2/bot/richmenu/alias/{richMenuAliasId}"
    .gsub(/{richMenuAliasId}/, rich_menu_alias_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuAliasResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu_batch_progress(request_id:) ⇒ Line::Bot::V2::MessagingApi::RichMenuBatchProgressResponse, ...

Get the status of Replace or unlink a linked rich menus in batches. This requests to GET https://api.line.me/v2/bot/richmenu/progress/batch When you want to get HTTP status code or response headers, use #get_rich_menu_batch_progress_with_http_info instead of this.

Parameters:

  • request_id (String) —

    A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns:

See Also:



1661
1662
1663
1664
1665
1666
1667
1668
1669
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1661

def get_rich_menu_batch_progress(
  request_id:
)
  response_body, _status_code, _headers = get_rich_menu_batch_progress_with_http_info(
    request_id: request_id
  )

  response_body
end

#get_rich_menu_batch_progress_with_http_info(request_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuBatchProgressResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get the status of Replace or unlink a linked rich menus in batches. This requests to GET https://api.line.me/v2/bot/richmenu/progress/batch This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • request_id (String) —

    A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns:

See Also:



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1627

def get_rich_menu_batch_progress_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  request_id:
)
  path = "/v2/bot/richmenu/progress/batch"
  query_params = {
    "requestId": request_id
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuBatchProgressResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu_id_of_user(user_id:) ⇒ Line::Bot::V2::MessagingApi::RichMenuIdResponse, ...

Get rich menu ID of user This requests to GET https://api.line.me/v2/bot/user/{userId}/richmenu When you want to get HTTP status code or response headers, use #get_rich_menu_id_of_user_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

Returns:

See Also:



1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1710

def get_rich_menu_id_of_user(
  user_id:
)
  response_body, _status_code, _headers = get_rich_menu_id_of_user_with_http_info(
    user_id: user_id
  )

  response_body
end

#get_rich_menu_id_of_user_with_http_info(user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get rich menu ID of user This requests to GET https://api.line.me/v2/bot/user/{userId}/richmenu This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuIdResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1679

def get_rich_menu_id_of_user_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:
)
  path = "/v2/bot/user/{userId}/richmenu"
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuIdResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu_list ⇒ Line::Bot::V2::MessagingApi::RichMenuListResponse, ...

Get rich menu list This requests to GET https://api.line.me/v2/bot/richmenu/list When you want to get HTTP status code or response headers, use #get_rich_menu_list_with_http_info instead of this.

Returns:

See Also:



1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1755

def get_rich_menu_list(
)
  response_body, _status_code, _headers = get_rich_menu_list_with_http_info(
  )

  response_body
end

#get_rich_menu_list_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuListResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get rich menu list This requests to GET https://api.line.me/v2/bot/richmenu/list This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuListResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1727

def get_rich_menu_list_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/richmenu/list"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuListResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_rich_menu_with_http_info(rich_menu_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RichMenuResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Gets a rich menu via a rich menu ID. This requests to GET https://api.line.me/v2/bot/richmenu/{richMenuId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RichMenuResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1486

def get_rich_menu_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_id:
)
  path = "/v2/bot/richmenu/{richMenuId}"
    .gsub(/{richMenuId}/, rich_menu_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RichMenuResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_room_member_count(room_id:) ⇒ Line::Bot::V2::MessagingApi::RoomMemberCountResponse, ...

Get number of users in a multi-person chat This requests to GET https://api.line.me/v2/bot/room/{roomId}/members/count When you want to get HTTP status code or response headers, use #get_room_member_count_with_http_info instead of this.

Parameters:

  • room_id (String) —

    Room ID

Returns:

See Also:



1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1802

def get_room_member_count(
  room_id:
)
  response_body, _status_code, _headers = get_room_member_count_with_http_info(
    room_id: room_id
  )

  response_body
end

#get_room_member_count_with_http_info(room_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RoomMemberCountResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get number of users in a multi-person chat This requests to GET https://api.line.me/v2/bot/room/{roomId}/members/count This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • room_id (String) —

    Room ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RoomMemberCountResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1771

def get_room_member_count_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  room_id:
)
  path = "/v2/bot/room/{roomId}/members/count"
    .gsub(/{roomId}/, room_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RoomMemberCountResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_room_member_profile(room_id:, user_id:) ⇒ Line::Bot::V2::MessagingApi::RoomUserProfileResponse, ...

Get multi-person chat member profile This requests to GET https://api.line.me/v2/bot/room/{roomId}/member/{userId} When you want to get HTTP status code or response headers, use #get_room_member_profile_with_http_info instead of this.

Parameters:

  • room_id (String) —

    Room ID

  • user_id (String) —

    User ID

Returns:

See Also:



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1855

def get_room_member_profile(
  room_id:,
  user_id:
)
  response_body, _status_code, _headers = get_room_member_profile_with_http_info(
    room_id: room_id,
    user_id: user_id
  )

  response_body
end

#get_room_member_profile_with_http_info(room_id:, user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::RoomUserProfileResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get multi-person chat member profile This requests to GET https://api.line.me/v2/bot/room/{roomId}/member/{userId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • room_id (String) —

    Room ID

  • user_id (String) —

    User ID

Returns:

  • (Array(Line::Bot::V2::MessagingApi::RoomUserProfileResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1821

def get_room_member_profile_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  room_id:, 
  user_id:
)
  path = "/v2/bot/room/{roomId}/member/{userId}"
    .gsub(/{roomId}/, room_id.to_s)
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::RoomUserProfileResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_room_members_ids(room_id:, start: nil) ⇒ Line::Bot::V2::MessagingApi::MembersIdsResponse, ...

Get multi-person chat member user IDs This requests to GET https://api.line.me/v2/bot/room/{roomId}/members/ids When you want to get HTTP status code or response headers, use #get_room_members_ids_with_http_info instead of this.

Parameters:

  • room_id (String) —

    Room ID

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the ‘next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns:

See Also:



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1913

def get_room_members_ids(
  room_id:,
  start: nil
)
  response_body, _status_code, _headers = get_room_members_ids_with_http_info(
    room_id: room_id,
    start: start
  )

  response_body
end

#get_room_members_ids_with_http_info(room_id:, start: nil) ⇒ Array(Line::Bot::V2::MessagingApi::MembersIdsResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get multi-person chat member user IDs This requests to GET https://api.line.me/v2/bot/room/{roomId}/members/ids This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • room_id (String) —

    Room ID

  • start (String, nil) (defaults to: nil) —

    Value of the continuation token found in the ‘next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::MembersIdsResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1876

def get_room_members_ids_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  room_id:, 
  start: nil
)
  path = "/v2/bot/room/{roomId}/members/ids"
    .gsub(/{roomId}/, room_id.to_s)
  query_params = {
    "start": start
  }.compact

  response = @http_client.get(
    path: path,
    query_params: query_params,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::MembersIdsResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#get_webhook_endpoint ⇒ Line::Bot::V2::MessagingApi::GetWebhookEndpointResponse, ...

Get webhook endpoint information This requests to GET https://api.line.me/v2/bot/channel/webhook/endpoint When you want to get HTTP status code or response headers, use #get_webhook_endpoint_with_http_info instead of this.

Returns:

See Also:



1960
1961
1962
1963
1964
1965
1966
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1960

def get_webhook_endpoint(
)
  response_body, _status_code, _headers = get_webhook_endpoint_with_http_info(
  )

  response_body
end

#get_webhook_endpoint_with_http_info ⇒ Array(Line::Bot::V2::MessagingApi::GetWebhookEndpointResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Get webhook endpoint information This requests to GET https://api.line.me/v2/bot/channel/webhook/endpoint This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Returns:

See Also:



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1932

def get_webhook_endpoint_with_http_info( # steep:ignore MethodBodyTypeMismatch
)
  path = "/v2/bot/channel/webhook/endpoint"

  response = @http_client.get(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::GetWebhookEndpointResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#issue_link_token(user_id:) ⇒ Line::Bot::V2::MessagingApi::IssueLinkTokenResponse, ...

Issue link token This requests to POST https://api.line.me/v2/bot/user/{userId}/linkToken When you want to get HTTP status code or response headers, use #issue_link_token_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID for the LINE account to be linked. Found in the ‘source` object of account link event objects. Do not use the LINE ID used in LINE.

Returns:

See Also:



2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2007

def issue_link_token(
  user_id:
)
  response_body, _status_code, _headers = issue_link_token_with_http_info(
    user_id: user_id
  )

  response_body
end

#issue_link_token_with_http_info(user_id:) ⇒ Array(Line::Bot::V2::MessagingApi::IssueLinkTokenResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Issue link token This requests to POST https://api.line.me/v2/bot/user/{userId}/linkToken This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID for the LINE account to be linked. Found in the ‘source` object of account link event objects. Do not use the LINE ID used in LINE.

Returns:

  • (Array(Line::Bot::V2::MessagingApi::IssueLinkTokenResponse, Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 1976

def issue_link_token_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:
)
  path = "/v2/bot/user/{userId}/linkToken"
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.post(
    path: path,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::IssueLinkTokenResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#leave_group(group_id:) ⇒ String, ...

Leave group chat This requests to POST https://api.line.me/v2/bot/group/{groupId}/leave When you want to get HTTP status code or response headers, use #leave_group_with_http_info instead of this.

Parameters:

  • group_id (String) —

    Group ID

Returns:

See Also:



2069
2070
2071
2072
2073
2074
2075
2076
2077
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2069

def leave_group(
  group_id:
)
  response_body, _status_code, _headers = leave_group_with_http_info(
    group_id: group_id
  )

  response_body
end

#leave_group_with_http_info(group_id:) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Leave group chat This requests to POST https://api.line.me/v2/bot/group/{groupId}/leave This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • group_id (String) —

    Group ID

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 400

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 404

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2027

def leave_group_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  group_id:
)
  path = "/v2/bot/group/{groupId}/leave"
    .gsub(/{groupId}/, group_id.to_s)

  response = @http_client.post(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 404
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 404, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#leave_room(room_id:) ⇒ String?

Leave multi-person chat This requests to POST https://api.line.me/v2/bot/room/{roomId}/leave When you want to get HTTP status code or response headers, use #leave_room_with_http_info instead of this.

Parameters:

  • room_id (String) —

    Room ID

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2113

def leave_room(
  room_id:
)
  response_body, _status_code, _headers = leave_room_with_http_info(
    room_id: room_id
  )

  response_body
end

#leave_room_with_http_info(room_id:) ⇒ Array((String|nil), Integer, Hash{String => String})

Leave multi-person chat This requests to POST https://api.line.me/v2/bot/room/{roomId}/leave This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • room_id (String) —

    Room ID

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2087

def leave_room_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  room_id:
)
  path = "/v2/bot/room/{roomId}/leave"
    .gsub(/{roomId}/, room_id.to_s)

  response = @http_client.post(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#link_rich_menu_id_to_user(user_id:, rich_menu_id:) ⇒ String?

Link rich menu to user. This requests to POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId} When you want to get HTTP status code or response headers, use #link_rich_menu_id_to_user_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2161

def link_rich_menu_id_to_user(
  user_id:,
  rich_menu_id:
)
  response_body, _status_code, _headers = link_rich_menu_id_to_user_with_http_info(
    user_id: user_id,
    rich_menu_id: rich_menu_id
  )

  response_body
end

#link_rich_menu_id_to_user_with_http_info(user_id:, rich_menu_id:) ⇒ Array((String|nil), Integer, Hash{String => String})

Link rich menu to user. This requests to POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2132

def link_rich_menu_id_to_user_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:, 
  rich_menu_id:
)
  path = "/v2/bot/user/{userId}/richmenu/{richMenuId}"
    .gsub(/{userId}/, user_id.to_s)
    .gsub(/{richMenuId}/, rich_menu_id.to_s)

  response = @http_client.post(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#link_rich_menu_id_to_users(rich_menu_bulk_link_request:) ⇒ String?

Link rich menu to multiple users This requests to POST https://api.line.me/v2/bot/richmenu/bulk/link When you want to get HTTP status code or response headers, use #link_rich_menu_id_to_users_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 202

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2207

def link_rich_menu_id_to_users(
  rich_menu_bulk_link_request:
)
  response_body, _status_code, _headers = link_rich_menu_id_to_users_with_http_info(
    rich_menu_bulk_link_request: rich_menu_bulk_link_request
  )

  response_body
end

#link_rich_menu_id_to_users_with_http_info(rich_menu_bulk_link_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Link rich menu to multiple users This requests to POST https://api.line.me/v2/bot/richmenu/bulk/link This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 202

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2181

def link_rich_menu_id_to_users_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_bulk_link_request:
)
  path = "/v2/bot/richmenu/bulk/link"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_bulk_link_request,
  )

  case response.code.to_i
  when 202
    [response.body, 202, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#mark_messages_as_read(mark_messages_as_read_request:) ⇒ String?

Mark messages from users as read This requests to POST https://api.line.me/v2/bot/message/markAsRead When you want to get HTTP status code or response headers, use #mark_messages_as_read_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2251
2252
2253
2254
2255
2256
2257
2258
2259
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2251

def mark_messages_as_read(
  mark_messages_as_read_request:
)
  response_body, _status_code, _headers = mark_messages_as_read_with_http_info(
    mark_messages_as_read_request: mark_messages_as_read_request
  )

  response_body
end

#mark_messages_as_read_with_http_info(mark_messages_as_read_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Mark messages from users as read This requests to POST https://api.line.me/v2/bot/message/markAsRead This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2225

def mark_messages_as_read_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  mark_messages_as_read_request:
)
  path = "/v2/bot/message/markAsRead"

  response = @http_client.post(
    path: path,
    body_params: mark_messages_as_read_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#multicast(multicast_request:, x_line_retry_key: nil) ⇒ String, ...

An API that efficiently sends the same message to multiple user IDs. You can’t send messages to group chats or multi-person chats. This requests to POST https://api.line.me/v2/bot/message/multicast When you want to get HTTP status code or response headers, use #multicast_with_http_info instead of this.

Parameters:

  • multicast_request (MulticastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2338

def multicast(
  multicast_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = multicast_with_http_info(
    multicast_request: multicast_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end

#multicast_with_http_info(multicast_request:, x_line_retry_key: nil) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

An API that efficiently sends the same message to multiple user IDs. You can’t send messages to group chats or multi-person chats. This requests to POST https://api.line.me/v2/bot/message/multicast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • multicast_request (MulticastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2274

def multicast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  multicast_request:, 
  x_line_retry_key: nil
)
  path = "/v2/bot/message/multicast"
  header_params = {
    "X-Line-Retry-Key": x_line_retry_key
  }.compact

  response = @http_client.post(
    path: path,
    body_params: multicast_request,
    headers: header_params
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 403
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 403, response.each_header.to_h]
  when 409
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 409, response.each_header.to_h]
  when 429
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 429, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#narrowcast(narrowcast_request:, x_line_retry_key: nil) ⇒ String, ...

Send narrowcast message This requests to POST https://api.line.me/v2/bot/message/narrowcast When you want to get HTTP status code or response headers, use #narrowcast_with_http_info instead of this.

Parameters:

  • narrowcast_request (NarrowcastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2427

def narrowcast(
  narrowcast_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = narrowcast_with_http_info(
    narrowcast_request: narrowcast_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end

#narrowcast_with_http_info(narrowcast_request:, x_line_retry_key: nil) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Send narrowcast message This requests to POST https://api.line.me/v2/bot/message/narrowcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • narrowcast_request (NarrowcastRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2363

def narrowcast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  narrowcast_request:, 
  x_line_retry_key: nil
)
  path = "/v2/bot/message/narrowcast"
  header_params = {
    "X-Line-Retry-Key": x_line_retry_key
  }.compact

  response = @http_client.post(
    path: path,
    body_params: narrowcast_request,
    headers: header_params
  )

  case response.code.to_i
  when 202
    [response.body, 202, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 403
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 403, response.each_header.to_h]
  when 409
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 409, response.each_header.to_h]
  when 429
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 429, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#push_message(push_message_request:, x_line_retry_key: nil) ⇒ Line::Bot::V2::MessagingApi::PushMessageResponse, ...

Sends a message to a user, group chat, or multi-person chat at any time. This requests to POST https://api.line.me/v2/bot/message/push When you want to get HTTP status code or response headers, use #push_message_with_http_info instead of this.

Parameters:

  • push_message_request (PushMessageRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2521

def push_message(
  push_message_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = push_message_with_http_info(
    push_message_request: push_message_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end

#push_message_with_http_info(push_message_request:, x_line_retry_key: nil) ⇒ Array(Line::Bot::V2::MessagingApi::PushMessageResponse, Integer, Hash{String => String}), ...

Sends a message to a user, group chat, or multi-person chat at any time. This requests to POST https://api.line.me/v2/bot/message/push This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • push_message_request (PushMessageRequest)
  • x_line_retry_key (String, nil) (defaults to: nil) —

    Retry key. Specifies the UUID in hexadecimal format (e.g., ‘123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn’t generated by LINE. Each developer must generate their own retry key.

Returns:

See Also:



2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2452

def push_message_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  push_message_request:, 
  x_line_retry_key: nil
)
  path = "/v2/bot/message/push"
  header_params = {
    "X-Line-Retry-Key": x_line_retry_key
  }.compact

  response = @http_client.post(
    path: path,
    body_params: push_message_request,
    headers: header_params
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::PushMessageResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 403
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 403, response.each_header.to_h]
  when 409
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 409, response.each_header.to_h]
  when 429
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 429, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#push_messages_by_phone(pnp_messages_request:, x_line_delivery_tag: nil) ⇒ String, ...

Send LINE notification message This requests to POST https://api.line.me/bot/pnp/push When you want to get HTTP status code or response headers, use #push_messages_by_phone_with_http_info instead of this.

Parameters:

  • pnp_messages_request (PnpMessagesRequest)
  • x_line_delivery_tag (String, nil) (defaults to: nil) —

    String returned in the delivery.data property of the delivery completion event via Webhook.

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (Line::Bot::V2::MessagingApi::ErrorResponse) —

    when HTTP status code is 422

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2583

def push_messages_by_phone(
  pnp_messages_request:,
  x_line_delivery_tag: nil
)
  response_body, _status_code, _headers = push_messages_by_phone_with_http_info(
    pnp_messages_request: pnp_messages_request,
    x_line_delivery_tag: x_line_delivery_tag
  )

  response_body
end

#push_messages_by_phone_with_http_info(pnp_messages_request:, x_line_delivery_tag: nil) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Send LINE notification message This requests to POST https://api.line.me/bot/pnp/push This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • pnp_messages_request (PnpMessagesRequest)
  • x_line_delivery_tag (String, nil) (defaults to: nil) —

    String returned in the delivery.data property of the delivery completion event via Webhook.

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 422

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2543

def push_messages_by_phone_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  pnp_messages_request:, 
  x_line_delivery_tag: nil
)
  path = "/bot/pnp/push"
  header_params = {
    "X-Line-Delivery-Tag": x_line_delivery_tag
  }.compact

  response = @http_client.post(
    path: path,
    body_params: pnp_messages_request,
    headers: header_params
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 422
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 422, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#reply_message(reply_message_request:) ⇒ Line::Bot::V2::MessagingApi::ReplyMessageResponse, ...

Send reply message This requests to POST https://api.line.me/v2/bot/message/reply When you want to get HTTP status code or response headers, use #reply_message_with_http_info instead of this.

Parameters:

Returns:

See Also:



2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2652

def reply_message(
  reply_message_request:
)
  response_body, _status_code, _headers = reply_message_with_http_info(
    reply_message_request: reply_message_request
  )

  response_body
end

#reply_message_with_http_info(reply_message_request:) ⇒ Array(Line::Bot::V2::MessagingApi::ReplyMessageResponse, Integer, Hash{String => String}), ...

Send reply message This requests to POST https://api.line.me/v2/bot/message/reply This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

See Also:



2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2605

def reply_message_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  reply_message_request:
)
  path = "/v2/bot/message/reply"

  response = @http_client.post(
    path: path,
    body_params: reply_message_request,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ReplyMessageResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  when 429
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 429, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#rich_menu_batch(rich_menu_batch_request:) ⇒ String?

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu This requests to POST https://api.line.me/v2/bot/richmenu/batch When you want to get HTTP status code or response headers, use #rich_menu_batch_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 202

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2696
2697
2698
2699
2700
2701
2702
2703
2704
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2696

def rich_menu_batch(
  rich_menu_batch_request:
)
  response_body, _status_code, _headers = rich_menu_batch_with_http_info(
    rich_menu_batch_request: rich_menu_batch_request
  )

  response_body
end

#rich_menu_batch_with_http_info(rich_menu_batch_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu This requests to POST https://api.line.me/v2/bot/richmenu/batch This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 202

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2670

def rich_menu_batch_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_batch_request:
)
  path = "/v2/bot/richmenu/batch"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_batch_request,
  )

  case response.code.to_i
  when 202
    [response.body, 202, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#set_default_rich_menu(rich_menu_id:) ⇒ String?

Set default rich menu This requests to POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId} When you want to get HTTP status code or response headers, use #set_default_rich_menu_with_http_info instead of this.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2740
2741
2742
2743
2744
2745
2746
2747
2748
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2740

def set_default_rich_menu(
  rich_menu_id:
)
  response_body, _status_code, _headers = set_default_rich_menu_with_http_info(
    rich_menu_id: rich_menu_id
  )

  response_body
end

#set_default_rich_menu_with_http_info(rich_menu_id:) ⇒ Array((String|nil), Integer, Hash{String => String})

Set default rich menu This requests to POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_id (String) —

    ID of a rich menu

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2714

def set_default_rich_menu_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_id:
)
  path = "/v2/bot/user/all/richmenu/{richMenuId}"
    .gsub(/{richMenuId}/, rich_menu_id.to_s)

  response = @http_client.post(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#set_webhook_endpoint(set_webhook_endpoint_request:) ⇒ String?

Set webhook endpoint URL This requests to PUT https://api.line.me/v2/bot/channel/webhook/endpoint When you want to get HTTP status code or response headers, use #set_webhook_endpoint_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2784
2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2784

def set_webhook_endpoint(
  set_webhook_endpoint_request:
)
  response_body, _status_code, _headers = set_webhook_endpoint_with_http_info(
    set_webhook_endpoint_request: set_webhook_endpoint_request
  )

  response_body
end

#set_webhook_endpoint_with_http_info(set_webhook_endpoint_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Set webhook endpoint URL This requests to PUT https://api.line.me/v2/bot/channel/webhook/endpoint This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2758

def set_webhook_endpoint_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  set_webhook_endpoint_request:
)
  path = "/v2/bot/channel/webhook/endpoint"

  response = @http_client.put(
    path: path,
    body_params: set_webhook_endpoint_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#show_loading_animation(show_loading_animation_request:) ⇒ String, ...

Display a loading animation in one-on-one chats between users and LINE Official Accounts. This requests to POST https://api.line.me/v2/bot/chat/loading/start When you want to get HTTP status code or response headers, use #show_loading_animation_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 202

  • (Line::Bot::V2::MessagingApi::ErrorResponse) —

    when HTTP status code is 400

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2837
2838
2839
2840
2841
2842
2843
2844
2845
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2837

def show_loading_animation(
  show_loading_animation_request:
)
  response_body, _status_code, _headers = show_loading_animation_with_http_info(
    show_loading_animation_request: show_loading_animation_request
  )

  response_body
end

#show_loading_animation_with_http_info(show_loading_animation_request:) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Display a loading animation in one-on-one chats between users and LINE Official Accounts. This requests to POST https://api.line.me/v2/bot/chat/loading/start This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 202

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 400

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2803

def show_loading_animation_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  show_loading_animation_request:
)
  path = "/v2/bot/chat/loading/start"

  response = @http_client.post(
    path: path,
    body_params: show_loading_animation_request,
  )

  case response.code.to_i
  when 202
    [response.body, 202, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#test_webhook_endpoint(test_webhook_endpoint_request: nil) ⇒ Line::Bot::V2::MessagingApi::TestWebhookEndpointResponse, ...

Test webhook endpoint This requests to POST https://api.line.me/v2/bot/channel/webhook/test When you want to get HTTP status code or response headers, use #test_webhook_endpoint_with_http_info instead of this.

Parameters:

Returns:

See Also:



2886
2887
2888
2889
2890
2891
2892
2893
2894
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2886

def test_webhook_endpoint(
  test_webhook_endpoint_request: nil
)
  response_body, _status_code, _headers = test_webhook_endpoint_with_http_info(
    test_webhook_endpoint_request: test_webhook_endpoint_request
  )

  response_body
end

#test_webhook_endpoint_with_http_info(test_webhook_endpoint_request: nil) ⇒ Array(Line::Bot::V2::MessagingApi::TestWebhookEndpointResponse, Integer, Hash{String => String}), Array((String|nil), Integer, Hash{String => String})

Test webhook endpoint This requests to POST https://api.line.me/v2/bot/channel/webhook/test This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

See Also:



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2855

def test_webhook_endpoint_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  test_webhook_endpoint_request: nil
)
  path = "/v2/bot/channel/webhook/test"

  response = @http_client.post(
    path: path,
    body_params: test_webhook_endpoint_request,
  )

  case response.code.to_i
  when 200
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::TestWebhookEndpointResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#unlink_rich_menu_id_from_user(user_id:) ⇒ String?

Unlink rich menu from user This requests to DELETE https://api.line.me/v2/bot/user/{userId}/richmenu When you want to get HTTP status code or response headers, use #unlink_rich_menu_id_from_user_with_http_info instead of this.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2930

def unlink_rich_menu_id_from_user(
  user_id:
)
  response_body, _status_code, _headers = unlink_rich_menu_id_from_user_with_http_info(
    user_id: user_id
  )

  response_body
end

#unlink_rich_menu_id_from_user_with_http_info(user_id:) ⇒ Array((String|nil), Integer, Hash{String => String})

Unlink rich menu from user This requests to DELETE https://api.line.me/v2/bot/user/{userId}/richmenu This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • user_id (String) —

    User ID. Found in the ‘source` object of webhook event objects. Do not use the LINE ID used in LINE.

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2904

def unlink_rich_menu_id_from_user_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  user_id:
)
  path = "/v2/bot/user/{userId}/richmenu"
    .gsub(/{userId}/, user_id.to_s)

  response = @http_client.delete(
    path: path,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#unlink_rich_menu_id_from_users(rich_menu_bulk_unlink_request:) ⇒ String?

Unlink rich menus from multiple users This requests to POST https://api.line.me/v2/bot/richmenu/bulk/unlink When you want to get HTTP status code or response headers, use #unlink_rich_menu_id_from_users_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 202

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



2974
2975
2976
2977
2978
2979
2980
2981
2982
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2974

def unlink_rich_menu_id_from_users(
  rich_menu_bulk_unlink_request:
)
  response_body, _status_code, _headers = unlink_rich_menu_id_from_users_with_http_info(
    rich_menu_bulk_unlink_request: rich_menu_bulk_unlink_request
  )

  response_body
end

#unlink_rich_menu_id_from_users_with_http_info(rich_menu_bulk_unlink_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Unlink rich menus from multiple users This requests to POST https://api.line.me/v2/bot/richmenu/bulk/unlink This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 202

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2948

def unlink_rich_menu_id_from_users_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_bulk_unlink_request:
)
  path = "/v2/bot/richmenu/bulk/unlink"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_bulk_unlink_request,
  )

  case response.code.to_i
  when 202
    [response.body, 202, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#update_rich_menu_alias(rich_menu_alias_id:, update_rich_menu_alias_request:) ⇒ String, ...

Update rich menu alias This requests to POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} When you want to get HTTP status code or response headers, use #update_rich_menu_alias_with_http_info instead of this.

Parameters:

  • rich_menu_alias_id (String) —

    The rich menu alias ID you want to update.

  • update_rich_menu_alias_request (UpdateRichMenuAliasRequest)

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (Line::Bot::V2::MessagingApi::ErrorResponse) —

    when HTTP status code is 400

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3031

def update_rich_menu_alias(
  rich_menu_alias_id:,
  update_rich_menu_alias_request:
)
  response_body, _status_code, _headers = update_rich_menu_alias_with_http_info(
    rich_menu_alias_id: rich_menu_alias_id,
    update_rich_menu_alias_request: update_rich_menu_alias_request
  )

  response_body
end

#update_rich_menu_alias_with_http_info(rich_menu_alias_id:, update_rich_menu_alias_request:) ⇒ Array((String|nil), Integer, Hash{String => String}), Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})

Update rich menu alias This requests to POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId} This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

  • rich_menu_alias_id (String) —

    The rich menu alias ID you want to update.

  • update_rich_menu_alias_request (UpdateRichMenuAliasRequest)

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})) —

    when HTTP status code is 400

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2994

def update_rich_menu_alias_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_alias_id:, 
  update_rich_menu_alias_request:
)
  path = "/v2/bot/richmenu/alias/{richMenuAliasId}"
    .gsub(/{richMenuAliasId}/, rich_menu_alias_id.to_s)

  response = @http_client.post(
    path: path,
    body_params: update_rich_menu_alias_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  when 400
    json = Line::Bot::V2::Utils.deep_underscore(JSON.parse(response.body))
    json.transform_keys! do |key|
      Line::Bot::V2::RESERVED_WORDS.include?(key) ? "_#{key}".to_sym : key
    end
    response_body = Line::Bot::V2::MessagingApi::ErrorResponse.create(json) # steep:ignore InsufficientKeywordArguments
    [response_body, 400, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_broadcast(validate_message_request:) ⇒ String?

Validate message objects of a broadcast message This requests to POST https://api.line.me/v2/bot/message/validate/broadcast When you want to get HTTP status code or response headers, use #validate_broadcast_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3077
3078
3079
3080
3081
3082
3083
3084
3085
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3077

def validate_broadcast(
  validate_message_request:
)
  response_body, _status_code, _headers = validate_broadcast_with_http_info(
    validate_message_request: validate_message_request
  )

  response_body
end

#validate_broadcast_with_http_info(validate_message_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate message objects of a broadcast message This requests to POST https://api.line.me/v2/bot/message/validate/broadcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3051

def validate_broadcast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  validate_message_request:
)
  path = "/v2/bot/message/validate/broadcast"

  response = @http_client.post(
    path: path,
    body_params: validate_message_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_multicast(validate_message_request:) ⇒ String?

Validate message objects of a multicast message This requests to POST https://api.line.me/v2/bot/message/validate/multicast When you want to get HTTP status code or response headers, use #validate_multicast_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3121
3122
3123
3124
3125
3126
3127
3128
3129
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3121

def validate_multicast(
  validate_message_request:
)
  response_body, _status_code, _headers = validate_multicast_with_http_info(
    validate_message_request: validate_message_request
  )

  response_body
end

#validate_multicast_with_http_info(validate_message_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate message objects of a multicast message This requests to POST https://api.line.me/v2/bot/message/validate/multicast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3095

def validate_multicast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  validate_message_request:
)
  path = "/v2/bot/message/validate/multicast"

  response = @http_client.post(
    path: path,
    body_params: validate_message_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_narrowcast(validate_message_request:) ⇒ String?

Validate message objects of a narrowcast message This requests to POST https://api.line.me/v2/bot/message/validate/narrowcast When you want to get HTTP status code or response headers, use #validate_narrowcast_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3165
3166
3167
3168
3169
3170
3171
3172
3173
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3165

def validate_narrowcast(
  validate_message_request:
)
  response_body, _status_code, _headers = validate_narrowcast_with_http_info(
    validate_message_request: validate_message_request
  )

  response_body
end

#validate_narrowcast_with_http_info(validate_message_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate message objects of a narrowcast message This requests to POST https://api.line.me/v2/bot/message/validate/narrowcast This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3139

def validate_narrowcast_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  validate_message_request:
)
  path = "/v2/bot/message/validate/narrowcast"

  response = @http_client.post(
    path: path,
    body_params: validate_message_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_push(validate_message_request:) ⇒ String?

Validate message objects of a push message This requests to POST https://api.line.me/v2/bot/message/validate/push When you want to get HTTP status code or response headers, use #validate_push_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3209
3210
3211
3212
3213
3214
3215
3216
3217
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3209

def validate_push(
  validate_message_request:
)
  response_body, _status_code, _headers = validate_push_with_http_info(
    validate_message_request: validate_message_request
  )

  response_body
end

#validate_push_with_http_info(validate_message_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate message objects of a push message This requests to POST https://api.line.me/v2/bot/message/validate/push This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3183

def validate_push_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  validate_message_request:
)
  path = "/v2/bot/message/validate/push"

  response = @http_client.post(
    path: path,
    body_params: validate_message_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_reply(validate_message_request:) ⇒ String?

Validate message objects of a reply message This requests to POST https://api.line.me/v2/bot/message/validate/reply When you want to get HTTP status code or response headers, use #validate_reply_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3253
3254
3255
3256
3257
3258
3259
3260
3261
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3253

def validate_reply(
  validate_message_request:
)
  response_body, _status_code, _headers = validate_reply_with_http_info(
    validate_message_request: validate_message_request
  )

  response_body
end

#validate_reply_with_http_info(validate_message_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate message objects of a reply message This requests to POST https://api.line.me/v2/bot/message/validate/reply This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3227

def validate_reply_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  validate_message_request:
)
  path = "/v2/bot/message/validate/reply"

  response = @http_client.post(
    path: path,
    body_params: validate_message_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_rich_menu_batch_request(rich_menu_batch_request:) ⇒ String?

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. This requests to POST https://api.line.me/v2/bot/richmenu/validate/batch When you want to get HTTP status code or response headers, use #validate_rich_menu_batch_request_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3297
3298
3299
3300
3301
3302
3303
3304
3305
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3297

def validate_rich_menu_batch_request(
  rich_menu_batch_request:
)
  response_body, _status_code, _headers = validate_rich_menu_batch_request_with_http_info(
    rich_menu_batch_request: rich_menu_batch_request
  )

  response_body
end

#validate_rich_menu_batch_request_with_http_info(rich_menu_batch_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. This requests to POST https://api.line.me/v2/bot/richmenu/validate/batch This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3271

def validate_rich_menu_batch_request_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_batch_request:
)
  path = "/v2/bot/richmenu/validate/batch"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_batch_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end

#validate_rich_menu_object(rich_menu_request:) ⇒ String?

Validate rich menu object This requests to POST https://api.line.me/v2/bot/richmenu/validate When you want to get HTTP status code or response headers, use #validate_rich_menu_object_with_http_info instead of this.

Parameters:

Returns:

  • (String, nil) —

    when HTTP status code is 200

  • (String, nil) —

    when other HTTP status code is returned. This String is HTTP response body itself.

See Also:



3341
3342
3343
3344
3345
3346
3347
3348
3349
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3341

def validate_rich_menu_object(
  rich_menu_request:
)
  response_body, _status_code, _headers = validate_rich_menu_object_with_http_info(
    rich_menu_request: rich_menu_request
  )

  response_body
end

#validate_rich_menu_object_with_http_info(rich_menu_request:) ⇒ Array((String|nil), Integer, Hash{String => String})

Validate rich menu object This requests to POST https://api.line.me/v2/bot/richmenu/validate This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.

Parameters:

Returns:

  • (Array((String|nil), Integer, Hash{String => String})) —

    when HTTP status code is 200

  • (Array((String|nil), Integer, Hash{String => String})) —

    when other HTTP status code is returned. String is HTTP response body itself.

See Also:



3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
 
# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 3315

def validate_rich_menu_object_with_http_info( # steep:ignore MethodBodyTypeMismatch 
  rich_menu_request:
)
  path = "/v2/bot/richmenu/validate"

  response = @http_client.post(
    path: path,
    body_params: rich_menu_request,
  )

  case response.code.to_i
  when 200
    [response.body, 200, response.each_header.to_h]
  else
    [response.body, response.code.to_i, response.each_header.to_h]
  end
end