From fd16ecfbb472ee0b600651f31a8a437b13149642 Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:11:49 +0900 Subject: [PATCH 1/6] NO-ISSUE template --- .../line-bot-sdk-ruby-generator/model.pebble | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble index 1a8e5c4f..9d3ad0f3 100644 --- a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble +++ b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble @@ -25,6 +25,28 @@ module Line {% if model.model.vendorExtensions.get("x-selector").propertyName != property.name %}attr_accessor{% else %}attr_reader{% endif %} :{{ property.name }}{% if property.description != null %} # {{ property.description }}{% endif %} {%- endfor %} + {# @param #} + {%- for variable in model.model.vars -%} + {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name -%} + {% if variable.openApiType == 'array' -%} + {% if variable.items.isModel -%} + # @param {{ variable.name }} [{{ "Array[#{variable.items.openApiType}]" }}] {{ variable.description }} + {% elseif variable.items.allowableValues != null -%} + # @param {{ variable.name }} [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor -%}]] {{ variable.description }} + {% else -%} + # @param {{ variable.name }} [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}] {{ variable.description }} + {% endif -%} + {% elseif variable.isModel -%} + # @param {{ variable.name }} [{{ variable.openApiType }}] {{ variable.description }} + {% else -%} + {% if variable.allowableValues != null -%} + # @param {{ variable.name }} [String] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} + {% else -%} + # @param {{ variable.name }} [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}] {{ variable.description }} + {% endif -%} + {% endif -%} + {% endif -%} + {% endfor -%} def initialize({% for property in model.model.vars %}{% if model.model.vendorExtensions.get("x-selector").propertyName != property.name %} {{ property.name }}:{% if property.defaultValue == null %}{{ property.required ? '' : ' nil' }}{% else %}{{ ' ' + property.defaultValue }}{% endif %},{% endif %}{% endfor %} **dynamic_attributes From 263a7a1ecafb5f8bf66769261b9bc01f986c25f3 Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:11:54 +0900 Subject: [PATCH 2/6] NO-ISSUE gen --- .../channel_access_token_key_ids_response.rb | 1 + .../model/error_response.rb | 2 ++ .../issue_channel_access_token_response.rb | 4 +++ ...ort_lived_channel_access_token_response.rb | 3 +++ ...stateless_channel_access_token_response.rb | 3 +++ .../verify_channel_access_token_response.rb | 3 +++ lib/line/bot/v2/insight/model/age_tile.rb | 2 ++ .../bot/v2/insight/model/app_type_tile.rb | 2 ++ lib/line/bot/v2/insight/model/area_tile.rb | 2 ++ lib/line/bot/v2/insight/model/error_detail.rb | 2 ++ .../bot/v2/insight/model/error_response.rb | 2 ++ lib/line/bot/v2/insight/model/gender_tile.rb | 2 ++ .../get_friends_demographics_response.rb | 6 +++++ .../model/get_message_event_response.rb | 3 +++ .../model/get_message_event_response_click.rb | 5 ++++ .../get_message_event_response_message.rb | 12 +++++++++ .../get_message_event_response_overview.rb | 7 +++++ .../model/get_number_of_followers_response.rb | 4 +++ ...t_number_of_message_deliveries_response.rb | 11 ++++++++ .../model/get_statistics_per_unit_response.rb | 3 +++ .../get_statistics_per_unit_response_click.rb | 5 ++++ ...et_statistics_per_unit_response_message.rb | 13 +++++++++ ...t_statistics_per_unit_response_overview.rb | 4 +++ .../insight/model/subscription_period_tile.rb | 2 ++ .../bot/v2/liff/model/add_liff_app_request.rb | 6 +++++ .../v2/liff/model/add_liff_app_response.rb | 1 + .../liff/model/get_all_liff_apps_response.rb | 1 + lib/line/bot/v2/liff/model/liff_app.rb | 7 +++++ lib/line/bot/v2/liff/model/liff_features.rb | 2 ++ lib/line/bot/v2/liff/model/liff_view.rb | 3 +++ .../v2/liff/model/update_liff_app_request.rb | 6 +++++ .../bot/v2/liff/model/update_liff_view.rb | 3 +++ .../bot/v2/manage_audience/model/adaccount.rb | 1 + .../add_audience_to_audience_group_request.rb | 3 +++ .../bot/v2/manage_audience/model/audience.rb | 1 + .../manage_audience/model/audience_group.rb | 12 +++++++++ .../model/audience_group_job.rb | 8 ++++++ .../model/create_audience_group_request.rb | 4 +++ .../model/create_audience_group_response.rb | 8 ++++++ ...eate_click_based_audience_group_request.rb | 3 +++ ...ate_click_based_audience_group_response.rb | 10 +++++++ ...create_imp_based_audience_group_request.rb | 2 ++ ...reate_imp_based_audience_group_response.rb | 5 ++++ .../manage_audience/model/detailed_owner.rb | 3 +++ .../v2/manage_audience/model/error_detail.rb | 2 ++ .../manage_audience/model/error_response.rb | 2 ++ .../model/get_audience_data_response.rb | 3 +++ ...audience_group_authority_level_response.rb | 1 + .../model/get_audience_groups_response.rb | 6 +++++ .../get_shared_audience_data_response.rb | 3 +++ .../get_shared_audience_groups_response.rb | 6 +++++ ..._audience_group_authority_level_request.rb | 1 + ...date_audience_group_description_request.rb | 1 + lib/line/bot/v2/messaging_api/model/action.rb | 2 ++ .../model/age_demographic_filter.rb | 2 ++ .../bot/v2/messaging_api/model/alt_uri.rb | 1 + .../model/app_type_demographic_filter.rb | 1 + .../model/area_demographic_filter.rb | 1 + .../messaging_api/model/audience_recipient.rb | 1 + .../v2/messaging_api/model/audio_message.rb | 4 +++ .../messaging_api/model/bot_info_response.rb | 7 +++++ .../messaging_api/model/broadcast_request.rb | 2 ++ .../messaging_api/model/buttons_template.rb | 8 ++++++ .../v2/messaging_api/model/camera_action.rb | 1 + .../messaging_api/model/camera_roll_action.rb | 1 + .../v2/messaging_api/model/carousel_column.rb | 6 +++++ .../messaging_api/model/carousel_template.rb | 3 +++ .../v2/messaging_api/model/chat_reference.rb | 1 + .../messaging_api/model/clipboard_action.rb | 2 ++ .../model/clipboard_imagemap_action.rb | 3 +++ .../messaging_api/model/confirm_template.rb | 2 ++ .../model/create_rich_menu_alias_request.rb | 2 ++ .../model/datetime_picker_action.rb | 6 +++++ .../messaging_api/model/demographic_filter.rb | 1 + lib/line/bot/v2/messaging_api/model/emoji.rb | 3 +++ .../model/emoji_substitution_object.rb | 2 ++ .../v2/messaging_api/model/error_detail.rb | 2 ++ .../v2/messaging_api/model/error_response.rb | 3 +++ lib/line/bot/v2/messaging_api/model/filter.rb | 1 + .../messaging_api/model/flex_block_style.rb | 3 +++ .../bot/v2/messaging_api/model/flex_box.rb | 27 +++++++++++++++++++ .../model/flex_box_background.rb | 1 + .../model/flex_box_linear_gradient.rb | 5 ++++ .../bot/v2/messaging_api/model/flex_bubble.rb | 8 ++++++ .../messaging_api/model/flex_bubble_styles.rb | 4 +++ .../bot/v2/messaging_api/model/flex_button.rb | 14 ++++++++++ .../v2/messaging_api/model/flex_carousel.rb | 1 + .../v2/messaging_api/model/flex_component.rb | 1 + .../v2/messaging_api/model/flex_container.rb | 1 + .../bot/v2/messaging_api/model/flex_filler.rb | 1 + .../bot/v2/messaging_api/model/flex_icon.rb | 10 +++++++ .../bot/v2/messaging_api/model/flex_image.rb | 16 +++++++++++ .../v2/messaging_api/model/flex_message.rb | 4 +++ .../v2/messaging_api/model/flex_separator.rb | 2 ++ .../bot/v2/messaging_api/model/flex_span.rb | 6 +++++ .../bot/v2/messaging_api/model/flex_text.rb | 22 +++++++++++++++ .../bot/v2/messaging_api/model/flex_video.rb | 5 ++++ .../model/gender_demographic_filter.rb | 1 + ...get_aggregation_unit_name_list_response.rb | 2 ++ .../get_aggregation_unit_usage_response.rb | 1 + .../model/get_followers_response.rb | 2 ++ .../get_joined_membership_users_response.rb | 2 ++ .../get_membership_subscription_response.rb | 1 + ...et_message_content_transcoding_response.rb | 1 + .../model/get_webhook_endpoint_response.rb | 2 ++ .../model/group_member_count_response.rb | 1 + .../model/group_summary_response.rb | 3 +++ .../model/group_user_profile_response.rb | 3 +++ .../model/image_carousel_column.rb | 2 ++ .../model/image_carousel_template.rb | 1 + .../v2/messaging_api/model/image_message.rb | 4 +++ .../v2/messaging_api/model/imagemap_action.rb | 2 ++ .../v2/messaging_api/model/imagemap_area.rb | 4 +++ .../messaging_api/model/imagemap_base_size.rb | 2 ++ .../model/imagemap_external_link.rb | 2 ++ .../messaging_api/model/imagemap_message.rb | 7 +++++ .../v2/messaging_api/model/imagemap_video.rb | 4 +++ .../model/issue_link_token_response.rb | 1 + lib/line/bot/v2/messaging_api/model/limit.rb | 2 ++ .../v2/messaging_api/model/location_action.rb | 1 + .../messaging_api/model/location_message.rb | 6 +++++ .../model/mark_messages_as_read_request.rb | 1 + .../model/members_ids_response.rb | 2 ++ .../bot/v2/messaging_api/model/membership.rb | 10 +++++++ .../model/membership_list_response.rb | 1 + .../model/mention_substitution_object.rb | 1 + .../v2/messaging_api/model/mention_target.rb | 1 + .../bot/v2/messaging_api/model/message.rb | 3 +++ .../v2/messaging_api/model/message_action.rb | 2 ++ .../model/message_imagemap_action.rb | 3 +++ .../model/message_quota_response.rb | 2 ++ .../messaging_api/model/multicast_request.rb | 4 +++ .../model/narrowcast_progress_response.rb | 8 ++++++ .../messaging_api/model/narrowcast_request.rb | 5 ++++ .../model/number_of_messages_response.rb | 2 ++ .../model/operator_demographic_filter.rb | 3 +++ .../messaging_api/model/operator_recipient.rb | 3 +++ .../model/pnp_messages_request.rb | 3 +++ .../v2/messaging_api/model/postback_action.rb | 6 +++++ .../model/push_message_request.rb | 4 +++ .../model/push_message_response.rb | 1 + .../bot/v2/messaging_api/model/quick_reply.rb | 1 + .../messaging_api/model/quick_reply_item.rb | 3 +++ .../model/quota_consumption_response.rb | 1 + .../bot/v2/messaging_api/model/recipient.rb | 1 + .../model/redelivery_recipient.rb | 1 + .../model/reply_message_request.rb | 3 +++ .../model/reply_message_response.rb | 1 + .../model/rich_menu_alias_list_response.rb | 1 + .../model/rich_menu_alias_response.rb | 2 ++ .../v2/messaging_api/model/rich_menu_area.rb | 2 ++ .../model/rich_menu_batch_link_operation.rb | 2 ++ .../model/rich_menu_batch_operation.rb | 1 + .../rich_menu_batch_progress_response.rb | 3 +++ .../model/rich_menu_batch_request.rb | 2 ++ .../model/rich_menu_batch_unlink_operation.rb | 1 + .../messaging_api/model/rich_menu_bounds.rb | 4 +++ .../model/rich_menu_bulk_link_request.rb | 2 ++ .../model/rich_menu_bulk_unlink_request.rb | 1 + .../model/rich_menu_id_response.rb | 1 + .../model/rich_menu_list_response.rb | 1 + .../messaging_api/model/rich_menu_request.rb | 5 ++++ .../messaging_api/model/rich_menu_response.rb | 6 +++++ .../v2/messaging_api/model/rich_menu_size.rb | 2 ++ .../model/rich_menu_switch_action.rb | 3 +++ .../model/room_member_count_response.rb | 1 + .../model/room_user_profile_response.rb | 3 +++ lib/line/bot/v2/messaging_api/model/sender.rb | 2 ++ .../v2/messaging_api/model/sent_message.rb | 2 ++ .../model/set_webhook_endpoint_request.rb | 1 + .../model/show_loading_animation_request.rb | 2 ++ .../v2/messaging_api/model/sticker_message.rb | 5 ++++ .../model/subscribed_membership_plan.rb | 6 +++++ .../model/subscribed_membership_user.rb | 4 +++ .../v2/messaging_api/model/subscription.rb | 2 ++ .../subscription_period_demographic_filter.rb | 2 ++ .../model/substitution_object.rb | 1 + .../bot/v2/messaging_api/model/template.rb | 1 + .../messaging_api/model/template_message.rb | 4 +++ .../model/test_webhook_endpoint_request.rb | 1 + .../model/test_webhook_endpoint_response.rb | 5 ++++ .../v2/messaging_api/model/text_message.rb | 5 ++++ .../v2/messaging_api/model/text_message_v2.rb | 5 ++++ .../model/update_rich_menu_alias_request.rb | 1 + .../bot/v2/messaging_api/model/uri_action.rb | 3 +++ .../model/uri_imagemap_action.rb | 3 +++ .../model/user_mention_target.rb | 1 + .../model/user_profile_response.rb | 5 ++++ .../model/validate_message_request.rb | 1 + .../v2/messaging_api/model/video_message.rb | 5 ++++ .../model/acquire_chat_control_request.rb | 2 ++ .../v2/module/model/detach_module_request.rb | 1 + .../v2/module/model/get_modules_response.rb | 2 ++ lib/line/bot/v2/module/model/module_bot.rb | 5 ++++ .../model/attach_module_response.rb | 2 ++ lib/line/bot/v2/shop/model/error_response.rb | 1 + .../v2/shop/model/mission_sticker_request.rb | 4 +++ .../v2/webhook/model/account_link_event.rb | 7 +++++ .../bot/v2/webhook/model/action_result.rb | 2 ++ .../bot/v2/webhook/model/activated_event.rb | 6 +++++ .../bot/v2/webhook/model/all_mentionee.rb | 2 ++ .../webhook/model/attached_module_content.rb | 2 ++ .../v2/webhook/model/audio_message_content.rb | 3 +++ .../bot/v2/webhook/model/beacon_content.rb | 3 +++ lib/line/bot/v2/webhook/model/beacon_event.rb | 7 +++++ .../bot/v2/webhook/model/bot_resumed_event.rb | 5 ++++ .../v2/webhook/model/bot_suspended_event.rb | 5 ++++ .../bot/v2/webhook/model/callback_request.rb | 2 ++ lib/line/bot/v2/webhook/model/chat_control.rb | 1 + .../bot/v2/webhook/model/content_provider.rb | 3 +++ .../bot/v2/webhook/model/deactivated_event.rb | 5 ++++ .../bot/v2/webhook/model/delivery_context.rb | 1 + .../webhook/model/detached_module_content.rb | 2 ++ lib/line/bot/v2/webhook/model/emoji.rb | 4 +++ lib/line/bot/v2/webhook/model/event.rb | 6 +++++ .../v2/webhook/model/file_message_content.rb | 3 +++ .../bot/v2/webhook/model/follow_detail.rb | 1 + lib/line/bot/v2/webhook/model/follow_event.rb | 7 +++++ lib/line/bot/v2/webhook/model/group_source.rb | 2 ++ .../v2/webhook/model/image_message_content.rb | 4 +++ lib/line/bot/v2/webhook/model/image_set.rb | 3 +++ lib/line/bot/v2/webhook/model/join_event.rb | 6 +++++ .../bot/v2/webhook/model/joined_members.rb | 1 + .../model/joined_membership_content.rb | 1 + lib/line/bot/v2/webhook/model/leave_event.rb | 5 ++++ lib/line/bot/v2/webhook/model/left_members.rb | 1 + .../webhook/model/left_membership_content.rb | 1 + lib/line/bot/v2/webhook/model/link_content.rb | 2 ++ .../v2/webhook/model/link_things_content.rb | 1 + .../webhook/model/location_message_content.rb | 5 ++++ .../v2/webhook/model/member_joined_event.rb | 7 +++++ .../bot/v2/webhook/model/member_left_event.rb | 6 +++++ .../v2/webhook/model/membership_content.rb | 1 + .../bot/v2/webhook/model/membership_event.rb | 7 +++++ lib/line/bot/v2/webhook/model/mention.rb | 1 + lib/line/bot/v2/webhook/model/mentionee.rb | 3 +++ .../bot/v2/webhook/model/message_content.rb | 2 ++ .../bot/v2/webhook/model/message_event.rb | 7 +++++ .../bot/v2/webhook/model/module_content.rb | 1 + lib/line/bot/v2/webhook/model/module_event.rb | 6 +++++ lib/line/bot/v2/webhook/model/pnp_delivery.rb | 1 + .../model/pnp_delivery_completion_event.rb | 6 +++++ .../bot/v2/webhook/model/postback_content.rb | 2 ++ .../bot/v2/webhook/model/postback_event.rb | 7 +++++ .../model/renewed_membership_content.rb | 1 + lib/line/bot/v2/webhook/model/room_source.rb | 2 ++ .../bot/v2/webhook/model/scenario_result.rb | 8 ++++++ .../model/scenario_result_things_content.rb | 2 ++ lib/line/bot/v2/webhook/model/source.rb | 1 + .../webhook/model/sticker_message_content.rb | 8 ++++++ .../v2/webhook/model/text_message_content.rb | 6 +++++ .../bot/v2/webhook/model/things_content.rb | 1 + lib/line/bot/v2/webhook/model/things_event.rb | 7 +++++ .../bot/v2/webhook/model/unfollow_event.rb | 5 ++++ .../v2/webhook/model/unlink_things_content.rb | 1 + .../bot/v2/webhook/model/unsend_detail.rb | 1 + lib/line/bot/v2/webhook/model/unsend_event.rb | 6 +++++ .../bot/v2/webhook/model/user_mentionee.rb | 4 +++ lib/line/bot/v2/webhook/model/user_source.rb | 1 + .../v2/webhook/model/video_message_content.rb | 4 +++ .../v2/webhook/model/video_play_complete.rb | 1 + .../model/video_play_complete_event.rb | 7 +++++ 262 files changed, 908 insertions(+) diff --git a/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb b/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb index 72aff373..0aaf4957 100644 --- a/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb @@ -16,6 +16,7 @@ module ChannelAccessToken class ChannelAccessTokenKeyIdsResponse attr_accessor :kids # Array of channel access token key IDs. + # @param kids [Array[String]] Array of channel access token key IDs. def initialize( kids:, **dynamic_attributes diff --git a/lib/line/bot/v2/channel_access_token/model/error_response.rb b/lib/line/bot/v2/channel_access_token/model/error_response.rb index ab37a7fa..131e3643 100644 --- a/lib/line/bot/v2/channel_access_token/model/error_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/error_response.rb @@ -16,6 +16,8 @@ class ErrorResponse attr_accessor :error # Error summary attr_accessor :error_description # Details of the error. Not returned in certain situations. + # @param error [String] Error summary + # @param error_description [String] Details of the error. Not returned in certain situations. def initialize( error: nil, error_description: nil, diff --git a/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb index 05decf2f..03e3c837 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb @@ -19,6 +19,10 @@ class IssueChannelAccessTokenResponse attr_accessor :token_type # A token type. attr_accessor :key_id # Unique key ID for identifying the channel access token. + # @param access_token [String] Channel access token. + # @param expires_in [Integer] Amount of time in seconds from issue to expiration of the channel access token + # @param token_type [String] A token type. + # @param key_id [String] Unique key ID for identifying the channel access token. def initialize( access_token:, expires_in:, diff --git a/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb index 6452c0fc..dba23728 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb @@ -18,6 +18,9 @@ class IssueShortLivedChannelAccessTokenResponse attr_accessor :expires_in # Time until channel access token expires in seconds from time the token is issued. attr_accessor :token_type # Token type. The value is always `Bearer`. + # @param access_token [String] A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. + # @param expires_in [Integer] Time until channel access token expires in seconds from time the token is issued. + # @param token_type [String] Token type. The value is always `Bearer`. def initialize( access_token:, expires_in:, diff --git a/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb index 020c665a..849fc1bc 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb @@ -18,6 +18,9 @@ class IssueStatelessChannelAccessTokenResponse attr_accessor :expires_in # Duration in seconds after which the issued access token expires attr_accessor :token_type # Token type. The value is always `Bearer`. + # @param access_token [String] A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. + # @param expires_in [Integer] Duration in seconds after which the issued access token expires + # @param token_type [String] Token type. The value is always `Bearer`. def initialize( access_token:, expires_in:, diff --git a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb index 45ee4e1e..aa06e604 100644 --- a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb @@ -17,6 +17,9 @@ class VerifyChannelAccessTokenResponse attr_accessor :expires_in # Number of seconds before the channel access token expires. attr_accessor :scope # Permissions granted to the channel access token. + # @param client_id [String] The channel ID for which the channel access token was issued. + # @param expires_in [Integer] Number of seconds before the channel access token expires. + # @param scope [String] Permissions granted to the channel access token. def initialize( client_id:, expires_in:, diff --git a/lib/line/bot/v2/insight/model/age_tile.rb b/lib/line/bot/v2/insight/model/age_tile.rb index 5090ca4d..4ff58563 100644 --- a/lib/line/bot/v2/insight/model/age_tile.rb +++ b/lib/line/bot/v2/insight/model/age_tile.rb @@ -15,6 +15,8 @@ class AgeTile attr_accessor :age # users' age attr_accessor :percentage # Percentage + # @param age [String] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age + # @param percentage [Float] Percentage def initialize( age: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/app_type_tile.rb b/lib/line/bot/v2/insight/model/app_type_tile.rb index 34346f6f..94f837db 100644 --- a/lib/line/bot/v2/insight/model/app_type_tile.rb +++ b/lib/line/bot/v2/insight/model/app_type_tile.rb @@ -15,6 +15,8 @@ class AppTypeTile attr_accessor :app_type # users' OS attr_accessor :percentage # Percentage + # @param app_type [String] ('ios'|'android'|'others') users' OS + # @param percentage [Float] Percentage def initialize( app_type: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/area_tile.rb b/lib/line/bot/v2/insight/model/area_tile.rb index a53954ec..ba10e5b3 100644 --- a/lib/line/bot/v2/insight/model/area_tile.rb +++ b/lib/line/bot/v2/insight/model/area_tile.rb @@ -15,6 +15,8 @@ class AreaTile attr_accessor :area # users' country and region attr_accessor :percentage # Percentage + # @param area [String] users' country and region + # @param percentage [Float] Percentage def initialize( area: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/error_detail.rb b/lib/line/bot/v2/insight/model/error_detail.rb index 368eb5eb..a8ed7123 100644 --- a/lib/line/bot/v2/insight/model/error_detail.rb +++ b/lib/line/bot/v2/insight/model/error_detail.rb @@ -15,6 +15,8 @@ class ErrorDetail attr_accessor :message # Details of the error. Not included in the response under certain situations. attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String] Details of the error. Not included in the response under certain situations. + # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/insight/model/error_response.rb b/lib/line/bot/v2/insight/model/error_response.rb index 97990fc5..4bc6d21d 100644 --- a/lib/line/bot/v2/insight/model/error_response.rb +++ b/lib/line/bot/v2/insight/model/error_response.rb @@ -16,6 +16,8 @@ class ErrorResponse attr_accessor :message # Message containing information about the error. attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. + # @param message [String] Message containing information about the error. + # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/insight/model/gender_tile.rb b/lib/line/bot/v2/insight/model/gender_tile.rb index 2971ed1d..274e85a2 100644 --- a/lib/line/bot/v2/insight/model/gender_tile.rb +++ b/lib/line/bot/v2/insight/model/gender_tile.rb @@ -15,6 +15,8 @@ class GenderTile attr_accessor :gender # users' gender attr_accessor :percentage # Percentage + # @param gender [String] ('male'|'female'|'unknown') users' gender + # @param percentage [Float] Percentage def initialize( gender: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb index 2c03e3b1..9fb3e053 100644 --- a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb +++ b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb @@ -21,6 +21,12 @@ class GetFriendsDemographicsResponse attr_accessor :app_types # Percentage by OS. attr_accessor :subscription_periods # Percentage per friendship duration. + # @param available [Boolean] true if friend demographic information is available. + # @param genders [Array[GenderTile]] Percentage per gender. + # @param ages [Array[AgeTile]] Percentage per age group. + # @param areas [Array[AreaTile]] Percentage per area. + # @param app_types [Array[AppTypeTile]] Percentage by OS. + # @param subscription_periods [Array[SubscriptionPeriodTile]] Percentage per friendship duration. def initialize( available: nil, genders: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response.rb b/lib/line/bot/v2/insight/model/get_message_event_response.rb index 624a6dde..46169f27 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response.rb @@ -18,6 +18,9 @@ class GetMessageEventResponse attr_accessor :messages # Array of information about individual message bubbles. attr_accessor :clicks # Array of information about opened URLs in the message. + # @param overview [GetMessageEventResponseOverview] + # @param messages [Array[GetMessageEventResponseMessage]] Array of information about individual message bubbles. + # @param clicks [Array[GetMessageEventResponseClick]] Array of information about opened URLs in the message. def initialize( overview: nil, messages: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb index 179388aa..3157f7b8 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb @@ -18,6 +18,11 @@ class GetMessageEventResponseClick attr_accessor :unique_click # Number of users that opened the URL. attr_accessor :unique_click_of_request # Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. + # @param seq [Integer] The URL's serial number. + # @param url [String] URL. + # @param click [Integer] Number of times the URL was opened. + # @param unique_click [Integer] Number of users that opened the URL. + # @param unique_click_of_request [Integer] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. def initialize( seq: nil, url: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb index 7f18599b..3c94a48a 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb @@ -25,6 +25,18 @@ class GetMessageEventResponseMessage attr_accessor :unique_media_played75_percent # Number of users that started playing audio or video in the bubble and played 75% of the total time. attr_accessor :unique_media_played100_percent # Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @param seq [Integer] Bubble's serial number. + # @param impression [Integer] Number of times the bubble was displayed. + # @param media_played [Integer] Number of times audio or video in the bubble started playing. + # @param media_played25_percent [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @param media_played50_percent [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @param media_played75_percent [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @param media_played100_percent [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @param unique_media_played [Integer] Number of users that started playing audio or video in the bubble. + # @param unique_media_played25_percent [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @param unique_media_played50_percent [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @param unique_media_played75_percent [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @param unique_media_played100_percent [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. def initialize( seq: nil, impression: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb index 1518bed5..0101111b 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb @@ -21,6 +21,13 @@ class GetMessageEventResponseOverview attr_accessor :unique_media_played # Number of users who started playing any video or audio in the message. attr_accessor :unique_media_played100_percent # Number of users who played the entirety of any video or audio in the message. + # @param request_id [String] Request ID. + # @param timestamp [Integer] UNIX timestamp for message delivery time in seconds. + # @param delivered [Integer] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. + # @param unique_impression [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @param unique_click [Integer] Number of users who opened any URL in the message. + # @param unique_media_played [Integer] Number of users who started playing any video or audio in the message. + # @param unique_media_played100_percent [Integer] Number of users who played the entirety of any video or audio in the message. def initialize( request_id: nil, timestamp: nil, diff --git a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb index 1551e538..b1b63900 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb @@ -19,6 +19,10 @@ class GetNumberOfFollowersResponse attr_accessor :targeted_reaches # The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. attr_accessor :blocks # The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. + # @param status [String] ('ready'|'unready'|'out_of_service') Calculation status. + # @param followers [Integer] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. + # @param targeted_reaches [Integer] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. + # @param blocks [Integer] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. def initialize( status: nil, followers: nil, diff --git a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb index bc541051..f16695d7 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb @@ -26,6 +26,17 @@ class GetNumberOfMessageDeliveriesResponse attr_accessor :api_narrowcast # Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. attr_accessor :api_reply # Number of replies sent with the `Send reply message` Messaging API operation. + # @param status [String] ('ready'|'unready'|'out_of_service') Status of the counting process. + # @param broadcast [Integer] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). + # @param targeting [Integer] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). + # @param auto_response [Integer] Number of auto-response messages sent. + # @param welcome_response [Integer] Number of greeting messages sent. + # @param chat [Integer] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). + # @param api_broadcast [Integer] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. + # @param api_push [Integer] Number of push messages sent with the `Send push message` Messaging API operation. + # @param api_multicast [Integer] Number of multicast messages sent with the `Send multicast message` Messaging API operation. + # @param api_narrowcast [Integer] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. + # @param api_reply [Integer] Number of replies sent with the `Send reply message` Messaging API operation. def initialize( status: nil, broadcast: nil, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb index 458b79d6..51f15bf9 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb @@ -18,6 +18,9 @@ class GetStatisticsPerUnitResponse attr_accessor :messages # Array of information about individual message bubbles. attr_accessor :clicks # Array of information about opened URLs in the message. + # @param overview [GetStatisticsPerUnitResponseOverview] + # @param messages [Array[GetStatisticsPerUnitResponseMessage]] Array of information about individual message bubbles. + # @param clicks [Array[GetStatisticsPerUnitResponseClick]] Array of information about opened URLs in the message. def initialize( overview:, messages:, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb index 5b41baf2..7049c414 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb @@ -19,6 +19,11 @@ class GetStatisticsPerUnitResponseClick attr_accessor :unique_click # Number of users that opened the URL in the bubble. attr_accessor :unique_click_of_request # Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. + # @param seq [Integer] The URL's serial number. + # @param url [String] URL. + # @param click [Integer] Number of times the URL in the bubble was opened. + # @param unique_click [Integer] Number of users that opened the URL in the bubble. + # @param unique_click_of_request [Integer] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. def initialize( seq:, url:, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb index d7e414d7..c5b3862d 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb @@ -27,6 +27,19 @@ class GetStatisticsPerUnitResponseMessage attr_accessor :unique_media_played75_percent # Number of users that started playing audio or video in the bubble and played 75% of the total time. attr_accessor :unique_media_played100_percent # Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @param seq [Integer] Bubble's serial number. + # @param impression [Integer] Number of times the bubble was displayed. + # @param media_played [Integer] Number of times audio or video in the bubble started playing. + # @param media_played25_percent [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @param media_played50_percent [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @param media_played75_percent [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @param media_played100_percent [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @param unique_impression [Integer] Number of users the bubble was displayed. + # @param unique_media_played [Integer] Number of users that started playing audio or video in the bubble. + # @param unique_media_played25_percent [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @param unique_media_played50_percent [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @param unique_media_played75_percent [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @param unique_media_played100_percent [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. def initialize( seq:, impression: nil, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb index bbf890e1..716116d1 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb @@ -19,6 +19,10 @@ class GetStatisticsPerUnitResponseOverview attr_accessor :unique_media_played # Number of users who started playing any video or audio in the message. attr_accessor :unique_media_played100_percent # Number of users who played the entirety of any video or audio in the message. + # @param unique_impression [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @param unique_click [Integer] Number of users who opened any URL in the message. + # @param unique_media_played [Integer] Number of users who started playing any video or audio in the message. + # @param unique_media_played100_percent [Integer] Number of users who played the entirety of any video or audio in the message. def initialize( unique_impression: nil, unique_click: nil, diff --git a/lib/line/bot/v2/insight/model/subscription_period_tile.rb b/lib/line/bot/v2/insight/model/subscription_period_tile.rb index 9577ef97..aca7f890 100644 --- a/lib/line/bot/v2/insight/model/subscription_period_tile.rb +++ b/lib/line/bot/v2/insight/model/subscription_period_tile.rb @@ -15,6 +15,8 @@ class SubscriptionPeriodTile attr_accessor :subscription_period # Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. attr_accessor :percentage # Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + # @param subscription_period [String] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. + # @param percentage [Float] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. def initialize( subscription_period: nil, percentage: nil, diff --git a/lib/line/bot/v2/liff/model/add_liff_app_request.rb b/lib/line/bot/v2/liff/model/add_liff_app_request.rb index cab4783c..92e07ec5 100644 --- a/lib/line/bot/v2/liff/model/add_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/add_liff_app_request.rb @@ -20,6 +20,12 @@ class AddLiffAppRequest attr_accessor :scope attr_accessor :bot_prompt + # @param view [LiffView] + # @param description [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @param features [LiffFeatures] + # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. Specify `concat`. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] + # @param bot_prompt [String] ('normal'|'aggressive'|'none') def initialize( view:, description: nil, diff --git a/lib/line/bot/v2/liff/model/add_liff_app_response.rb b/lib/line/bot/v2/liff/model/add_liff_app_response.rb index 073953fd..76908c84 100644 --- a/lib/line/bot/v2/liff/model/add_liff_app_response.rb +++ b/lib/line/bot/v2/liff/model/add_liff_app_response.rb @@ -14,6 +14,7 @@ module Liff class AddLiffAppResponse attr_accessor :liff_id + # @param liff_id [String] def initialize( liff_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb index 3c36b174..ec4d1f4e 100644 --- a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb +++ b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb @@ -14,6 +14,7 @@ module Liff class GetAllLiffAppsResponse attr_accessor :apps + # @param apps [Array[LiffApp]] def initialize( apps: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/liff/model/liff_app.rb b/lib/line/bot/v2/liff/model/liff_app.rb index 7e70b529..cc5f1d93 100644 --- a/lib/line/bot/v2/liff/model/liff_app.rb +++ b/lib/line/bot/v2/liff/model/liff_app.rb @@ -20,6 +20,13 @@ class LiffApp attr_accessor :scope attr_accessor :bot_prompt + # @param liff_id [String] LIFF app ID + # @param view [LiffView] + # @param description [String] Name of the LIFF app + # @param features [LiffFeatures] + # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. concat is returned. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] + # @param bot_prompt [String] ('normal'|'aggressive'|'none') def initialize( liff_id: nil, view: nil, diff --git a/lib/line/bot/v2/liff/model/liff_features.rb b/lib/line/bot/v2/liff/model/liff_features.rb index 4de048d3..99efb55e 100644 --- a/lib/line/bot/v2/liff/model/liff_features.rb +++ b/lib/line/bot/v2/liff/model/liff_features.rb @@ -15,6 +15,8 @@ class LiffFeatures attr_accessor :ble # `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. attr_accessor :qr_code # `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. + # @param ble [Boolean] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. + # @param qr_code [Boolean] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. def initialize( ble: nil, qr_code: false, diff --git a/lib/line/bot/v2/liff/model/liff_view.rb b/lib/line/bot/v2/liff/model/liff_view.rb index 8419009d..42644ced 100644 --- a/lib/line/bot/v2/liff/model/liff_view.rb +++ b/lib/line/bot/v2/liff/model/liff_view.rb @@ -17,6 +17,9 @@ class LiffView attr_accessor :url # Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. attr_accessor :module_mode # `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + # @param module_mode [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. def initialize( type:, url:, diff --git a/lib/line/bot/v2/liff/model/update_liff_app_request.rb b/lib/line/bot/v2/liff/model/update_liff_app_request.rb index 5b037e14..6e8452ee 100644 --- a/lib/line/bot/v2/liff/model/update_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/update_liff_app_request.rb @@ -20,6 +20,12 @@ class UpdateLiffAppRequest attr_accessor :scope attr_accessor :bot_prompt + # @param view [UpdateLiffView] + # @param description [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @param features [LiffFeatures] + # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. Specify `concat`. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] + # @param bot_prompt [String] ('normal'|'aggressive'|'none') def initialize( view: nil, description: nil, diff --git a/lib/line/bot/v2/liff/model/update_liff_view.rb b/lib/line/bot/v2/liff/model/update_liff_view.rb index 50352554..351f3281 100644 --- a/lib/line/bot/v2/liff/model/update_liff_view.rb +++ b/lib/line/bot/v2/liff/model/update_liff_view.rb @@ -17,6 +17,9 @@ class UpdateLiffView attr_accessor :url # Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. attr_accessor :module_mode # `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + # @param module_mode [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. def initialize( type: nil, url: nil, diff --git a/lib/line/bot/v2/manage_audience/model/adaccount.rb b/lib/line/bot/v2/manage_audience/model/adaccount.rb index 1979e752..2d577c90 100644 --- a/lib/line/bot/v2/manage_audience/model/adaccount.rb +++ b/lib/line/bot/v2/manage_audience/model/adaccount.rb @@ -15,6 +15,7 @@ module ManageAudience class Adaccount attr_accessor :name # Ad account name. + # @param name [String] Ad account name. def initialize( name: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb index 739bae9e..eb0a042e 100644 --- a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb @@ -18,6 +18,9 @@ class AddAudienceToAudienceGroupRequest attr_accessor :upload_description # The audience's name. attr_accessor :audiences # An array of up to 10,000 user IDs or IFAs. + # @param audience_group_id [Integer] The audience ID. + # @param upload_description [String] The audience's name. + # @param audiences [Array[Audience]] An array of up to 10,000 user IDs or IFAs. def initialize( audience_group_id: nil, upload_description: nil, diff --git a/lib/line/bot/v2/manage_audience/model/audience.rb b/lib/line/bot/v2/manage_audience/model/audience.rb index 4223e76b..74979e28 100644 --- a/lib/line/bot/v2/manage_audience/model/audience.rb +++ b/lib/line/bot/v2/manage_audience/model/audience.rb @@ -15,6 +15,7 @@ module ManageAudience class Audience attr_accessor :id # A user ID or IFA. You can specify an empty array. + # @param id [String] A user ID or IFA. You can specify an empty array. def initialize( id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/audience_group.rb b/lib/line/bot/v2/manage_audience/model/audience_group.rb index 267946fa..86e60666 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group.rb @@ -26,6 +26,18 @@ class AudienceGroup attr_accessor :permission attr_accessor :create_route + # @param audience_group_id [Integer] The audience ID. + # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String] The audience's name. + # @param status [String] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') + # @param failed_type [String] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') + # @param audience_count [Integer] The number of users included in the audience. + # @param created [Integer] When the audience was created (in UNIX time). + # @param request_id [String] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. + # @param click_url [String] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. + # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. + # @param permission [String] ('READ'|'READ_WRITE') + # @param create_route [String] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb index 854bfc3a..10b7accc 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb @@ -23,6 +23,14 @@ class AudienceGroupJob attr_accessor :audience_count # The number of accounts (recipients) that were added or removed. attr_accessor :created # When the job was created (in UNIX time). + # @param audience_group_job_id [Integer] A job ID. + # @param audience_group_id [Integer] An audience ID. + # @param description [String] The job's description. + # @param type [String] ('DIFF_ADD') + # @param job_status [String] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') + # @param failed_type [String] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') + # @param audience_count [Integer] The number of accounts (recipients) that were added or removed. + # @param created [Integer] When the job was created (in UNIX time). def initialize( audience_group_job_id: nil, audience_group_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb index cb98331a..1a78dc5b 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb @@ -19,6 +19,10 @@ class CreateAudienceGroupRequest attr_accessor :upload_description # The description to register for the job (in jobs[].description). attr_accessor :audiences # An array of user IDs or IFAs. Max number: 10,000 + # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param is_ifa_audience [Boolean] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. + # @param upload_description [String] The description to register for the job (in jobs[].description). + # @param audiences [Array[Audience]] An array of user IDs or IFAs. Max number: 10,000 def initialize( description: nil, is_ifa_audience: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb index 485bc5d5..3b41e710 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb @@ -23,6 +23,14 @@ class CreateAudienceGroupResponse attr_accessor :expire_timestamp # Time of audience expiration. Only returned for specific audiences. attr_accessor :is_ifa_audience # The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. + # @param audience_group_id [Integer] The audience ID. + # @param create_route [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String] The audience's name. + # @param created [Integer] When the audience was created (in UNIX time). + # @param permission [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. + # @param expire_timestamp [Float] Time of audience expiration. Only returned for specific audiences. + # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. def initialize( audience_group_id: nil, create_route: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb index 1d94cd83..a171e50e 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb @@ -18,6 +18,9 @@ class CreateClickBasedAudienceGroupRequest attr_accessor :request_id # The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. attr_accessor :click_url # The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 + # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @param click_url [String] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 def initialize( description: nil, request_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb index b2e04593..7fdc9ffa 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb @@ -25,6 +25,16 @@ class CreateClickBasedAudienceGroupResponse attr_accessor :expire_timestamp # Time of audience expiration. Only returned for specific audiences. attr_accessor :is_ifa_audience # The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. + # @param audience_group_id [Integer] The audience ID. + # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String] The audience's name. + # @param created [Integer] When the audience was created (in UNIX time). + # @param request_id [String] The request ID that was specified when the audience was created. + # @param click_url [String] The URL that was specified when the audience was created. + # @param create_route [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @param permission [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. + # @param expire_timestamp [Integer] Time of audience expiration. Only returned for specific audiences. + # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb index 9c5a5429..c521c3eb 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb @@ -17,6 +17,8 @@ class CreateImpBasedAudienceGroupRequest attr_accessor :description # The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 attr_accessor :request_id # The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @param description [String] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 + # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. def initialize( description: nil, request_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb index a4373da9..2bc26b7e 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb @@ -20,6 +20,11 @@ class CreateImpBasedAudienceGroupResponse attr_accessor :created # When the audience was created (in UNIX time). attr_accessor :request_id # The request ID that was specified when the audience was created. + # @param audience_group_id [Integer] The audience ID. + # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String] The audience's name. + # @param created [Integer] When the audience was created (in UNIX time). + # @param request_id [String] The request ID that was specified when the audience was created. def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb index 09a7ce31..48c99b86 100644 --- a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb +++ b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb @@ -17,6 +17,9 @@ class DetailedOwner attr_accessor :id # Owner ID in the service. attr_accessor :name # Owner account name. + # @param service_type [String] Service name where the audience group has been created. + # @param id [String] Owner ID in the service. + # @param name [String] Owner account name. def initialize( service_type: nil, id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/error_detail.rb b/lib/line/bot/v2/manage_audience/model/error_detail.rb index bdd0ee97..725c2cf2 100644 --- a/lib/line/bot/v2/manage_audience/model/error_detail.rb +++ b/lib/line/bot/v2/manage_audience/model/error_detail.rb @@ -15,6 +15,8 @@ class ErrorDetail attr_accessor :message # Details of the error. Not included in the response under certain situations. attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String] Details of the error. Not included in the response under certain situations. + # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/manage_audience/model/error_response.rb b/lib/line/bot/v2/manage_audience/model/error_response.rb index 8397df9d..283cb79a 100644 --- a/lib/line/bot/v2/manage_audience/model/error_response.rb +++ b/lib/line/bot/v2/manage_audience/model/error_response.rb @@ -16,6 +16,8 @@ class ErrorResponse attr_accessor :message # Message containing information about the error. attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. + # @param message [String] Message containing information about the error. + # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb index 018753a5..02804ee0 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb @@ -18,6 +18,9 @@ class GetAudienceDataResponse attr_accessor :jobs # An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 attr_accessor :adaccount + # @param audience_group [AudienceGroup] + # @param jobs [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @param adaccount [Adaccount] def initialize( audience_group: nil, jobs: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb index e814e0b5..63f9c42f 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb @@ -16,6 +16,7 @@ module ManageAudience class GetAudienceGroupAuthorityLevelResponse attr_accessor :authority_level + # @param authority_level [String] ('PUBLIC'|'PRIVATE') def initialize( authority_level: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb index c8c70a99..b152f005 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb @@ -21,6 +21,12 @@ class GetAudienceGroupsResponse attr_accessor :page # The current page number. attr_accessor :size # The maximum number of audiences on the current page. + # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @param has_next_page [Boolean] true when this is not the last page. + # @param total_count [Integer] The total number of audiences that can be returned with the specified filter. + # @param read_write_audience_group_total_count [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @param page [Integer] The current page number. + # @param size [Integer] The maximum number of audiences on the current page. def initialize( audience_groups: nil, has_next_page: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb index f154a547..03e3c946 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb @@ -18,6 +18,9 @@ class GetSharedAudienceDataResponse attr_accessor :jobs # An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 attr_accessor :owner + # @param audience_group [AudienceGroup] + # @param jobs [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @param owner [DetailedOwner] def initialize( audience_group: nil, jobs: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb index a9dc8891..5c6381cd 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb @@ -21,6 +21,12 @@ class GetSharedAudienceGroupsResponse attr_accessor :page # The current page number. attr_accessor :size # The maximum number of audiences on the current page. + # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @param has_next_page [Boolean] true when this is not the last page. + # @param total_count [Integer] The total number of audiences that can be returned with the specified filter. + # @param read_write_audience_group_total_count [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @param page [Integer] The current page number. + # @param size [Integer] The maximum number of audiences on the current page. def initialize( audience_groups: nil, has_next_page: nil, diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb index 07573268..92558346 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb @@ -16,6 +16,7 @@ module ManageAudience class UpdateAudienceGroupAuthorityLevelRequest attr_accessor :authority_level + # @param authority_level [String] ('PUBLIC'|'PRIVATE') def initialize( authority_level: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb index 1cd60a96..efcb78df 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb @@ -16,6 +16,7 @@ module ManageAudience class UpdateAudienceGroupDescriptionRequest attr_accessor :description # The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 def initialize( description: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/action.rb b/lib/line/bot/v2/messaging_api/model/action.rb index 3fc20fab..ed71e75a 100644 --- a/lib/line/bot/v2/messaging_api/model/action.rb +++ b/lib/line/bot/v2/messaging_api/model/action.rb @@ -17,6 +17,8 @@ class Action attr_accessor :type # Type of action attr_accessor :label # Label for the action. + # @param type [String] Type of action + # @param label [String] Label for the action. def initialize( type: nil, label: nil, diff --git a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb index 73e36b8a..f2bf5850 100644 --- a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb @@ -18,6 +18,8 @@ class AgeDemographicFilter < DemographicFilter attr_accessor :gte attr_accessor :lt + # @param gte [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') + # @param lt [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') def initialize( gte: nil, lt: nil, diff --git a/lib/line/bot/v2/messaging_api/model/alt_uri.rb b/lib/line/bot/v2/messaging_api/model/alt_uri.rb index c7f0f38c..3006ecb7 100644 --- a/lib/line/bot/v2/messaging_api/model/alt_uri.rb +++ b/lib/line/bot/v2/messaging_api/model/alt_uri.rb @@ -14,6 +14,7 @@ module MessagingApi class AltUri attr_accessor :desktop + # @param desktop [String] def initialize( desktop: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb index 032eccf9..936f3efc 100644 --- a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb @@ -17,6 +17,7 @@ class AppTypeDemographicFilter < DemographicFilter attr_reader :type # Type of demographic filter attr_accessor :one_of + # @param one_of [Array['ios'|'android']] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb index 7e91c986..d451f61a 100644 --- a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb @@ -17,6 +17,7 @@ class AreaDemographicFilter < DemographicFilter attr_reader :type # Type of demographic filter attr_accessor :one_of + # @param one_of [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12']] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb index eebf16b6..e85f586d 100644 --- a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb @@ -17,6 +17,7 @@ class AudienceRecipient < Recipient attr_reader :type # Type of recipient attr_accessor :audience_group_id + # @param audience_group_id [Integer] def initialize( audience_group_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/audio_message.rb b/lib/line/bot/v2/messaging_api/model/audio_message.rb index 08b94249..d4ee7fda 100644 --- a/lib/line/bot/v2/messaging_api/model/audio_message.rb +++ b/lib/line/bot/v2/messaging_api/model/audio_message.rb @@ -21,6 +21,10 @@ class AudioMessage < Message attr_accessor :original_content_url attr_accessor :duration + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param original_content_url [String] + # @param duration [Integer] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb index 12598efa..705ff656 100644 --- a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb +++ b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb @@ -21,6 +21,13 @@ class BotInfoResponse attr_accessor :chat_mode # Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". attr_accessor :mark_as_read_mode # Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned. `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled. + # @param user_id [String] Bot's user ID + # @param basic_id [String] Bot's basic ID + # @param premium_id [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @param display_name [String] Bot's display name + # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. + # @param chat_mode [String] ('chat'|'bot') Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". + # @param mark_as_read_mode [String] ('auto'|'manual') Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned. `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled. def initialize( user_id:, basic_id:, diff --git a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb index 405a086a..25a7d35a 100644 --- a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb @@ -16,6 +16,8 @@ class BroadcastRequest attr_accessor :messages # List of Message objects. attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param messages [Array[Message]] List of Message objects. + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, notification_disabled: false, diff --git a/lib/line/bot/v2/messaging_api/model/buttons_template.rb b/lib/line/bot/v2/messaging_api/model/buttons_template.rb index 357941cd..28f8217c 100644 --- a/lib/line/bot/v2/messaging_api/model/buttons_template.rb +++ b/lib/line/bot/v2/messaging_api/model/buttons_template.rb @@ -24,6 +24,14 @@ class ButtonsTemplate < Template attr_accessor :default_action attr_accessor :actions + # @param thumbnail_image_url [String] + # @param image_aspect_ratio [String] + # @param image_size [String] + # @param image_background_color [String] + # @param title [String] + # @param text [String] + # @param default_action [Action] + # @param actions [Array[Action]] def initialize( thumbnail_image_url: nil, image_aspect_ratio: nil, diff --git a/lib/line/bot/v2/messaging_api/model/camera_action.rb b/lib/line/bot/v2/messaging_api/model/camera_action.rb index 8caf8c71..4582a363 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_action.rb @@ -17,6 +17,7 @@ class CameraAction < Action attr_reader :type # Type of action attr_accessor :label # Label for the action. + # @param label [String] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb index e3153258..b9e0449b 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb @@ -17,6 +17,7 @@ class CameraRollAction < Action attr_reader :type # Type of action attr_accessor :label # Label for the action. + # @param label [String] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/carousel_column.rb b/lib/line/bot/v2/messaging_api/model/carousel_column.rb index 84347659..956c8357 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_column.rb @@ -20,6 +20,12 @@ class CarouselColumn attr_accessor :default_action attr_accessor :actions + # @param thumbnail_image_url [String] + # @param image_background_color [String] + # @param title [String] + # @param text [String] + # @param default_action [Action] + # @param actions [Array[Action]] def initialize( thumbnail_image_url: nil, image_background_color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/carousel_template.rb b/lib/line/bot/v2/messaging_api/model/carousel_template.rb index 6dba2bad..c3c0ee74 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_template.rb @@ -19,6 +19,9 @@ class CarouselTemplate < Template attr_accessor :image_aspect_ratio attr_accessor :image_size + # @param columns [Array[CarouselColumn]] + # @param image_aspect_ratio [String] + # @param image_size [String] def initialize( columns:, image_aspect_ratio: nil, diff --git a/lib/line/bot/v2/messaging_api/model/chat_reference.rb b/lib/line/bot/v2/messaging_api/model/chat_reference.rb index a7a5e3e5..113af431 100644 --- a/lib/line/bot/v2/messaging_api/model/chat_reference.rb +++ b/lib/line/bot/v2/messaging_api/model/chat_reference.rb @@ -16,6 +16,7 @@ module MessagingApi class ChatReference attr_accessor :user_id # The target user ID + # @param user_id [String] The target user ID def initialize( user_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb index 59cde1f8..0fd67973 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb @@ -19,6 +19,8 @@ class ClipboardAction < Action attr_accessor :label # Label for the action. attr_accessor :clipboard_text # Text that is copied to the clipboard. Max character limit: 1000 + # @param label [String] Label for the action. + # @param clipboard_text [String] Text that is copied to the clipboard. Max character limit: 1000 def initialize( label: nil, clipboard_text:, diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb index a27f3652..1e99c194 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb @@ -20,6 +20,9 @@ class ClipboardImagemapAction < ImagemapAction attr_accessor :clipboard_text # Text that is copied to the clipboard. Max character limit: 1000 attr_accessor :label + # @param area [ImagemapArea] + # @param clipboard_text [String] Text that is copied to the clipboard. Max character limit: 1000 + # @param label [String] def initialize( area:, clipboard_text:, diff --git a/lib/line/bot/v2/messaging_api/model/confirm_template.rb b/lib/line/bot/v2/messaging_api/model/confirm_template.rb index 9db14fab..5b920db3 100644 --- a/lib/line/bot/v2/messaging_api/model/confirm_template.rb +++ b/lib/line/bot/v2/messaging_api/model/confirm_template.rb @@ -18,6 +18,8 @@ class ConfirmTemplate < Template attr_accessor :text attr_accessor :actions + # @param text [String] + # @param actions [Array[Action]] def initialize( text:, actions:, diff --git a/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb b/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb index e770f9b6..79ca2190 100644 --- a/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb +++ b/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb @@ -16,6 +16,8 @@ class CreateRichMenuAliasRequest attr_accessor :rich_menu_alias_id # Rich menu alias ID, which can be any ID, unique for each channel. attr_accessor :rich_menu_id # The rich menu ID to be associated with the rich menu alias. + # @param rich_menu_alias_id [String] Rich menu alias ID, which can be any ID, unique for each channel. + # @param rich_menu_id [String] The rich menu ID to be associated with the rich menu alias. def initialize( rich_menu_alias_id:, rich_menu_id:, diff --git a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb index 8fb61234..97f0e261 100644 --- a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb +++ b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb @@ -23,6 +23,12 @@ class DatetimePickerAction < Action attr_accessor :max attr_accessor :min + # @param label [String] Label for the action. + # @param data [String] + # @param mode [String] ('date'|'time'|'datetime') + # @param initial [String] + # @param max [String] + # @param min [String] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb index e9958bfb..27b030bf 100644 --- a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb @@ -15,6 +15,7 @@ module MessagingApi class DemographicFilter attr_accessor :type # Type of demographic filter + # @param type [String] Type of demographic filter def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/emoji.rb b/lib/line/bot/v2/messaging_api/model/emoji.rb index 87bd3081..236f1cc7 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji.rb @@ -16,6 +16,9 @@ class Emoji attr_accessor :product_id attr_accessor :emoji_id + # @param index [Integer] + # @param product_id [String] + # @param emoji_id [String] def initialize( index: nil, product_id: nil, diff --git a/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb b/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb index 88ead32d..9aeb1695 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb @@ -20,6 +20,8 @@ class EmojiSubstitutionObject < SubstitutionObject attr_accessor :product_id attr_accessor :emoji_id + # @param product_id [String] + # @param emoji_id [String] def initialize( product_id:, emoji_id:, diff --git a/lib/line/bot/v2/messaging_api/model/error_detail.rb b/lib/line/bot/v2/messaging_api/model/error_detail.rb index 0bfcccaf..bccbd937 100644 --- a/lib/line/bot/v2/messaging_api/model/error_detail.rb +++ b/lib/line/bot/v2/messaging_api/model/error_detail.rb @@ -15,6 +15,8 @@ class ErrorDetail attr_accessor :message # Details of the error. Not included in the response under certain situations. attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String] Details of the error. Not included in the response under certain situations. + # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/messaging_api/model/error_response.rb b/lib/line/bot/v2/messaging_api/model/error_response.rb index 4b45707d..c6ffe1a5 100644 --- a/lib/line/bot/v2/messaging_api/model/error_response.rb +++ b/lib/line/bot/v2/messaging_api/model/error_response.rb @@ -17,6 +17,9 @@ class ErrorResponse attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. attr_accessor :sent_messages # Array of sent messages. + # @param message [String] Message containing information about the error. + # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @param sent_messages [Array[SentMessage]] Array of sent messages. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/messaging_api/model/filter.rb b/lib/line/bot/v2/messaging_api/model/filter.rb index 185bcac0..724859a1 100644 --- a/lib/line/bot/v2/messaging_api/model/filter.rb +++ b/lib/line/bot/v2/messaging_api/model/filter.rb @@ -15,6 +15,7 @@ module MessagingApi class Filter attr_accessor :demographic + # @param demographic [DemographicFilter] def initialize( demographic: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb index a25fc64c..fdd56f52 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb @@ -16,6 +16,9 @@ class FlexBlockStyle attr_accessor :separator attr_accessor :separator_color + # @param background_color [String] + # @param separator [Boolean] + # @param separator_color [String] def initialize( background_color: nil, separator: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_box.rb b/lib/line/bot/v2/messaging_api/model/flex_box.rb index 8fb0535f..850f2219 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box.rb @@ -43,6 +43,33 @@ class FlexBox < FlexComponent attr_accessor :align_items attr_accessor :background + # @param layout [String] ('horizontal'|'vertical'|'baseline') + # @param flex [Integer] + # @param contents [Array[FlexComponent]] + # @param spacing [String] + # @param margin [String] + # @param position [String] ('relative'|'absolute') + # @param offset_top [String] + # @param offset_bottom [String] + # @param offset_start [String] + # @param offset_end [String] + # @param background_color [String] + # @param border_color [String] + # @param border_width [String] + # @param corner_radius [String] + # @param width [String] + # @param max_width [String] + # @param height [String] + # @param max_height [String] + # @param padding_all [String] + # @param padding_top [String] + # @param padding_bottom [String] + # @param padding_start [String] + # @param padding_end [String] + # @param action [Action] + # @param justify_content [String] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') + # @param align_items [String] ('center'|'flex-start'|'flex-end') + # @param background [FlexBoxBackground] def initialize( layout:, flex: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_box_background.rb b/lib/line/bot/v2/messaging_api/model/flex_box_background.rb index 919ecb75..cf094c91 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box_background.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box_background.rb @@ -14,6 +14,7 @@ module MessagingApi class FlexBoxBackground attr_accessor :type + # @param type [String] def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb index 8f7a1edc..19e42ef7 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb @@ -21,6 +21,11 @@ class FlexBoxLinearGradient < FlexBoxBackground attr_accessor :center_color attr_accessor :center_position + # @param angle [String] + # @param start_color [String] + # @param end_color [String] + # @param center_color [String] + # @param center_position [String] def initialize( angle: nil, start_color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb index 739a28a5..0821b2fa 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb @@ -24,6 +24,14 @@ class FlexBubble < FlexContainer attr_accessor :size attr_accessor :action + # @param direction [String] ('ltr'|'rtl') + # @param styles [FlexBubbleStyles] + # @param header [FlexBox] + # @param hero [FlexComponent] + # @param body [FlexBox] + # @param footer [FlexBox] + # @param size [String] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') + # @param action [Action] def initialize( direction: nil, styles: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb index c21a6dab..a267456b 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb @@ -17,6 +17,10 @@ class FlexBubbleStyles attr_accessor :body attr_accessor :footer + # @param header [FlexBlockStyle] + # @param hero [FlexBlockStyle] + # @param body [FlexBlockStyle] + # @param footer [FlexBlockStyle] def initialize( header: nil, hero: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_button.rb b/lib/line/bot/v2/messaging_api/model/flex_button.rb index f8bcc186..f3f54afa 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_button.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_button.rb @@ -30,6 +30,20 @@ class FlexButton < FlexComponent attr_accessor :adjust_mode attr_accessor :scaling + # @param flex [Integer] + # @param color [String] + # @param style [String] ('primary'|'secondary'|'link') + # @param action [Action] + # @param gravity [String] ('top'|'bottom'|'center') + # @param margin [String] + # @param position [String] ('relative'|'absolute') + # @param offset_top [String] + # @param offset_bottom [String] + # @param offset_start [String] + # @param offset_end [String] + # @param height [String] ('md'|'sm') + # @param adjust_mode [String] ('shrink-to-fit') + # @param scaling [Boolean] def initialize( flex: nil, color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_carousel.rb b/lib/line/bot/v2/messaging_api/model/flex_carousel.rb index 1708482c..19acd6c4 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_carousel.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_carousel.rb @@ -17,6 +17,7 @@ class FlexCarousel < FlexContainer attr_reader :type attr_accessor :contents + # @param contents [Array[FlexBubble]] def initialize( contents:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_component.rb b/lib/line/bot/v2/messaging_api/model/flex_component.rb index 2a8939e9..c97ce71a 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_component.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_component.rb @@ -14,6 +14,7 @@ module MessagingApi class FlexComponent attr_accessor :type + # @param type [String] def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_container.rb b/lib/line/bot/v2/messaging_api/model/flex_container.rb index 7638f092..adf5d3ee 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_container.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_container.rb @@ -14,6 +14,7 @@ module MessagingApi class FlexContainer attr_accessor :type + # @param type [String] def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_filler.rb b/lib/line/bot/v2/messaging_api/model/flex_filler.rb index 53b1a00f..f5c3b8d8 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_filler.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_filler.rb @@ -17,6 +17,7 @@ class FlexFiller < FlexComponent attr_reader :type attr_accessor :flex + # @param flex [Integer] def initialize( flex: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_icon.rb b/lib/line/bot/v2/messaging_api/model/flex_icon.rb index d10d0de0..58489036 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_icon.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_icon.rb @@ -27,6 +27,16 @@ class FlexIcon < FlexComponent attr_accessor :offset_end attr_accessor :scaling + # @param url [String] + # @param size [String] + # @param aspect_ratio [String] + # @param margin [String] + # @param position [String] ('relative'|'absolute') + # @param offset_top [String] + # @param offset_bottom [String] + # @param offset_start [String] + # @param offset_end [String] + # @param scaling [Boolean] def initialize( url:, size: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_image.rb b/lib/line/bot/v2/messaging_api/model/flex_image.rb index f4f52574..ae17b240 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_image.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_image.rb @@ -33,6 +33,22 @@ class FlexImage < FlexComponent attr_accessor :action attr_accessor :animated # When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. + # @param url [String] Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) + # @param flex [Integer] The ratio of the width or height of this component within the parent box. + # @param margin [String] The minimum amount of space to include before this component in its parent container. + # @param position [String] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. + # @param offset_top [String] Offset. + # @param offset_bottom [String] Offset. + # @param offset_start [String] Offset. + # @param offset_end [String] Offset. + # @param align [String] ('start'|'end'|'center') Alignment style in horizontal direction. + # @param gravity [String] ('top'|'bottom'|'center') Alignment style in vertical direction. + # @param size [String] The maximum image width. This is md by default. + # @param aspect_ratio [String] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. + # @param aspect_mode [String] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. + # @param background_color [String] Background color of the image. Use a hexadecimal color code. + # @param action [Action] + # @param animated [Boolean] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. def initialize( url:, flex: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_message.rb b/lib/line/bot/v2/messaging_api/model/flex_message.rb index ffa54194..d17ba1c1 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_message.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_message.rb @@ -21,6 +21,10 @@ class FlexMessage < Message attr_accessor :alt_text attr_accessor :contents + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param alt_text [String] + # @param contents [FlexContainer] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_separator.rb b/lib/line/bot/v2/messaging_api/model/flex_separator.rb index 705a98d5..75b48b5f 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_separator.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_separator.rb @@ -18,6 +18,8 @@ class FlexSeparator < FlexComponent attr_accessor :margin attr_accessor :color + # @param margin [String] + # @param color [String] def initialize( margin: nil, color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_span.rb b/lib/line/bot/v2/messaging_api/model/flex_span.rb index 7fb3f562..2c839fee 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_span.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_span.rb @@ -22,6 +22,12 @@ class FlexSpan < FlexComponent attr_accessor :style attr_accessor :decoration + # @param text [String] + # @param size [String] + # @param color [String] + # @param weight [String] ('regular'|'bold') + # @param style [String] ('normal'|'italic') + # @param decoration [String] ('none'|'underline'|'line-through') def initialize( text: nil, size: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_text.rb b/lib/line/bot/v2/messaging_api/model/flex_text.rb index 50ad59c9..560de659 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_text.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_text.rb @@ -38,6 +38,28 @@ class FlexText < FlexComponent attr_accessor :adjust_mode attr_accessor :scaling + # @param flex [Integer] + # @param text [String] + # @param size [String] + # @param align [String] ('start'|'end'|'center') + # @param gravity [String] ('top'|'bottom'|'center') + # @param color [String] + # @param weight [String] ('regular'|'bold') + # @param style [String] ('normal'|'italic') + # @param decoration [String] ('none'|'underline'|'line-through') + # @param wrap [Boolean] + # @param line_spacing [String] + # @param margin [String] + # @param position [String] ('relative'|'absolute') + # @param offset_top [String] + # @param offset_bottom [String] + # @param offset_start [String] + # @param offset_end [String] + # @param action [Action] + # @param max_lines [Integer] + # @param contents [Array[FlexSpan]] + # @param adjust_mode [String] ('shrink-to-fit') + # @param scaling [Boolean] def initialize( flex: nil, text: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_video.rb b/lib/line/bot/v2/messaging_api/model/flex_video.rb index ab4da235..ce43e185 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_video.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_video.rb @@ -21,6 +21,11 @@ class FlexVideo < FlexComponent attr_accessor :aspect_ratio attr_accessor :action + # @param url [String] + # @param preview_url [String] + # @param alt_content [FlexComponent] + # @param aspect_ratio [String] + # @param action [Action] def initialize( url:, preview_url:, diff --git a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb index 98f36e72..844b9f77 100644 --- a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb @@ -17,6 +17,7 @@ class GenderDemographicFilter < DemographicFilter attr_reader :type # Type of demographic filter attr_accessor :one_of + # @param one_of [Array['male'|'female']] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb index b7e28525..d541b09e 100644 --- a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb @@ -16,6 +16,8 @@ class GetAggregationUnitNameListResponse attr_accessor :custom_aggregation_units # An array of strings indicating the names of aggregation units used this month. attr_accessor :_next # A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. + # @param custom_aggregation_units [Array[String]] An array of strings indicating the names of aggregation units used this month. + # @param _next [String] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. def initialize( custom_aggregation_units:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb index 143e5b93..17297e04 100644 --- a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb @@ -15,6 +15,7 @@ module MessagingApi class GetAggregationUnitUsageResponse attr_accessor :num_of_custom_aggregation_units # Number of aggregation units used this month. + # @param num_of_custom_aggregation_units [Integer] Number of aggregation units used this month. def initialize( num_of_custom_aggregation_units:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb index afaf7ed4..06059d62 100644 --- a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb @@ -16,6 +16,8 @@ class GetFollowersResponse attr_accessor :user_ids # An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. attr_accessor :_next # A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. + # @param user_ids [Array[String]] An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. + # @param _next [String] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. def initialize( user_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb index 1ac3225e..30fed081 100644 --- a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb @@ -17,6 +17,8 @@ class GetJoinedMembershipUsersResponse attr_accessor :user_ids # A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. attr_accessor :_next # 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). + # @param user_ids [Array[String]] A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. + # @param _next [String] 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). def initialize( user_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb b/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb index 6aac788b..9ebcd016 100644 --- a/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb @@ -16,6 +16,7 @@ module MessagingApi class GetMembershipSubscriptionResponse attr_accessor :subscriptions # List of subscription information + # @param subscriptions [Array[Subscription]] List of subscription information def initialize( subscriptions:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb b/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb index 921d1a2d..f68f6171 100644 --- a/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb @@ -16,6 +16,7 @@ module MessagingApi class GetMessageContentTranscodingResponse attr_accessor :status # The preparation status. One of: `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content. + # @param status [String] ('processing'|'succeeded'|'failed') The preparation status. One of: `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content. def initialize( status:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb b/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb index c40505b8..f2731f7d 100644 --- a/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb @@ -16,6 +16,8 @@ class GetWebhookEndpointResponse attr_accessor :endpoint # Webhook URL attr_accessor :active # Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. `true`: Webhook usage is enabled. `false`: Webhook usage is disabled. + # @param endpoint [String] Webhook URL + # @param active [Boolean] Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. `true`: Webhook usage is enabled. `false`: Webhook usage is disabled. def initialize( endpoint:, active:, diff --git a/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb b/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb index e31723b3..e6c8ec70 100644 --- a/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb @@ -15,6 +15,7 @@ module MessagingApi class GroupMemberCountResponse attr_accessor :count # The count of members in the group chat. The number returned excludes the LINE Official Account. + # @param count [Integer] The count of members in the group chat. The number returned excludes the LINE Official Account. def initialize( count:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb index a1e4f171..5d4826b4 100644 --- a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb @@ -17,6 +17,9 @@ class GroupSummaryResponse attr_accessor :group_name # Group name attr_accessor :picture_url # Group icon URL. Not included in the response if the user doesn't set a group profile icon. + # @param group_id [String] Group ID + # @param group_name [String] Group name + # @param picture_url [String] Group icon URL. Not included in the response if the user doesn't set a group profile icon. def initialize( group_id:, group_name:, diff --git a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb index 7f7a2c47..02ddcdf9 100644 --- a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb @@ -17,6 +17,9 @@ class GroupUserProfileResponse attr_accessor :user_id # User ID attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param display_name [String] User's display name + # @param user_id [String] User ID + # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb b/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb index 7a48419d..e632c253 100644 --- a/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb @@ -15,6 +15,8 @@ class ImageCarouselColumn attr_accessor :image_url attr_accessor :action + # @param image_url [String] + # @param action [Action] def initialize( image_url:, action:, diff --git a/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb b/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb index e76edcbd..21f30570 100644 --- a/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb @@ -17,6 +17,7 @@ class ImageCarouselTemplate < Template attr_reader :type attr_accessor :columns + # @param columns [Array[ImageCarouselColumn]] def initialize( columns:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/image_message.rb b/lib/line/bot/v2/messaging_api/model/image_message.rb index 7d5fc161..fb5a61d4 100644 --- a/lib/line/bot/v2/messaging_api/model/image_message.rb +++ b/lib/line/bot/v2/messaging_api/model/image_message.rb @@ -21,6 +21,10 @@ class ImageMessage < Message attr_accessor :original_content_url attr_accessor :preview_image_url + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param original_content_url [String] + # @param preview_image_url [String] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/imagemap_action.rb index eda3f3ec..683b355c 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_action.rb @@ -16,6 +16,8 @@ class ImagemapAction attr_accessor :type attr_accessor :area + # @param type [String] + # @param area [ImagemapArea] def initialize( type:, area:, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_area.rb b/lib/line/bot/v2/messaging_api/model/imagemap_area.rb index a04d0c0f..91f5c001 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_area.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_area.rb @@ -17,6 +17,10 @@ class ImagemapArea attr_accessor :width attr_accessor :height + # @param x [Integer] + # @param y [Integer] + # @param width [Integer] + # @param height [Integer] def initialize( x:, y:, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb b/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb index 1aac3fd1..0d8cd3a4 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb @@ -15,6 +15,8 @@ class ImagemapBaseSize attr_accessor :height attr_accessor :width + # @param height [Integer] + # @param width [Integer] def initialize( height:, width:, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb index 06eb5586..eb64f108 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb @@ -15,6 +15,8 @@ class ImagemapExternalLink attr_accessor :link_uri attr_accessor :label + # @param link_uri [String] + # @param label [String] def initialize( link_uri: nil, label: nil, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb index 9979ac9f..d6ff775b 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb @@ -24,6 +24,13 @@ class ImagemapMessage < Message attr_accessor :actions attr_accessor :video + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param base_url [String] + # @param alt_text [String] + # @param base_size [ImagemapBaseSize] + # @param actions [Array[ImagemapAction]] + # @param video [ImagemapVideo] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb index 5a2a4592..2ae3d964 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb @@ -17,6 +17,10 @@ class ImagemapVideo attr_accessor :area attr_accessor :external_link + # @param original_content_url [String] + # @param preview_image_url [String] + # @param area [ImagemapArea] + # @param external_link [ImagemapExternalLink] def initialize( original_content_url: nil, preview_image_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb b/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb index 745fc3d4..8f48866e 100644 --- a/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb +++ b/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb @@ -15,6 +15,7 @@ module MessagingApi class IssueLinkTokenResponse attr_accessor :link_token # Link token. Link tokens are valid for 10 minutes and can only be used once. + # @param link_token [String] Link token. Link tokens are valid for 10 minutes and can only be used once. def initialize( link_token:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/limit.rb b/lib/line/bot/v2/messaging_api/model/limit.rb index 4f9b7a0f..478d86eb 100644 --- a/lib/line/bot/v2/messaging_api/model/limit.rb +++ b/lib/line/bot/v2/messaging_api/model/limit.rb @@ -17,6 +17,8 @@ class Limit attr_accessor :max # The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. attr_accessor :up_to_remaining_quota # If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. + # @param max [Integer] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. + # @param up_to_remaining_quota [Boolean] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. def initialize( max: nil, up_to_remaining_quota: false, diff --git a/lib/line/bot/v2/messaging_api/model/location_action.rb b/lib/line/bot/v2/messaging_api/model/location_action.rb index 9d84164d..a80c5c32 100644 --- a/lib/line/bot/v2/messaging_api/model/location_action.rb +++ b/lib/line/bot/v2/messaging_api/model/location_action.rb @@ -17,6 +17,7 @@ class LocationAction < Action attr_reader :type # Type of action attr_accessor :label # Label for the action. + # @param label [String] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/location_message.rb b/lib/line/bot/v2/messaging_api/model/location_message.rb index 79ae1b57..a21fc182 100644 --- a/lib/line/bot/v2/messaging_api/model/location_message.rb +++ b/lib/line/bot/v2/messaging_api/model/location_message.rb @@ -23,6 +23,12 @@ class LocationMessage < Message attr_accessor :latitude attr_accessor :longitude + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param title [String] + # @param address [String] + # @param latitude [Float] + # @param longitude [Float] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb b/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb index 3e383eec..783e7d00 100644 --- a/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb +++ b/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb @@ -15,6 +15,7 @@ module MessagingApi class MarkMessagesAsReadRequest attr_accessor :chat + # @param chat [ChatReference] def initialize( chat:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb index f031cf2f..b1f46fe5 100644 --- a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb +++ b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb @@ -15,6 +15,8 @@ class MembersIdsResponse attr_accessor :member_ids # List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. attr_accessor :_next # A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. + # @param member_ids [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. + # @param _next [String] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. def initialize( member_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/membership.rb b/lib/line/bot/v2/messaging_api/model/membership.rb index 025264d0..85946f8d 100644 --- a/lib/line/bot/v2/messaging_api/model/membership.rb +++ b/lib/line/bot/v2/messaging_api/model/membership.rb @@ -23,6 +23,16 @@ class Membership attr_accessor :is_in_app_purchase # Payment method for users who subscribe to a membership plan. attr_accessor :is_published # Membership plan status. + # @param membership_id [Integer] Membership plan ID. + # @param title [String] Membership plan name. + # @param description [String] Membership plan description. + # @param benefits [Array[String]] List of membership plan perks. + # @param price [Float] Monthly fee for membership plan. (e.g. 1500.00) + # @param currency [String] ('JPY'|'TWD'|'THB') The currency of membership.price. + # @param member_count [Integer] Number of members subscribed to the membership plan. + # @param member_limit [Integer] The upper limit of members who can subscribe. If no upper limit is set, it will be null. + # @param is_in_app_purchase [Boolean] Payment method for users who subscribe to a membership plan. + # @param is_published [Boolean] Membership plan status. def initialize( membership_id:, title:, diff --git a/lib/line/bot/v2/messaging_api/model/membership_list_response.rb b/lib/line/bot/v2/messaging_api/model/membership_list_response.rb index f23945c2..4af20af6 100644 --- a/lib/line/bot/v2/messaging_api/model/membership_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/membership_list_response.rb @@ -15,6 +15,7 @@ module MessagingApi class MembershipListResponse attr_accessor :memberships # List of membership information + # @param memberships [Array[Membership]] List of membership information def initialize( memberships:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb b/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb index b90e9efc..9b24a298 100644 --- a/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb @@ -19,6 +19,7 @@ class MentionSubstitutionObject < SubstitutionObject attr_reader :type # Type of substitution object attr_accessor :mentionee + # @param mentionee [MentionTarget] def initialize( mentionee:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/mention_target.rb b/lib/line/bot/v2/messaging_api/model/mention_target.rb index 2cafbdaf..1c524730 100644 --- a/lib/line/bot/v2/messaging_api/model/mention_target.rb +++ b/lib/line/bot/v2/messaging_api/model/mention_target.rb @@ -14,6 +14,7 @@ module MessagingApi class MentionTarget attr_accessor :type # Target to be mentioned + # @param type [String] Target to be mentioned def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/message.rb b/lib/line/bot/v2/messaging_api/model/message.rb index fad2f317..ff91f0db 100644 --- a/lib/line/bot/v2/messaging_api/model/message.rb +++ b/lib/line/bot/v2/messaging_api/model/message.rb @@ -17,6 +17,9 @@ class Message attr_accessor :quick_reply attr_accessor :sender + # @param type [String] Type of message + # @param quick_reply [QuickReply] + # @param sender [Sender] def initialize( type:, quick_reply: nil, diff --git a/lib/line/bot/v2/messaging_api/model/message_action.rb b/lib/line/bot/v2/messaging_api/model/message_action.rb index 3c7ae83c..4701ceae 100644 --- a/lib/line/bot/v2/messaging_api/model/message_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_action.rb @@ -18,6 +18,8 @@ class MessageAction < Action attr_accessor :label # Label for the action. attr_accessor :text + # @param label [String] Label for the action. + # @param text [String] def initialize( label: nil, text: nil, diff --git a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb index 90fe2a9b..01f63aac 100644 --- a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb @@ -19,6 +19,9 @@ class MessageImagemapAction < ImagemapAction attr_accessor :text attr_accessor :label + # @param area [ImagemapArea] + # @param text [String] + # @param label [String] def initialize( area:, text:, diff --git a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb index 939163e0..0c847bce 100644 --- a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb +++ b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb @@ -16,6 +16,8 @@ class MessageQuotaResponse attr_accessor :type attr_accessor :value # The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. + # @param type [String] ('none'|'limited') + # @param value [Integer] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. def initialize( type:, value: nil, diff --git a/lib/line/bot/v2/messaging_api/model/multicast_request.rb b/lib/line/bot/v2/messaging_api/model/multicast_request.rb index e36e710c..26fbdb76 100644 --- a/lib/line/bot/v2/messaging_api/model/multicast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/multicast_request.rb @@ -18,6 +18,10 @@ class MulticastRequest attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :custom_aggregation_units # Name of aggregation unit. Case-sensitive. + # @param messages [Array[Message]] Messages to send + # @param to [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param custom_aggregation_units [Array[String]] Name of aggregation unit. Case-sensitive. def initialize( messages:, to:, diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb index 0253678f..1fec9e5d 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb @@ -22,6 +22,14 @@ class NarrowcastProgressResponse attr_accessor :accepted_time # Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC attr_accessor :completed_time # Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + # @param phase [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. + # @param success_count [Integer] The number of users who successfully received the message. + # @param failure_count [Integer] The number of users who failed to send the message. + # @param target_count [Integer] The number of intended recipients of the message. + # @param failed_description [String] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. + # @param error_code [Integer] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. + # @param accepted_time [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + # @param completed_time [String] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC def initialize( phase:, success_count: nil, diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb index 4dec205d..c1c52e4c 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb @@ -19,6 +19,11 @@ class NarrowcastRequest attr_accessor :limit attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param messages [Array[Message]] List of Message objects. + # @param recipient [Recipient] + # @param filter [Filter] + # @param limit [Limit] + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, recipient: nil, diff --git a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb index 400c6abe..1e8eaae3 100644 --- a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb +++ b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb @@ -15,6 +15,8 @@ class NumberOfMessagesResponse attr_accessor :status # Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). attr_accessor :success # The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. + # @param status [String] ('ready'|'unready'|'unavailable_for_privacy'|'out_of_service') Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). + # @param success [Integer] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. def initialize( status:, success: nil, diff --git a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb index 750232fb..9dd17e9e 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb @@ -19,6 +19,9 @@ class OperatorDemographicFilter < DemographicFilter attr_accessor :_or attr_accessor :_not + # @param _and [Array[DemographicFilter]] + # @param _or [Array[DemographicFilter]] + # @param _not [DemographicFilter] def initialize( _and: nil, _or: nil, diff --git a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb index 8c017e4a..2347aed7 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb @@ -19,6 +19,9 @@ class OperatorRecipient < Recipient attr_accessor :_or # Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. attr_accessor :_not + # @param _and [Array[Recipient]] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. + # @param _or [Array[Recipient]] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. + # @param _not [Recipient] def initialize( _and: nil, _or: nil, diff --git a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb index 5a4d309d..f7f583f5 100644 --- a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb +++ b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb @@ -17,6 +17,9 @@ class PnpMessagesRequest attr_accessor :to # Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param messages [Array[Message]] Message to be sent. + # @param to [String] Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, to:, diff --git a/lib/line/bot/v2/messaging_api/model/postback_action.rb b/lib/line/bot/v2/messaging_api/model/postback_action.rb index 38b35833..6c824bed 100644 --- a/lib/line/bot/v2/messaging_api/model/postback_action.rb +++ b/lib/line/bot/v2/messaging_api/model/postback_action.rb @@ -22,6 +22,12 @@ class PostbackAction < Action attr_accessor :input_option attr_accessor :fill_in_text + # @param label [String] Label for the action. + # @param data [String] + # @param display_text [String] + # @param text [String] + # @param input_option [String] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') + # @param fill_in_text [String] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/push_message_request.rb b/lib/line/bot/v2/messaging_api/model/push_message_request.rb index 6502d87b..90ecc076 100644 --- a/lib/line/bot/v2/messaging_api/model/push_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/push_message_request.rb @@ -18,6 +18,10 @@ class PushMessageRequest attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :custom_aggregation_units # List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. + # @param to [String] ID of the receiver. + # @param messages [Array[Message]] List of Message objects. + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param custom_aggregation_units [Array[String]] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. def initialize( to:, messages:, diff --git a/lib/line/bot/v2/messaging_api/model/push_message_response.rb b/lib/line/bot/v2/messaging_api/model/push_message_response.rb index 880b24b1..efe414af 100644 --- a/lib/line/bot/v2/messaging_api/model/push_message_response.rb +++ b/lib/line/bot/v2/messaging_api/model/push_message_response.rb @@ -15,6 +15,7 @@ module MessagingApi class PushMessageResponse attr_accessor :sent_messages # Array of sent messages. + # @param sent_messages [Array[SentMessage]] Array of sent messages. def initialize( sent_messages:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply.rb b/lib/line/bot/v2/messaging_api/model/quick_reply.rb index 7a6de948..c2b61fc4 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply.rb @@ -16,6 +16,7 @@ module MessagingApi class QuickReply attr_accessor :items # Quick reply button objects. + # @param items [Array[QuickReplyItem]] Quick reply button objects. def initialize( items: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb index 433bb463..80a8c500 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb @@ -17,6 +17,9 @@ class QuickReplyItem attr_accessor :action attr_accessor :type # `action` + # @param image_url [String] URL of the icon that is displayed at the beginning of the button + # @param action [Action] + # @param type [String] `action` def initialize( image_url: nil, action: nil, diff --git a/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb b/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb index 135b1402..6e126536 100644 --- a/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb +++ b/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb @@ -15,6 +15,7 @@ module MessagingApi class QuotaConsumptionResponse attr_accessor :total_usage # The number of sent messages in the current month + # @param total_usage [Integer] The number of sent messages in the current month def initialize( total_usage:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/recipient.rb b/lib/line/bot/v2/messaging_api/model/recipient.rb index 05c00849..a1d0f3b1 100644 --- a/lib/line/bot/v2/messaging_api/model/recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/recipient.rb @@ -15,6 +15,7 @@ module MessagingApi class Recipient attr_accessor :type # Type of recipient + # @param type [String] Type of recipient def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb index ee95e20a..4f3d142f 100644 --- a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb @@ -17,6 +17,7 @@ class RedeliveryRecipient < Recipient attr_reader :type # Type of recipient attr_accessor :request_id + # @param request_id [String] def initialize( request_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb index 86c339c8..8e4d338d 100644 --- a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb @@ -17,6 +17,9 @@ class ReplyMessageRequest attr_accessor :messages # List of messages. attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param reply_token [String] replyToken received via webhook. + # @param messages [Array[Message]] List of messages. + # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( reply_token:, messages:, diff --git a/lib/line/bot/v2/messaging_api/model/reply_message_response.rb b/lib/line/bot/v2/messaging_api/model/reply_message_response.rb index 849cf788..3eca0a56 100644 --- a/lib/line/bot/v2/messaging_api/model/reply_message_response.rb +++ b/lib/line/bot/v2/messaging_api/model/reply_message_response.rb @@ -15,6 +15,7 @@ module MessagingApi class ReplyMessageResponse attr_accessor :sent_messages # Array of sent messages. + # @param sent_messages [Array[SentMessage]] Array of sent messages. def initialize( sent_messages:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb index eeb5f112..0563f5b3 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb @@ -15,6 +15,7 @@ module MessagingApi class RichMenuAliasListResponse attr_accessor :aliases # Rich menu aliases. + # @param aliases [Array[RichMenuAliasResponse]] Rich menu aliases. def initialize( aliases:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb index f752c627..f2169283 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb @@ -15,6 +15,8 @@ class RichMenuAliasResponse attr_accessor :rich_menu_alias_id # Rich menu alias ID. attr_accessor :rich_menu_id # The rich menu ID associated with the rich menu alias. + # @param rich_menu_alias_id [String] Rich menu alias ID. + # @param rich_menu_id [String] The rich menu ID associated with the rich menu alias. def initialize( rich_menu_alias_id:, rich_menu_id:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb index 350f9220..267c374b 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb @@ -16,6 +16,8 @@ class RichMenuArea attr_accessor :bounds attr_accessor :action + # @param bounds [RichMenuBounds] + # @param action [Action] def initialize( bounds: nil, action: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb index b5ef3f42..b9bc97d8 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb @@ -19,6 +19,8 @@ class RichMenuBatchLinkOperation < RichMenuBatchOperation attr_accessor :from attr_accessor :to + # @param from [String] + # @param to [String] def initialize( from:, to:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb index 8abe84bc..3fff0a94 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb @@ -16,6 +16,7 @@ module MessagingApi class RichMenuBatchOperation attr_accessor :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + # @param type [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb index 69a0c90d..451e3890 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb @@ -17,6 +17,9 @@ class RichMenuBatchProgressResponse attr_accessor :accepted_time # The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC attr_accessor :completed_time # The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + # @param phase [String] ('ongoing'|'succeeded'|'failed') + # @param accepted_time [String] The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + # @param completed_time [String] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC def initialize( phase:, accepted_time:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb index beaf935c..d960292c 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb @@ -15,6 +15,8 @@ class RichMenuBatchRequest attr_accessor :operations # Array of Rich menu operation object... attr_accessor :resume_request_key # Key for retry. Key value is a string matching the regular expression pattern + # @param operations [Array[RichMenuBatchOperation]] Array of Rich menu operation object... + # @param resume_request_key [String] Key for retry. Key value is a string matching the regular expression pattern def initialize( operations:, resume_request_key: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb index 69579a5e..13d04b7f 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb @@ -18,6 +18,7 @@ class RichMenuBatchUnlinkOperation < RichMenuBatchOperation attr_reader :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. attr_accessor :from + # @param from [String] def initialize( from:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb index 35066562..7d3b3d8f 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb @@ -19,6 +19,10 @@ class RichMenuBounds attr_accessor :width # Width of the area. attr_accessor :height # Height of the area. + # @param x [Integer] Horizontal position relative to the top-left corner of the area. + # @param y [Integer] Vertical position relative to the top-left corner of the area. + # @param width [Integer] Width of the area. + # @param height [Integer] Height of the area. def initialize( x: nil, y: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb index 5f7e64d9..24d0dd1c 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb @@ -16,6 +16,8 @@ class RichMenuBulkLinkRequest attr_accessor :rich_menu_id # ID of a rich menu attr_accessor :user_ids # Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + # @param rich_menu_id [String] ID of a rich menu + # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. def initialize( rich_menu_id:, user_ids:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb index 653632dd..b126c4c8 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb @@ -15,6 +15,7 @@ module MessagingApi class RichMenuBulkUnlinkRequest attr_accessor :user_ids # Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. def initialize( user_ids:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb index 37f6da9a..e009e6ae 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb @@ -14,6 +14,7 @@ module MessagingApi class RichMenuIdResponse attr_accessor :rich_menu_id # Rich menu ID + # @param rich_menu_id [String] Rich menu ID def initialize( rich_menu_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb index e8c01035..13ceb50b 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb @@ -15,6 +15,7 @@ module MessagingApi class RichMenuListResponse attr_accessor :richmenus # Rich menus + # @param richmenus [Array[RichMenuResponse]] Rich menus def initialize( richmenus:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb index 9b063357..df8b1c13 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb @@ -18,6 +18,11 @@ class RichMenuRequest attr_accessor :chat_bar_text # Text displayed in the chat bar attr_accessor :areas # Array of area objects which define the coordinates and size of tappable areas + # @param size [RichMenuSize] + # @param selected [Boolean] `true` to display the rich menu by default. Otherwise, `false`. + # @param name [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + # @param chat_bar_text [String] Text displayed in the chat bar + # @param areas [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas def initialize( size: nil, selected: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb index 5f414806..3db368f9 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb @@ -19,6 +19,12 @@ class RichMenuResponse attr_accessor :chat_bar_text # Text displayed in the chat bar attr_accessor :areas # Array of area objects which define the coordinates and size of tappable areas + # @param rich_menu_id [String] ID of a rich menu + # @param size [RichMenuSize] + # @param selected [Boolean] `true` to display the rich menu by default. Otherwise, `false`. + # @param name [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + # @param chat_bar_text [String] Text displayed in the chat bar + # @param areas [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas def initialize( rich_menu_id:, size:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb index 2a91d4ee..b83300a7 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb @@ -16,6 +16,8 @@ class RichMenuSize attr_accessor :width # width attr_accessor :height # height + # @param width [Integer] width + # @param height [Integer] height def initialize( width: nil, height: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb index 557328ff..56e2abe2 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb @@ -19,6 +19,9 @@ class RichMenuSwitchAction < Action attr_accessor :data attr_accessor :rich_menu_alias_id + # @param label [String] Label for the action. + # @param data [String] + # @param rich_menu_alias_id [String] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb b/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb index 9fbd7b1e..a3b0c4a9 100644 --- a/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb +++ b/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb @@ -15,6 +15,7 @@ module MessagingApi class RoomMemberCountResponse attr_accessor :count # The count of members in the multi-person chat. The number returned excludes the LINE Official Account. + # @param count [Integer] The count of members in the multi-person chat. The number returned excludes the LINE Official Account. def initialize( count:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb index 3a64f62f..987b145e 100644 --- a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb @@ -17,6 +17,9 @@ class RoomUserProfileResponse attr_accessor :user_id # User ID attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param display_name [String] User's display name + # @param user_id [String] User ID + # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/sender.rb b/lib/line/bot/v2/messaging_api/model/sender.rb index b42e4b93..0f843f2c 100644 --- a/lib/line/bot/v2/messaging_api/model/sender.rb +++ b/lib/line/bot/v2/messaging_api/model/sender.rb @@ -16,6 +16,8 @@ class Sender attr_accessor :name # Display name. Certain words such as `LINE` may not be used. attr_accessor :icon_url # URL of the image to display as an icon when sending a message + # @param name [String] Display name. Certain words such as `LINE` may not be used. + # @param icon_url [String] URL of the image to display as an icon when sending a message def initialize( name: nil, icon_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/sent_message.rb b/lib/line/bot/v2/messaging_api/model/sent_message.rb index 56c5b020..ce16df5f 100644 --- a/lib/line/bot/v2/messaging_api/model/sent_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sent_message.rb @@ -15,6 +15,8 @@ class SentMessage attr_accessor :id # ID of the sent message. attr_accessor :quote_token # Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. + # @param id [String] ID of the sent message. + # @param quote_token [String] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. def initialize( id:, quote_token: nil, diff --git a/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb index 4ba21340..28541ba0 100644 --- a/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb +++ b/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb @@ -15,6 +15,7 @@ module MessagingApi class SetWebhookEndpointRequest attr_accessor :endpoint # A valid webhook URL. + # @param endpoint [String] A valid webhook URL. def initialize( endpoint:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb index c67165c5..5c67e04b 100644 --- a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb +++ b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb @@ -16,6 +16,8 @@ class ShowLoadingAnimationRequest attr_accessor :chat_id # User ID of the target user for whom the loading animation is to be displayed. attr_accessor :loading_seconds # The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. + # @param chat_id [String] User ID of the target user for whom the loading animation is to be displayed. + # @param loading_seconds [Integer] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. def initialize( chat_id:, loading_seconds: nil, diff --git a/lib/line/bot/v2/messaging_api/model/sticker_message.rb b/lib/line/bot/v2/messaging_api/model/sticker_message.rb index a5f70d48..3084b15e 100644 --- a/lib/line/bot/v2/messaging_api/model/sticker_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sticker_message.rb @@ -22,6 +22,11 @@ class StickerMessage < Message attr_accessor :sticker_id attr_accessor :quote_token # Quote token of the message you want to quote. + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param package_id [String] + # @param sticker_id [String] + # @param quote_token [String] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb b/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb index c98574a4..068111c7 100644 --- a/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb +++ b/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb @@ -20,6 +20,12 @@ class SubscribedMembershipPlan attr_accessor :price # Monthly fee for membership plan. (e.g. 1500.00) attr_accessor :currency # The currency of membership.price. + # @param membership_id [Integer] Membership plan ID. + # @param title [String] Membership plan name. + # @param description [String] Membership plan description. + # @param benefits [Array[String]] List of membership plan perks. + # @param price [Float] Monthly fee for membership plan. (e.g. 1500.00) + # @param currency [String] ('JPY'|'TWD'|'THB') The currency of membership.price. def initialize( membership_id:, title:, diff --git a/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb b/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb index 5e3364f0..39736e3f 100644 --- a/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb +++ b/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb @@ -18,6 +18,10 @@ class SubscribedMembershipUser attr_accessor :next_billing_date # Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 attr_accessor :total_subscription_months # The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted. + # @param membership_no [Integer] The user's member number in the membership plan. + # @param joined_time [Integer] UNIX timestamp at which the user subscribed to the membership. + # @param next_billing_date [String] Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 + # @param total_subscription_months [Integer] The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted. def initialize( membership_no:, joined_time:, diff --git a/lib/line/bot/v2/messaging_api/model/subscription.rb b/lib/line/bot/v2/messaging_api/model/subscription.rb index ec588c74..19c1136d 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription.rb @@ -16,6 +16,8 @@ class Subscription attr_accessor :membership attr_accessor :user + # @param membership [SubscribedMembershipPlan] + # @param user [SubscribedMembershipUser] def initialize( membership:, user:, diff --git a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb index bab5e541..f7309e36 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb @@ -18,6 +18,8 @@ class SubscriptionPeriodDemographicFilter < DemographicFilter attr_accessor :gte attr_accessor :lt + # @param gte [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') + # @param lt [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') def initialize( gte: nil, lt: nil, diff --git a/lib/line/bot/v2/messaging_api/model/substitution_object.rb b/lib/line/bot/v2/messaging_api/model/substitution_object.rb index 1d7eb0fa..f6f395a8 100644 --- a/lib/line/bot/v2/messaging_api/model/substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/substitution_object.rb @@ -15,6 +15,7 @@ module MessagingApi class SubstitutionObject attr_accessor :type # Type of substitution object + # @param type [String] Type of substitution object def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/template.rb b/lib/line/bot/v2/messaging_api/model/template.rb index 4234a160..1be3abc5 100644 --- a/lib/line/bot/v2/messaging_api/model/template.rb +++ b/lib/line/bot/v2/messaging_api/model/template.rb @@ -14,6 +14,7 @@ module MessagingApi class Template attr_accessor :type + # @param type [String] def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/template_message.rb b/lib/line/bot/v2/messaging_api/model/template_message.rb index 30ef298b..54fa3117 100644 --- a/lib/line/bot/v2/messaging_api/model/template_message.rb +++ b/lib/line/bot/v2/messaging_api/model/template_message.rb @@ -21,6 +21,10 @@ class TemplateMessage < Message attr_accessor :alt_text attr_accessor :template + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param alt_text [String] + # @param template [Template] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb index 925012c4..c33cedbe 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb @@ -15,6 +15,7 @@ module MessagingApi class TestWebhookEndpointRequest attr_accessor :endpoint # A webhook URL to be validated. + # @param endpoint [String] A webhook URL to be validated. def initialize( endpoint: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb index ec390985..73f3583f 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb @@ -19,6 +19,11 @@ class TestWebhookEndpointResponse attr_accessor :reason # Reason for the response. attr_accessor :detail # Details of the response. + # @param success [Boolean] Result of the communication from the LINE platform to the webhook URL. + # @param timestamp [String] Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. + # @param status_code [Integer] The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. + # @param reason [String] Reason for the response. + # @param detail [String] Details of the response. def initialize( success: nil, timestamp:, diff --git a/lib/line/bot/v2/messaging_api/model/text_message.rb b/lib/line/bot/v2/messaging_api/model/text_message.rb index e834b037..aa8019c1 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message.rb @@ -22,6 +22,11 @@ class TextMessage < Message attr_accessor :emojis attr_accessor :quote_token # Quote token of the message you want to quote. + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param text [String] + # @param emojis [Array[Emoji]] + # @param quote_token [String] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb index 18a4d2f9..854d08d6 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb @@ -22,6 +22,11 @@ class TextMessageV2 < Message attr_accessor :substitution # A mapping that specifies substitutions for parts enclosed in {} within the `text` field. attr_accessor :quote_token # Quote token of the message you want to quote. + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param text [String] + # @param substitution [Object] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. + # @param quote_token [String] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb b/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb index fe774c32..59aa0308 100644 --- a/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb +++ b/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb @@ -15,6 +15,7 @@ module MessagingApi class UpdateRichMenuAliasRequest attr_accessor :rich_menu_id # The rich menu ID to be associated with the rich menu alias. + # @param rich_menu_id [String] The rich menu ID to be associated with the rich menu alias. def initialize( rich_menu_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/uri_action.rb b/lib/line/bot/v2/messaging_api/model/uri_action.rb index 26125f0c..cf770212 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_action.rb @@ -19,6 +19,9 @@ class URIAction < Action attr_accessor :uri attr_accessor :alt_uri + # @param label [String] Label for the action. + # @param uri [String] + # @param alt_uri [AltUri] def initialize( label: nil, uri: nil, diff --git a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb index 82fbe760..7632e6f2 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb @@ -19,6 +19,9 @@ class URIImagemapAction < ImagemapAction attr_accessor :link_uri attr_accessor :label + # @param area [ImagemapArea] + # @param link_uri [String] + # @param label [String] def initialize( area:, link_uri:, diff --git a/lib/line/bot/v2/messaging_api/model/user_mention_target.rb b/lib/line/bot/v2/messaging_api/model/user_mention_target.rb index 4494aaab..d04c65c5 100644 --- a/lib/line/bot/v2/messaging_api/model/user_mention_target.rb +++ b/lib/line/bot/v2/messaging_api/model/user_mention_target.rb @@ -18,6 +18,7 @@ class UserMentionTarget < MentionTarget attr_reader :type # Target to be mentioned attr_accessor :user_id + # @param user_id [String] def initialize( user_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb index 52ee06d9..7657ee57 100644 --- a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb @@ -19,6 +19,11 @@ class UserProfileResponse attr_accessor :status_message # User's status message. Not included in the response if the user doesn't have a status message. attr_accessor :language # User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. + # @param display_name [String] User's display name + # @param user_id [String] User ID + # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param status_message [String] User's status message. Not included in the response if the user doesn't have a status message. + # @param language [String] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/validate_message_request.rb b/lib/line/bot/v2/messaging_api/model/validate_message_request.rb index bc50dce8..4a844fb1 100644 --- a/lib/line/bot/v2/messaging_api/model/validate_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/validate_message_request.rb @@ -14,6 +14,7 @@ module MessagingApi class ValidateMessageRequest attr_accessor :messages # Array of message objects to validate + # @param messages [Array[Message]] Array of message objects to validate def initialize( messages:, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/video_message.rb b/lib/line/bot/v2/messaging_api/model/video_message.rb index 83edd0dd..431c1d6f 100644 --- a/lib/line/bot/v2/messaging_api/model/video_message.rb +++ b/lib/line/bot/v2/messaging_api/model/video_message.rb @@ -22,6 +22,11 @@ class VideoMessage < Message attr_accessor :preview_image_url attr_accessor :tracking_id + # @param quick_reply [QuickReply] + # @param sender [Sender] + # @param original_content_url [String] + # @param preview_image_url [String] + # @param tracking_id [String] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb index d8238e2a..7eb1dd70 100644 --- a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb +++ b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb @@ -17,6 +17,8 @@ class AcquireChatControlRequest attr_accessor :expired # `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. attr_accessor :ttl # The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. + # @param expired [Boolean] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. + # @param ttl [Integer] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. def initialize( expired: nil, ttl: nil, diff --git a/lib/line/bot/v2/module/model/detach_module_request.rb b/lib/line/bot/v2/module/model/detach_module_request.rb index da22e9a4..41c334a5 100644 --- a/lib/line/bot/v2/module/model/detach_module_request.rb +++ b/lib/line/bot/v2/module/model/detach_module_request.rb @@ -16,6 +16,7 @@ module Module class DetachModuleRequest attr_accessor :bot_id # User ID of the LINE Official Account bot attached to the module channel. + # @param bot_id [String] User ID of the LINE Official Account bot attached to the module channel. def initialize( bot_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/module/model/get_modules_response.rb b/lib/line/bot/v2/module/model/get_modules_response.rb index 128e1a92..8ad35157 100644 --- a/lib/line/bot/v2/module/model/get_modules_response.rb +++ b/lib/line/bot/v2/module/model/get_modules_response.rb @@ -17,6 +17,8 @@ class GetModulesResponse attr_accessor :bots # Array of Bot list Item objects representing basic information about the bot. attr_accessor :_next # Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. + # @param bots [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot. + # @param _next [String] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. def initialize( bots:, _next: nil, diff --git a/lib/line/bot/v2/module/model/module_bot.rb b/lib/line/bot/v2/module/model/module_bot.rb index e05620d6..4c52024a 100644 --- a/lib/line/bot/v2/module/model/module_bot.rb +++ b/lib/line/bot/v2/module/model/module_bot.rb @@ -20,6 +20,11 @@ class ModuleBot attr_accessor :display_name # Bot's display name attr_accessor :picture_url # Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. + # @param user_id [String] Bot's user ID + # @param basic_id [String] Bot's basic ID + # @param premium_id [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @param display_name [String] Bot's display name + # @param picture_url [String] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. def initialize( user_id:, basic_id:, diff --git a/lib/line/bot/v2/module_attach/model/attach_module_response.rb b/lib/line/bot/v2/module_attach/model/attach_module_response.rb index 8b33840f..73a42b16 100644 --- a/lib/line/bot/v2/module_attach/model/attach_module_response.rb +++ b/lib/line/bot/v2/module_attach/model/attach_module_response.rb @@ -16,6 +16,8 @@ class AttachModuleResponse attr_accessor :bot_id # User ID of the bot on the LINE Official Account. attr_accessor :scopes # Permissions (scope) granted by the LINE Official Account admin. + # @param bot_id [String] User ID of the bot on the LINE Official Account. + # @param scopes [Array[String]] Permissions (scope) granted by the LINE Official Account admin. def initialize( bot_id:, scopes:, diff --git a/lib/line/bot/v2/shop/model/error_response.rb b/lib/line/bot/v2/shop/model/error_response.rb index feeb3d8f..0eacb769 100644 --- a/lib/line/bot/v2/shop/model/error_response.rb +++ b/lib/line/bot/v2/shop/model/error_response.rb @@ -15,6 +15,7 @@ module Shop class ErrorResponse attr_accessor :message # Message containing information about the error. + # @param message [String] Message containing information about the error. def initialize( message:, **dynamic_attributes diff --git a/lib/line/bot/v2/shop/model/mission_sticker_request.rb b/lib/line/bot/v2/shop/model/mission_sticker_request.rb index 4cfd4231..a91811b5 100644 --- a/lib/line/bot/v2/shop/model/mission_sticker_request.rb +++ b/lib/line/bot/v2/shop/model/mission_sticker_request.rb @@ -19,6 +19,10 @@ class MissionStickerRequest attr_accessor :product_type # `STICKER` attr_accessor :send_present_message # `false` + # @param to [String] Destination user ID + # @param product_id [String] Package ID for a set of stickers + # @param product_type [String] `STICKER` + # @param send_present_message [Boolean] `false` def initialize( to:, product_id:, diff --git a/lib/line/bot/v2/webhook/model/account_link_event.rb b/lib/line/bot/v2/webhook/model/account_link_event.rb index 2796578e..e8a62b75 100644 --- a/lib/line/bot/v2/webhook/model/account_link_event.rb +++ b/lib/line/bot/v2/webhook/model/account_link_event.rb @@ -24,6 +24,13 @@ class AccountLinkEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event. This property won't be included if linking the account has failed. attr_accessor :link + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. + # @param link [LinkContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/action_result.rb b/lib/line/bot/v2/webhook/model/action_result.rb index 76517604..02150241 100644 --- a/lib/line/bot/v2/webhook/model/action_result.rb +++ b/lib/line/bot/v2/webhook/model/action_result.rb @@ -15,6 +15,8 @@ class ActionResult attr_accessor :type attr_accessor :data # Base64-encoded binary data + # @param type [String] ('void'|'binary') + # @param data [String] Base64-encoded binary data def initialize( type:, data: nil, diff --git a/lib/line/bot/v2/webhook/model/activated_event.rb b/lib/line/bot/v2/webhook/model/activated_event.rb index 5731d409..18c5bbb5 100644 --- a/lib/line/bot/v2/webhook/model/activated_event.rb +++ b/lib/line/bot/v2/webhook/model/activated_event.rb @@ -23,6 +23,12 @@ class ActivatedEvent < Event attr_accessor :delivery_context attr_accessor :chat_control + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param chat_control [ChatControl] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/all_mentionee.rb b/lib/line/bot/v2/webhook/model/all_mentionee.rb index 5a461f8e..75d6ae77 100644 --- a/lib/line/bot/v2/webhook/model/all_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/all_mentionee.rb @@ -19,6 +19,8 @@ class AllMentionee < Mentionee attr_accessor :index # Index position of the user mention for a character in text, with the first character being at position 0. attr_accessor :length # The length of the text of the mentioned user. For a mention @example, 8 is the length. + # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. def initialize( index:, length:, diff --git a/lib/line/bot/v2/webhook/model/attached_module_content.rb b/lib/line/bot/v2/webhook/model/attached_module_content.rb index fc5021fc..8721a4a5 100644 --- a/lib/line/bot/v2/webhook/model/attached_module_content.rb +++ b/lib/line/bot/v2/webhook/model/attached_module_content.rb @@ -18,6 +18,8 @@ class AttachedModuleContent < ModuleContent attr_accessor :bot_id # User ID of the bot on the attached LINE Official Account attr_accessor :scopes # An array of strings indicating the scope permitted by the admin of the LINE Official Account. + # @param bot_id [String] User ID of the bot on the attached LINE Official Account + # @param scopes [Array[String]] An array of strings indicating the scope permitted by the admin of the LINE Official Account. def initialize( bot_id:, scopes:, diff --git a/lib/line/bot/v2/webhook/model/audio_message_content.rb b/lib/line/bot/v2/webhook/model/audio_message_content.rb index 8675cd39..c5962726 100644 --- a/lib/line/bot/v2/webhook/model/audio_message_content.rb +++ b/lib/line/bot/v2/webhook/model/audio_message_content.rb @@ -19,6 +19,9 @@ class AudioMessageContent < MessageContent attr_accessor :content_provider attr_accessor :duration # Length of audio file (milliseconds) + # @param id [String] Message ID + # @param content_provider [ContentProvider] + # @param duration [Integer] Length of audio file (milliseconds) def initialize( id:, content_provider:, diff --git a/lib/line/bot/v2/webhook/model/beacon_content.rb b/lib/line/bot/v2/webhook/model/beacon_content.rb index a6fe73d2..5788d554 100644 --- a/lib/line/bot/v2/webhook/model/beacon_content.rb +++ b/lib/line/bot/v2/webhook/model/beacon_content.rb @@ -16,6 +16,9 @@ class BeaconContent attr_accessor :type # Type of beacon event. attr_accessor :dm # Device message of beacon that was detected. + # @param hwid [String] Hardware ID of the beacon that was detected + # @param type [String] ('enter'|'banner'|'stay') Type of beacon event. + # @param dm [String] Device message of beacon that was detected. def initialize( hwid:, type:, diff --git a/lib/line/bot/v2/webhook/model/beacon_event.rb b/lib/line/bot/v2/webhook/model/beacon_event.rb index aeac6b45..81a102ee 100644 --- a/lib/line/bot/v2/webhook/model/beacon_event.rb +++ b/lib/line/bot/v2/webhook/model/beacon_event.rb @@ -24,6 +24,13 @@ class BeaconEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :beacon + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param beacon [BeaconContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb index cb820c98..f39ff133 100644 --- a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb @@ -22,6 +22,11 @@ class BotResumedEvent < Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb index 462d6005..4bc4755a 100644 --- a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb @@ -22,6 +22,11 @@ class BotSuspendedEvent < Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/callback_request.rb b/lib/line/bot/v2/webhook/model/callback_request.rb index d0d4975f..8e8f3144 100644 --- a/lib/line/bot/v2/webhook/model/callback_request.rb +++ b/lib/line/bot/v2/webhook/model/callback_request.rb @@ -17,6 +17,8 @@ class CallbackRequest attr_accessor :destination # User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`. attr_accessor :events # Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. + # @param destination [String] User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`. + # @param events [Array[Event]] Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. def initialize( destination:, events:, diff --git a/lib/line/bot/v2/webhook/model/chat_control.rb b/lib/line/bot/v2/webhook/model/chat_control.rb index 2e3e4374..955ef0ab 100644 --- a/lib/line/bot/v2/webhook/model/chat_control.rb +++ b/lib/line/bot/v2/webhook/model/chat_control.rb @@ -14,6 +14,7 @@ module Webhook class ChatControl attr_accessor :expire_at + # @param expire_at [Integer] def initialize( expire_at:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/content_provider.rb b/lib/line/bot/v2/webhook/model/content_provider.rb index b7634b44..85dc9932 100644 --- a/lib/line/bot/v2/webhook/model/content_provider.rb +++ b/lib/line/bot/v2/webhook/model/content_provider.rb @@ -17,6 +17,9 @@ class ContentProvider attr_accessor :original_content_url # URL of the image file. Only included when contentProvider.type is external. attr_accessor :preview_image_url # URL of the preview image. Only included when contentProvider.type is external. + # @param type [String] ('line'|'external') Provider of the image file. + # @param original_content_url [String] URL of the image file. Only included when contentProvider.type is external. + # @param preview_image_url [String] URL of the preview image. Only included when contentProvider.type is external. def initialize( type:, original_content_url: nil, diff --git a/lib/line/bot/v2/webhook/model/deactivated_event.rb b/lib/line/bot/v2/webhook/model/deactivated_event.rb index 5f30ccb3..565d3024 100644 --- a/lib/line/bot/v2/webhook/model/deactivated_event.rb +++ b/lib/line/bot/v2/webhook/model/deactivated_event.rb @@ -22,6 +22,11 @@ class DeactivatedEvent < Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/delivery_context.rb b/lib/line/bot/v2/webhook/model/delivery_context.rb index db82b180..794e082f 100644 --- a/lib/line/bot/v2/webhook/model/delivery_context.rb +++ b/lib/line/bot/v2/webhook/model/delivery_context.rb @@ -15,6 +15,7 @@ module Webhook class DeliveryContext attr_accessor :is_redelivery # Whether the webhook event is a redelivered one or not. + # @param is_redelivery [Boolean] Whether the webhook event is a redelivered one or not. def initialize( is_redelivery:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/detached_module_content.rb b/lib/line/bot/v2/webhook/model/detached_module_content.rb index 6c5aca8a..dc749589 100644 --- a/lib/line/bot/v2/webhook/model/detached_module_content.rb +++ b/lib/line/bot/v2/webhook/model/detached_module_content.rb @@ -18,6 +18,8 @@ class DetachedModuleContent < ModuleContent attr_accessor :bot_id # Detached LINE Official Account bot user ID attr_accessor :reason # Reason for detaching + # @param bot_id [String] Detached LINE Official Account bot user ID + # @param reason [String] ('bot_deleted') Reason for detaching def initialize( bot_id:, reason:, diff --git a/lib/line/bot/v2/webhook/model/emoji.rb b/lib/line/bot/v2/webhook/model/emoji.rb index c70461b8..f6098275 100644 --- a/lib/line/bot/v2/webhook/model/emoji.rb +++ b/lib/line/bot/v2/webhook/model/emoji.rb @@ -17,6 +17,10 @@ class Emoji attr_accessor :product_id # Product ID for a LINE emoji set. attr_accessor :emoji_id # ID for a LINE emoji inside a set. + # @param index [Integer] Index position for a character in text, with the first character being at position 0. + # @param length [Integer] The length of the LINE emoji string. For LINE emoji (hello), 7 is the length. + # @param product_id [String] Product ID for a LINE emoji set. + # @param emoji_id [String] ID for a LINE emoji inside a set. def initialize( index:, length:, diff --git a/lib/line/bot/v2/webhook/model/event.rb b/lib/line/bot/v2/webhook/model/event.rb index c1f921f0..e2faeef2 100644 --- a/lib/line/bot/v2/webhook/model/event.rb +++ b/lib/line/bot/v2/webhook/model/event.rb @@ -20,6 +20,12 @@ class Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param type [String] Type of the event + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( type:, source: nil, diff --git a/lib/line/bot/v2/webhook/model/file_message_content.rb b/lib/line/bot/v2/webhook/model/file_message_content.rb index e4e2e4a9..6909d919 100644 --- a/lib/line/bot/v2/webhook/model/file_message_content.rb +++ b/lib/line/bot/v2/webhook/model/file_message_content.rb @@ -19,6 +19,9 @@ class FileMessageContent < MessageContent attr_accessor :file_name # File name attr_accessor :file_size # File size in bytes + # @param id [String] Message ID + # @param file_name [String] File name + # @param file_size [Integer] File size in bytes def initialize( id:, file_name:, diff --git a/lib/line/bot/v2/webhook/model/follow_detail.rb b/lib/line/bot/v2/webhook/model/follow_detail.rb index 5de55ee5..f514d6d1 100644 --- a/lib/line/bot/v2/webhook/model/follow_detail.rb +++ b/lib/line/bot/v2/webhook/model/follow_detail.rb @@ -14,6 +14,7 @@ module Webhook class FollowDetail attr_accessor :is_unblocked # Whether a user has added your LINE Official Account as a friend or unblocked. + # @param is_unblocked [Boolean] Whether a user has added your LINE Official Account as a friend or unblocked. def initialize( is_unblocked:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/follow_event.rb b/lib/line/bot/v2/webhook/model/follow_event.rb index c495d182..7312092c 100644 --- a/lib/line/bot/v2/webhook/model/follow_event.rb +++ b/lib/line/bot/v2/webhook/model/follow_event.rb @@ -24,6 +24,13 @@ class FollowEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :follow + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param follow [FollowDetail] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/group_source.rb b/lib/line/bot/v2/webhook/model/group_source.rb index 4958c9bf..7212bbba 100644 --- a/lib/line/bot/v2/webhook/model/group_source.rb +++ b/lib/line/bot/v2/webhook/model/group_source.rb @@ -18,6 +18,8 @@ class GroupSource < Source attr_accessor :group_id # Group ID of the source group chat attr_accessor :user_id # ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @param group_id [String] Group ID of the source group chat + # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. def initialize( group_id:, user_id: nil, diff --git a/lib/line/bot/v2/webhook/model/image_message_content.rb b/lib/line/bot/v2/webhook/model/image_message_content.rb index 30f4f76b..9007f723 100644 --- a/lib/line/bot/v2/webhook/model/image_message_content.rb +++ b/lib/line/bot/v2/webhook/model/image_message_content.rb @@ -20,6 +20,10 @@ class ImageMessageContent < MessageContent attr_accessor :image_set attr_accessor :quote_token # Quote token to quote this message. + # @param id [String] Message ID + # @param content_provider [ContentProvider] + # @param image_set [ImageSet] + # @param quote_token [String] Quote token to quote this message. def initialize( id:, content_provider:, diff --git a/lib/line/bot/v2/webhook/model/image_set.rb b/lib/line/bot/v2/webhook/model/image_set.rb index 0631201a..752729e8 100644 --- a/lib/line/bot/v2/webhook/model/image_set.rb +++ b/lib/line/bot/v2/webhook/model/image_set.rb @@ -16,6 +16,9 @@ class ImageSet attr_accessor :index # An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. attr_accessor :total # The total number of images sent simultaneously. + # @param id [String] Image set ID. Only included when multiple images are sent simultaneously. + # @param index [Integer] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. + # @param total [Integer] The total number of images sent simultaneously. def initialize( id:, index: nil, diff --git a/lib/line/bot/v2/webhook/model/join_event.rb b/lib/line/bot/v2/webhook/model/join_event.rb index f958fb37..6aba00ec 100644 --- a/lib/line/bot/v2/webhook/model/join_event.rb +++ b/lib/line/bot/v2/webhook/model/join_event.rb @@ -23,6 +23,12 @@ class JoinEvent < Event attr_accessor :delivery_context attr_accessor :reply_token # Reply token used to send reply message to this event + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/joined_members.rb b/lib/line/bot/v2/webhook/model/joined_members.rb index f498858f..20f67215 100644 --- a/lib/line/bot/v2/webhook/model/joined_members.rb +++ b/lib/line/bot/v2/webhook/model/joined_members.rb @@ -14,6 +14,7 @@ module Webhook class JoinedMembers attr_accessor :members # Users who joined. Array of source user objects. + # @param members [Array[UserSource]] Users who joined. Array of source user objects. def initialize( members:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/joined_membership_content.rb b/lib/line/bot/v2/webhook/model/joined_membership_content.rb index 0a53bb3e..304e8f97 100644 --- a/lib/line/bot/v2/webhook/model/joined_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/joined_membership_content.rb @@ -17,6 +17,7 @@ class JoinedMembershipContent < MembershipContent attr_reader :type # Type of membership event. attr_accessor :membership_id # The ID of the membership that the user joined. This is defined for each membership. + # @param membership_id [Integer] The ID of the membership that the user joined. This is defined for each membership. def initialize( membership_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/leave_event.rb b/lib/line/bot/v2/webhook/model/leave_event.rb index 273dcd34..f71fc41d 100644 --- a/lib/line/bot/v2/webhook/model/leave_event.rb +++ b/lib/line/bot/v2/webhook/model/leave_event.rb @@ -22,6 +22,11 @@ class LeaveEvent < Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/left_members.rb b/lib/line/bot/v2/webhook/model/left_members.rb index 51e35c1c..a91ed938 100644 --- a/lib/line/bot/v2/webhook/model/left_members.rb +++ b/lib/line/bot/v2/webhook/model/left_members.rb @@ -14,6 +14,7 @@ module Webhook class LeftMembers attr_accessor :members # Users who left. Array of source user objects. + # @param members [Array[UserSource]] Users who left. Array of source user objects. def initialize( members:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/left_membership_content.rb b/lib/line/bot/v2/webhook/model/left_membership_content.rb index 10a680a9..736318dc 100644 --- a/lib/line/bot/v2/webhook/model/left_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/left_membership_content.rb @@ -17,6 +17,7 @@ class LeftMembershipContent < MembershipContent attr_reader :type # Type of membership event. attr_accessor :membership_id # The ID of the membership that the user left. This is defined for each membership. + # @param membership_id [Integer] The ID of the membership that the user left. This is defined for each membership. def initialize( membership_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/link_content.rb b/lib/line/bot/v2/webhook/model/link_content.rb index 2ca4dea1..c622fa80 100644 --- a/lib/line/bot/v2/webhook/model/link_content.rb +++ b/lib/line/bot/v2/webhook/model/link_content.rb @@ -16,6 +16,8 @@ class LinkContent attr_accessor :result # One of the following values to indicate whether linking the account was successful or not attr_accessor :nonce # Specified nonce (number used once) when verifying the user ID. + # @param result [String] ('ok'|'failed') One of the following values to indicate whether linking the account was successful or not + # @param nonce [String] Specified nonce (number used once) when verifying the user ID. def initialize( result:, nonce:, diff --git a/lib/line/bot/v2/webhook/model/link_things_content.rb b/lib/line/bot/v2/webhook/model/link_things_content.rb index 39df1906..a6561bfd 100644 --- a/lib/line/bot/v2/webhook/model/link_things_content.rb +++ b/lib/line/bot/v2/webhook/model/link_things_content.rb @@ -17,6 +17,7 @@ class LinkThingsContent < ThingsContent attr_reader :type # Type attr_accessor :device_id # Device ID of the device that has been linked with LINE. + # @param device_id [String] Device ID of the device that has been linked with LINE. def initialize( device_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/location_message_content.rb b/lib/line/bot/v2/webhook/model/location_message_content.rb index c0dd1dcc..24c94505 100644 --- a/lib/line/bot/v2/webhook/model/location_message_content.rb +++ b/lib/line/bot/v2/webhook/model/location_message_content.rb @@ -21,6 +21,11 @@ class LocationMessageContent < MessageContent attr_accessor :latitude # Latitude attr_accessor :longitude # Longitude + # @param id [String] Message ID + # @param title [String] Title + # @param address [String] Address + # @param latitude [Float] Latitude + # @param longitude [Float] Longitude def initialize( id:, title: nil, diff --git a/lib/line/bot/v2/webhook/model/member_joined_event.rb b/lib/line/bot/v2/webhook/model/member_joined_event.rb index cf3545c9..df83b1b3 100644 --- a/lib/line/bot/v2/webhook/model/member_joined_event.rb +++ b/lib/line/bot/v2/webhook/model/member_joined_event.rb @@ -24,6 +24,13 @@ class MemberJoinedEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :joined + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param joined [JoinedMembers] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/member_left_event.rb b/lib/line/bot/v2/webhook/model/member_left_event.rb index 16382b06..a6c6f6d7 100644 --- a/lib/line/bot/v2/webhook/model/member_left_event.rb +++ b/lib/line/bot/v2/webhook/model/member_left_event.rb @@ -23,6 +23,12 @@ class MemberLeftEvent < Event attr_accessor :delivery_context attr_accessor :left + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param left [LeftMembers] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/membership_content.rb b/lib/line/bot/v2/webhook/model/membership_content.rb index f638a1f6..c35e20ca 100644 --- a/lib/line/bot/v2/webhook/model/membership_content.rb +++ b/lib/line/bot/v2/webhook/model/membership_content.rb @@ -15,6 +15,7 @@ module Webhook class MembershipContent attr_accessor :type # Type of membership event. + # @param type [String] Type of membership event. def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/membership_event.rb b/lib/line/bot/v2/webhook/model/membership_event.rb index 39c2df49..84fc7815 100644 --- a/lib/line/bot/v2/webhook/model/membership_event.rb +++ b/lib/line/bot/v2/webhook/model/membership_event.rb @@ -24,6 +24,13 @@ class MembershipEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :membership + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param membership [MembershipContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/mention.rb b/lib/line/bot/v2/webhook/model/mention.rb index 5328b164..da0a4be3 100644 --- a/lib/line/bot/v2/webhook/model/mention.rb +++ b/lib/line/bot/v2/webhook/model/mention.rb @@ -14,6 +14,7 @@ module Webhook class Mention attr_accessor :mentionees # Array of one or more mention objects. Max: 20 mentions + # @param mentionees [Array[Mentionee]] Array of one or more mention objects. Max: 20 mentions def initialize( mentionees:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/mentionee.rb b/lib/line/bot/v2/webhook/model/mentionee.rb index a11b0aaf..90311903 100644 --- a/lib/line/bot/v2/webhook/model/mentionee.rb +++ b/lib/line/bot/v2/webhook/model/mentionee.rb @@ -17,6 +17,9 @@ class Mentionee attr_accessor :index # Index position of the user mention for a character in text, with the first character being at position 0. attr_accessor :length # The length of the text of the mentioned user. For a mention @example, 8 is the length. + # @param type [String] Mentioned target. + # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. def initialize( type:, index:, diff --git a/lib/line/bot/v2/webhook/model/message_content.rb b/lib/line/bot/v2/webhook/model/message_content.rb index ba0f05be..6f026647 100644 --- a/lib/line/bot/v2/webhook/model/message_content.rb +++ b/lib/line/bot/v2/webhook/model/message_content.rb @@ -16,6 +16,8 @@ class MessageContent attr_accessor :type # Type attr_accessor :id # Message ID + # @param type [String] Type + # @param id [String] Message ID def initialize( type:, id:, diff --git a/lib/line/bot/v2/webhook/model/message_event.rb b/lib/line/bot/v2/webhook/model/message_event.rb index a37593db..6107351b 100644 --- a/lib/line/bot/v2/webhook/model/message_event.rb +++ b/lib/line/bot/v2/webhook/model/message_event.rb @@ -24,6 +24,13 @@ class MessageEvent < Event attr_accessor :reply_token attr_accessor :message + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] + # @param message [MessageContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/module_content.rb b/lib/line/bot/v2/webhook/model/module_content.rb index c939e3c1..984be394 100644 --- a/lib/line/bot/v2/webhook/model/module_content.rb +++ b/lib/line/bot/v2/webhook/model/module_content.rb @@ -14,6 +14,7 @@ module Webhook class ModuleContent attr_accessor :type # Type + # @param type [String] Type def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/module_event.rb b/lib/line/bot/v2/webhook/model/module_event.rb index b050ca71..ffbf164d 100644 --- a/lib/line/bot/v2/webhook/model/module_event.rb +++ b/lib/line/bot/v2/webhook/model/module_event.rb @@ -23,6 +23,12 @@ class ModuleEvent < Event attr_accessor :delivery_context attr_accessor :_module + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param _module [ModuleContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/pnp_delivery.rb b/lib/line/bot/v2/webhook/model/pnp_delivery.rb index 43c09d9d..1c9ff825 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery.rb @@ -15,6 +15,7 @@ module Webhook class PnpDelivery attr_accessor :data # A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header + # @param data [String] A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header def initialize( data:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb index 10f74570..0565d631 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb @@ -23,6 +23,12 @@ class PnpDeliveryCompletionEvent < Event attr_accessor :delivery_context attr_accessor :delivery + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param delivery [PnpDelivery] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/postback_content.rb b/lib/line/bot/v2/webhook/model/postback_content.rb index daef42da..a9fbe465 100644 --- a/lib/line/bot/v2/webhook/model/postback_content.rb +++ b/lib/line/bot/v2/webhook/model/postback_content.rb @@ -15,6 +15,8 @@ class PostbackContent attr_accessor :data # Postback data attr_accessor :params + # @param data [String] Postback data + # @param params [Object] def initialize( data:, params: nil, diff --git a/lib/line/bot/v2/webhook/model/postback_event.rb b/lib/line/bot/v2/webhook/model/postback_event.rb index 369ca43b..ceba1157 100644 --- a/lib/line/bot/v2/webhook/model/postback_event.rb +++ b/lib/line/bot/v2/webhook/model/postback_event.rb @@ -24,6 +24,13 @@ class PostbackEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :postback + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param postback [PostbackContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/renewed_membership_content.rb b/lib/line/bot/v2/webhook/model/renewed_membership_content.rb index f2544e5c..6f183f04 100644 --- a/lib/line/bot/v2/webhook/model/renewed_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/renewed_membership_content.rb @@ -17,6 +17,7 @@ class RenewedMembershipContent < MembershipContent attr_reader :type # Type of membership event. attr_accessor :membership_id # The ID of the membership that the user renewed. This is defined for each membership. + # @param membership_id [Integer] The ID of the membership that the user renewed. This is defined for each membership. def initialize( membership_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/room_source.rb b/lib/line/bot/v2/webhook/model/room_source.rb index 3332a08f..4f8676e0 100644 --- a/lib/line/bot/v2/webhook/model/room_source.rb +++ b/lib/line/bot/v2/webhook/model/room_source.rb @@ -18,6 +18,8 @@ class RoomSource < Source attr_accessor :user_id # ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. attr_accessor :room_id # Room ID of the source multi-person chat + # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @param room_id [String] Room ID of the source multi-person chat def initialize( user_id: nil, room_id:, diff --git a/lib/line/bot/v2/webhook/model/scenario_result.rb b/lib/line/bot/v2/webhook/model/scenario_result.rb index c67161a8..803b1d1c 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result.rb @@ -22,6 +22,14 @@ class ScenarioResult attr_accessor :ble_notification_payload # Data contained in notification. attr_accessor :error_reason # Error reason. + # @param scenario_id [String] Scenario ID executed + # @param revision [Integer] Revision number of the scenario set containing the executed scenario + # @param start_time [Integer] Timestamp for when execution of scenario action started (milliseconds, LINE app time) + # @param end_time [Integer] Timestamp for when execution of scenario was completed (milliseconds, LINE app time) + # @param result_code [String] Scenario execution completion status + # @param action_results [Array[ActionResult]] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. + # @param ble_notification_payload [String] Data contained in notification. + # @param error_reason [String] Error reason. def initialize( scenario_id: nil, revision: nil, diff --git a/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb b/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb index 8f638020..fee3468d 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb @@ -18,6 +18,8 @@ class ScenarioResultThingsContent < ThingsContent attr_accessor :device_id # Device ID of the device that has been linked with LINE. attr_accessor :result + # @param device_id [String] Device ID of the device that has been linked with LINE. + # @param result [ScenarioResult] def initialize( device_id:, result:, diff --git a/lib/line/bot/v2/webhook/model/source.rb b/lib/line/bot/v2/webhook/model/source.rb index 1c11551c..62af0b74 100644 --- a/lib/line/bot/v2/webhook/model/source.rb +++ b/lib/line/bot/v2/webhook/model/source.rb @@ -16,6 +16,7 @@ module Webhook class Source attr_accessor :type # source type + # @param type [String] source type def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/sticker_message_content.rb b/lib/line/bot/v2/webhook/model/sticker_message_content.rb index 20fbcafc..97103adc 100644 --- a/lib/line/bot/v2/webhook/model/sticker_message_content.rb +++ b/lib/line/bot/v2/webhook/model/sticker_message_content.rb @@ -25,6 +25,14 @@ class StickerMessageContent < MessageContent attr_accessor :quote_token # Quote token to quote this message. attr_accessor :quoted_message_id # Message ID of a quoted message. Only included when the received message quotes a past message. + # @param id [String] Message ID + # @param package_id [String] Package ID + # @param sticker_id [String] Sticker ID + # @param sticker_resource_type [String] ('STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT') + # @param keywords [Array[String]] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. + # @param text [String] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 + # @param quote_token [String] Quote token to quote this message. + # @param quoted_message_id [String] Message ID of a quoted message. Only included when the received message quotes a past message. def initialize( id:, package_id:, diff --git a/lib/line/bot/v2/webhook/model/text_message_content.rb b/lib/line/bot/v2/webhook/model/text_message_content.rb index a937943e..aeae6677 100644 --- a/lib/line/bot/v2/webhook/model/text_message_content.rb +++ b/lib/line/bot/v2/webhook/model/text_message_content.rb @@ -22,6 +22,12 @@ class TextMessageContent < MessageContent attr_accessor :quote_token # Quote token to quote this message. attr_accessor :quoted_message_id # Message ID of a quoted message. Only included when the received message quotes a past message. + # @param id [String] Message ID + # @param text [String] Message text. + # @param emojis [Array[Emoji]] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. + # @param mention [Mention] + # @param quote_token [String] Quote token to quote this message. + # @param quoted_message_id [String] Message ID of a quoted message. Only included when the received message quotes a past message. def initialize( id:, text:, diff --git a/lib/line/bot/v2/webhook/model/things_content.rb b/lib/line/bot/v2/webhook/model/things_content.rb index 12ef8b4c..d5034101 100644 --- a/lib/line/bot/v2/webhook/model/things_content.rb +++ b/lib/line/bot/v2/webhook/model/things_content.rb @@ -14,6 +14,7 @@ module Webhook class ThingsContent attr_accessor :type # Type + # @param type [String] Type def initialize( type:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/things_event.rb b/lib/line/bot/v2/webhook/model/things_event.rb index 0fbdc9e5..e65b9c34 100644 --- a/lib/line/bot/v2/webhook/model/things_event.rb +++ b/lib/line/bot/v2/webhook/model/things_event.rb @@ -24,6 +24,13 @@ class ThingsEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :things + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param things [ThingsContent] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/unfollow_event.rb b/lib/line/bot/v2/webhook/model/unfollow_event.rb index 1e4ef1fb..116f8c3a 100644 --- a/lib/line/bot/v2/webhook/model/unfollow_event.rb +++ b/lib/line/bot/v2/webhook/model/unfollow_event.rb @@ -22,6 +22,11 @@ class UnfollowEvent < Event attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. attr_accessor :delivery_context + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/unlink_things_content.rb b/lib/line/bot/v2/webhook/model/unlink_things_content.rb index d6f8b2d0..872b65a0 100644 --- a/lib/line/bot/v2/webhook/model/unlink_things_content.rb +++ b/lib/line/bot/v2/webhook/model/unlink_things_content.rb @@ -17,6 +17,7 @@ class UnlinkThingsContent < ThingsContent attr_reader :type # Type attr_accessor :device_id # Device ID of the device that has been linked with LINE. + # @param device_id [String] Device ID of the device that has been linked with LINE. def initialize( device_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/unsend_detail.rb b/lib/line/bot/v2/webhook/model/unsend_detail.rb index d972fcd4..2310d4ed 100644 --- a/lib/line/bot/v2/webhook/model/unsend_detail.rb +++ b/lib/line/bot/v2/webhook/model/unsend_detail.rb @@ -14,6 +14,7 @@ module Webhook class UnsendDetail attr_accessor :message_id # The message ID of the unsent message + # @param message_id [String] The message ID of the unsent message def initialize( message_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/unsend_event.rb b/lib/line/bot/v2/webhook/model/unsend_event.rb index e2b0e4d1..b2765f32 100644 --- a/lib/line/bot/v2/webhook/model/unsend_event.rb +++ b/lib/line/bot/v2/webhook/model/unsend_event.rb @@ -23,6 +23,12 @@ class UnsendEvent < Event attr_accessor :delivery_context attr_accessor :unsend + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param unsend [UnsendDetail] def initialize( source: nil, timestamp:, diff --git a/lib/line/bot/v2/webhook/model/user_mentionee.rb b/lib/line/bot/v2/webhook/model/user_mentionee.rb index 0a424d12..c30f006b 100644 --- a/lib/line/bot/v2/webhook/model/user_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/user_mentionee.rb @@ -21,6 +21,10 @@ class UserMentionee < Mentionee attr_accessor :user_id # User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. attr_accessor :is_self # Whether the mentioned user is the bot that receives the webhook. + # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. + # @param user_id [String] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. + # @param is_self [Boolean] Whether the mentioned user is the bot that receives the webhook. def initialize( index:, length:, diff --git a/lib/line/bot/v2/webhook/model/user_source.rb b/lib/line/bot/v2/webhook/model/user_source.rb index b331f6f1..7c1fa840 100644 --- a/lib/line/bot/v2/webhook/model/user_source.rb +++ b/lib/line/bot/v2/webhook/model/user_source.rb @@ -17,6 +17,7 @@ class UserSource < Source attr_reader :type # source type attr_accessor :user_id # ID of the source user + # @param user_id [String] ID of the source user def initialize( user_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/video_message_content.rb b/lib/line/bot/v2/webhook/model/video_message_content.rb index a0e78088..8a4aa452 100644 --- a/lib/line/bot/v2/webhook/model/video_message_content.rb +++ b/lib/line/bot/v2/webhook/model/video_message_content.rb @@ -20,6 +20,10 @@ class VideoMessageContent < MessageContent attr_accessor :content_provider attr_accessor :quote_token # Quote token to quote this message. + # @param id [String] Message ID + # @param duration [Integer] Length of video file (milliseconds) + # @param content_provider [ContentProvider] + # @param quote_token [String] Quote token to quote this message. def initialize( id:, duration: nil, diff --git a/lib/line/bot/v2/webhook/model/video_play_complete.rb b/lib/line/bot/v2/webhook/model/video_play_complete.rb index d5f8ff86..ae5f7551 100644 --- a/lib/line/bot/v2/webhook/model/video_play_complete.rb +++ b/lib/line/bot/v2/webhook/model/video_play_complete.rb @@ -14,6 +14,7 @@ module Webhook class VideoPlayComplete attr_accessor :tracking_id # ID used to identify a video. Returns the same value as the trackingId assigned to the video message. + # @param tracking_id [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message. def initialize( tracking_id:, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb index 33d72ddd..374c8059 100644 --- a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb +++ b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb @@ -24,6 +24,13 @@ class VideoPlayCompleteEvent < Event attr_accessor :reply_token # Reply token used to send reply message to this event attr_accessor :video_play_complete + # @param source [Source] + # @param timestamp [Integer] Time of the event in milliseconds. + # @param mode [String] ('active'|'standby') + # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @param delivery_context [DeliveryContext] + # @param reply_token [String] Reply token used to send reply message to this event + # @param video_play_complete [VideoPlayComplete] def initialize( source: nil, timestamp:, From ecca24441045cb44e67d35a8c90d52d949815ba3 Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:34:18 +0900 Subject: [PATCH 3/6] NO-ISSUE template --- .../line-bot-sdk-ruby-generator/model.pebble | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble index 9d3ad0f3..dc014c5b 100644 --- a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble +++ b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble @@ -21,8 +21,26 @@ module Line # @see {{ model.model.externalDocumentation.url }} {% endif -%} class {{ model.model.classname }}{% if model.model.parent != null %} < {{ model.model.parent }}{% endif %} - {%- for property in model.model.vars %} - {% if model.model.vendorExtensions.get("x-selector").propertyName != property.name %}attr_accessor{% else %}attr_reader{% endif %} :{{ property.name }}{% if property.description != null %} # {{ property.description }}{% endif %} + {%- for variable in model.model.vars %} + # @!attribute [{% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name %}rw{% else %}r{% endif %}] {{ variable.name }} + {% if variable.openApiType == 'array' -%} + {% if variable.items.isModel -%} + # @return [{{ "Array[#{variable.items.openApiType}]" }}] {{ variable.description }} + {% elseif variable.items.allowableValues != null -%} + # @return [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor -%}]] {{ variable.description }} + {% else -%} + # @return [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}] {{ variable.description }} + {% endif -%} + {% elseif variable.isModel -%} + # @return [{{ variable.openApiType }}] {{ variable.description }} + {% else -%} + {% if variable.allowableValues != null -%} + # @return [String] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} + {% else -%} + # @return [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}] {{ variable.description }} + {% endif -%} + {% endif -%} + {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name %}attr_accessor{% else %}attr_reader{% endif %} :{{ variable.name }} {%- endfor %} {# @param #} From 26134f88d2e7c323303ec821c4142781b2fcb1bf Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:34:23 +0900 Subject: [PATCH 4/6] NO-ISSUE gen --- .../channel_access_token_key_ids_response.rb | 4 +- .../model/error_response.rb | 8 ++- .../issue_channel_access_token_response.rb | 16 +++-- ...ort_lived_channel_access_token_response.rb | 12 +++- ...stateless_channel_access_token_response.rb | 12 +++- .../verify_channel_access_token_response.rb | 12 +++- lib/line/bot/v2/insight/model/age_tile.rb | 8 ++- .../bot/v2/insight/model/app_type_tile.rb | 8 ++- lib/line/bot/v2/insight/model/area_tile.rb | 8 ++- lib/line/bot/v2/insight/model/error_detail.rb | 8 ++- .../bot/v2/insight/model/error_response.rb | 8 ++- lib/line/bot/v2/insight/model/gender_tile.rb | 8 ++- .../get_friends_demographics_response.rb | 24 +++++-- .../model/get_message_event_response.rb | 10 ++- .../model/get_message_event_response_click.rb | 20 ++++-- .../get_message_event_response_message.rb | 48 ++++++++++---- .../get_message_event_response_overview.rb | 28 ++++++-- .../model/get_number_of_followers_response.rb | 16 +++-- ...t_number_of_message_deliveries_response.rb | 44 +++++++++---- .../model/get_statistics_per_unit_response.rb | 10 ++- .../get_statistics_per_unit_response_click.rb | 20 ++++-- ...et_statistics_per_unit_response_message.rb | 52 +++++++++++---- ...t_statistics_per_unit_response_overview.rb | 16 +++-- .../insight/model/subscription_period_tile.rb | 8 ++- .../bot/v2/liff/model/add_liff_app_request.rb | 16 ++++- .../v2/liff/model/add_liff_app_response.rb | 2 + .../liff/model/get_all_liff_apps_response.rb | 2 + lib/line/bot/v2/liff/model/liff_app.rb | 20 +++++- lib/line/bot/v2/liff/model/liff_features.rb | 8 ++- lib/line/bot/v2/liff/model/liff_view.rb | 12 +++- .../v2/liff/model/update_liff_app_request.rb | 16 ++++- .../bot/v2/liff/model/update_liff_view.rb | 12 +++- .../bot/v2/manage_audience/model/adaccount.rb | 4 +- .../add_audience_to_audience_group_request.rb | 12 +++- .../bot/v2/manage_audience/model/audience.rb | 4 +- .../manage_audience/model/audience_group.rb | 38 +++++++++-- .../model/audience_group_job.rb | 26 ++++++-- .../model/create_audience_group_request.rb | 16 +++-- .../model/create_audience_group_response.rb | 30 +++++++-- ...eate_click_based_audience_group_request.rb | 12 +++- ...ate_click_based_audience_group_response.rb | 38 ++++++++--- ...create_imp_based_audience_group_request.rb | 8 ++- ...reate_imp_based_audience_group_response.rb | 18 ++++-- .../manage_audience/model/detailed_owner.rb | 12 +++- .../v2/manage_audience/model/error_detail.rb | 8 ++- .../manage_audience/model/error_response.rb | 8 ++- .../model/get_audience_data_response.rb | 8 ++- ...audience_group_authority_level_response.rb | 2 + .../model/get_audience_groups_response.rb | 24 +++++-- .../get_shared_audience_data_response.rb | 8 ++- .../get_shared_audience_groups_response.rb | 24 +++++-- ..._audience_group_authority_level_request.rb | 2 + ...date_audience_group_description_request.rb | 4 +- lib/line/bot/v2/messaging_api/model/action.rb | 8 ++- .../model/age_demographic_filter.rb | 8 ++- .../messaging_api/model/all_mention_target.rb | 4 +- .../bot/v2/messaging_api/model/alt_uri.rb | 2 + .../model/app_type_demographic_filter.rb | 6 +- .../model/area_demographic_filter.rb | 6 +- .../messaging_api/model/audience_recipient.rb | 6 +- .../v2/messaging_api/model/audio_message.rb | 12 +++- .../messaging_api/model/bot_info_response.rb | 28 ++++++-- .../messaging_api/model/broadcast_request.rb | 8 ++- .../messaging_api/model/buttons_template.rb | 18 ++++++ .../v2/messaging_api/model/camera_action.rb | 8 ++- .../messaging_api/model/camera_roll_action.rb | 8 ++- .../v2/messaging_api/model/carousel_column.rb | 12 ++++ .../messaging_api/model/carousel_template.rb | 8 +++ .../v2/messaging_api/model/chat_reference.rb | 4 +- .../messaging_api/model/clipboard_action.rb | 12 +++- .../model/clipboard_imagemap_action.rb | 10 ++- .../messaging_api/model/confirm_template.rb | 6 ++ .../model/create_rich_menu_alias_request.rb | 8 ++- .../model/datetime_picker_action.rb | 18 +++++- .../messaging_api/model/demographic_filter.rb | 4 +- lib/line/bot/v2/messaging_api/model/emoji.rb | 6 ++ .../model/emoji_substitution_object.rb | 8 ++- .../v2/messaging_api/model/error_detail.rb | 8 ++- .../v2/messaging_api/model/error_response.rb | 12 +++- lib/line/bot/v2/messaging_api/model/filter.rb | 2 + .../messaging_api/model/flex_block_style.rb | 6 ++ .../bot/v2/messaging_api/model/flex_box.rb | 56 ++++++++++++++++ .../model/flex_box_background.rb | 2 + .../model/flex_box_linear_gradient.rb | 12 ++++ .../bot/v2/messaging_api/model/flex_bubble.rb | 18 ++++++ .../messaging_api/model/flex_bubble_styles.rb | 8 +++ .../bot/v2/messaging_api/model/flex_button.rb | 30 +++++++++ .../v2/messaging_api/model/flex_carousel.rb | 4 ++ .../v2/messaging_api/model/flex_component.rb | 2 + .../v2/messaging_api/model/flex_container.rb | 2 + .../bot/v2/messaging_api/model/flex_filler.rb | 4 ++ .../bot/v2/messaging_api/model/flex_icon.rb | 22 +++++++ .../bot/v2/messaging_api/model/flex_image.rb | 64 ++++++++++++++----- .../v2/messaging_api/model/flex_message.rb | 12 +++- .../v2/messaging_api/model/flex_separator.rb | 6 ++ .../bot/v2/messaging_api/model/flex_span.rb | 14 ++++ .../bot/v2/messaging_api/model/flex_text.rb | 46 +++++++++++++ .../bot/v2/messaging_api/model/flex_video.rb | 12 ++++ .../model/gender_demographic_filter.rb | 6 +- ...get_aggregation_unit_name_list_response.rb | 8 ++- .../get_aggregation_unit_usage_response.rb | 4 +- .../model/get_followers_response.rb | 8 ++- .../get_joined_membership_users_response.rb | 8 ++- .../get_membership_subscription_response.rb | 4 +- ...et_message_content_transcoding_response.rb | 4 +- .../model/get_webhook_endpoint_response.rb | 8 ++- .../model/group_member_count_response.rb | 4 +- .../model/group_summary_response.rb | 12 +++- .../model/group_user_profile_response.rb | 12 +++- .../model/image_carousel_column.rb | 4 ++ .../model/image_carousel_template.rb | 4 ++ .../v2/messaging_api/model/image_message.rb | 12 +++- .../v2/messaging_api/model/imagemap_action.rb | 4 ++ .../v2/messaging_api/model/imagemap_area.rb | 8 +++ .../messaging_api/model/imagemap_base_size.rb | 4 ++ .../model/imagemap_external_link.rb | 4 ++ .../messaging_api/model/imagemap_message.rb | 18 +++++- .../v2/messaging_api/model/imagemap_video.rb | 8 +++ .../model/issue_link_token_response.rb | 4 +- lib/line/bot/v2/messaging_api/model/limit.rb | 8 ++- .../v2/messaging_api/model/location_action.rb | 8 ++- .../messaging_api/model/location_message.rb | 16 ++++- .../model/mark_messages_as_read_request.rb | 2 + .../model/members_ids_response.rb | 8 ++- .../bot/v2/messaging_api/model/membership.rb | 40 +++++++++--- .../model/membership_list_response.rb | 4 +- .../model/mention_substitution_object.rb | 6 +- .../v2/messaging_api/model/mention_target.rb | 4 +- .../bot/v2/messaging_api/model/message.rb | 8 ++- .../v2/messaging_api/model/message_action.rb | 10 ++- .../model/message_imagemap_action.rb | 8 +++ .../model/message_quota_response.rb | 6 +- .../messaging_api/model/multicast_request.rb | 16 +++-- .../model/narrowcast_progress_response.rb | 32 +++++++--- .../messaging_api/model/narrowcast_request.rb | 14 +++- .../model/number_of_messages_response.rb | 8 ++- .../model/operator_demographic_filter.rb | 10 ++- .../messaging_api/model/operator_recipient.rb | 14 +++- .../model/pnp_messages_request.rb | 12 +++- .../v2/messaging_api/model/postback_action.rb | 18 +++++- .../model/push_message_request.rb | 16 +++-- .../model/push_message_response.rb | 4 +- .../bot/v2/messaging_api/model/quick_reply.rb | 4 +- .../messaging_api/model/quick_reply_item.rb | 10 ++- .../model/quota_consumption_response.rb | 4 +- .../bot/v2/messaging_api/model/recipient.rb | 4 +- .../model/redelivery_recipient.rb | 6 +- .../model/reply_message_request.rb | 12 +++- .../model/reply_message_response.rb | 4 +- .../model/rich_menu_alias_list_response.rb | 4 +- .../model/rich_menu_alias_response.rb | 8 ++- .../v2/messaging_api/model/rich_menu_area.rb | 4 ++ .../model/rich_menu_batch_link_operation.rb | 8 ++- .../model/rich_menu_batch_operation.rb | 4 +- .../rich_menu_batch_progress_response.rb | 10 ++- .../model/rich_menu_batch_request.rb | 8 ++- .../rich_menu_batch_unlink_all_operation.rb | 4 +- .../model/rich_menu_batch_unlink_operation.rb | 6 +- .../messaging_api/model/rich_menu_bounds.rb | 16 +++-- .../model/rich_menu_bulk_link_request.rb | 8 ++- .../model/rich_menu_bulk_unlink_request.rb | 4 +- .../model/rich_menu_id_response.rb | 4 +- .../model/rich_menu_list_response.rb | 4 +- .../messaging_api/model/rich_menu_request.rb | 18 ++++-- .../messaging_api/model/rich_menu_response.rb | 22 +++++-- .../v2/messaging_api/model/rich_menu_size.rb | 8 ++- .../model/rich_menu_switch_action.rb | 12 +++- .../model/room_member_count_response.rb | 4 +- .../model/room_user_profile_response.rb | 12 +++- lib/line/bot/v2/messaging_api/model/sender.rb | 8 ++- .../v2/messaging_api/model/sent_message.rb | 8 ++- .../model/set_webhook_endpoint_request.rb | 4 +- .../model/show_loading_animation_request.rb | 8 ++- .../v2/messaging_api/model/sticker_message.rb | 16 ++++- .../model/subscribed_membership_plan.rb | 24 +++++-- .../model/subscribed_membership_user.rb | 16 +++-- .../v2/messaging_api/model/subscription.rb | 4 ++ .../subscription_period_demographic_filter.rb | 8 ++- .../model/substitution_object.rb | 4 +- .../bot/v2/messaging_api/model/template.rb | 2 + .../messaging_api/model/template_message.rb | 12 +++- .../model/test_webhook_endpoint_request.rb | 4 +- .../model/test_webhook_endpoint_response.rb | 20 ++++-- .../v2/messaging_api/model/text_message.rb | 16 ++++- .../v2/messaging_api/model/text_message_v2.rb | 18 +++++- .../model/update_rich_menu_alias_request.rb | 4 +- .../bot/v2/messaging_api/model/uri_action.rb | 12 +++- .../model/uri_imagemap_action.rb | 8 +++ .../model/user_mention_target.rb | 6 +- .../model/user_profile_response.rb | 20 ++++-- .../model/validate_message_request.rb | 4 +- .../v2/messaging_api/model/video_message.rb | 14 +++- .../model/acquire_chat_control_request.rb | 8 ++- .../v2/module/model/detach_module_request.rb | 4 +- .../v2/module/model/get_modules_response.rb | 8 ++- lib/line/bot/v2/module/model/module_bot.rb | 20 ++++-- .../model/attach_module_response.rb | 8 ++- lib/line/bot/v2/shop/model/error_response.rb | 4 +- .../v2/shop/model/mission_sticker_request.rb | 16 +++-- .../v2/webhook/model/account_link_event.rb | 24 +++++-- .../bot/v2/webhook/model/action_result.rb | 6 +- .../bot/v2/webhook/model/activated_event.rb | 20 +++++- .../bot/v2/webhook/model/all_mentionee.rb | 12 +++- .../webhook/model/attached_module_content.rb | 12 +++- .../v2/webhook/model/audio_message_content.rb | 14 +++- .../bot/v2/webhook/model/beacon_content.rb | 12 +++- lib/line/bot/v2/webhook/model/beacon_event.rb | 24 +++++-- .../bot/v2/webhook/model/bot_resumed_event.rb | 18 +++++- .../v2/webhook/model/bot_suspended_event.rb | 18 +++++- .../bot/v2/webhook/model/callback_request.rb | 8 ++- lib/line/bot/v2/webhook/model/chat_control.rb | 2 + .../bot/v2/webhook/model/content_provider.rb | 12 +++- .../bot/v2/webhook/model/deactivated_event.rb | 18 +++++- .../bot/v2/webhook/model/delivery_context.rb | 4 +- .../webhook/model/detached_module_content.rb | 12 +++- lib/line/bot/v2/webhook/model/emoji.rb | 16 +++-- lib/line/bot/v2/webhook/model/event.rb | 18 +++++- .../v2/webhook/model/file_message_content.rb | 16 +++-- .../bot/v2/webhook/model/follow_detail.rb | 4 +- lib/line/bot/v2/webhook/model/follow_event.rb | 24 +++++-- lib/line/bot/v2/webhook/model/group_source.rb | 12 +++- .../v2/webhook/model/image_message_content.rb | 16 ++++- lib/line/bot/v2/webhook/model/image_set.rb | 12 +++- lib/line/bot/v2/webhook/model/join_event.rb | 22 +++++-- .../bot/v2/webhook/model/joined_members.rb | 4 +- .../model/joined_membership_content.rb | 8 ++- lib/line/bot/v2/webhook/model/leave_event.rb | 18 +++++- lib/line/bot/v2/webhook/model/left_members.rb | 4 +- .../webhook/model/left_membership_content.rb | 8 ++- lib/line/bot/v2/webhook/model/link_content.rb | 8 ++- .../v2/webhook/model/link_things_content.rb | 8 ++- .../webhook/model/location_message_content.rb | 24 +++++-- .../v2/webhook/model/member_joined_event.rb | 24 +++++-- .../bot/v2/webhook/model/member_left_event.rb | 20 +++++- .../v2/webhook/model/membership_content.rb | 4 +- .../bot/v2/webhook/model/membership_event.rb | 24 +++++-- lib/line/bot/v2/webhook/model/mention.rb | 4 +- lib/line/bot/v2/webhook/model/mentionee.rb | 12 +++- .../bot/v2/webhook/model/message_content.rb | 8 ++- .../bot/v2/webhook/model/message_event.rb | 22 ++++++- .../bot/v2/webhook/model/module_content.rb | 4 +- lib/line/bot/v2/webhook/model/module_event.rb | 20 +++++- lib/line/bot/v2/webhook/model/pnp_delivery.rb | 4 +- .../model/pnp_delivery_completion_event.rb | 20 +++++- .../bot/v2/webhook/model/postback_content.rb | 6 +- .../bot/v2/webhook/model/postback_event.rb | 24 +++++-- .../model/renewed_membership_content.rb | 8 ++- lib/line/bot/v2/webhook/model/room_source.rb | 12 +++- .../bot/v2/webhook/model/scenario_result.rb | 32 +++++++--- .../model/scenario_result_things_content.rb | 10 ++- lib/line/bot/v2/webhook/model/source.rb | 4 +- .../webhook/model/sticker_message_content.rb | 34 +++++++--- .../v2/webhook/model/text_message_content.rb | 26 ++++++-- .../bot/v2/webhook/model/things_content.rb | 4 +- lib/line/bot/v2/webhook/model/things_event.rb | 24 +++++-- .../bot/v2/webhook/model/unfollow_event.rb | 18 +++++- .../v2/webhook/model/unlink_things_content.rb | 8 ++- .../bot/v2/webhook/model/unsend_detail.rb | 4 +- lib/line/bot/v2/webhook/model/unsend_event.rb | 20 +++++- .../bot/v2/webhook/model/user_mentionee.rb | 20 ++++-- lib/line/bot/v2/webhook/model/user_source.rb | 8 ++- .../v2/webhook/model/video_message_content.rb | 18 ++++-- .../v2/webhook/model/video_play_complete.rb | 4 +- .../model/video_play_complete_event.rb | 24 +++++-- 264 files changed, 2609 insertions(+), 605 deletions(-) diff --git a/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb b/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb index 0aaf4957..e885b6fc 100644 --- a/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb @@ -14,7 +14,9 @@ module ChannelAccessToken # Channel access token key IDs # @see https://developers.line.biz/en/reference/messaging-api/#get-all-valid-channel-access-token-key-ids-v2-1 class ChannelAccessTokenKeyIdsResponse - attr_accessor :kids # Array of channel access token key IDs. + # @!attribute [rw] kids + # @return [Array[String]] Array of channel access token key IDs. + attr_accessor :kids # @param kids [Array[String]] Array of channel access token key IDs. def initialize( diff --git a/lib/line/bot/v2/channel_access_token/model/error_response.rb b/lib/line/bot/v2/channel_access_token/model/error_response.rb index 131e3643..1222cb5c 100644 --- a/lib/line/bot/v2/channel_access_token/model/error_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/error_response.rb @@ -13,8 +13,12 @@ module V2 module ChannelAccessToken # Error response of the Channel access token class ErrorResponse - attr_accessor :error # Error summary - attr_accessor :error_description # Details of the error. Not returned in certain situations. + # @!attribute [rw] error + # @return [String] Error summary + attr_accessor :error + # @!attribute [rw] error_description + # @return [String] Details of the error. Not returned in certain situations. + attr_accessor :error_description # @param error [String] Error summary # @param error_description [String] Details of the error. Not returned in certain situations. diff --git a/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb index 03e3c837..d3e75d20 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb @@ -14,10 +14,18 @@ module ChannelAccessToken # Issued channel access token # @see https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1 class IssueChannelAccessTokenResponse - attr_accessor :access_token # Channel access token. - attr_accessor :expires_in # Amount of time in seconds from issue to expiration of the channel access token - attr_accessor :token_type # A token type. - attr_accessor :key_id # Unique key ID for identifying the channel access token. + # @!attribute [rw] access_token + # @return [String] Channel access token. + attr_accessor :access_token + # @!attribute [rw] expires_in + # @return [Integer] Amount of time in seconds from issue to expiration of the channel access token + attr_accessor :expires_in + # @!attribute [rw] token_type + # @return [String] A token type. + attr_accessor :token_type + # @!attribute [rw] key_id + # @return [String] Unique key ID for identifying the channel access token. + attr_accessor :key_id # @param access_token [String] Channel access token. # @param expires_in [Integer] Amount of time in seconds from issue to expiration of the channel access token diff --git a/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb index dba23728..3a2be17e 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb @@ -14,9 +14,15 @@ module ChannelAccessToken # Issued short-lived channel access token # @see https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token class IssueShortLivedChannelAccessTokenResponse - attr_accessor :access_token # A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. - attr_accessor :expires_in # Time until channel access token expires in seconds from time the token is issued. - attr_accessor :token_type # Token type. The value is always `Bearer`. + # @!attribute [rw] access_token + # @return [String] A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. + attr_accessor :access_token + # @!attribute [rw] expires_in + # @return [Integer] Time until channel access token expires in seconds from time the token is issued. + attr_accessor :expires_in + # @!attribute [rw] token_type + # @return [String] Token type. The value is always `Bearer`. + attr_accessor :token_type # @param access_token [String] A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. # @param expires_in [Integer] Time until channel access token expires in seconds from time the token is issued. diff --git a/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb index 849fc1bc..54b7009f 100644 --- a/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb @@ -14,9 +14,15 @@ module ChannelAccessToken # Issued stateless channel access token # @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token class IssueStatelessChannelAccessTokenResponse - attr_accessor :access_token # A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. - attr_accessor :expires_in # Duration in seconds after which the issued access token expires - attr_accessor :token_type # Token type. The value is always `Bearer`. + # @!attribute [rw] access_token + # @return [String] A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. + attr_accessor :access_token + # @!attribute [rw] expires_in + # @return [Integer] Duration in seconds after which the issued access token expires + attr_accessor :expires_in + # @!attribute [rw] token_type + # @return [String] Token type. The value is always `Bearer`. + attr_accessor :token_type # @param access_token [String] A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. # @param expires_in [Integer] Duration in seconds after which the issued access token expires diff --git a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb index aa06e604..61e7c39c 100644 --- a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb @@ -13,9 +13,15 @@ module V2 module ChannelAccessToken # Verification result class VerifyChannelAccessTokenResponse - attr_accessor :client_id # The channel ID for which the channel access token was issued. - attr_accessor :expires_in # Number of seconds before the channel access token expires. - attr_accessor :scope # Permissions granted to the channel access token. + # @!attribute [rw] client_id + # @return [String] The channel ID for which the channel access token was issued. + attr_accessor :client_id + # @!attribute [rw] expires_in + # @return [Integer] Number of seconds before the channel access token expires. + attr_accessor :expires_in + # @!attribute [rw] scope + # @return [String] Permissions granted to the channel access token. + attr_accessor :scope # @param client_id [String] The channel ID for which the channel access token was issued. # @param expires_in [Integer] Number of seconds before the channel access token expires. diff --git a/lib/line/bot/v2/insight/model/age_tile.rb b/lib/line/bot/v2/insight/model/age_tile.rb index 4ff58563..08fd98fd 100644 --- a/lib/line/bot/v2/insight/model/age_tile.rb +++ b/lib/line/bot/v2/insight/model/age_tile.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class AgeTile - attr_accessor :age # users' age - attr_accessor :percentage # Percentage + # @!attribute [rw] age + # @return [String] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age + attr_accessor :age + # @!attribute [rw] percentage + # @return [Float] Percentage + attr_accessor :percentage # @param age [String] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age # @param percentage [Float] Percentage diff --git a/lib/line/bot/v2/insight/model/app_type_tile.rb b/lib/line/bot/v2/insight/model/app_type_tile.rb index 94f837db..c3a27875 100644 --- a/lib/line/bot/v2/insight/model/app_type_tile.rb +++ b/lib/line/bot/v2/insight/model/app_type_tile.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class AppTypeTile - attr_accessor :app_type # users' OS - attr_accessor :percentage # Percentage + # @!attribute [rw] app_type + # @return [String] ('ios'|'android'|'others') users' OS + attr_accessor :app_type + # @!attribute [rw] percentage + # @return [Float] Percentage + attr_accessor :percentage # @param app_type [String] ('ios'|'android'|'others') users' OS # @param percentage [Float] Percentage diff --git a/lib/line/bot/v2/insight/model/area_tile.rb b/lib/line/bot/v2/insight/model/area_tile.rb index ba10e5b3..93e47a87 100644 --- a/lib/line/bot/v2/insight/model/area_tile.rb +++ b/lib/line/bot/v2/insight/model/area_tile.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class AreaTile - attr_accessor :area # users' country and region - attr_accessor :percentage # Percentage + # @!attribute [rw] area + # @return [String] users' country and region + attr_accessor :area + # @!attribute [rw] percentage + # @return [Float] Percentage + attr_accessor :percentage # @param area [String] users' country and region # @param percentage [Float] Percentage diff --git a/lib/line/bot/v2/insight/model/error_detail.rb b/lib/line/bot/v2/insight/model/error_detail.rb index a8ed7123..e84d7779 100644 --- a/lib/line/bot/v2/insight/model/error_detail.rb +++ b/lib/line/bot/v2/insight/model/error_detail.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class ErrorDetail - attr_accessor :message # Details of the error. Not included in the response under certain situations. - attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @!attribute [rw] message + # @return [String] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + attr_accessor :property # @param message [String] Details of the error. Not included in the response under certain situations. # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. diff --git a/lib/line/bot/v2/insight/model/error_response.rb b/lib/line/bot/v2/insight/model/error_response.rb index 4bc6d21d..be3a0710 100644 --- a/lib/line/bot/v2/insight/model/error_response.rb +++ b/lib/line/bot/v2/insight/model/error_response.rb @@ -13,8 +13,12 @@ module V2 module Insight # @see https://developers.line.biz/en/reference/messaging-api/#error-responses class ErrorResponse - attr_accessor :message # Message containing information about the error. - attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. + # @!attribute [rw] message + # @return [String] Message containing information about the error. + attr_accessor :message + # @!attribute [rw] details + # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + attr_accessor :details # @param message [String] Message containing information about the error. # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. diff --git a/lib/line/bot/v2/insight/model/gender_tile.rb b/lib/line/bot/v2/insight/model/gender_tile.rb index 274e85a2..13cf654b 100644 --- a/lib/line/bot/v2/insight/model/gender_tile.rb +++ b/lib/line/bot/v2/insight/model/gender_tile.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class GenderTile - attr_accessor :gender # users' gender - attr_accessor :percentage # Percentage + # @!attribute [rw] gender + # @return [String] ('male'|'female'|'unknown') users' gender + attr_accessor :gender + # @!attribute [rw] percentage + # @return [Float] Percentage + attr_accessor :percentage # @param gender [String] ('male'|'female'|'unknown') users' gender # @param percentage [Float] Percentage diff --git a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb index 9fb3e053..ece39b06 100644 --- a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb +++ b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb @@ -14,12 +14,24 @@ module Insight # Get friend demographics # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic class GetFriendsDemographicsResponse - attr_accessor :available # true if friend demographic information is available. - attr_accessor :genders # Percentage per gender. - attr_accessor :ages # Percentage per age group. - attr_accessor :areas # Percentage per area. - attr_accessor :app_types # Percentage by OS. - attr_accessor :subscription_periods # Percentage per friendship duration. + # @!attribute [rw] available + # @return [Boolean] true if friend demographic information is available. + attr_accessor :available + # @!attribute [rw] genders + # @return [Array[GenderTile]] Percentage per gender. + attr_accessor :genders + # @!attribute [rw] ages + # @return [Array[AgeTile]] Percentage per age group. + attr_accessor :ages + # @!attribute [rw] areas + # @return [Array[AreaTile]] Percentage per area. + attr_accessor :areas + # @!attribute [rw] app_types + # @return [Array[AppTypeTile]] Percentage by OS. + attr_accessor :app_types + # @!attribute [rw] subscription_periods + # @return [Array[SubscriptionPeriodTile]] Percentage per friendship duration. + attr_accessor :subscription_periods # @param available [Boolean] true if friend demographic information is available. # @param genders [Array[GenderTile]] Percentage per gender. diff --git a/lib/line/bot/v2/insight/model/get_message_event_response.rb b/lib/line/bot/v2/insight/model/get_message_event_response.rb index 46169f27..58595e2c 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response.rb @@ -14,9 +14,15 @@ module Insight # Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response class GetMessageEventResponse + # @!attribute [rw] overview + # @return [GetMessageEventResponseOverview] attr_accessor :overview - attr_accessor :messages # Array of information about individual message bubbles. - attr_accessor :clicks # Array of information about opened URLs in the message. + # @!attribute [rw] messages + # @return [Array[GetMessageEventResponseMessage]] Array of information about individual message bubbles. + attr_accessor :messages + # @!attribute [rw] clicks + # @return [Array[GetMessageEventResponseClick]] Array of information about opened URLs in the message. + attr_accessor :clicks # @param overview [GetMessageEventResponseOverview] # @param messages [Array[GetMessageEventResponseMessage]] Array of information about individual message bubbles. diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb index 3157f7b8..254b72c5 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb @@ -12,11 +12,21 @@ module Bot module V2 module Insight class GetMessageEventResponseClick - attr_accessor :seq # The URL's serial number. - attr_accessor :url # URL. - attr_accessor :click # Number of times the URL was opened. - attr_accessor :unique_click # Number of users that opened the URL. - attr_accessor :unique_click_of_request # Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. + # @!attribute [rw] seq + # @return [Integer] The URL's serial number. + attr_accessor :seq + # @!attribute [rw] url + # @return [String] URL. + attr_accessor :url + # @!attribute [rw] click + # @return [Integer] Number of times the URL was opened. + attr_accessor :click + # @!attribute [rw] unique_click + # @return [Integer] Number of users that opened the URL. + attr_accessor :unique_click + # @!attribute [rw] unique_click_of_request + # @return [Integer] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. + attr_accessor :unique_click_of_request # @param seq [Integer] The URL's serial number. # @param url [String] URL. diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb index 3c94a48a..93bc13e7 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb @@ -12,18 +12,42 @@ module Bot module V2 module Insight class GetMessageEventResponseMessage - attr_accessor :seq # Bubble's serial number. - attr_accessor :impression # Number of times the bubble was displayed. - attr_accessor :media_played # Number of times audio or video in the bubble started playing. - attr_accessor :media_played25_percent # Number of times audio or video in the bubble started playing and was played 25% of the total time. - attr_accessor :media_played50_percent # Number of times audio or video in the bubble started playing and was played 50% of the total time. - attr_accessor :media_played75_percent # Number of times audio or video in the bubble started playing and was played 75% of the total time. - attr_accessor :media_played100_percent # Number of times audio or video in the bubble started playing and was played 100% of the total time. - attr_accessor :unique_media_played # Number of users that started playing audio or video in the bubble. - attr_accessor :unique_media_played25_percent # Number of users that started playing audio or video in the bubble and played 25% of the total time. - attr_accessor :unique_media_played50_percent # Number of users that started playing audio or video in the bubble and played 50% of the total time. - attr_accessor :unique_media_played75_percent # Number of users that started playing audio or video in the bubble and played 75% of the total time. - attr_accessor :unique_media_played100_percent # Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @!attribute [rw] seq + # @return [Integer] Bubble's serial number. + attr_accessor :seq + # @!attribute [rw] impression + # @return [Integer] Number of times the bubble was displayed. + attr_accessor :impression + # @!attribute [rw] media_played + # @return [Integer] Number of times audio or video in the bubble started playing. + attr_accessor :media_played + # @!attribute [rw] media_played25_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + attr_accessor :media_played25_percent + # @!attribute [rw] media_played50_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + attr_accessor :media_played50_percent + # @!attribute [rw] media_played75_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + attr_accessor :media_played75_percent + # @!attribute [rw] media_played100_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + attr_accessor :media_played100_percent + # @!attribute [rw] unique_media_played + # @return [Integer] Number of users that started playing audio or video in the bubble. + attr_accessor :unique_media_played + # @!attribute [rw] unique_media_played25_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + attr_accessor :unique_media_played25_percent + # @!attribute [rw] unique_media_played50_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + attr_accessor :unique_media_played50_percent + # @!attribute [rw] unique_media_played75_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + attr_accessor :unique_media_played75_percent + # @!attribute [rw] unique_media_played100_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + attr_accessor :unique_media_played100_percent # @param seq [Integer] Bubble's serial number. # @param impression [Integer] Number of times the bubble was displayed. diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb index 0101111b..dafb4bf8 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb @@ -13,13 +13,27 @@ module V2 module Insight # Summary of message statistics. class GetMessageEventResponseOverview - attr_accessor :request_id # Request ID. - attr_accessor :timestamp # UNIX timestamp for message delivery time in seconds. - attr_accessor :delivered # Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. - attr_accessor :unique_impression # Number of users who opened the message, meaning they displayed at least 1 bubble. - attr_accessor :unique_click # Number of users who opened any URL in the message. - attr_accessor :unique_media_played # Number of users who started playing any video or audio in the message. - attr_accessor :unique_media_played100_percent # Number of users who played the entirety of any video or audio in the message. + # @!attribute [rw] request_id + # @return [String] Request ID. + attr_accessor :request_id + # @!attribute [rw] timestamp + # @return [Integer] UNIX timestamp for message delivery time in seconds. + attr_accessor :timestamp + # @!attribute [rw] delivered + # @return [Integer] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. + attr_accessor :delivered + # @!attribute [rw] unique_impression + # @return [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + attr_accessor :unique_impression + # @!attribute [rw] unique_click + # @return [Integer] Number of users who opened any URL in the message. + attr_accessor :unique_click + # @!attribute [rw] unique_media_played + # @return [Integer] Number of users who started playing any video or audio in the message. + attr_accessor :unique_media_played + # @!attribute [rw] unique_media_played100_percent + # @return [Integer] Number of users who played the entirety of any video or audio in the message. + attr_accessor :unique_media_played100_percent # @param request_id [String] Request ID. # @param timestamp [Integer] UNIX timestamp for message delivery time in seconds. diff --git a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb index b1b63900..242704cb 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb @@ -14,10 +14,18 @@ module Insight # Get number of followers # @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers class GetNumberOfFollowersResponse - attr_accessor :status # Calculation status. - attr_accessor :followers # The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. - attr_accessor :targeted_reaches # The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. - attr_accessor :blocks # The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. + # @!attribute [rw] status + # @return [String] ('ready'|'unready'|'out_of_service') Calculation status. + attr_accessor :status + # @!attribute [rw] followers + # @return [Integer] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. + attr_accessor :followers + # @!attribute [rw] targeted_reaches + # @return [Integer] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. + attr_accessor :targeted_reaches + # @!attribute [rw] blocks + # @return [Integer] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. + attr_accessor :blocks # @param status [String] ('ready'|'unready'|'out_of_service') Calculation status. # @param followers [Integer] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. diff --git a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb index f16695d7..d13df34e 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb @@ -14,17 +14,39 @@ module Insight # Get number of message deliveries # @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages class GetNumberOfMessageDeliveriesResponse - attr_accessor :status # Status of the counting process. - attr_accessor :broadcast # Number of messages sent to all of this LINE Official Account's friends (broadcast messages). - attr_accessor :targeting # Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). - attr_accessor :auto_response # Number of auto-response messages sent. - attr_accessor :welcome_response # Number of greeting messages sent. - attr_accessor :chat # Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). - attr_accessor :api_broadcast # Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. - attr_accessor :api_push # Number of push messages sent with the `Send push message` Messaging API operation. - attr_accessor :api_multicast # Number of multicast messages sent with the `Send multicast message` Messaging API operation. - attr_accessor :api_narrowcast # Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. - attr_accessor :api_reply # Number of replies sent with the `Send reply message` Messaging API operation. + # @!attribute [rw] status + # @return [String] ('ready'|'unready'|'out_of_service') Status of the counting process. + attr_accessor :status + # @!attribute [rw] broadcast + # @return [Integer] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). + attr_accessor :broadcast + # @!attribute [rw] targeting + # @return [Integer] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). + attr_accessor :targeting + # @!attribute [rw] auto_response + # @return [Integer] Number of auto-response messages sent. + attr_accessor :auto_response + # @!attribute [rw] welcome_response + # @return [Integer] Number of greeting messages sent. + attr_accessor :welcome_response + # @!attribute [rw] chat + # @return [Integer] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). + attr_accessor :chat + # @!attribute [rw] api_broadcast + # @return [Integer] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. + attr_accessor :api_broadcast + # @!attribute [rw] api_push + # @return [Integer] Number of push messages sent with the `Send push message` Messaging API operation. + attr_accessor :api_push + # @!attribute [rw] api_multicast + # @return [Integer] Number of multicast messages sent with the `Send multicast message` Messaging API operation. + attr_accessor :api_multicast + # @!attribute [rw] api_narrowcast + # @return [Integer] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. + attr_accessor :api_narrowcast + # @!attribute [rw] api_reply + # @return [Integer] Number of replies sent with the `Send reply message` Messaging API operation. + attr_accessor :api_reply # @param status [String] ('ready'|'unready'|'out_of_service') Status of the counting process. # @param broadcast [Integer] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb index 51f15bf9..0bfd2126 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb @@ -14,9 +14,15 @@ module Insight # Response object for `get statistics per unit` # @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response class GetStatisticsPerUnitResponse + # @!attribute [rw] overview + # @return [GetStatisticsPerUnitResponseOverview] attr_accessor :overview - attr_accessor :messages # Array of information about individual message bubbles. - attr_accessor :clicks # Array of information about opened URLs in the message. + # @!attribute [rw] messages + # @return [Array[GetStatisticsPerUnitResponseMessage]] Array of information about individual message bubbles. + attr_accessor :messages + # @!attribute [rw] clicks + # @return [Array[GetStatisticsPerUnitResponseClick]] Array of information about opened URLs in the message. + attr_accessor :clicks # @param overview [GetStatisticsPerUnitResponseOverview] # @param messages [Array[GetStatisticsPerUnitResponseMessage]] Array of information about individual message bubbles. diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb index 7049c414..f9a31f78 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb @@ -13,11 +13,21 @@ module V2 module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response class GetStatisticsPerUnitResponseClick - attr_accessor :seq # The URL's serial number. - attr_accessor :url # URL. - attr_accessor :click # Number of times the URL in the bubble was opened. - attr_accessor :unique_click # Number of users that opened the URL in the bubble. - attr_accessor :unique_click_of_request # Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. + # @!attribute [rw] seq + # @return [Integer] The URL's serial number. + attr_accessor :seq + # @!attribute [rw] url + # @return [String] URL. + attr_accessor :url + # @!attribute [rw] click + # @return [Integer] Number of times the URL in the bubble was opened. + attr_accessor :click + # @!attribute [rw] unique_click + # @return [Integer] Number of users that opened the URL in the bubble. + attr_accessor :unique_click + # @!attribute [rw] unique_click_of_request + # @return [Integer] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. + attr_accessor :unique_click_of_request # @param seq [Integer] The URL's serial number. # @param url [String] URL. diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb index c5b3862d..80e60071 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb @@ -13,19 +13,45 @@ module V2 module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response class GetStatisticsPerUnitResponseMessage - attr_accessor :seq # Bubble's serial number. - attr_accessor :impression # Number of times the bubble was displayed. - attr_accessor :media_played # Number of times audio or video in the bubble started playing. - attr_accessor :media_played25_percent # Number of times audio or video in the bubble started playing and was played 25% of the total time. - attr_accessor :media_played50_percent # Number of times audio or video in the bubble started playing and was played 50% of the total time. - attr_accessor :media_played75_percent # Number of times audio or video in the bubble started playing and was played 75% of the total time. - attr_accessor :media_played100_percent # Number of times audio or video in the bubble started playing and was played 100% of the total time. - attr_accessor :unique_impression # Number of users the bubble was displayed. - attr_accessor :unique_media_played # Number of users that started playing audio or video in the bubble. - attr_accessor :unique_media_played25_percent # Number of users that started playing audio or video in the bubble and played 25% of the total time. - attr_accessor :unique_media_played50_percent # Number of users that started playing audio or video in the bubble and played 50% of the total time. - attr_accessor :unique_media_played75_percent # Number of users that started playing audio or video in the bubble and played 75% of the total time. - attr_accessor :unique_media_played100_percent # Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @!attribute [rw] seq + # @return [Integer] Bubble's serial number. + attr_accessor :seq + # @!attribute [rw] impression + # @return [Integer] Number of times the bubble was displayed. + attr_accessor :impression + # @!attribute [rw] media_played + # @return [Integer] Number of times audio or video in the bubble started playing. + attr_accessor :media_played + # @!attribute [rw] media_played25_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + attr_accessor :media_played25_percent + # @!attribute [rw] media_played50_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + attr_accessor :media_played50_percent + # @!attribute [rw] media_played75_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + attr_accessor :media_played75_percent + # @!attribute [rw] media_played100_percent + # @return [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + attr_accessor :media_played100_percent + # @!attribute [rw] unique_impression + # @return [Integer] Number of users the bubble was displayed. + attr_accessor :unique_impression + # @!attribute [rw] unique_media_played + # @return [Integer] Number of users that started playing audio or video in the bubble. + attr_accessor :unique_media_played + # @!attribute [rw] unique_media_played25_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + attr_accessor :unique_media_played25_percent + # @!attribute [rw] unique_media_played50_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + attr_accessor :unique_media_played50_percent + # @!attribute [rw] unique_media_played75_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + attr_accessor :unique_media_played75_percent + # @!attribute [rw] unique_media_played100_percent + # @return [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + attr_accessor :unique_media_played100_percent # @param seq [Integer] Bubble's serial number. # @param impression [Integer] Number of times the bubble was displayed. diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb index 716116d1..5efcebd0 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb @@ -14,10 +14,18 @@ module Insight # Statistics related to messages. # @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response class GetStatisticsPerUnitResponseOverview - attr_accessor :unique_impression # Number of users who opened the message, meaning they displayed at least 1 bubble. - attr_accessor :unique_click # Number of users who opened any URL in the message. - attr_accessor :unique_media_played # Number of users who started playing any video or audio in the message. - attr_accessor :unique_media_played100_percent # Number of users who played the entirety of any video or audio in the message. + # @!attribute [rw] unique_impression + # @return [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + attr_accessor :unique_impression + # @!attribute [rw] unique_click + # @return [Integer] Number of users who opened any URL in the message. + attr_accessor :unique_click + # @!attribute [rw] unique_media_played + # @return [Integer] Number of users who started playing any video or audio in the message. + attr_accessor :unique_media_played + # @!attribute [rw] unique_media_played100_percent + # @return [Integer] Number of users who played the entirety of any video or audio in the message. + attr_accessor :unique_media_played100_percent # @param unique_impression [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. # @param unique_click [Integer] Number of users who opened any URL in the message. diff --git a/lib/line/bot/v2/insight/model/subscription_period_tile.rb b/lib/line/bot/v2/insight/model/subscription_period_tile.rb index aca7f890..74ba628d 100644 --- a/lib/line/bot/v2/insight/model/subscription_period_tile.rb +++ b/lib/line/bot/v2/insight/model/subscription_period_tile.rb @@ -12,8 +12,12 @@ module Bot module V2 module Insight class SubscriptionPeriodTile - attr_accessor :subscription_period # Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. - attr_accessor :percentage # Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + # @!attribute [rw] subscription_period + # @return [String] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. + attr_accessor :subscription_period + # @!attribute [rw] percentage + # @return [Float] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + attr_accessor :percentage # @param subscription_period [String] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. # @param percentage [Float] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. diff --git a/lib/line/bot/v2/liff/model/add_liff_app_request.rb b/lib/line/bot/v2/liff/model/add_liff_app_request.rb index 92e07ec5..aca5fb0e 100644 --- a/lib/line/bot/v2/liff/model/add_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/add_liff_app_request.rb @@ -13,11 +13,23 @@ module V2 module Liff # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app class AddLiffAppRequest + # @!attribute [rw] view + # @return [LiffView] attr_accessor :view - attr_accessor :description # Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @!attribute [rw] description + # @return [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + attr_accessor :description + # @!attribute [rw] features + # @return [LiffFeatures] attr_accessor :features - attr_accessor :permanent_link_pattern # How additional information in LIFF URLs is handled. Specify `concat`. + # @!attribute [rw] permanent_link_pattern + # @return [String] How additional information in LIFF URLs is handled. Specify `concat`. + attr_accessor :permanent_link_pattern + # @!attribute [rw] scope + # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope + # @!attribute [rw] bot_prompt + # @return [String] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt # @param view [LiffView] diff --git a/lib/line/bot/v2/liff/model/add_liff_app_response.rb b/lib/line/bot/v2/liff/model/add_liff_app_response.rb index 76908c84..d5140de8 100644 --- a/lib/line/bot/v2/liff/model/add_liff_app_response.rb +++ b/lib/line/bot/v2/liff/model/add_liff_app_response.rb @@ -12,6 +12,8 @@ module Bot module V2 module Liff class AddLiffAppResponse + # @!attribute [rw] liff_id + # @return [String] attr_accessor :liff_id # @param liff_id [String] diff --git a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb index ec4d1f4e..1ed90d69 100644 --- a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb +++ b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb @@ -12,6 +12,8 @@ module Bot module V2 module Liff class GetAllLiffAppsResponse + # @!attribute [rw] apps + # @return [Array[LiffApp]] attr_accessor :apps # @param apps [Array[LiffApp]] diff --git a/lib/line/bot/v2/liff/model/liff_app.rb b/lib/line/bot/v2/liff/model/liff_app.rb index cc5f1d93..228f9354 100644 --- a/lib/line/bot/v2/liff/model/liff_app.rb +++ b/lib/line/bot/v2/liff/model/liff_app.rb @@ -12,12 +12,26 @@ module Bot module V2 module Liff class LiffApp - attr_accessor :liff_id # LIFF app ID + # @!attribute [rw] liff_id + # @return [String] LIFF app ID + attr_accessor :liff_id + # @!attribute [rw] view + # @return [LiffView] attr_accessor :view - attr_accessor :description # Name of the LIFF app + # @!attribute [rw] description + # @return [String] Name of the LIFF app + attr_accessor :description + # @!attribute [rw] features + # @return [LiffFeatures] attr_accessor :features - attr_accessor :permanent_link_pattern # How additional information in LIFF URLs is handled. concat is returned. + # @!attribute [rw] permanent_link_pattern + # @return [String] How additional information in LIFF URLs is handled. concat is returned. + attr_accessor :permanent_link_pattern + # @!attribute [rw] scope + # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope + # @!attribute [rw] bot_prompt + # @return [String] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt # @param liff_id [String] LIFF app ID diff --git a/lib/line/bot/v2/liff/model/liff_features.rb b/lib/line/bot/v2/liff/model/liff_features.rb index 99efb55e..f1d08f92 100644 --- a/lib/line/bot/v2/liff/model/liff_features.rb +++ b/lib/line/bot/v2/liff/model/liff_features.rb @@ -12,8 +12,12 @@ module Bot module V2 module Liff class LiffFeatures - attr_accessor :ble # `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. - attr_accessor :qr_code # `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. + # @!attribute [rw] ble + # @return [Boolean] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. + attr_accessor :ble + # @!attribute [rw] qr_code + # @return [Boolean] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. + attr_accessor :qr_code # @param ble [Boolean] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. # @param qr_code [Boolean] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. diff --git a/lib/line/bot/v2/liff/model/liff_view.rb b/lib/line/bot/v2/liff/model/liff_view.rb index 42644ced..f1a03f80 100644 --- a/lib/line/bot/v2/liff/model/liff_view.rb +++ b/lib/line/bot/v2/liff/model/liff_view.rb @@ -13,9 +13,15 @@ module V2 module Liff # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app class LiffView - attr_accessor :type # Size of the LIFF app view. Specify one of these values: - compact - tall - full - attr_accessor :url # Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. - attr_accessor :module_mode # `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @!attribute [rw] type + # @return [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + attr_accessor :type + # @!attribute [rw] url + # @return [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + attr_accessor :url + # @!attribute [rw] module_mode + # @return [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + attr_accessor :module_mode # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. diff --git a/lib/line/bot/v2/liff/model/update_liff_app_request.rb b/lib/line/bot/v2/liff/model/update_liff_app_request.rb index 6e8452ee..2377a301 100644 --- a/lib/line/bot/v2/liff/model/update_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/update_liff_app_request.rb @@ -13,11 +13,23 @@ module V2 module Liff # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app class UpdateLiffAppRequest + # @!attribute [rw] view + # @return [UpdateLiffView] attr_accessor :view - attr_accessor :description # Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @!attribute [rw] description + # @return [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + attr_accessor :description + # @!attribute [rw] features + # @return [LiffFeatures] attr_accessor :features - attr_accessor :permanent_link_pattern # How additional information in LIFF URLs is handled. Specify `concat`. + # @!attribute [rw] permanent_link_pattern + # @return [String] How additional information in LIFF URLs is handled. Specify `concat`. + attr_accessor :permanent_link_pattern + # @!attribute [rw] scope + # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope + # @!attribute [rw] bot_prompt + # @return [String] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt # @param view [UpdateLiffView] diff --git a/lib/line/bot/v2/liff/model/update_liff_view.rb b/lib/line/bot/v2/liff/model/update_liff_view.rb index 351f3281..90f345eb 100644 --- a/lib/line/bot/v2/liff/model/update_liff_view.rb +++ b/lib/line/bot/v2/liff/model/update_liff_view.rb @@ -13,9 +13,15 @@ module V2 module Liff # @see https://developers.line.biz/en/reference/liff-server/#update-liff-app class UpdateLiffView - attr_accessor :type # Size of the LIFF app view. Specify one of these values: - compact - tall - full - attr_accessor :url # Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. - attr_accessor :module_mode # `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @!attribute [rw] type + # @return [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + attr_accessor :type + # @!attribute [rw] url + # @return [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + attr_accessor :url + # @!attribute [rw] module_mode + # @return [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + attr_accessor :module_mode # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. diff --git a/lib/line/bot/v2/manage_audience/model/adaccount.rb b/lib/line/bot/v2/manage_audience/model/adaccount.rb index 2d577c90..0b0abb5a 100644 --- a/lib/line/bot/v2/manage_audience/model/adaccount.rb +++ b/lib/line/bot/v2/manage_audience/model/adaccount.rb @@ -13,7 +13,9 @@ module V2 module ManageAudience # Adaccount class Adaccount - attr_accessor :name # Ad account name. + # @!attribute [rw] name + # @return [String] Ad account name. + attr_accessor :name # @param name [String] Ad account name. def initialize( diff --git a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb index eb0a042e..40f63a01 100644 --- a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb @@ -14,9 +14,15 @@ module ManageAudience # Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON) # @see https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group class AddAudienceToAudienceGroupRequest - attr_accessor :audience_group_id # The audience ID. - attr_accessor :upload_description # The audience's name. - attr_accessor :audiences # An array of up to 10,000 user IDs or IFAs. + # @!attribute [rw] audience_group_id + # @return [Integer] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] upload_description + # @return [String] The audience's name. + attr_accessor :upload_description + # @!attribute [rw] audiences + # @return [Array[Audience]] An array of up to 10,000 user IDs or IFAs. + attr_accessor :audiences # @param audience_group_id [Integer] The audience ID. # @param upload_description [String] The audience's name. diff --git a/lib/line/bot/v2/manage_audience/model/audience.rb b/lib/line/bot/v2/manage_audience/model/audience.rb index 74979e28..297a8416 100644 --- a/lib/line/bot/v2/manage_audience/model/audience.rb +++ b/lib/line/bot/v2/manage_audience/model/audience.rb @@ -13,7 +13,9 @@ module V2 module ManageAudience # Audience class Audience - attr_accessor :id # A user ID or IFA. You can specify an empty array. + # @!attribute [rw] id + # @return [String] A user ID or IFA. You can specify an empty array. + attr_accessor :id # @param id [String] A user ID or IFA. You can specify an empty array. def initialize( diff --git a/lib/line/bot/v2/manage_audience/model/audience_group.rb b/lib/line/bot/v2/manage_audience/model/audience_group.rb index 86e60666..cf989052 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group.rb @@ -13,17 +13,41 @@ module V2 module ManageAudience # Audience group class AudienceGroup - attr_accessor :audience_group_id # The audience ID. + # @!attribute [rw] audience_group_id + # @return [Integer] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type - attr_accessor :description # The audience's name. + # @!attribute [rw] description + # @return [String] The audience's name. + attr_accessor :description + # @!attribute [rw] status + # @return [String] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') attr_accessor :status + # @!attribute [rw] failed_type + # @return [String] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') attr_accessor :failed_type - attr_accessor :audience_count # The number of users included in the audience. - attr_accessor :created # When the audience was created (in UNIX time). - attr_accessor :request_id # The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. - attr_accessor :click_url # The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. - attr_accessor :is_ifa_audience # The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. + # @!attribute [rw] audience_count + # @return [Integer] The number of users included in the audience. + attr_accessor :audience_count + # @!attribute [rw] created + # @return [Integer] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @return [String] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. + attr_accessor :request_id + # @!attribute [rw] click_url + # @return [String] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. + attr_accessor :click_url + # @!attribute [rw] is_ifa_audience + # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. + attr_accessor :is_ifa_audience + # @!attribute [rw] permission + # @return [String] ('READ'|'READ_WRITE') attr_accessor :permission + # @!attribute [rw] create_route + # @return [String] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') attr_accessor :create_route # @param audience_group_id [Integer] The audience ID. diff --git a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb index 10b7accc..eef56cf2 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb @@ -14,14 +14,30 @@ module ManageAudience # Audience group job # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class AudienceGroupJob - attr_accessor :audience_group_job_id # A job ID. - attr_accessor :audience_group_id # An audience ID. - attr_accessor :description # The job's description. + # @!attribute [rw] audience_group_job_id + # @return [Integer] A job ID. + attr_accessor :audience_group_job_id + # @!attribute [rw] audience_group_id + # @return [Integer] An audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] description + # @return [String] The job's description. + attr_accessor :description + # @!attribute [rw] type + # @return [String] ('DIFF_ADD') attr_accessor :type + # @!attribute [rw] job_status + # @return [String] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') attr_accessor :job_status + # @!attribute [rw] failed_type + # @return [String] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') attr_accessor :failed_type - attr_accessor :audience_count # The number of accounts (recipients) that were added or removed. - attr_accessor :created # When the job was created (in UNIX time). + # @!attribute [rw] audience_count + # @return [Integer] The number of accounts (recipients) that were added or removed. + attr_accessor :audience_count + # @!attribute [rw] created + # @return [Integer] When the job was created (in UNIX time). + attr_accessor :created # @param audience_group_job_id [Integer] A job ID. # @param audience_group_id [Integer] An audience ID. diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb index 1a78dc5b..3a33f8a3 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb @@ -14,10 +14,18 @@ module ManageAudience # Create audience for uploading user IDs (by JSON) # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group class CreateAudienceGroupRequest - attr_accessor :description # The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 - attr_accessor :is_ifa_audience # To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. - attr_accessor :upload_description # The description to register for the job (in jobs[].description). - attr_accessor :audiences # An array of user IDs or IFAs. Max number: 10,000 + # @!attribute [rw] description + # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + attr_accessor :description + # @!attribute [rw] is_ifa_audience + # @return [Boolean] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. + attr_accessor :is_ifa_audience + # @!attribute [rw] upload_description + # @return [String] The description to register for the job (in jobs[].description). + attr_accessor :upload_description + # @!attribute [rw] audiences + # @return [Array[Audience]] An array of user IDs or IFAs. Max number: 10,000 + attr_accessor :audiences # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 # @param is_ifa_audience [Boolean] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb index 3b41e710..8b08526b 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb @@ -14,14 +14,30 @@ module ManageAudience # Create audience for uploading user IDs (by JSON) # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group class CreateAudienceGroupResponse - attr_accessor :audience_group_id # The audience ID. - attr_accessor :create_route # How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @!attribute [rw] audience_group_id + # @return [Integer] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] create_route + # @return [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + attr_accessor :create_route + # @!attribute [rw] type + # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type - attr_accessor :description # The audience's name. - attr_accessor :created # When the audience was created (in UNIX time). - attr_accessor :permission # Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. - attr_accessor :expire_timestamp # Time of audience expiration. Only returned for specific audiences. - attr_accessor :is_ifa_audience # The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. + # @!attribute [rw] description + # @return [String] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] permission + # @return [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. + attr_accessor :permission + # @!attribute [rw] expire_timestamp + # @return [Float] Time of audience expiration. Only returned for specific audiences. + attr_accessor :expire_timestamp + # @!attribute [rw] is_ifa_audience + # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. + attr_accessor :is_ifa_audience # @param audience_group_id [Integer] The audience ID. # @param create_route [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb index a171e50e..c9b8f8ae 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb @@ -14,9 +14,15 @@ module ManageAudience # Create audience for click-based retargeting # @see https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group class CreateClickBasedAudienceGroupRequest - attr_accessor :description # The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 - attr_accessor :request_id # The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. - attr_accessor :click_url # The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 + # @!attribute [rw] description + # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + attr_accessor :description + # @!attribute [rw] request_id + # @return [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + attr_accessor :request_id + # @!attribute [rw] click_url + # @return [String] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 + attr_accessor :click_url # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb index 7fdc9ffa..6d4c5f56 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb @@ -14,16 +14,36 @@ module ManageAudience # Create audience for click-based retargeting # @see https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group class CreateClickBasedAudienceGroupResponse - attr_accessor :audience_group_id # The audience ID. + # @!attribute [rw] audience_group_id + # @return [Integer] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type - attr_accessor :description # The audience's name. - attr_accessor :created # When the audience was created (in UNIX time). - attr_accessor :request_id # The request ID that was specified when the audience was created. - attr_accessor :click_url # The URL that was specified when the audience was created. - attr_accessor :create_route # How the audience was created. `MESSAGING_API`: An audience created with Messaging API. - attr_accessor :permission # Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. - attr_accessor :expire_timestamp # Time of audience expiration. Only returned for specific audiences. - attr_accessor :is_ifa_audience # The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. + # @!attribute [rw] description + # @return [String] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @return [String] The request ID that was specified when the audience was created. + attr_accessor :request_id + # @!attribute [rw] click_url + # @return [String] The URL that was specified when the audience was created. + attr_accessor :click_url + # @!attribute [rw] create_route + # @return [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + attr_accessor :create_route + # @!attribute [rw] permission + # @return [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. + attr_accessor :permission + # @!attribute [rw] expire_timestamp + # @return [Integer] Time of audience expiration. Only returned for specific audiences. + attr_accessor :expire_timestamp + # @!attribute [rw] is_ifa_audience + # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. + attr_accessor :is_ifa_audience # @param audience_group_id [Integer] The audience ID. # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb index c521c3eb..4998867d 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb @@ -14,8 +14,12 @@ module ManageAudience # Create audience for impression-based retargeting # @see https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group class CreateImpBasedAudienceGroupRequest - attr_accessor :description # The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 - attr_accessor :request_id # The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @!attribute [rw] description + # @return [String] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 + attr_accessor :description + # @!attribute [rw] request_id + # @return [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + attr_accessor :request_id # @param description [String] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb index 2bc26b7e..1ef79fc2 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb @@ -14,11 +14,21 @@ module ManageAudience # Create audience for impression-based retargeting # @see https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group class CreateImpBasedAudienceGroupResponse - attr_accessor :audience_group_id # The audience ID. + # @!attribute [rw] audience_group_id + # @return [Integer] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type - attr_accessor :description # The audience's name. - attr_accessor :created # When the audience was created (in UNIX time). - attr_accessor :request_id # The request ID that was specified when the audience was created. + # @!attribute [rw] description + # @return [String] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @return [String] The request ID that was specified when the audience was created. + attr_accessor :request_id # @param audience_group_id [Integer] The audience ID. # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') diff --git a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb index 48c99b86..52b98379 100644 --- a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb +++ b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb @@ -13,9 +13,15 @@ module V2 module ManageAudience # Owner of this audience group. class DetailedOwner - attr_accessor :service_type # Service name where the audience group has been created. - attr_accessor :id # Owner ID in the service. - attr_accessor :name # Owner account name. + # @!attribute [rw] service_type + # @return [String] Service name where the audience group has been created. + attr_accessor :service_type + # @!attribute [rw] id + # @return [String] Owner ID in the service. + attr_accessor :id + # @!attribute [rw] name + # @return [String] Owner account name. + attr_accessor :name # @param service_type [String] Service name where the audience group has been created. # @param id [String] Owner ID in the service. diff --git a/lib/line/bot/v2/manage_audience/model/error_detail.rb b/lib/line/bot/v2/manage_audience/model/error_detail.rb index 725c2cf2..367daa57 100644 --- a/lib/line/bot/v2/manage_audience/model/error_detail.rb +++ b/lib/line/bot/v2/manage_audience/model/error_detail.rb @@ -12,8 +12,12 @@ module Bot module V2 module ManageAudience class ErrorDetail - attr_accessor :message # Details of the error. Not included in the response under certain situations. - attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @!attribute [rw] message + # @return [String] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + attr_accessor :property # @param message [String] Details of the error. Not included in the response under certain situations. # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. diff --git a/lib/line/bot/v2/manage_audience/model/error_response.rb b/lib/line/bot/v2/manage_audience/model/error_response.rb index 283cb79a..464a2c38 100644 --- a/lib/line/bot/v2/manage_audience/model/error_response.rb +++ b/lib/line/bot/v2/manage_audience/model/error_response.rb @@ -13,8 +13,12 @@ module V2 module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#error-responses class ErrorResponse - attr_accessor :message # Message containing information about the error. - attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. + # @!attribute [rw] message + # @return [String] Message containing information about the error. + attr_accessor :message + # @!attribute [rw] details + # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + attr_accessor :details # @param message [String] Message containing information about the error. # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb index 02804ee0..e57918b2 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb @@ -14,8 +14,14 @@ module ManageAudience # Get audience data # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class GetAudienceDataResponse + # @!attribute [rw] audience_group + # @return [AudienceGroup] attr_accessor :audience_group - attr_accessor :jobs # An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @!attribute [rw] jobs + # @return [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + attr_accessor :jobs + # @!attribute [rw] adaccount + # @return [Adaccount] attr_accessor :adaccount # @param audience_group [AudienceGroup] diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb index 63f9c42f..54534d06 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb @@ -14,6 +14,8 @@ module ManageAudience # Get the authority level of the audience # @see https://developers.line.biz/en/reference/messaging-api/#get-authority-level class GetAudienceGroupAuthorityLevelResponse + # @!attribute [rw] authority_level + # @return [String] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level # @param authority_level [String] ('PUBLIC'|'PRIVATE') diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb index b152f005..26ce785f 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb @@ -14,12 +14,24 @@ module ManageAudience # Gets data for more than one audience. # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups class GetAudienceGroupsResponse - attr_accessor :audience_groups # An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. - attr_accessor :has_next_page # true when this is not the last page. - attr_accessor :total_count # The total number of audiences that can be returned with the specified filter. - attr_accessor :read_write_audience_group_total_count # Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. - attr_accessor :page # The current page number. - attr_accessor :size # The maximum number of audiences on the current page. + # @!attribute [rw] audience_groups + # @return [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + attr_accessor :audience_groups + # @!attribute [rw] has_next_page + # @return [Boolean] true when this is not the last page. + attr_accessor :has_next_page + # @!attribute [rw] total_count + # @return [Integer] The total number of audiences that can be returned with the specified filter. + attr_accessor :total_count + # @!attribute [rw] read_write_audience_group_total_count + # @return [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + attr_accessor :read_write_audience_group_total_count + # @!attribute [rw] page + # @return [Integer] The current page number. + attr_accessor :page + # @!attribute [rw] size + # @return [Integer] The maximum number of audiences on the current page. + attr_accessor :size # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. # @param has_next_page [Boolean] true when this is not the last page. diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb index 03e3c946..37aa775d 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb @@ -14,8 +14,14 @@ module ManageAudience # Get audience data # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class GetSharedAudienceDataResponse + # @!attribute [rw] audience_group + # @return [AudienceGroup] attr_accessor :audience_group - attr_accessor :jobs # An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @!attribute [rw] jobs + # @return [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + attr_accessor :jobs + # @!attribute [rw] owner + # @return [DetailedOwner] attr_accessor :owner # @param audience_group [AudienceGroup] diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb index 5c6381cd..117bc8bf 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb @@ -14,12 +14,24 @@ module ManageAudience # Gets data for more than one audience. # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups class GetSharedAudienceGroupsResponse - attr_accessor :audience_groups # An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. - attr_accessor :has_next_page # true when this is not the last page. - attr_accessor :total_count # The total number of audiences that can be returned with the specified filter. - attr_accessor :read_write_audience_group_total_count # Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. - attr_accessor :page # The current page number. - attr_accessor :size # The maximum number of audiences on the current page. + # @!attribute [rw] audience_groups + # @return [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + attr_accessor :audience_groups + # @!attribute [rw] has_next_page + # @return [Boolean] true when this is not the last page. + attr_accessor :has_next_page + # @!attribute [rw] total_count + # @return [Integer] The total number of audiences that can be returned with the specified filter. + attr_accessor :total_count + # @!attribute [rw] read_write_audience_group_total_count + # @return [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + attr_accessor :read_write_audience_group_total_count + # @!attribute [rw] page + # @return [Integer] The current page number. + attr_accessor :page + # @!attribute [rw] size + # @return [Integer] The maximum number of audiences on the current page. + attr_accessor :size # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. # @param has_next_page [Boolean] true when this is not the last page. diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb index 92558346..1bc82558 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb @@ -14,6 +14,8 @@ module ManageAudience # Change the authority level of the audience # @see https://developers.line.biz/en/reference/messaging-api/#change-authority-level class UpdateAudienceGroupAuthorityLevelRequest + # @!attribute [rw] authority_level + # @return [String] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level # @param authority_level [String] ('PUBLIC'|'PRIVATE') diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb index efcb78df..bf0d91ac 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb @@ -14,7 +14,9 @@ module ManageAudience # Rename an audience # @see https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group class UpdateAudienceGroupDescriptionRequest - attr_accessor :description # The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @!attribute [rw] description + # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + attr_accessor :description # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/action.rb b/lib/line/bot/v2/messaging_api/model/action.rb index ed71e75a..c5d4c572 100644 --- a/lib/line/bot/v2/messaging_api/model/action.rb +++ b/lib/line/bot/v2/messaging_api/model/action.rb @@ -14,8 +14,12 @@ module MessagingApi # Action # @see https://developers.line.biz/en/reference/messaging-api/#action-objects class Action - attr_accessor :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [rw] type + # @return [String] Type of action + attr_accessor :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label # @param type [String] Type of action # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb index f2bf5850..01799afc 100644 --- a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb @@ -14,8 +14,14 @@ module Bot module V2 module MessagingApi class AgeDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] gte + # @return [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') attr_accessor :gte + # @!attribute [rw] lt + # @return [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') attr_accessor :lt # @param gte [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') diff --git a/lib/line/bot/v2/messaging_api/model/all_mention_target.rb b/lib/line/bot/v2/messaging_api/model/all_mention_target.rb index 209d03a5..a57f97e9 100644 --- a/lib/line/bot/v2/messaging_api/model/all_mention_target.rb +++ b/lib/line/bot/v2/messaging_api/model/all_mention_target.rb @@ -15,7 +15,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mentionee-all class AllMentionTarget < MentionTarget - attr_reader :type # Target to be mentioned + # @!attribute [r] type + # @return [String] Target to be mentioned + attr_reader :type def initialize( **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/alt_uri.rb b/lib/line/bot/v2/messaging_api/model/alt_uri.rb index 3006ecb7..cd820318 100644 --- a/lib/line/bot/v2/messaging_api/model/alt_uri.rb +++ b/lib/line/bot/v2/messaging_api/model/alt_uri.rb @@ -12,6 +12,8 @@ module Bot module V2 module MessagingApi class AltUri + # @!attribute [rw] desktop + # @return [String] attr_accessor :desktop # @param desktop [String] diff --git a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb index 936f3efc..9519c185 100644 --- a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class AppTypeDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] one_of + # @return [Array['ios'|'android']] attr_accessor :one_of # @param one_of [Array['ios'|'android']] diff --git a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb index d451f61a..95bd08ac 100644 --- a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class AreaDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] one_of + # @return [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12']] attr_accessor :one_of # @param one_of [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12']] diff --git a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb index e85f586d..50b3d200 100644 --- a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class AudienceRecipient < Recipient - attr_reader :type # Type of recipient + # @!attribute [r] type + # @return [String] Type of recipient + attr_reader :type + # @!attribute [rw] audience_group_id + # @return [Integer] attr_accessor :audience_group_id # @param audience_group_id [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/audio_message.rb b/lib/line/bot/v2/messaging_api/model/audio_message.rb index d4ee7fda..5719552f 100644 --- a/lib/line/bot/v2/messaging_api/model/audio_message.rb +++ b/lib/line/bot/v2/messaging_api/model/audio_message.rb @@ -15,10 +15,20 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#audio-message class AudioMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] original_content_url + # @return [String] attr_accessor :original_content_url + # @!attribute [rw] duration + # @return [Integer] attr_accessor :duration # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb index 705ff656..0471f39b 100644 --- a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb +++ b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb @@ -13,13 +13,27 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-bot-info class BotInfoResponse - attr_accessor :user_id # Bot's user ID - attr_accessor :basic_id # Bot's basic ID - attr_accessor :premium_id # Bot's premium ID. Not included in the response if the premium ID isn't set. - attr_accessor :display_name # Bot's display name - attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. - attr_accessor :chat_mode # Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". - attr_accessor :mark_as_read_mode # Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned. `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled. + # @!attribute [rw] user_id + # @return [String] Bot's user ID + attr_accessor :user_id + # @!attribute [rw] basic_id + # @return [String] Bot's basic ID + attr_accessor :basic_id + # @!attribute [rw] premium_id + # @return [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + attr_accessor :premium_id + # @!attribute [rw] display_name + # @return [String] Bot's display name + attr_accessor :display_name + # @!attribute [rw] picture_url + # @return [String] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. + attr_accessor :picture_url + # @!attribute [rw] chat_mode + # @return [String] ('chat'|'bot') Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". + attr_accessor :chat_mode + # @!attribute [rw] mark_as_read_mode + # @return [String] ('auto'|'manual') Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned. `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled. + attr_accessor :mark_as_read_mode # @param user_id [String] Bot's user ID # @param basic_id [String] Bot's basic ID diff --git a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb index 25a7d35a..da123f91 100644 --- a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message class BroadcastRequest - attr_accessor :messages # List of Message objects. - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @!attribute [rw] messages + # @return [Array[Message]] List of Message objects. + attr_accessor :messages + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled # @param messages [Array[Message]] List of Message objects. # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. diff --git a/lib/line/bot/v2/messaging_api/model/buttons_template.rb b/lib/line/bot/v2/messaging_api/model/buttons_template.rb index 28f8217c..825f79dd 100644 --- a/lib/line/bot/v2/messaging_api/model/buttons_template.rb +++ b/lib/line/bot/v2/messaging_api/model/buttons_template.rb @@ -14,14 +14,32 @@ module Bot module V2 module MessagingApi class ButtonsTemplate < Template + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] thumbnail_image_url + # @return [String] attr_accessor :thumbnail_image_url + # @!attribute [rw] image_aspect_ratio + # @return [String] attr_accessor :image_aspect_ratio + # @!attribute [rw] image_size + # @return [String] attr_accessor :image_size + # @!attribute [rw] image_background_color + # @return [String] attr_accessor :image_background_color + # @!attribute [rw] title + # @return [String] attr_accessor :title + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] default_action + # @return [Action] attr_accessor :default_action + # @!attribute [rw] actions + # @return [Array[Action]] attr_accessor :actions # @param thumbnail_image_url [String] diff --git a/lib/line/bot/v2/messaging_api/model/camera_action.rb b/lib/line/bot/v2/messaging_api/model/camera_action.rb index 4582a363..28ffccf9 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_action.rb @@ -14,8 +14,12 @@ module Bot module V2 module MessagingApi class CameraAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label # @param label [String] Label for the action. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb index b9e0449b..45a8484a 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb @@ -14,8 +14,12 @@ module Bot module V2 module MessagingApi class CameraRollAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label # @param label [String] Label for the action. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/carousel_column.rb b/lib/line/bot/v2/messaging_api/model/carousel_column.rb index 956c8357..27b14819 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_column.rb @@ -13,11 +13,23 @@ module V2 module MessagingApi # Column object for carousel template. class CarouselColumn + # @!attribute [rw] thumbnail_image_url + # @return [String] attr_accessor :thumbnail_image_url + # @!attribute [rw] image_background_color + # @return [String] attr_accessor :image_background_color + # @!attribute [rw] title + # @return [String] attr_accessor :title + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] default_action + # @return [Action] attr_accessor :default_action + # @!attribute [rw] actions + # @return [Array[Action]] attr_accessor :actions # @param thumbnail_image_url [String] diff --git a/lib/line/bot/v2/messaging_api/model/carousel_template.rb b/lib/line/bot/v2/messaging_api/model/carousel_template.rb index c3c0ee74..5d8de097 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_template.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class CarouselTemplate < Template + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] columns + # @return [Array[CarouselColumn]] attr_accessor :columns + # @!attribute [rw] image_aspect_ratio + # @return [String] attr_accessor :image_aspect_ratio + # @!attribute [rw] image_size + # @return [String] attr_accessor :image_size # @param columns [Array[CarouselColumn]] diff --git a/lib/line/bot/v2/messaging_api/model/chat_reference.rb b/lib/line/bot/v2/messaging_api/model/chat_reference.rb index 113af431..dbd669b1 100644 --- a/lib/line/bot/v2/messaging_api/model/chat_reference.rb +++ b/lib/line/bot/v2/messaging_api/model/chat_reference.rb @@ -14,7 +14,9 @@ module MessagingApi # Chat reference # @see https://developers.line.biz/en/reference/partner-docs/#mark-messages-from-users-as-read class ChatReference - attr_accessor :user_id # The target user ID + # @!attribute [rw] user_id + # @return [String] The target user ID + attr_accessor :user_id # @param user_id [String] The target user ID def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb index 0fd67973..62c57909 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb @@ -15,9 +15,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#clipboard-action class ClipboardAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. - attr_accessor :clipboard_text # Text that is copied to the clipboard. Max character limit: 1000 + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] clipboard_text + # @return [String] Text that is copied to the clipboard. Max character limit: 1000 + attr_accessor :clipboard_text # @param label [String] Label for the action. # @param clipboard_text [String] Text that is copied to the clipboard. Max character limit: 1000 diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb index 1e99c194..283e5510 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb @@ -15,9 +15,17 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#imagemap-clipboard-action-object class ClipboardImagemapAction < ImagemapAction + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] area + # @return [ImagemapArea] attr_accessor :area - attr_accessor :clipboard_text # Text that is copied to the clipboard. Max character limit: 1000 + # @!attribute [rw] clipboard_text + # @return [String] Text that is copied to the clipboard. Max character limit: 1000 + attr_accessor :clipboard_text + # @!attribute [rw] label + # @return [String] attr_accessor :label # @param area [ImagemapArea] diff --git a/lib/line/bot/v2/messaging_api/model/confirm_template.rb b/lib/line/bot/v2/messaging_api/model/confirm_template.rb index 5b920db3..9d9f872d 100644 --- a/lib/line/bot/v2/messaging_api/model/confirm_template.rb +++ b/lib/line/bot/v2/messaging_api/model/confirm_template.rb @@ -14,8 +14,14 @@ module Bot module V2 module MessagingApi class ConfirmTemplate < Template + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] actions + # @return [Array[Action]] attr_accessor :actions # @param text [String] diff --git a/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb b/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb index 79ca2190..895de0d5 100644 --- a/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb +++ b/lib/line/bot/v2/messaging_api/model/create_rich_menu_alias_request.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias class CreateRichMenuAliasRequest - attr_accessor :rich_menu_alias_id # Rich menu alias ID, which can be any ID, unique for each channel. - attr_accessor :rich_menu_id # The rich menu ID to be associated with the rich menu alias. + # @!attribute [rw] rich_menu_alias_id + # @return [String] Rich menu alias ID, which can be any ID, unique for each channel. + attr_accessor :rich_menu_alias_id + # @!attribute [rw] rich_menu_id + # @return [String] The rich menu ID to be associated with the rich menu alias. + attr_accessor :rich_menu_id # @param rich_menu_alias_id [String] Rich menu alias ID, which can be any ID, unique for each channel. # @param rich_menu_id [String] The rich menu ID to be associated with the rich menu alias. diff --git a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb index 97f0e261..96cbf86f 100644 --- a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb +++ b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb @@ -15,12 +15,26 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action class DatetimePickerAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String] attr_accessor :data + # @!attribute [rw] mode + # @return [String] ('date'|'time'|'datetime') attr_accessor :mode + # @!attribute [rw] initial + # @return [String] attr_accessor :initial + # @!attribute [rw] max + # @return [String] attr_accessor :max + # @!attribute [rw] min + # @return [String] attr_accessor :min # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb index 27b030bf..081c1efb 100644 --- a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # Demographic filter class DemographicFilter - attr_accessor :type # Type of demographic filter + # @!attribute [rw] type + # @return [String] Type of demographic filter + attr_accessor :type # @param type [String] Type of demographic filter def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/emoji.rb b/lib/line/bot/v2/messaging_api/model/emoji.rb index 236f1cc7..5f1c3afc 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji.rb @@ -12,8 +12,14 @@ module Bot module V2 module MessagingApi class Emoji + # @!attribute [rw] index + # @return [Integer] attr_accessor :index + # @!attribute [rw] product_id + # @return [String] attr_accessor :product_id + # @!attribute [rw] emoji_id + # @return [String] attr_accessor :emoji_id # @param index [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb b/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb index 9aeb1695..2725d040 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb @@ -16,8 +16,14 @@ module MessagingApi # An object representing a emoji substitution. # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2-emoji-object class EmojiSubstitutionObject < SubstitutionObject - attr_reader :type # Type of substitution object + # @!attribute [r] type + # @return [String] Type of substitution object + attr_reader :type + # @!attribute [rw] product_id + # @return [String] attr_accessor :product_id + # @!attribute [rw] emoji_id + # @return [String] attr_accessor :emoji_id # @param product_id [String] diff --git a/lib/line/bot/v2/messaging_api/model/error_detail.rb b/lib/line/bot/v2/messaging_api/model/error_detail.rb index bccbd937..2709ff7f 100644 --- a/lib/line/bot/v2/messaging_api/model/error_detail.rb +++ b/lib/line/bot/v2/messaging_api/model/error_detail.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class ErrorDetail - attr_accessor :message # Details of the error. Not included in the response under certain situations. - attr_accessor :property # Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @!attribute [rw] message + # @return [String] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + attr_accessor :property # @param message [String] Details of the error. Not included in the response under certain situations. # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. diff --git a/lib/line/bot/v2/messaging_api/model/error_response.rb b/lib/line/bot/v2/messaging_api/model/error_response.rb index c6ffe1a5..97f886f4 100644 --- a/lib/line/bot/v2/messaging_api/model/error_response.rb +++ b/lib/line/bot/v2/messaging_api/model/error_response.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#error-responses class ErrorResponse - attr_accessor :message # Message containing information about the error. - attr_accessor :details # An array of error details. If the array is empty, this property will not be included in the response. - attr_accessor :sent_messages # Array of sent messages. + # @!attribute [rw] message + # @return [String] Message containing information about the error. + attr_accessor :message + # @!attribute [rw] details + # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + attr_accessor :details + # @!attribute [rw] sent_messages + # @return [Array[SentMessage]] Array of sent messages. + attr_accessor :sent_messages # @param message [String] Message containing information about the error. # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. diff --git a/lib/line/bot/v2/messaging_api/model/filter.rb b/lib/line/bot/v2/messaging_api/model/filter.rb index 724859a1..d4b98bc7 100644 --- a/lib/line/bot/v2/messaging_api/model/filter.rb +++ b/lib/line/bot/v2/messaging_api/model/filter.rb @@ -13,6 +13,8 @@ module V2 module MessagingApi # Filter for narrowcast class Filter + # @!attribute [rw] demographic + # @return [DemographicFilter] attr_accessor :demographic # @param demographic [DemographicFilter] diff --git a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb index fdd56f52..d6f22308 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb @@ -12,8 +12,14 @@ module Bot module V2 module MessagingApi class FlexBlockStyle + # @!attribute [rw] background_color + # @return [String] attr_accessor :background_color + # @!attribute [rw] separator + # @return [Boolean] attr_accessor :separator + # @!attribute [rw] separator_color + # @return [String] attr_accessor :separator_color # @param background_color [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_box.rb b/lib/line/bot/v2/messaging_api/model/flex_box.rb index 850f2219..68d01540 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box.rb @@ -14,33 +14,89 @@ module Bot module V2 module MessagingApi class FlexBox < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] layout + # @return [String] ('horizontal'|'vertical'|'baseline') attr_accessor :layout + # @!attribute [rw] flex + # @return [Integer] attr_accessor :flex + # @!attribute [rw] contents + # @return [Array[FlexComponent]] attr_accessor :contents + # @!attribute [rw] spacing + # @return [String] attr_accessor :spacing + # @!attribute [rw] margin + # @return [String] attr_accessor :margin + # @!attribute [rw] position + # @return [String] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String] attr_accessor :offset_end + # @!attribute [rw] background_color + # @return [String] attr_accessor :background_color + # @!attribute [rw] border_color + # @return [String] attr_accessor :border_color + # @!attribute [rw] border_width + # @return [String] attr_accessor :border_width + # @!attribute [rw] corner_radius + # @return [String] attr_accessor :corner_radius + # @!attribute [rw] width + # @return [String] attr_accessor :width + # @!attribute [rw] max_width + # @return [String] attr_accessor :max_width + # @!attribute [rw] height + # @return [String] attr_accessor :height + # @!attribute [rw] max_height + # @return [String] attr_accessor :max_height + # @!attribute [rw] padding_all + # @return [String] attr_accessor :padding_all + # @!attribute [rw] padding_top + # @return [String] attr_accessor :padding_top + # @!attribute [rw] padding_bottom + # @return [String] attr_accessor :padding_bottom + # @!attribute [rw] padding_start + # @return [String] attr_accessor :padding_start + # @!attribute [rw] padding_end + # @return [String] attr_accessor :padding_end + # @!attribute [rw] action + # @return [Action] attr_accessor :action + # @!attribute [rw] justify_content + # @return [String] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') attr_accessor :justify_content + # @!attribute [rw] align_items + # @return [String] ('center'|'flex-start'|'flex-end') attr_accessor :align_items + # @!attribute [rw] background + # @return [FlexBoxBackground] attr_accessor :background # @param layout [String] ('horizontal'|'vertical'|'baseline') diff --git a/lib/line/bot/v2/messaging_api/model/flex_box_background.rb b/lib/line/bot/v2/messaging_api/model/flex_box_background.rb index cf094c91..572197a4 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box_background.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box_background.rb @@ -12,6 +12,8 @@ module Bot module V2 module MessagingApi class FlexBoxBackground + # @!attribute [rw] type + # @return [String] attr_accessor :type # @param type [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb index 19e42ef7..11a05f22 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb @@ -14,11 +14,23 @@ module Bot module V2 module MessagingApi class FlexBoxLinearGradient < FlexBoxBackground + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] angle + # @return [String] attr_accessor :angle + # @!attribute [rw] start_color + # @return [String] attr_accessor :start_color + # @!attribute [rw] end_color + # @return [String] attr_accessor :end_color + # @!attribute [rw] center_color + # @return [String] attr_accessor :center_color + # @!attribute [rw] center_position + # @return [String] attr_accessor :center_position # @param angle [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb index 0821b2fa..63126699 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb @@ -14,14 +14,32 @@ module Bot module V2 module MessagingApi class FlexBubble < FlexContainer + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] direction + # @return [String] ('ltr'|'rtl') attr_accessor :direction + # @!attribute [rw] styles + # @return [FlexBubbleStyles] attr_accessor :styles + # @!attribute [rw] header + # @return [FlexBox] attr_accessor :header + # @!attribute [rw] hero + # @return [FlexComponent] attr_accessor :hero + # @!attribute [rw] body + # @return [FlexBox] attr_accessor :body + # @!attribute [rw] footer + # @return [FlexBox] attr_accessor :footer + # @!attribute [rw] size + # @return [String] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') attr_accessor :size + # @!attribute [rw] action + # @return [Action] attr_accessor :action # @param direction [String] ('ltr'|'rtl') diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb index a267456b..efa22fc3 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb @@ -12,9 +12,17 @@ module Bot module V2 module MessagingApi class FlexBubbleStyles + # @!attribute [rw] header + # @return [FlexBlockStyle] attr_accessor :header + # @!attribute [rw] hero + # @return [FlexBlockStyle] attr_accessor :hero + # @!attribute [rw] body + # @return [FlexBlockStyle] attr_accessor :body + # @!attribute [rw] footer + # @return [FlexBlockStyle] attr_accessor :footer # @param header [FlexBlockStyle] diff --git a/lib/line/bot/v2/messaging_api/model/flex_button.rb b/lib/line/bot/v2/messaging_api/model/flex_button.rb index f3f54afa..697ee676 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_button.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_button.rb @@ -14,20 +14,50 @@ module Bot module V2 module MessagingApi class FlexButton < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer] attr_accessor :flex + # @!attribute [rw] color + # @return [String] attr_accessor :color + # @!attribute [rw] style + # @return [String] ('primary'|'secondary'|'link') attr_accessor :style + # @!attribute [rw] action + # @return [Action] attr_accessor :action + # @!attribute [rw] gravity + # @return [String] ('top'|'bottom'|'center') attr_accessor :gravity + # @!attribute [rw] margin + # @return [String] attr_accessor :margin + # @!attribute [rw] position + # @return [String] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String] attr_accessor :offset_end + # @!attribute [rw] height + # @return [String] ('md'|'sm') attr_accessor :height + # @!attribute [rw] adjust_mode + # @return [String] ('shrink-to-fit') attr_accessor :adjust_mode + # @!attribute [rw] scaling + # @return [Boolean] attr_accessor :scaling # @param flex [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/flex_carousel.rb b/lib/line/bot/v2/messaging_api/model/flex_carousel.rb index 19acd6c4..d7a95b01 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_carousel.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_carousel.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class FlexCarousel < FlexContainer + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] contents + # @return [Array[FlexBubble]] attr_accessor :contents # @param contents [Array[FlexBubble]] diff --git a/lib/line/bot/v2/messaging_api/model/flex_component.rb b/lib/line/bot/v2/messaging_api/model/flex_component.rb index c97ce71a..4d2418ab 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_component.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_component.rb @@ -12,6 +12,8 @@ module Bot module V2 module MessagingApi class FlexComponent + # @!attribute [rw] type + # @return [String] attr_accessor :type # @param type [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_container.rb b/lib/line/bot/v2/messaging_api/model/flex_container.rb index adf5d3ee..406c1242 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_container.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_container.rb @@ -12,6 +12,8 @@ module Bot module V2 module MessagingApi class FlexContainer + # @!attribute [rw] type + # @return [String] attr_accessor :type # @param type [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_filler.rb b/lib/line/bot/v2/messaging_api/model/flex_filler.rb index f5c3b8d8..d9f2c2ba 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_filler.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_filler.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class FlexFiller < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer] attr_accessor :flex # @param flex [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/flex_icon.rb b/lib/line/bot/v2/messaging_api/model/flex_icon.rb index 58489036..6a2a5c99 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_icon.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_icon.rb @@ -15,16 +15,38 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#icon class FlexIcon < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] url + # @return [String] attr_accessor :url + # @!attribute [rw] size + # @return [String] attr_accessor :size + # @!attribute [rw] aspect_ratio + # @return [String] attr_accessor :aspect_ratio + # @!attribute [rw] margin + # @return [String] attr_accessor :margin + # @!attribute [rw] position + # @return [String] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String] attr_accessor :offset_end + # @!attribute [rw] scaling + # @return [Boolean] attr_accessor :scaling # @param url [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_image.rb b/lib/line/bot/v2/messaging_api/model/flex_image.rb index ae17b240..6404eb8b 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_image.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_image.rb @@ -15,23 +15,57 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#f-image class FlexImage < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type - attr_accessor :url # Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) - attr_accessor :flex # The ratio of the width or height of this component within the parent box. - attr_accessor :margin # The minimum amount of space to include before this component in its parent container. - attr_accessor :position # Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. - attr_accessor :offset_top # Offset. - attr_accessor :offset_bottom # Offset. - attr_accessor :offset_start # Offset. - attr_accessor :offset_end # Offset. - attr_accessor :align # Alignment style in horizontal direction. - attr_accessor :gravity # Alignment style in vertical direction. - attr_accessor :size # The maximum image width. This is md by default. - attr_accessor :aspect_ratio # Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. - attr_accessor :aspect_mode # The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. - attr_accessor :background_color # Background color of the image. Use a hexadecimal color code. + # @!attribute [rw] url + # @return [String] Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) + attr_accessor :url + # @!attribute [rw] flex + # @return [Integer] The ratio of the width or height of this component within the parent box. + attr_accessor :flex + # @!attribute [rw] margin + # @return [String] The minimum amount of space to include before this component in its parent container. + attr_accessor :margin + # @!attribute [rw] position + # @return [String] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. + attr_accessor :position + # @!attribute [rw] offset_top + # @return [String] Offset. + attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String] Offset. + attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String] Offset. + attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String] Offset. + attr_accessor :offset_end + # @!attribute [rw] align + # @return [String] ('start'|'end'|'center') Alignment style in horizontal direction. + attr_accessor :align + # @!attribute [rw] gravity + # @return [String] ('top'|'bottom'|'center') Alignment style in vertical direction. + attr_accessor :gravity + # @!attribute [rw] size + # @return [String] The maximum image width. This is md by default. + attr_accessor :size + # @!attribute [rw] aspect_ratio + # @return [String] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. + attr_accessor :aspect_ratio + # @!attribute [rw] aspect_mode + # @return [String] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. + attr_accessor :aspect_mode + # @!attribute [rw] background_color + # @return [String] Background color of the image. Use a hexadecimal color code. + attr_accessor :background_color + # @!attribute [rw] action + # @return [Action] attr_accessor :action - attr_accessor :animated # When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. + # @!attribute [rw] animated + # @return [Boolean] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. + attr_accessor :animated # @param url [String] Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) # @param flex [Integer] The ratio of the width or height of this component within the parent box. diff --git a/lib/line/bot/v2/messaging_api/model/flex_message.rb b/lib/line/bot/v2/messaging_api/model/flex_message.rb index d17ba1c1..751675c3 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_message.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_message.rb @@ -15,10 +15,20 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#flex-message class FlexMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] alt_text + # @return [String] attr_accessor :alt_text + # @!attribute [rw] contents + # @return [FlexContainer] attr_accessor :contents # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/flex_separator.rb b/lib/line/bot/v2/messaging_api/model/flex_separator.rb index 75b48b5f..d6c83b3b 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_separator.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_separator.rb @@ -14,8 +14,14 @@ module Bot module V2 module MessagingApi class FlexSeparator < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] margin + # @return [String] attr_accessor :margin + # @!attribute [rw] color + # @return [String] attr_accessor :color # @param margin [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_span.rb b/lib/line/bot/v2/messaging_api/model/flex_span.rb index 2c839fee..f08504ae 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_span.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_span.rb @@ -14,12 +14,26 @@ module Bot module V2 module MessagingApi class FlexSpan < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] size + # @return [String] attr_accessor :size + # @!attribute [rw] color + # @return [String] attr_accessor :color + # @!attribute [rw] weight + # @return [String] ('regular'|'bold') attr_accessor :weight + # @!attribute [rw] style + # @return [String] ('normal'|'italic') attr_accessor :style + # @!attribute [rw] decoration + # @return [String] ('none'|'underline'|'line-through') attr_accessor :decoration # @param text [String] diff --git a/lib/line/bot/v2/messaging_api/model/flex_text.rb b/lib/line/bot/v2/messaging_api/model/flex_text.rb index 560de659..195d04d1 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_text.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_text.rb @@ -14,28 +14,74 @@ module Bot module V2 module MessagingApi class FlexText < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer] attr_accessor :flex + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] size + # @return [String] attr_accessor :size + # @!attribute [rw] align + # @return [String] ('start'|'end'|'center') attr_accessor :align + # @!attribute [rw] gravity + # @return [String] ('top'|'bottom'|'center') attr_accessor :gravity + # @!attribute [rw] color + # @return [String] attr_accessor :color + # @!attribute [rw] weight + # @return [String] ('regular'|'bold') attr_accessor :weight + # @!attribute [rw] style + # @return [String] ('normal'|'italic') attr_accessor :style + # @!attribute [rw] decoration + # @return [String] ('none'|'underline'|'line-through') attr_accessor :decoration + # @!attribute [rw] wrap + # @return [Boolean] attr_accessor :wrap + # @!attribute [rw] line_spacing + # @return [String] attr_accessor :line_spacing + # @!attribute [rw] margin + # @return [String] attr_accessor :margin + # @!attribute [rw] position + # @return [String] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String] attr_accessor :offset_end + # @!attribute [rw] action + # @return [Action] attr_accessor :action + # @!attribute [rw] max_lines + # @return [Integer] attr_accessor :max_lines + # @!attribute [rw] contents + # @return [Array[FlexSpan]] attr_accessor :contents + # @!attribute [rw] adjust_mode + # @return [String] ('shrink-to-fit') attr_accessor :adjust_mode + # @!attribute [rw] scaling + # @return [Boolean] attr_accessor :scaling # @param flex [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/flex_video.rb b/lib/line/bot/v2/messaging_api/model/flex_video.rb index ce43e185..374bfd65 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_video.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_video.rb @@ -14,11 +14,23 @@ module Bot module V2 module MessagingApi class FlexVideo < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] url + # @return [String] attr_accessor :url + # @!attribute [rw] preview_url + # @return [String] attr_accessor :preview_url + # @!attribute [rw] alt_content + # @return [FlexComponent] attr_accessor :alt_content + # @!attribute [rw] aspect_ratio + # @return [String] attr_accessor :aspect_ratio + # @!attribute [rw] action + # @return [Action] attr_accessor :action # @param url [String] diff --git a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb index 844b9f77..10355155 100644 --- a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class GenderDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] one_of + # @return [Array['male'|'female']] attr_accessor :one_of # @param one_of [Array['male'|'female']] diff --git a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb index d541b09e..ce3e7f4b 100644 --- a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month class GetAggregationUnitNameListResponse - attr_accessor :custom_aggregation_units # An array of strings indicating the names of aggregation units used this month. - attr_accessor :_next # A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. + # @!attribute [rw] custom_aggregation_units + # @return [Array[String]] An array of strings indicating the names of aggregation units used this month. + attr_accessor :custom_aggregation_units + # @!attribute [rw] _next + # @return [String] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. + attr_accessor :_next # @param custom_aggregation_units [Array[String]] An array of strings indicating the names of aggregation units used this month. # @param _next [String] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. diff --git a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb index 17297e04..61016b85 100644 --- a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month class GetAggregationUnitUsageResponse - attr_accessor :num_of_custom_aggregation_units # Number of aggregation units used this month. + # @!attribute [rw] num_of_custom_aggregation_units + # @return [Integer] Number of aggregation units used this month. + attr_accessor :num_of_custom_aggregation_units # @param num_of_custom_aggregation_units [Integer] Number of aggregation units used this month. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb index 06059d62..3de44189 100644 --- a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-follower-ids class GetFollowersResponse - attr_accessor :user_ids # An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. - attr_accessor :_next # A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. + # @!attribute [rw] user_ids + # @return [Array[String]] An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. + attr_accessor :user_ids + # @!attribute [rw] _next + # @return [String] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. + attr_accessor :_next # @param user_ids [Array[String]] An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. # @param _next [String] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. diff --git a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb index 30fed081..7d81d2a9 100644 --- a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb @@ -14,8 +14,12 @@ module MessagingApi # List of users who have joined the membership # @see https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids class GetJoinedMembershipUsersResponse - attr_accessor :user_ids # A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. - attr_accessor :_next # 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). + # @!attribute [rw] user_ids + # @return [Array[String]] A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. + attr_accessor :user_ids + # @!attribute [rw] _next + # @return [String] 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). + attr_accessor :_next # @param user_ids [Array[String]] A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. # @param _next [String] 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). diff --git a/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb b/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb index 9ebcd016..9b541ca8 100644 --- a/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb @@ -14,7 +14,9 @@ module MessagingApi # A user's membership subscription status # @see https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status class GetMembershipSubscriptionResponse - attr_accessor :subscriptions # List of subscription information + # @!attribute [rw] subscriptions + # @return [Array[Subscription]] List of subscription information + attr_accessor :subscriptions # @param subscriptions [Array[Subscription]] List of subscription information def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb b/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb index f68f6171..44f1667b 100644 --- a/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_message_content_transcoding_response.rb @@ -14,7 +14,9 @@ module MessagingApi # Transcoding response # @see https://developers.line.biz/en/reference/messaging-api/#verify-video-or-audio-preparation-status class GetMessageContentTranscodingResponse - attr_accessor :status # The preparation status. One of: `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content. + # @!attribute [rw] status + # @return [String] ('processing'|'succeeded'|'failed') The preparation status. One of: `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content. + attr_accessor :status # @param status [String] ('processing'|'succeeded'|'failed') The preparation status. One of: `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb b/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb index f2731f7d..226c155b 100644 --- a/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_webhook_endpoint_response.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-webhook-endpoint-information class GetWebhookEndpointResponse - attr_accessor :endpoint # Webhook URL - attr_accessor :active # Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. `true`: Webhook usage is enabled. `false`: Webhook usage is disabled. + # @!attribute [rw] endpoint + # @return [String] Webhook URL + attr_accessor :endpoint + # @!attribute [rw] active + # @return [Boolean] Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. `true`: Webhook usage is enabled. `false`: Webhook usage is disabled. + attr_accessor :active # @param endpoint [String] Webhook URL # @param active [Boolean] Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. `true`: Webhook usage is enabled. `false`: Webhook usage is disabled. diff --git a/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb b/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb index e6c8ec70..d9a1c799 100644 --- a/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_member_count_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-members-group-count class GroupMemberCountResponse - attr_accessor :count # The count of members in the group chat. The number returned excludes the LINE Official Account. + # @!attribute [rw] count + # @return [Integer] The count of members in the group chat. The number returned excludes the LINE Official Account. + attr_accessor :count # @param count [Integer] The count of members in the group chat. The number returned excludes the LINE Official Account. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb index 5d4826b4..c3e5ffbb 100644 --- a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-group-summary class GroupSummaryResponse - attr_accessor :group_id # Group ID - attr_accessor :group_name # Group name - attr_accessor :picture_url # Group icon URL. Not included in the response if the user doesn't set a group profile icon. + # @!attribute [rw] group_id + # @return [String] Group ID + attr_accessor :group_id + # @!attribute [rw] group_name + # @return [String] Group name + attr_accessor :group_name + # @!attribute [rw] picture_url + # @return [String] Group icon URL. Not included in the response if the user doesn't set a group profile icon. + attr_accessor :picture_url # @param group_id [String] Group ID # @param group_name [String] Group name diff --git a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb index 02ddcdf9..816327fc 100644 --- a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile class GroupUserProfileResponse - attr_accessor :display_name # User's display name - attr_accessor :user_id # User ID - attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @!attribute [rw] display_name + # @return [String] User's display name + attr_accessor :display_name + # @!attribute [rw] user_id + # @return [String] User ID + attr_accessor :user_id + # @!attribute [rw] picture_url + # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + attr_accessor :picture_url # @param display_name [String] User's display name # @param user_id [String] User ID diff --git a/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb b/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb index e632c253..f15bde9d 100644 --- a/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb @@ -12,7 +12,11 @@ module Bot module V2 module MessagingApi class ImageCarouselColumn + # @!attribute [rw] image_url + # @return [String] attr_accessor :image_url + # @!attribute [rw] action + # @return [Action] attr_accessor :action # @param image_url [String] diff --git a/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb b/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb index 21f30570..391635ff 100644 --- a/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/image_carousel_template.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class ImageCarouselTemplate < Template + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] columns + # @return [Array[ImageCarouselColumn]] attr_accessor :columns # @param columns [Array[ImageCarouselColumn]] diff --git a/lib/line/bot/v2/messaging_api/model/image_message.rb b/lib/line/bot/v2/messaging_api/model/image_message.rb index fb5a61d4..7f9c4bba 100644 --- a/lib/line/bot/v2/messaging_api/model/image_message.rb +++ b/lib/line/bot/v2/messaging_api/model/image_message.rb @@ -15,10 +15,20 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#image-message class ImageMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] original_content_url + # @return [String] attr_accessor :original_content_url + # @!attribute [rw] preview_image_url + # @return [String] attr_accessor :preview_image_url # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/imagemap_action.rb index 683b355c..163f63d1 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_action.rb @@ -13,7 +13,11 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#imagemap-action-objects class ImagemapAction + # @!attribute [rw] type + # @return [String] attr_accessor :type + # @!attribute [rw] area + # @return [ImagemapArea] attr_accessor :area # @param type [String] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_area.rb b/lib/line/bot/v2/messaging_api/model/imagemap_area.rb index 91f5c001..e1a70f9a 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_area.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_area.rb @@ -12,9 +12,17 @@ module Bot module V2 module MessagingApi class ImagemapArea + # @!attribute [rw] x + # @return [Integer] attr_accessor :x + # @!attribute [rw] y + # @return [Integer] attr_accessor :y + # @!attribute [rw] width + # @return [Integer] attr_accessor :width + # @!attribute [rw] height + # @return [Integer] attr_accessor :height # @param x [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb b/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb index 0d8cd3a4..90a2f7e9 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_base_size.rb @@ -12,7 +12,11 @@ module Bot module V2 module MessagingApi class ImagemapBaseSize + # @!attribute [rw] height + # @return [Integer] attr_accessor :height + # @!attribute [rw] width + # @return [Integer] attr_accessor :width # @param height [Integer] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb index eb64f108..479420f9 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb @@ -12,7 +12,11 @@ module Bot module V2 module MessagingApi class ImagemapExternalLink + # @!attribute [rw] link_uri + # @return [String] attr_accessor :link_uri + # @!attribute [rw] label + # @return [String] attr_accessor :label # @param link_uri [String] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb index d6ff775b..03ba1bf6 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb @@ -15,13 +15,29 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#imagemap-message class ImagemapMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] base_url + # @return [String] attr_accessor :base_url + # @!attribute [rw] alt_text + # @return [String] attr_accessor :alt_text + # @!attribute [rw] base_size + # @return [ImagemapBaseSize] attr_accessor :base_size + # @!attribute [rw] actions + # @return [Array[ImagemapAction]] attr_accessor :actions + # @!attribute [rw] video + # @return [ImagemapVideo] attr_accessor :video # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb index 2ae3d964..fcaa3b49 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb @@ -12,9 +12,17 @@ module Bot module V2 module MessagingApi class ImagemapVideo + # @!attribute [rw] original_content_url + # @return [String] attr_accessor :original_content_url + # @!attribute [rw] preview_image_url + # @return [String] attr_accessor :preview_image_url + # @!attribute [rw] area + # @return [ImagemapArea] attr_accessor :area + # @!attribute [rw] external_link + # @return [ImagemapExternalLink] attr_accessor :external_link # @param original_content_url [String] diff --git a/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb b/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb index 8f48866e..e10e9ddb 100644 --- a/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb +++ b/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#issue-link-token class IssueLinkTokenResponse - attr_accessor :link_token # Link token. Link tokens are valid for 10 minutes and can only be used once. + # @!attribute [rw] link_token + # @return [String] Link token. Link tokens are valid for 10 minutes and can only be used once. + attr_accessor :link_token # @param link_token [String] Link token. Link tokens are valid for 10 minutes and can only be used once. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/limit.rb b/lib/line/bot/v2/messaging_api/model/limit.rb index 478d86eb..0aa7dca4 100644 --- a/lib/line/bot/v2/messaging_api/model/limit.rb +++ b/lib/line/bot/v2/messaging_api/model/limit.rb @@ -14,8 +14,12 @@ module MessagingApi # Limit of the Narrowcast # @see https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message class Limit - attr_accessor :max # The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. - attr_accessor :up_to_remaining_quota # If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. + # @!attribute [rw] max + # @return [Integer] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. + attr_accessor :max + # @!attribute [rw] up_to_remaining_quota + # @return [Boolean] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. + attr_accessor :up_to_remaining_quota # @param max [Integer] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. # @param up_to_remaining_quota [Boolean] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. diff --git a/lib/line/bot/v2/messaging_api/model/location_action.rb b/lib/line/bot/v2/messaging_api/model/location_action.rb index a80c5c32..9b3c8666 100644 --- a/lib/line/bot/v2/messaging_api/model/location_action.rb +++ b/lib/line/bot/v2/messaging_api/model/location_action.rb @@ -14,8 +14,12 @@ module Bot module V2 module MessagingApi class LocationAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label # @param label [String] Label for the action. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/location_message.rb b/lib/line/bot/v2/messaging_api/model/location_message.rb index a21fc182..b9525a9f 100644 --- a/lib/line/bot/v2/messaging_api/model/location_message.rb +++ b/lib/line/bot/v2/messaging_api/model/location_message.rb @@ -15,12 +15,26 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#location-message class LocationMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] title + # @return [String] attr_accessor :title + # @!attribute [rw] address + # @return [String] attr_accessor :address + # @!attribute [rw] latitude + # @return [Float] attr_accessor :latitude + # @!attribute [rw] longitude + # @return [Float] attr_accessor :longitude # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb b/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb index 783e7d00..e1463a76 100644 --- a/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb +++ b/lib/line/bot/v2/messaging_api/model/mark_messages_as_read_request.rb @@ -13,6 +13,8 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/partner-docs/#mark-messages-from-users-as-read class MarkMessagesAsReadRequest + # @!attribute [rw] chat + # @return [ChatReference] attr_accessor :chat # @param chat [ChatReference] diff --git a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb index b1f46fe5..5d08b902 100644 --- a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb +++ b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class MembersIdsResponse - attr_accessor :member_ids # List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. - attr_accessor :_next # A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. + # @!attribute [rw] member_ids + # @return [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. + attr_accessor :member_ids + # @!attribute [rw] _next + # @return [String] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. + attr_accessor :_next # @param member_ids [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. # @param _next [String] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. diff --git a/lib/line/bot/v2/messaging_api/model/membership.rb b/lib/line/bot/v2/messaging_api/model/membership.rb index 85946f8d..c7777b46 100644 --- a/lib/line/bot/v2/messaging_api/model/membership.rb +++ b/lib/line/bot/v2/messaging_api/model/membership.rb @@ -12,16 +12,36 @@ module Bot module V2 module MessagingApi class Membership - attr_accessor :membership_id # Membership plan ID. - attr_accessor :title # Membership plan name. - attr_accessor :description # Membership plan description. - attr_accessor :benefits # List of membership plan perks. - attr_accessor :price # Monthly fee for membership plan. (e.g. 1500.00) - attr_accessor :currency # The currency of membership.price. - attr_accessor :member_count # Number of members subscribed to the membership plan. - attr_accessor :member_limit # The upper limit of members who can subscribe. If no upper limit is set, it will be null. - attr_accessor :is_in_app_purchase # Payment method for users who subscribe to a membership plan. - attr_accessor :is_published # Membership plan status. + # @!attribute [rw] membership_id + # @return [Integer] Membership plan ID. + attr_accessor :membership_id + # @!attribute [rw] title + # @return [String] Membership plan name. + attr_accessor :title + # @!attribute [rw] description + # @return [String] Membership plan description. + attr_accessor :description + # @!attribute [rw] benefits + # @return [Array[String]] List of membership plan perks. + attr_accessor :benefits + # @!attribute [rw] price + # @return [Float] Monthly fee for membership plan. (e.g. 1500.00) + attr_accessor :price + # @!attribute [rw] currency + # @return [String] ('JPY'|'TWD'|'THB') The currency of membership.price. + attr_accessor :currency + # @!attribute [rw] member_count + # @return [Integer] Number of members subscribed to the membership plan. + attr_accessor :member_count + # @!attribute [rw] member_limit + # @return [Integer] The upper limit of members who can subscribe. If no upper limit is set, it will be null. + attr_accessor :member_limit + # @!attribute [rw] is_in_app_purchase + # @return [Boolean] Payment method for users who subscribe to a membership plan. + attr_accessor :is_in_app_purchase + # @!attribute [rw] is_published + # @return [Boolean] Membership plan status. + attr_accessor :is_published # @param membership_id [Integer] Membership plan ID. # @param title [String] Membership plan name. diff --git a/lib/line/bot/v2/messaging_api/model/membership_list_response.rb b/lib/line/bot/v2/messaging_api/model/membership_list_response.rb index 4af20af6..ea9132c0 100644 --- a/lib/line/bot/v2/messaging_api/model/membership_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/membership_list_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # List of memberships class MembershipListResponse - attr_accessor :memberships # List of membership information + # @!attribute [rw] memberships + # @return [Array[Membership]] List of membership information + attr_accessor :memberships # @param memberships [Array[Membership]] List of membership information def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb b/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb index 9b24a298..054132a0 100644 --- a/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/mention_substitution_object.rb @@ -16,7 +16,11 @@ module MessagingApi # An object representing a mention substitution. # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mention-object class MentionSubstitutionObject < SubstitutionObject - attr_reader :type # Type of substitution object + # @!attribute [r] type + # @return [String] Type of substitution object + attr_reader :type + # @!attribute [rw] mentionee + # @return [MentionTarget] attr_accessor :mentionee # @param mentionee [MentionTarget] diff --git a/lib/line/bot/v2/messaging_api/model/mention_target.rb b/lib/line/bot/v2/messaging_api/model/mention_target.rb index 1c524730..e4d5568b 100644 --- a/lib/line/bot/v2/messaging_api/model/mention_target.rb +++ b/lib/line/bot/v2/messaging_api/model/mention_target.rb @@ -12,7 +12,9 @@ module Bot module V2 module MessagingApi class MentionTarget - attr_accessor :type # Target to be mentioned + # @!attribute [rw] type + # @return [String] Target to be mentioned + attr_accessor :type # @param type [String] Target to be mentioned def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/message.rb b/lib/line/bot/v2/messaging_api/model/message.rb index ff91f0db..5ff52836 100644 --- a/lib/line/bot/v2/messaging_api/model/message.rb +++ b/lib/line/bot/v2/messaging_api/model/message.rb @@ -13,8 +13,14 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#message-common-properties class Message - attr_accessor :type # Type of message + # @!attribute [rw] type + # @return [String] Type of message + attr_accessor :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender # @param type [String] Type of message diff --git a/lib/line/bot/v2/messaging_api/model/message_action.rb b/lib/line/bot/v2/messaging_api/model/message_action.rb index 4701ceae..0af3341a 100644 --- a/lib/line/bot/v2/messaging_api/model/message_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_action.rb @@ -14,8 +14,14 @@ module Bot module V2 module MessagingApi class MessageAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] text + # @return [String] attr_accessor :text # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb index 01f63aac..d60e69da 100644 --- a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class MessageImagemapAction < ImagemapAction + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] area + # @return [ImagemapArea] attr_accessor :area + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] label + # @return [String] attr_accessor :label # @param area [ImagemapArea] diff --git a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb index 0c847bce..889db93a 100644 --- a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb +++ b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-quota class MessageQuotaResponse + # @!attribute [rw] type + # @return [String] ('none'|'limited') attr_accessor :type - attr_accessor :value # The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. + # @!attribute [rw] value + # @return [Integer] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. + attr_accessor :value # @param type [String] ('none'|'limited') # @param value [Integer] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. diff --git a/lib/line/bot/v2/messaging_api/model/multicast_request.rb b/lib/line/bot/v2/messaging_api/model/multicast_request.rb index 26fbdb76..424ec485 100644 --- a/lib/line/bot/v2/messaging_api/model/multicast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/multicast_request.rb @@ -13,10 +13,18 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-multicast-message class MulticastRequest - attr_accessor :messages # Messages to send - attr_accessor :to # Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. - attr_accessor :custom_aggregation_units # Name of aggregation unit. Case-sensitive. + # @!attribute [rw] messages + # @return [Array[Message]] Messages to send + attr_accessor :messages + # @!attribute [rw] to + # @return [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. + attr_accessor :to + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled + # @!attribute [rw] custom_aggregation_units + # @return [Array[String]] Name of aggregation unit. Case-sensitive. + attr_accessor :custom_aggregation_units # @param messages [Array[Message]] Messages to send # @param to [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb index 1fec9e5d..ec29d731 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb @@ -13,14 +13,30 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status class NarrowcastProgressResponse - attr_accessor :phase # The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. - attr_accessor :success_count # The number of users who successfully received the message. - attr_accessor :failure_count # The number of users who failed to send the message. - attr_accessor :target_count # The number of intended recipients of the message. - attr_accessor :failed_description # The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. - attr_accessor :error_code # Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. - attr_accessor :accepted_time # Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC - attr_accessor :completed_time # Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + # @!attribute [rw] phase + # @return [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. + attr_accessor :phase + # @!attribute [rw] success_count + # @return [Integer] The number of users who successfully received the message. + attr_accessor :success_count + # @!attribute [rw] failure_count + # @return [Integer] The number of users who failed to send the message. + attr_accessor :failure_count + # @!attribute [rw] target_count + # @return [Integer] The number of intended recipients of the message. + attr_accessor :target_count + # @!attribute [rw] failed_description + # @return [String] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. + attr_accessor :failed_description + # @!attribute [rw] error_code + # @return [Integer] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. + attr_accessor :error_code + # @!attribute [rw] accepted_time + # @return [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + attr_accessor :accepted_time + # @!attribute [rw] completed_time + # @return [String] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + attr_accessor :completed_time # @param phase [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. # @param success_count [Integer] The number of users who successfully received the message. diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb index c1c52e4c..dd31a981 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb @@ -13,11 +13,21 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message class NarrowcastRequest - attr_accessor :messages # List of Message objects. + # @!attribute [rw] messages + # @return [Array[Message]] List of Message objects. + attr_accessor :messages + # @!attribute [rw] recipient + # @return [Recipient] attr_accessor :recipient + # @!attribute [rw] filter + # @return [Filter] attr_accessor :filter + # @!attribute [rw] limit + # @return [Limit] attr_accessor :limit - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled # @param messages [Array[Message]] List of Message objects. # @param recipient [Recipient] diff --git a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb index 1e8eaae3..23deaf3e 100644 --- a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb +++ b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class NumberOfMessagesResponse - attr_accessor :status # Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). - attr_accessor :success # The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. + # @!attribute [rw] status + # @return [String] ('ready'|'unready'|'unavailable_for_privacy'|'out_of_service') Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). + attr_accessor :status + # @!attribute [rw] success + # @return [Integer] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. + attr_accessor :success # @param status [String] ('ready'|'unready'|'unavailable_for_privacy'|'out_of_service') Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). # @param success [Integer] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. diff --git a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb index 9dd17e9e..349b713b 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class OperatorDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] _and + # @return [Array[DemographicFilter]] attr_accessor :_and + # @!attribute [rw] _or + # @return [Array[DemographicFilter]] attr_accessor :_or + # @!attribute [rw] _not + # @return [DemographicFilter] attr_accessor :_not # @param _and [Array[DemographicFilter]] diff --git a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb index 2347aed7..cbb1b464 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class OperatorRecipient < Recipient - attr_reader :type # Type of recipient - attr_accessor :_and # Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. - attr_accessor :_or # Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. + # @!attribute [r] type + # @return [String] Type of recipient + attr_reader :type + # @!attribute [rw] _and + # @return [Array[Recipient]] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. + attr_accessor :_and + # @!attribute [rw] _or + # @return [Array[Recipient]] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. + attr_accessor :_or + # @!attribute [rw] _not + # @return [Recipient] attr_accessor :_not # @param _and [Array[Recipient]] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. diff --git a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb index f7f583f5..53003eeb 100644 --- a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb +++ b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/partner-docs/#send-line-notification-message class PnpMessagesRequest - attr_accessor :messages # Message to be sent. - attr_accessor :to # Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @!attribute [rw] messages + # @return [Array[Message]] Message to be sent. + attr_accessor :messages + # @!attribute [rw] to + # @return [String] Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. + attr_accessor :to + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled # @param messages [Array[Message]] Message to be sent. # @param to [String] Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. diff --git a/lib/line/bot/v2/messaging_api/model/postback_action.rb b/lib/line/bot/v2/messaging_api/model/postback_action.rb index 6c824bed..7e84e3d4 100644 --- a/lib/line/bot/v2/messaging_api/model/postback_action.rb +++ b/lib/line/bot/v2/messaging_api/model/postback_action.rb @@ -14,12 +14,26 @@ module Bot module V2 module MessagingApi class PostbackAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String] attr_accessor :data + # @!attribute [rw] display_text + # @return [String] attr_accessor :display_text + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] input_option + # @return [String] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') attr_accessor :input_option + # @!attribute [rw] fill_in_text + # @return [String] attr_accessor :fill_in_text # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/push_message_request.rb b/lib/line/bot/v2/messaging_api/model/push_message_request.rb index 90ecc076..75e16299 100644 --- a/lib/line/bot/v2/messaging_api/model/push_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/push_message_request.rb @@ -13,10 +13,18 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-push-message class PushMessageRequest - attr_accessor :to # ID of the receiver. - attr_accessor :messages # List of Message objects. - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. - attr_accessor :custom_aggregation_units # List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. + # @!attribute [rw] to + # @return [String] ID of the receiver. + attr_accessor :to + # @!attribute [rw] messages + # @return [Array[Message]] List of Message objects. + attr_accessor :messages + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled + # @!attribute [rw] custom_aggregation_units + # @return [Array[String]] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. + attr_accessor :custom_aggregation_units # @param to [String] ID of the receiver. # @param messages [Array[Message]] List of Message objects. diff --git a/lib/line/bot/v2/messaging_api/model/push_message_response.rb b/lib/line/bot/v2/messaging_api/model/push_message_response.rb index efe414af..8a8828f0 100644 --- a/lib/line/bot/v2/messaging_api/model/push_message_response.rb +++ b/lib/line/bot/v2/messaging_api/model/push_message_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-push-message-response class PushMessageResponse - attr_accessor :sent_messages # Array of sent messages. + # @!attribute [rw] sent_messages + # @return [Array[SentMessage]] Array of sent messages. + attr_accessor :sent_messages # @param sent_messages [Array[SentMessage]] Array of sent messages. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply.rb b/lib/line/bot/v2/messaging_api/model/quick_reply.rb index c2b61fc4..d061a008 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply.rb @@ -14,7 +14,9 @@ module MessagingApi # Quick reply # @see https://developers.line.biz/en/reference/messaging-api/#items-object class QuickReply - attr_accessor :items # Quick reply button objects. + # @!attribute [rw] items + # @return [Array[QuickReplyItem]] Quick reply button objects. + attr_accessor :items # @param items [Array[QuickReplyItem]] Quick reply button objects. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb index 80a8c500..90afecb3 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#items-object class QuickReplyItem - attr_accessor :image_url # URL of the icon that is displayed at the beginning of the button + # @!attribute [rw] image_url + # @return [String] URL of the icon that is displayed at the beginning of the button + attr_accessor :image_url + # @!attribute [rw] action + # @return [Action] attr_accessor :action - attr_accessor :type # `action` + # @!attribute [rw] type + # @return [String] `action` + attr_accessor :type # @param image_url [String] URL of the icon that is displayed at the beginning of the button # @param action [Action] diff --git a/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb b/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb index 6e126536..71fee49b 100644 --- a/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb +++ b/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-consumption class QuotaConsumptionResponse - attr_accessor :total_usage # The number of sent messages in the current month + # @!attribute [rw] total_usage + # @return [Integer] The number of sent messages in the current month + attr_accessor :total_usage # @param total_usage [Integer] The number of sent messages in the current month def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/recipient.rb b/lib/line/bot/v2/messaging_api/model/recipient.rb index a1d0f3b1..5b71b612 100644 --- a/lib/line/bot/v2/messaging_api/model/recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/recipient.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # Recipient class Recipient - attr_accessor :type # Type of recipient + # @!attribute [rw] type + # @return [String] Type of recipient + attr_accessor :type # @param type [String] Type of recipient def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb index 4f3d142f..b616545c 100644 --- a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb @@ -14,7 +14,11 @@ module Bot module V2 module MessagingApi class RedeliveryRecipient < Recipient - attr_reader :type # Type of recipient + # @!attribute [r] type + # @return [String] Type of recipient + attr_reader :type + # @!attribute [rw] request_id + # @return [String] attr_accessor :request_id # @param request_id [String] diff --git a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb index 8e4d338d..662070c6 100644 --- a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-reply-message class ReplyMessageRequest - attr_accessor :reply_token # replyToken received via webhook. - attr_accessor :messages # List of messages. - attr_accessor :notification_disabled # `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @!attribute [rw] reply_token + # @return [String] replyToken received via webhook. + attr_accessor :reply_token + # @!attribute [rw] messages + # @return [Array[Message]] List of messages. + attr_accessor :messages + # @!attribute [rw] notification_disabled + # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + attr_accessor :notification_disabled # @param reply_token [String] replyToken received via webhook. # @param messages [Array[Message]] List of messages. diff --git a/lib/line/bot/v2/messaging_api/model/reply_message_response.rb b/lib/line/bot/v2/messaging_api/model/reply_message_response.rb index 3eca0a56..d8ea3d7b 100644 --- a/lib/line/bot/v2/messaging_api/model/reply_message_response.rb +++ b/lib/line/bot/v2/messaging_api/model/reply_message_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-reply-message-response class ReplyMessageResponse - attr_accessor :sent_messages # Array of sent messages. + # @!attribute [rw] sent_messages + # @return [Array[SentMessage]] Array of sent messages. + attr_accessor :sent_messages # @param sent_messages [Array[SentMessage]] Array of sent messages. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb index 0563f5b3..320717a7 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_list_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list class RichMenuAliasListResponse - attr_accessor :aliases # Rich menu aliases. + # @!attribute [rw] aliases + # @return [Array[RichMenuAliasResponse]] Rich menu aliases. + attr_accessor :aliases # @param aliases [Array[RichMenuAliasResponse]] Rich menu aliases. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb index f2169283..522cb668 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_alias_response.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class RichMenuAliasResponse - attr_accessor :rich_menu_alias_id # Rich menu alias ID. - attr_accessor :rich_menu_id # The rich menu ID associated with the rich menu alias. + # @!attribute [rw] rich_menu_alias_id + # @return [String] Rich menu alias ID. + attr_accessor :rich_menu_alias_id + # @!attribute [rw] rich_menu_id + # @return [String] The rich menu ID associated with the rich menu alias. + attr_accessor :rich_menu_id # @param rich_menu_alias_id [String] Rich menu alias ID. # @param rich_menu_id [String] The rich menu ID associated with the rich menu alias. diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb index 267c374b..e9f8025a 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb @@ -13,7 +13,11 @@ module V2 module MessagingApi # Rich menu area class RichMenuArea + # @!attribute [rw] bounds + # @return [RichMenuBounds] attr_accessor :bounds + # @!attribute [rw] action + # @return [Action] attr_accessor :action # @param bounds [RichMenuBounds] diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb index b9bc97d8..660963ba 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb @@ -15,8 +15,14 @@ module V2 module MessagingApi # Replace the rich menu with the rich menu specified in the `to` property for all users linked to the rich menu specified in the `from` property. class RichMenuBatchLinkOperation < RichMenuBatchOperation - attr_reader :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + # @!attribute [r] type + # @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + attr_reader :type + # @!attribute [rw] from + # @return [String] attr_accessor :from + # @!attribute [rw] to + # @return [String] attr_accessor :to # @param from [String] diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb index 3fff0a94..954589a1 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_operation.rb @@ -14,7 +14,9 @@ module MessagingApi # Rich menu operation object represents the batch operation to the rich menu linked to the user. # @see https://developers.line.biz/en/reference/messaging-api/#batch-control-rich-menus-of-users-operations class RichMenuBatchOperation - attr_accessor :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + # @!attribute [rw] type + # @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + attr_accessor :type # @param type [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb index 451e3890..2b71650d 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-batch-control-rich-menus-progress-status-response class RichMenuBatchProgressResponse + # @!attribute [rw] phase + # @return [String] ('ongoing'|'succeeded'|'failed') attr_accessor :phase - attr_accessor :accepted_time # The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC - attr_accessor :completed_time # The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + # @!attribute [rw] accepted_time + # @return [String] The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + attr_accessor :accepted_time + # @!attribute [rw] completed_time + # @return [String] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + attr_accessor :completed_time # @param phase [String] ('ongoing'|'succeeded'|'failed') # @param accepted_time [String] The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb index d960292c..42c6241a 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class RichMenuBatchRequest - attr_accessor :operations # Array of Rich menu operation object... - attr_accessor :resume_request_key # Key for retry. Key value is a string matching the regular expression pattern + # @!attribute [rw] operations + # @return [Array[RichMenuBatchOperation]] Array of Rich menu operation object... + attr_accessor :operations + # @!attribute [rw] resume_request_key + # @return [String] Key for retry. Key value is a string matching the regular expression pattern + attr_accessor :resume_request_key # @param operations [Array[RichMenuBatchOperation]] Array of Rich menu operation object... # @param resume_request_key [String] Key for retry. Key value is a string matching the regular expression pattern diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_all_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_all_operation.rb index e8558ef7..64a99d34 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_all_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_all_operation.rb @@ -15,7 +15,9 @@ module V2 module MessagingApi # Unlink the rich menu from all users linked to the rich menu. class RichMenuBatchUnlinkAllOperation < RichMenuBatchOperation - attr_reader :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + # @!attribute [r] type + # @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + attr_reader :type def initialize( **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb index 13d04b7f..acef5dea 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_unlink_operation.rb @@ -15,7 +15,11 @@ module V2 module MessagingApi # Unlink the rich menu for all users linked to the rich menu specified in the `from` property. class RichMenuBatchUnlinkOperation < RichMenuBatchOperation - attr_reader :type # The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + # @!attribute [r] type + # @return [String] The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. + attr_reader :type + # @!attribute [rw] from + # @return [String] attr_accessor :from # @param from [String] diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb index 7d3b3d8f..b7ab3890 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb @@ -14,10 +14,18 @@ module MessagingApi # Rich menu bounds # @see https://developers.line.biz/en/reference/messaging-api/#bounds-object class RichMenuBounds - attr_accessor :x # Horizontal position relative to the top-left corner of the area. - attr_accessor :y # Vertical position relative to the top-left corner of the area. - attr_accessor :width # Width of the area. - attr_accessor :height # Height of the area. + # @!attribute [rw] x + # @return [Integer] Horizontal position relative to the top-left corner of the area. + attr_accessor :x + # @!attribute [rw] y + # @return [Integer] Vertical position relative to the top-left corner of the area. + attr_accessor :y + # @!attribute [rw] width + # @return [Integer] Width of the area. + attr_accessor :width + # @!attribute [rw] height + # @return [Integer] Height of the area. + attr_accessor :height # @param x [Integer] Horizontal position relative to the top-left corner of the area. # @param y [Integer] Vertical position relative to the top-left corner of the area. diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb index 24d0dd1c..d05b6adf 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#link-rich-menu-to-users class RichMenuBulkLinkRequest - attr_accessor :rich_menu_id # ID of a rich menu - attr_accessor :user_ids # Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + # @!attribute [rw] rich_menu_id + # @return [String] ID of a rich menu + attr_accessor :rich_menu_id + # @!attribute [rw] user_ids + # @return [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + attr_accessor :user_ids # @param rich_menu_id [String] ID of a rich menu # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb index b126c4c8..e577a711 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_unlink_request.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#unlink-rich-menu-from-users class RichMenuBulkUnlinkRequest - attr_accessor :user_ids # Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + # @!attribute [rw] user_ids + # @return [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. + attr_accessor :user_ids # @param user_ids [Array[String]] Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb index e009e6ae..7ff457ff 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_id_response.rb @@ -12,7 +12,9 @@ module Bot module V2 module MessagingApi class RichMenuIdResponse - attr_accessor :rich_menu_id # Rich menu ID + # @!attribute [rw] rich_menu_id + # @return [String] Rich menu ID + attr_accessor :rich_menu_id # @param rich_menu_id [String] Rich menu ID def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb index 13ceb50b..91d59974 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_list_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-list class RichMenuListResponse - attr_accessor :richmenus # Rich menus + # @!attribute [rw] richmenus + # @return [Array[RichMenuResponse]] Rich menus + attr_accessor :richmenus # @param richmenus [Array[RichMenuResponse]] Rich menus def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb index df8b1c13..2e5c9273 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb @@ -12,11 +12,21 @@ module Bot module V2 module MessagingApi class RichMenuRequest + # @!attribute [rw] size + # @return [RichMenuSize] attr_accessor :size - attr_accessor :selected # `true` to display the rich menu by default. Otherwise, `false`. - attr_accessor :name # Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. - attr_accessor :chat_bar_text # Text displayed in the chat bar - attr_accessor :areas # Array of area objects which define the coordinates and size of tappable areas + # @!attribute [rw] selected + # @return [Boolean] `true` to display the rich menu by default. Otherwise, `false`. + attr_accessor :selected + # @!attribute [rw] name + # @return [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + attr_accessor :name + # @!attribute [rw] chat_bar_text + # @return [String] Text displayed in the chat bar + attr_accessor :chat_bar_text + # @!attribute [rw] areas + # @return [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas + attr_accessor :areas # @param size [RichMenuSize] # @param selected [Boolean] `true` to display the rich menu by default. Otherwise, `false`. diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb index 3db368f9..536338f5 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb @@ -12,12 +12,24 @@ module Bot module V2 module MessagingApi class RichMenuResponse - attr_accessor :rich_menu_id # ID of a rich menu + # @!attribute [rw] rich_menu_id + # @return [String] ID of a rich menu + attr_accessor :rich_menu_id + # @!attribute [rw] size + # @return [RichMenuSize] attr_accessor :size - attr_accessor :selected # `true` to display the rich menu by default. Otherwise, `false`. - attr_accessor :name # Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. - attr_accessor :chat_bar_text # Text displayed in the chat bar - attr_accessor :areas # Array of area objects which define the coordinates and size of tappable areas + # @!attribute [rw] selected + # @return [Boolean] `true` to display the rich menu by default. Otherwise, `false`. + attr_accessor :selected + # @!attribute [rw] name + # @return [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + attr_accessor :name + # @!attribute [rw] chat_bar_text + # @return [String] Text displayed in the chat bar + attr_accessor :chat_bar_text + # @!attribute [rw] areas + # @return [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas + attr_accessor :areas # @param rich_menu_id [String] ID of a rich menu # @param size [RichMenuSize] diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb index b83300a7..83b2c9be 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # Rich menu size class RichMenuSize - attr_accessor :width # width - attr_accessor :height # height + # @!attribute [rw] width + # @return [Integer] width + attr_accessor :width + # @!attribute [rw] height + # @return [Integer] height + attr_accessor :height # @param width [Integer] width # @param height [Integer] height diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb index 56e2abe2..437d1507 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class RichMenuSwitchAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String] attr_accessor :data + # @!attribute [rw] rich_menu_alias_id + # @return [String] attr_accessor :rich_menu_alias_id # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb b/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb index a3b0c4a9..da4b1163 100644 --- a/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb +++ b/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-members-room-count class RoomMemberCountResponse - attr_accessor :count # The count of members in the multi-person chat. The number returned excludes the LINE Official Account. + # @!attribute [rw] count + # @return [Integer] The count of members in the multi-person chat. The number returned excludes the LINE Official Account. + attr_accessor :count # @param count [Integer] The count of members in the multi-person chat. The number returned excludes the LINE Official Account. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb index 987b145e..f97419fc 100644 --- a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb @@ -13,9 +13,15 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-room-member-profile class RoomUserProfileResponse - attr_accessor :display_name # User's display name - attr_accessor :user_id # User ID - attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @!attribute [rw] display_name + # @return [String] User's display name + attr_accessor :display_name + # @!attribute [rw] user_id + # @return [String] User ID + attr_accessor :user_id + # @!attribute [rw] picture_url + # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + attr_accessor :picture_url # @param display_name [String] User's display name # @param user_id [String] User ID diff --git a/lib/line/bot/v2/messaging_api/model/sender.rb b/lib/line/bot/v2/messaging_api/model/sender.rb index 0f843f2c..b8255e30 100644 --- a/lib/line/bot/v2/messaging_api/model/sender.rb +++ b/lib/line/bot/v2/messaging_api/model/sender.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # Change icon and display name class Sender - attr_accessor :name # Display name. Certain words such as `LINE` may not be used. - attr_accessor :icon_url # URL of the image to display as an icon when sending a message + # @!attribute [rw] name + # @return [String] Display name. Certain words such as `LINE` may not be used. + attr_accessor :name + # @!attribute [rw] icon_url + # @return [String] URL of the image to display as an icon when sending a message + attr_accessor :icon_url # @param name [String] Display name. Certain words such as `LINE` may not be used. # @param icon_url [String] URL of the image to display as an icon when sending a message diff --git a/lib/line/bot/v2/messaging_api/model/sent_message.rb b/lib/line/bot/v2/messaging_api/model/sent_message.rb index ce16df5f..5e672ced 100644 --- a/lib/line/bot/v2/messaging_api/model/sent_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sent_message.rb @@ -12,8 +12,12 @@ module Bot module V2 module MessagingApi class SentMessage - attr_accessor :id # ID of the sent message. - attr_accessor :quote_token # Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. + # @!attribute [rw] id + # @return [String] ID of the sent message. + attr_accessor :id + # @!attribute [rw] quote_token + # @return [String] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. + attr_accessor :quote_token # @param id [String] ID of the sent message. # @param quote_token [String] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. diff --git a/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb index 28541ba0..7802c5fa 100644 --- a/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb +++ b/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#set-webhook-endpoint-url class SetWebhookEndpointRequest - attr_accessor :endpoint # A valid webhook URL. + # @!attribute [rw] endpoint + # @return [String] A valid webhook URL. + attr_accessor :endpoint # @param endpoint [String] A valid webhook URL. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb index 5c67e04b..d0bb81be 100644 --- a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb +++ b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb @@ -13,8 +13,12 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#display-a-loading-indicator-request-body class ShowLoadingAnimationRequest - attr_accessor :chat_id # User ID of the target user for whom the loading animation is to be displayed. - attr_accessor :loading_seconds # The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. + # @!attribute [rw] chat_id + # @return [String] User ID of the target user for whom the loading animation is to be displayed. + attr_accessor :chat_id + # @!attribute [rw] loading_seconds + # @return [Integer] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. + attr_accessor :loading_seconds # @param chat_id [String] User ID of the target user for whom the loading animation is to be displayed. # @param loading_seconds [Integer] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. diff --git a/lib/line/bot/v2/messaging_api/model/sticker_message.rb b/lib/line/bot/v2/messaging_api/model/sticker_message.rb index 3084b15e..1bd0a1cb 100644 --- a/lib/line/bot/v2/messaging_api/model/sticker_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sticker_message.rb @@ -15,12 +15,24 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#sticker-message class StickerMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] package_id + # @return [String] attr_accessor :package_id + # @!attribute [rw] sticker_id + # @return [String] attr_accessor :sticker_id - attr_accessor :quote_token # Quote token of the message you want to quote. + # @!attribute [rw] quote_token + # @return [String] Quote token of the message you want to quote. + attr_accessor :quote_token # @param quick_reply [QuickReply] # @param sender [Sender] diff --git a/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb b/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb index 068111c7..6ae9fd02 100644 --- a/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb +++ b/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb @@ -13,12 +13,24 @@ module V2 module MessagingApi # Object containing information about the membership plan. class SubscribedMembershipPlan - attr_accessor :membership_id # Membership plan ID. - attr_accessor :title # Membership plan name. - attr_accessor :description # Membership plan description. - attr_accessor :benefits # List of membership plan perks. - attr_accessor :price # Monthly fee for membership plan. (e.g. 1500.00) - attr_accessor :currency # The currency of membership.price. + # @!attribute [rw] membership_id + # @return [Integer] Membership plan ID. + attr_accessor :membership_id + # @!attribute [rw] title + # @return [String] Membership plan name. + attr_accessor :title + # @!attribute [rw] description + # @return [String] Membership plan description. + attr_accessor :description + # @!attribute [rw] benefits + # @return [Array[String]] List of membership plan perks. + attr_accessor :benefits + # @!attribute [rw] price + # @return [Float] Monthly fee for membership plan. (e.g. 1500.00) + attr_accessor :price + # @!attribute [rw] currency + # @return [String] ('JPY'|'TWD'|'THB') The currency of membership.price. + attr_accessor :currency # @param membership_id [Integer] Membership plan ID. # @param title [String] Membership plan name. diff --git a/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb b/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb index 39736e3f..994d93f1 100644 --- a/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb +++ b/lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb @@ -13,10 +13,18 @@ module V2 module MessagingApi # Object containing user membership subscription information. class SubscribedMembershipUser - attr_accessor :membership_no # The user's member number in the membership plan. - attr_accessor :joined_time # UNIX timestamp at which the user subscribed to the membership. - attr_accessor :next_billing_date # Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 - attr_accessor :total_subscription_months # The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted. + # @!attribute [rw] membership_no + # @return [Integer] The user's member number in the membership plan. + attr_accessor :membership_no + # @!attribute [rw] joined_time + # @return [Integer] UNIX timestamp at which the user subscribed to the membership. + attr_accessor :joined_time + # @!attribute [rw] next_billing_date + # @return [String] Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 + attr_accessor :next_billing_date + # @!attribute [rw] total_subscription_months + # @return [Integer] The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted. + attr_accessor :total_subscription_months # @param membership_no [Integer] The user's member number in the membership plan. # @param joined_time [Integer] UNIX timestamp at which the user subscribed to the membership. diff --git a/lib/line/bot/v2/messaging_api/model/subscription.rb b/lib/line/bot/v2/messaging_api/model/subscription.rb index 19c1136d..b5281936 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription.rb @@ -13,7 +13,11 @@ module V2 module MessagingApi # An array of memberships. class Subscription + # @!attribute [rw] membership + # @return [SubscribedMembershipPlan] attr_accessor :membership + # @!attribute [rw] user + # @return [SubscribedMembershipUser] attr_accessor :user # @param membership [SubscribedMembershipPlan] diff --git a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb index f7309e36..67d111ec 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb @@ -14,8 +14,14 @@ module Bot module V2 module MessagingApi class SubscriptionPeriodDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String] Type of demographic filter + attr_reader :type + # @!attribute [rw] gte + # @return [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :gte + # @!attribute [rw] lt + # @return [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :lt # @param gte [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') diff --git a/lib/line/bot/v2/messaging_api/model/substitution_object.rb b/lib/line/bot/v2/messaging_api/model/substitution_object.rb index f6f395a8..e4145ba7 100644 --- a/lib/line/bot/v2/messaging_api/model/substitution_object.rb +++ b/lib/line/bot/v2/messaging_api/model/substitution_object.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # An object that defines the replacement value for a placeholder in the text. class SubstitutionObject - attr_accessor :type # Type of substitution object + # @!attribute [rw] type + # @return [String] Type of substitution object + attr_accessor :type # @param type [String] Type of substitution object def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/template.rb b/lib/line/bot/v2/messaging_api/model/template.rb index 1be3abc5..776ea7e6 100644 --- a/lib/line/bot/v2/messaging_api/model/template.rb +++ b/lib/line/bot/v2/messaging_api/model/template.rb @@ -12,6 +12,8 @@ module Bot module V2 module MessagingApi class Template + # @!attribute [rw] type + # @return [String] attr_accessor :type # @param type [String] diff --git a/lib/line/bot/v2/messaging_api/model/template_message.rb b/lib/line/bot/v2/messaging_api/model/template_message.rb index 54fa3117..fc183b01 100644 --- a/lib/line/bot/v2/messaging_api/model/template_message.rb +++ b/lib/line/bot/v2/messaging_api/model/template_message.rb @@ -15,10 +15,20 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#template-messages class TemplateMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] alt_text + # @return [String] attr_accessor :alt_text + # @!attribute [rw] template + # @return [Template] attr_accessor :template # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb index c33cedbe..bd012a05 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint class TestWebhookEndpointRequest - attr_accessor :endpoint # A webhook URL to be validated. + # @!attribute [rw] endpoint + # @return [String] A webhook URL to be validated. + attr_accessor :endpoint # @param endpoint [String] A webhook URL to be validated. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb index 73f3583f..de5ce4dc 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb @@ -13,11 +13,21 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint class TestWebhookEndpointResponse - attr_accessor :success # Result of the communication from the LINE platform to the webhook URL. - attr_accessor :timestamp # Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. - attr_accessor :status_code # The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. - attr_accessor :reason # Reason for the response. - attr_accessor :detail # Details of the response. + # @!attribute [rw] success + # @return [Boolean] Result of the communication from the LINE platform to the webhook URL. + attr_accessor :success + # @!attribute [rw] timestamp + # @return [String] Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. + attr_accessor :timestamp + # @!attribute [rw] status_code + # @return [Integer] The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. + attr_accessor :status_code + # @!attribute [rw] reason + # @return [String] Reason for the response. + attr_accessor :reason + # @!attribute [rw] detail + # @return [String] Details of the response. + attr_accessor :detail # @param success [Boolean] Result of the communication from the LINE platform to the webhook URL. # @param timestamp [String] Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. diff --git a/lib/line/bot/v2/messaging_api/model/text_message.rb b/lib/line/bot/v2/messaging_api/model/text_message.rb index aa8019c1..86c03ca1 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message.rb @@ -15,12 +15,24 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#text-message class TextMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] emojis + # @return [Array[Emoji]] attr_accessor :emojis - attr_accessor :quote_token # Quote token of the message you want to quote. + # @!attribute [rw] quote_token + # @return [String] Quote token of the message you want to quote. + attr_accessor :quote_token # @param quick_reply [QuickReply] # @param sender [Sender] diff --git a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb index 854d08d6..f6cc38c6 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb @@ -15,12 +15,24 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2 class TextMessageV2 < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] text + # @return [String] attr_accessor :text - attr_accessor :substitution # A mapping that specifies substitutions for parts enclosed in {} within the `text` field. - attr_accessor :quote_token # Quote token of the message you want to quote. + # @!attribute [rw] substitution + # @return [Object] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. + attr_accessor :substitution + # @!attribute [rw] quote_token + # @return [String] Quote token of the message you want to quote. + attr_accessor :quote_token # @param quick_reply [QuickReply] # @param sender [Sender] diff --git a/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb b/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb index 59aa0308..c544f739 100644 --- a/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb +++ b/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb @@ -13,7 +13,9 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#update-rich-menu-alias class UpdateRichMenuAliasRequest - attr_accessor :rich_menu_id # The rich menu ID to be associated with the rich menu alias. + # @!attribute [rw] rich_menu_id + # @return [String] The rich menu ID to be associated with the rich menu alias. + attr_accessor :rich_menu_id # @param rich_menu_id [String] The rich menu ID to be associated with the rich menu alias. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/uri_action.rb b/lib/line/bot/v2/messaging_api/model/uri_action.rb index cf770212..38e648bd 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_action.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class URIAction < Action - attr_reader :type # Type of action - attr_accessor :label # Label for the action. + # @!attribute [r] type + # @return [String] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String] Label for the action. + attr_accessor :label + # @!attribute [rw] uri + # @return [String] attr_accessor :uri + # @!attribute [rw] alt_uri + # @return [AltUri] attr_accessor :alt_uri # @param label [String] Label for the action. diff --git a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb index 7632e6f2..38003694 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb @@ -14,9 +14,17 @@ module Bot module V2 module MessagingApi class URIImagemapAction < ImagemapAction + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] area + # @return [ImagemapArea] attr_accessor :area + # @!attribute [rw] link_uri + # @return [String] attr_accessor :link_uri + # @!attribute [rw] label + # @return [String] attr_accessor :label # @param area [ImagemapArea] diff --git a/lib/line/bot/v2/messaging_api/model/user_mention_target.rb b/lib/line/bot/v2/messaging_api/model/user_mention_target.rb index d04c65c5..c368ea1b 100644 --- a/lib/line/bot/v2/messaging_api/model/user_mention_target.rb +++ b/lib/line/bot/v2/messaging_api/model/user_mention_target.rb @@ -15,7 +15,11 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mentionee-user class UserMentionTarget < MentionTarget - attr_reader :type # Target to be mentioned + # @!attribute [r] type + # @return [String] Target to be mentioned + attr_reader :type + # @!attribute [rw] user_id + # @return [String] attr_accessor :user_id # @param user_id [String] diff --git a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb index 7657ee57..f8c103f9 100644 --- a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb @@ -13,11 +13,21 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#get-profile class UserProfileResponse - attr_accessor :display_name # User's display name - attr_accessor :user_id # User ID - attr_accessor :picture_url # Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. - attr_accessor :status_message # User's status message. Not included in the response if the user doesn't have a status message. - attr_accessor :language # User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. + # @!attribute [rw] display_name + # @return [String] User's display name + attr_accessor :display_name + # @!attribute [rw] user_id + # @return [String] User ID + attr_accessor :user_id + # @!attribute [rw] picture_url + # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + attr_accessor :picture_url + # @!attribute [rw] status_message + # @return [String] User's status message. Not included in the response if the user doesn't have a status message. + attr_accessor :status_message + # @!attribute [rw] language + # @return [String] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. + attr_accessor :language # @param display_name [String] User's display name # @param user_id [String] User ID diff --git a/lib/line/bot/v2/messaging_api/model/validate_message_request.rb b/lib/line/bot/v2/messaging_api/model/validate_message_request.rb index 4a844fb1..86cd90ee 100644 --- a/lib/line/bot/v2/messaging_api/model/validate_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/validate_message_request.rb @@ -12,7 +12,9 @@ module Bot module V2 module MessagingApi class ValidateMessageRequest - attr_accessor :messages # Array of message objects to validate + # @!attribute [rw] messages + # @return [Array[Message]] Array of message objects to validate + attr_accessor :messages # @param messages [Array[Message]] Array of message objects to validate def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/video_message.rb b/lib/line/bot/v2/messaging_api/model/video_message.rb index 431c1d6f..2a24db57 100644 --- a/lib/line/bot/v2/messaging_api/model/video_message.rb +++ b/lib/line/bot/v2/messaging_api/model/video_message.rb @@ -15,11 +15,23 @@ module V2 module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#video-message class VideoMessage < Message - attr_reader :type # Type of message + # @!attribute [r] type + # @return [String] Type of message + attr_reader :type + # @!attribute [rw] quick_reply + # @return [QuickReply] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender] attr_accessor :sender + # @!attribute [rw] original_content_url + # @return [String] attr_accessor :original_content_url + # @!attribute [rw] preview_image_url + # @return [String] attr_accessor :preview_image_url + # @!attribute [rw] tracking_id + # @return [String] attr_accessor :tracking_id # @param quick_reply [QuickReply] diff --git a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb index 7eb1dd70..46224796 100644 --- a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb +++ b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb @@ -14,8 +14,12 @@ module Module # Request entity of the Acquire Control API # @see https://developers.line.biz/en/reference/partner-docs/#acquire-control-api class AcquireChatControlRequest - attr_accessor :expired # `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. - attr_accessor :ttl # The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. + # @!attribute [rw] expired + # @return [Boolean] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. + attr_accessor :expired + # @!attribute [rw] ttl + # @return [Integer] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. + attr_accessor :ttl # @param expired [Boolean] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. # @param ttl [Integer] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. diff --git a/lib/line/bot/v2/module/model/detach_module_request.rb b/lib/line/bot/v2/module/model/detach_module_request.rb index 41c334a5..16284e04 100644 --- a/lib/line/bot/v2/module/model/detach_module_request.rb +++ b/lib/line/bot/v2/module/model/detach_module_request.rb @@ -14,7 +14,9 @@ module Module # Unlink (detach) the module channel by the operation of the module channel administrator # @see https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin class DetachModuleRequest - attr_accessor :bot_id # User ID of the LINE Official Account bot attached to the module channel. + # @!attribute [rw] bot_id + # @return [String] User ID of the LINE Official Account bot attached to the module channel. + attr_accessor :bot_id # @param bot_id [String] User ID of the LINE Official Account bot attached to the module channel. def initialize( diff --git a/lib/line/bot/v2/module/model/get_modules_response.rb b/lib/line/bot/v2/module/model/get_modules_response.rb index 8ad35157..0f7f539f 100644 --- a/lib/line/bot/v2/module/model/get_modules_response.rb +++ b/lib/line/bot/v2/module/model/get_modules_response.rb @@ -14,8 +14,12 @@ module Module # List of bots to which the module is attached # @see https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api class GetModulesResponse - attr_accessor :bots # Array of Bot list Item objects representing basic information about the bot. - attr_accessor :_next # Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. + # @!attribute [rw] bots + # @return [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot. + attr_accessor :bots + # @!attribute [rw] _next + # @return [String] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. + attr_accessor :_next # @param bots [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot. # @param _next [String] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. diff --git a/lib/line/bot/v2/module/model/module_bot.rb b/lib/line/bot/v2/module/model/module_bot.rb index 4c52024a..2dd82c0d 100644 --- a/lib/line/bot/v2/module/model/module_bot.rb +++ b/lib/line/bot/v2/module/model/module_bot.rb @@ -14,11 +14,21 @@ module Module # basic information about the bot. # @see https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api class ModuleBot - attr_accessor :user_id # Bot's user ID - attr_accessor :basic_id # Bot's basic ID - attr_accessor :premium_id # Bot's premium ID. Not included in the response if the premium ID isn't set. - attr_accessor :display_name # Bot's display name - attr_accessor :picture_url # Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. + # @!attribute [rw] user_id + # @return [String] Bot's user ID + attr_accessor :user_id + # @!attribute [rw] basic_id + # @return [String] Bot's basic ID + attr_accessor :basic_id + # @!attribute [rw] premium_id + # @return [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + attr_accessor :premium_id + # @!attribute [rw] display_name + # @return [String] Bot's display name + attr_accessor :display_name + # @!attribute [rw] picture_url + # @return [String] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. + attr_accessor :picture_url # @param user_id [String] Bot's user ID # @param basic_id [String] Bot's basic ID diff --git a/lib/line/bot/v2/module_attach/model/attach_module_response.rb b/lib/line/bot/v2/module_attach/model/attach_module_response.rb index 73a42b16..5a308476 100644 --- a/lib/line/bot/v2/module_attach/model/attach_module_response.rb +++ b/lib/line/bot/v2/module_attach/model/attach_module_response.rb @@ -13,8 +13,12 @@ module V2 module ModuleAttach # Attach by operation of the module channel provider class AttachModuleResponse - attr_accessor :bot_id # User ID of the bot on the LINE Official Account. - attr_accessor :scopes # Permissions (scope) granted by the LINE Official Account admin. + # @!attribute [rw] bot_id + # @return [String] User ID of the bot on the LINE Official Account. + attr_accessor :bot_id + # @!attribute [rw] scopes + # @return [Array[String]] Permissions (scope) granted by the LINE Official Account admin. + attr_accessor :scopes # @param bot_id [String] User ID of the bot on the LINE Official Account. # @param scopes [Array[String]] Permissions (scope) granted by the LINE Official Account admin. diff --git a/lib/line/bot/v2/shop/model/error_response.rb b/lib/line/bot/v2/shop/model/error_response.rb index 0eacb769..8254b2ba 100644 --- a/lib/line/bot/v2/shop/model/error_response.rb +++ b/lib/line/bot/v2/shop/model/error_response.rb @@ -13,7 +13,9 @@ module V2 module Shop # @see https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3 class ErrorResponse - attr_accessor :message # Message containing information about the error. + # @!attribute [rw] message + # @return [String] Message containing information about the error. + attr_accessor :message # @param message [String] Message containing information about the error. def initialize( diff --git a/lib/line/bot/v2/shop/model/mission_sticker_request.rb b/lib/line/bot/v2/shop/model/mission_sticker_request.rb index a91811b5..67822a91 100644 --- a/lib/line/bot/v2/shop/model/mission_sticker_request.rb +++ b/lib/line/bot/v2/shop/model/mission_sticker_request.rb @@ -14,10 +14,18 @@ module Shop # Send mission stickers (v3) # @see https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3 class MissionStickerRequest - attr_accessor :to # Destination user ID - attr_accessor :product_id # Package ID for a set of stickers - attr_accessor :product_type # `STICKER` - attr_accessor :send_present_message # `false` + # @!attribute [rw] to + # @return [String] Destination user ID + attr_accessor :to + # @!attribute [rw] product_id + # @return [String] Package ID for a set of stickers + attr_accessor :product_id + # @!attribute [rw] product_type + # @return [String] `STICKER` + attr_accessor :product_type + # @!attribute [rw] send_present_message + # @return [Boolean] `false` + attr_accessor :send_present_message # @param to [String] Destination user ID # @param product_id [String] Package ID for a set of stickers diff --git a/lib/line/bot/v2/webhook/model/account_link_event.rb b/lib/line/bot/v2/webhook/model/account_link_event.rb index e8a62b75..1f19019e 100644 --- a/lib/line/bot/v2/webhook/model/account_link_event.rb +++ b/lib/line/bot/v2/webhook/model/account_link_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event object for when a user has linked their LINE account with a provider's service account. You can reply to account link events. class AccountLinkEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event. This property won't be included if linking the account has failed. + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. + attr_accessor :reply_token + # @!attribute [rw] link + # @return [LinkContent] attr_accessor :link # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/action_result.rb b/lib/line/bot/v2/webhook/model/action_result.rb index 02150241..a58e1826 100644 --- a/lib/line/bot/v2/webhook/model/action_result.rb +++ b/lib/line/bot/v2/webhook/model/action_result.rb @@ -12,8 +12,12 @@ module Bot module V2 module Webhook class ActionResult + # @!attribute [rw] type + # @return [String] ('void'|'binary') attr_accessor :type - attr_accessor :data # Base64-encoded binary data + # @!attribute [rw] data + # @return [String] Base64-encoded binary data + attr_accessor :data # @param type [String] ('void'|'binary') # @param data [String] Base64-encoded binary data diff --git a/lib/line/bot/v2/webhook/model/activated_event.rb b/lib/line/bot/v2/webhook/model/activated_event.rb index 18c5bbb5..91f2f5ba 100644 --- a/lib/line/bot/v2/webhook/model/activated_event.rb +++ b/lib/line/bot/v2/webhook/model/activated_event.rb @@ -15,12 +15,26 @@ module V2 module Webhook # This event indicates that the module channel has been switched to Active Channel by calling the Acquire Control API. Sent to the webhook URL server of the module channel. class ActivatedEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] chat_control + # @return [ChatControl] attr_accessor :chat_control # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/all_mentionee.rb b/lib/line/bot/v2/webhook/model/all_mentionee.rb index 75d6ae77..393e1789 100644 --- a/lib/line/bot/v2/webhook/model/all_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/all_mentionee.rb @@ -15,9 +15,15 @@ module V2 module Webhook # Mentioned target is entire group class AllMentionee < Mentionee - attr_reader :type # Mentioned target. - attr_accessor :index # Index position of the user mention for a character in text, with the first character being at position 0. - attr_accessor :length # The length of the text of the mentioned user. For a mention @example, 8 is the length. + # @!attribute [r] type + # @return [String] Mentioned target. + attr_reader :type + # @!attribute [rw] index + # @return [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + attr_accessor :index + # @!attribute [rw] length + # @return [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. + attr_accessor :length # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. diff --git a/lib/line/bot/v2/webhook/model/attached_module_content.rb b/lib/line/bot/v2/webhook/model/attached_module_content.rb index 8721a4a5..f708745d 100644 --- a/lib/line/bot/v2/webhook/model/attached_module_content.rb +++ b/lib/line/bot/v2/webhook/model/attached_module_content.rb @@ -14,9 +14,15 @@ module Bot module V2 module Webhook class AttachedModuleContent < ModuleContent - attr_reader :type # Type - attr_accessor :bot_id # User ID of the bot on the attached LINE Official Account - attr_accessor :scopes # An array of strings indicating the scope permitted by the admin of the LINE Official Account. + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] bot_id + # @return [String] User ID of the bot on the attached LINE Official Account + attr_accessor :bot_id + # @!attribute [rw] scopes + # @return [Array[String]] An array of strings indicating the scope permitted by the admin of the LINE Official Account. + attr_accessor :scopes # @param bot_id [String] User ID of the bot on the attached LINE Official Account # @param scopes [Array[String]] An array of strings indicating the scope permitted by the admin of the LINE Official Account. diff --git a/lib/line/bot/v2/webhook/model/audio_message_content.rb b/lib/line/bot/v2/webhook/model/audio_message_content.rb index c5962726..28def99b 100644 --- a/lib/line/bot/v2/webhook/model/audio_message_content.rb +++ b/lib/line/bot/v2/webhook/model/audio_message_content.rb @@ -14,10 +14,18 @@ module Bot module V2 module Webhook class AudioMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] content_provider + # @return [ContentProvider] attr_accessor :content_provider - attr_accessor :duration # Length of audio file (milliseconds) + # @!attribute [rw] duration + # @return [Integer] Length of audio file (milliseconds) + attr_accessor :duration # @param id [String] Message ID # @param content_provider [ContentProvider] diff --git a/lib/line/bot/v2/webhook/model/beacon_content.rb b/lib/line/bot/v2/webhook/model/beacon_content.rb index 5788d554..ffc3666c 100644 --- a/lib/line/bot/v2/webhook/model/beacon_content.rb +++ b/lib/line/bot/v2/webhook/model/beacon_content.rb @@ -12,9 +12,15 @@ module Bot module V2 module Webhook class BeaconContent - attr_accessor :hwid # Hardware ID of the beacon that was detected - attr_accessor :type # Type of beacon event. - attr_accessor :dm # Device message of beacon that was detected. + # @!attribute [rw] hwid + # @return [String] Hardware ID of the beacon that was detected + attr_accessor :hwid + # @!attribute [rw] type + # @return [String] ('enter'|'banner'|'stay') Type of beacon event. + attr_accessor :type + # @!attribute [rw] dm + # @return [String] Device message of beacon that was detected. + attr_accessor :dm # @param hwid [String] Hardware ID of the beacon that was detected # @param type [String] ('enter'|'banner'|'stay') Type of beacon event. diff --git a/lib/line/bot/v2/webhook/model/beacon_event.rb b/lib/line/bot/v2/webhook/model/beacon_event.rb index 81a102ee..9838d977 100644 --- a/lib/line/bot/v2/webhook/model/beacon_event.rb +++ b/lib/line/bot/v2/webhook/model/beacon_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event object for when a user enters the range of a LINE Beacon. You can reply to beacon events. class BeaconEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] beacon + # @return [BeaconContent] attr_accessor :beacon # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb index f39ff133..2e8b1ebd 100644 --- a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb @@ -15,11 +15,23 @@ module V2 module Webhook # This event indicates that the LINE Official Account has returned from the suspended state. Sent to the webhook URL server of the module channel. class BotResumedEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb index 4bc4755a..ac665ea6 100644 --- a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb @@ -15,11 +15,23 @@ module V2 module Webhook # This event indicates that the LINE Official Account has been suspended (Suspend). Sent to the webhook URL server of the module channel. class BotSuspendedEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/callback_request.rb b/lib/line/bot/v2/webhook/model/callback_request.rb index 8e8f3144..2b6c436d 100644 --- a/lib/line/bot/v2/webhook/model/callback_request.rb +++ b/lib/line/bot/v2/webhook/model/callback_request.rb @@ -14,8 +14,12 @@ module Webhook # The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects. # @see https://developers.line.biz/en/reference/messaging-api/#request-body class CallbackRequest - attr_accessor :destination # User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`. - attr_accessor :events # Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. + # @!attribute [rw] destination + # @return [String] User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`. + attr_accessor :destination + # @!attribute [rw] events + # @return [Array[Event]] Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. + attr_accessor :events # @param destination [String] User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`. # @param events [Array[Event]] Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. diff --git a/lib/line/bot/v2/webhook/model/chat_control.rb b/lib/line/bot/v2/webhook/model/chat_control.rb index 955ef0ab..5a319a7e 100644 --- a/lib/line/bot/v2/webhook/model/chat_control.rb +++ b/lib/line/bot/v2/webhook/model/chat_control.rb @@ -12,6 +12,8 @@ module Bot module V2 module Webhook class ChatControl + # @!attribute [rw] expire_at + # @return [Integer] attr_accessor :expire_at # @param expire_at [Integer] diff --git a/lib/line/bot/v2/webhook/model/content_provider.rb b/lib/line/bot/v2/webhook/model/content_provider.rb index 85dc9932..c395d29f 100644 --- a/lib/line/bot/v2/webhook/model/content_provider.rb +++ b/lib/line/bot/v2/webhook/model/content_provider.rb @@ -13,9 +13,15 @@ module V2 module Webhook # Provider of the media file. class ContentProvider - attr_accessor :type # Provider of the image file. - attr_accessor :original_content_url # URL of the image file. Only included when contentProvider.type is external. - attr_accessor :preview_image_url # URL of the preview image. Only included when contentProvider.type is external. + # @!attribute [rw] type + # @return [String] ('line'|'external') Provider of the image file. + attr_accessor :type + # @!attribute [rw] original_content_url + # @return [String] URL of the image file. Only included when contentProvider.type is external. + attr_accessor :original_content_url + # @!attribute [rw] preview_image_url + # @return [String] URL of the preview image. Only included when contentProvider.type is external. + attr_accessor :preview_image_url # @param type [String] ('line'|'external') Provider of the image file. # @param original_content_url [String] URL of the image file. Only included when contentProvider.type is external. diff --git a/lib/line/bot/v2/webhook/model/deactivated_event.rb b/lib/line/bot/v2/webhook/model/deactivated_event.rb index 565d3024..bea55bad 100644 --- a/lib/line/bot/v2/webhook/model/deactivated_event.rb +++ b/lib/line/bot/v2/webhook/model/deactivated_event.rb @@ -15,11 +15,23 @@ module V2 module Webhook # This event indicates that the module channel has been switched to Standby Channel by calling Acquire Control API or Release Control API. Sent to the webhook URL server of the module channel. class DeactivatedEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/delivery_context.rb b/lib/line/bot/v2/webhook/model/delivery_context.rb index 794e082f..01cfc968 100644 --- a/lib/line/bot/v2/webhook/model/delivery_context.rb +++ b/lib/line/bot/v2/webhook/model/delivery_context.rb @@ -13,7 +13,9 @@ module V2 module Webhook # webhook's delivery context information class DeliveryContext - attr_accessor :is_redelivery # Whether the webhook event is a redelivered one or not. + # @!attribute [rw] is_redelivery + # @return [Boolean] Whether the webhook event is a redelivered one or not. + attr_accessor :is_redelivery # @param is_redelivery [Boolean] Whether the webhook event is a redelivered one or not. def initialize( diff --git a/lib/line/bot/v2/webhook/model/detached_module_content.rb b/lib/line/bot/v2/webhook/model/detached_module_content.rb index dc749589..109fd089 100644 --- a/lib/line/bot/v2/webhook/model/detached_module_content.rb +++ b/lib/line/bot/v2/webhook/model/detached_module_content.rb @@ -14,9 +14,15 @@ module Bot module V2 module Webhook class DetachedModuleContent < ModuleContent - attr_reader :type # Type - attr_accessor :bot_id # Detached LINE Official Account bot user ID - attr_accessor :reason # Reason for detaching + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] bot_id + # @return [String] Detached LINE Official Account bot user ID + attr_accessor :bot_id + # @!attribute [rw] reason + # @return [String] ('bot_deleted') Reason for detaching + attr_accessor :reason # @param bot_id [String] Detached LINE Official Account bot user ID # @param reason [String] ('bot_deleted') Reason for detaching diff --git a/lib/line/bot/v2/webhook/model/emoji.rb b/lib/line/bot/v2/webhook/model/emoji.rb index f6098275..1ca3bae4 100644 --- a/lib/line/bot/v2/webhook/model/emoji.rb +++ b/lib/line/bot/v2/webhook/model/emoji.rb @@ -12,10 +12,18 @@ module Bot module V2 module Webhook class Emoji - attr_accessor :index # Index position for a character in text, with the first character being at position 0. - attr_accessor :length # The length of the LINE emoji string. For LINE emoji (hello), 7 is the length. - attr_accessor :product_id # Product ID for a LINE emoji set. - attr_accessor :emoji_id # ID for a LINE emoji inside a set. + # @!attribute [rw] index + # @return [Integer] Index position for a character in text, with the first character being at position 0. + attr_accessor :index + # @!attribute [rw] length + # @return [Integer] The length of the LINE emoji string. For LINE emoji (hello), 7 is the length. + attr_accessor :length + # @!attribute [rw] product_id + # @return [String] Product ID for a LINE emoji set. + attr_accessor :product_id + # @!attribute [rw] emoji_id + # @return [String] ID for a LINE emoji inside a set. + attr_accessor :emoji_id # @param index [Integer] Index position for a character in text, with the first character being at position 0. # @param length [Integer] The length of the LINE emoji string. For LINE emoji (hello), 7 is the length. diff --git a/lib/line/bot/v2/webhook/model/event.rb b/lib/line/bot/v2/webhook/model/event.rb index e2faeef2..65454c33 100644 --- a/lib/line/bot/v2/webhook/model/event.rb +++ b/lib/line/bot/v2/webhook/model/event.rb @@ -13,11 +13,23 @@ module V2 module Webhook # Webhook event class Event - attr_accessor :type # Type of the event + # @!attribute [rw] type + # @return [String] Type of the event + attr_accessor :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param type [String] Type of the event diff --git a/lib/line/bot/v2/webhook/model/file_message_content.rb b/lib/line/bot/v2/webhook/model/file_message_content.rb index 6909d919..bf3e933e 100644 --- a/lib/line/bot/v2/webhook/model/file_message_content.rb +++ b/lib/line/bot/v2/webhook/model/file_message_content.rb @@ -14,10 +14,18 @@ module Bot module V2 module Webhook class FileMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID - attr_accessor :file_name # File name - attr_accessor :file_size # File size in bytes + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] file_name + # @return [String] File name + attr_accessor :file_name + # @!attribute [rw] file_size + # @return [Integer] File size in bytes + attr_accessor :file_size # @param id [String] Message ID # @param file_name [String] File name diff --git a/lib/line/bot/v2/webhook/model/follow_detail.rb b/lib/line/bot/v2/webhook/model/follow_detail.rb index f514d6d1..dff37770 100644 --- a/lib/line/bot/v2/webhook/model/follow_detail.rb +++ b/lib/line/bot/v2/webhook/model/follow_detail.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class FollowDetail - attr_accessor :is_unblocked # Whether a user has added your LINE Official Account as a friend or unblocked. + # @!attribute [rw] is_unblocked + # @return [Boolean] Whether a user has added your LINE Official Account as a friend or unblocked. + attr_accessor :is_unblocked # @param is_unblocked [Boolean] Whether a user has added your LINE Official Account as a friend or unblocked. def initialize( diff --git a/lib/line/bot/v2/webhook/model/follow_event.rb b/lib/line/bot/v2/webhook/model/follow_event.rb index 7312092c..8d63eb47 100644 --- a/lib/line/bot/v2/webhook/model/follow_event.rb +++ b/lib/line/bot/v2/webhook/model/follow_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event object for when your LINE Official Account is added as a friend (or unblocked). You can reply to follow events. class FollowEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] follow + # @return [FollowDetail] attr_accessor :follow # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/group_source.rb b/lib/line/bot/v2/webhook/model/group_source.rb index 7212bbba..159f7604 100644 --- a/lib/line/bot/v2/webhook/model/group_source.rb +++ b/lib/line/bot/v2/webhook/model/group_source.rb @@ -14,9 +14,15 @@ module Bot module V2 module Webhook class GroupSource < Source - attr_reader :type # source type - attr_accessor :group_id # Group ID of the source group chat - attr_accessor :user_id # ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @!attribute [r] type + # @return [String] source type + attr_reader :type + # @!attribute [rw] group_id + # @return [String] Group ID of the source group chat + attr_accessor :group_id + # @!attribute [rw] user_id + # @return [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + attr_accessor :user_id # @param group_id [String] Group ID of the source group chat # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. diff --git a/lib/line/bot/v2/webhook/model/image_message_content.rb b/lib/line/bot/v2/webhook/model/image_message_content.rb index 9007f723..9ff5f192 100644 --- a/lib/line/bot/v2/webhook/model/image_message_content.rb +++ b/lib/line/bot/v2/webhook/model/image_message_content.rb @@ -14,11 +14,21 @@ module Bot module V2 module Webhook class ImageMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] content_provider + # @return [ContentProvider] attr_accessor :content_provider + # @!attribute [rw] image_set + # @return [ImageSet] attr_accessor :image_set - attr_accessor :quote_token # Quote token to quote this message. + # @!attribute [rw] quote_token + # @return [String] Quote token to quote this message. + attr_accessor :quote_token # @param id [String] Message ID # @param content_provider [ContentProvider] diff --git a/lib/line/bot/v2/webhook/model/image_set.rb b/lib/line/bot/v2/webhook/model/image_set.rb index 752729e8..d7450d2a 100644 --- a/lib/line/bot/v2/webhook/model/image_set.rb +++ b/lib/line/bot/v2/webhook/model/image_set.rb @@ -12,9 +12,15 @@ module Bot module V2 module Webhook class ImageSet - attr_accessor :id # Image set ID. Only included when multiple images are sent simultaneously. - attr_accessor :index # An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. - attr_accessor :total # The total number of images sent simultaneously. + # @!attribute [rw] id + # @return [String] Image set ID. Only included when multiple images are sent simultaneously. + attr_accessor :id + # @!attribute [rw] index + # @return [Integer] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. + attr_accessor :index + # @!attribute [rw] total + # @return [Integer] The total number of images sent simultaneously. + attr_accessor :total # @param id [String] Image set ID. Only included when multiple images are sent simultaneously. # @param index [Integer] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. diff --git a/lib/line/bot/v2/webhook/model/join_event.rb b/lib/line/bot/v2/webhook/model/join_event.rb index 6aba00ec..049d7c6e 100644 --- a/lib/line/bot/v2/webhook/model/join_event.rb +++ b/lib/line/bot/v2/webhook/model/join_event.rb @@ -15,13 +15,27 @@ module V2 module Webhook # Event object for when your LINE Official Account joins a group chat or multi-person chat. You can reply to join events. class JoinEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token # @param source [Source] # @param timestamp [Integer] Time of the event in milliseconds. diff --git a/lib/line/bot/v2/webhook/model/joined_members.rb b/lib/line/bot/v2/webhook/model/joined_members.rb index 20f67215..1a5cc9f4 100644 --- a/lib/line/bot/v2/webhook/model/joined_members.rb +++ b/lib/line/bot/v2/webhook/model/joined_members.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class JoinedMembers - attr_accessor :members # Users who joined. Array of source user objects. + # @!attribute [rw] members + # @return [Array[UserSource]] Users who joined. Array of source user objects. + attr_accessor :members # @param members [Array[UserSource]] Users who joined. Array of source user objects. def initialize( diff --git a/lib/line/bot/v2/webhook/model/joined_membership_content.rb b/lib/line/bot/v2/webhook/model/joined_membership_content.rb index 304e8f97..3aea623c 100644 --- a/lib/line/bot/v2/webhook/model/joined_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/joined_membership_content.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class JoinedMembershipContent < MembershipContent - attr_reader :type # Type of membership event. - attr_accessor :membership_id # The ID of the membership that the user joined. This is defined for each membership. + # @!attribute [r] type + # @return [String] Type of membership event. + attr_reader :type + # @!attribute [rw] membership_id + # @return [Integer] The ID of the membership that the user joined. This is defined for each membership. + attr_accessor :membership_id # @param membership_id [Integer] The ID of the membership that the user joined. This is defined for each membership. def initialize( diff --git a/lib/line/bot/v2/webhook/model/leave_event.rb b/lib/line/bot/v2/webhook/model/leave_event.rb index f71fc41d..cc7ac6d5 100644 --- a/lib/line/bot/v2/webhook/model/leave_event.rb +++ b/lib/line/bot/v2/webhook/model/leave_event.rb @@ -15,11 +15,23 @@ module V2 module Webhook # 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. class LeaveEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/left_members.rb b/lib/line/bot/v2/webhook/model/left_members.rb index a91ed938..1a4cfe1c 100644 --- a/lib/line/bot/v2/webhook/model/left_members.rb +++ b/lib/line/bot/v2/webhook/model/left_members.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class LeftMembers - attr_accessor :members # Users who left. Array of source user objects. + # @!attribute [rw] members + # @return [Array[UserSource]] Users who left. Array of source user objects. + attr_accessor :members # @param members [Array[UserSource]] Users who left. Array of source user objects. def initialize( diff --git a/lib/line/bot/v2/webhook/model/left_membership_content.rb b/lib/line/bot/v2/webhook/model/left_membership_content.rb index 736318dc..048dfcad 100644 --- a/lib/line/bot/v2/webhook/model/left_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/left_membership_content.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class LeftMembershipContent < MembershipContent - attr_reader :type # Type of membership event. - attr_accessor :membership_id # The ID of the membership that the user left. This is defined for each membership. + # @!attribute [r] type + # @return [String] Type of membership event. + attr_reader :type + # @!attribute [rw] membership_id + # @return [Integer] The ID of the membership that the user left. This is defined for each membership. + attr_accessor :membership_id # @param membership_id [Integer] The ID of the membership that the user left. This is defined for each membership. def initialize( diff --git a/lib/line/bot/v2/webhook/model/link_content.rb b/lib/line/bot/v2/webhook/model/link_content.rb index c622fa80..a5a4cc6c 100644 --- a/lib/line/bot/v2/webhook/model/link_content.rb +++ b/lib/line/bot/v2/webhook/model/link_content.rb @@ -13,8 +13,12 @@ module V2 module Webhook # Content of the account link event. class LinkContent - attr_accessor :result # One of the following values to indicate whether linking the account was successful or not - attr_accessor :nonce # Specified nonce (number used once) when verifying the user ID. + # @!attribute [rw] result + # @return [String] ('ok'|'failed') One of the following values to indicate whether linking the account was successful or not + attr_accessor :result + # @!attribute [rw] nonce + # @return [String] Specified nonce (number used once) when verifying the user ID. + attr_accessor :nonce # @param result [String] ('ok'|'failed') One of the following values to indicate whether linking the account was successful or not # @param nonce [String] Specified nonce (number used once) when verifying the user ID. diff --git a/lib/line/bot/v2/webhook/model/link_things_content.rb b/lib/line/bot/v2/webhook/model/link_things_content.rb index a6561bfd..fe5e7c0e 100644 --- a/lib/line/bot/v2/webhook/model/link_things_content.rb +++ b/lib/line/bot/v2/webhook/model/link_things_content.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class LinkThingsContent < ThingsContent - attr_reader :type # Type - attr_accessor :device_id # Device ID of the device that has been linked with LINE. + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] device_id + # @return [String] Device ID of the device that has been linked with LINE. + attr_accessor :device_id # @param device_id [String] Device ID of the device that has been linked with LINE. def initialize( diff --git a/lib/line/bot/v2/webhook/model/location_message_content.rb b/lib/line/bot/v2/webhook/model/location_message_content.rb index 24c94505..14201d60 100644 --- a/lib/line/bot/v2/webhook/model/location_message_content.rb +++ b/lib/line/bot/v2/webhook/model/location_message_content.rb @@ -14,12 +14,24 @@ module Bot module V2 module Webhook class LocationMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID - attr_accessor :title # Title - attr_accessor :address # Address - attr_accessor :latitude # Latitude - attr_accessor :longitude # Longitude + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] title + # @return [String] Title + attr_accessor :title + # @!attribute [rw] address + # @return [String] Address + attr_accessor :address + # @!attribute [rw] latitude + # @return [Float] Latitude + attr_accessor :latitude + # @!attribute [rw] longitude + # @return [Float] Longitude + attr_accessor :longitude # @param id [String] Message ID # @param title [String] Title diff --git a/lib/line/bot/v2/webhook/model/member_joined_event.rb b/lib/line/bot/v2/webhook/model/member_joined_event.rb index df83b1b3..764027b7 100644 --- a/lib/line/bot/v2/webhook/model/member_joined_event.rb +++ b/lib/line/bot/v2/webhook/model/member_joined_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event object for when a user joins a group chat or multi-person chat that the LINE Official Account is in. class MemberJoinedEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] joined + # @return [JoinedMembers] attr_accessor :joined # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/member_left_event.rb b/lib/line/bot/v2/webhook/model/member_left_event.rb index a6c6f6d7..f50aaab0 100644 --- a/lib/line/bot/v2/webhook/model/member_left_event.rb +++ b/lib/line/bot/v2/webhook/model/member_left_event.rb @@ -15,12 +15,26 @@ module V2 module Webhook # Event object for when a user leaves a group chat or multi-person chat that the LINE Official Account is in. class MemberLeftEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] left + # @return [LeftMembers] attr_accessor :left # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/membership_content.rb b/lib/line/bot/v2/webhook/model/membership_content.rb index c35e20ca..46a43420 100644 --- a/lib/line/bot/v2/webhook/model/membership_content.rb +++ b/lib/line/bot/v2/webhook/model/membership_content.rb @@ -13,7 +13,9 @@ module V2 module Webhook # Content of the membership event. class MembershipContent - attr_accessor :type # Type of membership event. + # @!attribute [rw] type + # @return [String] Type of membership event. + attr_accessor :type # @param type [String] Type of membership event. def initialize( diff --git a/lib/line/bot/v2/webhook/model/membership_event.rb b/lib/line/bot/v2/webhook/model/membership_event.rb index 84fc7815..5b7f6943 100644 --- a/lib/line/bot/v2/webhook/model/membership_event.rb +++ b/lib/line/bot/v2/webhook/model/membership_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # This event indicates that a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership. class MembershipEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] membership + # @return [MembershipContent] attr_accessor :membership # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/mention.rb b/lib/line/bot/v2/webhook/model/mention.rb index da0a4be3..179955a7 100644 --- a/lib/line/bot/v2/webhook/model/mention.rb +++ b/lib/line/bot/v2/webhook/model/mention.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class Mention - attr_accessor :mentionees # Array of one or more mention objects. Max: 20 mentions + # @!attribute [rw] mentionees + # @return [Array[Mentionee]] Array of one or more mention objects. Max: 20 mentions + attr_accessor :mentionees # @param mentionees [Array[Mentionee]] Array of one or more mention objects. Max: 20 mentions def initialize( diff --git a/lib/line/bot/v2/webhook/model/mentionee.rb b/lib/line/bot/v2/webhook/model/mentionee.rb index 90311903..81483a15 100644 --- a/lib/line/bot/v2/webhook/model/mentionee.rb +++ b/lib/line/bot/v2/webhook/model/mentionee.rb @@ -13,9 +13,15 @@ module V2 module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#wh-text class Mentionee - attr_accessor :type # Mentioned target. - attr_accessor :index # Index position of the user mention for a character in text, with the first character being at position 0. - attr_accessor :length # The length of the text of the mentioned user. For a mention @example, 8 is the length. + # @!attribute [rw] type + # @return [String] Mentioned target. + attr_accessor :type + # @!attribute [rw] index + # @return [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + attr_accessor :index + # @!attribute [rw] length + # @return [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. + attr_accessor :length # @param type [String] Mentioned target. # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. diff --git a/lib/line/bot/v2/webhook/model/message_content.rb b/lib/line/bot/v2/webhook/model/message_content.rb index 6f026647..5b65cc9e 100644 --- a/lib/line/bot/v2/webhook/model/message_content.rb +++ b/lib/line/bot/v2/webhook/model/message_content.rb @@ -13,8 +13,12 @@ module V2 module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#message-event class MessageContent - attr_accessor :type # Type - attr_accessor :id # Message ID + # @!attribute [rw] type + # @return [String] Type + attr_accessor :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id # @param type [String] Type # @param id [String] Message ID diff --git a/lib/line/bot/v2/webhook/model/message_event.rb b/lib/line/bot/v2/webhook/model/message_event.rb index 6107351b..25e11f84 100644 --- a/lib/line/bot/v2/webhook/model/message_event.rb +++ b/lib/line/bot/v2/webhook/model/message_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Webhook event object which contains the sent message. class MessageEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] reply_token + # @return [String] attr_accessor :reply_token + # @!attribute [rw] message + # @return [MessageContent] attr_accessor :message # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/module_content.rb b/lib/line/bot/v2/webhook/model/module_content.rb index 984be394..c861e6e3 100644 --- a/lib/line/bot/v2/webhook/model/module_content.rb +++ b/lib/line/bot/v2/webhook/model/module_content.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class ModuleContent - attr_accessor :type # Type + # @!attribute [rw] type + # @return [String] Type + attr_accessor :type # @param type [String] Type def initialize( diff --git a/lib/line/bot/v2/webhook/model/module_event.rb b/lib/line/bot/v2/webhook/model/module_event.rb index ffbf164d..4108c61c 100644 --- a/lib/line/bot/v2/webhook/model/module_event.rb +++ b/lib/line/bot/v2/webhook/model/module_event.rb @@ -15,12 +15,26 @@ module V2 module Webhook # 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. class ModuleEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] _module + # @return [ModuleContent] attr_accessor :_module # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/pnp_delivery.rb b/lib/line/bot/v2/webhook/model/pnp_delivery.rb index 1c9ff825..fe43f01d 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery.rb @@ -13,7 +13,9 @@ module V2 module Webhook # A delivery object containing a hashed phone number string or a string specified by `X-Line-Delivery-Tag` header class PnpDelivery - attr_accessor :data # A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header + # @!attribute [rw] data + # @return [String] A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header + attr_accessor :data # @param data [String] A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header def initialize( diff --git a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb index 0565d631..b1dd5b6d 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb @@ -15,12 +15,26 @@ module V2 module Webhook # 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. class PnpDeliveryCompletionEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] delivery + # @return [PnpDelivery] attr_accessor :delivery # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/postback_content.rb b/lib/line/bot/v2/webhook/model/postback_content.rb index a9fbe465..e966ac27 100644 --- a/lib/line/bot/v2/webhook/model/postback_content.rb +++ b/lib/line/bot/v2/webhook/model/postback_content.rb @@ -12,7 +12,11 @@ module Bot module V2 module Webhook class PostbackContent - attr_accessor :data # Postback data + # @!attribute [rw] data + # @return [String] Postback data + attr_accessor :data + # @!attribute [rw] params + # @return [Object] attr_accessor :params # @param data [String] Postback data diff --git a/lib/line/bot/v2/webhook/model/postback_event.rb b/lib/line/bot/v2/webhook/model/postback_event.rb index ceba1157..a5cf7871 100644 --- a/lib/line/bot/v2/webhook/model/postback_event.rb +++ b/lib/line/bot/v2/webhook/model/postback_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event object for when a user performs a postback action which initiates a postback. You can reply to postback events. class PostbackEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] postback + # @return [PostbackContent] attr_accessor :postback # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/renewed_membership_content.rb b/lib/line/bot/v2/webhook/model/renewed_membership_content.rb index 6f183f04..558027f4 100644 --- a/lib/line/bot/v2/webhook/model/renewed_membership_content.rb +++ b/lib/line/bot/v2/webhook/model/renewed_membership_content.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class RenewedMembershipContent < MembershipContent - attr_reader :type # Type of membership event. - attr_accessor :membership_id # The ID of the membership that the user renewed. This is defined for each membership. + # @!attribute [r] type + # @return [String] Type of membership event. + attr_reader :type + # @!attribute [rw] membership_id + # @return [Integer] The ID of the membership that the user renewed. This is defined for each membership. + attr_accessor :membership_id # @param membership_id [Integer] The ID of the membership that the user renewed. This is defined for each membership. def initialize( diff --git a/lib/line/bot/v2/webhook/model/room_source.rb b/lib/line/bot/v2/webhook/model/room_source.rb index 4f8676e0..8ec37efb 100644 --- a/lib/line/bot/v2/webhook/model/room_source.rb +++ b/lib/line/bot/v2/webhook/model/room_source.rb @@ -14,9 +14,15 @@ module Bot module V2 module Webhook class RoomSource < Source - attr_reader :type # source type - attr_accessor :user_id # ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. - attr_accessor :room_id # Room ID of the source multi-person chat + # @!attribute [r] type + # @return [String] source type + attr_reader :type + # @!attribute [rw] user_id + # @return [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + attr_accessor :user_id + # @!attribute [rw] room_id + # @return [String] Room ID of the source multi-person chat + attr_accessor :room_id # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. # @param room_id [String] Room ID of the source multi-person chat diff --git a/lib/line/bot/v2/webhook/model/scenario_result.rb b/lib/line/bot/v2/webhook/model/scenario_result.rb index 803b1d1c..a197aa51 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result.rb @@ -13,14 +13,30 @@ module V2 module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#scenario-result-event class ScenarioResult - attr_accessor :scenario_id # Scenario ID executed - attr_accessor :revision # Revision number of the scenario set containing the executed scenario - attr_accessor :start_time # Timestamp for when execution of scenario action started (milliseconds, LINE app time) - attr_accessor :end_time # Timestamp for when execution of scenario was completed (milliseconds, LINE app time) - attr_accessor :result_code # Scenario execution completion status - attr_accessor :action_results # Execution result of individual operations specified in action. Only included when things.result.resultCode is success. - attr_accessor :ble_notification_payload # Data contained in notification. - attr_accessor :error_reason # Error reason. + # @!attribute [rw] scenario_id + # @return [String] Scenario ID executed + attr_accessor :scenario_id + # @!attribute [rw] revision + # @return [Integer] Revision number of the scenario set containing the executed scenario + attr_accessor :revision + # @!attribute [rw] start_time + # @return [Integer] Timestamp for when execution of scenario action started (milliseconds, LINE app time) + attr_accessor :start_time + # @!attribute [rw] end_time + # @return [Integer] Timestamp for when execution of scenario was completed (milliseconds, LINE app time) + attr_accessor :end_time + # @!attribute [rw] result_code + # @return [String] Scenario execution completion status + attr_accessor :result_code + # @!attribute [rw] action_results + # @return [Array[ActionResult]] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. + attr_accessor :action_results + # @!attribute [rw] ble_notification_payload + # @return [String] Data contained in notification. + attr_accessor :ble_notification_payload + # @!attribute [rw] error_reason + # @return [String] Error reason. + attr_accessor :error_reason # @param scenario_id [String] Scenario ID executed # @param revision [Integer] Revision number of the scenario set containing the executed scenario diff --git a/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb b/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb index fee3468d..71fe43f4 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb @@ -14,8 +14,14 @@ module Bot module V2 module Webhook class ScenarioResultThingsContent < ThingsContent - attr_reader :type # Type - attr_accessor :device_id # Device ID of the device that has been linked with LINE. + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] device_id + # @return [String] Device ID of the device that has been linked with LINE. + attr_accessor :device_id + # @!attribute [rw] result + # @return [ScenarioResult] attr_accessor :result # @param device_id [String] Device ID of the device that has been linked with LINE. diff --git a/lib/line/bot/v2/webhook/model/source.rb b/lib/line/bot/v2/webhook/model/source.rb index 62af0b74..aa150fe1 100644 --- a/lib/line/bot/v2/webhook/model/source.rb +++ b/lib/line/bot/v2/webhook/model/source.rb @@ -14,7 +14,9 @@ module Webhook # the source of the event. # @see https://developers.line.biz/en/reference/messaging-api/#source-user class Source - attr_accessor :type # source type + # @!attribute [rw] type + # @return [String] source type + attr_accessor :type # @param type [String] source type def initialize( diff --git a/lib/line/bot/v2/webhook/model/sticker_message_content.rb b/lib/line/bot/v2/webhook/model/sticker_message_content.rb index 97103adc..e74c3700 100644 --- a/lib/line/bot/v2/webhook/model/sticker_message_content.rb +++ b/lib/line/bot/v2/webhook/model/sticker_message_content.rb @@ -15,15 +15,33 @@ module V2 module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#wh-sticker class StickerMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID - attr_accessor :package_id # Package ID - attr_accessor :sticker_id # Sticker ID + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] package_id + # @return [String] Package ID + attr_accessor :package_id + # @!attribute [rw] sticker_id + # @return [String] Sticker ID + attr_accessor :sticker_id + # @!attribute [rw] sticker_resource_type + # @return [String] ('STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT') attr_accessor :sticker_resource_type - attr_accessor :keywords # Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. - attr_accessor :text # Any text entered by the user. This property is only included for message stickers. Max character limit: 100 - attr_accessor :quote_token # Quote token to quote this message. - attr_accessor :quoted_message_id # Message ID of a quoted message. Only included when the received message quotes a past message. + # @!attribute [rw] keywords + # @return [Array[String]] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. + attr_accessor :keywords + # @!attribute [rw] text + # @return [String] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 + attr_accessor :text + # @!attribute [rw] quote_token + # @return [String] Quote token to quote this message. + attr_accessor :quote_token + # @!attribute [rw] quoted_message_id + # @return [String] Message ID of a quoted message. Only included when the received message quotes a past message. + attr_accessor :quoted_message_id # @param id [String] Message ID # @param package_id [String] Package ID diff --git a/lib/line/bot/v2/webhook/model/text_message_content.rb b/lib/line/bot/v2/webhook/model/text_message_content.rb index aeae6677..65c00517 100644 --- a/lib/line/bot/v2/webhook/model/text_message_content.rb +++ b/lib/line/bot/v2/webhook/model/text_message_content.rb @@ -14,13 +14,27 @@ module Bot module V2 module Webhook class TextMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID - attr_accessor :text # Message text. - attr_accessor :emojis # Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] text + # @return [String] Message text. + attr_accessor :text + # @!attribute [rw] emojis + # @return [Array[Emoji]] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. + attr_accessor :emojis + # @!attribute [rw] mention + # @return [Mention] attr_accessor :mention - attr_accessor :quote_token # Quote token to quote this message. - attr_accessor :quoted_message_id # Message ID of a quoted message. Only included when the received message quotes a past message. + # @!attribute [rw] quote_token + # @return [String] Quote token to quote this message. + attr_accessor :quote_token + # @!attribute [rw] quoted_message_id + # @return [String] Message ID of a quoted message. Only included when the received message quotes a past message. + attr_accessor :quoted_message_id # @param id [String] Message ID # @param text [String] Message text. diff --git a/lib/line/bot/v2/webhook/model/things_content.rb b/lib/line/bot/v2/webhook/model/things_content.rb index d5034101..74aa4c6f 100644 --- a/lib/line/bot/v2/webhook/model/things_content.rb +++ b/lib/line/bot/v2/webhook/model/things_content.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class ThingsContent - attr_accessor :type # Type + # @!attribute [rw] type + # @return [String] Type + attr_accessor :type # @param type [String] Type def initialize( diff --git a/lib/line/bot/v2/webhook/model/things_event.rb b/lib/line/bot/v2/webhook/model/things_event.rb index e65b9c34..4e732e11 100644 --- a/lib/line/bot/v2/webhook/model/things_event.rb +++ b/lib/line/bot/v2/webhook/model/things_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Indicates that a user linked a device with LINE. class ThingsEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] things + # @return [ThingsContent] attr_accessor :things # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/unfollow_event.rb b/lib/line/bot/v2/webhook/model/unfollow_event.rb index 116f8c3a..269f2cce 100644 --- a/lib/line/bot/v2/webhook/model/unfollow_event.rb +++ b/lib/line/bot/v2/webhook/model/unfollow_event.rb @@ -15,11 +15,23 @@ module V2 module Webhook # Event object for when your LINE Official Account is blocked. class UnfollowEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/unlink_things_content.rb b/lib/line/bot/v2/webhook/model/unlink_things_content.rb index 872b65a0..01728c86 100644 --- a/lib/line/bot/v2/webhook/model/unlink_things_content.rb +++ b/lib/line/bot/v2/webhook/model/unlink_things_content.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class UnlinkThingsContent < ThingsContent - attr_reader :type # Type - attr_accessor :device_id # Device ID of the device that has been linked with LINE. + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] device_id + # @return [String] Device ID of the device that has been linked with LINE. + attr_accessor :device_id # @param device_id [String] Device ID of the device that has been linked with LINE. def initialize( diff --git a/lib/line/bot/v2/webhook/model/unsend_detail.rb b/lib/line/bot/v2/webhook/model/unsend_detail.rb index 2310d4ed..b0547ddb 100644 --- a/lib/line/bot/v2/webhook/model/unsend_detail.rb +++ b/lib/line/bot/v2/webhook/model/unsend_detail.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class UnsendDetail - attr_accessor :message_id # The message ID of the unsent message + # @!attribute [rw] message_id + # @return [String] The message ID of the unsent message + attr_accessor :message_id # @param message_id [String] The message ID of the unsent message def initialize( diff --git a/lib/line/bot/v2/webhook/model/unsend_event.rb b/lib/line/bot/v2/webhook/model/unsend_event.rb index b2765f32..97230489 100644 --- a/lib/line/bot/v2/webhook/model/unsend_event.rb +++ b/lib/line/bot/v2/webhook/model/unsend_event.rb @@ -15,12 +15,26 @@ module V2 module Webhook # Event object for when the user unsends a message. class UnsendEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context + # @!attribute [rw] unsend + # @return [UnsendDetail] attr_accessor :unsend # @param source [Source] diff --git a/lib/line/bot/v2/webhook/model/user_mentionee.rb b/lib/line/bot/v2/webhook/model/user_mentionee.rb index c30f006b..cfb221eb 100644 --- a/lib/line/bot/v2/webhook/model/user_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/user_mentionee.rb @@ -15,11 +15,21 @@ module V2 module Webhook # Mentioned target is user class UserMentionee < Mentionee - attr_reader :type # Mentioned target. - attr_accessor :index # Index position of the user mention for a character in text, with the first character being at position 0. - attr_accessor :length # The length of the text of the mentioned user. For a mention @example, 8 is the length. - attr_accessor :user_id # User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. - attr_accessor :is_self # Whether the mentioned user is the bot that receives the webhook. + # @!attribute [r] type + # @return [String] Mentioned target. + attr_reader :type + # @!attribute [rw] index + # @return [Integer] Index position of the user mention for a character in text, with the first character being at position 0. + attr_accessor :index + # @!attribute [rw] length + # @return [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. + attr_accessor :length + # @!attribute [rw] user_id + # @return [String] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. + attr_accessor :user_id + # @!attribute [rw] is_self + # @return [Boolean] Whether the mentioned user is the bot that receives the webhook. + attr_accessor :is_self # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. diff --git a/lib/line/bot/v2/webhook/model/user_source.rb b/lib/line/bot/v2/webhook/model/user_source.rb index 7c1fa840..74eac535 100644 --- a/lib/line/bot/v2/webhook/model/user_source.rb +++ b/lib/line/bot/v2/webhook/model/user_source.rb @@ -14,8 +14,12 @@ module Bot module V2 module Webhook class UserSource < Source - attr_reader :type # source type - attr_accessor :user_id # ID of the source user + # @!attribute [r] type + # @return [String] source type + attr_reader :type + # @!attribute [rw] user_id + # @return [String] ID of the source user + attr_accessor :user_id # @param user_id [String] ID of the source user def initialize( diff --git a/lib/line/bot/v2/webhook/model/video_message_content.rb b/lib/line/bot/v2/webhook/model/video_message_content.rb index 8a4aa452..deb08a76 100644 --- a/lib/line/bot/v2/webhook/model/video_message_content.rb +++ b/lib/line/bot/v2/webhook/model/video_message_content.rb @@ -14,11 +14,21 @@ module Bot module V2 module Webhook class VideoMessageContent < MessageContent - attr_reader :type # Type - attr_accessor :id # Message ID - attr_accessor :duration # Length of video file (milliseconds) + # @!attribute [r] type + # @return [String] Type + attr_reader :type + # @!attribute [rw] id + # @return [String] Message ID + attr_accessor :id + # @!attribute [rw] duration + # @return [Integer] Length of video file (milliseconds) + attr_accessor :duration + # @!attribute [rw] content_provider + # @return [ContentProvider] attr_accessor :content_provider - attr_accessor :quote_token # Quote token to quote this message. + # @!attribute [rw] quote_token + # @return [String] Quote token to quote this message. + attr_accessor :quote_token # @param id [String] Message ID # @param duration [Integer] Length of video file (milliseconds) diff --git a/lib/line/bot/v2/webhook/model/video_play_complete.rb b/lib/line/bot/v2/webhook/model/video_play_complete.rb index ae5f7551..96b6ecfc 100644 --- a/lib/line/bot/v2/webhook/model/video_play_complete.rb +++ b/lib/line/bot/v2/webhook/model/video_play_complete.rb @@ -12,7 +12,9 @@ module Bot module V2 module Webhook class VideoPlayComplete - attr_accessor :tracking_id # ID used to identify a video. Returns the same value as the trackingId assigned to the video message. + # @!attribute [rw] tracking_id + # @return [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message. + attr_accessor :tracking_id # @param tracking_id [String] ID used to identify a video. Returns the same value as the trackingId assigned to the video message. def initialize( diff --git a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb index 374c8059..89e68150 100644 --- a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb +++ b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb @@ -15,13 +15,29 @@ module V2 module Webhook # Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account. class VideoPlayCompleteEvent < Event - attr_reader :type # Type of the event + # @!attribute [r] type + # @return [String] Type of the event + attr_reader :type + # @!attribute [rw] source + # @return [Source] attr_accessor :source - attr_accessor :timestamp # Time of the event in milliseconds. + # @!attribute [rw] timestamp + # @return [Integer] Time of the event in milliseconds. + attr_accessor :timestamp + # @!attribute [rw] mode + # @return [String] ('active'|'standby') attr_accessor :mode - attr_accessor :webhook_event_id # Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + # @!attribute [rw] webhook_event_id + # @return [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. + attr_accessor :webhook_event_id + # @!attribute [rw] delivery_context + # @return [DeliveryContext] attr_accessor :delivery_context - attr_accessor :reply_token # Reply token used to send reply message to this event + # @!attribute [rw] reply_token + # @return [String] Reply token used to send reply message to this event + attr_accessor :reply_token + # @!attribute [rw] video_play_complete + # @return [VideoPlayComplete] attr_accessor :video_play_complete # @param source [Source] From e6665438572cec2b0b5025597f3fbfc28819fbeb Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:47:24 +0900 Subject: [PATCH 5/6] NO-ISSUE Add nil to type if value is nullable or key is undefined --- .../line-bot-sdk-ruby-generator/model.pebble | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble index dc014c5b..0262f0be 100644 --- a/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble +++ b/generator/src/main/resources/line-bot-sdk-ruby-generator/model.pebble @@ -25,19 +25,19 @@ module Line # @!attribute [{% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name %}rw{% else %}r{% endif %}] {{ variable.name }} {% if variable.openApiType == 'array' -%} {% if variable.items.isModel -%} - # @return [{{ "Array[#{variable.items.openApiType}]" }}] {{ variable.description }} + # @return [{{ "Array[#{variable.items.openApiType}]" }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% elseif variable.items.allowableValues != null -%} # @return [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor -%}]] {{ variable.description }} {% else -%} - # @return [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}] {{ variable.description }} + # @return [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% endif -%} {% elseif variable.isModel -%} - # @return [{{ variable.openApiType }}] {{ variable.description }} + # @return [{{ variable.openApiType }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% else -%} {% if variable.allowableValues != null -%} - # @return [String] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} + # @return [String{% if not variable.required %},nil{% endif -%}] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} {% else -%} - # @return [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}] {{ variable.description }} + # @return [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% endif -%} {% endif -%} {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name %}attr_accessor{% else %}attr_reader{% endif %} :{{ variable.name }} @@ -48,19 +48,19 @@ module Line {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name -%} {% if variable.openApiType == 'array' -%} {% if variable.items.isModel -%} - # @param {{ variable.name }} [{{ "Array[#{variable.items.openApiType}]" }}] {{ variable.description }} + # @param {{ variable.name }} [{{ "Array[#{variable.items.openApiType}]" }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% elseif variable.items.allowableValues != null -%} - # @param {{ variable.name }} [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor -%}]] {{ variable.description }} + # @param {{ variable.name }} [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor -%}]{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% else -%} - # @param {{ variable.name }} [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}] {{ variable.description }} + # @param {{ variable.name }} [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% endif -%} {% elseif variable.isModel -%} - # @param {{ variable.name }} [{{ variable.openApiType }}] {{ variable.description }} + # @param {{ variable.name }} [{{ variable.openApiType }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% else -%} {% if variable.allowableValues != null -%} - # @param {{ variable.name }} [String] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} + # @param {{ variable.name }} [String{% if not variable.required %},nil{% endif -%}] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }} {% else -%} - # @param {{ variable.name }} [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}] {{ variable.description }} + # @param {{ variable.name }} [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} {% endif -%} {% endif -%} {% endif -%} From ed17f3f9fb3fac933df9040f2d62f7e9b03565d7 Mon Sep 17 00:00:00 2001 From: Yuta Kasai Date: Sun, 6 Apr 2025 01:47:29 +0900 Subject: [PATCH 6/6] NO-ISSUE gen --- .../model/error_response.rb | 8 +- .../verify_channel_access_token_response.rb | 4 +- lib/line/bot/v2/insight/model/age_tile.rb | 8 +- .../bot/v2/insight/model/app_type_tile.rb | 8 +- lib/line/bot/v2/insight/model/area_tile.rb | 8 +- lib/line/bot/v2/insight/model/error_detail.rb | 8 +- .../bot/v2/insight/model/error_response.rb | 4 +- lib/line/bot/v2/insight/model/gender_tile.rb | 8 +- .../get_friends_demographics_response.rb | 24 ++--- .../model/get_message_event_response.rb | 12 +-- .../model/get_message_event_response_click.rb | 20 ++-- .../get_message_event_response_message.rb | 48 ++++----- .../get_message_event_response_overview.rb | 28 ++--- .../model/get_number_of_followers_response.rb | 16 +-- ...t_number_of_message_deliveries_response.rb | 44 ++++---- .../get_statistics_per_unit_response_click.rb | 12 +-- ...et_statistics_per_unit_response_message.rb | 48 ++++----- ...t_statistics_per_unit_response_overview.rb | 16 +-- .../insight/model/subscription_period_tile.rb | 8 +- .../bot/v2/liff/model/add_liff_app_request.rb | 18 ++-- .../liff/model/get_all_liff_apps_response.rb | 4 +- lib/line/bot/v2/liff/model/liff_app.rb | 26 ++--- lib/line/bot/v2/liff/model/liff_features.rb | 8 +- lib/line/bot/v2/liff/model/liff_view.rb | 4 +- .../v2/liff/model/update_liff_app_request.rb | 22 ++-- .../bot/v2/liff/model/update_liff_view.rb | 12 +-- .../bot/v2/manage_audience/model/adaccount.rb | 4 +- .../add_audience_to_audience_group_request.rb | 12 +-- .../bot/v2/manage_audience/model/audience.rb | 4 +- .../manage_audience/model/audience_group.rb | 48 ++++----- .../model/audience_group_job.rb | 32 +++--- .../model/create_audience_group_request.rb | 16 +-- .../model/create_audience_group_response.rb | 32 +++--- ...eate_click_based_audience_group_request.rb | 12 +-- ...ate_click_based_audience_group_response.rb | 40 +++---- ...create_imp_based_audience_group_request.rb | 8 +- ...reate_imp_based_audience_group_response.rb | 20 ++-- .../manage_audience/model/detailed_owner.rb | 12 +-- .../v2/manage_audience/model/error_detail.rb | 8 +- .../manage_audience/model/error_response.rb | 4 +- .../model/get_audience_data_response.rb | 12 +-- ...audience_group_authority_level_response.rb | 4 +- .../model/get_audience_groups_response.rb | 24 ++--- .../get_shared_audience_data_response.rb | 12 +-- .../get_shared_audience_groups_response.rb | 24 ++--- ..._audience_group_authority_level_request.rb | 4 +- ...date_audience_group_description_request.rb | 4 +- lib/line/bot/v2/messaging_api/model/action.rb | 8 +- .../model/age_demographic_filter.rb | 10 +- .../bot/v2/messaging_api/model/alt_uri.rb | 4 +- .../model/app_type_demographic_filter.rb | 4 +- .../model/area_demographic_filter.rb | 4 +- .../messaging_api/model/audience_recipient.rb | 6 +- .../v2/messaging_api/model/audio_message.rb | 8 +- .../messaging_api/model/bot_info_response.rb | 8 +- .../messaging_api/model/broadcast_request.rb | 4 +- .../messaging_api/model/buttons_template.rb | 24 ++--- .../v2/messaging_api/model/camera_action.rb | 6 +- .../messaging_api/model/camera_roll_action.rb | 6 +- .../v2/messaging_api/model/carousel_column.rb | 16 +-- .../messaging_api/model/carousel_template.rb | 8 +- .../messaging_api/model/clipboard_action.rb | 6 +- .../model/clipboard_imagemap_action.rb | 4 +- .../model/datetime_picker_action.rb | 26 ++--- .../messaging_api/model/demographic_filter.rb | 4 +- lib/line/bot/v2/messaging_api/model/emoji.rb | 12 +-- .../v2/messaging_api/model/error_detail.rb | 8 +- .../v2/messaging_api/model/error_response.rb | 8 +- lib/line/bot/v2/messaging_api/model/filter.rb | 4 +- .../messaging_api/model/flex_block_style.rb | 12 +-- .../bot/v2/messaging_api/model/flex_box.rb | 100 +++++++++--------- .../model/flex_box_linear_gradient.rb | 20 ++-- .../bot/v2/messaging_api/model/flex_bubble.rb | 32 +++--- .../messaging_api/model/flex_bubble_styles.rb | 16 +-- .../bot/v2/messaging_api/model/flex_button.rb | 52 ++++----- .../bot/v2/messaging_api/model/flex_filler.rb | 4 +- .../bot/v2/messaging_api/model/flex_icon.rb | 36 +++---- .../bot/v2/messaging_api/model/flex_image.rb | 60 +++++------ .../v2/messaging_api/model/flex_message.rb | 8 +- .../v2/messaging_api/model/flex_separator.rb | 8 +- .../bot/v2/messaging_api/model/flex_span.rb | 24 ++--- .../bot/v2/messaging_api/model/flex_text.rb | 88 +++++++-------- .../bot/v2/messaging_api/model/flex_video.rb | 8 +- .../model/gender_demographic_filter.rb | 4 +- ...get_aggregation_unit_name_list_response.rb | 4 +- .../model/get_followers_response.rb | 4 +- .../get_joined_membership_users_response.rb | 4 +- .../model/group_summary_response.rb | 4 +- .../model/group_user_profile_response.rb | 4 +- .../v2/messaging_api/model/image_message.rb | 8 +- .../model/imagemap_external_link.rb | 8 +- .../messaging_api/model/imagemap_message.rb | 12 +-- .../v2/messaging_api/model/imagemap_video.rb | 16 +-- lib/line/bot/v2/messaging_api/model/limit.rb | 8 +- .../v2/messaging_api/model/location_action.rb | 6 +- .../messaging_api/model/location_message.rb | 8 +- .../model/members_ids_response.rb | 4 +- .../bot/v2/messaging_api/model/message.rb | 8 +- .../v2/messaging_api/model/message_action.rb | 10 +- .../model/message_imagemap_action.rb | 4 +- .../model/message_quota_response.rb | 4 +- .../messaging_api/model/multicast_request.rb | 8 +- .../model/narrowcast_progress_response.rb | 24 ++--- .../messaging_api/model/narrowcast_request.rb | 16 +-- .../model/number_of_messages_response.rb | 4 +- .../model/operator_demographic_filter.rb | 14 +-- .../messaging_api/model/operator_recipient.rb | 14 +-- .../model/pnp_messages_request.rb | 4 +- .../v2/messaging_api/model/postback_action.rb | 26 ++--- .../model/push_message_request.rb | 8 +- .../bot/v2/messaging_api/model/quick_reply.rb | 4 +- .../messaging_api/model/quick_reply_item.rb | 12 +-- .../bot/v2/messaging_api/model/recipient.rb | 4 +- .../model/redelivery_recipient.rb | 6 +- .../model/reply_message_request.rb | 4 +- .../v2/messaging_api/model/rich_menu_area.rb | 8 +- .../rich_menu_batch_progress_response.rb | 4 +- .../model/rich_menu_batch_request.rb | 4 +- .../messaging_api/model/rich_menu_bounds.rb | 16 +-- .../messaging_api/model/rich_menu_request.rb | 20 ++-- .../v2/messaging_api/model/rich_menu_size.rb | 8 +- .../model/rich_menu_switch_action.rb | 14 +-- .../model/room_user_profile_response.rb | 4 +- lib/line/bot/v2/messaging_api/model/sender.rb | 8 +- .../v2/messaging_api/model/sent_message.rb | 4 +- .../model/show_loading_animation_request.rb | 4 +- .../v2/messaging_api/model/sticker_message.rb | 12 +-- .../subscription_period_demographic_filter.rb | 10 +- .../messaging_api/model/template_message.rb | 8 +- .../model/test_webhook_endpoint_request.rb | 4 +- .../model/test_webhook_endpoint_response.rb | 4 +- .../v2/messaging_api/model/text_message.rb | 16 +-- .../v2/messaging_api/model/text_message_v2.rb | 16 +-- .../bot/v2/messaging_api/model/uri_action.rb | 14 +-- .../model/uri_imagemap_action.rb | 4 +- .../model/user_profile_response.rb | 12 +-- .../v2/messaging_api/model/video_message.rb | 12 +-- .../model/acquire_chat_control_request.rb | 8 +- .../v2/module/model/detach_module_request.rb | 4 +- .../v2/module/model/get_modules_response.rb | 4 +- lib/line/bot/v2/module/model/module_bot.rb | 8 +- .../v2/webhook/model/account_link_event.rb | 8 +- .../bot/v2/webhook/model/action_result.rb | 4 +- .../bot/v2/webhook/model/activated_event.rb | 4 +- .../v2/webhook/model/audio_message_content.rb | 4 +- .../bot/v2/webhook/model/beacon_content.rb | 4 +- lib/line/bot/v2/webhook/model/beacon_event.rb | 4 +- .../bot/v2/webhook/model/bot_resumed_event.rb | 4 +- .../v2/webhook/model/bot_suspended_event.rb | 4 +- .../bot/v2/webhook/model/content_provider.rb | 8 +- .../bot/v2/webhook/model/deactivated_event.rb | 4 +- lib/line/bot/v2/webhook/model/event.rb | 4 +- lib/line/bot/v2/webhook/model/follow_event.rb | 4 +- lib/line/bot/v2/webhook/model/group_source.rb | 4 +- .../v2/webhook/model/image_message_content.rb | 4 +- lib/line/bot/v2/webhook/model/image_set.rb | 8 +- lib/line/bot/v2/webhook/model/join_event.rb | 4 +- lib/line/bot/v2/webhook/model/leave_event.rb | 4 +- .../webhook/model/location_message_content.rb | 8 +- .../v2/webhook/model/member_joined_event.rb | 4 +- .../bot/v2/webhook/model/member_left_event.rb | 4 +- .../bot/v2/webhook/model/membership_event.rb | 4 +- .../bot/v2/webhook/model/message_event.rb | 8 +- lib/line/bot/v2/webhook/model/module_event.rb | 4 +- .../model/pnp_delivery_completion_event.rb | 4 +- .../bot/v2/webhook/model/postback_content.rb | 4 +- .../bot/v2/webhook/model/postback_event.rb | 8 +- lib/line/bot/v2/webhook/model/room_source.rb | 4 +- .../bot/v2/webhook/model/scenario_result.rb | 20 ++-- lib/line/bot/v2/webhook/model/source.rb | 4 +- .../webhook/model/sticker_message_content.rb | 12 +-- .../v2/webhook/model/text_message_content.rb | 12 +-- lib/line/bot/v2/webhook/model/things_event.rb | 4 +- .../bot/v2/webhook/model/unfollow_event.rb | 4 +- lib/line/bot/v2/webhook/model/unsend_event.rb | 4 +- .../bot/v2/webhook/model/user_mentionee.rb | 8 +- lib/line/bot/v2/webhook/model/user_source.rb | 4 +- .../v2/webhook/model/video_message_content.rb | 4 +- .../model/video_play_complete_event.rb | 4 +- 179 files changed, 1064 insertions(+), 1064 deletions(-) diff --git a/lib/line/bot/v2/channel_access_token/model/error_response.rb b/lib/line/bot/v2/channel_access_token/model/error_response.rb index 1222cb5c..28e7468e 100644 --- a/lib/line/bot/v2/channel_access_token/model/error_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/error_response.rb @@ -14,14 +14,14 @@ module ChannelAccessToken # Error response of the Channel access token class ErrorResponse # @!attribute [rw] error - # @return [String] Error summary + # @return [String,nil] Error summary attr_accessor :error # @!attribute [rw] error_description - # @return [String] Details of the error. Not returned in certain situations. + # @return [String,nil] Details of the error. Not returned in certain situations. attr_accessor :error_description - # @param error [String] Error summary - # @param error_description [String] Details of the error. Not returned in certain situations. + # @param error [String,nil] Error summary + # @param error_description [String,nil] Details of the error. Not returned in certain situations. def initialize( error: nil, error_description: nil, diff --git a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb index 61e7c39c..6e7d10fa 100644 --- a/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb +++ b/lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb @@ -20,12 +20,12 @@ class VerifyChannelAccessTokenResponse # @return [Integer] Number of seconds before the channel access token expires. attr_accessor :expires_in # @!attribute [rw] scope - # @return [String] Permissions granted to the channel access token. + # @return [String,nil] Permissions granted to the channel access token. attr_accessor :scope # @param client_id [String] The channel ID for which the channel access token was issued. # @param expires_in [Integer] Number of seconds before the channel access token expires. - # @param scope [String] Permissions granted to the channel access token. + # @param scope [String,nil] Permissions granted to the channel access token. def initialize( client_id:, expires_in:, diff --git a/lib/line/bot/v2/insight/model/age_tile.rb b/lib/line/bot/v2/insight/model/age_tile.rb index 08fd98fd..31659021 100644 --- a/lib/line/bot/v2/insight/model/age_tile.rb +++ b/lib/line/bot/v2/insight/model/age_tile.rb @@ -13,14 +13,14 @@ module V2 module Insight class AgeTile # @!attribute [rw] age - # @return [String] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age + # @return [String,nil] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age attr_accessor :age # @!attribute [rw] percentage - # @return [Float] Percentage + # @return [Float,nil] Percentage attr_accessor :percentage - # @param age [String] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age - # @param percentage [Float] Percentage + # @param age [String,nil] ('from0to14'|'from15to19'|'from20to24'|'from25to29'|'from30to34'|'from35to39'|'from40to44'|'from45to49'|'from50'|'from50to54'|'from55to59'|'from60to64'|'from65to69'|'from70'|'unknown') users' age + # @param percentage [Float,nil] Percentage def initialize( age: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/app_type_tile.rb b/lib/line/bot/v2/insight/model/app_type_tile.rb index c3a27875..72191c26 100644 --- a/lib/line/bot/v2/insight/model/app_type_tile.rb +++ b/lib/line/bot/v2/insight/model/app_type_tile.rb @@ -13,14 +13,14 @@ module V2 module Insight class AppTypeTile # @!attribute [rw] app_type - # @return [String] ('ios'|'android'|'others') users' OS + # @return [String,nil] ('ios'|'android'|'others') users' OS attr_accessor :app_type # @!attribute [rw] percentage - # @return [Float] Percentage + # @return [Float,nil] Percentage attr_accessor :percentage - # @param app_type [String] ('ios'|'android'|'others') users' OS - # @param percentage [Float] Percentage + # @param app_type [String,nil] ('ios'|'android'|'others') users' OS + # @param percentage [Float,nil] Percentage def initialize( app_type: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/area_tile.rb b/lib/line/bot/v2/insight/model/area_tile.rb index 93e47a87..34a8a4d4 100644 --- a/lib/line/bot/v2/insight/model/area_tile.rb +++ b/lib/line/bot/v2/insight/model/area_tile.rb @@ -13,14 +13,14 @@ module V2 module Insight class AreaTile # @!attribute [rw] area - # @return [String] users' country and region + # @return [String,nil] users' country and region attr_accessor :area # @!attribute [rw] percentage - # @return [Float] Percentage + # @return [Float,nil] Percentage attr_accessor :percentage - # @param area [String] users' country and region - # @param percentage [Float] Percentage + # @param area [String,nil] users' country and region + # @param percentage [Float,nil] Percentage def initialize( area: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/error_detail.rb b/lib/line/bot/v2/insight/model/error_detail.rb index e84d7779..59558939 100644 --- a/lib/line/bot/v2/insight/model/error_detail.rb +++ b/lib/line/bot/v2/insight/model/error_detail.rb @@ -13,14 +13,14 @@ module V2 module Insight class ErrorDetail # @!attribute [rw] message - # @return [String] Details of the error. Not included in the response under certain situations. + # @return [String,nil] Details of the error. Not included in the response under certain situations. attr_accessor :message # @!attribute [rw] property - # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @return [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. attr_accessor :property - # @param message [String] Details of the error. Not included in the response under certain situations. - # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String,nil] Details of the error. Not included in the response under certain situations. + # @param property [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/insight/model/error_response.rb b/lib/line/bot/v2/insight/model/error_response.rb index be3a0710..ef174c7c 100644 --- a/lib/line/bot/v2/insight/model/error_response.rb +++ b/lib/line/bot/v2/insight/model/error_response.rb @@ -17,11 +17,11 @@ class ErrorResponse # @return [String] Message containing information about the error. attr_accessor :message # @!attribute [rw] details - # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @return [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. attr_accessor :details # @param message [String] Message containing information about the error. - # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @param details [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/insight/model/gender_tile.rb b/lib/line/bot/v2/insight/model/gender_tile.rb index 13cf654b..b3984259 100644 --- a/lib/line/bot/v2/insight/model/gender_tile.rb +++ b/lib/line/bot/v2/insight/model/gender_tile.rb @@ -13,14 +13,14 @@ module V2 module Insight class GenderTile # @!attribute [rw] gender - # @return [String] ('male'|'female'|'unknown') users' gender + # @return [String,nil] ('male'|'female'|'unknown') users' gender attr_accessor :gender # @!attribute [rw] percentage - # @return [Float] Percentage + # @return [Float,nil] Percentage attr_accessor :percentage - # @param gender [String] ('male'|'female'|'unknown') users' gender - # @param percentage [Float] Percentage + # @param gender [String,nil] ('male'|'female'|'unknown') users' gender + # @param percentage [Float,nil] Percentage def initialize( gender: nil, percentage: nil, diff --git a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb index ece39b06..2e1c5f99 100644 --- a/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb +++ b/lib/line/bot/v2/insight/model/get_friends_demographics_response.rb @@ -15,30 +15,30 @@ module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-demographic class GetFriendsDemographicsResponse # @!attribute [rw] available - # @return [Boolean] true if friend demographic information is available. + # @return [Boolean,nil] true if friend demographic information is available. attr_accessor :available # @!attribute [rw] genders - # @return [Array[GenderTile]] Percentage per gender. + # @return [Array[GenderTile],nil] Percentage per gender. attr_accessor :genders # @!attribute [rw] ages - # @return [Array[AgeTile]] Percentage per age group. + # @return [Array[AgeTile],nil] Percentage per age group. attr_accessor :ages # @!attribute [rw] areas - # @return [Array[AreaTile]] Percentage per area. + # @return [Array[AreaTile],nil] Percentage per area. attr_accessor :areas # @!attribute [rw] app_types - # @return [Array[AppTypeTile]] Percentage by OS. + # @return [Array[AppTypeTile],nil] Percentage by OS. attr_accessor :app_types # @!attribute [rw] subscription_periods - # @return [Array[SubscriptionPeriodTile]] Percentage per friendship duration. + # @return [Array[SubscriptionPeriodTile],nil] Percentage per friendship duration. attr_accessor :subscription_periods - # @param available [Boolean] true if friend demographic information is available. - # @param genders [Array[GenderTile]] Percentage per gender. - # @param ages [Array[AgeTile]] Percentage per age group. - # @param areas [Array[AreaTile]] Percentage per area. - # @param app_types [Array[AppTypeTile]] Percentage by OS. - # @param subscription_periods [Array[SubscriptionPeriodTile]] Percentage per friendship duration. + # @param available [Boolean,nil] true if friend demographic information is available. + # @param genders [Array[GenderTile],nil] Percentage per gender. + # @param ages [Array[AgeTile],nil] Percentage per age group. + # @param areas [Array[AreaTile],nil] Percentage per area. + # @param app_types [Array[AppTypeTile],nil] Percentage by OS. + # @param subscription_periods [Array[SubscriptionPeriodTile],nil] Percentage per friendship duration. def initialize( available: nil, genders: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response.rb b/lib/line/bot/v2/insight/model/get_message_event_response.rb index 58595e2c..98daac70 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response.rb @@ -15,18 +15,18 @@ module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response class GetMessageEventResponse # @!attribute [rw] overview - # @return [GetMessageEventResponseOverview] + # @return [GetMessageEventResponseOverview,nil] attr_accessor :overview # @!attribute [rw] messages - # @return [Array[GetMessageEventResponseMessage]] Array of information about individual message bubbles. + # @return [Array[GetMessageEventResponseMessage],nil] Array of information about individual message bubbles. attr_accessor :messages # @!attribute [rw] clicks - # @return [Array[GetMessageEventResponseClick]] Array of information about opened URLs in the message. + # @return [Array[GetMessageEventResponseClick],nil] Array of information about opened URLs in the message. attr_accessor :clicks - # @param overview [GetMessageEventResponseOverview] - # @param messages [Array[GetMessageEventResponseMessage]] Array of information about individual message bubbles. - # @param clicks [Array[GetMessageEventResponseClick]] Array of information about opened URLs in the message. + # @param overview [GetMessageEventResponseOverview,nil] + # @param messages [Array[GetMessageEventResponseMessage],nil] Array of information about individual message bubbles. + # @param clicks [Array[GetMessageEventResponseClick],nil] Array of information about opened URLs in the message. def initialize( overview: nil, messages: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb index 254b72c5..f2cf716f 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_click.rb @@ -13,26 +13,26 @@ module V2 module Insight class GetMessageEventResponseClick # @!attribute [rw] seq - # @return [Integer] The URL's serial number. + # @return [Integer,nil] The URL's serial number. attr_accessor :seq # @!attribute [rw] url - # @return [String] URL. + # @return [String,nil] URL. attr_accessor :url # @!attribute [rw] click - # @return [Integer] Number of times the URL was opened. + # @return [Integer,nil] Number of times the URL was opened. attr_accessor :click # @!attribute [rw] unique_click - # @return [Integer] Number of users that opened the URL. + # @return [Integer,nil] Number of users that opened the URL. attr_accessor :unique_click # @!attribute [rw] unique_click_of_request - # @return [Integer] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. + # @return [Integer,nil] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. attr_accessor :unique_click_of_request - # @param seq [Integer] The URL's serial number. - # @param url [String] URL. - # @param click [Integer] Number of times the URL was opened. - # @param unique_click [Integer] Number of users that opened the URL. - # @param unique_click_of_request [Integer] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. + # @param seq [Integer,nil] The URL's serial number. + # @param url [String,nil] URL. + # @param click [Integer,nil] Number of times the URL was opened. + # @param unique_click [Integer,nil] Number of users that opened the URL. + # @param unique_click_of_request [Integer,nil] Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. def initialize( seq: nil, url: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb index 93bc13e7..2b985562 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_message.rb @@ -13,54 +13,54 @@ module V2 module Insight class GetMessageEventResponseMessage # @!attribute [rw] seq - # @return [Integer] Bubble's serial number. + # @return [Integer,nil] Bubble's serial number. attr_accessor :seq # @!attribute [rw] impression - # @return [Integer] Number of times the bubble was displayed. + # @return [Integer,nil] Number of times the bubble was displayed. attr_accessor :impression # @!attribute [rw] media_played - # @return [Integer] Number of times audio or video in the bubble started playing. + # @return [Integer,nil] Number of times audio or video in the bubble started playing. attr_accessor :media_played # @!attribute [rw] media_played25_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time. attr_accessor :media_played25_percent # @!attribute [rw] media_played50_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time. attr_accessor :media_played50_percent # @!attribute [rw] media_played75_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time. attr_accessor :media_played75_percent # @!attribute [rw] media_played100_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time. attr_accessor :media_played100_percent # @!attribute [rw] unique_media_played - # @return [Integer] Number of users that started playing audio or video in the bubble. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble. attr_accessor :unique_media_played # @!attribute [rw] unique_media_played25_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time. attr_accessor :unique_media_played25_percent # @!attribute [rw] unique_media_played50_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time. attr_accessor :unique_media_played50_percent # @!attribute [rw] unique_media_played75_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time. attr_accessor :unique_media_played75_percent # @!attribute [rw] unique_media_played100_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time. attr_accessor :unique_media_played100_percent - # @param seq [Integer] Bubble's serial number. - # @param impression [Integer] Number of times the bubble was displayed. - # @param media_played [Integer] Number of times audio or video in the bubble started playing. - # @param media_played25_percent [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. - # @param media_played50_percent [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. - # @param media_played75_percent [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. - # @param media_played100_percent [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. - # @param unique_media_played [Integer] Number of users that started playing audio or video in the bubble. - # @param unique_media_played25_percent [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. - # @param unique_media_played50_percent [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. - # @param unique_media_played75_percent [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. - # @param unique_media_played100_percent [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @param seq [Integer,nil] Bubble's serial number. + # @param impression [Integer,nil] Number of times the bubble was displayed. + # @param media_played [Integer,nil] Number of times audio or video in the bubble started playing. + # @param media_played25_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @param media_played50_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @param media_played75_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @param media_played100_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @param unique_media_played [Integer,nil] Number of users that started playing audio or video in the bubble. + # @param unique_media_played25_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @param unique_media_played50_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @param unique_media_played75_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @param unique_media_played100_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time. def initialize( seq: nil, impression: nil, diff --git a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb index dafb4bf8..106dc2c7 100644 --- a/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_message_event_response_overview.rb @@ -14,34 +14,34 @@ module Insight # Summary of message statistics. class GetMessageEventResponseOverview # @!attribute [rw] request_id - # @return [String] Request ID. + # @return [String,nil] Request ID. attr_accessor :request_id # @!attribute [rw] timestamp - # @return [Integer] UNIX timestamp for message delivery time in seconds. + # @return [Integer,nil] UNIX timestamp for message delivery time in seconds. attr_accessor :timestamp # @!attribute [rw] delivered - # @return [Integer] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. + # @return [Integer,nil] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. attr_accessor :delivered # @!attribute [rw] unique_impression - # @return [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @return [Integer,nil] Number of users who opened the message, meaning they displayed at least 1 bubble. attr_accessor :unique_impression # @!attribute [rw] unique_click - # @return [Integer] Number of users who opened any URL in the message. + # @return [Integer,nil] Number of users who opened any URL in the message. attr_accessor :unique_click # @!attribute [rw] unique_media_played - # @return [Integer] Number of users who started playing any video or audio in the message. + # @return [Integer,nil] Number of users who started playing any video or audio in the message. attr_accessor :unique_media_played # @!attribute [rw] unique_media_played100_percent - # @return [Integer] Number of users who played the entirety of any video or audio in the message. + # @return [Integer,nil] Number of users who played the entirety of any video or audio in the message. attr_accessor :unique_media_played100_percent - # @param request_id [String] Request ID. - # @param timestamp [Integer] UNIX timestamp for message delivery time in seconds. - # @param delivered [Integer] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. - # @param unique_impression [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. - # @param unique_click [Integer] Number of users who opened any URL in the message. - # @param unique_media_played [Integer] Number of users who started playing any video or audio in the message. - # @param unique_media_played100_percent [Integer] Number of users who played the entirety of any video or audio in the message. + # @param request_id [String,nil] Request ID. + # @param timestamp [Integer,nil] UNIX timestamp for message delivery time in seconds. + # @param delivered [Integer,nil] Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. + # @param unique_impression [Integer,nil] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @param unique_click [Integer,nil] Number of users who opened any URL in the message. + # @param unique_media_played [Integer,nil] Number of users who started playing any video or audio in the message. + # @param unique_media_played100_percent [Integer,nil] Number of users who played the entirety of any video or audio in the message. def initialize( request_id: nil, timestamp: nil, diff --git a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb index 242704cb..a6e28723 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_followers_response.rb @@ -15,22 +15,22 @@ module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers class GetNumberOfFollowersResponse # @!attribute [rw] status - # @return [String] ('ready'|'unready'|'out_of_service') Calculation status. + # @return [String,nil] ('ready'|'unready'|'out_of_service') Calculation status. attr_accessor :status # @!attribute [rw] followers - # @return [Integer] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. + # @return [Integer,nil] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. attr_accessor :followers # @!attribute [rw] targeted_reaches - # @return [Integer] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. + # @return [Integer,nil] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. attr_accessor :targeted_reaches # @!attribute [rw] blocks - # @return [Integer] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. + # @return [Integer,nil] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. attr_accessor :blocks - # @param status [String] ('ready'|'unready'|'out_of_service') Calculation status. - # @param followers [Integer] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. - # @param targeted_reaches [Integer] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. - # @param blocks [Integer] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. + # @param status [String,nil] ('ready'|'unready'|'out_of_service') Calculation status. + # @param followers [Integer,nil] The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. + # @param targeted_reaches [Integer,nil] The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. + # @param blocks [Integer,nil] The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. def initialize( status: nil, followers: nil, diff --git a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb index d13df34e..193de27e 100644 --- a/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb +++ b/lib/line/bot/v2/insight/model/get_number_of_message_deliveries_response.rb @@ -15,50 +15,50 @@ module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages class GetNumberOfMessageDeliveriesResponse # @!attribute [rw] status - # @return [String] ('ready'|'unready'|'out_of_service') Status of the counting process. + # @return [String,nil] ('ready'|'unready'|'out_of_service') Status of the counting process. attr_accessor :status # @!attribute [rw] broadcast - # @return [Integer] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). + # @return [Integer,nil] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). attr_accessor :broadcast # @!attribute [rw] targeting - # @return [Integer] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). + # @return [Integer,nil] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). attr_accessor :targeting # @!attribute [rw] auto_response - # @return [Integer] Number of auto-response messages sent. + # @return [Integer,nil] Number of auto-response messages sent. attr_accessor :auto_response # @!attribute [rw] welcome_response - # @return [Integer] Number of greeting messages sent. + # @return [Integer,nil] Number of greeting messages sent. attr_accessor :welcome_response # @!attribute [rw] chat - # @return [Integer] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). + # @return [Integer,nil] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). attr_accessor :chat # @!attribute [rw] api_broadcast - # @return [Integer] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. + # @return [Integer,nil] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. attr_accessor :api_broadcast # @!attribute [rw] api_push - # @return [Integer] Number of push messages sent with the `Send push message` Messaging API operation. + # @return [Integer,nil] Number of push messages sent with the `Send push message` Messaging API operation. attr_accessor :api_push # @!attribute [rw] api_multicast - # @return [Integer] Number of multicast messages sent with the `Send multicast message` Messaging API operation. + # @return [Integer,nil] Number of multicast messages sent with the `Send multicast message` Messaging API operation. attr_accessor :api_multicast # @!attribute [rw] api_narrowcast - # @return [Integer] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. + # @return [Integer,nil] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. attr_accessor :api_narrowcast # @!attribute [rw] api_reply - # @return [Integer] Number of replies sent with the `Send reply message` Messaging API operation. + # @return [Integer,nil] Number of replies sent with the `Send reply message` Messaging API operation. attr_accessor :api_reply - # @param status [String] ('ready'|'unready'|'out_of_service') Status of the counting process. - # @param broadcast [Integer] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). - # @param targeting [Integer] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). - # @param auto_response [Integer] Number of auto-response messages sent. - # @param welcome_response [Integer] Number of greeting messages sent. - # @param chat [Integer] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). - # @param api_broadcast [Integer] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. - # @param api_push [Integer] Number of push messages sent with the `Send push message` Messaging API operation. - # @param api_multicast [Integer] Number of multicast messages sent with the `Send multicast message` Messaging API operation. - # @param api_narrowcast [Integer] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. - # @param api_reply [Integer] Number of replies sent with the `Send reply message` Messaging API operation. + # @param status [String,nil] ('ready'|'unready'|'out_of_service') Status of the counting process. + # @param broadcast [Integer,nil] Number of messages sent to all of this LINE Official Account's friends (broadcast messages). + # @param targeting [Integer,nil] Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). + # @param auto_response [Integer,nil] Number of auto-response messages sent. + # @param welcome_response [Integer,nil] Number of greeting messages sent. + # @param chat [Integer,nil] Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese). + # @param api_broadcast [Integer,nil] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. + # @param api_push [Integer,nil] Number of push messages sent with the `Send push message` Messaging API operation. + # @param api_multicast [Integer,nil] Number of multicast messages sent with the `Send multicast message` Messaging API operation. + # @param api_narrowcast [Integer,nil] Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation. + # @param api_reply [Integer,nil] Number of replies sent with the `Send reply message` Messaging API operation. def initialize( status: nil, broadcast: nil, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb index f9a31f78..5afba63f 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_click.rb @@ -20,20 +20,20 @@ class GetStatisticsPerUnitResponseClick # @return [String] URL. attr_accessor :url # @!attribute [rw] click - # @return [Integer] Number of times the URL in the bubble was opened. + # @return [Integer,nil] Number of times the URL in the bubble was opened. attr_accessor :click # @!attribute [rw] unique_click - # @return [Integer] Number of users that opened the URL in the bubble. + # @return [Integer,nil] Number of users that opened the URL in the bubble. attr_accessor :unique_click # @!attribute [rw] unique_click_of_request - # @return [Integer] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. + # @return [Integer,nil] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. attr_accessor :unique_click_of_request # @param seq [Integer] The URL's serial number. # @param url [String] URL. - # @param click [Integer] Number of times the URL in the bubble was opened. - # @param unique_click [Integer] Number of users that opened the URL in the bubble. - # @param unique_click_of_request [Integer] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. + # @param click [Integer,nil] Number of times the URL in the bubble was opened. + # @param unique_click [Integer,nil] Number of users that opened the URL in the bubble. + # @param unique_click_of_request [Integer,nil] Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. def initialize( seq:, url:, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb index 80e60071..00e6adac 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_message.rb @@ -17,55 +17,55 @@ class GetStatisticsPerUnitResponseMessage # @return [Integer] Bubble's serial number. attr_accessor :seq # @!attribute [rw] impression - # @return [Integer] Number of times the bubble was displayed. + # @return [Integer,nil] Number of times the bubble was displayed. attr_accessor :impression # @!attribute [rw] media_played - # @return [Integer] Number of times audio or video in the bubble started playing. + # @return [Integer,nil] Number of times audio or video in the bubble started playing. attr_accessor :media_played # @!attribute [rw] media_played25_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time. attr_accessor :media_played25_percent # @!attribute [rw] media_played50_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time. attr_accessor :media_played50_percent # @!attribute [rw] media_played75_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time. attr_accessor :media_played75_percent # @!attribute [rw] media_played100_percent - # @return [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @return [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time. attr_accessor :media_played100_percent # @!attribute [rw] unique_impression - # @return [Integer] Number of users the bubble was displayed. + # @return [Integer,nil] Number of users the bubble was displayed. attr_accessor :unique_impression # @!attribute [rw] unique_media_played - # @return [Integer] Number of users that started playing audio or video in the bubble. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble. attr_accessor :unique_media_played # @!attribute [rw] unique_media_played25_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time. attr_accessor :unique_media_played25_percent # @!attribute [rw] unique_media_played50_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time. attr_accessor :unique_media_played50_percent # @!attribute [rw] unique_media_played75_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time. attr_accessor :unique_media_played75_percent # @!attribute [rw] unique_media_played100_percent - # @return [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @return [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time. attr_accessor :unique_media_played100_percent # @param seq [Integer] Bubble's serial number. - # @param impression [Integer] Number of times the bubble was displayed. - # @param media_played [Integer] Number of times audio or video in the bubble started playing. - # @param media_played25_percent [Integer] Number of times audio or video in the bubble started playing and was played 25% of the total time. - # @param media_played50_percent [Integer] Number of times audio or video in the bubble started playing and was played 50% of the total time. - # @param media_played75_percent [Integer] Number of times audio or video in the bubble started playing and was played 75% of the total time. - # @param media_played100_percent [Integer] Number of times audio or video in the bubble started playing and was played 100% of the total time. - # @param unique_impression [Integer] Number of users the bubble was displayed. - # @param unique_media_played [Integer] Number of users that started playing audio or video in the bubble. - # @param unique_media_played25_percent [Integer] Number of users that started playing audio or video in the bubble and played 25% of the total time. - # @param unique_media_played50_percent [Integer] Number of users that started playing audio or video in the bubble and played 50% of the total time. - # @param unique_media_played75_percent [Integer] Number of users that started playing audio or video in the bubble and played 75% of the total time. - # @param unique_media_played100_percent [Integer] Number of users that started playing audio or video in the bubble and played 100% of the total time. + # @param impression [Integer,nil] Number of times the bubble was displayed. + # @param media_played [Integer,nil] Number of times audio or video in the bubble started playing. + # @param media_played25_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 25% of the total time. + # @param media_played50_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 50% of the total time. + # @param media_played75_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 75% of the total time. + # @param media_played100_percent [Integer,nil] Number of times audio or video in the bubble started playing and was played 100% of the total time. + # @param unique_impression [Integer,nil] Number of users the bubble was displayed. + # @param unique_media_played [Integer,nil] Number of users that started playing audio or video in the bubble. + # @param unique_media_played25_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 25% of the total time. + # @param unique_media_played50_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 50% of the total time. + # @param unique_media_played75_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 75% of the total time. + # @param unique_media_played100_percent [Integer,nil] Number of users that started playing audio or video in the bubble and played 100% of the total time. def initialize( seq:, impression: nil, diff --git a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb index 5efcebd0..b28d54e0 100644 --- a/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb +++ b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb @@ -15,22 +15,22 @@ module Insight # @see https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response class GetStatisticsPerUnitResponseOverview # @!attribute [rw] unique_impression - # @return [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @return [Integer,nil] Number of users who opened the message, meaning they displayed at least 1 bubble. attr_accessor :unique_impression # @!attribute [rw] unique_click - # @return [Integer] Number of users who opened any URL in the message. + # @return [Integer,nil] Number of users who opened any URL in the message. attr_accessor :unique_click # @!attribute [rw] unique_media_played - # @return [Integer] Number of users who started playing any video or audio in the message. + # @return [Integer,nil] Number of users who started playing any video or audio in the message. attr_accessor :unique_media_played # @!attribute [rw] unique_media_played100_percent - # @return [Integer] Number of users who played the entirety of any video or audio in the message. + # @return [Integer,nil] Number of users who played the entirety of any video or audio in the message. attr_accessor :unique_media_played100_percent - # @param unique_impression [Integer] Number of users who opened the message, meaning they displayed at least 1 bubble. - # @param unique_click [Integer] Number of users who opened any URL in the message. - # @param unique_media_played [Integer] Number of users who started playing any video or audio in the message. - # @param unique_media_played100_percent [Integer] Number of users who played the entirety of any video or audio in the message. + # @param unique_impression [Integer,nil] Number of users who opened the message, meaning they displayed at least 1 bubble. + # @param unique_click [Integer,nil] Number of users who opened any URL in the message. + # @param unique_media_played [Integer,nil] Number of users who started playing any video or audio in the message. + # @param unique_media_played100_percent [Integer,nil] Number of users who played the entirety of any video or audio in the message. def initialize( unique_impression: nil, unique_click: nil, diff --git a/lib/line/bot/v2/insight/model/subscription_period_tile.rb b/lib/line/bot/v2/insight/model/subscription_period_tile.rb index 74ba628d..44dd5fe7 100644 --- a/lib/line/bot/v2/insight/model/subscription_period_tile.rb +++ b/lib/line/bot/v2/insight/model/subscription_period_tile.rb @@ -13,14 +13,14 @@ module V2 module Insight class SubscriptionPeriodTile # @!attribute [rw] subscription_period - # @return [String] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. + # @return [String,nil] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. attr_accessor :subscription_period # @!attribute [rw] percentage - # @return [Float] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + # @return [Float,nil] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. attr_accessor :percentage - # @param subscription_period [String] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. - # @param percentage [Float] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + # @param subscription_period [String,nil] ('within7days'|'within30days'|'within90days'|'within180days'|'within365days'|'over365days'|'unknown') Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc. + # @param percentage [Float,nil] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. def initialize( subscription_period: nil, percentage: nil, diff --git a/lib/line/bot/v2/liff/model/add_liff_app_request.rb b/lib/line/bot/v2/liff/model/add_liff_app_request.rb index aca5fb0e..e64ea6ae 100644 --- a/lib/line/bot/v2/liff/model/add_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/add_liff_app_request.rb @@ -17,27 +17,27 @@ class AddLiffAppRequest # @return [LiffView] attr_accessor :view # @!attribute [rw] description - # @return [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @return [String,nil] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. attr_accessor :description # @!attribute [rw] features - # @return [LiffFeatures] + # @return [LiffFeatures,nil] attr_accessor :features # @!attribute [rw] permanent_link_pattern - # @return [String] How additional information in LIFF URLs is handled. Specify `concat`. + # @return [String,nil] How additional information in LIFF URLs is handled. Specify `concat`. attr_accessor :permanent_link_pattern # @!attribute [rw] scope # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope # @!attribute [rw] bot_prompt - # @return [String] ('normal'|'aggressive'|'none') + # @return [String,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt # @param view [LiffView] - # @param description [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. - # @param features [LiffFeatures] - # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. Specify `concat`. - # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] - # @param bot_prompt [String] ('normal'|'aggressive'|'none') + # @param description [String,nil] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @param features [LiffFeatures,nil] + # @param permanent_link_pattern [String,nil] How additional information in LIFF URLs is handled. Specify `concat`. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write'],nil] + # @param bot_prompt [String,nil] ('normal'|'aggressive'|'none') def initialize( view:, description: nil, diff --git a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb index 1ed90d69..b2515d7e 100644 --- a/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb +++ b/lib/line/bot/v2/liff/model/get_all_liff_apps_response.rb @@ -13,10 +13,10 @@ module V2 module Liff class GetAllLiffAppsResponse # @!attribute [rw] apps - # @return [Array[LiffApp]] + # @return [Array[LiffApp],nil] attr_accessor :apps - # @param apps [Array[LiffApp]] + # @param apps [Array[LiffApp],nil] def initialize( apps: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/liff/model/liff_app.rb b/lib/line/bot/v2/liff/model/liff_app.rb index 228f9354..ad7104de 100644 --- a/lib/line/bot/v2/liff/model/liff_app.rb +++ b/lib/line/bot/v2/liff/model/liff_app.rb @@ -13,34 +13,34 @@ module V2 module Liff class LiffApp # @!attribute [rw] liff_id - # @return [String] LIFF app ID + # @return [String,nil] LIFF app ID attr_accessor :liff_id # @!attribute [rw] view - # @return [LiffView] + # @return [LiffView,nil] attr_accessor :view # @!attribute [rw] description - # @return [String] Name of the LIFF app + # @return [String,nil] Name of the LIFF app attr_accessor :description # @!attribute [rw] features - # @return [LiffFeatures] + # @return [LiffFeatures,nil] attr_accessor :features # @!attribute [rw] permanent_link_pattern - # @return [String] How additional information in LIFF URLs is handled. concat is returned. + # @return [String,nil] How additional information in LIFF URLs is handled. concat is returned. attr_accessor :permanent_link_pattern # @!attribute [rw] scope # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope # @!attribute [rw] bot_prompt - # @return [String] ('normal'|'aggressive'|'none') + # @return [String,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt - # @param liff_id [String] LIFF app ID - # @param view [LiffView] - # @param description [String] Name of the LIFF app - # @param features [LiffFeatures] - # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. concat is returned. - # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] - # @param bot_prompt [String] ('normal'|'aggressive'|'none') + # @param liff_id [String,nil] LIFF app ID + # @param view [LiffView,nil] + # @param description [String,nil] Name of the LIFF app + # @param features [LiffFeatures,nil] + # @param permanent_link_pattern [String,nil] How additional information in LIFF URLs is handled. concat is returned. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write'],nil] + # @param bot_prompt [String,nil] ('normal'|'aggressive'|'none') def initialize( liff_id: nil, view: nil, diff --git a/lib/line/bot/v2/liff/model/liff_features.rb b/lib/line/bot/v2/liff/model/liff_features.rb index f1d08f92..d51c6121 100644 --- a/lib/line/bot/v2/liff/model/liff_features.rb +++ b/lib/line/bot/v2/liff/model/liff_features.rb @@ -13,14 +13,14 @@ module V2 module Liff class LiffFeatures # @!attribute [rw] ble - # @return [Boolean] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. + # @return [Boolean,nil] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. attr_accessor :ble # @!attribute [rw] qr_code - # @return [Boolean] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. + # @return [Boolean,nil] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. attr_accessor :qr_code - # @param ble [Boolean] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. - # @param qr_code [Boolean] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. + # @param ble [Boolean,nil] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. + # @param qr_code [Boolean,nil] `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`. def initialize( ble: nil, qr_code: false, diff --git a/lib/line/bot/v2/liff/model/liff_view.rb b/lib/line/bot/v2/liff/model/liff_view.rb index f1a03f80..7a4d4c4a 100644 --- a/lib/line/bot/v2/liff/model/liff_view.rb +++ b/lib/line/bot/v2/liff/model/liff_view.rb @@ -20,12 +20,12 @@ class LiffView # @return [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. attr_accessor :url # @!attribute [rw] module_mode - # @return [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @return [Boolean,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. attr_accessor :module_mode # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. - # @param module_mode [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @param module_mode [Boolean,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. def initialize( type:, url:, diff --git a/lib/line/bot/v2/liff/model/update_liff_app_request.rb b/lib/line/bot/v2/liff/model/update_liff_app_request.rb index 2377a301..b8253720 100644 --- a/lib/line/bot/v2/liff/model/update_liff_app_request.rb +++ b/lib/line/bot/v2/liff/model/update_liff_app_request.rb @@ -14,30 +14,30 @@ module Liff # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app class UpdateLiffAppRequest # @!attribute [rw] view - # @return [UpdateLiffView] + # @return [UpdateLiffView,nil] attr_accessor :view # @!attribute [rw] description - # @return [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @return [String,nil] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. attr_accessor :description # @!attribute [rw] features - # @return [LiffFeatures] + # @return [LiffFeatures,nil] attr_accessor :features # @!attribute [rw] permanent_link_pattern - # @return [String] How additional information in LIFF URLs is handled. Specify `concat`. + # @return [String,nil] How additional information in LIFF URLs is handled. Specify `concat`. attr_accessor :permanent_link_pattern # @!attribute [rw] scope # @return [Array['openid'|'email'|'profile'|'chat_message.write']] attr_accessor :scope # @!attribute [rw] bot_prompt - # @return [String] ('normal'|'aggressive'|'none') + # @return [String,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt - # @param view [UpdateLiffView] - # @param description [String] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. - # @param features [LiffFeatures] - # @param permanent_link_pattern [String] How additional information in LIFF URLs is handled. Specify `concat`. - # @param scope [Array['openid'|'email'|'profile'|'chat_message.write']] - # @param bot_prompt [String] ('normal'|'aggressive'|'none') + # @param view [UpdateLiffView,nil] + # @param description [String,nil] Name of the LIFF app. The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings. + # @param features [LiffFeatures,nil] + # @param permanent_link_pattern [String,nil] How additional information in LIFF URLs is handled. Specify `concat`. + # @param scope [Array['openid'|'email'|'profile'|'chat_message.write'],nil] + # @param bot_prompt [String,nil] ('normal'|'aggressive'|'none') def initialize( view: nil, description: nil, diff --git a/lib/line/bot/v2/liff/model/update_liff_view.rb b/lib/line/bot/v2/liff/model/update_liff_view.rb index 90f345eb..75b8ec0d 100644 --- a/lib/line/bot/v2/liff/model/update_liff_view.rb +++ b/lib/line/bot/v2/liff/model/update_liff_view.rb @@ -14,18 +14,18 @@ module Liff # @see https://developers.line.biz/en/reference/liff-server/#update-liff-app class UpdateLiffView # @!attribute [rw] type - # @return [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + # @return [String,nil] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full attr_accessor :type # @!attribute [rw] url - # @return [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + # @return [String,nil] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. attr_accessor :url # @!attribute [rw] module_mode - # @return [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @return [Boolean,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. attr_accessor :module_mode - # @param type [String] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full - # @param url [String] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. - # @param module_mode [Boolean] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. + # @param type [String,nil] ('compact'|'tall'|'full') Size of the LIFF app view. Specify one of these values: - compact - tall - full + # @param url [String,nil] Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. + # @param module_mode [Boolean,nil] `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. def initialize( type: nil, url: nil, diff --git a/lib/line/bot/v2/manage_audience/model/adaccount.rb b/lib/line/bot/v2/manage_audience/model/adaccount.rb index 0b0abb5a..37c681d2 100644 --- a/lib/line/bot/v2/manage_audience/model/adaccount.rb +++ b/lib/line/bot/v2/manage_audience/model/adaccount.rb @@ -14,10 +14,10 @@ module ManageAudience # Adaccount class Adaccount # @!attribute [rw] name - # @return [String] Ad account name. + # @return [String,nil] Ad account name. attr_accessor :name - # @param name [String] Ad account name. + # @param name [String,nil] Ad account name. def initialize( name: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb index 40f63a01..0cb3e1f8 100644 --- a/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/add_audience_to_audience_group_request.rb @@ -15,18 +15,18 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group class AddAudienceToAudienceGroupRequest # @!attribute [rw] audience_group_id - # @return [Integer] The audience ID. + # @return [Integer,nil] The audience ID. attr_accessor :audience_group_id # @!attribute [rw] upload_description - # @return [String] The audience's name. + # @return [String,nil] The audience's name. attr_accessor :upload_description # @!attribute [rw] audiences - # @return [Array[Audience]] An array of up to 10,000 user IDs or IFAs. + # @return [Array[Audience],nil] An array of up to 10,000 user IDs or IFAs. attr_accessor :audiences - # @param audience_group_id [Integer] The audience ID. - # @param upload_description [String] The audience's name. - # @param audiences [Array[Audience]] An array of up to 10,000 user IDs or IFAs. + # @param audience_group_id [Integer,nil] The audience ID. + # @param upload_description [String,nil] The audience's name. + # @param audiences [Array[Audience],nil] An array of up to 10,000 user IDs or IFAs. def initialize( audience_group_id: nil, upload_description: nil, diff --git a/lib/line/bot/v2/manage_audience/model/audience.rb b/lib/line/bot/v2/manage_audience/model/audience.rb index 297a8416..623e9367 100644 --- a/lib/line/bot/v2/manage_audience/model/audience.rb +++ b/lib/line/bot/v2/manage_audience/model/audience.rb @@ -14,10 +14,10 @@ module ManageAudience # Audience class Audience # @!attribute [rw] id - # @return [String] A user ID or IFA. You can specify an empty array. + # @return [String,nil] A user ID or IFA. You can specify an empty array. attr_accessor :id - # @param id [String] A user ID or IFA. You can specify an empty array. + # @param id [String,nil] A user ID or IFA. You can specify an empty array. def initialize( id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/audience_group.rb b/lib/line/bot/v2/manage_audience/model/audience_group.rb index cf989052..f959e023 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group.rb @@ -14,54 +14,54 @@ module ManageAudience # Audience group class AudienceGroup # @!attribute [rw] audience_group_id - # @return [Integer] The audience ID. + # @return [Integer,nil] The audience ID. attr_accessor :audience_group_id # @!attribute [rw] type - # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type # @!attribute [rw] description - # @return [String] The audience's name. + # @return [String,nil] The audience's name. attr_accessor :description # @!attribute [rw] status - # @return [String] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') + # @return [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') attr_accessor :status # @!attribute [rw] failed_type - # @return [String] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') + # @return [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') attr_accessor :failed_type # @!attribute [rw] audience_count - # @return [Integer] The number of users included in the audience. + # @return [Integer,nil] The number of users included in the audience. attr_accessor :audience_count # @!attribute [rw] created - # @return [Integer] When the audience was created (in UNIX time). + # @return [Integer,nil] When the audience was created (in UNIX time). attr_accessor :created # @!attribute [rw] request_id - # @return [String] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. + # @return [String,nil] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. attr_accessor :request_id # @!attribute [rw] click_url - # @return [String] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. + # @return [String,nil] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. attr_accessor :click_url # @!attribute [rw] is_ifa_audience - # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. + # @return [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. attr_accessor :is_ifa_audience # @!attribute [rw] permission - # @return [String] ('READ'|'READ_WRITE') + # @return [String,nil] ('READ'|'READ_WRITE') attr_accessor :permission # @!attribute [rw] create_route - # @return [String] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') + # @return [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') attr_accessor :create_route - # @param audience_group_id [Integer] The audience ID. - # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') - # @param description [String] The audience's name. - # @param status [String] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') - # @param failed_type [String] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') - # @param audience_count [Integer] The number of users included in the audience. - # @param created [Integer] When the audience was created (in UNIX time). - # @param request_id [String] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. - # @param click_url [String] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. - # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. - # @param permission [String] ('READ'|'READ_WRITE') - # @param create_route [String] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') + # @param audience_group_id [Integer,nil] The audience ID. + # @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String,nil] The audience's name. + # @param status [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') + # @param failed_type [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'') + # @param audience_count [Integer,nil] The number of users included in the audience. + # @param created [Integer,nil] When the audience was created (in UNIX time). + # @param request_id [String,nil] The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. + # @param click_url [String,nil] The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. + # @param is_ifa_audience [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. + # @param permission [String,nil] ('READ'|'READ_WRITE') + # @param create_route [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb index eef56cf2..4e6ac6db 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group_job.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group_job.rb @@ -15,38 +15,38 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class AudienceGroupJob # @!attribute [rw] audience_group_job_id - # @return [Integer] A job ID. + # @return [Integer,nil] A job ID. attr_accessor :audience_group_job_id # @!attribute [rw] audience_group_id - # @return [Integer] An audience ID. + # @return [Integer,nil] An audience ID. attr_accessor :audience_group_id # @!attribute [rw] description - # @return [String] The job's description. + # @return [String,nil] The job's description. attr_accessor :description # @!attribute [rw] type - # @return [String] ('DIFF_ADD') + # @return [String,nil] ('DIFF_ADD') attr_accessor :type # @!attribute [rw] job_status - # @return [String] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') + # @return [String,nil] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') attr_accessor :job_status # @!attribute [rw] failed_type - # @return [String] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') + # @return [String,nil] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') attr_accessor :failed_type # @!attribute [rw] audience_count - # @return [Integer] The number of accounts (recipients) that were added or removed. + # @return [Integer,nil] The number of accounts (recipients) that were added or removed. attr_accessor :audience_count # @!attribute [rw] created - # @return [Integer] When the job was created (in UNIX time). + # @return [Integer,nil] When the job was created (in UNIX time). attr_accessor :created - # @param audience_group_job_id [Integer] A job ID. - # @param audience_group_id [Integer] An audience ID. - # @param description [String] The job's description. - # @param type [String] ('DIFF_ADD') - # @param job_status [String] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') - # @param failed_type [String] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') - # @param audience_count [Integer] The number of accounts (recipients) that were added or removed. - # @param created [Integer] When the job was created (in UNIX time). + # @param audience_group_job_id [Integer,nil] A job ID. + # @param audience_group_id [Integer,nil] An audience ID. + # @param description [String,nil] The job's description. + # @param type [String,nil] ('DIFF_ADD') + # @param job_status [String,nil] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') + # @param failed_type [String,nil] ('INTERNAL_ERROR'|'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT') + # @param audience_count [Integer,nil] The number of accounts (recipients) that were added or removed. + # @param created [Integer,nil] When the job was created (in UNIX time). def initialize( audience_group_job_id: nil, audience_group_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb index 3a33f8a3..063df7d6 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_request.rb @@ -15,22 +15,22 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group class CreateAudienceGroupRequest # @!attribute [rw] description - # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @return [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 attr_accessor :description # @!attribute [rw] is_ifa_audience - # @return [Boolean] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. + # @return [Boolean,nil] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. attr_accessor :is_ifa_audience # @!attribute [rw] upload_description - # @return [String] The description to register for the job (in jobs[].description). + # @return [String,nil] The description to register for the job (in jobs[].description). attr_accessor :upload_description # @!attribute [rw] audiences - # @return [Array[Audience]] An array of user IDs or IFAs. Max number: 10,000 + # @return [Array[Audience],nil] An array of user IDs or IFAs. Max number: 10,000 attr_accessor :audiences - # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 - # @param is_ifa_audience [Boolean] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. - # @param upload_description [String] The description to register for the job (in jobs[].description). - # @param audiences [Array[Audience]] An array of user IDs or IFAs. Max number: 10,000 + # @param description [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param is_ifa_audience [Boolean,nil] To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. + # @param upload_description [String,nil] The description to register for the job (in jobs[].description). + # @param audiences [Array[Audience],nil] An array of user IDs or IFAs. Max number: 10,000 def initialize( description: nil, is_ifa_audience: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb index 8b08526b..3f0596d4 100644 --- a/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb @@ -15,38 +15,38 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group class CreateAudienceGroupResponse # @!attribute [rw] audience_group_id - # @return [Integer] The audience ID. + # @return [Integer,nil] The audience ID. attr_accessor :audience_group_id # @!attribute [rw] create_route - # @return [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @return [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. attr_accessor :create_route # @!attribute [rw] type - # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type # @!attribute [rw] description - # @return [String] The audience's name. + # @return [String,nil] The audience's name. attr_accessor :description # @!attribute [rw] created - # @return [Integer] When the audience was created (in UNIX time). + # @return [Integer,nil] When the audience was created (in UNIX time). attr_accessor :created # @!attribute [rw] permission - # @return [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. + # @return [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. attr_accessor :permission # @!attribute [rw] expire_timestamp - # @return [Float] Time of audience expiration. Only returned for specific audiences. + # @return [Float,nil] Time of audience expiration. Only returned for specific audiences. attr_accessor :expire_timestamp # @!attribute [rw] is_ifa_audience - # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. + # @return [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. attr_accessor :is_ifa_audience - # @param audience_group_id [Integer] The audience ID. - # @param create_route [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. - # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') - # @param description [String] The audience's name. - # @param created [Integer] When the audience was created (in UNIX time). - # @param permission [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. - # @param expire_timestamp [Float] Time of audience expiration. Only returned for specific audiences. - # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. + # @param audience_group_id [Integer,nil] The audience ID. + # @param create_route [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String,nil] The audience's name. + # @param created [Integer,nil] When the audience was created (in UNIX time). + # @param permission [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update. + # @param expire_timestamp [Float,nil] Time of audience expiration. Only returned for specific audiences. + # @param is_ifa_audience [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs. def initialize( audience_group_id: nil, create_route: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb index c9b8f8ae..70da8f95 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb @@ -15,18 +15,18 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group class CreateClickBasedAudienceGroupRequest # @!attribute [rw] description - # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @return [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 attr_accessor :description # @!attribute [rw] request_id - # @return [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @return [String,nil] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. attr_accessor :request_id # @!attribute [rw] click_url - # @return [String] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 + # @return [String,nil] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 attr_accessor :click_url - # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 - # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. - # @param click_url [String] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 + # @param description [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param request_id [String,nil] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @param click_url [String,nil] The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 def initialize( description: nil, request_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb index 6d4c5f56..5a74b318 100644 --- a/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb @@ -15,46 +15,46 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group class CreateClickBasedAudienceGroupResponse # @!attribute [rw] audience_group_id - # @return [Integer] The audience ID. + # @return [Integer,nil] The audience ID. attr_accessor :audience_group_id # @!attribute [rw] type - # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type # @!attribute [rw] description - # @return [String] The audience's name. + # @return [String,nil] The audience's name. attr_accessor :description # @!attribute [rw] created - # @return [Integer] When the audience was created (in UNIX time). + # @return [Integer,nil] When the audience was created (in UNIX time). attr_accessor :created # @!attribute [rw] request_id - # @return [String] The request ID that was specified when the audience was created. + # @return [String,nil] The request ID that was specified when the audience was created. attr_accessor :request_id # @!attribute [rw] click_url - # @return [String] The URL that was specified when the audience was created. + # @return [String,nil] The URL that was specified when the audience was created. attr_accessor :click_url # @!attribute [rw] create_route - # @return [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @return [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. attr_accessor :create_route # @!attribute [rw] permission - # @return [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. + # @return [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. attr_accessor :permission # @!attribute [rw] expire_timestamp - # @return [Integer] Time of audience expiration. Only returned for specific audiences. + # @return [Integer,nil] Time of audience expiration. Only returned for specific audiences. attr_accessor :expire_timestamp # @!attribute [rw] is_ifa_audience - # @return [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. + # @return [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. attr_accessor :is_ifa_audience - # @param audience_group_id [Integer] The audience ID. - # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') - # @param description [String] The audience's name. - # @param created [Integer] When the audience was created (in UNIX time). - # @param request_id [String] The request ID that was specified when the audience was created. - # @param click_url [String] The URL that was specified when the audience was created. - # @param create_route [String] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. - # @param permission [String] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. - # @param expire_timestamp [Integer] Time of audience expiration. Only returned for specific audiences. - # @param is_ifa_audience [Boolean] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. + # @param audience_group_id [Integer,nil] The audience ID. + # @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String,nil] The audience's name. + # @param created [Integer,nil] When the audience was created (in UNIX time). + # @param request_id [String,nil] The request ID that was specified when the audience was created. + # @param click_url [String,nil] The URL that was specified when the audience was created. + # @param create_route [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API. + # @param permission [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update. + # @param expire_timestamp [Integer,nil] Time of audience expiration. Only returned for specific audiences. + # @param is_ifa_audience [Boolean,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb index 4998867d..9996c722 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_request.rb @@ -15,14 +15,14 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group class CreateImpBasedAudienceGroupRequest # @!attribute [rw] description - # @return [String] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 + # @return [String,nil] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 attr_accessor :description # @!attribute [rw] request_id - # @return [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @return [String,nil] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. attr_accessor :request_id - # @param description [String] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 - # @param request_id [String] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. + # @param description [String,nil] The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120 + # @param request_id [String,nil] The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. def initialize( description: nil, request_id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb index 1ef79fc2..10155c5e 100644 --- a/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb +++ b/lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb @@ -15,26 +15,26 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group class CreateImpBasedAudienceGroupResponse # @!attribute [rw] audience_group_id - # @return [Integer] The audience ID. + # @return [Integer,nil] The audience ID. attr_accessor :audience_group_id # @!attribute [rw] type - # @return [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') attr_accessor :type # @!attribute [rw] description - # @return [String] The audience's name. + # @return [String,nil] The audience's name. attr_accessor :description # @!attribute [rw] created - # @return [Integer] When the audience was created (in UNIX time). + # @return [Integer,nil] When the audience was created (in UNIX time). attr_accessor :created # @!attribute [rw] request_id - # @return [String] The request ID that was specified when the audience was created. + # @return [String,nil] The request ID that was specified when the audience was created. attr_accessor :request_id - # @param audience_group_id [Integer] The audience ID. - # @param type [String] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') - # @param description [String] The audience's name. - # @param created [Integer] When the audience was created (in UNIX time). - # @param request_id [String] The request ID that was specified when the audience was created. + # @param audience_group_id [Integer,nil] The audience ID. + # @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK') + # @param description [String,nil] The audience's name. + # @param created [Integer,nil] When the audience was created (in UNIX time). + # @param request_id [String,nil] The request ID that was specified when the audience was created. def initialize( audience_group_id: nil, type: nil, diff --git a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb index 52b98379..79aeb423 100644 --- a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb +++ b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb @@ -14,18 +14,18 @@ module ManageAudience # Owner of this audience group. class DetailedOwner # @!attribute [rw] service_type - # @return [String] Service name where the audience group has been created. + # @return [String,nil] Service name where the audience group has been created. attr_accessor :service_type # @!attribute [rw] id - # @return [String] Owner ID in the service. + # @return [String,nil] Owner ID in the service. attr_accessor :id # @!attribute [rw] name - # @return [String] Owner account name. + # @return [String,nil] Owner account name. attr_accessor :name - # @param service_type [String] Service name where the audience group has been created. - # @param id [String] Owner ID in the service. - # @param name [String] Owner account name. + # @param service_type [String,nil] Service name where the audience group has been created. + # @param id [String,nil] Owner ID in the service. + # @param name [String,nil] Owner account name. def initialize( service_type: nil, id: nil, diff --git a/lib/line/bot/v2/manage_audience/model/error_detail.rb b/lib/line/bot/v2/manage_audience/model/error_detail.rb index 367daa57..4102c50c 100644 --- a/lib/line/bot/v2/manage_audience/model/error_detail.rb +++ b/lib/line/bot/v2/manage_audience/model/error_detail.rb @@ -13,14 +13,14 @@ module V2 module ManageAudience class ErrorDetail # @!attribute [rw] message - # @return [String] Details of the error. Not included in the response under certain situations. + # @return [String,nil] Details of the error. Not included in the response under certain situations. attr_accessor :message # @!attribute [rw] property - # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @return [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. attr_accessor :property - # @param message [String] Details of the error. Not included in the response under certain situations. - # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String,nil] Details of the error. Not included in the response under certain situations. + # @param property [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/manage_audience/model/error_response.rb b/lib/line/bot/v2/manage_audience/model/error_response.rb index 464a2c38..0237ce5f 100644 --- a/lib/line/bot/v2/manage_audience/model/error_response.rb +++ b/lib/line/bot/v2/manage_audience/model/error_response.rb @@ -17,11 +17,11 @@ class ErrorResponse # @return [String] Message containing information about the error. attr_accessor :message # @!attribute [rw] details - # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @return [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. attr_accessor :details # @param message [String] Message containing information about the error. - # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @param details [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb index e57918b2..9189e5a3 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_data_response.rb @@ -15,18 +15,18 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class GetAudienceDataResponse # @!attribute [rw] audience_group - # @return [AudienceGroup] + # @return [AudienceGroup,nil] attr_accessor :audience_group # @!attribute [rw] jobs - # @return [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @return [Array[AudienceGroupJob],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 attr_accessor :jobs # @!attribute [rw] adaccount - # @return [Adaccount] + # @return [Adaccount,nil] attr_accessor :adaccount - # @param audience_group [AudienceGroup] - # @param jobs [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 - # @param adaccount [Adaccount] + # @param audience_group [AudienceGroup,nil] + # @param jobs [Array[AudienceGroupJob],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @param adaccount [Adaccount,nil] def initialize( audience_group: nil, jobs: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb index 54534d06..d51dda59 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_group_authority_level_response.rb @@ -15,10 +15,10 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-authority-level class GetAudienceGroupAuthorityLevelResponse # @!attribute [rw] authority_level - # @return [String] ('PUBLIC'|'PRIVATE') + # @return [String,nil] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level - # @param authority_level [String] ('PUBLIC'|'PRIVATE') + # @param authority_level [String,nil] ('PUBLIC'|'PRIVATE') def initialize( authority_level: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb index 26ce785f..2b84aef1 100644 --- a/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_audience_groups_response.rb @@ -15,30 +15,30 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups class GetAudienceGroupsResponse # @!attribute [rw] audience_groups - # @return [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @return [Array[AudienceGroup],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. attr_accessor :audience_groups # @!attribute [rw] has_next_page - # @return [Boolean] true when this is not the last page. + # @return [Boolean,nil] true when this is not the last page. attr_accessor :has_next_page # @!attribute [rw] total_count - # @return [Integer] The total number of audiences that can be returned with the specified filter. + # @return [Integer,nil] The total number of audiences that can be returned with the specified filter. attr_accessor :total_count # @!attribute [rw] read_write_audience_group_total_count - # @return [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @return [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. attr_accessor :read_write_audience_group_total_count # @!attribute [rw] page - # @return [Integer] The current page number. + # @return [Integer,nil] The current page number. attr_accessor :page # @!attribute [rw] size - # @return [Integer] The maximum number of audiences on the current page. + # @return [Integer,nil] The maximum number of audiences on the current page. attr_accessor :size - # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. - # @param has_next_page [Boolean] true when this is not the last page. - # @param total_count [Integer] The total number of audiences that can be returned with the specified filter. - # @param read_write_audience_group_total_count [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. - # @param page [Integer] The current page number. - # @param size [Integer] The maximum number of audiences on the current page. + # @param audience_groups [Array[AudienceGroup],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @param has_next_page [Boolean,nil] true when this is not the last page. + # @param total_count [Integer,nil] The total number of audiences that can be returned with the specified filter. + # @param read_write_audience_group_total_count [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @param page [Integer,nil] The current page number. + # @param size [Integer,nil] The maximum number of audiences on the current page. def initialize( audience_groups: nil, has_next_page: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb index 37aa775d..3e5ec2b3 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_data_response.rb @@ -15,18 +15,18 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-group class GetSharedAudienceDataResponse # @!attribute [rw] audience_group - # @return [AudienceGroup] + # @return [AudienceGroup,nil] attr_accessor :audience_group # @!attribute [rw] jobs - # @return [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @return [Array[AudienceGroupJob],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 attr_accessor :jobs # @!attribute [rw] owner - # @return [DetailedOwner] + # @return [DetailedOwner,nil] attr_accessor :owner - # @param audience_group [AudienceGroup] - # @param jobs [Array[AudienceGroupJob]] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 - # @param owner [DetailedOwner] + # @param audience_group [AudienceGroup,nil] + # @param jobs [Array[AudienceGroupJob],nil] An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 + # @param owner [DetailedOwner,nil] def initialize( audience_group: nil, jobs: nil, diff --git a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb index 117bc8bf..c3c4b1cf 100644 --- a/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb +++ b/lib/line/bot/v2/manage_audience/model/get_shared_audience_groups_response.rb @@ -15,30 +15,30 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#get-audience-groups class GetSharedAudienceGroupsResponse # @!attribute [rw] audience_groups - # @return [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @return [Array[AudienceGroup],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. attr_accessor :audience_groups # @!attribute [rw] has_next_page - # @return [Boolean] true when this is not the last page. + # @return [Boolean,nil] true when this is not the last page. attr_accessor :has_next_page # @!attribute [rw] total_count - # @return [Integer] The total number of audiences that can be returned with the specified filter. + # @return [Integer,nil] The total number of audiences that can be returned with the specified filter. attr_accessor :total_count # @!attribute [rw] read_write_audience_group_total_count - # @return [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @return [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. attr_accessor :read_write_audience_group_total_count # @!attribute [rw] page - # @return [Integer] The current page number. + # @return [Integer,nil] The current page number. attr_accessor :page # @!attribute [rw] size - # @return [Integer] The maximum number of audiences on the current page. + # @return [Integer,nil] The maximum number of audiences on the current page. attr_accessor :size - # @param audience_groups [Array[AudienceGroup]] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. - # @param has_next_page [Boolean] true when this is not the last page. - # @param total_count [Integer] The total number of audiences that can be returned with the specified filter. - # @param read_write_audience_group_total_count [Integer] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. - # @param page [Integer] The current page number. - # @param size [Integer] The maximum number of audiences on the current page. + # @param audience_groups [Array[AudienceGroup],nil] An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. + # @param has_next_page [Boolean,nil] true when this is not the last page. + # @param total_count [Integer,nil] The total number of audiences that can be returned with the specified filter. + # @param read_write_audience_group_total_count [Integer,nil] Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. + # @param page [Integer,nil] The current page number. + # @param size [Integer,nil] The maximum number of audiences on the current page. def initialize( audience_groups: nil, has_next_page: nil, diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb index 1bc82558..c2290d47 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_authority_level_request.rb @@ -15,10 +15,10 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#change-authority-level class UpdateAudienceGroupAuthorityLevelRequest # @!attribute [rw] authority_level - # @return [String] ('PUBLIC'|'PRIVATE') + # @return [String,nil] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level - # @param authority_level [String] ('PUBLIC'|'PRIVATE') + # @param authority_level [String,nil] ('PUBLIC'|'PRIVATE') def initialize( authority_level: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb index bf0d91ac..07dd9346 100644 --- a/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb +++ b/lib/line/bot/v2/manage_audience/model/update_audience_group_description_request.rb @@ -15,10 +15,10 @@ module ManageAudience # @see https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group class UpdateAudienceGroupDescriptionRequest # @!attribute [rw] description - # @return [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @return [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 attr_accessor :description - # @param description [String] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 + # @param description [String,nil] The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 def initialize( description: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/action.rb b/lib/line/bot/v2/messaging_api/model/action.rb index c5d4c572..a7086318 100644 --- a/lib/line/bot/v2/messaging_api/model/action.rb +++ b/lib/line/bot/v2/messaging_api/model/action.rb @@ -15,14 +15,14 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#action-objects class Action # @!attribute [rw] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_accessor :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label - # @param type [String] Type of action - # @param label [String] Label for the action. + # @param type [String,nil] Type of action + # @param label [String,nil] Label for the action. def initialize( type: nil, label: nil, diff --git a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb index 01799afc..63f109cc 100644 --- a/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/age_demographic_filter.rb @@ -15,17 +15,17 @@ module V2 module MessagingApi class AgeDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] gte - # @return [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') + # @return [String,nil] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') attr_accessor :gte # @!attribute [rw] lt - # @return [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') + # @return [String,nil] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') attr_accessor :lt - # @param gte [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') - # @param lt [String] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') + # @param gte [String,nil] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') + # @param lt [String,nil] ('age_15'|'age_20'|'age_25'|'age_30'|'age_35'|'age_40'|'age_45'|'age_50'|'age_55'|'age_60'|'age_65'|'age_70') def initialize( gte: nil, lt: nil, diff --git a/lib/line/bot/v2/messaging_api/model/alt_uri.rb b/lib/line/bot/v2/messaging_api/model/alt_uri.rb index cd820318..c19d9ba3 100644 --- a/lib/line/bot/v2/messaging_api/model/alt_uri.rb +++ b/lib/line/bot/v2/messaging_api/model/alt_uri.rb @@ -13,10 +13,10 @@ module V2 module MessagingApi class AltUri # @!attribute [rw] desktop - # @return [String] + # @return [String,nil] attr_accessor :desktop - # @param desktop [String] + # @param desktop [String,nil] def initialize( desktop: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb index 9519c185..78d3e8c1 100644 --- a/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/app_type_demographic_filter.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class AppTypeDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] one_of # @return [Array['ios'|'android']] attr_accessor :one_of - # @param one_of [Array['ios'|'android']] + # @param one_of [Array['ios'|'android'],nil] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb index 95bd08ac..7f3405ae 100644 --- a/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/area_demographic_filter.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class AreaDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] one_of # @return [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12']] attr_accessor :one_of - # @param one_of [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12']] + # @param one_of [Array['jp_01'|'jp_02'|'jp_03'|'jp_04'|'jp_05'|'jp_06'|'jp_07'|'jp_08'|'jp_09'|'jp_10'|'jp_11'|'jp_12'|'jp_13'|'jp_14'|'jp_15'|'jp_16'|'jp_17'|'jp_18'|'jp_19'|'jp_20'|'jp_21'|'jp_22'|'jp_23'|'jp_24'|'jp_25'|'jp_26'|'jp_27'|'jp_28'|'jp_29'|'jp_30'|'jp_31'|'jp_32'|'jp_33'|'jp_34'|'jp_35'|'jp_36'|'jp_37'|'jp_38'|'jp_39'|'jp_40'|'jp_41'|'jp_42'|'jp_43'|'jp_44'|'jp_45'|'jp_46'|'jp_47'|'tw_01'|'tw_02'|'tw_03'|'tw_04'|'tw_05'|'tw_06'|'tw_07'|'tw_08'|'tw_09'|'tw_10'|'tw_11'|'tw_12'|'tw_13'|'tw_14'|'tw_15'|'tw_16'|'tw_17'|'tw_18'|'tw_19'|'tw_20'|'tw_21'|'tw_22'|'th_01'|'th_02'|'th_03'|'th_04'|'th_05'|'th_06'|'th_07'|'th_08'|'id_01'|'id_02'|'id_03'|'id_04'|'id_05'|'id_06'|'id_07'|'id_08'|'id_09'|'id_10'|'id_11'|'id_12'],nil] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb index 50b3d200..8b9e0d81 100644 --- a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class AudienceRecipient < Recipient # @!attribute [r] type - # @return [String] Type of recipient + # @return [String,nil] Type of recipient attr_reader :type # @!attribute [rw] audience_group_id - # @return [Integer] + # @return [Integer,nil] attr_accessor :audience_group_id - # @param audience_group_id [Integer] + # @param audience_group_id [Integer,nil] def initialize( audience_group_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/audio_message.rb b/lib/line/bot/v2/messaging_api/model/audio_message.rb index 5719552f..13d3030f 100644 --- a/lib/line/bot/v2/messaging_api/model/audio_message.rb +++ b/lib/line/bot/v2/messaging_api/model/audio_message.rb @@ -19,10 +19,10 @@ class AudioMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] original_content_url # @return [String] @@ -31,8 +31,8 @@ class AudioMessage < Message # @return [Integer] attr_accessor :duration - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param original_content_url [String] # @param duration [Integer] def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb index 0471f39b..aae64ab5 100644 --- a/lib/line/bot/v2/messaging_api/model/bot_info_response.rb +++ b/lib/line/bot/v2/messaging_api/model/bot_info_response.rb @@ -20,13 +20,13 @@ class BotInfoResponse # @return [String] Bot's basic ID attr_accessor :basic_id # @!attribute [rw] premium_id - # @return [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @return [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set. attr_accessor :premium_id # @!attribute [rw] display_name # @return [String] Bot's display name attr_accessor :display_name # @!attribute [rw] picture_url - # @return [String] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. + # @return [String,nil] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. attr_accessor :picture_url # @!attribute [rw] chat_mode # @return [String] ('chat'|'bot') Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". @@ -37,9 +37,9 @@ class BotInfoResponse # @param user_id [String] Bot's user ID # @param basic_id [String] Bot's basic ID - # @param premium_id [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @param premium_id [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set. # @param display_name [String] Bot's display name - # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. + # @param picture_url [String,nil] Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image. # @param chat_mode [String] ('chat'|'bot') Chat settings set in the LINE Official Account Manager. One of: `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\". # @param mark_as_read_mode [String] ('auto'|'manual') Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned. `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled. def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb index da123f91..aee4640b 100644 --- a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb @@ -17,11 +17,11 @@ class BroadcastRequest # @return [Array[Message]] List of Message objects. attr_accessor :messages # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @param messages [Array[Message]] List of Message objects. - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, notification_disabled: false, diff --git a/lib/line/bot/v2/messaging_api/model/buttons_template.rb b/lib/line/bot/v2/messaging_api/model/buttons_template.rb index 825f79dd..5bf81d64 100644 --- a/lib/line/bot/v2/messaging_api/model/buttons_template.rb +++ b/lib/line/bot/v2/messaging_api/model/buttons_template.rb @@ -18,37 +18,37 @@ class ButtonsTemplate < Template # @return [String] attr_reader :type # @!attribute [rw] thumbnail_image_url - # @return [String] + # @return [String,nil] attr_accessor :thumbnail_image_url # @!attribute [rw] image_aspect_ratio - # @return [String] + # @return [String,nil] attr_accessor :image_aspect_ratio # @!attribute [rw] image_size - # @return [String] + # @return [String,nil] attr_accessor :image_size # @!attribute [rw] image_background_color - # @return [String] + # @return [String,nil] attr_accessor :image_background_color # @!attribute [rw] title - # @return [String] + # @return [String,nil] attr_accessor :title # @!attribute [rw] text # @return [String] attr_accessor :text # @!attribute [rw] default_action - # @return [Action] + # @return [Action,nil] attr_accessor :default_action # @!attribute [rw] actions # @return [Array[Action]] attr_accessor :actions - # @param thumbnail_image_url [String] - # @param image_aspect_ratio [String] - # @param image_size [String] - # @param image_background_color [String] - # @param title [String] + # @param thumbnail_image_url [String,nil] + # @param image_aspect_ratio [String,nil] + # @param image_size [String,nil] + # @param image_background_color [String,nil] + # @param title [String,nil] # @param text [String] - # @param default_action [Action] + # @param default_action [Action,nil] # @param actions [Array[Action]] def initialize( thumbnail_image_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/camera_action.rb b/lib/line/bot/v2/messaging_api/model/camera_action.rb index 28ffccf9..b4a63923 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_action.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class CameraAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label - # @param label [String] Label for the action. + # @param label [String,nil] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb index 45a8484a..b42b4f42 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_roll_action.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class CameraRollAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label - # @param label [String] Label for the action. + # @param label [String,nil] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/carousel_column.rb b/lib/line/bot/v2/messaging_api/model/carousel_column.rb index 27b14819..4d71fa88 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_column.rb @@ -14,29 +14,29 @@ module MessagingApi # Column object for carousel template. class CarouselColumn # @!attribute [rw] thumbnail_image_url - # @return [String] + # @return [String,nil] attr_accessor :thumbnail_image_url # @!attribute [rw] image_background_color - # @return [String] + # @return [String,nil] attr_accessor :image_background_color # @!attribute [rw] title - # @return [String] + # @return [String,nil] attr_accessor :title # @!attribute [rw] text # @return [String] attr_accessor :text # @!attribute [rw] default_action - # @return [Action] + # @return [Action,nil] attr_accessor :default_action # @!attribute [rw] actions # @return [Array[Action]] attr_accessor :actions - # @param thumbnail_image_url [String] - # @param image_background_color [String] - # @param title [String] + # @param thumbnail_image_url [String,nil] + # @param image_background_color [String,nil] + # @param title [String,nil] # @param text [String] - # @param default_action [Action] + # @param default_action [Action,nil] # @param actions [Array[Action]] def initialize( thumbnail_image_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/carousel_template.rb b/lib/line/bot/v2/messaging_api/model/carousel_template.rb index 5d8de097..1d986e17 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_template.rb @@ -21,15 +21,15 @@ class CarouselTemplate < Template # @return [Array[CarouselColumn]] attr_accessor :columns # @!attribute [rw] image_aspect_ratio - # @return [String] + # @return [String,nil] attr_accessor :image_aspect_ratio # @!attribute [rw] image_size - # @return [String] + # @return [String,nil] attr_accessor :image_size # @param columns [Array[CarouselColumn]] - # @param image_aspect_ratio [String] - # @param image_size [String] + # @param image_aspect_ratio [String,nil] + # @param image_size [String,nil] def initialize( columns:, image_aspect_ratio: nil, diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb index 62c57909..a4064a53 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb @@ -16,16 +16,16 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#clipboard-action class ClipboardAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] clipboard_text # @return [String] Text that is copied to the clipboard. Max character limit: 1000 attr_accessor :clipboard_text - # @param label [String] Label for the action. + # @param label [String,nil] Label for the action. # @param clipboard_text [String] Text that is copied to the clipboard. Max character limit: 1000 def initialize( label: nil, diff --git a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb index 283e5510..5416713b 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_imagemap_action.rb @@ -25,12 +25,12 @@ class ClipboardImagemapAction < ImagemapAction # @return [String] Text that is copied to the clipboard. Max character limit: 1000 attr_accessor :clipboard_text # @!attribute [rw] label - # @return [String] + # @return [String,nil] attr_accessor :label # @param area [ImagemapArea] # @param clipboard_text [String] Text that is copied to the clipboard. Max character limit: 1000 - # @param label [String] + # @param label [String,nil] def initialize( area:, clipboard_text:, diff --git a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb index 96cbf86f..516d19c5 100644 --- a/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb +++ b/lib/line/bot/v2/messaging_api/model/datetime_picker_action.rb @@ -16,33 +16,33 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action class DatetimePickerAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] data - # @return [String] + # @return [String,nil] attr_accessor :data # @!attribute [rw] mode - # @return [String] ('date'|'time'|'datetime') + # @return [String,nil] ('date'|'time'|'datetime') attr_accessor :mode # @!attribute [rw] initial - # @return [String] + # @return [String,nil] attr_accessor :initial # @!attribute [rw] max - # @return [String] + # @return [String,nil] attr_accessor :max # @!attribute [rw] min - # @return [String] + # @return [String,nil] attr_accessor :min - # @param label [String] Label for the action. - # @param data [String] - # @param mode [String] ('date'|'time'|'datetime') - # @param initial [String] - # @param max [String] - # @param min [String] + # @param label [String,nil] Label for the action. + # @param data [String,nil] + # @param mode [String,nil] ('date'|'time'|'datetime') + # @param initial [String,nil] + # @param max [String,nil] + # @param min [String,nil] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb index 081c1efb..898fa11b 100644 --- a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb @@ -14,10 +14,10 @@ module MessagingApi # Demographic filter class DemographicFilter # @!attribute [rw] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_accessor :type - # @param type [String] Type of demographic filter + # @param type [String,nil] Type of demographic filter def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/emoji.rb b/lib/line/bot/v2/messaging_api/model/emoji.rb index 5f1c3afc..bd4710b5 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji.rb @@ -13,18 +13,18 @@ module V2 module MessagingApi class Emoji # @!attribute [rw] index - # @return [Integer] + # @return [Integer,nil] attr_accessor :index # @!attribute [rw] product_id - # @return [String] + # @return [String,nil] attr_accessor :product_id # @!attribute [rw] emoji_id - # @return [String] + # @return [String,nil] attr_accessor :emoji_id - # @param index [Integer] - # @param product_id [String] - # @param emoji_id [String] + # @param index [Integer,nil] + # @param product_id [String,nil] + # @param emoji_id [String,nil] def initialize( index: nil, product_id: nil, diff --git a/lib/line/bot/v2/messaging_api/model/error_detail.rb b/lib/line/bot/v2/messaging_api/model/error_detail.rb index 2709ff7f..321bb4a3 100644 --- a/lib/line/bot/v2/messaging_api/model/error_detail.rb +++ b/lib/line/bot/v2/messaging_api/model/error_detail.rb @@ -13,14 +13,14 @@ module V2 module MessagingApi class ErrorDetail # @!attribute [rw] message - # @return [String] Details of the error. Not included in the response under certain situations. + # @return [String,nil] Details of the error. Not included in the response under certain situations. attr_accessor :message # @!attribute [rw] property - # @return [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @return [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. attr_accessor :property - # @param message [String] Details of the error. Not included in the response under certain situations. - # @param property [String] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. + # @param message [String,nil] Details of the error. Not included in the response under certain situations. + # @param property [String,nil] Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. def initialize( message: nil, property: nil, diff --git a/lib/line/bot/v2/messaging_api/model/error_response.rb b/lib/line/bot/v2/messaging_api/model/error_response.rb index 97f886f4..7b3eba48 100644 --- a/lib/line/bot/v2/messaging_api/model/error_response.rb +++ b/lib/line/bot/v2/messaging_api/model/error_response.rb @@ -17,15 +17,15 @@ class ErrorResponse # @return [String] Message containing information about the error. attr_accessor :message # @!attribute [rw] details - # @return [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. + # @return [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. attr_accessor :details # @!attribute [rw] sent_messages - # @return [Array[SentMessage]] Array of sent messages. + # @return [Array[SentMessage],nil] Array of sent messages. attr_accessor :sent_messages # @param message [String] Message containing information about the error. - # @param details [Array[ErrorDetail]] An array of error details. If the array is empty, this property will not be included in the response. - # @param sent_messages [Array[SentMessage]] Array of sent messages. + # @param details [Array[ErrorDetail],nil] An array of error details. If the array is empty, this property will not be included in the response. + # @param sent_messages [Array[SentMessage],nil] Array of sent messages. def initialize( message:, details: nil, diff --git a/lib/line/bot/v2/messaging_api/model/filter.rb b/lib/line/bot/v2/messaging_api/model/filter.rb index d4b98bc7..dbdf7374 100644 --- a/lib/line/bot/v2/messaging_api/model/filter.rb +++ b/lib/line/bot/v2/messaging_api/model/filter.rb @@ -14,10 +14,10 @@ module MessagingApi # Filter for narrowcast class Filter # @!attribute [rw] demographic - # @return [DemographicFilter] + # @return [DemographicFilter,nil] attr_accessor :demographic - # @param demographic [DemographicFilter] + # @param demographic [DemographicFilter,nil] def initialize( demographic: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb index d6f22308..482a403a 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_block_style.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_block_style.rb @@ -13,18 +13,18 @@ module V2 module MessagingApi class FlexBlockStyle # @!attribute [rw] background_color - # @return [String] + # @return [String,nil] attr_accessor :background_color # @!attribute [rw] separator - # @return [Boolean] + # @return [Boolean,nil] attr_accessor :separator # @!attribute [rw] separator_color - # @return [String] + # @return [String,nil] attr_accessor :separator_color - # @param background_color [String] - # @param separator [Boolean] - # @param separator_color [String] + # @param background_color [String,nil] + # @param separator [Boolean,nil] + # @param separator_color [String,nil] def initialize( background_color: nil, separator: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_box.rb b/lib/line/bot/v2/messaging_api/model/flex_box.rb index 68d01540..551ad30f 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box.rb @@ -21,111 +21,111 @@ class FlexBox < FlexComponent # @return [String] ('horizontal'|'vertical'|'baseline') attr_accessor :layout # @!attribute [rw] flex - # @return [Integer] + # @return [Integer,nil] attr_accessor :flex # @!attribute [rw] contents # @return [Array[FlexComponent]] attr_accessor :contents # @!attribute [rw] spacing - # @return [String] + # @return [String,nil] attr_accessor :spacing # @!attribute [rw] margin - # @return [String] + # @return [String,nil] attr_accessor :margin # @!attribute [rw] position - # @return [String] ('relative'|'absolute') + # @return [String,nil] ('relative'|'absolute') attr_accessor :position # @!attribute [rw] offset_top - # @return [String] + # @return [String,nil] attr_accessor :offset_top # @!attribute [rw] offset_bottom - # @return [String] + # @return [String,nil] attr_accessor :offset_bottom # @!attribute [rw] offset_start - # @return [String] + # @return [String,nil] attr_accessor :offset_start # @!attribute [rw] offset_end - # @return [String] + # @return [String,nil] attr_accessor :offset_end # @!attribute [rw] background_color - # @return [String] + # @return [String,nil] attr_accessor :background_color # @!attribute [rw] border_color - # @return [String] + # @return [String,nil] attr_accessor :border_color # @!attribute [rw] border_width - # @return [String] + # @return [String,nil] attr_accessor :border_width # @!attribute [rw] corner_radius - # @return [String] + # @return [String,nil] attr_accessor :corner_radius # @!attribute [rw] width - # @return [String] + # @return [String,nil] attr_accessor :width # @!attribute [rw] max_width - # @return [String] + # @return [String,nil] attr_accessor :max_width # @!attribute [rw] height - # @return [String] + # @return [String,nil] attr_accessor :height # @!attribute [rw] max_height - # @return [String] + # @return [String,nil] attr_accessor :max_height # @!attribute [rw] padding_all - # @return [String] + # @return [String,nil] attr_accessor :padding_all # @!attribute [rw] padding_top - # @return [String] + # @return [String,nil] attr_accessor :padding_top # @!attribute [rw] padding_bottom - # @return [String] + # @return [String,nil] attr_accessor :padding_bottom # @!attribute [rw] padding_start - # @return [String] + # @return [String,nil] attr_accessor :padding_start # @!attribute [rw] padding_end - # @return [String] + # @return [String,nil] attr_accessor :padding_end # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action # @!attribute [rw] justify_content - # @return [String] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') + # @return [String,nil] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') attr_accessor :justify_content # @!attribute [rw] align_items - # @return [String] ('center'|'flex-start'|'flex-end') + # @return [String,nil] ('center'|'flex-start'|'flex-end') attr_accessor :align_items # @!attribute [rw] background - # @return [FlexBoxBackground] + # @return [FlexBoxBackground,nil] attr_accessor :background # @param layout [String] ('horizontal'|'vertical'|'baseline') - # @param flex [Integer] + # @param flex [Integer,nil] # @param contents [Array[FlexComponent]] - # @param spacing [String] - # @param margin [String] - # @param position [String] ('relative'|'absolute') - # @param offset_top [String] - # @param offset_bottom [String] - # @param offset_start [String] - # @param offset_end [String] - # @param background_color [String] - # @param border_color [String] - # @param border_width [String] - # @param corner_radius [String] - # @param width [String] - # @param max_width [String] - # @param height [String] - # @param max_height [String] - # @param padding_all [String] - # @param padding_top [String] - # @param padding_bottom [String] - # @param padding_start [String] - # @param padding_end [String] - # @param action [Action] - # @param justify_content [String] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') - # @param align_items [String] ('center'|'flex-start'|'flex-end') - # @param background [FlexBoxBackground] + # @param spacing [String,nil] + # @param margin [String,nil] + # @param position [String,nil] ('relative'|'absolute') + # @param offset_top [String,nil] + # @param offset_bottom [String,nil] + # @param offset_start [String,nil] + # @param offset_end [String,nil] + # @param background_color [String,nil] + # @param border_color [String,nil] + # @param border_width [String,nil] + # @param corner_radius [String,nil] + # @param width [String,nil] + # @param max_width [String,nil] + # @param height [String,nil] + # @param max_height [String,nil] + # @param padding_all [String,nil] + # @param padding_top [String,nil] + # @param padding_bottom [String,nil] + # @param padding_start [String,nil] + # @param padding_end [String,nil] + # @param action [Action,nil] + # @param justify_content [String,nil] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') + # @param align_items [String,nil] ('center'|'flex-start'|'flex-end') + # @param background [FlexBoxBackground,nil] def initialize( layout:, flex: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb index 11a05f22..32178da8 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box_linear_gradient.rb @@ -18,26 +18,26 @@ class FlexBoxLinearGradient < FlexBoxBackground # @return [String] attr_reader :type # @!attribute [rw] angle - # @return [String] + # @return [String,nil] attr_accessor :angle # @!attribute [rw] start_color - # @return [String] + # @return [String,nil] attr_accessor :start_color # @!attribute [rw] end_color - # @return [String] + # @return [String,nil] attr_accessor :end_color # @!attribute [rw] center_color - # @return [String] + # @return [String,nil] attr_accessor :center_color # @!attribute [rw] center_position - # @return [String] + # @return [String,nil] attr_accessor :center_position - # @param angle [String] - # @param start_color [String] - # @param end_color [String] - # @param center_color [String] - # @param center_position [String] + # @param angle [String,nil] + # @param start_color [String,nil] + # @param end_color [String,nil] + # @param center_color [String,nil] + # @param center_position [String,nil] def initialize( angle: nil, start_color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb index 63126699..1f4b2205 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb @@ -18,38 +18,38 @@ class FlexBubble < FlexContainer # @return [String] attr_reader :type # @!attribute [rw] direction - # @return [String] ('ltr'|'rtl') + # @return [String,nil] ('ltr'|'rtl') attr_accessor :direction # @!attribute [rw] styles - # @return [FlexBubbleStyles] + # @return [FlexBubbleStyles,nil] attr_accessor :styles # @!attribute [rw] header - # @return [FlexBox] + # @return [FlexBox,nil] attr_accessor :header # @!attribute [rw] hero - # @return [FlexComponent] + # @return [FlexComponent,nil] attr_accessor :hero # @!attribute [rw] body - # @return [FlexBox] + # @return [FlexBox,nil] attr_accessor :body # @!attribute [rw] footer - # @return [FlexBox] + # @return [FlexBox,nil] attr_accessor :footer # @!attribute [rw] size - # @return [String] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') + # @return [String,nil] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') attr_accessor :size # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action - # @param direction [String] ('ltr'|'rtl') - # @param styles [FlexBubbleStyles] - # @param header [FlexBox] - # @param hero [FlexComponent] - # @param body [FlexBox] - # @param footer [FlexBox] - # @param size [String] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') - # @param action [Action] + # @param direction [String,nil] ('ltr'|'rtl') + # @param styles [FlexBubbleStyles,nil] + # @param header [FlexBox,nil] + # @param hero [FlexComponent,nil] + # @param body [FlexBox,nil] + # @param footer [FlexBox,nil] + # @param size [String,nil] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') + # @param action [Action,nil] def initialize( direction: nil, styles: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb index efa22fc3..1924a2ee 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble_styles.rb @@ -13,22 +13,22 @@ module V2 module MessagingApi class FlexBubbleStyles # @!attribute [rw] header - # @return [FlexBlockStyle] + # @return [FlexBlockStyle,nil] attr_accessor :header # @!attribute [rw] hero - # @return [FlexBlockStyle] + # @return [FlexBlockStyle,nil] attr_accessor :hero # @!attribute [rw] body - # @return [FlexBlockStyle] + # @return [FlexBlockStyle,nil] attr_accessor :body # @!attribute [rw] footer - # @return [FlexBlockStyle] + # @return [FlexBlockStyle,nil] attr_accessor :footer - # @param header [FlexBlockStyle] - # @param hero [FlexBlockStyle] - # @param body [FlexBlockStyle] - # @param footer [FlexBlockStyle] + # @param header [FlexBlockStyle,nil] + # @param hero [FlexBlockStyle,nil] + # @param body [FlexBlockStyle,nil] + # @param footer [FlexBlockStyle,nil] def initialize( header: nil, hero: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_button.rb b/lib/line/bot/v2/messaging_api/model/flex_button.rb index 697ee676..bd1a9990 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_button.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_button.rb @@ -18,62 +18,62 @@ class FlexButton < FlexComponent # @return [String] attr_reader :type # @!attribute [rw] flex - # @return [Integer] + # @return [Integer,nil] attr_accessor :flex # @!attribute [rw] color - # @return [String] + # @return [String,nil] attr_accessor :color # @!attribute [rw] style - # @return [String] ('primary'|'secondary'|'link') + # @return [String,nil] ('primary'|'secondary'|'link') attr_accessor :style # @!attribute [rw] action # @return [Action] attr_accessor :action # @!attribute [rw] gravity - # @return [String] ('top'|'bottom'|'center') + # @return [String,nil] ('top'|'bottom'|'center') attr_accessor :gravity # @!attribute [rw] margin - # @return [String] + # @return [String,nil] attr_accessor :margin # @!attribute [rw] position - # @return [String] ('relative'|'absolute') + # @return [String,nil] ('relative'|'absolute') attr_accessor :position # @!attribute [rw] offset_top - # @return [String] + # @return [String,nil] attr_accessor :offset_top # @!attribute [rw] offset_bottom - # @return [String] + # @return [String,nil] attr_accessor :offset_bottom # @!attribute [rw] offset_start - # @return [String] + # @return [String,nil] attr_accessor :offset_start # @!attribute [rw] offset_end - # @return [String] + # @return [String,nil] attr_accessor :offset_end # @!attribute [rw] height - # @return [String] ('md'|'sm') + # @return [String,nil] ('md'|'sm') attr_accessor :height # @!attribute [rw] adjust_mode - # @return [String] ('shrink-to-fit') + # @return [String,nil] ('shrink-to-fit') attr_accessor :adjust_mode # @!attribute [rw] scaling - # @return [Boolean] + # @return [Boolean,nil] attr_accessor :scaling - # @param flex [Integer] - # @param color [String] - # @param style [String] ('primary'|'secondary'|'link') + # @param flex [Integer,nil] + # @param color [String,nil] + # @param style [String,nil] ('primary'|'secondary'|'link') # @param action [Action] - # @param gravity [String] ('top'|'bottom'|'center') - # @param margin [String] - # @param position [String] ('relative'|'absolute') - # @param offset_top [String] - # @param offset_bottom [String] - # @param offset_start [String] - # @param offset_end [String] - # @param height [String] ('md'|'sm') - # @param adjust_mode [String] ('shrink-to-fit') - # @param scaling [Boolean] + # @param gravity [String,nil] ('top'|'bottom'|'center') + # @param margin [String,nil] + # @param position [String,nil] ('relative'|'absolute') + # @param offset_top [String,nil] + # @param offset_bottom [String,nil] + # @param offset_start [String,nil] + # @param offset_end [String,nil] + # @param height [String,nil] ('md'|'sm') + # @param adjust_mode [String,nil] ('shrink-to-fit') + # @param scaling [Boolean,nil] def initialize( flex: nil, color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_filler.rb b/lib/line/bot/v2/messaging_api/model/flex_filler.rb index d9f2c2ba..f780026c 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_filler.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_filler.rb @@ -18,10 +18,10 @@ class FlexFiller < FlexComponent # @return [String] attr_reader :type # @!attribute [rw] flex - # @return [Integer] + # @return [Integer,nil] attr_accessor :flex - # @param flex [Integer] + # @param flex [Integer,nil] def initialize( flex: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/flex_icon.rb b/lib/line/bot/v2/messaging_api/model/flex_icon.rb index 6a2a5c99..8eeb774a 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_icon.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_icon.rb @@ -22,43 +22,43 @@ class FlexIcon < FlexComponent # @return [String] attr_accessor :url # @!attribute [rw] size - # @return [String] + # @return [String,nil] attr_accessor :size # @!attribute [rw] aspect_ratio - # @return [String] + # @return [String,nil] attr_accessor :aspect_ratio # @!attribute [rw] margin - # @return [String] + # @return [String,nil] attr_accessor :margin # @!attribute [rw] position - # @return [String] ('relative'|'absolute') + # @return [String,nil] ('relative'|'absolute') attr_accessor :position # @!attribute [rw] offset_top - # @return [String] + # @return [String,nil] attr_accessor :offset_top # @!attribute [rw] offset_bottom - # @return [String] + # @return [String,nil] attr_accessor :offset_bottom # @!attribute [rw] offset_start - # @return [String] + # @return [String,nil] attr_accessor :offset_start # @!attribute [rw] offset_end - # @return [String] + # @return [String,nil] attr_accessor :offset_end # @!attribute [rw] scaling - # @return [Boolean] + # @return [Boolean,nil] attr_accessor :scaling # @param url [String] - # @param size [String] - # @param aspect_ratio [String] - # @param margin [String] - # @param position [String] ('relative'|'absolute') - # @param offset_top [String] - # @param offset_bottom [String] - # @param offset_start [String] - # @param offset_end [String] - # @param scaling [Boolean] + # @param size [String,nil] + # @param aspect_ratio [String,nil] + # @param margin [String,nil] + # @param position [String,nil] ('relative'|'absolute') + # @param offset_top [String,nil] + # @param offset_bottom [String,nil] + # @param offset_start [String,nil] + # @param offset_end [String,nil] + # @param scaling [Boolean,nil] def initialize( url:, size: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_image.rb b/lib/line/bot/v2/messaging_api/model/flex_image.rb index 6404eb8b..5ed4af92 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_image.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_image.rb @@ -22,67 +22,67 @@ class FlexImage < FlexComponent # @return [String] Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) attr_accessor :url # @!attribute [rw] flex - # @return [Integer] The ratio of the width or height of this component within the parent box. + # @return [Integer,nil] The ratio of the width or height of this component within the parent box. attr_accessor :flex # @!attribute [rw] margin - # @return [String] The minimum amount of space to include before this component in its parent container. + # @return [String,nil] The minimum amount of space to include before this component in its parent container. attr_accessor :margin # @!attribute [rw] position - # @return [String] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. + # @return [String,nil] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. attr_accessor :position # @!attribute [rw] offset_top - # @return [String] Offset. + # @return [String,nil] Offset. attr_accessor :offset_top # @!attribute [rw] offset_bottom - # @return [String] Offset. + # @return [String,nil] Offset. attr_accessor :offset_bottom # @!attribute [rw] offset_start - # @return [String] Offset. + # @return [String,nil] Offset. attr_accessor :offset_start # @!attribute [rw] offset_end - # @return [String] Offset. + # @return [String,nil] Offset. attr_accessor :offset_end # @!attribute [rw] align - # @return [String] ('start'|'end'|'center') Alignment style in horizontal direction. + # @return [String,nil] ('start'|'end'|'center') Alignment style in horizontal direction. attr_accessor :align # @!attribute [rw] gravity - # @return [String] ('top'|'bottom'|'center') Alignment style in vertical direction. + # @return [String,nil] ('top'|'bottom'|'center') Alignment style in vertical direction. attr_accessor :gravity # @!attribute [rw] size - # @return [String] The maximum image width. This is md by default. + # @return [String,nil] The maximum image width. This is md by default. attr_accessor :size # @!attribute [rw] aspect_ratio - # @return [String] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. + # @return [String,nil] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. attr_accessor :aspect_ratio # @!attribute [rw] aspect_mode - # @return [String] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. + # @return [String,nil] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. attr_accessor :aspect_mode # @!attribute [rw] background_color - # @return [String] Background color of the image. Use a hexadecimal color code. + # @return [String,nil] Background color of the image. Use a hexadecimal color code. attr_accessor :background_color # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action # @!attribute [rw] animated - # @return [Boolean] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. + # @return [Boolean,nil] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. attr_accessor :animated # @param url [String] Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true) - # @param flex [Integer] The ratio of the width or height of this component within the parent box. - # @param margin [String] The minimum amount of space to include before this component in its parent container. - # @param position [String] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. - # @param offset_top [String] Offset. - # @param offset_bottom [String] Offset. - # @param offset_start [String] Offset. - # @param offset_end [String] Offset. - # @param align [String] ('start'|'end'|'center') Alignment style in horizontal direction. - # @param gravity [String] ('top'|'bottom'|'center') Alignment style in vertical direction. - # @param size [String] The maximum image width. This is md by default. - # @param aspect_ratio [String] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. - # @param aspect_mode [String] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. - # @param background_color [String] Background color of the image. Use a hexadecimal color code. - # @param action [Action] - # @param animated [Boolean] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. + # @param flex [Integer,nil] The ratio of the width or height of this component within the parent box. + # @param margin [String,nil] The minimum amount of space to include before this component in its parent container. + # @param position [String,nil] ('relative'|'absolute') Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values: `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative. + # @param offset_top [String,nil] Offset. + # @param offset_bottom [String,nil] Offset. + # @param offset_start [String,nil] Offset. + # @param offset_end [String,nil] Offset. + # @param align [String,nil] ('start'|'end'|'center') Alignment style in horizontal direction. + # @param gravity [String,nil] ('top'|'bottom'|'center') Alignment style in vertical direction. + # @param size [String,nil] The maximum image width. This is md by default. + # @param aspect_ratio [String,nil] Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`. + # @param aspect_mode [String,nil] ('fit'|'cover') The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. + # @param background_color [String,nil] Background color of the image. Use a hexadecimal color code. + # @param action [Action,nil] + # @param animated [Boolean,nil] When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back. def initialize( url:, flex: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_message.rb b/lib/line/bot/v2/messaging_api/model/flex_message.rb index 751675c3..49d06037 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_message.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_message.rb @@ -19,10 +19,10 @@ class FlexMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] alt_text # @return [String] @@ -31,8 +31,8 @@ class FlexMessage < Message # @return [FlexContainer] attr_accessor :contents - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param alt_text [String] # @param contents [FlexContainer] def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/flex_separator.rb b/lib/line/bot/v2/messaging_api/model/flex_separator.rb index d6c83b3b..81a90bc5 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_separator.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_separator.rb @@ -18,14 +18,14 @@ class FlexSeparator < FlexComponent # @return [String] attr_reader :type # @!attribute [rw] margin - # @return [String] + # @return [String,nil] attr_accessor :margin # @!attribute [rw] color - # @return [String] + # @return [String,nil] attr_accessor :color - # @param margin [String] - # @param color [String] + # @param margin [String,nil] + # @param color [String,nil] def initialize( margin: nil, color: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_span.rb b/lib/line/bot/v2/messaging_api/model/flex_span.rb index f08504ae..766761ae 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_span.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_span.rb @@ -18,30 +18,30 @@ class FlexSpan < FlexComponent # @return [String] attr_reader :type # @!attribute [rw] text - # @return [String] + # @return [String,nil] attr_accessor :text # @!attribute [rw] size - # @return [String] + # @return [String,nil] attr_accessor :size # @!attribute [rw] color - # @return [String] + # @return [String,nil] attr_accessor :color # @!attribute [rw] weight - # @return [String] ('regular'|'bold') + # @return [String,nil] ('regular'|'bold') attr_accessor :weight # @!attribute [rw] style - # @return [String] ('normal'|'italic') + # @return [String,nil] ('normal'|'italic') attr_accessor :style # @!attribute [rw] decoration - # @return [String] ('none'|'underline'|'line-through') + # @return [String,nil] ('none'|'underline'|'line-through') attr_accessor :decoration - # @param text [String] - # @param size [String] - # @param color [String] - # @param weight [String] ('regular'|'bold') - # @param style [String] ('normal'|'italic') - # @param decoration [String] ('none'|'underline'|'line-through') + # @param text [String,nil] + # @param size [String,nil] + # @param color [String,nil] + # @param weight [String,nil] ('regular'|'bold') + # @param style [String,nil] ('normal'|'italic') + # @param decoration [String,nil] ('none'|'underline'|'line-through') def initialize( text: nil, size: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_text.rb b/lib/line/bot/v2/messaging_api/model/flex_text.rb index 195d04d1..cb1acac7 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_text.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_text.rb @@ -18,94 +18,94 @@ class FlexText < FlexComponent # @return [String] attr_reader :type # @!attribute [rw] flex - # @return [Integer] + # @return [Integer,nil] attr_accessor :flex # @!attribute [rw] text - # @return [String] + # @return [String,nil] attr_accessor :text # @!attribute [rw] size - # @return [String] + # @return [String,nil] attr_accessor :size # @!attribute [rw] align - # @return [String] ('start'|'end'|'center') + # @return [String,nil] ('start'|'end'|'center') attr_accessor :align # @!attribute [rw] gravity - # @return [String] ('top'|'bottom'|'center') + # @return [String,nil] ('top'|'bottom'|'center') attr_accessor :gravity # @!attribute [rw] color - # @return [String] + # @return [String,nil] attr_accessor :color # @!attribute [rw] weight - # @return [String] ('regular'|'bold') + # @return [String,nil] ('regular'|'bold') attr_accessor :weight # @!attribute [rw] style - # @return [String] ('normal'|'italic') + # @return [String,nil] ('normal'|'italic') attr_accessor :style # @!attribute [rw] decoration - # @return [String] ('none'|'underline'|'line-through') + # @return [String,nil] ('none'|'underline'|'line-through') attr_accessor :decoration # @!attribute [rw] wrap - # @return [Boolean] + # @return [Boolean,nil] attr_accessor :wrap # @!attribute [rw] line_spacing - # @return [String] + # @return [String,nil] attr_accessor :line_spacing # @!attribute [rw] margin - # @return [String] + # @return [String,nil] attr_accessor :margin # @!attribute [rw] position - # @return [String] ('relative'|'absolute') + # @return [String,nil] ('relative'|'absolute') attr_accessor :position # @!attribute [rw] offset_top - # @return [String] + # @return [String,nil] attr_accessor :offset_top # @!attribute [rw] offset_bottom - # @return [String] + # @return [String,nil] attr_accessor :offset_bottom # @!attribute [rw] offset_start - # @return [String] + # @return [String,nil] attr_accessor :offset_start # @!attribute [rw] offset_end - # @return [String] + # @return [String,nil] attr_accessor :offset_end # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action # @!attribute [rw] max_lines - # @return [Integer] + # @return [Integer,nil] attr_accessor :max_lines # @!attribute [rw] contents - # @return [Array[FlexSpan]] + # @return [Array[FlexSpan],nil] attr_accessor :contents # @!attribute [rw] adjust_mode - # @return [String] ('shrink-to-fit') + # @return [String,nil] ('shrink-to-fit') attr_accessor :adjust_mode # @!attribute [rw] scaling - # @return [Boolean] + # @return [Boolean,nil] attr_accessor :scaling - # @param flex [Integer] - # @param text [String] - # @param size [String] - # @param align [String] ('start'|'end'|'center') - # @param gravity [String] ('top'|'bottom'|'center') - # @param color [String] - # @param weight [String] ('regular'|'bold') - # @param style [String] ('normal'|'italic') - # @param decoration [String] ('none'|'underline'|'line-through') - # @param wrap [Boolean] - # @param line_spacing [String] - # @param margin [String] - # @param position [String] ('relative'|'absolute') - # @param offset_top [String] - # @param offset_bottom [String] - # @param offset_start [String] - # @param offset_end [String] - # @param action [Action] - # @param max_lines [Integer] - # @param contents [Array[FlexSpan]] - # @param adjust_mode [String] ('shrink-to-fit') - # @param scaling [Boolean] + # @param flex [Integer,nil] + # @param text [String,nil] + # @param size [String,nil] + # @param align [String,nil] ('start'|'end'|'center') + # @param gravity [String,nil] ('top'|'bottom'|'center') + # @param color [String,nil] + # @param weight [String,nil] ('regular'|'bold') + # @param style [String,nil] ('normal'|'italic') + # @param decoration [String,nil] ('none'|'underline'|'line-through') + # @param wrap [Boolean,nil] + # @param line_spacing [String,nil] + # @param margin [String,nil] + # @param position [String,nil] ('relative'|'absolute') + # @param offset_top [String,nil] + # @param offset_bottom [String,nil] + # @param offset_start [String,nil] + # @param offset_end [String,nil] + # @param action [Action,nil] + # @param max_lines [Integer,nil] + # @param contents [Array[FlexSpan],nil] + # @param adjust_mode [String,nil] ('shrink-to-fit') + # @param scaling [Boolean,nil] def initialize( flex: nil, text: nil, diff --git a/lib/line/bot/v2/messaging_api/model/flex_video.rb b/lib/line/bot/v2/messaging_api/model/flex_video.rb index 374bfd65..bc9c2cfd 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_video.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_video.rb @@ -27,17 +27,17 @@ class FlexVideo < FlexComponent # @return [FlexComponent] attr_accessor :alt_content # @!attribute [rw] aspect_ratio - # @return [String] + # @return [String,nil] attr_accessor :aspect_ratio # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action # @param url [String] # @param preview_url [String] # @param alt_content [FlexComponent] - # @param aspect_ratio [String] - # @param action [Action] + # @param aspect_ratio [String,nil] + # @param action [Action,nil] def initialize( url:, preview_url:, diff --git a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb index 10355155..73ad7cb7 100644 --- a/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/gender_demographic_filter.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class GenderDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] one_of # @return [Array['male'|'female']] attr_accessor :one_of - # @param one_of [Array['male'|'female']] + # @param one_of [Array['male'|'female'],nil] def initialize( one_of: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb index ce3e7f4b..2da99f86 100644 --- a/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_name_list_response.rb @@ -17,11 +17,11 @@ class GetAggregationUnitNameListResponse # @return [Array[String]] An array of strings indicating the names of aggregation units used this month. attr_accessor :custom_aggregation_units # @!attribute [rw] _next - # @return [String] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. + # @return [String,nil] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. attr_accessor :_next # @param custom_aggregation_units [Array[String]] An array of strings indicating the names of aggregation units used this month. - # @param _next [String] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. + # @param _next [String,nil] A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. def initialize( custom_aggregation_units:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb index 3de44189..4c490019 100644 --- a/lib/line/bot/v2/messaging_api/model/get_followers_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_followers_response.rb @@ -17,11 +17,11 @@ class GetFollowersResponse # @return [Array[String]] An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. attr_accessor :user_ids # @!attribute [rw] _next - # @return [String] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. + # @return [String,nil] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. attr_accessor :_next # @param user_ids [Array[String]] An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`. - # @param _next [String] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. + # @param _next [String,nil] A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response. def initialize( user_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb index 7d81d2a9..118b613d 100644 --- a/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb +++ b/lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb @@ -18,11 +18,11 @@ class GetJoinedMembershipUsersResponse # @return [Array[String]] A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. attr_accessor :user_ids # @!attribute [rw] _next - # @return [String] 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). + # @return [String,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). attr_accessor :_next # @param user_ids [Array[String]] A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned. - # @param _next [String] 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). + # @param _next [String,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). def initialize( user_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb index c3e5ffbb..fe2aba9f 100644 --- a/lib/line/bot/v2/messaging_api/model/group_summary_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_summary_response.rb @@ -20,12 +20,12 @@ class GroupSummaryResponse # @return [String] Group name attr_accessor :group_name # @!attribute [rw] picture_url - # @return [String] Group icon URL. Not included in the response if the user doesn't set a group profile icon. + # @return [String,nil] Group icon URL. Not included in the response if the user doesn't set a group profile icon. attr_accessor :picture_url # @param group_id [String] Group ID # @param group_name [String] Group name - # @param picture_url [String] Group icon URL. Not included in the response if the user doesn't set a group profile icon. + # @param picture_url [String,nil] Group icon URL. Not included in the response if the user doesn't set a group profile icon. def initialize( group_id:, group_name:, diff --git a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb index 816327fc..88525027 100644 --- a/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/group_user_profile_response.rb @@ -20,12 +20,12 @@ class GroupUserProfileResponse # @return [String] User ID attr_accessor :user_id # @!attribute [rw] picture_url - # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @return [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. attr_accessor :picture_url # @param display_name [String] User's display name # @param user_id [String] User ID - # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param picture_url [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/image_message.rb b/lib/line/bot/v2/messaging_api/model/image_message.rb index 7f9c4bba..f1c3dd7f 100644 --- a/lib/line/bot/v2/messaging_api/model/image_message.rb +++ b/lib/line/bot/v2/messaging_api/model/image_message.rb @@ -19,10 +19,10 @@ class ImageMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] original_content_url # @return [String] @@ -31,8 +31,8 @@ class ImageMessage < Message # @return [String] attr_accessor :preview_image_url - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param original_content_url [String] # @param preview_image_url [String] def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb index 479420f9..11b8a9aa 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_external_link.rb @@ -13,14 +13,14 @@ module V2 module MessagingApi class ImagemapExternalLink # @!attribute [rw] link_uri - # @return [String] + # @return [String,nil] attr_accessor :link_uri # @!attribute [rw] label - # @return [String] + # @return [String,nil] attr_accessor :label - # @param link_uri [String] - # @param label [String] + # @param link_uri [String,nil] + # @param label [String,nil] def initialize( link_uri: nil, label: nil, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb index 03ba1bf6..1739085c 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb @@ -19,10 +19,10 @@ class ImagemapMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] base_url # @return [String] @@ -37,16 +37,16 @@ class ImagemapMessage < Message # @return [Array[ImagemapAction]] attr_accessor :actions # @!attribute [rw] video - # @return [ImagemapVideo] + # @return [ImagemapVideo,nil] attr_accessor :video - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param base_url [String] # @param alt_text [String] # @param base_size [ImagemapBaseSize] # @param actions [Array[ImagemapAction]] - # @param video [ImagemapVideo] + # @param video [ImagemapVideo,nil] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb index fcaa3b49..c4857b55 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb @@ -13,22 +13,22 @@ module V2 module MessagingApi class ImagemapVideo # @!attribute [rw] original_content_url - # @return [String] + # @return [String,nil] attr_accessor :original_content_url # @!attribute [rw] preview_image_url - # @return [String] + # @return [String,nil] attr_accessor :preview_image_url # @!attribute [rw] area - # @return [ImagemapArea] + # @return [ImagemapArea,nil] attr_accessor :area # @!attribute [rw] external_link - # @return [ImagemapExternalLink] + # @return [ImagemapExternalLink,nil] attr_accessor :external_link - # @param original_content_url [String] - # @param preview_image_url [String] - # @param area [ImagemapArea] - # @param external_link [ImagemapExternalLink] + # @param original_content_url [String,nil] + # @param preview_image_url [String,nil] + # @param area [ImagemapArea,nil] + # @param external_link [ImagemapExternalLink,nil] def initialize( original_content_url: nil, preview_image_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/limit.rb b/lib/line/bot/v2/messaging_api/model/limit.rb index 0aa7dca4..ed92c605 100644 --- a/lib/line/bot/v2/messaging_api/model/limit.rb +++ b/lib/line/bot/v2/messaging_api/model/limit.rb @@ -15,14 +15,14 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message class Limit # @!attribute [rw] max - # @return [Integer] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. + # @return [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. attr_accessor :max # @!attribute [rw] up_to_remaining_quota - # @return [Boolean] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. + # @return [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. attr_accessor :up_to_remaining_quota - # @param max [Integer] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. - # @param up_to_remaining_quota [Boolean] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. + # @param max [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. + # @param up_to_remaining_quota [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. def initialize( max: nil, up_to_remaining_quota: false, diff --git a/lib/line/bot/v2/messaging_api/model/location_action.rb b/lib/line/bot/v2/messaging_api/model/location_action.rb index 9b3c8666..bce3c410 100644 --- a/lib/line/bot/v2/messaging_api/model/location_action.rb +++ b/lib/line/bot/v2/messaging_api/model/location_action.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class LocationAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label - # @param label [String] Label for the action. + # @param label [String,nil] Label for the action. def initialize( label: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/location_message.rb b/lib/line/bot/v2/messaging_api/model/location_message.rb index b9525a9f..ed35917d 100644 --- a/lib/line/bot/v2/messaging_api/model/location_message.rb +++ b/lib/line/bot/v2/messaging_api/model/location_message.rb @@ -19,10 +19,10 @@ class LocationMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] title # @return [String] @@ -37,8 +37,8 @@ class LocationMessage < Message # @return [Float] attr_accessor :longitude - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param title [String] # @param address [String] # @param latitude [Float] diff --git a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb index 5d08b902..af350003 100644 --- a/lib/line/bot/v2/messaging_api/model/members_ids_response.rb +++ b/lib/line/bot/v2/messaging_api/model/members_ids_response.rb @@ -16,11 +16,11 @@ class MembersIdsResponse # @return [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. attr_accessor :member_ids # @!attribute [rw] _next - # @return [String] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. + # @return [String,nil] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. attr_accessor :_next # @param member_ids [Array[String]] List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`. - # @param _next [String] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. + # @param _next [String,nil] A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request. def initialize( member_ids:, _next: nil, diff --git a/lib/line/bot/v2/messaging_api/model/message.rb b/lib/line/bot/v2/messaging_api/model/message.rb index 5ff52836..4688e749 100644 --- a/lib/line/bot/v2/messaging_api/model/message.rb +++ b/lib/line/bot/v2/messaging_api/model/message.rb @@ -17,15 +17,15 @@ class Message # @return [String] Type of message attr_accessor :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @param type [String] Type of message - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] def initialize( type:, quick_reply: nil, diff --git a/lib/line/bot/v2/messaging_api/model/message_action.rb b/lib/line/bot/v2/messaging_api/model/message_action.rb index 0af3341a..993a204a 100644 --- a/lib/line/bot/v2/messaging_api/model/message_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_action.rb @@ -15,17 +15,17 @@ module V2 module MessagingApi class MessageAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] text - # @return [String] + # @return [String,nil] attr_accessor :text - # @param label [String] Label for the action. - # @param text [String] + # @param label [String,nil] Label for the action. + # @param text [String,nil] def initialize( label: nil, text: nil, diff --git a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb index d60e69da..b44c0065 100644 --- a/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_imagemap_action.rb @@ -24,12 +24,12 @@ class MessageImagemapAction < ImagemapAction # @return [String] attr_accessor :text # @!attribute [rw] label - # @return [String] + # @return [String,nil] attr_accessor :label # @param area [ImagemapArea] # @param text [String] - # @param label [String] + # @param label [String,nil] def initialize( area:, text:, diff --git a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb index 889db93a..53d506f4 100644 --- a/lib/line/bot/v2/messaging_api/model/message_quota_response.rb +++ b/lib/line/bot/v2/messaging_api/model/message_quota_response.rb @@ -17,11 +17,11 @@ class MessageQuotaResponse # @return [String] ('none'|'limited') attr_accessor :type # @!attribute [rw] value - # @return [Integer] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. + # @return [Integer,nil] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. attr_accessor :value # @param type [String] ('none'|'limited') - # @param value [Integer] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. + # @param value [Integer,nil] The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`. def initialize( type:, value: nil, diff --git a/lib/line/bot/v2/messaging_api/model/multicast_request.rb b/lib/line/bot/v2/messaging_api/model/multicast_request.rb index 424ec485..7a68e334 100644 --- a/lib/line/bot/v2/messaging_api/model/multicast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/multicast_request.rb @@ -20,16 +20,16 @@ class MulticastRequest # @return [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. attr_accessor :to # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @!attribute [rw] custom_aggregation_units - # @return [Array[String]] Name of aggregation unit. Case-sensitive. + # @return [Array[String],nil] Name of aggregation unit. Case-sensitive. attr_accessor :custom_aggregation_units # @param messages [Array[Message]] Messages to send # @param to [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. - # @param custom_aggregation_units [Array[String]] Name of aggregation unit. Case-sensitive. + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param custom_aggregation_units [Array[String],nil] Name of aggregation unit. Case-sensitive. def initialize( messages:, to:, diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb index ec29d731..f1ba5691 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb @@ -17,35 +17,35 @@ class NarrowcastProgressResponse # @return [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. attr_accessor :phase # @!attribute [rw] success_count - # @return [Integer] The number of users who successfully received the message. + # @return [Integer,nil] The number of users who successfully received the message. attr_accessor :success_count # @!attribute [rw] failure_count - # @return [Integer] The number of users who failed to send the message. + # @return [Integer,nil] The number of users who failed to send the message. attr_accessor :failure_count # @!attribute [rw] target_count - # @return [Integer] The number of intended recipients of the message. + # @return [Integer,nil] The number of intended recipients of the message. attr_accessor :target_count # @!attribute [rw] failed_description - # @return [String] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. + # @return [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. attr_accessor :failed_description # @!attribute [rw] error_code - # @return [Integer] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. + # @return [Integer,nil] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. attr_accessor :error_code # @!attribute [rw] accepted_time # @return [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC attr_accessor :accepted_time # @!attribute [rw] completed_time - # @return [String] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + # @return [String,nil] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC attr_accessor :completed_time # @param phase [String] ('waiting'|'sending'|'succeeded'|'failed') The current status. One of: `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. - # @param success_count [Integer] The number of users who successfully received the message. - # @param failure_count [Integer] The number of users who failed to send the message. - # @param target_count [Integer] The number of intended recipients of the message. - # @param failed_description [String] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. - # @param error_code [Integer] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. + # @param success_count [Integer,nil] The number of users who successfully received the message. + # @param failure_count [Integer,nil] The number of users who failed to send the message. + # @param target_count [Integer,nil] The number of intended recipients of the message. + # @param failed_description [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`. + # @param error_code [Integer,nil] Error summary. This is only included with a phase property value of failed. One of: `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. # @param accepted_time [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC - # @param completed_time [String] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC + # @param completed_time [String,nil] Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC def initialize( phase:, success_count: nil, diff --git a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb index dd31a981..7bd372dc 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb @@ -17,23 +17,23 @@ class NarrowcastRequest # @return [Array[Message]] List of Message objects. attr_accessor :messages # @!attribute [rw] recipient - # @return [Recipient] + # @return [Recipient,nil] attr_accessor :recipient # @!attribute [rw] filter - # @return [Filter] + # @return [Filter,nil] attr_accessor :filter # @!attribute [rw] limit - # @return [Limit] + # @return [Limit,nil] attr_accessor :limit # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @param messages [Array[Message]] List of Message objects. - # @param recipient [Recipient] - # @param filter [Filter] - # @param limit [Limit] - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param recipient [Recipient,nil] + # @param filter [Filter,nil] + # @param limit [Limit,nil] + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, recipient: nil, diff --git a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb index 23deaf3e..40db7e7e 100644 --- a/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb +++ b/lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb @@ -16,11 +16,11 @@ class NumberOfMessagesResponse # @return [String] ('ready'|'unready'|'unavailable_for_privacy'|'out_of_service') Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). attr_accessor :status # @!attribute [rw] success - # @return [Integer] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. + # @return [Integer,nil] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. attr_accessor :success # @param status [String] ('ready'|'unready'|'unavailable_for_privacy'|'out_of_service') Aggregation process status. One of: `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018). - # @param success [Integer] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. + # @param success [Integer,nil] The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`. def initialize( status:, success: nil, diff --git a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb index 349b713b..9436f96b 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_demographic_filter.rb @@ -15,21 +15,21 @@ module V2 module MessagingApi class OperatorDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] _and - # @return [Array[DemographicFilter]] + # @return [Array[DemographicFilter],nil] attr_accessor :_and # @!attribute [rw] _or - # @return [Array[DemographicFilter]] + # @return [Array[DemographicFilter],nil] attr_accessor :_or # @!attribute [rw] _not - # @return [DemographicFilter] + # @return [DemographicFilter,nil] attr_accessor :_not - # @param _and [Array[DemographicFilter]] - # @param _or [Array[DemographicFilter]] - # @param _not [DemographicFilter] + # @param _and [Array[DemographicFilter],nil] + # @param _or [Array[DemographicFilter],nil] + # @param _not [DemographicFilter,nil] def initialize( _and: nil, _or: nil, diff --git a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb index cbb1b464..27663c30 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb @@ -15,21 +15,21 @@ module V2 module MessagingApi class OperatorRecipient < Recipient # @!attribute [r] type - # @return [String] Type of recipient + # @return [String,nil] Type of recipient attr_reader :type # @!attribute [rw] _and - # @return [Array[Recipient]] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. + # @return [Array[Recipient],nil] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. attr_accessor :_and # @!attribute [rw] _or - # @return [Array[Recipient]] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. + # @return [Array[Recipient],nil] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. attr_accessor :_or # @!attribute [rw] _not - # @return [Recipient] + # @return [Recipient,nil] attr_accessor :_not - # @param _and [Array[Recipient]] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. - # @param _or [Array[Recipient]] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. - # @param _not [Recipient] + # @param _and [Array[Recipient],nil] Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects. + # @param _or [Array[Recipient],nil] Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects. + # @param _not [Recipient,nil] def initialize( _and: nil, _or: nil, diff --git a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb index 53003eeb..d1dd2b17 100644 --- a/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb +++ b/lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb @@ -20,12 +20,12 @@ class PnpMessagesRequest # @return [String] Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. attr_accessor :to # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @param messages [Array[Message]] Message to be sent. # @param to [String] Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( messages:, to:, diff --git a/lib/line/bot/v2/messaging_api/model/postback_action.rb b/lib/line/bot/v2/messaging_api/model/postback_action.rb index 7e84e3d4..da45c0f7 100644 --- a/lib/line/bot/v2/messaging_api/model/postback_action.rb +++ b/lib/line/bot/v2/messaging_api/model/postback_action.rb @@ -15,33 +15,33 @@ module V2 module MessagingApi class PostbackAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] data - # @return [String] + # @return [String,nil] attr_accessor :data # @!attribute [rw] display_text - # @return [String] + # @return [String,nil] attr_accessor :display_text # @!attribute [rw] text - # @return [String] + # @return [String,nil] attr_accessor :text # @!attribute [rw] input_option - # @return [String] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') + # @return [String,nil] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') attr_accessor :input_option # @!attribute [rw] fill_in_text - # @return [String] + # @return [String,nil] attr_accessor :fill_in_text - # @param label [String] Label for the action. - # @param data [String] - # @param display_text [String] - # @param text [String] - # @param input_option [String] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') - # @param fill_in_text [String] + # @param label [String,nil] Label for the action. + # @param data [String,nil] + # @param display_text [String,nil] + # @param text [String,nil] + # @param input_option [String,nil] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') + # @param fill_in_text [String,nil] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/push_message_request.rb b/lib/line/bot/v2/messaging_api/model/push_message_request.rb index 75e16299..f56ad8ea 100644 --- a/lib/line/bot/v2/messaging_api/model/push_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/push_message_request.rb @@ -20,16 +20,16 @@ class PushMessageRequest # @return [Array[Message]] List of Message objects. attr_accessor :messages # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @!attribute [rw] custom_aggregation_units - # @return [Array[String]] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. + # @return [Array[String],nil] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. attr_accessor :custom_aggregation_units # @param to [String] ID of the receiver. # @param messages [Array[Message]] List of Message objects. - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. - # @param custom_aggregation_units [Array[String]] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param custom_aggregation_units [Array[String],nil] List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. def initialize( to:, messages:, diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply.rb b/lib/line/bot/v2/messaging_api/model/quick_reply.rb index d061a008..6b0f5903 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply.rb @@ -15,10 +15,10 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#items-object class QuickReply # @!attribute [rw] items - # @return [Array[QuickReplyItem]] Quick reply button objects. + # @return [Array[QuickReplyItem],nil] Quick reply button objects. attr_accessor :items - # @param items [Array[QuickReplyItem]] Quick reply button objects. + # @param items [Array[QuickReplyItem],nil] Quick reply button objects. def initialize( items: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb index 90afecb3..1ecb4dc3 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply_item.rb @@ -14,18 +14,18 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#items-object class QuickReplyItem # @!attribute [rw] image_url - # @return [String] URL of the icon that is displayed at the beginning of the button + # @return [String,nil] URL of the icon that is displayed at the beginning of the button attr_accessor :image_url # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action # @!attribute [rw] type - # @return [String] `action` + # @return [String,nil] `action` attr_accessor :type - # @param image_url [String] URL of the icon that is displayed at the beginning of the button - # @param action [Action] - # @param type [String] `action` + # @param image_url [String,nil] URL of the icon that is displayed at the beginning of the button + # @param action [Action,nil] + # @param type [String,nil] `action` def initialize( image_url: nil, action: nil, diff --git a/lib/line/bot/v2/messaging_api/model/recipient.rb b/lib/line/bot/v2/messaging_api/model/recipient.rb index 5b71b612..66c85ade 100644 --- a/lib/line/bot/v2/messaging_api/model/recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/recipient.rb @@ -14,10 +14,10 @@ module MessagingApi # Recipient class Recipient # @!attribute [rw] type - # @return [String] Type of recipient + # @return [String,nil] Type of recipient attr_accessor :type - # @param type [String] Type of recipient + # @param type [String,nil] Type of recipient def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb index b616545c..62540e99 100644 --- a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb @@ -15,13 +15,13 @@ module V2 module MessagingApi class RedeliveryRecipient < Recipient # @!attribute [r] type - # @return [String] Type of recipient + # @return [String,nil] Type of recipient attr_reader :type # @!attribute [rw] request_id - # @return [String] + # @return [String,nil] attr_accessor :request_id - # @param request_id [String] + # @param request_id [String,nil] def initialize( request_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb index 662070c6..37a47a7a 100644 --- a/lib/line/bot/v2/messaging_api/model/reply_message_request.rb +++ b/lib/line/bot/v2/messaging_api/model/reply_message_request.rb @@ -20,12 +20,12 @@ class ReplyMessageRequest # @return [Array[Message]] List of messages. attr_accessor :messages # @!attribute [rw] notification_disabled - # @return [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. attr_accessor :notification_disabled # @param reply_token [String] replyToken received via webhook. # @param messages [Array[Message]] List of messages. - # @param notification_disabled [Boolean] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. + # @param notification_disabled [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. def initialize( reply_token:, messages:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb index e9f8025a..7b05d2b0 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_area.rb @@ -14,14 +14,14 @@ module MessagingApi # Rich menu area class RichMenuArea # @!attribute [rw] bounds - # @return [RichMenuBounds] + # @return [RichMenuBounds,nil] attr_accessor :bounds # @!attribute [rw] action - # @return [Action] + # @return [Action,nil] attr_accessor :action - # @param bounds [RichMenuBounds] - # @param action [Action] + # @param bounds [RichMenuBounds,nil] + # @param action [Action,nil] def initialize( bounds: nil, action: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb index 2b71650d..04846d91 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb @@ -20,12 +20,12 @@ class RichMenuBatchProgressResponse # @return [String] The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC attr_accessor :accepted_time # @!attribute [rw] completed_time - # @return [String] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + # @return [String,nil] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC attr_accessor :completed_time # @param phase [String] ('ongoing'|'succeeded'|'failed') # @param accepted_time [String] The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC - # @param completed_time [String] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC + # @param completed_time [String,nil] The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC def initialize( phase:, accepted_time:, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb index 42c6241a..3a0a5725 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_request.rb @@ -16,11 +16,11 @@ class RichMenuBatchRequest # @return [Array[RichMenuBatchOperation]] Array of Rich menu operation object... attr_accessor :operations # @!attribute [rw] resume_request_key - # @return [String] Key for retry. Key value is a string matching the regular expression pattern + # @return [String,nil] Key for retry. Key value is a string matching the regular expression pattern attr_accessor :resume_request_key # @param operations [Array[RichMenuBatchOperation]] Array of Rich menu operation object... - # @param resume_request_key [String] Key for retry. Key value is a string matching the regular expression pattern + # @param resume_request_key [String,nil] Key for retry. Key value is a string matching the regular expression pattern def initialize( operations:, resume_request_key: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb index b7ab3890..e0b2b86c 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_bounds.rb @@ -15,22 +15,22 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#bounds-object class RichMenuBounds # @!attribute [rw] x - # @return [Integer] Horizontal position relative to the top-left corner of the area. + # @return [Integer,nil] Horizontal position relative to the top-left corner of the area. attr_accessor :x # @!attribute [rw] y - # @return [Integer] Vertical position relative to the top-left corner of the area. + # @return [Integer,nil] Vertical position relative to the top-left corner of the area. attr_accessor :y # @!attribute [rw] width - # @return [Integer] Width of the area. + # @return [Integer,nil] Width of the area. attr_accessor :width # @!attribute [rw] height - # @return [Integer] Height of the area. + # @return [Integer,nil] Height of the area. attr_accessor :height - # @param x [Integer] Horizontal position relative to the top-left corner of the area. - # @param y [Integer] Vertical position relative to the top-left corner of the area. - # @param width [Integer] Width of the area. - # @param height [Integer] Height of the area. + # @param x [Integer,nil] Horizontal position relative to the top-left corner of the area. + # @param y [Integer,nil] Vertical position relative to the top-left corner of the area. + # @param width [Integer,nil] Width of the area. + # @param height [Integer,nil] Height of the area. def initialize( x: nil, y: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb index 2e5c9273..95759d25 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_request.rb @@ -13,26 +13,26 @@ module V2 module MessagingApi class RichMenuRequest # @!attribute [rw] size - # @return [RichMenuSize] + # @return [RichMenuSize,nil] attr_accessor :size # @!attribute [rw] selected - # @return [Boolean] `true` to display the rich menu by default. Otherwise, `false`. + # @return [Boolean,nil] `true` to display the rich menu by default. Otherwise, `false`. attr_accessor :selected # @!attribute [rw] name - # @return [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + # @return [String,nil] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. attr_accessor :name # @!attribute [rw] chat_bar_text - # @return [String] Text displayed in the chat bar + # @return [String,nil] Text displayed in the chat bar attr_accessor :chat_bar_text # @!attribute [rw] areas - # @return [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas + # @return [Array[RichMenuArea],nil] Array of area objects which define the coordinates and size of tappable areas attr_accessor :areas - # @param size [RichMenuSize] - # @param selected [Boolean] `true` to display the rich menu by default. Otherwise, `false`. - # @param name [String] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. - # @param chat_bar_text [String] Text displayed in the chat bar - # @param areas [Array[RichMenuArea]] Array of area objects which define the coordinates and size of tappable areas + # @param size [RichMenuSize,nil] + # @param selected [Boolean,nil] `true` to display the rich menu by default. Otherwise, `false`. + # @param name [String,nil] Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. + # @param chat_bar_text [String,nil] Text displayed in the chat bar + # @param areas [Array[RichMenuArea],nil] Array of area objects which define the coordinates and size of tappable areas def initialize( size: nil, selected: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb index 83b2c9be..5c46d3ce 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_size.rb @@ -14,14 +14,14 @@ module MessagingApi # Rich menu size class RichMenuSize # @!attribute [rw] width - # @return [Integer] width + # @return [Integer,nil] width attr_accessor :width # @!attribute [rw] height - # @return [Integer] height + # @return [Integer,nil] height attr_accessor :height - # @param width [Integer] width - # @param height [Integer] height + # @param width [Integer,nil] width + # @param height [Integer,nil] height def initialize( width: nil, height: nil, diff --git a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb index 437d1507..cb021df5 100644 --- a/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb +++ b/lib/line/bot/v2/messaging_api/model/rich_menu_switch_action.rb @@ -15,21 +15,21 @@ module V2 module MessagingApi class RichMenuSwitchAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] data - # @return [String] + # @return [String,nil] attr_accessor :data # @!attribute [rw] rich_menu_alias_id - # @return [String] + # @return [String,nil] attr_accessor :rich_menu_alias_id - # @param label [String] Label for the action. - # @param data [String] - # @param rich_menu_alias_id [String] + # @param label [String,nil] Label for the action. + # @param data [String,nil] + # @param rich_menu_alias_id [String,nil] def initialize( label: nil, data: nil, diff --git a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb index f97419fc..64da0105 100644 --- a/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/room_user_profile_response.rb @@ -20,12 +20,12 @@ class RoomUserProfileResponse # @return [String] User ID attr_accessor :user_id # @!attribute [rw] picture_url - # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @return [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. attr_accessor :picture_url # @param display_name [String] User's display name # @param user_id [String] User ID - # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param picture_url [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/sender.rb b/lib/line/bot/v2/messaging_api/model/sender.rb index b8255e30..c21507af 100644 --- a/lib/line/bot/v2/messaging_api/model/sender.rb +++ b/lib/line/bot/v2/messaging_api/model/sender.rb @@ -14,14 +14,14 @@ module MessagingApi # Change icon and display name class Sender # @!attribute [rw] name - # @return [String] Display name. Certain words such as `LINE` may not be used. + # @return [String,nil] Display name. Certain words such as `LINE` may not be used. attr_accessor :name # @!attribute [rw] icon_url - # @return [String] URL of the image to display as an icon when sending a message + # @return [String,nil] URL of the image to display as an icon when sending a message attr_accessor :icon_url - # @param name [String] Display name. Certain words such as `LINE` may not be used. - # @param icon_url [String] URL of the image to display as an icon when sending a message + # @param name [String,nil] Display name. Certain words such as `LINE` may not be used. + # @param icon_url [String,nil] URL of the image to display as an icon when sending a message def initialize( name: nil, icon_url: nil, diff --git a/lib/line/bot/v2/messaging_api/model/sent_message.rb b/lib/line/bot/v2/messaging_api/model/sent_message.rb index 5e672ced..e268e431 100644 --- a/lib/line/bot/v2/messaging_api/model/sent_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sent_message.rb @@ -16,11 +16,11 @@ class SentMessage # @return [String] ID of the sent message. attr_accessor :id # @!attribute [rw] quote_token - # @return [String] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. + # @return [String,nil] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. attr_accessor :quote_token # @param id [String] ID of the sent message. - # @param quote_token [String] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. + # @param quote_token [String,nil] Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. def initialize( id:, quote_token: nil, diff --git a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb index d0bb81be..cb5331be 100644 --- a/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb +++ b/lib/line/bot/v2/messaging_api/model/show_loading_animation_request.rb @@ -17,11 +17,11 @@ class ShowLoadingAnimationRequest # @return [String] User ID of the target user for whom the loading animation is to be displayed. attr_accessor :chat_id # @!attribute [rw] loading_seconds - # @return [Integer] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. + # @return [Integer,nil] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. attr_accessor :loading_seconds # @param chat_id [String] User ID of the target user for whom the loading animation is to be displayed. - # @param loading_seconds [Integer] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. + # @param loading_seconds [Integer,nil] The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. def initialize( chat_id:, loading_seconds: nil, diff --git a/lib/line/bot/v2/messaging_api/model/sticker_message.rb b/lib/line/bot/v2/messaging_api/model/sticker_message.rb index 1bd0a1cb..0e8144d3 100644 --- a/lib/line/bot/v2/messaging_api/model/sticker_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sticker_message.rb @@ -19,10 +19,10 @@ class StickerMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] package_id # @return [String] @@ -31,14 +31,14 @@ class StickerMessage < Message # @return [String] attr_accessor :sticker_id # @!attribute [rw] quote_token - # @return [String] Quote token of the message you want to quote. + # @return [String,nil] Quote token of the message you want to quote. attr_accessor :quote_token - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param package_id [String] # @param sticker_id [String] - # @param quote_token [String] Quote token of the message you want to quote. + # @param quote_token [String,nil] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb index 67d111ec..e1efe871 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription_period_demographic_filter.rb @@ -15,17 +15,17 @@ module V2 module MessagingApi class SubscriptionPeriodDemographicFilter < DemographicFilter # @!attribute [r] type - # @return [String] Type of demographic filter + # @return [String,nil] Type of demographic filter attr_reader :type # @!attribute [rw] gte - # @return [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') + # @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :gte # @!attribute [rw] lt - # @return [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') + # @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :lt - # @param gte [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') - # @param lt [String] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') + # @param gte [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') + # @param lt [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') def initialize( gte: nil, lt: nil, diff --git a/lib/line/bot/v2/messaging_api/model/template_message.rb b/lib/line/bot/v2/messaging_api/model/template_message.rb index fc183b01..5afd2c5c 100644 --- a/lib/line/bot/v2/messaging_api/model/template_message.rb +++ b/lib/line/bot/v2/messaging_api/model/template_message.rb @@ -19,10 +19,10 @@ class TemplateMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] alt_text # @return [String] @@ -31,8 +31,8 @@ class TemplateMessage < Message # @return [Template] attr_accessor :template - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param alt_text [String] # @param template [Template] def initialize( diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb index bd012a05..1115ce6b 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_request.rb @@ -14,10 +14,10 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint class TestWebhookEndpointRequest # @!attribute [rw] endpoint - # @return [String] A webhook URL to be validated. + # @return [String,nil] A webhook URL to be validated. attr_accessor :endpoint - # @param endpoint [String] A webhook URL to be validated. + # @param endpoint [String,nil] A webhook URL to be validated. def initialize( endpoint: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb index de5ce4dc..27429fd1 100644 --- a/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb +++ b/lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb @@ -14,7 +14,7 @@ module MessagingApi # @see https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint class TestWebhookEndpointResponse # @!attribute [rw] success - # @return [Boolean] Result of the communication from the LINE platform to the webhook URL. + # @return [Boolean,nil] Result of the communication from the LINE platform to the webhook URL. attr_accessor :success # @!attribute [rw] timestamp # @return [String] Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. @@ -29,7 +29,7 @@ class TestWebhookEndpointResponse # @return [String] Details of the response. attr_accessor :detail - # @param success [Boolean] Result of the communication from the LINE platform to the webhook URL. + # @param success [Boolean,nil] Result of the communication from the LINE platform to the webhook URL. # @param timestamp [String] Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. # @param status_code [Integer] The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. # @param reason [String] Reason for the response. diff --git a/lib/line/bot/v2/messaging_api/model/text_message.rb b/lib/line/bot/v2/messaging_api/model/text_message.rb index 86c03ca1..282163af 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message.rb @@ -19,26 +19,26 @@ class TextMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] text # @return [String] attr_accessor :text # @!attribute [rw] emojis - # @return [Array[Emoji]] + # @return [Array[Emoji],nil] attr_accessor :emojis # @!attribute [rw] quote_token - # @return [String] Quote token of the message you want to quote. + # @return [String,nil] Quote token of the message you want to quote. attr_accessor :quote_token - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param text [String] - # @param emojis [Array[Emoji]] - # @param quote_token [String] Quote token of the message you want to quote. + # @param emojis [Array[Emoji],nil] + # @param quote_token [String,nil] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb index f6cc38c6..bfa2ce7c 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message_v2.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message_v2.rb @@ -19,26 +19,26 @@ class TextMessageV2 < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] text # @return [String] attr_accessor :text # @!attribute [rw] substitution - # @return [Object] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. + # @return [Object,nil] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. attr_accessor :substitution # @!attribute [rw] quote_token - # @return [String] Quote token of the message you want to quote. + # @return [String,nil] Quote token of the message you want to quote. attr_accessor :quote_token - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param text [String] - # @param substitution [Object] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. - # @param quote_token [String] Quote token of the message you want to quote. + # @param substitution [Object,nil] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. + # @param quote_token [String,nil] Quote token of the message you want to quote. def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/messaging_api/model/uri_action.rb b/lib/line/bot/v2/messaging_api/model/uri_action.rb index 38e648bd..bde13c95 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_action.rb @@ -15,21 +15,21 @@ module V2 module MessagingApi class URIAction < Action # @!attribute [r] type - # @return [String] Type of action + # @return [String,nil] Type of action attr_reader :type # @!attribute [rw] label - # @return [String] Label for the action. + # @return [String,nil] Label for the action. attr_accessor :label # @!attribute [rw] uri - # @return [String] + # @return [String,nil] attr_accessor :uri # @!attribute [rw] alt_uri - # @return [AltUri] + # @return [AltUri,nil] attr_accessor :alt_uri - # @param label [String] Label for the action. - # @param uri [String] - # @param alt_uri [AltUri] + # @param label [String,nil] Label for the action. + # @param uri [String,nil] + # @param alt_uri [AltUri,nil] def initialize( label: nil, uri: nil, diff --git a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb index 38003694..a8a94e75 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_imagemap_action.rb @@ -24,12 +24,12 @@ class URIImagemapAction < ImagemapAction # @return [String] attr_accessor :link_uri # @!attribute [rw] label - # @return [String] + # @return [String,nil] attr_accessor :label # @param area [ImagemapArea] # @param link_uri [String] - # @param label [String] + # @param label [String,nil] def initialize( area:, link_uri:, diff --git a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb index f8c103f9..4610951b 100644 --- a/lib/line/bot/v2/messaging_api/model/user_profile_response.rb +++ b/lib/line/bot/v2/messaging_api/model/user_profile_response.rb @@ -20,20 +20,20 @@ class UserProfileResponse # @return [String] User ID attr_accessor :user_id # @!attribute [rw] picture_url - # @return [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @return [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. attr_accessor :picture_url # @!attribute [rw] status_message - # @return [String] User's status message. Not included in the response if the user doesn't have a status message. + # @return [String,nil] User's status message. Not included in the response if the user doesn't have a status message. attr_accessor :status_message # @!attribute [rw] language - # @return [String] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. + # @return [String,nil] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. attr_accessor :language # @param display_name [String] User's display name # @param user_id [String] User ID - # @param picture_url [String] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. - # @param status_message [String] User's status message. Not included in the response if the user doesn't have a status message. - # @param language [String] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. + # @param picture_url [String,nil] Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image. + # @param status_message [String,nil] User's status message. Not included in the response if the user doesn't have a status message. + # @param language [String,nil] User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. def initialize( display_name:, user_id:, diff --git a/lib/line/bot/v2/messaging_api/model/video_message.rb b/lib/line/bot/v2/messaging_api/model/video_message.rb index 2a24db57..6f9cae61 100644 --- a/lib/line/bot/v2/messaging_api/model/video_message.rb +++ b/lib/line/bot/v2/messaging_api/model/video_message.rb @@ -19,10 +19,10 @@ class VideoMessage < Message # @return [String] Type of message attr_reader :type # @!attribute [rw] quick_reply - # @return [QuickReply] + # @return [QuickReply,nil] attr_accessor :quick_reply # @!attribute [rw] sender - # @return [Sender] + # @return [Sender,nil] attr_accessor :sender # @!attribute [rw] original_content_url # @return [String] @@ -31,14 +31,14 @@ class VideoMessage < Message # @return [String] attr_accessor :preview_image_url # @!attribute [rw] tracking_id - # @return [String] + # @return [String,nil] attr_accessor :tracking_id - # @param quick_reply [QuickReply] - # @param sender [Sender] + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] # @param original_content_url [String] # @param preview_image_url [String] - # @param tracking_id [String] + # @param tracking_id [String,nil] def initialize( quick_reply: nil, sender: nil, diff --git a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb index 46224796..583cb993 100644 --- a/lib/line/bot/v2/module/model/acquire_chat_control_request.rb +++ b/lib/line/bot/v2/module/model/acquire_chat_control_request.rb @@ -15,14 +15,14 @@ module Module # @see https://developers.line.biz/en/reference/partner-docs/#acquire-control-api class AcquireChatControlRequest # @!attribute [rw] expired - # @return [Boolean] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. + # @return [Boolean,nil] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. attr_accessor :expired # @!attribute [rw] ttl - # @return [Integer] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. + # @return [Integer,nil] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. attr_accessor :ttl - # @param expired [Boolean] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. - # @param ttl [Integer] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. + # @param expired [Boolean,nil] `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time. + # @param ttl [Integer,nil] The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. def initialize( expired: nil, ttl: nil, diff --git a/lib/line/bot/v2/module/model/detach_module_request.rb b/lib/line/bot/v2/module/model/detach_module_request.rb index 16284e04..58aee47d 100644 --- a/lib/line/bot/v2/module/model/detach_module_request.rb +++ b/lib/line/bot/v2/module/model/detach_module_request.rb @@ -15,10 +15,10 @@ module Module # @see https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin class DetachModuleRequest # @!attribute [rw] bot_id - # @return [String] User ID of the LINE Official Account bot attached to the module channel. + # @return [String,nil] User ID of the LINE Official Account bot attached to the module channel. attr_accessor :bot_id - # @param bot_id [String] User ID of the LINE Official Account bot attached to the module channel. + # @param bot_id [String,nil] User ID of the LINE Official Account bot attached to the module channel. def initialize( bot_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/module/model/get_modules_response.rb b/lib/line/bot/v2/module/model/get_modules_response.rb index 0f7f539f..8500295e 100644 --- a/lib/line/bot/v2/module/model/get_modules_response.rb +++ b/lib/line/bot/v2/module/model/get_modules_response.rb @@ -18,11 +18,11 @@ class GetModulesResponse # @return [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot. attr_accessor :bots # @!attribute [rw] _next - # @return [String] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. + # @return [String,nil] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. attr_accessor :_next # @param bots [Array[ModuleBot]] Array of Bot list Item objects representing basic information about the bot. - # @param _next [String] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. + # @param _next [String,nil] Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. def initialize( bots:, _next: nil, diff --git a/lib/line/bot/v2/module/model/module_bot.rb b/lib/line/bot/v2/module/model/module_bot.rb index 2dd82c0d..e16da968 100644 --- a/lib/line/bot/v2/module/model/module_bot.rb +++ b/lib/line/bot/v2/module/model/module_bot.rb @@ -21,20 +21,20 @@ class ModuleBot # @return [String] Bot's basic ID attr_accessor :basic_id # @!attribute [rw] premium_id - # @return [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @return [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set. attr_accessor :premium_id # @!attribute [rw] display_name # @return [String] Bot's display name attr_accessor :display_name # @!attribute [rw] picture_url - # @return [String] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. + # @return [String,nil] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. attr_accessor :picture_url # @param user_id [String] Bot's user ID # @param basic_id [String] Bot's basic ID - # @param premium_id [String] Bot's premium ID. Not included in the response if the premium ID isn't set. + # @param premium_id [String,nil] Bot's premium ID. Not included in the response if the premium ID isn't set. # @param display_name [String] Bot's display name - # @param picture_url [String] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. + # @param picture_url [String,nil] Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image. def initialize( user_id:, basic_id:, diff --git a/lib/line/bot/v2/webhook/model/account_link_event.rb b/lib/line/bot/v2/webhook/model/account_link_event.rb index 1f19019e..ffb1bffa 100644 --- a/lib/line/bot/v2/webhook/model/account_link_event.rb +++ b/lib/line/bot/v2/webhook/model/account_link_event.rb @@ -19,7 +19,7 @@ class AccountLinkEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,18 +34,18 @@ class AccountLinkEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context # @!attribute [rw] reply_token - # @return [String] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. + # @return [String,nil] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. attr_accessor :reply_token # @!attribute [rw] link # @return [LinkContent] attr_accessor :link - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. # @param delivery_context [DeliveryContext] - # @param reply_token [String] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. + # @param reply_token [String,nil] Reply token used to send reply message to this event. This property won't be included if linking the account has failed. # @param link [LinkContent] def initialize( source: nil, diff --git a/lib/line/bot/v2/webhook/model/action_result.rb b/lib/line/bot/v2/webhook/model/action_result.rb index a58e1826..e58a5a70 100644 --- a/lib/line/bot/v2/webhook/model/action_result.rb +++ b/lib/line/bot/v2/webhook/model/action_result.rb @@ -16,11 +16,11 @@ class ActionResult # @return [String] ('void'|'binary') attr_accessor :type # @!attribute [rw] data - # @return [String] Base64-encoded binary data + # @return [String,nil] Base64-encoded binary data attr_accessor :data # @param type [String] ('void'|'binary') - # @param data [String] Base64-encoded binary data + # @param data [String,nil] Base64-encoded binary data def initialize( type:, data: nil, diff --git a/lib/line/bot/v2/webhook/model/activated_event.rb b/lib/line/bot/v2/webhook/model/activated_event.rb index 91f2f5ba..ee9fcc34 100644 --- a/lib/line/bot/v2/webhook/model/activated_event.rb +++ b/lib/line/bot/v2/webhook/model/activated_event.rb @@ -19,7 +19,7 @@ class ActivatedEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class ActivatedEvent < Event # @return [ChatControl] attr_accessor :chat_control - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/audio_message_content.rb b/lib/line/bot/v2/webhook/model/audio_message_content.rb index 28def99b..b6b95373 100644 --- a/lib/line/bot/v2/webhook/model/audio_message_content.rb +++ b/lib/line/bot/v2/webhook/model/audio_message_content.rb @@ -24,12 +24,12 @@ class AudioMessageContent < MessageContent # @return [ContentProvider] attr_accessor :content_provider # @!attribute [rw] duration - # @return [Integer] Length of audio file (milliseconds) + # @return [Integer,nil] Length of audio file (milliseconds) attr_accessor :duration # @param id [String] Message ID # @param content_provider [ContentProvider] - # @param duration [Integer] Length of audio file (milliseconds) + # @param duration [Integer,nil] Length of audio file (milliseconds) def initialize( id:, content_provider:, diff --git a/lib/line/bot/v2/webhook/model/beacon_content.rb b/lib/line/bot/v2/webhook/model/beacon_content.rb index ffc3666c..2d1280a5 100644 --- a/lib/line/bot/v2/webhook/model/beacon_content.rb +++ b/lib/line/bot/v2/webhook/model/beacon_content.rb @@ -19,12 +19,12 @@ class BeaconContent # @return [String] ('enter'|'banner'|'stay') Type of beacon event. attr_accessor :type # @!attribute [rw] dm - # @return [String] Device message of beacon that was detected. + # @return [String,nil] Device message of beacon that was detected. attr_accessor :dm # @param hwid [String] Hardware ID of the beacon that was detected # @param type [String] ('enter'|'banner'|'stay') Type of beacon event. - # @param dm [String] Device message of beacon that was detected. + # @param dm [String,nil] Device message of beacon that was detected. def initialize( hwid:, type:, diff --git a/lib/line/bot/v2/webhook/model/beacon_event.rb b/lib/line/bot/v2/webhook/model/beacon_event.rb index 9838d977..72c2438b 100644 --- a/lib/line/bot/v2/webhook/model/beacon_event.rb +++ b/lib/line/bot/v2/webhook/model/beacon_event.rb @@ -19,7 +19,7 @@ class BeaconEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class BeaconEvent < Event # @return [BeaconContent] attr_accessor :beacon - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb index 2e8b1ebd..83b3efc3 100644 --- a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb @@ -19,7 +19,7 @@ class BotResumedEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,7 +34,7 @@ class BotResumedEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb index ac665ea6..bf14f6b8 100644 --- a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb @@ -19,7 +19,7 @@ class BotSuspendedEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,7 +34,7 @@ class BotSuspendedEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/content_provider.rb b/lib/line/bot/v2/webhook/model/content_provider.rb index c395d29f..a295271e 100644 --- a/lib/line/bot/v2/webhook/model/content_provider.rb +++ b/lib/line/bot/v2/webhook/model/content_provider.rb @@ -17,15 +17,15 @@ class ContentProvider # @return [String] ('line'|'external') Provider of the image file. attr_accessor :type # @!attribute [rw] original_content_url - # @return [String] URL of the image file. Only included when contentProvider.type is external. + # @return [String,nil] URL of the image file. Only included when contentProvider.type is external. attr_accessor :original_content_url # @!attribute [rw] preview_image_url - # @return [String] URL of the preview image. Only included when contentProvider.type is external. + # @return [String,nil] URL of the preview image. Only included when contentProvider.type is external. attr_accessor :preview_image_url # @param type [String] ('line'|'external') Provider of the image file. - # @param original_content_url [String] URL of the image file. Only included when contentProvider.type is external. - # @param preview_image_url [String] URL of the preview image. Only included when contentProvider.type is external. + # @param original_content_url [String,nil] URL of the image file. Only included when contentProvider.type is external. + # @param preview_image_url [String,nil] URL of the preview image. Only included when contentProvider.type is external. def initialize( type:, original_content_url: nil, diff --git a/lib/line/bot/v2/webhook/model/deactivated_event.rb b/lib/line/bot/v2/webhook/model/deactivated_event.rb index bea55bad..b832b492 100644 --- a/lib/line/bot/v2/webhook/model/deactivated_event.rb +++ b/lib/line/bot/v2/webhook/model/deactivated_event.rb @@ -19,7 +19,7 @@ class DeactivatedEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,7 +34,7 @@ class DeactivatedEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/event.rb b/lib/line/bot/v2/webhook/model/event.rb index 65454c33..a2b249f9 100644 --- a/lib/line/bot/v2/webhook/model/event.rb +++ b/lib/line/bot/v2/webhook/model/event.rb @@ -17,7 +17,7 @@ class Event # @return [String] Type of the event attr_accessor :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -33,7 +33,7 @@ class Event attr_accessor :delivery_context # @param type [String] Type of the event - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/follow_event.rb b/lib/line/bot/v2/webhook/model/follow_event.rb index 8d63eb47..4b9bca7d 100644 --- a/lib/line/bot/v2/webhook/model/follow_event.rb +++ b/lib/line/bot/v2/webhook/model/follow_event.rb @@ -19,7 +19,7 @@ class FollowEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class FollowEvent < Event # @return [FollowDetail] attr_accessor :follow - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/group_source.rb b/lib/line/bot/v2/webhook/model/group_source.rb index 159f7604..3bea58e1 100644 --- a/lib/line/bot/v2/webhook/model/group_source.rb +++ b/lib/line/bot/v2/webhook/model/group_source.rb @@ -21,11 +21,11 @@ class GroupSource < Source # @return [String] Group ID of the source group chat attr_accessor :group_id # @!attribute [rw] user_id - # @return [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @return [String,nil] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. attr_accessor :user_id # @param group_id [String] Group ID of the source group chat - # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @param user_id [String,nil] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. def initialize( group_id:, user_id: nil, diff --git a/lib/line/bot/v2/webhook/model/image_message_content.rb b/lib/line/bot/v2/webhook/model/image_message_content.rb index 9ff5f192..a1ab0c69 100644 --- a/lib/line/bot/v2/webhook/model/image_message_content.rb +++ b/lib/line/bot/v2/webhook/model/image_message_content.rb @@ -24,7 +24,7 @@ class ImageMessageContent < MessageContent # @return [ContentProvider] attr_accessor :content_provider # @!attribute [rw] image_set - # @return [ImageSet] + # @return [ImageSet,nil] attr_accessor :image_set # @!attribute [rw] quote_token # @return [String] Quote token to quote this message. @@ -32,7 +32,7 @@ class ImageMessageContent < MessageContent # @param id [String] Message ID # @param content_provider [ContentProvider] - # @param image_set [ImageSet] + # @param image_set [ImageSet,nil] # @param quote_token [String] Quote token to quote this message. def initialize( id:, diff --git a/lib/line/bot/v2/webhook/model/image_set.rb b/lib/line/bot/v2/webhook/model/image_set.rb index d7450d2a..40377425 100644 --- a/lib/line/bot/v2/webhook/model/image_set.rb +++ b/lib/line/bot/v2/webhook/model/image_set.rb @@ -16,15 +16,15 @@ class ImageSet # @return [String] Image set ID. Only included when multiple images are sent simultaneously. attr_accessor :id # @!attribute [rw] index - # @return [Integer] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. + # @return [Integer,nil] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. attr_accessor :index # @!attribute [rw] total - # @return [Integer] The total number of images sent simultaneously. + # @return [Integer,nil] The total number of images sent simultaneously. attr_accessor :total # @param id [String] Image set ID. Only included when multiple images are sent simultaneously. - # @param index [Integer] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. - # @param total [Integer] The total number of images sent simultaneously. + # @param index [Integer,nil] An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android. + # @param total [Integer,nil] The total number of images sent simultaneously. def initialize( id:, index: nil, diff --git a/lib/line/bot/v2/webhook/model/join_event.rb b/lib/line/bot/v2/webhook/model/join_event.rb index 049d7c6e..594cde43 100644 --- a/lib/line/bot/v2/webhook/model/join_event.rb +++ b/lib/line/bot/v2/webhook/model/join_event.rb @@ -19,7 +19,7 @@ class JoinEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class JoinEvent < Event # @return [String] Reply token used to send reply message to this event attr_accessor :reply_token - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/leave_event.rb b/lib/line/bot/v2/webhook/model/leave_event.rb index cc7ac6d5..dedaabb4 100644 --- a/lib/line/bot/v2/webhook/model/leave_event.rb +++ b/lib/line/bot/v2/webhook/model/leave_event.rb @@ -19,7 +19,7 @@ class LeaveEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,7 +34,7 @@ class LeaveEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/location_message_content.rb b/lib/line/bot/v2/webhook/model/location_message_content.rb index 14201d60..3cb49954 100644 --- a/lib/line/bot/v2/webhook/model/location_message_content.rb +++ b/lib/line/bot/v2/webhook/model/location_message_content.rb @@ -21,10 +21,10 @@ class LocationMessageContent < MessageContent # @return [String] Message ID attr_accessor :id # @!attribute [rw] title - # @return [String] Title + # @return [String,nil] Title attr_accessor :title # @!attribute [rw] address - # @return [String] Address + # @return [String,nil] Address attr_accessor :address # @!attribute [rw] latitude # @return [Float] Latitude @@ -34,8 +34,8 @@ class LocationMessageContent < MessageContent attr_accessor :longitude # @param id [String] Message ID - # @param title [String] Title - # @param address [String] Address + # @param title [String,nil] Title + # @param address [String,nil] Address # @param latitude [Float] Latitude # @param longitude [Float] Longitude def initialize( diff --git a/lib/line/bot/v2/webhook/model/member_joined_event.rb b/lib/line/bot/v2/webhook/model/member_joined_event.rb index 764027b7..9f5b5a39 100644 --- a/lib/line/bot/v2/webhook/model/member_joined_event.rb +++ b/lib/line/bot/v2/webhook/model/member_joined_event.rb @@ -19,7 +19,7 @@ class MemberJoinedEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class MemberJoinedEvent < Event # @return [JoinedMembers] attr_accessor :joined - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/member_left_event.rb b/lib/line/bot/v2/webhook/model/member_left_event.rb index f50aaab0..1025c5a5 100644 --- a/lib/line/bot/v2/webhook/model/member_left_event.rb +++ b/lib/line/bot/v2/webhook/model/member_left_event.rb @@ -19,7 +19,7 @@ class MemberLeftEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class MemberLeftEvent < Event # @return [LeftMembers] attr_accessor :left - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/membership_event.rb b/lib/line/bot/v2/webhook/model/membership_event.rb index 5b7f6943..e41429c8 100644 --- a/lib/line/bot/v2/webhook/model/membership_event.rb +++ b/lib/line/bot/v2/webhook/model/membership_event.rb @@ -19,7 +19,7 @@ class MembershipEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class MembershipEvent < Event # @return [MembershipContent] attr_accessor :membership - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/message_event.rb b/lib/line/bot/v2/webhook/model/message_event.rb index 25e11f84..e970bf13 100644 --- a/lib/line/bot/v2/webhook/model/message_event.rb +++ b/lib/line/bot/v2/webhook/model/message_event.rb @@ -19,7 +19,7 @@ class MessageEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,18 +34,18 @@ class MessageEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context # @!attribute [rw] reply_token - # @return [String] + # @return [String,nil] attr_accessor :reply_token # @!attribute [rw] message # @return [MessageContent] attr_accessor :message - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. # @param delivery_context [DeliveryContext] - # @param reply_token [String] + # @param reply_token [String,nil] # @param message [MessageContent] def initialize( source: nil, diff --git a/lib/line/bot/v2/webhook/model/module_event.rb b/lib/line/bot/v2/webhook/model/module_event.rb index 4108c61c..2b4b762b 100644 --- a/lib/line/bot/v2/webhook/model/module_event.rb +++ b/lib/line/bot/v2/webhook/model/module_event.rb @@ -19,7 +19,7 @@ class ModuleEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class ModuleEvent < Event # @return [ModuleContent] attr_accessor :_module - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb index b1dd5b6d..bf7f26e5 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb @@ -19,7 +19,7 @@ class PnpDeliveryCompletionEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class PnpDeliveryCompletionEvent < Event # @return [PnpDelivery] attr_accessor :delivery - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/postback_content.rb b/lib/line/bot/v2/webhook/model/postback_content.rb index e966ac27..1b410aa8 100644 --- a/lib/line/bot/v2/webhook/model/postback_content.rb +++ b/lib/line/bot/v2/webhook/model/postback_content.rb @@ -16,11 +16,11 @@ class PostbackContent # @return [String] Postback data attr_accessor :data # @!attribute [rw] params - # @return [Object] + # @return [Object,nil] attr_accessor :params # @param data [String] Postback data - # @param params [Object] + # @param params [Object,nil] def initialize( data:, params: nil, diff --git a/lib/line/bot/v2/webhook/model/postback_event.rb b/lib/line/bot/v2/webhook/model/postback_event.rb index a5cf7871..0ef2d006 100644 --- a/lib/line/bot/v2/webhook/model/postback_event.rb +++ b/lib/line/bot/v2/webhook/model/postback_event.rb @@ -19,7 +19,7 @@ class PostbackEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,18 +34,18 @@ class PostbackEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context # @!attribute [rw] reply_token - # @return [String] Reply token used to send reply message to this event + # @return [String,nil] Reply token used to send reply message to this event attr_accessor :reply_token # @!attribute [rw] postback # @return [PostbackContent] attr_accessor :postback - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. # @param delivery_context [DeliveryContext] - # @param reply_token [String] Reply token used to send reply message to this event + # @param reply_token [String,nil] Reply token used to send reply message to this event # @param postback [PostbackContent] def initialize( source: nil, diff --git a/lib/line/bot/v2/webhook/model/room_source.rb b/lib/line/bot/v2/webhook/model/room_source.rb index 8ec37efb..bf9e06b9 100644 --- a/lib/line/bot/v2/webhook/model/room_source.rb +++ b/lib/line/bot/v2/webhook/model/room_source.rb @@ -18,13 +18,13 @@ class RoomSource < Source # @return [String] source type attr_reader :type # @!attribute [rw] user_id - # @return [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @return [String,nil] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. attr_accessor :user_id # @!attribute [rw] room_id # @return [String] Room ID of the source multi-person chat attr_accessor :room_id - # @param user_id [String] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. + # @param user_id [String,nil] ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId. # @param room_id [String] Room ID of the source multi-person chat def initialize( user_id: nil, diff --git a/lib/line/bot/v2/webhook/model/scenario_result.rb b/lib/line/bot/v2/webhook/model/scenario_result.rb index a197aa51..b49eef09 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result.rb @@ -14,10 +14,10 @@ module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#scenario-result-event class ScenarioResult # @!attribute [rw] scenario_id - # @return [String] Scenario ID executed + # @return [String,nil] Scenario ID executed attr_accessor :scenario_id # @!attribute [rw] revision - # @return [Integer] Revision number of the scenario set containing the executed scenario + # @return [Integer,nil] Revision number of the scenario set containing the executed scenario attr_accessor :revision # @!attribute [rw] start_time # @return [Integer] Timestamp for when execution of scenario action started (milliseconds, LINE app time) @@ -29,23 +29,23 @@ class ScenarioResult # @return [String] Scenario execution completion status attr_accessor :result_code # @!attribute [rw] action_results - # @return [Array[ActionResult]] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. + # @return [Array[ActionResult],nil] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. attr_accessor :action_results # @!attribute [rw] ble_notification_payload - # @return [String] Data contained in notification. + # @return [String,nil] Data contained in notification. attr_accessor :ble_notification_payload # @!attribute [rw] error_reason - # @return [String] Error reason. + # @return [String,nil] Error reason. attr_accessor :error_reason - # @param scenario_id [String] Scenario ID executed - # @param revision [Integer] Revision number of the scenario set containing the executed scenario + # @param scenario_id [String,nil] Scenario ID executed + # @param revision [Integer,nil] Revision number of the scenario set containing the executed scenario # @param start_time [Integer] Timestamp for when execution of scenario action started (milliseconds, LINE app time) # @param end_time [Integer] Timestamp for when execution of scenario was completed (milliseconds, LINE app time) # @param result_code [String] Scenario execution completion status - # @param action_results [Array[ActionResult]] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. - # @param ble_notification_payload [String] Data contained in notification. - # @param error_reason [String] Error reason. + # @param action_results [Array[ActionResult],nil] Execution result of individual operations specified in action. Only included when things.result.resultCode is success. + # @param ble_notification_payload [String,nil] Data contained in notification. + # @param error_reason [String,nil] Error reason. def initialize( scenario_id: nil, revision: nil, diff --git a/lib/line/bot/v2/webhook/model/source.rb b/lib/line/bot/v2/webhook/model/source.rb index aa150fe1..d12cd68a 100644 --- a/lib/line/bot/v2/webhook/model/source.rb +++ b/lib/line/bot/v2/webhook/model/source.rb @@ -15,10 +15,10 @@ module Webhook # @see https://developers.line.biz/en/reference/messaging-api/#source-user class Source # @!attribute [rw] type - # @return [String] source type + # @return [String,nil] source type attr_accessor :type - # @param type [String] source type + # @param type [String,nil] source type def initialize( type: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/sticker_message_content.rb b/lib/line/bot/v2/webhook/model/sticker_message_content.rb index e74c3700..4f1ce8d7 100644 --- a/lib/line/bot/v2/webhook/model/sticker_message_content.rb +++ b/lib/line/bot/v2/webhook/model/sticker_message_content.rb @@ -31,26 +31,26 @@ class StickerMessageContent < MessageContent # @return [String] ('STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT') attr_accessor :sticker_resource_type # @!attribute [rw] keywords - # @return [Array[String]] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. + # @return [Array[String],nil] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. attr_accessor :keywords # @!attribute [rw] text - # @return [String] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 + # @return [String,nil] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 attr_accessor :text # @!attribute [rw] quote_token # @return [String] Quote token to quote this message. attr_accessor :quote_token # @!attribute [rw] quoted_message_id - # @return [String] Message ID of a quoted message. Only included when the received message quotes a past message. + # @return [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message. attr_accessor :quoted_message_id # @param id [String] Message ID # @param package_id [String] Package ID # @param sticker_id [String] Sticker ID # @param sticker_resource_type [String] ('STATIC'|'ANIMATION'|'SOUND'|'ANIMATION_SOUND'|'POPUP'|'POPUP_SOUND'|'CUSTOM'|'MESSAGE'|'NAME_TEXT'|'PER_STICKER_TEXT') - # @param keywords [Array[String]] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. - # @param text [String] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 + # @param keywords [Array[String],nil] Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. + # @param text [String,nil] Any text entered by the user. This property is only included for message stickers. Max character limit: 100 # @param quote_token [String] Quote token to quote this message. - # @param quoted_message_id [String] Message ID of a quoted message. Only included when the received message quotes a past message. + # @param quoted_message_id [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message. def initialize( id:, package_id:, diff --git a/lib/line/bot/v2/webhook/model/text_message_content.rb b/lib/line/bot/v2/webhook/model/text_message_content.rb index 65c00517..a85485b5 100644 --- a/lib/line/bot/v2/webhook/model/text_message_content.rb +++ b/lib/line/bot/v2/webhook/model/text_message_content.rb @@ -24,24 +24,24 @@ class TextMessageContent < MessageContent # @return [String] Message text. attr_accessor :text # @!attribute [rw] emojis - # @return [Array[Emoji]] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. + # @return [Array[Emoji],nil] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. attr_accessor :emojis # @!attribute [rw] mention - # @return [Mention] + # @return [Mention,nil] attr_accessor :mention # @!attribute [rw] quote_token # @return [String] Quote token to quote this message. attr_accessor :quote_token # @!attribute [rw] quoted_message_id - # @return [String] Message ID of a quoted message. Only included when the received message quotes a past message. + # @return [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message. attr_accessor :quoted_message_id # @param id [String] Message ID # @param text [String] Message text. - # @param emojis [Array[Emoji]] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. - # @param mention [Mention] + # @param emojis [Array[Emoji],nil] Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji. + # @param mention [Mention,nil] # @param quote_token [String] Quote token to quote this message. - # @param quoted_message_id [String] Message ID of a quoted message. Only included when the received message quotes a past message. + # @param quoted_message_id [String,nil] Message ID of a quoted message. Only included when the received message quotes a past message. def initialize( id:, text:, diff --git a/lib/line/bot/v2/webhook/model/things_event.rb b/lib/line/bot/v2/webhook/model/things_event.rb index 4e732e11..1b1b06f7 100644 --- a/lib/line/bot/v2/webhook/model/things_event.rb +++ b/lib/line/bot/v2/webhook/model/things_event.rb @@ -19,7 +19,7 @@ class ThingsEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class ThingsEvent < Event # @return [ThingsContent] attr_accessor :things - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/unfollow_event.rb b/lib/line/bot/v2/webhook/model/unfollow_event.rb index 269f2cce..ea163e47 100644 --- a/lib/line/bot/v2/webhook/model/unfollow_event.rb +++ b/lib/line/bot/v2/webhook/model/unfollow_event.rb @@ -19,7 +19,7 @@ class UnfollowEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -34,7 +34,7 @@ class UnfollowEvent < Event # @return [DeliveryContext] attr_accessor :delivery_context - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/unsend_event.rb b/lib/line/bot/v2/webhook/model/unsend_event.rb index 97230489..93096e63 100644 --- a/lib/line/bot/v2/webhook/model/unsend_event.rb +++ b/lib/line/bot/v2/webhook/model/unsend_event.rb @@ -19,7 +19,7 @@ class UnsendEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -37,7 +37,7 @@ class UnsendEvent < Event # @return [UnsendDetail] attr_accessor :unsend - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format. diff --git a/lib/line/bot/v2/webhook/model/user_mentionee.rb b/lib/line/bot/v2/webhook/model/user_mentionee.rb index cfb221eb..07fe39db 100644 --- a/lib/line/bot/v2/webhook/model/user_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/user_mentionee.rb @@ -25,16 +25,16 @@ class UserMentionee < Mentionee # @return [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. attr_accessor :length # @!attribute [rw] user_id - # @return [String] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. + # @return [String,nil] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. attr_accessor :user_id # @!attribute [rw] is_self - # @return [Boolean] Whether the mentioned user is the bot that receives the webhook. + # @return [Boolean,nil] Whether the mentioned user is the bot that receives the webhook. attr_accessor :is_self # @param index [Integer] Index position of the user mention for a character in text, with the first character being at position 0. # @param length [Integer] The length of the text of the mentioned user. For a mention @example, 8 is the length. - # @param user_id [String] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. - # @param is_self [Boolean] Whether the mentioned user is the bot that receives the webhook. + # @param user_id [String,nil] User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information. + # @param is_self [Boolean,nil] Whether the mentioned user is the bot that receives the webhook. def initialize( index:, length:, diff --git a/lib/line/bot/v2/webhook/model/user_source.rb b/lib/line/bot/v2/webhook/model/user_source.rb index 74eac535..df3bcc71 100644 --- a/lib/line/bot/v2/webhook/model/user_source.rb +++ b/lib/line/bot/v2/webhook/model/user_source.rb @@ -18,10 +18,10 @@ class UserSource < Source # @return [String] source type attr_reader :type # @!attribute [rw] user_id - # @return [String] ID of the source user + # @return [String,nil] ID of the source user attr_accessor :user_id - # @param user_id [String] ID of the source user + # @param user_id [String,nil] ID of the source user def initialize( user_id: nil, **dynamic_attributes diff --git a/lib/line/bot/v2/webhook/model/video_message_content.rb b/lib/line/bot/v2/webhook/model/video_message_content.rb index deb08a76..eba06ed7 100644 --- a/lib/line/bot/v2/webhook/model/video_message_content.rb +++ b/lib/line/bot/v2/webhook/model/video_message_content.rb @@ -21,7 +21,7 @@ class VideoMessageContent < MessageContent # @return [String] Message ID attr_accessor :id # @!attribute [rw] duration - # @return [Integer] Length of video file (milliseconds) + # @return [Integer,nil] Length of video file (milliseconds) attr_accessor :duration # @!attribute [rw] content_provider # @return [ContentProvider] @@ -31,7 +31,7 @@ class VideoMessageContent < MessageContent attr_accessor :quote_token # @param id [String] Message ID - # @param duration [Integer] Length of video file (milliseconds) + # @param duration [Integer,nil] Length of video file (milliseconds) # @param content_provider [ContentProvider] # @param quote_token [String] Quote token to quote this message. def initialize( diff --git a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb index 89e68150..7a9b4a16 100644 --- a/lib/line/bot/v2/webhook/model/video_play_complete_event.rb +++ b/lib/line/bot/v2/webhook/model/video_play_complete_event.rb @@ -19,7 +19,7 @@ class VideoPlayCompleteEvent < Event # @return [String] Type of the event attr_reader :type # @!attribute [rw] source - # @return [Source] + # @return [Source,nil] attr_accessor :source # @!attribute [rw] timestamp # @return [Integer] Time of the event in milliseconds. @@ -40,7 +40,7 @@ class VideoPlayCompleteEvent < Event # @return [VideoPlayComplete] attr_accessor :video_play_complete - # @param source [Source] + # @param source [Source,nil] # @param timestamp [Integer] Time of the event in milliseconds. # @param mode [String] ('active'|'standby') # @param webhook_event_id [String] Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.