line-bot-api 2.8.1 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. checksums.yaml +4 -4
  2. data/lib/line/bot/v2/channel_access_token/api/channel_access_token_client.rb +2 -2
  3. data/lib/line/bot/v2/channel_access_token/model/error_response.rb +1 -0
  4. data/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb +1 -0
  5. data/lib/line/bot/v2/insight/api/insight_client.rb +166 -0
  6. data/lib/line/bot/v2/insight/core.rb +10 -0
  7. data/lib/line/bot/v2/insight/model/age_tile.rb +1 -0
  8. data/lib/line/bot/v2/insight/model/app_type_tile.rb +1 -0
  9. data/lib/line/bot/v2/insight/model/area_tile.rb +1 -0
  10. data/lib/line/bot/v2/insight/model/error_detail.rb +1 -0
  11. data/lib/line/bot/v2/insight/model/gender_tile.rb +1 -0
  12. data/lib/line/bot/v2/insight/model/get_message_event_response_click.rb +1 -0
  13. data/lib/line/bot/v2/insight/model/get_message_event_response_message.rb +1 -0
  14. data/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb +1 -0
  15. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_daily_response.rb +97 -0
  16. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_bounds.rb +85 -0
  17. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_click.rb +79 -0
  18. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_daily_metrics.rb +79 -0
  19. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_impression.rb +73 -0
  20. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_summary_response.rb +97 -0
  21. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_bounds.rb +85 -0
  22. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_click.rb +73 -0
  23. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_impression.rb +67 -0
  24. data/lib/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_metrics.rb +73 -0
  25. data/lib/line/bot/v2/insight/model/subscription_period_tile.rb +1 -0
  26. data/lib/line/bot/v2/liff/model/add_liff_app_response.rb +1 -0
  27. data/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb +1 -0
  28. data/lib/line/bot/v2/liff/model/liff_app.rb +1 -0
  29. data/lib/line/bot/v2/liff/model/liff_features.rb +1 -0
  30. data/lib/line/bot/v2/manage_audience/model/audience_group.rb +2 -2
  31. data/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb +1 -0
  32. data/lib/line/bot/v2/module_attach/model/attach_module_response.rb +1 -0
  33. data/lib/line/bot/v2/webhook/model/account_link_event.rb +1 -0
  34. data/lib/line/bot/v2/webhook/model/activated_event.rb +1 -0
  35. data/lib/line/bot/v2/webhook/model/attached_module_content.rb +1 -0
  36. data/lib/line/bot/v2/webhook/model/audio_message_content.rb +1 -0
  37. data/lib/line/bot/v2/webhook/model/beacon_content.rb +1 -0
  38. data/lib/line/bot/v2/webhook/model/beacon_event.rb +1 -0
  39. data/lib/line/bot/v2/webhook/model/bot_resumed_event.rb +1 -0
  40. data/lib/line/bot/v2/webhook/model/bot_suspended_event.rb +1 -0
  41. data/lib/line/bot/v2/webhook/model/chat_control.rb +1 -0
  42. data/lib/line/bot/v2/webhook/model/deactivated_event.rb +1 -0
  43. data/lib/line/bot/v2/webhook/model/detached_module_content.rb +1 -0
  44. data/lib/line/bot/v2/webhook/model/file_message_content.rb +1 -0
  45. data/lib/line/bot/v2/webhook/model/follow_detail.rb +1 -0
  46. data/lib/line/bot/v2/webhook/model/follow_event.rb +1 -0
  47. data/lib/line/bot/v2/webhook/model/image_message_content.rb +1 -0
  48. data/lib/line/bot/v2/webhook/model/join_event.rb +1 -0
  49. data/lib/line/bot/v2/webhook/model/joined_members.rb +1 -0
  50. data/lib/line/bot/v2/webhook/model/leave_event.rb +1 -0
  51. data/lib/line/bot/v2/webhook/model/left_members.rb +1 -0
  52. data/lib/line/bot/v2/webhook/model/link_content.rb +1 -0
  53. data/lib/line/bot/v2/webhook/model/location_message_content.rb +1 -0
  54. data/lib/line/bot/v2/webhook/model/member_joined_event.rb +1 -0
  55. data/lib/line/bot/v2/webhook/model/member_left_event.rb +1 -0
  56. data/lib/line/bot/v2/webhook/model/membership_content.rb +1 -0
  57. data/lib/line/bot/v2/webhook/model/membership_event.rb +1 -0
  58. data/lib/line/bot/v2/webhook/model/message_event.rb +1 -0
  59. data/lib/line/bot/v2/webhook/model/module_content.rb +1 -0
  60. data/lib/line/bot/v2/webhook/model/module_event.rb +1 -0
  61. data/lib/line/bot/v2/webhook/model/pnp_delivery.rb +1 -0
  62. data/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb +1 -0
  63. data/lib/line/bot/v2/webhook/model/postback_content.rb +1 -0
  64. data/lib/line/bot/v2/webhook/model/postback_event.rb +1 -0
  65. data/lib/line/bot/v2/webhook/model/text_message_content.rb +1 -0
  66. data/lib/line/bot/v2/webhook/model/unfollow_event.rb +1 -0
  67. data/lib/line/bot/v2/webhook/model/unsend_detail.rb +1 -0
  68. data/lib/line/bot/v2/webhook/model/unsend_event.rb +1 -0
  69. data/lib/line/bot/v2/webhook/model/video_message_content.rb +1 -0
  70. data/lib/line/bot/v2/webhook/model/video_play_complete.rb +1 -0
  71. data/lib/line/bot/v2/webhook/model/video_play_complete_event.rb +1 -0
  72. data/lib/line/bot/version.rb +1 -1
  73. data/sig/line/bot/v2/channel_access_token/api/channel_access_token_client.rbs +2 -2
  74. data/sig/line/bot/v2/channel_access_token/model/error_response.rbs +1 -0
  75. data/sig/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rbs +1 -0
  76. data/sig/line/bot/v2/insight/api/insight_client.rbs +92 -0
  77. data/sig/line/bot/v2/insight/model/age_tile.rbs +1 -0
  78. data/sig/line/bot/v2/insight/model/app_type_tile.rbs +1 -0
  79. data/sig/line/bot/v2/insight/model/area_tile.rbs +1 -0
  80. data/sig/line/bot/v2/insight/model/error_detail.rbs +1 -0
  81. data/sig/line/bot/v2/insight/model/gender_tile.rbs +1 -0
  82. data/sig/line/bot/v2/insight/model/get_message_event_response_click.rbs +1 -0
  83. data/sig/line/bot/v2/insight/model/get_message_event_response_message.rbs +1 -0
  84. data/sig/line/bot/v2/insight/model/get_message_event_response_overview.rbs +1 -0
  85. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_daily_response.rbs +52 -0
  86. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_bounds.rbs +49 -0
  87. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_click.rbs +43 -0
  88. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_daily_metrics.rbs +46 -0
  89. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_daily_response_impression.rbs +40 -0
  90. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_summary_response.rbs +52 -0
  91. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_bounds.rbs +49 -0
  92. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_click.rbs +43 -0
  93. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_impression.rbs +40 -0
  94. data/sig/line/bot/v2/insight/model/get_rich_menu_insight_summary_response_metrics.rbs +43 -0
  95. data/sig/line/bot/v2/insight/model/subscription_period_tile.rbs +1 -0
  96. data/sig/line/bot/v2/liff/model/add_liff_app_response.rbs +1 -0
  97. data/sig/line/bot/v2/liff/model/get_all_liff_apps_response.rbs +1 -0
  98. data/sig/line/bot/v2/liff/model/liff_app.rbs +1 -0
  99. data/sig/line/bot/v2/liff/model/liff_features.rbs +1 -0
  100. data/sig/line/bot/v2/manage_audience/model/audience_group.rbs +3 -3
  101. data/sig/line/bot/v2/messaging_api/model/rich_menu_response.rbs +1 -0
  102. data/sig/line/bot/v2/module_attach/model/attach_module_response.rbs +1 -0
  103. data/sig/line/bot/v2/webhook/model/account_link_event.rbs +1 -0
  104. data/sig/line/bot/v2/webhook/model/activated_event.rbs +1 -0
  105. data/sig/line/bot/v2/webhook/model/attached_module_content.rbs +1 -0
  106. data/sig/line/bot/v2/webhook/model/audio_message_content.rbs +1 -0
  107. data/sig/line/bot/v2/webhook/model/beacon_content.rbs +1 -0
  108. data/sig/line/bot/v2/webhook/model/beacon_event.rbs +1 -0
  109. data/sig/line/bot/v2/webhook/model/bot_resumed_event.rbs +1 -0
  110. data/sig/line/bot/v2/webhook/model/bot_suspended_event.rbs +1 -0
  111. data/sig/line/bot/v2/webhook/model/chat_control.rbs +1 -0
  112. data/sig/line/bot/v2/webhook/model/deactivated_event.rbs +1 -0
  113. data/sig/line/bot/v2/webhook/model/detached_module_content.rbs +1 -0
  114. data/sig/line/bot/v2/webhook/model/file_message_content.rbs +1 -0
  115. data/sig/line/bot/v2/webhook/model/follow_detail.rbs +1 -0
  116. data/sig/line/bot/v2/webhook/model/follow_event.rbs +1 -0
  117. data/sig/line/bot/v2/webhook/model/image_message_content.rbs +1 -0
  118. data/sig/line/bot/v2/webhook/model/join_event.rbs +1 -0
  119. data/sig/line/bot/v2/webhook/model/joined_members.rbs +1 -0
  120. data/sig/line/bot/v2/webhook/model/leave_event.rbs +1 -0
  121. data/sig/line/bot/v2/webhook/model/left_members.rbs +1 -0
  122. data/sig/line/bot/v2/webhook/model/link_content.rbs +1 -0
  123. data/sig/line/bot/v2/webhook/model/location_message_content.rbs +1 -0
  124. data/sig/line/bot/v2/webhook/model/member_joined_event.rbs +1 -0
  125. data/sig/line/bot/v2/webhook/model/member_left_event.rbs +1 -0
  126. data/sig/line/bot/v2/webhook/model/membership_content.rbs +1 -0
  127. data/sig/line/bot/v2/webhook/model/membership_event.rbs +1 -0
  128. data/sig/line/bot/v2/webhook/model/message_event.rbs +1 -0
  129. data/sig/line/bot/v2/webhook/model/module_content.rbs +1 -0
  130. data/sig/line/bot/v2/webhook/model/module_event.rbs +1 -0
  131. data/sig/line/bot/v2/webhook/model/pnp_delivery.rbs +1 -0
  132. data/sig/line/bot/v2/webhook/model/pnp_delivery_completion_event.rbs +1 -0
  133. data/sig/line/bot/v2/webhook/model/postback_content.rbs +1 -0
  134. data/sig/line/bot/v2/webhook/model/postback_event.rbs +1 -0
  135. data/sig/line/bot/v2/webhook/model/text_message_content.rbs +1 -0
  136. data/sig/line/bot/v2/webhook/model/unfollow_event.rbs +1 -0
  137. data/sig/line/bot/v2/webhook/model/unsend_detail.rbs +1 -0
  138. data/sig/line/bot/v2/webhook/model/unsend_event.rbs +1 -0
  139. data/sig/line/bot/v2/webhook/model/video_message_content.rbs +1 -0
  140. data/sig/line/bot/v2/webhook/model/video_play_complete.rbs +1 -0
  141. data/sig/line/bot/v2/webhook/model/video_play_complete_event.rbs +1 -0
  142. metadata +21 -1
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#follow-event
14
15
  class FollowDetail
15
16
  # @!attribute [rw] is_unblocked
16
17
  # @return [Boolean] Whether a user has added your LINE Official Account as a friend or unblocked.
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when your LINE Official Account is added as a friend (or unblocked). You can reply to follow events.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#follow-event
17
18
  class FollowEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -13,6 +13,7 @@ module Line
13
13
  module Bot
14
14
  module V2
15
15
  module Webhook
16
+ # @see https://developers.line.biz/en/reference/messaging-api/#wh-image
16
17
  class ImageMessageContent < MessageContent
17
18
  # @!attribute [r] type
18
19
  # @return [String] Type
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when your LINE Official Account joins a group chat or multi-person chat. You can reply to join events.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#join-event
17
18
  class JoinEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#member-joined-event
14
15
  class JoinedMembers
15
16
  # @!attribute [rw] members
16
17
  # @return [Array[UserSource]] Users who joined. Array of source user objects.
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when a user removes your LINE Official Account from a group chat or when your LINE Official Account leaves a group chat or multi-person chat.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#leave-event
17
18
  class LeaveEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#member-left-event
14
15
  class LeftMembers
15
16
  # @!attribute [rw] members
16
17
  # @return [Array[UserSource]] Users who left. Array of source user objects.
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module Webhook
14
14
  # Content of the account link event.
15
+ # @see https://developers.line.biz/en/reference/messaging-api/#account-link-event
15
16
  class LinkContent
16
17
  # @!attribute [rw] result
17
18
  # @return [String] ('ok'|'failed') One of the following values to indicate whether linking the account was successful or not
@@ -13,6 +13,7 @@ module Line
13
13
  module Bot
14
14
  module V2
15
15
  module Webhook
16
+ # @see https://developers.line.biz/en/reference/messaging-api/#wh-location
16
17
  class LocationMessageContent < MessageContent
17
18
  # @!attribute [r] type
18
19
  # @return [String] Type
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when a user joins a group chat or multi-person chat that the LINE Official Account is in.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#member-joined-event
17
18
  class MemberJoinedEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when a user leaves a group chat or multi-person chat that the LINE Official Account is in.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#member-left-event
17
18
  class MemberLeftEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module Webhook
14
14
  # Content of the membership event.
15
+ # @see https://developers.line.biz/en/reference/messaging-api/#membership-event
15
16
  class MembershipContent
16
17
  # @!attribute [rw] type
17
18
  # @return [String] Type of membership event.
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # This event indicates that a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#membership-event
17
18
  class MembershipEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Webhook event object which contains the sent message.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#message-event
17
18
  class MessageEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/partner-docs/#module-channel-specific-webhook-events
14
15
  class ModuleContent
15
16
  # @!attribute [rw] type
16
17
  # @return [String] Type
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # This event indicates that the module channel has been attached to the LINE Official Account. Sent to the webhook URL server of the module channel.
17
+ # @see https://developers.line.biz/en/reference/partner-docs/#module-channel-specific-webhook-events
17
18
  class ModuleEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module Webhook
14
14
  # A delivery object containing a hashed phone number string or a string specified by `X-Line-Delivery-Tag` header
15
+ # @see https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#overview-delivery-webhook-event
15
16
  class PnpDelivery
16
17
  # @!attribute [rw] data
17
18
  # @return [String] A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # When a request is made to the LINE notification messages API and delivery of the LINE notification message to the user is completed, a dedicated webhook event (delivery completion event) is sent from the LINE Platform to the webhook URL of the bot server.
17
+ # @see https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#overview-delivery-webhook-event
17
18
  class PnpDeliveryCompletionEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#postback-event
14
15
  class PostbackContent
15
16
  # @!attribute [rw] data
16
17
  # @return [String] Postback data
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when a user performs a postback action which initiates a postback. You can reply to postback events.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#postback-event
17
18
  class PostbackEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -13,6 +13,7 @@ module Line
13
13
  module Bot
14
14
  module V2
15
15
  module Webhook
16
+ # @see https://developers.line.biz/en/reference/messaging-api/#wh-text
16
17
  class TextMessageContent < MessageContent
17
18
  # @!attribute [r] type
18
19
  # @return [String] Type
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when your LINE Official Account is blocked.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#unfollow-event
17
18
  class UnfollowEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#unsend-event
14
15
  class UnsendDetail
15
16
  # @!attribute [rw] message_id
16
17
  # @return [String] The message ID of the unsent message
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event object for when the user unsends a message.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#unsend-event
17
18
  class UnsendEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -13,6 +13,7 @@ module Line
13
13
  module Bot
14
14
  module V2
15
15
  module Webhook
16
+ # @see https://developers.line.biz/en/reference/messaging-api/#wh-video
16
17
  class VideoMessageContent < MessageContent
17
18
  # @!attribute [r] type
18
19
  # @return [String] Type
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Webhook
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete
14
15
  class VideoPlayComplete
15
16
  # @!attribute [rw] tracking_id
16
17
  # @return [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message.
@@ -14,6 +14,7 @@ module Line
14
14
  module V2
15
15
  module Webhook
16
16
  # Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
17
+ # @see https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete
17
18
  class VideoPlayCompleteEvent < Event
18
19
  # @!attribute [r] type
19
20
  # @return [String] Type of the event
@@ -2,6 +2,6 @@ module Line
2
2
  module Bot
3
3
  # This version is updated before releasing a new version in the release process.
4
4
  # You don't have to update this version manually.
5
- VERSION = "2.8.1"
5
+ VERSION = "2.9.0"
6
6
  end
7
7
  end
@@ -199,7 +199,7 @@ module Line
199
199
  # This requests to <code>POST https://api.line.me/v2/oauth/revoke</code>
200
200
  # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
201
201
  #
202
- # @param access_token [String] Channel access token
202
+ # @param access_token [String] A short-lived or long-lived channel access token.
203
203
  # @see https://developers.line.biz/en/reference/messaging-api/#revoke-longlived-or-shortlived-channel-access-token
204
204
  # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
205
205
  # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
@@ -214,7 +214,7 @@ module Line
214
214
  # This requests to <code>POST https://api.line.me/v2/oauth/revoke</code>
215
215
  # When you want to get HTTP status code or response headers, use {#revoke_channel_token_with_http_info} instead of this.
216
216
  #
217
- # @param access_token [String] Channel access token
217
+ # @param access_token [String] A short-lived or long-lived channel access token.
218
218
  # @see https://developers.line.biz/en/reference/messaging-api/#revoke-longlived-or-shortlived-channel-access-token
219
219
  # @return [String, nil] when HTTP status code is 200
220
220
  # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module ChannelAccessToken
14
14
  # Error response of the Channel access token
15
+ # @see https://developers.line.biz/en/reference/messaging-api/#error-responses
15
16
  class ErrorResponse
16
17
  attr_accessor error: String?
17
18
  attr_accessor error_description: String?
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module ChannelAccessToken
14
14
  # Verification result
15
+ # @see https://developers.line.biz/en/reference/messaging-api/#verify-channel-access-token-v2-1
15
16
  class VerifyChannelAccessTokenResponse
16
17
  attr_accessor client_id: String
17
18
  attr_accessor expires_in: Integer
@@ -152,6 +152,98 @@ module Line
152
152
  | String? # otherwise
153
153
  )
154
154
 
155
+ # Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only `richMenuId` is returned and the other fields are omitted.
156
+ # This requests to <code>GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily</code>
157
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
158
+ #
159
+ # @param rich_menu_id [String] ID of the rich menu created via the Messaging API.
160
+ # @param from [String] Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
161
+ # @param to [String] End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
162
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-daily
163
+ # @return [Array(Line::Bot::V2::Insight::GetRichMenuInsightDailyResponse, Integer, Hash{String => String})] when HTTP status code is 200
164
+ # @return [Array(Line::Bot::V2::Insight::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
165
+ # @return [Array(Line::Bot::V2::Insight::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 404
166
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
167
+ def get_rich_menu_insight_daily_with_http_info: (
168
+ rich_menu_id: String,
169
+ from: String,
170
+ to: String
171
+ ) -> (
172
+ [GetRichMenuInsightDailyResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
173
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
174
+ | [ErrorResponse, 404, Hash[untyped, untyped]] # when HTTP status code is 404
175
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
176
+ )
177
+
178
+ # Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only `richMenuId` is returned and the other fields are omitted.
179
+ # This requests to <code>GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily</code>
180
+ # When you want to get HTTP status code or response headers, use {#get_rich_menu_insight_daily_with_http_info} instead of this.
181
+ #
182
+ # @param rich_menu_id [String] ID of the rich menu created via the Messaging API.
183
+ # @param from [String] Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
184
+ # @param to [String] End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
185
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-daily
186
+ # @return [Line::Bot::V2::Insight::GetRichMenuInsightDailyResponse] when HTTP status code is 200
187
+ # @return [Line::Bot::V2::Insight::ErrorResponse] when HTTP status code is 400
188
+ # @return [Line::Bot::V2::Insight::ErrorResponse] when HTTP status code is 404
189
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
190
+ def get_rich_menu_insight_daily: (
191
+ rich_menu_id: String,
192
+ from: String,
193
+ to: String
194
+ ) -> (
195
+ GetRichMenuInsightDailyResponse # when HTTP status code is 200
196
+ | ErrorResponse # when HTTP status code is 400
197
+ | ErrorResponse # when HTTP status code is 404
198
+ | String? # otherwise
199
+ )
200
+
201
+ # Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only `richMenuId` is returned and the other fields are omitted.
202
+ # This requests to <code>GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary</code>
203
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
204
+ #
205
+ # @param rich_menu_id [String] ID of the rich menu created via the Messaging API.
206
+ # @param from [String] Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
207
+ # @param to [String] End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
208
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-summary
209
+ # @return [Array(Line::Bot::V2::Insight::GetRichMenuInsightSummaryResponse, Integer, Hash{String => String})] when HTTP status code is 200
210
+ # @return [Array(Line::Bot::V2::Insight::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
211
+ # @return [Array(Line::Bot::V2::Insight::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 404
212
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
213
+ def get_rich_menu_insight_summary_with_http_info: (
214
+ rich_menu_id: String,
215
+ from: String,
216
+ to: String
217
+ ) -> (
218
+ [GetRichMenuInsightSummaryResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
219
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
220
+ | [ErrorResponse, 404, Hash[untyped, untyped]] # when HTTP status code is 404
221
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
222
+ )
223
+
224
+ # Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only `richMenuId` is returned and the other fields are omitted.
225
+ # This requests to <code>GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary</code>
226
+ # When you want to get HTTP status code or response headers, use {#get_rich_menu_insight_summary_with_http_info} instead of this.
227
+ #
228
+ # @param rich_menu_id [String] ID of the rich menu created via the Messaging API.
229
+ # @param from [String] Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
230
+ # @param to [String] End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
231
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-summary
232
+ # @return [Line::Bot::V2::Insight::GetRichMenuInsightSummaryResponse] when HTTP status code is 200
233
+ # @return [Line::Bot::V2::Insight::ErrorResponse] when HTTP status code is 400
234
+ # @return [Line::Bot::V2::Insight::ErrorResponse] when HTTP status code is 404
235
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
236
+ def get_rich_menu_insight_summary: (
237
+ rich_menu_id: String,
238
+ from: String,
239
+ to: String
240
+ ) -> (
241
+ GetRichMenuInsightSummaryResponse # when HTTP status code is 200
242
+ | ErrorResponse # when HTTP status code is 400
243
+ | ErrorResponse # when HTTP status code is 404
244
+ | String? # otherwise
245
+ )
246
+
155
247
  # You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.
156
248
  # This requests to <code>GET https://api.line.me/v2/bot/insight/message/event/aggregation</code>
157
249
  # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
14
15
  class AgeTile
15
16
  attr_accessor age: 'from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown'?
16
17
  attr_accessor percentage: Float?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
14
15
  class AppTypeTile
15
16
  attr_accessor app_type: 'ios'|'android'|'others'?
16
17
  attr_accessor percentage: Float?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
14
15
  class AreaTile
15
16
  attr_accessor area: String?
16
17
  attr_accessor percentage: Float?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#error-responses
14
15
  class ErrorDetail
15
16
  attr_accessor message: String?
16
17
  attr_accessor property: String?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic
14
15
  class GenderTile
15
16
  attr_accessor gender: 'male'|'female'|'unknown'?
16
17
  attr_accessor percentage: Float?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response
14
15
  class GetMessageEventResponseClick
15
16
  attr_accessor seq: Integer?
16
17
  attr_accessor url: String?
@@ -11,6 +11,7 @@ module Line
11
11
  module Bot
12
12
  module V2
13
13
  module Insight
14
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response
14
15
  class GetMessageEventResponseMessage
15
16
  attr_accessor seq: Integer?
16
17
  attr_accessor impression: Integer?
@@ -12,6 +12,7 @@ module Line
12
12
  module V2
13
13
  module Insight
14
14
  # Summary of message statistics.
15
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response
15
16
  class GetMessageEventResponseOverview
16
17
  attr_accessor request_id: String?
17
18
  attr_accessor timestamp: Integer?
@@ -0,0 +1,52 @@
1
+ # LINE Messaging API(Insight)
2
+ # This document describes LINE Messaging API(Insight).
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module Insight
14
+ # Daily impression and click statistics for a rich menu created via the Messaging API.
15
+ class GetRichMenuInsightDailyResponse
16
+ attr_accessor rich_menu_id: String
17
+ attr_accessor metrics_from: String?
18
+ attr_accessor metrics_to: String?
19
+ attr_accessor impression: GetRichMenuInsightDailyResponseImpression?
20
+ attr_accessor clicks: Array[GetRichMenuInsightDailyResponseClick]?
21
+
22
+
23
+ # @param rich_menu_id [String] Rich menu ID.
24
+ # @param metrics_from [String,nil] Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260213).
25
+ # @param metrics_to [String,nil] End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260215).
26
+ # @param impression [GetRichMenuInsightDailyResponseImpression, Hash[Symbol, untyped], nil]
27
+ # @param clicks [Array[GetRichMenuInsightDailyResponseClick, Hash[Symbol, untyped]],nil] Daily click metrics for each tappable area of the rich menu.
28
+ def initialize: (
29
+ rich_menu_id: String,
30
+ ?metrics_from: String?,
31
+ ?metrics_to: String?,
32
+ ?impression: GetRichMenuInsightDailyResponseImpression?| Hash[Symbol, untyped]?,
33
+ ?clicks: Array[GetRichMenuInsightDailyResponseClick| Hash[Symbol, untyped]]?,
34
+ **untyped dynamic_attributes
35
+ ) -> void
36
+
37
+ # Create an instance of the class from a hash
38
+ # @param args [Hash] Hash containing all the required attributes
39
+ # @return [Line::Bot::V2::Insight::GetRichMenuInsightDailyResponse] Instance of the class
40
+ def self.create: (Hash[Symbol, untyped]) -> GetRichMenuInsightDailyResponse
41
+
42
+ # @param other [Object] Object to compare
43
+ # @return [Boolean] true if the objects are equal, false otherwise
44
+ def ==: (untyped other) -> bool
45
+
46
+ # @return [Integer] Hash code of the object
47
+ def hash: () -> Integer
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,49 @@
1
+ # LINE Messaging API(Insight)
2
+ # This document describes LINE Messaging API(Insight).
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module Insight
14
+ # Target area of the metrics, represented by the top-left coordinate, width, and height.
15
+ class GetRichMenuInsightDailyResponseBounds
16
+ attr_accessor x: Integer
17
+ attr_accessor y: Integer
18
+ attr_accessor width: Integer
19
+ attr_accessor height: Integer
20
+
21
+
22
+ # @param x [Integer] The x coordinate of the top-left corner of the target area.
23
+ # @param y [Integer] The y coordinate of the top-left corner of the target area.
24
+ # @param width [Integer] The width of the target area.
25
+ # @param height [Integer] The height of the target area.
26
+ def initialize: (
27
+ x: Integer,
28
+ y: Integer,
29
+ width: Integer,
30
+ height: Integer,
31
+ **untyped dynamic_attributes
32
+ ) -> void
33
+
34
+ # Create an instance of the class from a hash
35
+ # @param args [Hash] Hash containing all the required attributes
36
+ # @return [Line::Bot::V2::Insight::GetRichMenuInsightDailyResponseBounds] Instance of the class
37
+ def self.create: (Hash[Symbol, untyped]) -> GetRichMenuInsightDailyResponseBounds
38
+
39
+ # @param other [Object] Object to compare
40
+ # @return [Boolean] true if the objects are equal, false otherwise
41
+ def ==: (untyped other) -> bool
42
+
43
+ # @return [Integer] Hash code of the object
44
+ def hash: () -> Integer
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,43 @@
1
+ # LINE Messaging API(Insight)
2
+ # This document describes LINE Messaging API(Insight).
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module Insight
14
+ # Daily click metrics for a single tappable area of the rich menu.
15
+ class GetRichMenuInsightDailyResponseClick
16
+ attr_accessor bounds: GetRichMenuInsightDailyResponseBounds
17
+ attr_accessor metrics: Array[GetRichMenuInsightDailyResponseDailyMetrics]
18
+
19
+
20
+ # @param bounds [GetRichMenuInsightDailyResponseBounds, Hash[Symbol, untyped]]
21
+ # @param metrics [Array[GetRichMenuInsightDailyResponseDailyMetrics, Hash[Symbol, untyped]]] Per-day click metrics for the target area.
22
+ def initialize: (
23
+ bounds: GetRichMenuInsightDailyResponseBounds| Hash[Symbol, untyped],
24
+ metrics: Array[GetRichMenuInsightDailyResponseDailyMetrics| Hash[Symbol, untyped]],
25
+ **untyped dynamic_attributes
26
+ ) -> void
27
+
28
+ # Create an instance of the class from a hash
29
+ # @param args [Hash] Hash containing all the required attributes
30
+ # @return [Line::Bot::V2::Insight::GetRichMenuInsightDailyResponseClick] Instance of the class
31
+ def self.create: (Hash[Symbol, untyped]) -> GetRichMenuInsightDailyResponseClick
32
+
33
+ # @param other [Object] Object to compare
34
+ # @return [Boolean] true if the objects are equal, false otherwise
35
+ def ==: (untyped other) -> bool
36
+
37
+ # @return [Integer] Hash code of the object
38
+ def hash: () -> Integer
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end