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..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 @@ -21,10 +21,50 @@ 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}]" }}{% 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]' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} + {% endif -%} + {% elseif variable.isModel -%} + # @return [{{ variable.openApiType }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} + {% else -%} + {% if variable.allowableValues != null -%} + # @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' }}{% 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 }} {%- 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}]" }}{% 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 -%}]{% if not variable.required %},nil{% endif -%}] {{ variable.description }} + {% else -%} + # @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 }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }} + {% else -%} + {% if variable.allowableValues != null -%} + # @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' }}{% if not variable.required %},nil{% endif -%}] {{ 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 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..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,8 +14,11 @@ 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( 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..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 @@ -13,9 +13,15 @@ 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,nil] Error summary + attr_accessor :error + # @!attribute [rw] error_description + # @return [String,nil] Details of the error. Not returned in certain situations. + attr_accessor :error_description + # @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/issue_channel_access_token_response.rb b/lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb index 05decf2f..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,11 +14,23 @@ 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 + # @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..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,10 +14,19 @@ 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. + # @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..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,10 +14,19 @@ 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 + # @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..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 @@ -13,10 +13,19 @@ 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,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,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 5090ca4d..31659021 100644 --- a/lib/line/bot/v2/insight/model/age_tile.rb +++ b/lib/line/bot/v2/insight/model/age_tile.rb @@ -12,9 +12,15 @@ module Bot module V2 module Insight class AgeTile - attr_accessor :age # users' age - attr_accessor :percentage # Percentage + # @!attribute [rw] 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,nil] Percentage + attr_accessor :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 34346f6f..72191c26 100644 --- a/lib/line/bot/v2/insight/model/app_type_tile.rb +++ b/lib/line/bot/v2/insight/model/app_type_tile.rb @@ -12,9 +12,15 @@ module Bot module V2 module Insight class AppTypeTile - attr_accessor :app_type # users' OS - attr_accessor :percentage # Percentage + # @!attribute [rw] app_type + # @return [String,nil] ('ios'|'android'|'others') users' OS + attr_accessor :app_type + # @!attribute [rw] percentage + # @return [Float,nil] Percentage + attr_accessor :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 a53954ec..34a8a4d4 100644 --- a/lib/line/bot/v2/insight/model/area_tile.rb +++ b/lib/line/bot/v2/insight/model/area_tile.rb @@ -12,9 +12,15 @@ module Bot module V2 module Insight class AreaTile - attr_accessor :area # users' country and region - attr_accessor :percentage # Percentage + # @!attribute [rw] area + # @return [String,nil] users' country and region + attr_accessor :area + # @!attribute [rw] percentage + # @return [Float,nil] Percentage + attr_accessor :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 368eb5eb..59558939 100644 --- a/lib/line/bot/v2/insight/model/error_detail.rb +++ b/lib/line/bot/v2/insight/model/error_detail.rb @@ -12,9 +12,15 @@ 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,nil] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @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,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 97990fc5..ef174c7c 100644 --- a/lib/line/bot/v2/insight/model/error_response.rb +++ b/lib/line/bot/v2/insight/model/error_response.rb @@ -13,9 +13,15 @@ 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],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],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 2971ed1d..b3984259 100644 --- a/lib/line/bot/v2/insight/model/gender_tile.rb +++ b/lib/line/bot/v2/insight/model/gender_tile.rb @@ -12,9 +12,15 @@ module Bot module V2 module Insight class GenderTile - attr_accessor :gender # users' gender - attr_accessor :percentage # Percentage + # @!attribute [rw] gender + # @return [String,nil] ('male'|'female'|'unknown') users' gender + attr_accessor :gender + # @!attribute [rw] percentage + # @return [Float,nil] Percentage + attr_accessor :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 2c03e3b1..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 @@ -14,13 +14,31 @@ 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,nil] true if friend demographic information is available. + attr_accessor :available + # @!attribute [rw] genders + # @return [Array[GenderTile],nil] Percentage per gender. + attr_accessor :genders + # @!attribute [rw] ages + # @return [Array[AgeTile],nil] Percentage per age group. + attr_accessor :ages + # @!attribute [rw] areas + # @return [Array[AreaTile],nil] Percentage per area. + attr_accessor :areas + # @!attribute [rw] app_types + # @return [Array[AppTypeTile],nil] Percentage by OS. + attr_accessor :app_types + # @!attribute [rw] subscription_periods + # @return [Array[SubscriptionPeriodTile],nil] Percentage per friendship duration. + attr_accessor :subscription_periods + # @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 624a6dde..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 @@ -14,10 +14,19 @@ 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,nil] 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],nil] Array of information about individual message bubbles. + attr_accessor :messages + # @!attribute [rw] clicks + # @return [Array[GetMessageEventResponseClick],nil] Array of information about opened URLs in the message. + attr_accessor :clicks + # @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 179388aa..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 @@ -12,12 +12,27 @@ 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,nil] The URL's serial number. + attr_accessor :seq + # @!attribute [rw] url + # @return [String,nil] URL. + attr_accessor :url + # @!attribute [rw] click + # @return [Integer,nil] Number of times the URL was opened. + attr_accessor :click + # @!attribute [rw] unique_click + # @return [Integer,nil] Number of users that opened the URL. + attr_accessor :unique_click + # @!attribute [rw] unique_click_of_request + # @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,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 7f18599b..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 @@ -12,19 +12,55 @@ 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,nil] Bubble's serial number. + attr_accessor :seq + # @!attribute [rw] impression + # @return [Integer,nil] Number of times the bubble was displayed. + attr_accessor :impression + # @!attribute [rw] media_played + # @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,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,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,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,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,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,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,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,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,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,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 1518bed5..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 @@ -13,14 +13,35 @@ 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,nil] Request ID. + attr_accessor :request_id + # @!attribute [rw] timestamp + # @return [Integer,nil] UNIX timestamp for message delivery time in seconds. + attr_accessor :timestamp + # @!attribute [rw] delivered + # @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,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,nil] Number of users who opened any URL in the message. + attr_accessor :unique_click + # @!attribute [rw] unique_media_played + # @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,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,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 1551e538..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 @@ -14,11 +14,23 @@ 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,nil] ('ready'|'unready'|'out_of_service') Calculation status. + attr_accessor :status + # @!attribute [rw] followers + # @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,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,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,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 bc541051..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 @@ -14,18 +14,51 @@ 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,nil] ('ready'|'unready'|'out_of_service') Status of the counting process. + attr_accessor :status + # @!attribute [rw] broadcast + # @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,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,nil] Number of auto-response messages sent. + attr_accessor :auto_response + # @!attribute [rw] welcome_response + # @return [Integer,nil] Number of greeting messages sent. + attr_accessor :welcome_response + # @!attribute [rw] chat + # @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,nil] Number of broadcast messages sent with the `Send broadcast message` Messaging API operation. + attr_accessor :api_broadcast + # @!attribute [rw] api_push + # @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,nil] Number of multicast messages sent with the `Send multicast message` Messaging API operation. + attr_accessor :api_multicast + # @!attribute [rw] api_narrowcast + # @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,nil] Number of replies sent with the `Send reply message` Messaging API operation. + attr_accessor :api_reply + # @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.rb b/lib/line/bot/v2/insight/model/get_statistics_per_unit_response.rb index 458b79d6..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,10 +14,19 @@ 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. + # @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..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 @@ -13,12 +13,27 @@ 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,nil] Number of times the URL in the bubble was opened. + attr_accessor :click + # @!attribute [rw] unique_click + # @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,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,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 d7e414d7..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 @@ -13,20 +13,59 @@ 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,nil] Number of times the bubble was displayed. + attr_accessor :impression + # @!attribute [rw] media_played + # @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,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,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,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,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,nil] Number of users the bubble was displayed. + attr_accessor :unique_impression + # @!attribute [rw] unique_media_played + # @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,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,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,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,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,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 bbf890e1..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 @@ -14,11 +14,23 @@ 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,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,nil] Number of users who opened any URL in the message. + attr_accessor :unique_click + # @!attribute [rw] unique_media_played + # @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,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,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 9577ef97..44dd5fe7 100644 --- a/lib/line/bot/v2/insight/model/subscription_period_tile.rb +++ b/lib/line/bot/v2/insight/model/subscription_period_tile.rb @@ -12,9 +12,15 @@ 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,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,nil] Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. + attr_accessor :percentage + # @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 cab4783c..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 @@ -13,13 +13,31 @@ 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,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,nil] 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,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,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt + # @param view [LiffView] + # @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/add_liff_app_response.rb b/lib/line/bot/v2/liff/model/add_liff_app_response.rb index 073953fd..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,8 +12,11 @@ module Bot module V2 module Liff class AddLiffAppResponse + # @!attribute [rw] liff_id + # @return [String] 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..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 @@ -12,8 +12,11 @@ module Bot module V2 module Liff class GetAllLiffAppsResponse + # @!attribute [rw] apps + # @return [Array[LiffApp],nil] attr_accessor :apps + # @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 7e70b529..ad7104de 100644 --- a/lib/line/bot/v2/liff/model/liff_app.rb +++ b/lib/line/bot/v2/liff/model/liff_app.rb @@ -12,14 +12,35 @@ module Bot module V2 module Liff class LiffApp - attr_accessor :liff_id # LIFF app ID + # @!attribute [rw] liff_id + # @return [String,nil] LIFF app ID + attr_accessor :liff_id + # @!attribute [rw] view + # @return [LiffView,nil] attr_accessor :view - attr_accessor :description # Name of the LIFF app + # @!attribute [rw] description + # @return [String,nil] Name of the LIFF app + attr_accessor :description + # @!attribute [rw] features + # @return [LiffFeatures,nil] 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,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,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt + # @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 4de048d3..d51c6121 100644 --- a/lib/line/bot/v2/liff/model/liff_features.rb +++ b/lib/line/bot/v2/liff/model/liff_features.rb @@ -12,9 +12,15 @@ 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,nil] `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise. + attr_accessor :ble + # @!attribute [rw] qr_code + # @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,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 8419009d..7a4d4c4a 100644 --- a/lib/line/bot/v2/liff/model/liff_view.rb +++ b/lib/line/bot/v2/liff/model/liff_view.rb @@ -13,10 +13,19 @@ 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,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,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 5b037e14..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 @@ -13,13 +13,31 @@ module V2 module Liff # @see https://developers.line.biz/en/reference/liff-server/#add-liff-app class UpdateLiffAppRequest + # @!attribute [rw] view + # @return [UpdateLiffView,nil] 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,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,nil] 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,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,nil] ('normal'|'aggressive'|'none') attr_accessor :bot_prompt + # @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 50352554..75b8ec0d 100644 --- a/lib/line/bot/v2/liff/model/update_liff_view.rb +++ b/lib/line/bot/v2/liff/model/update_liff_view.rb @@ -13,10 +13,19 @@ 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,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,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,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,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 1979e752..37c681d2 100644 --- a/lib/line/bot/v2/manage_audience/model/adaccount.rb +++ b/lib/line/bot/v2/manage_audience/model/adaccount.rb @@ -13,8 +13,11 @@ module V2 module ManageAudience # Adaccount class Adaccount - attr_accessor :name # Ad account name. + # @!attribute [rw] name + # @return [String,nil] Ad account name. + attr_accessor :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 739bae9e..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 @@ -14,10 +14,19 @@ 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,nil] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] upload_description + # @return [String,nil] The audience's name. + attr_accessor :upload_description + # @!attribute [rw] audiences + # @return [Array[Audience],nil] An array of up to 10,000 user IDs or IFAs. + attr_accessor :audiences + # @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 4223e76b..623e9367 100644 --- a/lib/line/bot/v2/manage_audience/model/audience.rb +++ b/lib/line/bot/v2/manage_audience/model/audience.rb @@ -13,8 +13,11 @@ 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,nil] A user ID or IFA. You can specify an empty array. + attr_accessor :id + # @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 267946fa..f959e023 100644 --- a/lib/line/bot/v2/manage_audience/model/audience_group.rb +++ b/lib/line/bot/v2/manage_audience/model/audience_group.rb @@ -13,19 +13,55 @@ module V2 module ManageAudience # Audience group class AudienceGroup - attr_accessor :audience_group_id # The audience ID. + # @!attribute [rw] audience_group_id + # @return [Integer,nil] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @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 - attr_accessor :description # The audience's name. + # @!attribute [rw] description + # @return [String,nil] The audience's name. + attr_accessor :description + # @!attribute [rw] status + # @return [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING') attr_accessor :status + # @!attribute [rw] failed_type + # @return [String,nil] ('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,nil] The number of users included in the audience. + attr_accessor :audience_count + # @!attribute [rw] created + # @return [Integer,nil] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @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,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,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,nil] ('READ'|'READ_WRITE') attr_accessor :permission + # @!attribute [rw] create_route + # @return [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER') attr_accessor :create_route + # @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 854bfc3a..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 @@ -14,15 +14,39 @@ 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,nil] A job ID. + attr_accessor :audience_group_job_id + # @!attribute [rw] audience_group_id + # @return [Integer,nil] An audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] description + # @return [String,nil] The job's description. + attr_accessor :description + # @!attribute [rw] type + # @return [String,nil] ('DIFF_ADD') attr_accessor :type + # @!attribute [rw] job_status + # @return [String,nil] ('QUEUED'|'WORKING'|'FINISHED'|'FAILED') attr_accessor :job_status + # @!attribute [rw] failed_type + # @return [String,nil] ('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,nil] The number of accounts (recipients) that were added or removed. + attr_accessor :audience_count + # @!attribute [rw] created + # @return [Integer,nil] When the job was created (in UNIX time). + attr_accessor :created + # @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 cb98331a..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 @@ -14,11 +14,23 @@ 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,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,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,nil] The description to register for the job (in jobs[].description). + attr_accessor :upload_description + # @!attribute [rw] audiences + # @return [Array[Audience],nil] An array of user IDs or IFAs. Max number: 10,000 + attr_accessor :audiences + # @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 485bc5d5..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 @@ -14,15 +14,39 @@ 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,nil] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] create_route + # @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,nil] ('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,nil] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer,nil] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] permission + # @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,nil] Time of audience expiration. Only returned for specific audiences. + attr_accessor :expire_timestamp + # @!attribute [rw] is_ifa_audience + # @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,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 1d94cd83..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 @@ -14,10 +14,19 @@ 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,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,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,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,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 b2e04593..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 @@ -14,17 +14,47 @@ 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,nil] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @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 - 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,nil] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer,nil] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @return [String,nil] The request ID that was specified when the audience was created. + attr_accessor :request_id + # @!attribute [rw] click_url + # @return [String,nil] The URL that was specified when the audience was created. + attr_accessor :click_url + # @!attribute [rw] create_route + # @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,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,nil] Time of audience expiration. Only returned for specific audiences. + attr_accessor :expire_timestamp + # @!attribute [rw] is_ifa_audience + # @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,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 9c5a5429..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 @@ -14,9 +14,15 @@ 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,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,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,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 a4373da9..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 @@ -14,12 +14,27 @@ 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,nil] The audience ID. + attr_accessor :audience_group_id + # @!attribute [rw] type + # @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 - 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,nil] The audience's name. + attr_accessor :description + # @!attribute [rw] created + # @return [Integer,nil] When the audience was created (in UNIX time). + attr_accessor :created + # @!attribute [rw] request_id + # @return [String,nil] The request ID that was specified when the audience was created. + attr_accessor :request_id + # @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 09a7ce31..79aeb423 100644 --- a/lib/line/bot/v2/manage_audience/model/detailed_owner.rb +++ b/lib/line/bot/v2/manage_audience/model/detailed_owner.rb @@ -13,10 +13,19 @@ 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,nil] Service name where the audience group has been created. + attr_accessor :service_type + # @!attribute [rw] id + # @return [String,nil] Owner ID in the service. + attr_accessor :id + # @!attribute [rw] name + # @return [String,nil] Owner account name. + attr_accessor :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 bdd0ee97..4102c50c 100644 --- a/lib/line/bot/v2/manage_audience/model/error_detail.rb +++ b/lib/line/bot/v2/manage_audience/model/error_detail.rb @@ -12,9 +12,15 @@ 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,nil] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @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,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 8397df9d..0237ce5f 100644 --- a/lib/line/bot/v2/manage_audience/model/error_response.rb +++ b/lib/line/bot/v2/manage_audience/model/error_response.rb @@ -13,9 +13,15 @@ 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],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],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 018753a5..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 @@ -14,10 +14,19 @@ 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,nil] 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],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,nil] attr_accessor :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 e814e0b5..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 @@ -14,8 +14,11 @@ 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,nil] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level + # @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 c8c70a99..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 @@ -14,13 +14,31 @@ 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],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,nil] true when this is not the last page. + attr_accessor :has_next_page + # @!attribute [rw] total_count + # @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,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,nil] The current page number. + attr_accessor :page + # @!attribute [rw] size + # @return [Integer,nil] The maximum number of audiences on the current page. + attr_accessor :size + # @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 f154a547..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 @@ -14,10 +14,19 @@ 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,nil] 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],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,nil] attr_accessor :owner + # @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 a9dc8891..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 @@ -14,13 +14,31 @@ 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],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,nil] true when this is not the last page. + attr_accessor :has_next_page + # @!attribute [rw] total_count + # @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,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,nil] The current page number. + attr_accessor :page + # @!attribute [rw] size + # @return [Integer,nil] The maximum number of audiences on the current page. + attr_accessor :size + # @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 07573268..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 @@ -14,8 +14,11 @@ 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,nil] ('PUBLIC'|'PRIVATE') attr_accessor :authority_level + # @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 1cd60a96..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 @@ -14,8 +14,11 @@ 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,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,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 3fc20fab..a7086318 100644 --- a/lib/line/bot/v2/messaging_api/model/action.rb +++ b/lib/line/bot/v2/messaging_api/model/action.rb @@ -14,9 +14,15 @@ 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,nil] Type of action + attr_accessor :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @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 73e36b8a..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 @@ -14,10 +14,18 @@ module Bot module V2 module MessagingApi class AgeDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String,nil] Type of demographic filter + attr_reader :type + # @!attribute [rw] gte + # @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,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,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/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 c7f0f38c..c19d9ba3 100644 --- a/lib/line/bot/v2/messaging_api/model/alt_uri.rb +++ b/lib/line/bot/v2/messaging_api/model/alt_uri.rb @@ -12,8 +12,11 @@ module Bot module V2 module MessagingApi class AltUri + # @!attribute [rw] desktop + # @return [String,nil] attr_accessor :desktop + # @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 032eccf9..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 @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class AppTypeDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @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'],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 7e91c986..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 @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class AreaDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @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'],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 eebf16b6..8b9e0d81 100644 --- a/lib/line/bot/v2/messaging_api/model/audience_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/audience_recipient.rb @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class AudienceRecipient < Recipient - attr_reader :type # Type of recipient + # @!attribute [r] type + # @return [String,nil] Type of recipient + attr_reader :type + # @!attribute [rw] audience_group_id + # @return [Integer,nil] attr_accessor :audience_group_id + # @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 08b94249..13d3030f 100644 --- a/lib/line/bot/v2/messaging_api/model/audio_message.rb +++ b/lib/line/bot/v2/messaging_api/model/audio_message.rb @@ -15,12 +15,26 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] + # @param sender [Sender,nil] + # @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..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 @@ -13,14 +13,35 @@ 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,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,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\". + 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 + # @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,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( 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..aee4640b 100644 --- a/lib/line/bot/v2/messaging_api/model/broadcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/broadcast_request.rb @@ -13,9 +13,15 @@ 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,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,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 357941cd..5bf81d64 100644 --- a/lib/line/bot/v2/messaging_api/model/buttons_template.rb +++ b/lib/line/bot/v2/messaging_api/model/buttons_template.rb @@ -14,16 +14,42 @@ module Bot module V2 module MessagingApi class ButtonsTemplate < Template + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] thumbnail_image_url + # @return [String,nil] attr_accessor :thumbnail_image_url + # @!attribute [rw] image_aspect_ratio + # @return [String,nil] attr_accessor :image_aspect_ratio + # @!attribute [rw] image_size + # @return [String,nil] attr_accessor :image_size + # @!attribute [rw] image_background_color + # @return [String,nil] attr_accessor :image_background_color + # @!attribute [rw] title + # @return [String,nil] attr_accessor :title + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] default_action + # @return [Action,nil] attr_accessor :default_action + # @!attribute [rw] actions + # @return [Array[Action]] attr_accessor :actions + # @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,nil] + # @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..b4a63923 100644 --- a/lib/line/bot/v2/messaging_api/model/camera_action.rb +++ b/lib/line/bot/v2/messaging_api/model/camera_action.rb @@ -14,9 +14,14 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @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 e3153258..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 @@ -14,9 +14,14 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @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 84347659..4d71fa88 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_column.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_column.rb @@ -13,13 +13,31 @@ module V2 module MessagingApi # Column object for carousel template. class CarouselColumn + # @!attribute [rw] thumbnail_image_url + # @return [String,nil] attr_accessor :thumbnail_image_url + # @!attribute [rw] image_background_color + # @return [String,nil] attr_accessor :image_background_color + # @!attribute [rw] title + # @return [String,nil] attr_accessor :title + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] default_action + # @return [Action,nil] attr_accessor :default_action + # @!attribute [rw] actions + # @return [Array[Action]] attr_accessor :actions + # @param thumbnail_image_url [String,nil] + # @param image_background_color [String,nil] + # @param title [String,nil] + # @param text [String] + # @param default_action [Action,nil] + # @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..1d986e17 100644 --- a/lib/line/bot/v2/messaging_api/model/carousel_template.rb +++ b/lib/line/bot/v2/messaging_api/model/carousel_template.rb @@ -14,11 +14,22 @@ 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,nil] attr_accessor :image_aspect_ratio + # @!attribute [rw] image_size + # @return [String,nil] attr_accessor :image_size + # @param columns [Array[CarouselColumn]] + # @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/chat_reference.rb b/lib/line/bot/v2/messaging_api/model/chat_reference.rb index a7a5e3e5..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,8 +14,11 @@ 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( 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..a4064a53 100644 --- a/lib/line/bot/v2/messaging_api/model/clipboard_action.rb +++ b/lib/line/bot/v2/messaging_api/model/clipboard_action.rb @@ -15,10 +15,18 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @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,nil] 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..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 @@ -15,11 +15,22 @@ 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,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,nil] 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..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,10 +14,18 @@ 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] + # @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..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,9 +13,15 @@ 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. 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..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 @@ -15,14 +15,34 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String,nil] attr_accessor :data + # @!attribute [rw] mode + # @return [String,nil] ('date'|'time'|'datetime') attr_accessor :mode + # @!attribute [rw] initial + # @return [String,nil] attr_accessor :initial + # @!attribute [rw] max + # @return [String,nil] attr_accessor :max + # @!attribute [rw] min + # @return [String,nil] attr_accessor :min + # @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 e9958bfb..898fa11b 100644 --- a/lib/line/bot/v2/messaging_api/model/demographic_filter.rb +++ b/lib/line/bot/v2/messaging_api/model/demographic_filter.rb @@ -13,8 +13,11 @@ module V2 module MessagingApi # Demographic filter class DemographicFilter - attr_accessor :type # Type of demographic filter + # @!attribute [rw] type + # @return [String,nil] Type of demographic filter + attr_accessor :type + # @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 87bd3081..bd4710b5 100644 --- a/lib/line/bot/v2/messaging_api/model/emoji.rb +++ b/lib/line/bot/v2/messaging_api/model/emoji.rb @@ -12,10 +12,19 @@ module Bot module V2 module MessagingApi class Emoji + # @!attribute [rw] index + # @return [Integer,nil] attr_accessor :index + # @!attribute [rw] product_id + # @return [String,nil] attr_accessor :product_id + # @!attribute [rw] emoji_id + # @return [String,nil] attr_accessor :emoji_id + # @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/emoji_substitution_object.rb b/lib/line/bot/v2/messaging_api/model/emoji_substitution_object.rb index 88ead32d..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,10 +16,18 @@ 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] + # @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..321bb4a3 100644 --- a/lib/line/bot/v2/messaging_api/model/error_detail.rb +++ b/lib/line/bot/v2/messaging_api/model/error_detail.rb @@ -12,9 +12,15 @@ 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,nil] Details of the error. Not included in the response under certain situations. + attr_accessor :message + # @!attribute [rw] property + # @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,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 4b45707d..7b3eba48 100644 --- a/lib/line/bot/v2/messaging_api/model/error_response.rb +++ b/lib/line/bot/v2/messaging_api/model/error_response.rb @@ -13,10 +13,19 @@ 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],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],nil] Array of sent messages. + attr_accessor :sent_messages + # @param message [String] Message containing information about the error. + # @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 185bcac0..dbdf7374 100644 --- a/lib/line/bot/v2/messaging_api/model/filter.rb +++ b/lib/line/bot/v2/messaging_api/model/filter.rb @@ -13,8 +13,11 @@ module V2 module MessagingApi # Filter for narrowcast class Filter + # @!attribute [rw] demographic + # @return [DemographicFilter,nil] attr_accessor :demographic + # @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 a25fc64c..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 @@ -12,10 +12,19 @@ module Bot module V2 module MessagingApi class FlexBlockStyle + # @!attribute [rw] background_color + # @return [String,nil] attr_accessor :background_color + # @!attribute [rw] separator + # @return [Boolean,nil] attr_accessor :separator + # @!attribute [rw] separator_color + # @return [String,nil] attr_accessor :separator_color + # @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 8fb0535f..551ad30f 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_box.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_box.rb @@ -14,35 +14,118 @@ 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,nil] attr_accessor :flex + # @!attribute [rw] contents + # @return [Array[FlexComponent]] attr_accessor :contents + # @!attribute [rw] spacing + # @return [String,nil] attr_accessor :spacing + # @!attribute [rw] margin + # @return [String,nil] attr_accessor :margin + # @!attribute [rw] position + # @return [String,nil] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String,nil] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String,nil] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String,nil] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String,nil] attr_accessor :offset_end + # @!attribute [rw] background_color + # @return [String,nil] attr_accessor :background_color + # @!attribute [rw] border_color + # @return [String,nil] attr_accessor :border_color + # @!attribute [rw] border_width + # @return [String,nil] attr_accessor :border_width + # @!attribute [rw] corner_radius + # @return [String,nil] attr_accessor :corner_radius + # @!attribute [rw] width + # @return [String,nil] attr_accessor :width + # @!attribute [rw] max_width + # @return [String,nil] attr_accessor :max_width + # @!attribute [rw] height + # @return [String,nil] attr_accessor :height + # @!attribute [rw] max_height + # @return [String,nil] attr_accessor :max_height + # @!attribute [rw] padding_all + # @return [String,nil] attr_accessor :padding_all + # @!attribute [rw] padding_top + # @return [String,nil] attr_accessor :padding_top + # @!attribute [rw] padding_bottom + # @return [String,nil] attr_accessor :padding_bottom + # @!attribute [rw] padding_start + # @return [String,nil] attr_accessor :padding_start + # @!attribute [rw] padding_end + # @return [String,nil] attr_accessor :padding_end + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :action + # @!attribute [rw] justify_content + # @return [String,nil] ('center'|'flex-start'|'flex-end'|'space-between'|'space-around'|'space-evenly') attr_accessor :justify_content + # @!attribute [rw] align_items + # @return [String,nil] ('center'|'flex-start'|'flex-end') attr_accessor :align_items + # @!attribute [rw] background + # @return [FlexBoxBackground,nil] attr_accessor :background + # @param layout [String] ('horizontal'|'vertical'|'baseline') + # @param flex [Integer,nil] + # @param contents [Array[FlexComponent]] + # @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_background.rb b/lib/line/bot/v2/messaging_api/model/flex_box_background.rb index 919ecb75..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,8 +12,11 @@ module Bot module V2 module MessagingApi class FlexBoxBackground + # @!attribute [rw] type + # @return [String] 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..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 @@ -14,13 +14,30 @@ module Bot module V2 module MessagingApi class FlexBoxLinearGradient < FlexBoxBackground + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] angle + # @return [String,nil] attr_accessor :angle + # @!attribute [rw] start_color + # @return [String,nil] attr_accessor :start_color + # @!attribute [rw] end_color + # @return [String,nil] attr_accessor :end_color + # @!attribute [rw] center_color + # @return [String,nil] attr_accessor :center_color + # @!attribute [rw] center_position + # @return [String,nil] attr_accessor :center_position + # @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 739a28a5..1f4b2205 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_bubble.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_bubble.rb @@ -14,16 +14,42 @@ module Bot module V2 module MessagingApi class FlexBubble < FlexContainer + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] direction + # @return [String,nil] ('ltr'|'rtl') attr_accessor :direction + # @!attribute [rw] styles + # @return [FlexBubbleStyles,nil] attr_accessor :styles + # @!attribute [rw] header + # @return [FlexBox,nil] attr_accessor :header + # @!attribute [rw] hero + # @return [FlexComponent,nil] attr_accessor :hero + # @!attribute [rw] body + # @return [FlexBox,nil] attr_accessor :body + # @!attribute [rw] footer + # @return [FlexBox,nil] attr_accessor :footer + # @!attribute [rw] size + # @return [String,nil] ('nano'|'micro'|'deca'|'hecto'|'kilo'|'mega'|'giga') attr_accessor :size + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :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 c21a6dab..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 @@ -12,11 +12,23 @@ module Bot module V2 module MessagingApi class FlexBubbleStyles + # @!attribute [rw] header + # @return [FlexBlockStyle,nil] attr_accessor :header + # @!attribute [rw] hero + # @return [FlexBlockStyle,nil] attr_accessor :hero + # @!attribute [rw] body + # @return [FlexBlockStyle,nil] attr_accessor :body + # @!attribute [rw] footer + # @return [FlexBlockStyle,nil] attr_accessor :footer + # @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 f8bcc186..bd1a9990 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_button.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_button.rb @@ -14,22 +14,66 @@ module Bot module V2 module MessagingApi class FlexButton < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer,nil] attr_accessor :flex + # @!attribute [rw] color + # @return [String,nil] attr_accessor :color + # @!attribute [rw] style + # @return [String,nil] ('primary'|'secondary'|'link') attr_accessor :style + # @!attribute [rw] action + # @return [Action] attr_accessor :action + # @!attribute [rw] gravity + # @return [String,nil] ('top'|'bottom'|'center') attr_accessor :gravity + # @!attribute [rw] margin + # @return [String,nil] attr_accessor :margin + # @!attribute [rw] position + # @return [String,nil] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String,nil] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String,nil] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String,nil] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String,nil] attr_accessor :offset_end + # @!attribute [rw] height + # @return [String,nil] ('md'|'sm') attr_accessor :height + # @!attribute [rw] adjust_mode + # @return [String,nil] ('shrink-to-fit') attr_accessor :adjust_mode + # @!attribute [rw] scaling + # @return [Boolean,nil] attr_accessor :scaling + # @param flex [Integer,nil] + # @param color [String,nil] + # @param style [String,nil] ('primary'|'secondary'|'link') + # @param action [Action] + # @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_carousel.rb b/lib/line/bot/v2/messaging_api/model/flex_carousel.rb index 1708482c..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,9 +14,14 @@ 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]] 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..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,8 +12,11 @@ module Bot module V2 module MessagingApi class FlexComponent + # @!attribute [rw] type + # @return [String] 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..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,8 +12,11 @@ module Bot module V2 module MessagingApi class FlexContainer + # @!attribute [rw] type + # @return [String] 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..f780026c 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_filler.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_filler.rb @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class FlexFiller < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer,nil] attr_accessor :flex + # @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 d10d0de0..8eeb774a 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_icon.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_icon.rb @@ -15,18 +15,50 @@ 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,nil] attr_accessor :size + # @!attribute [rw] aspect_ratio + # @return [String,nil] attr_accessor :aspect_ratio + # @!attribute [rw] margin + # @return [String,nil] attr_accessor :margin + # @!attribute [rw] position + # @return [String,nil] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String,nil] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String,nil] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String,nil] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String,nil] attr_accessor :offset_end + # @!attribute [rw] scaling + # @return [Boolean,nil] attr_accessor :scaling + # @param url [String] + # @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 f4f52574..5ed4af92 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_image.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_image.rb @@ -15,24 +15,74 @@ 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,nil] The ratio of the width or height of this component within the parent box. + attr_accessor :flex + # @!attribute [rw] margin + # @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,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,nil] Offset. + attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String,nil] Offset. + attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String,nil] Offset. + attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String,nil] Offset. + attr_accessor :offset_end + # @!attribute [rw] align + # @return [String,nil] ('start'|'end'|'center') Alignment style in horizontal direction. + attr_accessor :align + # @!attribute [rw] gravity + # @return [String,nil] ('top'|'bottom'|'center') Alignment style in vertical direction. + attr_accessor :gravity + # @!attribute [rw] size + # @return [String,nil] The maximum image width. This is md by default. + attr_accessor :size + # @!attribute [rw] aspect_ratio + # @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,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,nil] Background color of the image. Use a hexadecimal color code. + attr_accessor :background_color + # @!attribute [rw] action + # @return [Action,nil] 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,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,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 ffa54194..49d06037 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_message.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_message.rb @@ -15,12 +15,26 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] + # @param sender [Sender,nil] + # @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..81a90bc5 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_separator.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_separator.rb @@ -14,10 +14,18 @@ module Bot module V2 module MessagingApi class FlexSeparator < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] margin + # @return [String,nil] attr_accessor :margin + # @!attribute [rw] color + # @return [String,nil] attr_accessor :color + # @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 7fb3f562..766761ae 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_span.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_span.rb @@ -14,14 +14,34 @@ module Bot module V2 module MessagingApi class FlexSpan < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] text + # @return [String,nil] attr_accessor :text + # @!attribute [rw] size + # @return [String,nil] attr_accessor :size + # @!attribute [rw] color + # @return [String,nil] attr_accessor :color + # @!attribute [rw] weight + # @return [String,nil] ('regular'|'bold') attr_accessor :weight + # @!attribute [rw] style + # @return [String,nil] ('normal'|'italic') attr_accessor :style + # @!attribute [rw] decoration + # @return [String,nil] ('none'|'underline'|'line-through') attr_accessor :decoration + # @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 50ad59c9..cb1acac7 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_text.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_text.rb @@ -14,30 +14,98 @@ module Bot module V2 module MessagingApi class FlexText < FlexComponent + # @!attribute [r] type + # @return [String] attr_reader :type + # @!attribute [rw] flex + # @return [Integer,nil] attr_accessor :flex + # @!attribute [rw] text + # @return [String,nil] attr_accessor :text + # @!attribute [rw] size + # @return [String,nil] attr_accessor :size + # @!attribute [rw] align + # @return [String,nil] ('start'|'end'|'center') attr_accessor :align + # @!attribute [rw] gravity + # @return [String,nil] ('top'|'bottom'|'center') attr_accessor :gravity + # @!attribute [rw] color + # @return [String,nil] attr_accessor :color + # @!attribute [rw] weight + # @return [String,nil] ('regular'|'bold') attr_accessor :weight + # @!attribute [rw] style + # @return [String,nil] ('normal'|'italic') attr_accessor :style + # @!attribute [rw] decoration + # @return [String,nil] ('none'|'underline'|'line-through') attr_accessor :decoration + # @!attribute [rw] wrap + # @return [Boolean,nil] attr_accessor :wrap + # @!attribute [rw] line_spacing + # @return [String,nil] attr_accessor :line_spacing + # @!attribute [rw] margin + # @return [String,nil] attr_accessor :margin + # @!attribute [rw] position + # @return [String,nil] ('relative'|'absolute') attr_accessor :position + # @!attribute [rw] offset_top + # @return [String,nil] attr_accessor :offset_top + # @!attribute [rw] offset_bottom + # @return [String,nil] attr_accessor :offset_bottom + # @!attribute [rw] offset_start + # @return [String,nil] attr_accessor :offset_start + # @!attribute [rw] offset_end + # @return [String,nil] attr_accessor :offset_end + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :action + # @!attribute [rw] max_lines + # @return [Integer,nil] attr_accessor :max_lines + # @!attribute [rw] contents + # @return [Array[FlexSpan],nil] attr_accessor :contents + # @!attribute [rw] adjust_mode + # @return [String,nil] ('shrink-to-fit') attr_accessor :adjust_mode + # @!attribute [rw] scaling + # @return [Boolean,nil] attr_accessor :scaling + # @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 ab4da235..bc9c2cfd 100644 --- a/lib/line/bot/v2/messaging_api/model/flex_video.rb +++ b/lib/line/bot/v2/messaging_api/model/flex_video.rb @@ -14,13 +14,30 @@ 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,nil] attr_accessor :aspect_ratio + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :action + # @param url [String] + # @param preview_url [String] + # @param alt_content [FlexComponent] + # @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 98f36e72..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 @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class GenderDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @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'],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 b7e28525..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 @@ -13,9 +13,15 @@ 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,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,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_aggregation_unit_usage_response.rb b/lib/line/bot/v2/messaging_api/model/get_aggregation_unit_usage_response.rb index 143e5b93..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,8 +13,11 @@ 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( 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..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 @@ -13,9 +13,15 @@ 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,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,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 1ac3225e..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 @@ -14,9 +14,15 @@ 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,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,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/get_membership_subscription_response.rb b/lib/line/bot/v2/messaging_api/model/get_membership_subscription_response.rb index 6aac788b..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,8 +14,11 @@ 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( 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..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,8 +14,11 @@ 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( 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..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,9 +13,15 @@ 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. 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..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,8 +13,11 @@ 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( 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..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 @@ -13,10 +13,19 @@ 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,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,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 7f7a2c47..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 @@ -13,10 +13,19 @@ 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,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,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_carousel_column.rb b/lib/line/bot/v2/messaging_api/model/image_carousel_column.rb index 7a48419d..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,9 +12,15 @@ 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] + # @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..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,9 +14,14 @@ 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]] 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..f1c3dd7f 100644 --- a/lib/line/bot/v2/messaging_api/model/image_message.rb +++ b/lib/line/bot/v2/messaging_api/model/image_message.rb @@ -15,12 +15,26 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] + # @param sender [Sender,nil] + # @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..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,9 +13,15 @@ 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] + # @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..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,11 +12,23 @@ 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] + # @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..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,9 +12,15 @@ 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] + # @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..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 @@ -12,9 +12,15 @@ module Bot module V2 module MessagingApi class ImagemapExternalLink + # @!attribute [rw] link_uri + # @return [String,nil] attr_accessor :link_uri + # @!attribute [rw] label + # @return [String,nil] attr_accessor :label + # @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 9979ac9f..1739085c 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_message.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_message.rb @@ -15,15 +15,38 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] attr_accessor :video + # @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,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 5a2a4592..c4857b55 100644 --- a/lib/line/bot/v2/messaging_api/model/imagemap_video.rb +++ b/lib/line/bot/v2/messaging_api/model/imagemap_video.rb @@ -12,11 +12,23 @@ module Bot module V2 module MessagingApi class ImagemapVideo + # @!attribute [rw] original_content_url + # @return [String,nil] attr_accessor :original_content_url + # @!attribute [rw] preview_image_url + # @return [String,nil] attr_accessor :preview_image_url + # @!attribute [rw] area + # @return [ImagemapArea,nil] attr_accessor :area + # @!attribute [rw] external_link + # @return [ImagemapExternalLink,nil] attr_accessor :external_link + # @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/issue_link_token_response.rb b/lib/line/bot/v2/messaging_api/model/issue_link_token_response.rb index 745fc3d4..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,8 +13,11 @@ 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( 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..ed92c605 100644 --- a/lib/line/bot/v2/messaging_api/model/limit.rb +++ b/lib/line/bot/v2/messaging_api/model/limit.rb @@ -14,9 +14,15 @@ 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,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,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,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 9d84164d..bce3c410 100644 --- a/lib/line/bot/v2/messaging_api/model/location_action.rb +++ b/lib/line/bot/v2/messaging_api/model/location_action.rb @@ -14,9 +14,14 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @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 79ae1b57..ed35917d 100644 --- a/lib/line/bot/v2/messaging_api/model/location_message.rb +++ b/lib/line/bot/v2/messaging_api/model/location_message.rb @@ -15,14 +15,34 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] + # @param sender [Sender,nil] + # @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..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,8 +13,11 @@ 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] 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..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 @@ -12,9 +12,15 @@ 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,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,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/membership.rb b/lib/line/bot/v2/messaging_api/model/membership.rb index 025264d0..c7777b46 100644 --- a/lib/line/bot/v2/messaging_api/model/membership.rb +++ b/lib/line/bot/v2/messaging_api/model/membership.rb @@ -12,17 +12,47 @@ 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. + # @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..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,8 +13,11 @@ 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( 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..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,9 +16,14 @@ 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] 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..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,8 +12,11 @@ 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( 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..4688e749 100644 --- a/lib/line/bot/v2/messaging_api/model/message.rb +++ b/lib/line/bot/v2/messaging_api/model/message.rb @@ -13,10 +13,19 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] attr_accessor :sender + # @param type [String] Type of message + # @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 3c7ae83c..993a204a 100644 --- a/lib/line/bot/v2/messaging_api/model/message_action.rb +++ b/lib/line/bot/v2/messaging_api/model/message_action.rb @@ -14,10 +14,18 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @!attribute [rw] text + # @return [String,nil] attr_accessor :text + # @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 90fe2a9b..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 @@ -14,11 +14,22 @@ 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,nil] attr_accessor :label + # @param area [ImagemapArea] + # @param text [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 939163e0..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 @@ -13,9 +13,15 @@ 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,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,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 e36e710c..7a68e334 100644 --- a/lib/line/bot/v2/messaging_api/model/multicast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/multicast_request.rb @@ -13,11 +13,23 @@ 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,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],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,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 0253678f..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 @@ -13,15 +13,39 @@ 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,nil] The number of users who successfully received the message. + attr_accessor :success_count + # @!attribute [rw] failure_count + # @return [Integer,nil] The number of users who failed to send the message. + attr_accessor :failure_count + # @!attribute [rw] target_count + # @return [Integer,nil] The number of intended recipients of the message. + attr_accessor :target_count + # @!attribute [rw] failed_description + # @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,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,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,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,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 4dec205d..7bd372dc 100644 --- a/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb +++ b/lib/line/bot/v2/messaging_api/model/narrowcast_request.rb @@ -13,12 +13,27 @@ 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,nil] attr_accessor :recipient + # @!attribute [rw] filter + # @return [Filter,nil] attr_accessor :filter + # @!attribute [rw] limit + # @return [Limit,nil] 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,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,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 400c6abe..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 @@ -12,9 +12,15 @@ 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,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,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 750232fb..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 @@ -14,11 +14,22 @@ module Bot module V2 module MessagingApi class OperatorDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String,nil] Type of demographic filter + attr_reader :type + # @!attribute [rw] _and + # @return [Array[DemographicFilter],nil] attr_accessor :_and + # @!attribute [rw] _or + # @return [Array[DemographicFilter],nil] attr_accessor :_or + # @!attribute [rw] _not + # @return [DemographicFilter,nil] attr_accessor :_not + # @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 8c017e4a..27663c30 100644 --- a/lib/line/bot/v2/messaging_api/model/operator_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/operator_recipient.rb @@ -14,11 +14,22 @@ 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,nil] Type of recipient + attr_reader :type + # @!attribute [rw] _and + # @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],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,nil] attr_accessor :_not + # @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 5a4d309d..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 @@ -13,10 +13,19 @@ 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,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,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 38b35833..da45c0f7 100644 --- a/lib/line/bot/v2/messaging_api/model/postback_action.rb +++ b/lib/line/bot/v2/messaging_api/model/postback_action.rb @@ -14,14 +14,34 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String,nil] attr_accessor :data + # @!attribute [rw] display_text + # @return [String,nil] attr_accessor :display_text + # @!attribute [rw] text + # @return [String,nil] attr_accessor :text + # @!attribute [rw] input_option + # @return [String,nil] ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice') attr_accessor :input_option + # @!attribute [rw] fill_in_text + # @return [String,nil] attr_accessor :fill_in_text + # @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 6502d87b..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 @@ -13,11 +13,23 @@ 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,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],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,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/push_message_response.rb b/lib/line/bot/v2/messaging_api/model/push_message_response.rb index 880b24b1..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,8 +13,11 @@ 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( 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..6b0f5903 100644 --- a/lib/line/bot/v2/messaging_api/model/quick_reply.rb +++ b/lib/line/bot/v2/messaging_api/model/quick_reply.rb @@ -14,8 +14,11 @@ 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],nil] Quick reply button objects. + attr_accessor :items + # @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 433bb463..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 @@ -13,10 +13,19 @@ 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,nil] URL of the icon that is displayed at the beginning of the button + attr_accessor :image_url + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :action - attr_accessor :type # `action` + # @!attribute [rw] type + # @return [String,nil] `action` + attr_accessor :type + # @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/quota_consumption_response.rb b/lib/line/bot/v2/messaging_api/model/quota_consumption_response.rb index 135b1402..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,8 +13,11 @@ 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( 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..66c85ade 100644 --- a/lib/line/bot/v2/messaging_api/model/recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/recipient.rb @@ -13,8 +13,11 @@ module V2 module MessagingApi # Recipient class Recipient - attr_accessor :type # Type of recipient + # @!attribute [rw] type + # @return [String,nil] Type of recipient + attr_accessor :type + # @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 ee95e20a..62540e99 100644 --- a/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb +++ b/lib/line/bot/v2/messaging_api/model/redelivery_recipient.rb @@ -14,9 +14,14 @@ module Bot module V2 module MessagingApi class RedeliveryRecipient < Recipient - attr_reader :type # Type of recipient + # @!attribute [r] type + # @return [String,nil] Type of recipient + attr_reader :type + # @!attribute [rw] request_id + # @return [String,nil] attr_accessor :request_id + # @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 86c339c8..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 @@ -13,10 +13,19 @@ 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,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,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/reply_message_response.rb b/lib/line/bot/v2/messaging_api/model/reply_message_response.rb index 849cf788..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,8 +13,11 @@ 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( 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..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,8 +13,11 @@ 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( 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..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,9 +12,15 @@ 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. 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..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 @@ -13,9 +13,15 @@ module V2 module MessagingApi # Rich menu area class RichMenuArea + # @!attribute [rw] bounds + # @return [RichMenuBounds,nil] attr_accessor :bounds + # @!attribute [rw] action + # @return [Action,nil] attr_accessor :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_link_operation.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_batch_link_operation.rb index b5ef3f42..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,10 +15,18 @@ 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] + # @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..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,8 +14,11 @@ 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( 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..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 @@ -13,10 +13,19 @@ 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,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,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 beaf935c..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 @@ -12,9 +12,15 @@ 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,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,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_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 69579a5e..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,9 +15,14 @@ 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] 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..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 @@ -14,11 +14,23 @@ 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,nil] Horizontal position relative to the top-left corner of the area. + attr_accessor :x + # @!attribute [rw] y + # @return [Integer,nil] Vertical position relative to the top-left corner of the area. + attr_accessor :y + # @!attribute [rw] width + # @return [Integer,nil] Width of the area. + attr_accessor :width + # @!attribute [rw] height + # @return [Integer,nil] Height of the area. + attr_accessor :height + # @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_bulk_link_request.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_bulk_link_request.rb index 5f7e64d9..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,9 +13,15 @@ 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. 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..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,8 +13,11 @@ 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( 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..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,8 +12,11 @@ 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( 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..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,8 +13,11 @@ 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( 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..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 @@ -12,12 +12,27 @@ module Bot module V2 module MessagingApi class RichMenuRequest + # @!attribute [rw] size + # @return [RichMenuSize,nil] 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,nil] `true` to display the rich menu by default. Otherwise, `false`. + attr_accessor :selected + # @!attribute [rw] name + # @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,nil] Text displayed in the chat bar + attr_accessor :chat_bar_text + # @!attribute [rw] areas + # @return [Array[RichMenuArea],nil] Array of area objects which define the coordinates and size of tappable areas + attr_accessor :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_response.rb b/lib/line/bot/v2/messaging_api/model/rich_menu_response.rb index 5f414806..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,13 +12,31 @@ 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] + # @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..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 @@ -13,9 +13,15 @@ module V2 module MessagingApi # Rich menu size class RichMenuSize - attr_accessor :width # width - attr_accessor :height # height + # @!attribute [rw] width + # @return [Integer,nil] width + attr_accessor :width + # @!attribute [rw] height + # @return [Integer,nil] height + attr_accessor :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 557328ff..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 @@ -14,11 +14,22 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @!attribute [rw] data + # @return [String,nil] attr_accessor :data + # @!attribute [rw] rich_menu_alias_id + # @return [String,nil] attr_accessor :rich_menu_alias_id + # @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_member_count_response.rb b/lib/line/bot/v2/messaging_api/model/room_member_count_response.rb index 9fbd7b1e..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,8 +13,11 @@ 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( 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..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 @@ -13,10 +13,19 @@ 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,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,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 b42e4b93..c21507af 100644 --- a/lib/line/bot/v2/messaging_api/model/sender.rb +++ b/lib/line/bot/v2/messaging_api/model/sender.rb @@ -13,9 +13,15 @@ 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,nil] Display name. Certain words such as `LINE` may not be used. + attr_accessor :name + # @!attribute [rw] icon_url + # @return [String,nil] URL of the image to display as an icon when sending a message + attr_accessor :icon_url + # @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 56c5b020..e268e431 100644 --- a/lib/line/bot/v2/messaging_api/model/sent_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sent_message.rb @@ -12,9 +12,15 @@ 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,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,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/set_webhook_endpoint_request.rb b/lib/line/bot/v2/messaging_api/model/set_webhook_endpoint_request.rb index 4ba21340..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,8 +13,11 @@ 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( 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..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 @@ -13,9 +13,15 @@ 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,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,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 a5f70d48..0e8144d3 100644 --- a/lib/line/bot/v2/messaging_api/model/sticker_message.rb +++ b/lib/line/bot/v2/messaging_api/model/sticker_message.rb @@ -15,13 +15,30 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] Quote token of the message you want to quote. + attr_accessor :quote_token + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] + # @param package_id [String] + # @param sticker_id [String] + # @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/subscribed_membership_plan.rb b/lib/line/bot/v2/messaging_api/model/subscribed_membership_plan.rb index c98574a4..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,13 +13,31 @@ 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. + # @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..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,11 +13,23 @@ 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. + # @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..b5281936 100644 --- a/lib/line/bot/v2/messaging_api/model/subscription.rb +++ b/lib/line/bot/v2/messaging_api/model/subscription.rb @@ -13,9 +13,15 @@ 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] + # @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..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 @@ -14,10 +14,18 @@ module Bot module V2 module MessagingApi class SubscriptionPeriodDemographicFilter < DemographicFilter - attr_reader :type # Type of demographic filter + # @!attribute [r] type + # @return [String,nil] Type of demographic filter + attr_reader :type + # @!attribute [rw] gte + # @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :gte + # @!attribute [rw] lt + # @return [String,nil] ('day_7'|'day_30'|'day_90'|'day_180'|'day_365') attr_accessor :lt + # @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/substitution_object.rb b/lib/line/bot/v2/messaging_api/model/substitution_object.rb index 1d7eb0fa..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,8 +13,11 @@ 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( 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..776ea7e6 100644 --- a/lib/line/bot/v2/messaging_api/model/template.rb +++ b/lib/line/bot/v2/messaging_api/model/template.rb @@ -12,8 +12,11 @@ module Bot module V2 module MessagingApi class Template + # @!attribute [rw] type + # @return [String] 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..5afd2c5c 100644 --- a/lib/line/bot/v2/messaging_api/model/template_message.rb +++ b/lib/line/bot/v2/messaging_api/model/template_message.rb @@ -15,12 +15,26 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] + # @param sender [Sender,nil] + # @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..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 @@ -13,8 +13,11 @@ 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,nil] A webhook URL to be validated. + attr_accessor :endpoint + # @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 ec390985..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 @@ -13,12 +13,27 @@ 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,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. + 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,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. + # @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..282163af 100644 --- a/lib/line/bot/v2/messaging_api/model/text_message.rb +++ b/lib/line/bot/v2/messaging_api/model/text_message.rb @@ -15,13 +15,30 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] attr_accessor :sender + # @!attribute [rw] text + # @return [String] attr_accessor :text + # @!attribute [rw] emojis + # @return [Array[Emoji],nil] attr_accessor :emojis - attr_accessor :quote_token # Quote token of the message you want to quote. + # @!attribute [rw] quote_token + # @return [String,nil] Quote token of the message you want to quote. + attr_accessor :quote_token + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] + # @param text [String] + # @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 18a4d2f9..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 @@ -15,13 +15,30 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] A mapping that specifies substitutions for parts enclosed in {} within the `text` field. + attr_accessor :substitution + # @!attribute [rw] quote_token + # @return [String,nil] Quote token of the message you want to quote. + attr_accessor :quote_token + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] + # @param text [String] + # @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/update_rich_menu_alias_request.rb b/lib/line/bot/v2/messaging_api/model/update_rich_menu_alias_request.rb index fe774c32..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,8 +13,11 @@ 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( 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..bde13c95 100644 --- a/lib/line/bot/v2/messaging_api/model/uri_action.rb +++ b/lib/line/bot/v2/messaging_api/model/uri_action.rb @@ -14,11 +14,22 @@ 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,nil] Type of action + attr_reader :type + # @!attribute [rw] label + # @return [String,nil] Label for the action. + attr_accessor :label + # @!attribute [rw] uri + # @return [String,nil] attr_accessor :uri + # @!attribute [rw] alt_uri + # @return [AltUri,nil] attr_accessor :alt_uri + # @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 82fbe760..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 @@ -14,11 +14,22 @@ 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,nil] attr_accessor :label + # @param area [ImagemapArea] + # @param link_uri [String] + # @param label [String,nil] 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..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,9 +15,14 @@ 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] 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..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 @@ -13,12 +13,27 @@ 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,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,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,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,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/validate_message_request.rb b/lib/line/bot/v2/messaging_api/model/validate_message_request.rb index bc50dce8..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,8 +12,11 @@ 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( 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..6f9cae61 100644 --- a/lib/line/bot/v2/messaging_api/model/video_message.rb +++ b/lib/line/bot/v2/messaging_api/model/video_message.rb @@ -15,13 +15,30 @@ 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,nil] attr_accessor :quick_reply + # @!attribute [rw] sender + # @return [Sender,nil] 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,nil] attr_accessor :tracking_id + # @param quick_reply [QuickReply,nil] + # @param sender [Sender,nil] + # @param original_content_url [String] + # @param preview_image_url [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 d8238e2a..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 @@ -14,9 +14,15 @@ 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,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,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,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 da22e9a4..58aee47d 100644 --- a/lib/line/bot/v2/module/model/detach_module_request.rb +++ b/lib/line/bot/v2/module/model/detach_module_request.rb @@ -14,8 +14,11 @@ 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,nil] User ID of the LINE Official Account bot attached to the module channel. + attr_accessor :bot_id + # @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 128e1a92..8500295e 100644 --- a/lib/line/bot/v2/module/model/get_modules_response.rb +++ b/lib/line/bot/v2/module/model/get_modules_response.rb @@ -14,9 +14,15 @@ 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,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,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 e05620d6..e16da968 100644 --- a/lib/line/bot/v2/module/model/module_bot.rb +++ b/lib/line/bot/v2/module/model/module_bot.rb @@ -14,12 +14,27 @@ 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,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,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,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,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/module_attach/model/attach_module_response.rb b/lib/line/bot/v2/module_attach/model/attach_module_response.rb index 8b33840f..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,9 +13,15 @@ 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. 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..8254b2ba 100644 --- a/lib/line/bot/v2/shop/model/error_response.rb +++ b/lib/line/bot/v2/shop/model/error_response.rb @@ -13,8 +13,11 @@ 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( 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..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,11 +14,23 @@ 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 + # @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..ffb1bffa 100644 --- a/lib/line/bot/v2/webhook/model/account_link_event.rb +++ b/lib/line/bot/v2/webhook/model/account_link_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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,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,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, 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..e58a5a70 100644 --- a/lib/line/bot/v2/webhook/model/action_result.rb +++ b/lib/line/bot/v2/webhook/model/action_result.rb @@ -12,9 +12,15 @@ 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,nil] Base64-encoded binary data + attr_accessor :data + # @param type [String] ('void'|'binary') + # @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 5731d409..ee9fcc34 100644 --- a/lib/line/bot/v2/webhook/model/activated_event.rb +++ b/lib/line/bot/v2/webhook/model/activated_event.rb @@ -15,14 +15,34 @@ 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,nil] 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,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 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..393e1789 100644 --- a/lib/line/bot/v2/webhook/model/all_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/all_mentionee.rb @@ -15,10 +15,18 @@ 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. 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..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,10 +14,18 @@ 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. 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..b6b95373 100644 --- a/lib/line/bot/v2/webhook/model/audio_message_content.rb +++ b/lib/line/bot/v2/webhook/model/audio_message_content.rb @@ -14,11 +14,22 @@ 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,nil] Length of audio file (milliseconds) + attr_accessor :duration + # @param id [String] Message ID + # @param content_provider [ContentProvider] + # @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 a6fe73d2..2d1280a5 100644 --- a/lib/line/bot/v2/webhook/model/beacon_content.rb +++ b/lib/line/bot/v2/webhook/model/beacon_content.rb @@ -12,10 +12,19 @@ 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,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,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 aeac6b45..72c2438b 100644 --- a/lib/line/bot/v2/webhook/model/beacon_event.rb +++ b/lib/line/bot/v2/webhook/model/beacon_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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 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..83b3efc3 100644 --- a/lib/line/bot/v2/webhook/model/bot_resumed_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_resumed_event.rb @@ -15,13 +15,30 @@ 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,nil] 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,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] 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..bf14f6b8 100644 --- a/lib/line/bot/v2/webhook/model/bot_suspended_event.rb +++ b/lib/line/bot/v2/webhook/model/bot_suspended_event.rb @@ -15,13 +15,30 @@ 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,nil] 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,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] 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..2b6c436d 100644 --- a/lib/line/bot/v2/webhook/model/callback_request.rb +++ b/lib/line/bot/v2/webhook/model/callback_request.rb @@ -14,9 +14,15 @@ 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. 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..5a319a7e 100644 --- a/lib/line/bot/v2/webhook/model/chat_control.rb +++ b/lib/line/bot/v2/webhook/model/chat_control.rb @@ -12,8 +12,11 @@ module Bot module V2 module Webhook class ChatControl + # @!attribute [rw] expire_at + # @return [Integer] 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..a295271e 100644 --- a/lib/line/bot/v2/webhook/model/content_provider.rb +++ b/lib/line/bot/v2/webhook/model/content_provider.rb @@ -13,10 +13,19 @@ 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,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,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,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 5f30ccb3..b832b492 100644 --- a/lib/line/bot/v2/webhook/model/deactivated_event.rb +++ b/lib/line/bot/v2/webhook/model/deactivated_event.rb @@ -15,13 +15,30 @@ 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,nil] 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,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] 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..01cfc968 100644 --- a/lib/line/bot/v2/webhook/model/delivery_context.rb +++ b/lib/line/bot/v2/webhook/model/delivery_context.rb @@ -13,8 +13,11 @@ 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( 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..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,10 +14,18 @@ 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 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..1ca3bae4 100644 --- a/lib/line/bot/v2/webhook/model/emoji.rb +++ b/lib/line/bot/v2/webhook/model/emoji.rb @@ -12,11 +12,23 @@ 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. + # @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..a2b249f9 100644 --- a/lib/line/bot/v2/webhook/model/event.rb +++ b/lib/line/bot/v2/webhook/model/event.rb @@ -13,13 +13,31 @@ 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,nil] 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 + # @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] 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..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,11 +14,22 @@ 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 + # @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..dff37770 100644 --- a/lib/line/bot/v2/webhook/model/follow_detail.rb +++ b/lib/line/bot/v2/webhook/model/follow_detail.rb @@ -12,8 +12,11 @@ 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( 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..4b9bca7d 100644 --- a/lib/line/bot/v2/webhook/model/follow_event.rb +++ b/lib/line/bot/v2/webhook/model/follow_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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 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..3bea58e1 100644 --- a/lib/line/bot/v2/webhook/model/group_source.rb +++ b/lib/line/bot/v2/webhook/model/group_source.rb @@ -14,10 +14,18 @@ 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,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,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 30f4f76b..a1ab0c69 100644 --- a/lib/line/bot/v2/webhook/model/image_message_content.rb +++ b/lib/line/bot/v2/webhook/model/image_message_content.rb @@ -14,12 +14,26 @@ 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,nil] 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] + # @param image_set [ImageSet,nil] + # @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..40377425 100644 --- a/lib/line/bot/v2/webhook/model/image_set.rb +++ b/lib/line/bot/v2/webhook/model/image_set.rb @@ -12,10 +12,19 @@ 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,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,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,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 f958fb37..594cde43 100644 --- a/lib/line/bot/v2/webhook/model/join_event.rb +++ b/lib/line/bot/v2/webhook/model/join_event.rb @@ -15,14 +15,34 @@ 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,nil] 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,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 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..1a5cc9f4 100644 --- a/lib/line/bot/v2/webhook/model/joined_members.rb +++ b/lib/line/bot/v2/webhook/model/joined_members.rb @@ -12,8 +12,11 @@ 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( 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..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,9 +14,14 @@ 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( 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..dedaabb4 100644 --- a/lib/line/bot/v2/webhook/model/leave_event.rb +++ b/lib/line/bot/v2/webhook/model/leave_event.rb @@ -15,13 +15,30 @@ 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,nil] 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,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] 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..1a4cfe1c 100644 --- a/lib/line/bot/v2/webhook/model/left_members.rb +++ b/lib/line/bot/v2/webhook/model/left_members.rb @@ -12,8 +12,11 @@ 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( 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..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,9 +14,14 @@ 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( 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..a5a4cc6c 100644 --- a/lib/line/bot/v2/webhook/model/link_content.rb +++ b/lib/line/bot/v2/webhook/model/link_content.rb @@ -13,9 +13,15 @@ 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. 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..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,9 +14,14 @@ 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( 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..3cb49954 100644 --- a/lib/line/bot/v2/webhook/model/location_message_content.rb +++ b/lib/line/bot/v2/webhook/model/location_message_content.rb @@ -14,13 +14,30 @@ 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,nil] Title + attr_accessor :title + # @!attribute [rw] address + # @return [String,nil] 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,nil] Title + # @param address [String,nil] 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..9f5b5a39 100644 --- a/lib/line/bot/v2/webhook/model/member_joined_event.rb +++ b/lib/line/bot/v2/webhook/model/member_joined_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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 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..1025c5a5 100644 --- a/lib/line/bot/v2/webhook/model/member_left_event.rb +++ b/lib/line/bot/v2/webhook/model/member_left_event.rb @@ -15,14 +15,34 @@ 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,nil] 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,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 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..46a43420 100644 --- a/lib/line/bot/v2/webhook/model/membership_content.rb +++ b/lib/line/bot/v2/webhook/model/membership_content.rb @@ -13,8 +13,11 @@ 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( 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..e41429c8 100644 --- a/lib/line/bot/v2/webhook/model/membership_event.rb +++ b/lib/line/bot/v2/webhook/model/membership_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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 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..179955a7 100644 --- a/lib/line/bot/v2/webhook/model/mention.rb +++ b/lib/line/bot/v2/webhook/model/mention.rb @@ -12,8 +12,11 @@ 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( 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..81483a15 100644 --- a/lib/line/bot/v2/webhook/model/mentionee.rb +++ b/lib/line/bot/v2/webhook/model/mentionee.rb @@ -13,10 +13,19 @@ 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. + # @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..5b65cc9e 100644 --- a/lib/line/bot/v2/webhook/model/message_content.rb +++ b/lib/line/bot/v2/webhook/model/message_content.rb @@ -13,9 +13,15 @@ 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 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..e970bf13 100644 --- a/lib/line/bot/v2/webhook/model/message_event.rb +++ b/lib/line/bot/v2/webhook/model/message_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,nil] attr_accessor :reply_token + # @!attribute [rw] message + # @return [MessageContent] attr_accessor :message + # @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,nil] + # @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..c861e6e3 100644 --- a/lib/line/bot/v2/webhook/model/module_content.rb +++ b/lib/line/bot/v2/webhook/model/module_content.rb @@ -12,8 +12,11 @@ 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( 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..2b4b762b 100644 --- a/lib/line/bot/v2/webhook/model/module_event.rb +++ b/lib/line/bot/v2/webhook/model/module_event.rb @@ -15,14 +15,34 @@ 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,nil] 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,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 _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..fe43f01d 100644 --- a/lib/line/bot/v2/webhook/model/pnp_delivery.rb +++ b/lib/line/bot/v2/webhook/model/pnp_delivery.rb @@ -13,8 +13,11 @@ 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( 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..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 @@ -15,14 +15,34 @@ 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,nil] 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,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 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..1b410aa8 100644 --- a/lib/line/bot/v2/webhook/model/postback_content.rb +++ b/lib/line/bot/v2/webhook/model/postback_content.rb @@ -12,9 +12,15 @@ 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,nil] attr_accessor :params + # @param data [String] Postback data + # @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 369ca43b..0ef2d006 100644 --- a/lib/line/bot/v2/webhook/model/postback_event.rb +++ b/lib/line/bot/v2/webhook/model/postback_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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,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,nil] 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..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,9 +14,14 @@ 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( 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..bf9e06b9 100644 --- a/lib/line/bot/v2/webhook/model/room_source.rb +++ b/lib/line/bot/v2/webhook/model/room_source.rb @@ -14,10 +14,18 @@ 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,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,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, 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..b49eef09 100644 --- a/lib/line/bot/v2/webhook/model/scenario_result.rb +++ b/lib/line/bot/v2/webhook/model/scenario_result.rb @@ -13,15 +13,39 @@ 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,nil] Scenario ID executed + attr_accessor :scenario_id + # @!attribute [rw] revision + # @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) + 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],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,nil] Data contained in notification. + attr_accessor :ble_notification_payload + # @!attribute [rw] error_reason + # @return [String,nil] Error reason. + attr_accessor :error_reason + # @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],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/scenario_result_things_content.rb b/lib/line/bot/v2/webhook/model/scenario_result_things_content.rb index 8f638020..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,10 +14,18 @@ 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. + # @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..d12cd68a 100644 --- a/lib/line/bot/v2/webhook/model/source.rb +++ b/lib/line/bot/v2/webhook/model/source.rb @@ -14,8 +14,11 @@ 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,nil] source type + attr_accessor :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 20fbcafc..4f1ce8d7 100644 --- a/lib/line/bot/v2/webhook/model/sticker_message_content.rb +++ b/lib/line/bot/v2/webhook/model/sticker_message_content.rb @@ -15,16 +15,42 @@ 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],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,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,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],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,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 a937943e..a85485b5 100644 --- a/lib/line/bot/v2/webhook/model/text_message_content.rb +++ b/lib/line/bot/v2/webhook/model/text_message_content.rb @@ -14,14 +14,34 @@ 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],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,nil] 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,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],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,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_content.rb b/lib/line/bot/v2/webhook/model/things_content.rb index 12ef8b4c..74aa4c6f 100644 --- a/lib/line/bot/v2/webhook/model/things_content.rb +++ b/lib/line/bot/v2/webhook/model/things_content.rb @@ -12,8 +12,11 @@ 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( 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..1b1b06f7 100644 --- a/lib/line/bot/v2/webhook/model/things_event.rb +++ b/lib/line/bot/v2/webhook/model/things_event.rb @@ -15,15 +15,38 @@ 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,nil] 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,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 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..ea163e47 100644 --- a/lib/line/bot/v2/webhook/model/unfollow_event.rb +++ b/lib/line/bot/v2/webhook/model/unfollow_event.rb @@ -15,13 +15,30 @@ 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,nil] 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,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] 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..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,9 +14,14 @@ 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( 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..b0547ddb 100644 --- a/lib/line/bot/v2/webhook/model/unsend_detail.rb +++ b/lib/line/bot/v2/webhook/model/unsend_detail.rb @@ -12,8 +12,11 @@ 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( 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..93096e63 100644 --- a/lib/line/bot/v2/webhook/model/unsend_event.rb +++ b/lib/line/bot/v2/webhook/model/unsend_event.rb @@ -15,14 +15,34 @@ 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,nil] 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,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 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..07fe39db 100644 --- a/lib/line/bot/v2/webhook/model/user_mentionee.rb +++ b/lib/line/bot/v2/webhook/model/user_mentionee.rb @@ -15,12 +15,26 @@ 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,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,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,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 b331f6f1..df3bcc71 100644 --- a/lib/line/bot/v2/webhook/model/user_source.rb +++ b/lib/line/bot/v2/webhook/model/user_source.rb @@ -14,9 +14,14 @@ 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,nil] ID of the source user + attr_accessor :user_id + # @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 a0e78088..eba06ed7 100644 --- a/lib/line/bot/v2/webhook/model/video_message_content.rb +++ b/lib/line/bot/v2/webhook/model/video_message_content.rb @@ -14,12 +14,26 @@ 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,nil] 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,nil] 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..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,8 +12,11 @@ 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( 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..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 @@ -15,15 +15,38 @@ 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,nil] 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,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 video_play_complete [VideoPlayComplete] def initialize( source: nil, timestamp:,