From e59d6778290ab9345bb19e5ccda741ba94246f01 Mon Sep 17 00:00:00 2001 From: Jennifer Mah <42650198+JenniferMah@users.noreply.github.com> Date: Tue, 22 Sep 2020 13:56:52 -0600 Subject: [PATCH] docs: convert markdown links to RDoc formatted links (#535) --- lib/twilio-ruby/rest/api.rb | 2 +- .../rest/api/v2010/account/address.rb | 6 +- .../account/address/dependent_phone_number.rb | 4 +- .../rest/api/v2010/account/application.rb | 6 +- .../v2010/account/authorized_connect_app.rb | 6 +- .../v2010/account/available_phone_number.rb | 6 +- .../account/available_phone_number/local.rb | 58 +++++----- .../machine_to_machine.rb | 58 +++++----- .../account/available_phone_number/mobile.rb | 58 +++++----- .../available_phone_number/national.rb | 58 +++++----- .../available_phone_number/shared_cost.rb | 58 +++++----- .../available_phone_number/toll_free.rb | 58 +++++----- .../account/available_phone_number/voip.rb | 58 +++++----- .../rest/api/v2010/account/call.rb | 40 +++---- .../rest/api/v2010/account/call/feedback.rb | 6 +- .../v2010/account/call/feedback_summary.rb | 6 +- .../api/v2010/account/call/notification.rb | 12 +- .../rest/api/v2010/account/call/payment.rb | 32 +++--- .../rest/api/v2010/account/call/recording.rb | 16 +-- .../rest/api/v2010/account/conference.rb | 6 +- .../v2010/account/conference/participant.rb | 42 +++---- .../api/v2010/account/conference/recording.rb | 6 +- .../rest/api/v2010/account/connect_app.rb | 6 +- .../v2010/account/incoming_phone_number.rb | 20 ++-- .../incoming_phone_number/assigned_add_on.rb | 6 +- .../assigned_add_on_extension.rb | 6 +- .../account/incoming_phone_number/local.rb | 6 +- .../account/incoming_phone_number/mobile.rb | 6 +- .../incoming_phone_number/toll_free.rb | 6 +- lib/twilio-ruby/rest/api/v2010/account/key.rb | 2 +- .../rest/api/v2010/account/message.rb | 50 ++++---- .../api/v2010/account/message/feedback.rb | 8 +- .../rest/api/v2010/account/message/media.rb | 6 +- .../rest/api/v2010/account/notification.rb | 6 +- .../api/v2010/account/outgoing_caller_id.rb | 6 +- .../rest/api/v2010/account/queue.rb | 6 +- .../rest/api/v2010/account/queue/member.rb | 10 +- .../rest/api/v2010/account/recording.rb | 12 +- .../v2010/account/recording/add_on_result.rb | 6 +- .../recording/add_on_result/payload.rb | 6 +- .../v2010/account/recording/transcription.rb | 12 +- .../rest/api/v2010/account/short_code.rb | 6 +- .../rest/api/v2010/account/sip/domain.rb | 2 +- .../v2010/account/sip/domain/auth_types.rb | 4 +- .../domain/auth_types/auth_calls_mapping.rb | 4 +- .../auth_calls_credential_list_mapping.rb | 6 +- ...th_calls_ip_access_control_list_mapping.rb | 6 +- .../auth_types/auth_registrations_mapping.rb | 4 +- ...h_registrations_credential_list_mapping.rb | 6 +- .../sip/domain/credential_list_mapping.rb | 2 +- .../account/sip/ip_access_control_list.rb | 2 +- .../sip/ip_access_control_list/ip_address.rb | 2 +- .../rest/api/v2010/account/token.rb | 4 +- .../rest/api/v2010/account/transcription.rb | 6 +- .../rest/api/v2010/account/usage/record.rb | 12 +- .../v2010/account/usage/record/all_time.rb | 12 +- .../api/v2010/account/usage/record/daily.rb | 12 +- .../v2010/account/usage/record/last_month.rb | 12 +- .../api/v2010/account/usage/record/monthly.rb | 12 +- .../v2010/account/usage/record/this_month.rb | 12 +- .../api/v2010/account/usage/record/today.rb | 12 +- .../api/v2010/account/usage/record/yearly.rb | 12 +- .../v2010/account/usage/record/yesterday.rb | 12 +- .../rest/api/v2010/account/usage/trigger.rb | 36 +++--- .../api/v2010/account/validation_request.rb | 6 +- .../rest/autopilot/v1/assistant.rb | 24 ++-- .../rest/autopilot/v1/assistant/defaults.rb | 6 +- .../rest/autopilot/v1/assistant/dialogue.rb | 6 +- .../rest/autopilot/v1/assistant/field_type.rb | 6 +- .../v1/assistant/field_type/field_value.rb | 22 ++-- .../autopilot/v1/assistant/model_build.rb | 6 +- .../rest/autopilot/v1/assistant/query.rb | 52 ++++----- .../autopilot/v1/assistant/style_sheet.rb | 6 +- .../rest/autopilot/v1/assistant/task.rb | 12 +- .../rest/autopilot/v1/assistant/task/field.rb | 18 +-- .../autopilot/v1/assistant/task/sample.rb | 48 ++++---- .../v1/assistant/task/task_actions.rb | 16 +-- .../v1/assistant/task/task_statistics.rb | 12 +- .../rest/autopilot/v1/assistant/webhook.rb | 6 +- lib/twilio-ruby/rest/chat/v1/service.rb | 72 ++++++------ .../rest/chat/v1/service/channel.rb | 6 +- .../rest/chat/v1/service/channel/invite.rb | 38 +++--- .../rest/chat/v1/service/channel/member.rb | 56 ++++----- .../rest/chat/v1/service/channel/message.rb | 14 +-- lib/twilio-ruby/rest/chat/v1/service/role.rb | 10 +- lib/twilio-ruby/rest/chat/v1/service/user.rb | 16 +-- .../rest/chat/v1/service/user/user_channel.rb | 4 +- lib/twilio-ruby/rest/chat/v2/service.rb | 72 ++++++------ .../rest/chat/v2/service/binding.rb | 36 +++--- .../rest/chat/v2/service/channel.rb | 30 ++--- .../rest/chat/v2/service/channel/invite.rb | 38 +++--- .../rest/chat/v2/service/channel/member.rb | 108 +++++++++--------- .../rest/chat/v2/service/channel/message.rb | 50 ++++---- .../rest/chat/v2/service/channel/webhook.rb | 30 ++--- lib/twilio-ruby/rest/chat/v2/service/role.rb | 10 +- lib/twilio-ruby/rest/chat/v2/service/user.rb | 16 +-- .../rest/chat/v2/service/user/user_binding.rb | 36 +++--- .../rest/chat/v2/service/user/user_channel.rb | 40 +++---- lib/twilio-ruby/rest/client.rb | 2 +- .../rest/conversations/v1/configuration.rb | 16 +-- .../rest/conversations/v1/conversation.rb | 12 +- .../conversations/v1/conversation/message.rb | 6 +- .../conversation/message/delivery_receipt.rb | 14 +-- .../v1/conversation/participant.rb | 24 ++-- .../conversations/v1/conversation/webhook.rb | 6 +- lib/twilio-ruby/rest/conversations/v1/role.rb | 6 +- .../rest/conversations/v1/service/binding.rb | 48 ++++---- .../conversations/v1/service/configuration.rb | 24 ++-- .../v1/service/configuration/notification.rb | 4 +- .../conversations/v1/service/conversation.rb | 20 ++-- .../v1/service/conversation/message.rb | 18 +-- .../conversation/message/delivery_receipt.rb | 26 ++--- .../v1/service/conversation/participant.rb | 36 +++--- .../v1/service/conversation/webhook.rb | 18 +-- .../rest/conversations/v1/service/role.rb | 18 +-- .../rest/conversations/v1/service/user.rb | 22 ++-- lib/twilio-ruby/rest/conversations/v1/user.rb | 10 +- lib/twilio-ruby/rest/fax/v1/fax.rb | 54 ++++----- .../rest/ip_messaging/v1/service.rb | 72 ++++++------ .../rest/ip_messaging/v1/service/channel.rb | 6 +- .../ip_messaging/v1/service/channel/invite.rb | 38 +++--- .../ip_messaging/v1/service/channel/member.rb | 56 ++++----- .../v1/service/channel/message.rb | 14 +-- .../rest/ip_messaging/v1/service/role.rb | 10 +- .../rest/ip_messaging/v1/service/user.rb | 16 +-- .../v1/service/user/user_channel.rb | 4 +- .../rest/ip_messaging/v2/service.rb | 72 ++++++------ .../rest/ip_messaging/v2/service/binding.rb | 36 +++--- .../rest/ip_messaging/v2/service/channel.rb | 30 ++--- .../ip_messaging/v2/service/channel/invite.rb | 38 +++--- .../ip_messaging/v2/service/channel/member.rb | 108 +++++++++--------- .../v2/service/channel/message.rb | 50 ++++---- .../v2/service/channel/webhook.rb | 30 ++--- .../rest/ip_messaging/v2/service/role.rb | 10 +- .../rest/ip_messaging/v2/service/user.rb | 16 +-- .../v2/service/user/user_binding.rb | 36 +++--- .../v2/service/user/user_channel.rb | 40 +++---- lib/twilio-ruby/rest/lookups.rb | 2 +- lib/twilio-ruby/rest/lookups/v1.rb | 2 +- .../rest/lookups/v1/phone_number.rb | 20 ++-- lib/twilio-ruby/rest/messaging/v1/service.rb | 72 ++++++------ .../rest/messaging/v1/service/alpha_sender.rb | 6 +- .../rest/messaging/v1/service/phone_number.rb | 6 +- .../rest/messaging/v1/service/short_code.rb | 6 +- lib/twilio-ruby/rest/monitor/v1/event.rb | 30 ++--- lib/twilio-ruby/rest/notify/v1/service.rb | 48 ++++---- .../rest/notify/v1/service/binding.rb | 20 ++-- .../rest/notify/v1/service/notification.rb | 34 +++--- .../hosted_numbers/authorization_document.rb | 20 ++-- .../dependent_hosted_number_order.rb | 12 +- .../hosted_numbers/hosted_number_order.rb | 2 +- .../preview/trusted_comms/branded_call.rb | 8 +- .../preview/trusted_comms/current_call.rb | 8 +- .../rest/preview/trusted_comms/phone_call.rb | 104 ++++++++--------- .../understand/assistant/task/field.rb | 4 +- lib/twilio-ruby/rest/pricing/v1/messaging.rb | 4 +- .../rest/pricing/v1/messaging/country.rb | 8 +- .../rest/pricing/v1/phone_number.rb | 4 +- .../rest/pricing/v1/phone_number/country.rb | 8 +- lib/twilio-ruby/rest/pricing/v1/voice.rb | 4 +- .../rest/pricing/v1/voice/country.rb | 8 +- lib/twilio-ruby/rest/pricing/v2/voice.rb | 6 +- .../rest/pricing/v2/voice/country.rb | 8 +- .../rest/pricing/v2/voice/number.rb | 8 +- lib/twilio-ruby/rest/proxy/v1/service.rb | 30 ++--- .../rest/proxy/v1/service/phone_number.rb | 22 ++-- .../rest/proxy/v1/service/session.rb | 12 +- .../proxy/v1/service/session/interaction.rb | 12 +- .../proxy/v1/service/session/participant.rb | 12 +- .../participant/message_interaction.rb | 18 +-- .../rest/proxy/v1/service/short_code.rb | 16 +-- .../rest/studio/v1/flow/execution.rb | 12 +- .../rest/studio/v2/flow/execution.rb | 12 +- lib/twilio-ruby/rest/supersim/v1/command.rb | 14 +-- lib/twilio-ruby/rest/supersim/v1/network.rb | 12 +- lib/twilio-ruby/rest/supersim/v1/sim.rb | 14 +-- .../rest/supersim/v1/usage_record.rb | 12 +- lib/twilio-ruby/rest/sync/v1/service.rb | 6 +- .../rest/sync/v1/service/document.rb | 12 +- .../service/document/document_permission.rb | 12 +- .../rest/sync/v1/service/sync_list.rb | 12 +- .../v1/service/sync_list/sync_list_item.rb | 12 +- .../service/sync_list/sync_list_permission.rb | 12 +- .../rest/sync/v1/service/sync_map.rb | 12 +- .../sync/v1/service/sync_map/sync_map_item.rb | 24 ++-- .../service/sync_map/sync_map_permission.rb | 12 +- .../rest/sync/v1/service/sync_stream.rb | 12 +- .../v1/service/sync_stream/stream_message.rb | 8 +- .../rest/taskrouter/v1/workspace.rb | 8 +- .../rest/taskrouter/v1/workspace/event.rb | 12 +- .../v1/workspace/task/reservation.rb | 24 ++-- .../taskrouter/v1/workspace/task_queue.rb | 16 +-- .../task_queue_cumulative_statistics.rb | 12 +- .../task_queue/task_queue_statistics.rb | 12 +- .../task_queue/task_queues_statistics.rb | 18 +-- .../rest/taskrouter/v1/workspace/worker.rb | 6 +- .../v1/workspace/worker/reservation.rb | 24 ++-- .../v1/workspace/worker/worker_statistics.rb | 8 +- .../worker/workers_cumulative_statistics.rb | 8 +- .../v1/workspace/worker/workers_statistics.rb | 12 +- .../rest/taskrouter/v1/workspace/workflow.rb | 24 ++-- .../workflow_cumulative_statistics.rb | 8 +- .../workspace/workflow/workflow_statistics.rb | 12 +- .../workspace_cumulative_statistics.rb | 8 +- .../v1/workspace/workspace_statistics.rb | 12 +- lib/twilio-ruby/rest/trunking/v1/trunk.rb | 54 ++++----- .../rest/trunking/v1/trunk/credential_list.rb | 4 +- .../v1/trunk/ip_access_control_list.rb | 4 +- .../rest/trunking/v1/trunk/phone_number.rb | 4 +- lib/twilio-ruby/rest/verify/v2/service.rb | 6 +- .../verify/v2/service/entity/challenge.rb | 6 +- .../v2/service/messaging_configuration.rb | 24 ++-- .../rest/verify/v2/service/rate_limit.rb | 6 +- .../verify/v2/service/rate_limit/bucket.rb | 6 +- .../rest/verify/v2/service/verification.rb | 24 ++-- .../verify/v2/service/verification_check.rb | 10 +- lib/twilio-ruby/rest/video/v1/composition.rb | 18 +-- .../rest/video/v1/composition_hook.rb | 48 ++++---- lib/twilio-ruby/rest/video/v1/recording.rb | 12 +- lib/twilio-ruby/rest/video/v1/room.rb | 12 +- .../rest/video/v1/room/recording.rb | 12 +- .../rest/video/v1/room/room_participant.rb | 18 +-- .../room_participant_subscribe_rule.rb | 4 +- lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb | 18 +-- .../rest/voice/v1/dialing_permissions.rb | 4 +- .../voice/v1/dialing_permissions/country.rb | 44 +++---- .../country/highrisk_special_prefix.rb | 8 +- lib/twilio-ruby/rest/voice/v1/ip_record.rb | 4 +- lib/twilio-ruby/rest/wireless/v1/command.rb | 14 +-- lib/twilio-ruby/rest/wireless/v1/rate_plan.rb | 14 +-- lib/twilio-ruby/rest/wireless/v1/sim.rb | 44 +++---- .../rest/wireless/v1/sim/data_session.rb | 8 +- .../rest/wireless/v1/sim/usage_record.rb | 20 ++-- .../rest/wireless/v1/usage_record.rb | 12 +- 234 files changed, 2230 insertions(+), 2230 deletions(-) diff --git a/lib/twilio-ruby/rest/api.rb b/lib/twilio-ruby/rest/api.rb index e26536938..10c1de4b6 100644 --- a/lib/twilio-ruby/rest/api.rb +++ b/lib/twilio-ruby/rest/api.rb @@ -71,7 +71,7 @@ def authorized_connect_apps(connect_app_sid=:unset) ## # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed. # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList] diff --git a/lib/twilio-ruby/rest/api/v2010/account/address.rb b/lib/twilio-ruby/rest/api/v2010/account/address.rb index ad2437770..12371a825 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/address.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/address.rb @@ -16,7 +16,7 @@ class AddressList < ListResource # Initialize the AddressList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for + # {Account}[https://www.twilio.com/docs/iam/api/account] that is responsible for # the Address resource. # @return [AddressList] AddressList def initialize(version, account_sid: nil) @@ -215,7 +215,7 @@ class AddressContext < InstanceContext # Initialize the AddressContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for + # {Account}[https://www.twilio.com/docs/iam/api/account] that is responsible for # the Address resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Address resource to fetch. @@ -317,7 +317,7 @@ class AddressInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for + # {Account}[https://www.twilio.com/docs/iam/api/account] that is responsible for # the Address resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Address resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb b/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb index 148859e10..ba1408253 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb @@ -17,7 +17,7 @@ class DependentPhoneNumberList < ListResource # Initialize the DependentPhoneNumberList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # DependentPhoneNumber resource. # @param [String] address_sid The unique string that that we created to identify # the Address resource. @@ -157,7 +157,7 @@ class DependentPhoneNumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # DependentPhoneNumber resource. # @param [String] address_sid The unique string that that we created to identify # the Address resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/application.rb b/lib/twilio-ruby/rest/api/v2010/account/application.rb index 94f6923b4..a35514972 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/application.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/application.rb @@ -16,7 +16,7 @@ class ApplicationList < ListResource # Initialize the ApplicationList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Application resource. # @return [ApplicationList] ApplicationList def initialize(version, account_sid: nil) @@ -214,7 +214,7 @@ class ApplicationContext < InstanceContext # Initialize the ApplicationContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Application resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Application resource to fetch. @@ -334,7 +334,7 @@ class ApplicationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Application resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Application resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb b/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb index 5591c36c2..4bf9fca83 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb @@ -16,7 +16,7 @@ class AuthorizedConnectAppList < ListResource # Initialize the AuthorizedConnectAppList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # AuthorizedConnectApp resource. # @return [AuthorizedConnectAppList] AuthorizedConnectAppList def initialize(version, account_sid: nil) @@ -148,7 +148,7 @@ class AuthorizedConnectAppContext < InstanceContext # Initialize the AuthorizedConnectAppContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # AuthorizedConnectApp resource to fetch. # @param [String] connect_app_sid The SID of the Connect App to fetch. # @return [AuthorizedConnectAppContext] AuthorizedConnectAppContext @@ -195,7 +195,7 @@ class AuthorizedConnectAppInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # AuthorizedConnectApp resource. # @param [String] connect_app_sid The SID of the Connect App to fetch. # @return [AuthorizedConnectAppInstance] AuthorizedConnectAppInstance diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb index c1993b98a..443e0aca0 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb @@ -147,10 +147,10 @@ class AvailablePhoneNumberCountryContext < InstanceContext # Initialize the AvailablePhoneNumberCountryContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) requesting the available + # {Account}[https://www.twilio.com/docs/iam/api/account] requesting the available # phone number Country resource. # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country to fetch available phone number information about. # @return [AvailablePhoneNumberCountryContext] AvailablePhoneNumberCountryContext def initialize(version, account_sid, country_code) @@ -319,7 +319,7 @@ class AvailablePhoneNumberCountryInstance < InstanceResource # @param [String] account_sid A 34 character string that uniquely identifies this # resource. # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country to fetch available phone number information about. # @return [AvailablePhoneNumberCountryInstance] AvailablePhoneNumberCountryInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb index 1a050723e..7ab4645d3 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb @@ -18,7 +18,7 @@ class LocalList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [LocalList] LocalList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class LocalInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [LocalInstance] LocalInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb index c49492321..dc73dfc78 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb @@ -18,7 +18,7 @@ class MachineToMachineList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [MachineToMachineList] MachineToMachineList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class MachineToMachineInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [MachineToMachineInstance] MachineToMachineInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb index f5a3308d6..939db965d 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb @@ -18,7 +18,7 @@ class MobileList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [MobileList] MobileList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class MobileInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [MobileInstance] MobileInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb index eca8d16ac..b9fd8b00e 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb @@ -18,7 +18,7 @@ class NationalList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [NationalList] NationalList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class NationalInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [NationalInstance] NationalInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb index 156bf8713..a4562c7f3 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb @@ -18,7 +18,7 @@ class SharedCostList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [SharedCostList] SharedCostList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class SharedCostInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [SharedCostInstance] SharedCostInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb index 0ff0b20b2..96a665eac 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb @@ -18,7 +18,7 @@ class TollFreeList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [TollFreeList] TollFreeList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class TollFreeInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [TollFreeInstance] TollFreeInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb index b29d1b796..32fa79783 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb @@ -18,7 +18,7 @@ class VoipList < ListResource # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [VoipList] VoipList def initialize(version, account_sid: nil, country_code: nil) @@ -37,10 +37,10 @@ def initialize(version, account_sid: nil, country_code: nil) # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -49,14 +49,14 @@ def initialize(version, account_sid: nil, country_code: nil) # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -79,9 +79,9 @@ def initialize(version, account_sid: nil, country_code: nil) # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -127,10 +127,10 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -139,14 +139,14 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -169,9 +169,9 @@ def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -233,10 +233,10 @@ def each # only phone numbers in the US and Canada. # @param [String] contains The pattern on which to match phone numbers. Valid # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any - # single digit. For examples, see [Example - # 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) - # and [Example - # 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). + # single digit. For examples, see {Example + # 2}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2] + # and {Example + # 3}[https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3]. # If specified, this value must have at least two characters. # @param [Boolean] sms_enabled Whether the phone numbers can receive text # messages. Can be: `true` or `false`. @@ -245,14 +245,14 @@ def each # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can # be: `true` or `false`. # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers - # that require an [Address](https://www.twilio.com/docs/usage/api/address). Can + # that require an {Address}[https://www.twilio.com/docs/usage/api/address]. Can # be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers - # that require a local [Address](https://www.twilio.com/docs/usage/api/address). + # that require a local {Address}[https://www.twilio.com/docs/usage/api/address]. # Can be: `true` or `false` and the default is `false`. # @param [Boolean] exclude_foreign_address_required Whether to exclude phone # numbers that require a foreign - # [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or + # {Address}[https://www.twilio.com/docs/usage/api/address]. Can be: `true` or # `false` and the default is `false`. # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio # platform. Can be: `true` or `false` and the default is `true`. @@ -275,9 +275,9 @@ def each # a phone number search within the same rate center as that number. Requires # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. # @param [String] in_lata Limit results to a specific local access and transport - # area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). + # area ({LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area]). # Given a phone number, search within the same - # [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that + # {LATA}[https://en.wikipedia.org/wiki/Local_access_and_transport_area] as that # number. Applies to only phone numbers in the US and Canada. # @param [String] in_locality Limit results to a particular locality or city. # Given a phone number, search within the same Locality as that number. @@ -378,7 +378,7 @@ class VoipInstance < InstanceResource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The account_sid # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [VoipInstance] VoipInstance def initialize(version, payload, account_sid: nil, country_code: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/call.rb b/lib/twilio-ruby/rest/api/v2010/account/call.rb index 5e9adec81..c9fdfe176 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call.rb @@ -16,7 +16,7 @@ class CallList < ListResource # Initialize the CallList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call # resource. # @return [CallList] CallList def initialize(version, account_sid: nil) @@ -34,8 +34,8 @@ def initialize(version, account_sid: nil) # Create the CallInstance # @param [String] to The phone number, SIP address, or client identifier to call. # @param [String] from The phone number or client identifier to use as the caller - # id. If using a phone number, it must be a Twilio number or a Verified [outgoing - # caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your + # id. If using a phone number, it must be a Twilio number or a Verified {outgoing + # caller id}[https://www.twilio.com/docs/voice/api/outgoing-caller-ids] for your # account. If the `to` parameter is a phone number, `From` must also be a phone # number. # @param [String] method The HTTP method we should use when calling the `url` @@ -56,8 +56,8 @@ def initialize(version, account_sid: nil) # to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and # `completed`. If no event is specified, we send the `completed` status. If you # want to receive multiple events, specify each one in a separate - # `status_callback_event` parameter. See the code sample for [monitoring call - # progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). + # `status_callback_event` parameter. See the code sample for {monitoring call + # progress}[https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json]. # If an `application_sid` is present, this parameter is ignored. # @param [String] status_callback_method The HTTP method we should use when # calling the `status_callback` URL. Can be: `GET` or `POST` and the default is @@ -101,8 +101,8 @@ def initialize(version, account_sid: nil) # Use `Enable` if you would like us to return `AnsweredBy` as soon as the called # party is identified. Use `DetectMessageEnd`, if you would like to leave a # message on an answering machine. If `send_digits` is provided, this parameter is - # ignored. For more information, see [Answering Machine - # Detection](https://www.twilio.com/docs/voice/answering-machine-detection). + # ignored. For more information, see {Answering Machine + # Detection}[https://www.twilio.com/docs/voice/answering-machine-detection]. # @param [String] machine_detection_timeout The number of seconds that we should # attempt to detect an answering machine before timing out and sending a voice # request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. @@ -114,8 +114,8 @@ def initialize(version, account_sid: nil) # recording. Can be: `trim-silence` or `do-not-trim` and the default is # `trim-silence`. # @param [String] caller_id The phone number, SIP address, or Client identifier - # that made this call. Phone numbers are in [E.164 - # format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). + # that made this call. Phone numbers are in {E.164 + # format}[https://wwnw.twilio.com/docs/glossary/what-e164] (e.g., +16175551212). # SIP addresses are formatted as `name@company.com`. # @param [String] machine_detection_speech_threshold The number of milliseconds # that is used as the measuring stick for the length of the speech activity, where @@ -144,9 +144,9 @@ def initialize(version, account_sid: nil) # Calls Beta) # @param [String] url The absolute URL that returns the TwiML instructions for the # call. We will call this URL using the `method` when the call connects. For more - # information, see the [Url - # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) - # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). + # information, see the {Url + # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter] + # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls]. # @param [String] twiml TwiML instructions for the call Twilio will use without # fetching Twiml from url parameter. If both `twiml` and `url` are provided then # `twiml` parameter will be ignored. @@ -411,7 +411,7 @@ class CallContext < InstanceContext # Initialize the CallContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call # resource(s) to fetch. # @param [String] sid The SID of the Call resource to fetch. # @return [CallContext] CallContext @@ -449,9 +449,9 @@ def fetch # Update the CallInstance # @param [String] url The absolute URL that returns the TwiML instructions for the # call. We will call this URL using the `method` when the call connects. For more - # information, see the [Url - # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) - # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). + # information, see the {Url + # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter] + # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls]. # @param [String] method The HTTP method we should use when calling the `url`. Can # be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter # is present, this parameter is ignored. @@ -589,7 +589,7 @@ class CallInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [CallInstance] CallInstance @@ -823,9 +823,9 @@ def fetch # Update the CallInstance # @param [String] url The absolute URL that returns the TwiML instructions for the # call. We will call this URL using the `method` when the call connects. For more - # information, see the [Url - # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) - # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). + # information, see the {Url + # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter] + # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls]. # @param [String] method The HTTP method we should use when calling the `url`. Can # be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter # is present, this parameter is ignored. diff --git a/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb b/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb index 2773e8f49..64e116820 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb @@ -17,7 +17,7 @@ class FeedbackList < ListResource # Initialize the FeedbackList # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] call_sid The unique string that that we created to identify this # Call resource. @@ -75,7 +75,7 @@ class FeedbackContext < InstanceContext # Initialize the FeedbackContext # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] call_sid The call sid that uniquely identifies the call # @return [FeedbackContext] FeedbackContext @@ -174,7 +174,7 @@ class FeedbackInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] call_sid The unique string that that we created to identify this # Call resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb b/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb index 8cd98ef09..c199f9b81 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb @@ -17,7 +17,7 @@ class FeedbackSummaryList < ListResource # Initialize the FeedbackSummaryList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call # resource. # @return [FeedbackSummaryList] FeedbackSummaryList def initialize(version, account_sid: nil) @@ -97,7 +97,7 @@ class FeedbackSummaryContext < InstanceContext # Initialize the FeedbackSummaryContext # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -152,7 +152,7 @@ class FeedbackSummaryInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call # resource. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb b/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb index b9733aa2e..5906e0a01 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb @@ -17,10 +17,10 @@ class NotificationList < ListResource # Initialize the NotificationList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call # Notification resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Call + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Call # Notification resource is associated with. # @return [NotificationList] NotificationList def initialize(version, account_sid: nil, call_sid: nil) @@ -192,10 +192,10 @@ class NotificationContext < InstanceContext # Initialize the NotificationContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call # Notification resource to fetch. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the Call # Notification resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the Call # Notification resource to fetch. @@ -244,10 +244,10 @@ class NotificationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Call + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call # Notification resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Call + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Call # Notification resource is associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the Call # Notification resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb b/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb index 819f1cc71..e7cca3a8f 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb @@ -19,10 +19,10 @@ class PaymentList < ListResource # Initialize the PaymentList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Payments # resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Payments # resource is associated with. This will refer to the call sid that is producing # the payment card (credit/ACH) information thru DTMF. # @return [PaymentList] PaymentList @@ -41,17 +41,17 @@ def initialize(version, account_sid: nil, call_sid: nil) # transactions. This should be a unique string value per API call and can be a # randomly generated. # @param [String] status_callback Provide an absolute or relative URL to receive - # status updates regarding your Pay session. Read more about the [expected + # status updates regarding your Pay session. Read more about the {expected # StatusCallback - # values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback) + # values}[https://www.twilio.com/docs/voice/api/payment-resource#statuscallback] # @param [payment.BankAccountType] bank_account_type Type of bank account if # payment source is ACH. One of `consumer-checking`, `consumer-savings`, or # `commercial-checking`. The default value is `consumer-checking`. # @param [String] charge_amount A positive decimal value less than 1,000,000 to # charge against the credit card or bank account. Default currency can be # overwritten with `currency` field. Leave blank or set to 0 to tokenize. - # @param [String] currency The currency of the `charge_amount`, formatted as [ISO - # 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The + # @param [String] currency The currency of the `charge_amount`, formatted as {ISO + # 4127}[http://www.iso.org/iso/home/standards/currency_codes.htm] format. The # default value is `USD` and all values allowed from the Connector are # accepted. # @param [String] description The description can be used to provide more details @@ -65,11 +65,11 @@ def initialize(version, account_sid: nil, call_sid: nil) # this many digits. # @param [Hash] parameter A single level JSON string that is required when # accepting certain information specific only to ACH payments. The information - # that has to be included here depends on the Connector. [Read - # more](https://www.twilio.com/console/voice/pay-connectors). + # that has to be included here depends on the Connector. {Read + # more}[https://www.twilio.com/console/voice/pay-connectors]. # @param [String] payment_connector This is the unique name corresponding to the # Payment Gateway Connector installed in the Twilio Add-ons. Learn more about - # [ Connectors](https://www.twilio.com/console/voice/pay-connectors). The + # { Connectors}[https://www.twilio.com/console/voice/pay-connectors]. The # default value is `Default`. # @param [payment.PaymentMethod] payment_method Type of payment being captured. # One of `credit-card` or `ach-debit`. The default value is `credit-card`. @@ -170,7 +170,7 @@ class PaymentContext < InstanceContext # Initialize the PaymentContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that will update the + # {Account}[https://www.twilio.com/docs/iam/api/account] that will update the # resource. # @param [String] call_sid The SID of the call that will update the resource. This # should be the same call sid that was used to create payments resource. @@ -192,9 +192,9 @@ def initialize(version, account_sid, call_sid, sid) # randomly generated. # @param [String] status_callback Provide an absolute or relative URL to receive # status updates regarding your Pay session. Read more about the - # [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) + # {Update}[https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update] # and - # [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) + # {Complete/Cancel}[https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete] # POST requests. # @param [payment.Capture] capture The piece of payment information that you wish # the caller to enter. Must be one of `payment-card-number`, `expiration-date`, @@ -246,10 +246,10 @@ class PaymentInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Payments # resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Payments # resource is associated with. This will refer to the call sid that is producing # the payment card (credit/ACH) information thru DTMF. # @param [String] sid The SID of Payments session that needs to be updated. @@ -332,9 +332,9 @@ def uri # randomly generated. # @param [String] status_callback Provide an absolute or relative URL to receive # status updates regarding your Pay session. Read more about the - # [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) + # {Update}[https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update] # and - # [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) + # {Complete/Cancel}[https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete] # POST requests. # @param [payment.Capture] capture The piece of payment information that you wish # the caller to enter. Must be one of `payment-card-number`, `expiration-date`, diff --git a/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb b/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb index d93839bf7..a1146e05f 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb @@ -17,10 +17,10 @@ class RecordingList < ListResource # Initialize the RecordingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Recording # resource is associated with. # @return [RecordingList] RecordingList def initialize(version, account_sid: nil, call_sid: nil) @@ -40,8 +40,8 @@ def initialize(version, account_sid: nil, call_sid: nil) # @param [String] recording_status_callback The URL we should call using the # `recording_status_callback_method` on each recording event specified in # `recording_status_callback_event`. For more information, see - # [RecordingStatusCallback - # parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback). + # {RecordingStatusCallback + # parameters}[https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback]. # @param [String] recording_status_callback_method The HTTP method we should use # to call `recording_status_callback`. Can be: `GET` or `POST` and the default is # `POST`. @@ -222,10 +222,10 @@ class RecordingContext < InstanceContext # Initialize the RecordingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource to fetch. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resource # to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Recording resource to fetch. @@ -305,10 +305,10 @@ class RecordingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource. # @param [String] call_sid The SID of the - # [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Recording # resource is associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Recording resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/conference.rb b/lib/twilio-ruby/rest/api/v2010/account/conference.rb index 305e7333c..e08fb59a7 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/conference.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/conference.rb @@ -16,7 +16,7 @@ class ConferenceList < ListResource # Initialize the ConferenceList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # Conference resource. # @return [ConferenceList] ConferenceList def initialize(version, account_sid: nil) @@ -207,7 +207,7 @@ class ConferenceContext < InstanceContext # Initialize the ConferenceContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Conference resource(s) to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Conference resource to fetch @@ -331,7 +331,7 @@ class ConferenceInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # Conference resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Conference resource to fetch diff --git a/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb b/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb index 544686302..135792b8b 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb @@ -17,7 +17,7 @@ class ParticipantList < ListResource # Initialize the ParticipantList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Participant resource. # @param [String] conference_sid The SID of the conference the participant is in. # @return [ParticipantList] ParticipantList @@ -33,20 +33,20 @@ def initialize(version, account_sid: nil, conference_sid: nil) # Create the ParticipantInstance # @param [String] from The phone number, Client identifier, or username portion of # SIP address that made this call. Phone numbers are in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format (e.g., # +16175551212). Client identifiers are formatted `client:name`. If using a phone - # number, it must be a Twilio number or a Verified [outgoing caller - # id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. + # number, it must be a Twilio number or a Verified {outgoing caller + # id}[https://www.twilio.com/docs/voice/api/outgoing-caller-ids] for your account. # If the `to` parameter is a phone number, `from` must also be a phone number. If # `to` is sip address, this value of `from` should be a username portion to be # used to populate the P-Asserted-Identity header that is passed to the SIP # endpoint. # @param [String] to The phone number, SIP address, or Client identifier that # received this call. Phone numbers are in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format (e.g., # +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client - # identifiers are formatted `client:name`. [Custom - # parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) + # identifiers are formatted `client:name`. {Custom + # parameters}[https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters] # may also be specified. # @param [String] status_callback The URL we should call using the # `status_callback_method` to send status information to your application. @@ -80,8 +80,8 @@ def initialize(version, account_sid: nil, conference_sid: nil) # participant leaves. Can be: `true` or `false` and defaults to `false`. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -119,7 +119,7 @@ def initialize(version, account_sid: nil, conference_sid: nil) # @param [String] sip_auth_username The SIP username used for authentication. # @param [String] sip_auth_password The SIP password for authentication. # @param [String] region The - # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) + # {region}[https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls] # where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, # `br1`, `au1`, or `jp1`. # @param [String] conference_recording_status_callback The URL we should call @@ -152,10 +152,10 @@ def initialize(version, account_sid: nil, conference_sid: nil) # it will otherwise be ignored. (Beta) # @param [String] caller_id The phone number, Client identifier, or username # portion of SIP address that made this call. Phone numbers are in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format (e.g., # +16175551212). Client identifiers are formatted `client:name`. If using a phone - # number, it must be a Twilio number or a Verified [outgoing caller - # id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. + # number, it must be a Twilio number or a Verified {outgoing caller + # id}[https://www.twilio.com/docs/voice/api/outgoing-caller-ids] for your account. # If the `to` parameter is a phone number, `callerId` must also be a phone number. # If `to` is sip address, this value of `callerId` should be a username portion to # be used to populate the From header that is passed to the SIP endpoint. @@ -363,12 +363,12 @@ class ParticipantContext < InstanceContext # Initialize the ParticipantContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Participant resource to fetch. # @param [String] conference_sid The SID of the conference with the participant to # fetch. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID or label of the # participant to fetch. Non URL safe characters in a label must be percent # encoded, for example, a space character is represented as %20. # @return [ParticipantContext] ParticipantContext @@ -416,8 +416,8 @@ def fetch # `announce_url`. Can be: `GET` or `POST` and defaults to `POST`. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -487,11 +487,11 @@ class ParticipantInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Participant resource. # @param [String] conference_sid The SID of the conference the participant is in. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID or label of the # participant to fetch. Non URL safe characters in a label must be percent # encoded, for example, a space character is represented as %20. # @return [ParticipantInstance] ParticipantInstance @@ -653,8 +653,8 @@ def fetch # `announce_url`. Can be: `GET` or `POST` and defaults to `POST`. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. diff --git a/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb b/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb index 9931bd9cb..09185668c 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb @@ -17,7 +17,7 @@ class RecordingList < ListResource # Initialize the RecordingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Conference Recording resource. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording. @@ -179,7 +179,7 @@ class RecordingContext < InstanceContext # Initialize the RecordingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Conference Recording resource to fetch. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording to fetch. @@ -261,7 +261,7 @@ class RecordingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Conference Recording resource. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording. diff --git a/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb b/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb index 7808510e3..e81cfb7dc 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb @@ -16,7 +16,7 @@ class ConnectAppList < ListResource # Initialize the ConnectAppList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # ConnectApp resource. # @return [ConnectAppList] ConnectAppList def initialize(version, account_sid: nil) @@ -148,7 +148,7 @@ class ConnectAppContext < InstanceContext # Initialize the ConnectAppContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # ConnectApp resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # ConnectApp resource to fetch. @@ -243,7 +243,7 @@ class ConnectAppInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # ConnectApp resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # ConnectApp resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb index d1e5e1bb5..6ac7bb77f 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb @@ -16,7 +16,7 @@ class IncomingPhoneNumberList < ListResource # Initialize the IncomingPhoneNumberList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [IncomingPhoneNumberList] IncomingPhoneNumberList def initialize(version, account_sid: nil) @@ -221,7 +221,7 @@ def get_page(target_url) # @param [String] bundle_sid The SID of the Bundle resource that you associate # with the phone number. Some regions require a Bundle to meet local Regulations. # @param [String] phone_number The phone number to purchase specified in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone # numbers consist of a + followed by the country code and subscriber number # without punctuation characters. For example, +14155551234. # @param [String] area_code The desired area code for your new incoming phone @@ -327,7 +327,7 @@ class IncomingPhoneNumberContext < InstanceContext # Initialize the IncomingPhoneNumberContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # IncomingPhoneNumber resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # IncomingPhoneNumber resource to fetch. @@ -346,10 +346,10 @@ def initialize(version, account_sid, sid) ## # Update the IncomingPhoneNumberInstance # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the - # IncomingPhoneNumber resource to update. For more information, see [Exchanging + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the + # IncomingPhoneNumber resource to update. For more information, see {Exchanging # Numbers Between - # Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers). + # Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers]. # @param [String] api_version The API version to use for incoming calls made to # the phone number. The default is `2010-04-01`. # @param [String] friendly_name A descriptive string that you created to describe @@ -509,7 +509,7 @@ class IncomingPhoneNumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # IncomingPhoneNumber resource to fetch. @@ -771,10 +771,10 @@ def status ## # Update the IncomingPhoneNumberInstance # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the - # IncomingPhoneNumber resource to update. For more information, see [Exchanging + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the + # IncomingPhoneNumber resource to update. For more information, see {Exchanging # Numbers Between - # Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers). + # Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers]. # @param [String] api_version The API version to use for incoming calls made to # the phone number. The default is `2010-04-01`. # @param [String] friendly_name A descriptive string that you created to describe diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb index 36fd3d83c..b5693f199 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb @@ -19,7 +19,7 @@ class AssignedAddOnList < ListResource # Initialize the AssignedAddOnList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # resource. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. @@ -180,7 +180,7 @@ class AssignedAddOnContext < InstanceContext # Initialize the AssignedAddOnContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the resource + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the resource # to fetch. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. @@ -272,7 +272,7 @@ class AssignedAddOnInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # resource. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb index a7e663b41..7d920ebdb 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb @@ -20,7 +20,7 @@ class AssignedAddOnExtensionList < ListResource # Initialize the AssignedAddOnExtensionList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # resource. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. @@ -170,7 +170,7 @@ class AssignedAddOnExtensionContext < InstanceContext # Initialize the AssignedAddOnExtensionContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the resource + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the resource # to fetch. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. @@ -231,7 +231,7 @@ class AssignedAddOnExtensionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # resource. # @param [String] resource_sid The SID of the Phone Number to which the Add-on is # assigned. diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb index b1b0b0c70..e62c518f2 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb @@ -17,7 +17,7 @@ class LocalList < ListResource # Initialize the LocalList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [LocalList] LocalList def initialize(version, account_sid: nil) @@ -155,7 +155,7 @@ def get_page(target_url) ## # Create the LocalInstance # @param [String] phone_number The phone number to purchase specified in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone # numbers consist of a + followed by the country code and subscriber number # without punctuation characters. For example, +14155551234. # @param [String] api_version The API version to use for incoming calls made to @@ -292,7 +292,7 @@ class LocalInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [LocalInstance] LocalInstance def initialize(version, payload, account_sid: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb index b35eafa0a..b36b52637 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb @@ -17,7 +17,7 @@ class MobileList < ListResource # Initialize the MobileList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [MobileList] MobileList def initialize(version, account_sid: nil) @@ -155,7 +155,7 @@ def get_page(target_url) ## # Create the MobileInstance # @param [String] phone_number The phone number to purchase specified in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone # numbers consist of a + followed by the country code and subscriber number # without punctuation characters. For example, +14155551234. # @param [String] api_version The API version to use for incoming calls made to @@ -291,7 +291,7 @@ class MobileInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [MobileInstance] MobileInstance def initialize(version, payload, account_sid: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb index 9a8aff5c6..7cce9a508 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb @@ -17,7 +17,7 @@ class TollFreeList < ListResource # Initialize the TollFreeList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [TollFreeList] TollFreeList def initialize(version, account_sid: nil) @@ -155,7 +155,7 @@ def get_page(target_url) ## # Create the TollFreeInstance # @param [String] phone_number The phone number to purchase specified in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone # numbers consist of a + followed by the country code and subscriber number # without punctuation characters. For example, +14155551234. # @param [String] api_version The API version to use for incoming calls made to @@ -291,7 +291,7 @@ class TollFreeInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # IncomingPhoneNumber resource. # @return [TollFreeInstance] TollFreeInstance def initialize(version, payload, account_sid: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/key.rb b/lib/twilio-ruby/rest/api/v2010/account/key.rb index 4472ae006..46e4cb220 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/key.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/key.rb @@ -147,7 +147,7 @@ class KeyContext < InstanceContext # Initialize the KeyContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Key + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Key # resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the Key # resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/message.rb b/lib/twilio-ruby/rest/api/v2010/account/message.rb index 9c36bed04..1e603bfaa 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/message.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/message.rb @@ -16,7 +16,7 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that sent the message + # {Account}[https://www.twilio.com/docs/iam/api/account] that sent the message # that created the resource. # @return [MessageList] MessageList def initialize(version, account_sid: nil) @@ -30,24 +30,24 @@ def initialize(version, account_sid: nil) ## # Create the MessageInstance # @param [String] to The destination phone number in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or - # [Channel user - # address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format for SMS/MMS or + # {Channel user + # address}[https://www.twilio.com/docs/sms/channels#channel-addresses] for other # 3rd-party channels. # @param [String] status_callback The URL we should call using the # `status_callback_method` to send status information to your application. If # specified, we POST these message status changes to the URL: `queued`, `failed`, - # `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request - # parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as + # `sent`, `delivered`, or `undelivered`. Twilio will POST its {standard request + # parameters}[https://www.twilio.com/docs/sms/twiml#request-parameters] as well as # some additional parameters including `MessageSid`, `MessageStatus`, and # `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we - # use this URL instead of the Status Callback URL of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a + # use this URL instead of the Status Callback URL of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api]. URLs must contain a # valid hostname and underscores are not allowed. # @param [String] application_sid The SID of the application that should receive # message status. We POST a `message_sid` parameter and a `message_status` # parameter with a value of `sent` or `failed` to the - # [application](https://www.twilio.com/docs/usage/api/applications)'s + # {application}[https://www.twilio.com/docs/usage/api/applications]'s # `message_status_callback`. If a `status_callback` parameter is also passed, it # will be ignored and the application's `message_status_callback` parameter will # be used. @@ -59,8 +59,8 @@ def initialize(version, account_sid: nil) # is not set, the message cost is not checked. # @param [Boolean] provide_feedback Whether to confirm delivery of the message. # Set this value to `true` if you are sending messages that have a trackable user - # action and you intend to confirm delivery of the message using the [Message - # Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). + # action and you intend to confirm delivery of the message using the {Message + # Feedback API}[https://www.twilio.com/docs/sms/api/message-feedback-resource]. # This parameter is `false` by default. # @param [String] attempt Total number of attempts made ( including this ) to send # out the message regardless of the provider used @@ -79,21 +79,21 @@ def initialize(version, account_sid: nil) # similar GSM-7 character and replace them. Can be: `true` or `false`. # @param [String] persistent_action Rich actions for Channels Messages. # @param [String] from A Twilio phone number in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, an {alphanumeric # sender - # ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), - # or a [Channel Endpoint - # address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is - # enabled for the type of message you want to send. Phone numbers or [short - # codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio + # ID}[https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id], + # or a {Channel Endpoint + # address}[https://www.twilio.com/docs/sms/channels#channel-addresses] that is + # enabled for the type of message you want to send. Phone numbers or {short + # codes}[https://www.twilio.com/docs/sms/api/short-code] purchased from Twilio # also work here. You cannot, for example, spoof messages from a private cell # phone number. If you are using `messaging_service_sid`, this parameter must be # empty. - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) - # you want to associate with the Message. Set this parameter to use the [Messaging + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services#send-a-message-with-copilot] + # you want to associate with the Message. Set this parameter to use the {Messaging # Service Settings and Copilot - # Features](https://www.twilio.com/console/sms/services) you have configured and + # Features}[https://www.twilio.com/console/sms/services] you have configured and # leave the `from` parameter empty. When only this parameter is set, Twilio will # use your enabled Copilot Features to select the `from` phone number for # delivery. @@ -102,8 +102,8 @@ def initialize(version, account_sid: nil) # @param [String] media_url The URL of the media to send with the message. The # media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on # the recipient's device. The media size limit is 5MB for supported file types - # (JPEG, PNG, GIF) and 500KB for [other - # types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. + # (JPEG, PNG, GIF) and 500KB for {other + # types}[https://www.twilio.com/docs/sms/accepted-mime-types] of accepted media. # To send more than one image in the message body, provide multiple `media_url` # parameters in the POST request. You can include up to 10 `media_url` parameters # per message. You can send images in an SMS message in only the US and Canada. @@ -292,7 +292,7 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Message + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Message # resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. @@ -393,7 +393,7 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that sent the message + # {Account}[https://www.twilio.com/docs/iam/api/account] that sent the message # that created the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb b/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb index 1df68add5..628f8d922 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb @@ -17,7 +17,7 @@ class FeedbackList < ListResource # Initialize the FeedbackList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # MessageFeedback resource. # @param [String] message_sid The SID of the Message resource for which the # feedback was provided. @@ -33,8 +33,8 @@ def initialize(version, account_sid: nil, message_sid: nil) ## # Create the FeedbackInstance # @param [feedback.Outcome] outcome Whether the feedback has arrived. Can be: - # `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP - # POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), + # `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in {the initial HTTP + # POST}[https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource], # the initial value of this property is `unconfirmed`. After the message arrives, # update the value to `confirmed`. # @return [FeedbackInstance] Created FeedbackInstance @@ -98,7 +98,7 @@ class FeedbackInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # MessageFeedback resource. # @param [String] message_sid The SID of the Message resource for which the # feedback was provided. diff --git a/lib/twilio-ruby/rest/api/v2010/account/message/media.rb b/lib/twilio-ruby/rest/api/v2010/account/message/media.rb index 3fc6ec0e9..bc47a22d9 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/message/media.rb @@ -17,7 +17,7 @@ class MediaList < ListResource # Initialize the MediaList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Media + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Media # resource. # @param [String] message_sid The unique string that that we created to identify # the Message resource. @@ -179,7 +179,7 @@ class MediaContext < InstanceContext # Initialize the MediaContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Media + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Media # resource(s) to fetch. # @param [String] message_sid The SID of the Message resource that this Media # resource belongs to. @@ -237,7 +237,7 @@ class MediaInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Media + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Media # resource. # @param [String] message_sid The unique string that that we created to identify # the Message resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/notification.rb b/lib/twilio-ruby/rest/api/v2010/account/notification.rb index 55fd0831f..9eb0aa72e 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/notification.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/notification.rb @@ -16,7 +16,7 @@ class NotificationList < ListResource # Initialize the NotificationList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Notification resource. # @return [NotificationList] NotificationList def initialize(version, account_sid: nil) @@ -183,7 +183,7 @@ class NotificationContext < InstanceContext # Initialize the NotificationContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Notification resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Notification resource to fetch. @@ -231,7 +231,7 @@ class NotificationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Notification resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Notification resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb b/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb index 682a42baa..1c148b865 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb @@ -16,7 +16,7 @@ class OutgoingCallerIdList < ListResource # Initialize the OutgoingCallerIdList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # OutgoingCallerId resource. # @return [OutgoingCallerIdList] OutgoingCallerIdList def initialize(version, account_sid: nil) @@ -171,7 +171,7 @@ class OutgoingCallerIdContext < InstanceContext # Initialize the OutgoingCallerIdContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # OutgoingCallerId resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # OutgoingCallerId resource to fetch. @@ -244,7 +244,7 @@ class OutgoingCallerIdInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # OutgoingCallerId resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # OutgoingCallerId resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/queue.rb b/lib/twilio-ruby/rest/api/v2010/account/queue.rb index 5d93cca2b..474aab27b 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/queue.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/queue.rb @@ -16,7 +16,7 @@ class QueueList < ListResource # Initialize the QueueList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue # resource. # @return [QueueList] QueueList def initialize(version, account_sid: nil) @@ -163,7 +163,7 @@ class QueueContext < InstanceContext # Initialize the QueueContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Queue # resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Queue resource to fetch @@ -253,7 +253,7 @@ class QueueInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue # resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Queue resource to fetch diff --git a/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb b/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb index a09654537..c39b8bbe9 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb @@ -17,7 +17,7 @@ class MemberList < ListResource # Initialize the MemberList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue # resource. # @param [String] queue_sid The SID of the Queue the member is in. # @return [MemberList] MemberList @@ -155,12 +155,12 @@ class MemberContext < InstanceContext # Initialize the MemberContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Member + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Member # resource(s) to fetch. # @param [String] queue_sid The SID of the Queue in which to find the members to # fetch. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the # resource(s) to fetch. # @return [MemberContext] MemberContext def initialize(version, account_sid, queue_sid, call_sid) @@ -228,11 +228,11 @@ class MemberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue # resource. # @param [String] queue_sid The SID of the Queue the member is in. # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the # resource(s) to fetch. # @return [MemberInstance] MemberInstance def initialize(version, payload, account_sid: nil, queue_sid: nil, call_sid: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/recording.rb b/lib/twilio-ruby/rest/api/v2010/account/recording.rb index aa545a8a2..b7588b090 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/recording.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/recording.rb @@ -16,7 +16,7 @@ class RecordingList < ListResource # Initialize the RecordingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource. # @return [RecordingList] RecordingList def initialize(version, account_sid: nil) @@ -35,7 +35,7 @@ def initialize(version, account_sid: nil) # @param [Time] date_created Only include recordings that were created on this date # @param [Time] date_created_after Only include recordings that were created on this date # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources # to read. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording to read. @@ -66,7 +66,7 @@ def list(date_created_before: :unset, date_created: :unset, date_created_after: # @param [Time] date_created Only include recordings that were created on this date # @param [Time] date_created_after Only include recordings that were created on this date # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources # to read. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording to read. @@ -113,7 +113,7 @@ def each # @param [Time] date_created Only include recordings that were created on this date # @param [Time] date_created_after Only include recordings that were created on this date # @param [String] call_sid The - # [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources + # {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources # to read. # @param [String] conference_sid The Conference SID that identifies the conference # associated with the recording to read. @@ -192,7 +192,7 @@ class RecordingContext < InstanceContext # Initialize the RecordingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Recording resource to fetch. @@ -290,7 +290,7 @@ class RecordingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Recording resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb b/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb index f9882d76c..0c75a9eae 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb @@ -17,7 +17,7 @@ class AddOnResultList < ListResource # Initialize the AddOnResultList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult resource. # @param [String] reference_sid The SID of the recording to which the AddOnResult # resource belongs. @@ -156,7 +156,7 @@ class AddOnResultContext < InstanceContext # Initialize the AddOnResultContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult resource to fetch. # @param [String] reference_sid The SID of the recording to which the result to # fetch belongs. @@ -246,7 +246,7 @@ class AddOnResultInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult resource. # @param [String] reference_sid The SID of the recording to which the AddOnResult # resource belongs. diff --git a/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb b/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb index 6d563137a..a7f72887a 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb @@ -18,7 +18,7 @@ class PayloadList < ListResource # Initialize the PayloadList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult Payload resource. # @param [String] reference_sid The SID of the recording to which the AddOnResult # resource that contains the payload belongs. @@ -164,7 +164,7 @@ class PayloadContext < InstanceContext # Initialize the PayloadContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult Payload resource to fetch. # @param [String] reference_sid The SID of the recording to which the AddOnResult # resource that contains the payload to fetch belongs. @@ -230,7 +230,7 @@ class PayloadInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Recording AddOnResult Payload resource. # @param [String] reference_sid The SID of the recording to which the AddOnResult # resource that contains the payload belongs. diff --git a/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb b/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb index 5d51f86df..b7eac3e6d 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb @@ -17,10 +17,10 @@ class TranscriptionList < ListResource # Initialize the TranscriptionList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource. # @param [String] recording_sid The SID of the - # [Recording](https://www.twilio.com/docs/voice/api/recording) from which the + # {Recording}[https://www.twilio.com/docs/voice/api/recording] from which the # transcription was created. # @return [TranscriptionList] TranscriptionList def initialize(version, account_sid: nil, recording_sid: nil) @@ -157,10 +157,10 @@ class TranscriptionContext < InstanceContext # Initialize the TranscriptionContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource to fetch. # @param [String] recording_sid The SID of the - # [Recording](https://www.twilio.com/docs/voice/api/recording) that created the + # {Recording}[https://www.twilio.com/docs/voice/api/recording] that created the # transcription to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Transcription resource to fetch. @@ -216,10 +216,10 @@ class TranscriptionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource. # @param [String] recording_sid The SID of the - # [Recording](https://www.twilio.com/docs/voice/api/recording) from which the + # {Recording}[https://www.twilio.com/docs/voice/api/recording] from which the # transcription was created. # @param [String] sid The Twilio-provided string that uniquely identifies the # Transcription resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/short_code.rb b/lib/twilio-ruby/rest/api/v2010/account/short_code.rb index 2942a2f93..a7b950713 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/short_code.rb @@ -16,7 +16,7 @@ class ShortCodeList < ListResource # Initialize the ShortCodeList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # ShortCode resource. # @return [ShortCodeList] ShortCodeList def initialize(version, account_sid: nil) @@ -174,7 +174,7 @@ class ShortCodeContext < InstanceContext # Initialize the ShortCodeContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # ShortCode resource(s) to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # ShortCode resource to fetch @@ -248,7 +248,7 @@ class ShortCodeInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created this + # {Account}[https://www.twilio.com/docs/iam/api/account] that created this # ShortCode resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # ShortCode resource to fetch diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb index 6cb1e976e..8986a2a65 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb @@ -202,7 +202,7 @@ class DomainContext < InstanceContext # Initialize the DomainContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # SipDomain resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb index caa9ae826..832a842ed 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb @@ -18,7 +18,7 @@ class AuthTypesList < ListResource # Initialize the AuthTypesList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -105,7 +105,7 @@ class AuthTypesInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb index ef7190dd8..1317e12c5 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb @@ -19,7 +19,7 @@ class AuthTypeCallsList < ListResource # Initialize the AuthTypeCallsList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -132,7 +132,7 @@ class AuthTypeCallsInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb index bc13ca6e2..44b2c8de4 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb @@ -20,7 +20,7 @@ class AuthCallsCredentialListMappingList < ListResource # Initialize the AuthCallsCredentialListMappingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -177,7 +177,7 @@ class AuthCallsCredentialListMappingContext < InstanceContext # Initialize the AuthCallsCredentialListMappingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # CredentialListMapping resource to fetch. # @param [String] domain_sid The SID of the SIP domain that contains the resource # to fetch. @@ -235,7 +235,7 @@ class AuthCallsCredentialListMappingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb index 15544a768..750988eb8 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb @@ -20,7 +20,7 @@ class AuthCallsIpAccessControlListMappingList < ListResource # Initialize the AuthCallsIpAccessControlListMappingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -177,7 +177,7 @@ class AuthCallsIpAccessControlListMappingContext < InstanceContext # Initialize the AuthCallsIpAccessControlListMappingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # IpAccessControlListMapping resource to fetch. # @param [String] domain_sid The SID of the SIP domain that contains the resource # to fetch. @@ -235,7 +235,7 @@ class AuthCallsIpAccessControlListMappingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb index e73d50339..ca102d347 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb @@ -19,7 +19,7 @@ class AuthTypeRegistrationsList < ListResource # Initialize the AuthTypeRegistrationsList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -106,7 +106,7 @@ class AuthTypeRegistrationsInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb index 1e9c02fe8..c9a3415e6 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb @@ -20,7 +20,7 @@ class AuthRegistrationsCredentialListMappingList < ListResource # Initialize the AuthRegistrationsCredentialListMappingList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. @@ -177,7 +177,7 @@ class AuthRegistrationsCredentialListMappingContext < InstanceContext # Initialize the AuthRegistrationsCredentialListMappingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # CredentialListMapping resource to fetch. # @param [String] domain_sid The SID of the SIP domain that contains the resource # to fetch. @@ -235,7 +235,7 @@ class AuthRegistrationsCredentialListMappingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # SipDomain resource. # @param [String] domain_sid The unique string that that we created to identify # the SipDomain resource. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb index fc88bfe92..98ce5b706 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb @@ -174,7 +174,7 @@ class CredentialListMappingContext < InstanceContext # Initialize the CredentialListMappingContext # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] domain_sid A 34 character string that uniquely identifies the # SIP Domain that includes the resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb index 7a0c70014..60c1bce46 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb @@ -161,7 +161,7 @@ class IpAccessControlListContext < InstanceContext # Initialize the IpAccessControlListContext # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] sid A 34 character string that uniquely identifies the resource # to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb b/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb index c8b3762b8..1bdece8ad 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb @@ -184,7 +184,7 @@ class IpAddressContext < InstanceContext # Initialize the IpAddressContext # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this # resource. # @param [String] ip_access_control_list_sid The IpAccessControlList Sid that # identifies the IpAddress resources to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/token.rb b/lib/twilio-ruby/rest/api/v2010/account/token.rb index f0135f5e4..bed55e0d0 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/token.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/token.rb @@ -16,7 +16,7 @@ class TokenList < ListResource # Initialize the TokenList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Token + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token # resource. # @return [TokenList] TokenList def initialize(version, account_sid: nil) @@ -82,7 +82,7 @@ class TokenInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the Token + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token # resource. # @return [TokenInstance] TokenInstance def initialize(version, payload, account_sid: nil) diff --git a/lib/twilio-ruby/rest/api/v2010/account/transcription.rb b/lib/twilio-ruby/rest/api/v2010/account/transcription.rb index 4135acef1..e0aed01fa 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/transcription.rb @@ -16,7 +16,7 @@ class TranscriptionList < ListResource # Initialize the TranscriptionList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource. # @return [TranscriptionList] TranscriptionList def initialize(version, account_sid: nil) @@ -148,7 +148,7 @@ class TranscriptionContext < InstanceContext # Initialize the TranscriptionContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Transcription resource to fetch. @@ -203,7 +203,7 @@ class TranscriptionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # Transcription resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Transcription resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb index 738e6f388..c1851173c 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb @@ -41,8 +41,8 @@ def initialize(version, account_sid: nil) # Lists RecordInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [record.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [record.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -79,8 +79,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams RecordInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [record.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [record.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -133,8 +133,8 @@ def each ## # Retrieve a single page of RecordInstance records from the API. # Request is executed immediately. - # @param [record.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [record.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb index 1951470d8..b6065ac3d 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists AllTimeInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [all_time.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [all_time.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams AllTimeInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [all_time.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [all_time.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of AllTimeInstance records from the API. # Request is executed immediately. - # @param [all_time.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [all_time.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb index 71251694f..c9e7ae911 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists DailyInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [daily.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [daily.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams DailyInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [daily.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [daily.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of DailyInstance records from the API. # Request is executed immediately. - # @param [daily.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [daily.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb index 2453d96d6..abca26c4c 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists LastMonthInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [last_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [last_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams LastMonthInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [last_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [last_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of LastMonthInstance records from the API. # Request is executed immediately. - # @param [last_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [last_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb index fcd5912da..3989dcacd 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists MonthlyInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [monthly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [monthly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams MonthlyInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [monthly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [monthly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of MonthlyInstance records from the API. # Request is executed immediately. - # @param [monthly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [monthly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb index 94570f3da..5caa962f8 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists ThisMonthInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [this_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [this_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams ThisMonthInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [this_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [this_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of ThisMonthInstance records from the API. # Request is executed immediately. - # @param [this_month.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [this_month.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb index f0df8a82a..c086d242c 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists TodayInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [today.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [today.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams TodayInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [today.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [today.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of TodayInstance records from the API. # Request is executed immediately. - # @param [today.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [today.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb index 22d150d8b..96e287ee6 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists YearlyInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [yearly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yearly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams YearlyInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [yearly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yearly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of YearlyInstance records from the API. # Request is executed immediately. - # @param [yearly.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yearly.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb index 358a0c8c6..291d02ebe 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb @@ -32,8 +32,8 @@ def initialize(version, account_sid: nil) # Lists YesterdayInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [yesterday.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yesterday.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -70,8 +70,8 @@ def list(category: :unset, start_date: :unset, end_date: :unset, include_subacco # Streams YesterdayInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [yesterday.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yesterday.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this @@ -124,8 +124,8 @@ def each ## # Retrieve a single page of YesterdayInstance records from the API. # Request is executed immediately. - # @param [yesterday.Category] category The [usage - # category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # @param [yesterday.Category] category The {usage + # category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # of the UsageRecord resources to read. Only UsageRecord resources in the # specified category are retrieved. # @param [Date] start_date Only include usage that has occurred on or after this diff --git a/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb b/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb index aa6ea8305..3c4fb8657 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb @@ -36,8 +36,8 @@ def initialize(version, account_sid: nil) # trigger_value that is 30 units more than the current usage value. Be sure to # urlencode a `+` as `%2B`. # @param [trigger.UsageCategory] usage_category The usage category that the - # trigger should watch. Use one of the supported [usage - # categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) + # trigger should watch. Use one of the supported {usage + # categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories] # for this value. # @param [String] callback_method The HTTP method we should use to call # `callback_url`. Can be: `GET` or `POST` and the default is `POST`. @@ -48,10 +48,10 @@ def initialize(version, account_sid: nil) # non-recurring triggers. A trigger will only fire once during each period. # Recurring times are in GMT. # @param [trigger.TriggerField] trigger_by The field in the - # [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that + # {UsageRecord}[https://www.twilio.com/docs/usage/api/usage-record] resource that # should fire the trigger. Can be: `count`, `usage`, or `price` as described in - # the [UsageRecords - # documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). + # the {UsageRecords + # documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price]. # The default is `usage`. # @return [TriggerInstance] Created TriggerInstance def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset) @@ -78,11 +78,11 @@ def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_ # read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. # An empty value or a value of `alltime` reads non-recurring UsageTriggers. # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers - # to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords - # documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). + # to read. Can be: `count`, `usage`, or `price` as described in the {UsageRecords + # documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price]. # @param [trigger.UsageCategory] usage_category The usage category of the - # UsageTriggers to read. Must be a supported [usage - # categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). + # UsageTriggers to read. Must be a supported {usage + # categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -108,11 +108,11 @@ def list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: n # read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. # An empty value or a value of `alltime` reads non-recurring UsageTriggers. # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers - # to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords - # documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). + # to read. Can be: `count`, `usage`, or `price` as described in the {UsageRecords + # documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price]. # @param [trigger.UsageCategory] usage_category The usage category of the - # UsageTriggers to read. Must be a supported [usage - # categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). + # UsageTriggers to read. Must be a supported {usage + # categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -154,11 +154,11 @@ def each # read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. # An empty value or a value of `alltime` reads non-recurring UsageTriggers. # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers - # to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords - # documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). + # to read. Can be: `count`, `usage`, or `price` as described in the {UsageRecords + # documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price]. # @param [trigger.UsageCategory] usage_category The usage category of the - # UsageTriggers to read. Must be a supported [usage - # categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). + # UsageTriggers to read. Must be a supported {usage + # categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -232,7 +232,7 @@ class TriggerContext < InstanceContext # Initialize the TriggerContext # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) that created the + # {Account}[https://www.twilio.com/docs/iam/api/account] that created the # UsageTrigger resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # UsageTrigger resource to fetch. diff --git a/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb b/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb index 8fce135ee..c34c5e6bf 100644 --- a/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +++ b/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb @@ -16,7 +16,7 @@ class ValidationRequestList < ListResource # Initialize the ValidationRequestList # @param [Version] version Version that contains the resource # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for the + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for the # Caller ID. # @return [ValidationRequestList] ValidationRequestList def initialize(version, account_sid: nil) @@ -30,7 +30,7 @@ def initialize(version, account_sid: nil) ## # Create the ValidationRequestInstance # @param [String] phone_number The phone number to verify in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists # of a + followed by the country code and subscriber number. # @param [String] friendly_name A descriptive string that you create to describe # the new caller ID resource. It can be up to 64 characters long. The default @@ -103,7 +103,7 @@ class ValidationRequestInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) responsible for the + # {Account}[https://www.twilio.com/docs/iam/api/account] responsible for the # Caller ID. # @return [ValidationRequestInstance] ValidationRequestInstance def initialize(version, payload, account_sid: nil) diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant.rb index f45e457fb..81e2cb9ae 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant.rb @@ -117,10 +117,10 @@ def get_page(target_url) # the URL path to address the resource. The first 64 characters must be unique. # @param [String] callback_url Reserved. # @param [String] callback_events Reserved. - # @param [Hash] style_sheet The JSON string that defines the Assistant's [style - # sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) - # @param [Hash] defaults A JSON object that defines the Assistant's [default - # tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various + # @param [Hash] style_sheet The JSON string that defines the Assistant's {style + # sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet] + # @param [Hash] defaults A JSON object that defines the Assistant's {default + # tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various # scenarios, including initiation actions and fallback tasks. # @return [AssistantInstance] Created AssistantInstance def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset) @@ -225,10 +225,10 @@ def fetch # URL path to address the resource. The first 64 characters must be unique. # @param [String] callback_url Reserved. # @param [String] callback_events Reserved. - # @param [Hash] style_sheet The JSON string that defines the Assistant's [style - # sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) - # @param [Hash] defaults A JSON object that defines the Assistant's [default - # tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various + # @param [Hash] style_sheet The JSON string that defines the Assistant's {style + # sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet] + # @param [Hash] defaults A JSON object that defines the Assistant's {default + # tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various # scenarios, including initiation actions and fallback tasks. # @param [String] development_stage A string describing the state of the # assistant. @@ -546,10 +546,10 @@ def fetch # URL path to address the resource. The first 64 characters must be unique. # @param [String] callback_url Reserved. # @param [String] callback_events Reserved. - # @param [Hash] style_sheet The JSON string that defines the Assistant's [style - # sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) - # @param [Hash] defaults A JSON object that defines the Assistant's [default - # tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various + # @param [Hash] style_sheet The JSON string that defines the Assistant's {style + # sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet] + # @param [Hash] defaults A JSON object that defines the Assistant's {default + # tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various # scenarios, including initiation actions and fallback tasks. # @param [String] development_stage A string describing the state of the # assistant. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb index 065534c1d..8ad75d04a 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb @@ -18,7 +18,7 @@ class DefaultsList < ListResource # Initialize the DefaultsList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [DefaultsList] DefaultsList def initialize(version, assistant_sid: nil) @@ -73,7 +73,7 @@ class DefaultsContext < InstanceContext # Initialize the DefaultsContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @return [DefaultsContext] DefaultsContext def initialize(version, assistant_sid) @@ -129,7 +129,7 @@ class DefaultsInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [DefaultsInstance] DefaultsInstance def initialize(version, payload, assistant_sid: nil) diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb index 1ec778fc2..9b113483b 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb @@ -18,7 +18,7 @@ class DialogueList < ListResource # Initialize the DialogueList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [DialogueList] DialogueList def initialize(version, assistant_sid: nil) @@ -73,7 +73,7 @@ class DialogueContext < InstanceContext # Initialize the DialogueContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Dialogue resource to fetch. @@ -123,7 +123,7 @@ class DialogueInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Dialogue resource to fetch. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb index 3b11d1db8..7b1d95752 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb @@ -18,7 +18,7 @@ class FieldTypeList < ListResource # Initialize the FieldTypeList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [FieldTypeList] FieldTypeList def initialize(version, assistant_sid: nil) @@ -170,7 +170,7 @@ class FieldTypeContext < InstanceContext # Initialize the FieldTypeContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # FieldType resource to fetch. @@ -273,7 +273,7 @@ class FieldTypeInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # FieldType resource to fetch. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb index 4a1dec9a4..97b3b0d3a 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb @@ -19,7 +19,7 @@ class FieldValueList < ListResource # Initialize the FieldValueList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the FieldType associated with the resource. # @param [String] field_type_sid The SID of the Field Type associated with the # Field Value. @@ -36,8 +36,8 @@ def initialize(version, assistant_sid: nil, field_type_sid: nil) # Lists FieldValueInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # tag that specifies the language of the value. Currently supported tags: `en-US` # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -54,8 +54,8 @@ def list(language: :unset, limit: nil, page_size: nil) # Streams FieldValueInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # tag that specifies the language of the value. Currently supported tags: `en-US` # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -89,8 +89,8 @@ def each ## # Retrieve a single page of FieldValueInstance records from the API. # Request is executed immediately. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # tag that specifies the language of the value. Currently supported tags: `en-US` # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -124,8 +124,8 @@ def get_page(target_url) ## # Create the FieldValueInstance - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # tag that specifies the language of the value. Currently supported tags: `en-US` # @param [String] value The Field Value data. # @param [String] synonym_of The string value that indicates which word the field @@ -194,7 +194,7 @@ class FieldValueContext < InstanceContext # Initialize the FieldValueContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the FieldType associated with the resource to fetch. # @param [String] field_type_sid The SID of the Field Type associated with the # Field Value to fetch. @@ -254,7 +254,7 @@ class FieldValueInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the FieldType associated with the resource. # @param [String] field_type_sid The SID of the Field Type associated with the # Field Value. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb index d9b617b72..462a67c86 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb @@ -18,7 +18,7 @@ class ModelBuildList < ListResource # Initialize the ModelBuildList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [ModelBuildList] ModelBuildList def initialize(version, assistant_sid: nil) @@ -171,7 +171,7 @@ class ModelBuildContext < InstanceContext # Initialize the ModelBuildContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # ModelBuild resource to fetch. @@ -248,7 +248,7 @@ class ModelBuildInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # ModelBuild resource to fetch. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb index 1d4e5efe4..a49daef8c 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb @@ -18,7 +18,7 @@ class QueryList < ListResource # Initialize the QueryList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [QueryList] QueryList def initialize(version, assistant_sid: nil) @@ -33,16 +33,16 @@ def initialize(version, assistant_sid: nil) # Lists QueryInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used by the Query resources to read. For # example: `en-US`. - # @param [String] model_build The SID or unique name of the [Model - # Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. + # @param [String] model_build The SID or unique name of the {Model + # Build}[https://www.twilio.com/docs/autopilot/api/model-build] to be queried. # @param [String] status The status of the resources to read. Can be: # `pending-review`, `reviewed`, or `discarded` # @param [String] dialogue_sid The SID of the - # [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + # {Dialogue}[https://www.twilio.com/docs/autopilot/api/dialogue]. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -65,16 +65,16 @@ def list(language: :unset, model_build: :unset, status: :unset, dialogue_sid: :u # Streams QueryInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used by the Query resources to read. For # example: `en-US`. - # @param [String] model_build The SID or unique name of the [Model - # Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. + # @param [String] model_build The SID or unique name of the {Model + # Build}[https://www.twilio.com/docs/autopilot/api/model-build] to be queried. # @param [String] status The status of the resources to read. Can be: # `pending-review`, `reviewed`, or `discarded` # @param [String] dialogue_sid The SID of the - # [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + # {Dialogue}[https://www.twilio.com/docs/autopilot/api/dialogue]. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -113,16 +113,16 @@ def each ## # Retrieve a single page of QueryInstance records from the API. # Request is executed immediately. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used by the Query resources to read. For # example: `en-US`. - # @param [String] model_build The SID or unique name of the [Model - # Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. + # @param [String] model_build The SID or unique name of the {Model + # Build}[https://www.twilio.com/docs/autopilot/api/model-build] to be queried. # @param [String] status The status of the resources to read. Can be: # `pending-review`, `reviewed`, or `discarded` # @param [String] dialogue_sid The SID of the - # [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + # {Dialogue}[https://www.twilio.com/docs/autopilot/api/dialogue]. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -158,8 +158,8 @@ def get_page(target_url) ## # Create the QueryInstance - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the new query. For example: `en-US`. # @param [String] query The end-user's natural language input. It can be up to # 2048 characters long. @@ -167,8 +167,8 @@ def get_page(target_url) # expressed as a comma-separated list of task `unique_name` values. For example, # `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to # constrain the paths that a user can take. - # @param [String] model_build The SID or unique name of the [Model - # Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. + # @param [String] model_build The SID or unique name of the {Model + # Build}[https://www.twilio.com/docs/autopilot/api/model-build] to be queried. # @return [QueryInstance] Created QueryInstance def create(language: nil, query: nil, tasks: :unset, model_build: :unset) data = Twilio::Values.of({ @@ -228,7 +228,7 @@ class QueryContext < InstanceContext # Initialize the QueryContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Query resource to fetch. @@ -253,7 +253,7 @@ def fetch ## # Update the QueryInstance # @param [String] sample_sid The SID of an optional reference to the - # [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the + # {Sample}[https://www.twilio.com/docs/autopilot/api/task-sample] created from the # query. # @param [String] status The new status of the resource. Can be: `pending-review`, # `reviewed`, or `discarded` @@ -296,7 +296,7 @@ class QueryInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Query resource to fetch. @@ -369,7 +369,7 @@ def language end ## - # @return [String] The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried + # @return [String] The SID of the {Model Build}[https://www.twilio.com/docs/autopilot/api/model-build] queried def model_build_sid @properties['model_build_sid'] end @@ -417,7 +417,7 @@ def source_channel end ## - # @return [String] The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + # @return [String] The SID of the {Dialogue}[https://www.twilio.com/docs/autopilot/api/dialogue]. def dialogue_sid @properties['dialogue_sid'] end @@ -432,7 +432,7 @@ def fetch ## # Update the QueryInstance # @param [String] sample_sid The SID of an optional reference to the - # [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the + # {Sample}[https://www.twilio.com/docs/autopilot/api/task-sample] created from the # query. # @param [String] status The new status of the resource. Can be: `pending-review`, # `reviewed`, or `discarded` diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb index 0d41e3323..1905a1dd7 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb @@ -18,7 +18,7 @@ class StyleSheetList < ListResource # Initialize the StyleSheetList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [StyleSheetList] StyleSheetList def initialize(version, assistant_sid: nil) @@ -73,7 +73,7 @@ class StyleSheetContext < InstanceContext # Initialize the StyleSheetContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @return [StyleSheetContext] StyleSheetContext def initialize(version, assistant_sid) @@ -128,7 +128,7 @@ class StyleSheetInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [StyleSheetInstance] StyleSheetInstance def initialize(version, payload, assistant_sid: nil) diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb index d984d2551..da52ece9b 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb @@ -18,7 +18,7 @@ class TaskList < ListResource # Initialize the TaskList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [TaskList] TaskList def initialize(version, assistant_sid: nil) @@ -118,7 +118,7 @@ def get_page(target_url) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It is not unique and can be up to 255 characters long. # @param [Hash] actions The JSON string that specifies the - # [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the + # {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the # Assistant on how to perform the task. It is optional and not unique. # @param [String] actions_url The URL from which the Assistant can fetch actions. # @return [TaskInstance] Created TaskInstance @@ -180,7 +180,7 @@ class TaskContext < InstanceContext # Initialize the TaskContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the Task # resource to fetch. @@ -217,7 +217,7 @@ def fetch # be unique. It can be used as an alternative to the `sid` in the URL path to # address the resource. # @param [Hash] actions The JSON string that specifies the - # [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the + # {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the # Assistant on how to perform the task. # @param [String] actions_url The URL from which the Assistant can fetch actions. # @return [TaskInstance] Updated TaskInstance @@ -324,7 +324,7 @@ class TaskInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the Task # resource to fetch. @@ -438,7 +438,7 @@ def fetch # be unique. It can be used as an alternative to the `sid` in the URL path to # address the resource. # @param [Hash] actions The JSON string that specifies the - # [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the + # {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the # Assistant on how to perform the task. # @param [String] actions_url The URL from which the Assistant can fetch actions. # @return [TaskInstance] Updated TaskInstance diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb index 4141bf560..a80658609 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb @@ -19,10 +19,10 @@ class FieldList < ListResource # Initialize the FieldList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with + # {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with # this Field. # @return [FieldList] FieldList def initialize(version, assistant_sid: nil, task_sid: nil) @@ -115,8 +115,8 @@ def get_page(target_url) ## # Create the FieldInstance - # @param [String] field_type The Field Type of the new field. Can be: a [Built-in - # Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the + # @param [String] field_type The Field Type of the new field. Can be: a {Built-in + # Field Type}[https://www.twilio.com/docs/autopilot/built-in-field-types], the # `unique_name`, or the `sid` of a custom Field Type. # @param [String] unique_name An application-defined string that uniquely # identifies the new resource. This value must be a unique string of no more than @@ -186,10 +186,10 @@ class FieldContext < InstanceContext # Initialize the FieldContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource to fetch. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with + # {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with # the Field resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Field resource to fetch. @@ -247,10 +247,10 @@ class FieldInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with + # {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with # this Field. # @param [String] sid The Twilio-provided string that uniquely identifies the # Field resource to fetch. @@ -321,7 +321,7 @@ def field_type end ## - # @return [String] The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field + # @return [String] The SID of the {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with this Field def task_sid @properties['task_sid'] end diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb index 4aafd8206..21d901274 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb @@ -19,10 +19,10 @@ class SampleList < ListResource # Initialize the SampleList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the + # {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the # resource. # @return [SampleList] SampleList def initialize(version, assistant_sid: nil, task_sid: nil) @@ -37,8 +37,8 @@ def initialize(version, assistant_sid: nil, task_sid: nil) # Lists SampleInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the sample. For example: `en-US`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -55,8 +55,8 @@ def list(language: :unset, limit: nil, page_size: nil) # Streams SampleInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the sample. For example: `en-US`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -90,8 +90,8 @@ def each ## # Retrieve a single page of SampleInstance records from the API. # Request is executed immediately. - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the sample. For example: `en-US`. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -125,13 +125,13 @@ def get_page(target_url) ## # Create the SampleInstance - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the new sample. For example: # `en-US`. # @param [String] tagged_text The text example of how end users might express the - # task. The sample can contain [Field tag - # blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + # task. The sample can contain {Field tag + # blocks}[https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging]. # @param [String] source_channel The communication channel from which the new # sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, # `google-assistant`, `slack`, or null if not included. @@ -203,10 +203,10 @@ class SampleContext < InstanceContext # Initialize the SampleContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource to fetch. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the + # {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the # Sample resource to create. # @param [String] sid The Twilio-provided string that uniquely identifies the # Sample resource to fetch. @@ -236,12 +236,12 @@ def fetch ## # Update the SampleInstance - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the sample. For example: `en-US`. # @param [String] tagged_text The text example of how end users might express the - # task. The sample can contain [Field tag - # blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + # task. The sample can contain {Field tag + # blocks}[https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging]. # @param [String] source_channel The communication channel from which the sample # was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, # `slack`, or null if not included. @@ -294,10 +294,10 @@ class SampleInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the + # {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the # resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Sample resource to fetch. @@ -413,12 +413,12 @@ def fetch ## # Update the SampleInstance - # @param [String] language The [ISO - # language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + # @param [String] language The {ISO + # language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html] # string that specifies the language used for the sample. For example: `en-US`. # @param [String] tagged_text The text example of how end users might express the - # task. The sample can contain [Field tag - # blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + # task. The sample can contain {Field tag + # blocks}[https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging]. # @param [String] source_channel The communication channel from which the sample # was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, # `slack`, or null if not included. diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb index 19783e5d2..6bd1581e5 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb @@ -19,10 +19,10 @@ class TaskActionsList < ListResource # Initialize the TaskActionsList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the + # {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the # resource. # @return [TaskActionsList] TaskActionsList def initialize(version, assistant_sid: nil, task_sid: nil) @@ -82,10 +82,10 @@ class TaskActionsContext < InstanceContext # Initialize the TaskActionsContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task for which the task actions to fetch were defined. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task + # {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the task # actions to fetch were defined. # @return [TaskActionsContext] TaskActionsContext def initialize(version, assistant_sid, task_sid) @@ -113,7 +113,7 @@ def fetch ## # Update the TaskActionsInstance # @param [Hash] actions The JSON string that specifies the - # [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the + # {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the # Assistant on how to perform the task. # @return [TaskActionsInstance] Updated TaskActionsInstance def update(actions: :unset) @@ -152,10 +152,10 @@ class TaskActionsInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the + # {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the # resource. # @return [TaskActionsInstance] TaskActionsInstance def initialize(version, payload, assistant_sid: nil, task_sid: nil) @@ -226,7 +226,7 @@ def fetch ## # Update the TaskActionsInstance # @param [Hash] actions The JSON string that specifies the - # [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the + # {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the # Assistant on how to perform the task. # @return [TaskActionsInstance] Updated TaskActionsInstance def update(actions: :unset) diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb index 3da4d0176..0b7257ee2 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb @@ -19,10 +19,10 @@ class TaskStatisticsList < ListResource # Initialize the TaskStatisticsList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics + # {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the statistics # were collected. # @return [TaskStatisticsList] TaskStatisticsList def initialize(version, assistant_sid: nil, task_sid: nil) @@ -82,10 +82,10 @@ class TaskStatisticsContext < InstanceContext # Initialize the TaskStatisticsContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with + # {Task}[https://www.twilio.com/docs/autopilot/api/task] that is associated with # the resource to fetch. # @return [TaskStatisticsContext] TaskStatisticsContext def initialize(version, assistant_sid, task_sid) @@ -133,10 +133,10 @@ class TaskStatisticsInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the Task associated with the resource. # @param [String] task_sid The SID of the - # [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics + # {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the statistics # were collected. # @return [TaskStatisticsInstance] TaskStatisticsInstance def initialize(version, payload, assistant_sid: nil, task_sid: nil) diff --git a/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb b/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb index 4d1e32b56..fae09323e 100644 --- a/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +++ b/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb @@ -18,7 +18,7 @@ class WebhookList < ListResource # Initialize the WebhookList # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @return [WebhookList] WebhookList def initialize(version, assistant_sid: nil) @@ -179,7 +179,7 @@ class WebhookContext < InstanceContext # Initialize the WebhookContext # @param [Version] version Version that contains the resource # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Webhook resource to fetch. @@ -266,7 +266,7 @@ class WebhookInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] assistant_sid The SID of the - # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the + # {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the # parent of the resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Webhook resource to fetch. diff --git a/lib/twilio-ruby/rest/chat/v1/service.rb b/lib/twilio-ruby/rest/chat/v1/service.rb index 774160fc9..8dd67eb8e 100644 --- a/lib/twilio-ruby/rest/chat/v1/service.rb +++ b/lib/twilio-ruby/rest/chat/v1/service.rb @@ -193,19 +193,19 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to the service. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to a channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # channel creator when they join a new channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -237,18 +237,18 @@ def delete # create the notification text displayed when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of WebHook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhooks_on_message_send_url The URL of the webhook to call in # response to the `on_message_send` event using the # `webhooks.on_message_send.method` HTTP method. @@ -663,19 +663,19 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to the service. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to a channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # channel creator when they join a new channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -707,18 +707,18 @@ def delete # create the notification text displayed when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of WebHook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhooks_on_message_send_url The URL of the webhook to call in # response to the `on_message_send` event using the # `webhooks.on_message_send.method` HTTP method. diff --git a/lib/twilio-ruby/rest/chat/v1/service/channel.rb b/lib/twilio-ruby/rest/chat/v1/service/channel.rb index b1f53b1e6..9ba54f672 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/channel.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/channel.rb @@ -16,7 +16,7 @@ class ChannelList < ListResource # Initialize the ChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [ChannelList] ChannelList def initialize(version, service_sid: nil) @@ -181,7 +181,7 @@ class ChannelContext < InstanceContext # Initialize the ChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the # Channel resource to fetch. @@ -325,7 +325,7 @@ class ChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Channel resource to fetch. diff --git a/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb b/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb index 65a6a1544..f0aea8c47 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb @@ -17,10 +17,10 @@ class InviteList < ListResource # Initialize the InviteList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource # belongs to. # @return [InviteList] InviteList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,12 +34,12 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the InviteInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/v1/service]. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to the new # member. # @return [InviteInstance] Created InviteInstance def create(identity: nil, role_sid: :unset) @@ -60,9 +60,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -80,9 +80,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -117,9 +117,9 @@ def each # Retrieve a single page of InviteInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -197,10 +197,10 @@ class InviteContext < InstanceContext # Initialize the InviteContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource to # fetch belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Invite resource to fetch. @@ -256,10 +256,10 @@ class InviteInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource # belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Invite resource to fetch. diff --git a/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb b/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb index ce3043444..4760c4961 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb @@ -17,10 +17,10 @@ class MemberList < ListResource # Initialize the MemberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member. + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member. # @return [MemberList] MemberList def initialize(version, service_sid: nil, channel_sid: nil) super(version) @@ -33,14 +33,14 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MemberInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services]. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @return [MemberInstance] Created MemberInstance def create(identity: nil, role_sid: :unset) data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, }) @@ -60,9 +60,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -80,9 +80,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -117,9 +117,9 @@ def each # Retrieve a single page of MemberInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -197,10 +197,10 @@ class MemberContext < InstanceContext # Initialize the MemberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the member to # fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value. # @param [String] sid The Twilio-provided string that uniquely identifies the # Member resource to fetch. @@ -238,13 +238,13 @@ def delete ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member + # {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member # has read within the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels]. # @return [MemberInstance] Updated MemberInstance def update(role_sid: :unset, last_consumed_message_index: :unset) data = Twilio::Values.of({ @@ -284,10 +284,10 @@ class MemberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member. + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member. # @param [String] sid The Twilio-provided string that uniquely identifies the # Member resource to fetch. # @return [MemberInstance] MemberInstance @@ -417,13 +417,13 @@ def delete ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member + # {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member # has read within the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels]. # @return [MemberInstance] Updated MemberInstance def update(role_sid: :unset, last_consumed_message_index: :unset) context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, ) diff --git a/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb b/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb index fd26f981b..671568a7e 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb @@ -17,10 +17,10 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message # resource belongs to. # @return [MessageList] MessageList def initialize(version, service_sid: nil, channel_sid: nil) @@ -37,7 +37,7 @@ def initialize(version, service_sid: nil, channel_sid: nil) # string or `null`, which sets the value as an empty string. You can send # structured data in the body by serializing it as a string. # @param [String] from The - # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new + # {identity}[https://www.twilio.com/docs/api/chat/guides/identity] of the new # message's author. The default value is `system`. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -188,10 +188,10 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the message to # fetch belongs to. Can be the Channel's `sid` or `unique_name`. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. @@ -269,10 +269,10 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message # resource belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. diff --git a/lib/twilio-ruby/rest/chat/v1/service/role.rb b/lib/twilio-ruby/rest/chat/v1/service/role.rb index c5a180bcd..49a851748 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/role.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/role.rb @@ -16,7 +16,7 @@ class RoleList < ListResource # Initialize the RoleList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [RoleList] RoleList def initialize(version, service_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, service_sid: nil) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `channel` for - # [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` - # for [Service](https://www.twilio.com/docs/chat/api/services) roles. + # {Channel}[https://www.twilio.com/docs/chat/api/channels] roles or `deployment` + # for {Service}[https://www.twilio.com/docs/chat/api/services] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter @@ -172,7 +172,7 @@ class RoleContext < InstanceContext # Initialize the RoleContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the Role # resource to fetch. @@ -237,7 +237,7 @@ class RoleInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the Role # resource to fetch. diff --git a/lib/twilio-ruby/rest/chat/v1/service/user.rb b/lib/twilio-ruby/rest/chat/v1/service/user.rb index 9f948599b..9545dd36f 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/user.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/user.rb @@ -16,7 +16,7 @@ class UserList < ListResource # Initialize the UserList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [UserList] UserList def initialize(version, service_sid: nil) @@ -30,12 +30,12 @@ def initialize(version, service_sid: nil) ## # Create the UserInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/v1/service]. This value is # often a username or email address. See the Identity documentation for more # details. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to the new # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -176,7 +176,7 @@ class UserContext < InstanceContext # Initialize the UserContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the User # resource to fetch. @@ -211,7 +211,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this user. # @param [String] attributes A valid JSON string that contains # application-specific data. # @param [String] friendly_name A descriptive string that you create to describe @@ -266,7 +266,7 @@ class UserInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the User # resource to fetch. @@ -409,7 +409,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this user. # @param [String] attributes A valid JSON string that contains # application-specific data. # @param [String] friendly_name A descriptive string that you create to describe diff --git a/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb b/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb index 32796fde5..ea18500aa 100644 --- a/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +++ b/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb @@ -17,7 +17,7 @@ class UserChannelList < ListResource # Initialize the UserChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] user_sid The unique string that we created to identify the User # resource. @@ -157,7 +157,7 @@ class UserChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] user_sid The unique string that we created to identify the User # resource. diff --git a/lib/twilio-ruby/rest/chat/v2/service.rb b/lib/twilio-ruby/rest/chat/v2/service.rb index b0020cf90..66d2b3d35 100644 --- a/lib/twilio-ruby/rest/chat/v2/service.rb +++ b/lib/twilio-ruby/rest/chat/v2/service.rb @@ -193,22 +193,22 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to the service. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to a channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # channel creator when they join a new channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -251,18 +251,18 @@ def delete # play when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of webhook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] limits_channel_members The maximum number of Members that can be # added to Channels within this Service. Can be up to 1,000. # @param [String] limits_user_channels The maximum number of Channels Users can be @@ -617,22 +617,22 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to the service. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to a channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # channel creator when they join a new channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -675,18 +675,18 @@ def delete # play when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of webhook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] limits_channel_members The maximum number of Members that can be # added to Channels within this Service. Can be up to 1,000. # @param [String] limits_user_channels The maximum number of Channels Users can be diff --git a/lib/twilio-ruby/rest/chat/v2/service/binding.rb b/lib/twilio-ruby/rest/chat/v2/service/binding.rb index 50cb6ca58..9e891074d 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/binding.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/binding.rb @@ -16,7 +16,7 @@ class BindingList < ListResource # Initialize the BindingList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding # resource is associated with. # @return [BindingList] BindingList def initialize(version, service_sid: nil) @@ -32,14 +32,14 @@ def initialize(version, service_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -61,14 +61,14 @@ def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -102,14 +102,14 @@ def each # Retrieve a single page of BindingInstance records from the API. # Request is executed immediately. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -182,7 +182,7 @@ class BindingContext < InstanceContext # Initialize the BindingContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Binding resource from. # @param [String] sid The SID of the Binding resource to fetch. # @return [BindingContext] BindingContext @@ -231,7 +231,7 @@ class BindingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding # resource is associated with. # @param [String] sid The SID of the Binding resource to fetch. # @return [BindingInstance] BindingInstance diff --git a/lib/twilio-ruby/rest/chat/v2/service/channel.rb b/lib/twilio-ruby/rest/chat/v2/service/channel.rb index 2ca9be6ce..eaaf225f8 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/channel.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/channel.rb @@ -16,7 +16,7 @@ class ChannelList < ListResource # Initialize the ChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # resource is associated with. # @return [ChannelList] ChannelList def initialize(version, service_sid: nil) @@ -39,13 +39,13 @@ def initialize(version, service_sid: nil) # application-specific data. # @param [channel.ChannelType] type The visibility of the channel. Can be: # `public` or `private` and defaults to `public`. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. The default value is `null`. Note that this # parameter should only be used in cases where a Channel is being recreated from a # backup/separate source and where a Message was previously updated. @@ -199,7 +199,7 @@ class ChannelContext < InstanceContext # Initialize the ChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Channel resource from. # @param [String] sid The SID of the Channel resource to fetch. This value can be # either the `sid` or the `unique_name` of the Channel resource to fetch. @@ -248,13 +248,13 @@ def delete(x_twilio_webhook_enabled: :unset) # and unique within the Service. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] created_by The `identity` of the User that created the channel. # Default is: `system`. @@ -386,7 +386,7 @@ class ChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # resource is associated with. # @param [String] sid The SID of the Channel resource to fetch. This value can be # either the `sid` or the `unique_name` of the Channel resource to fetch. @@ -538,13 +538,13 @@ def delete(x_twilio_webhook_enabled: :unset) # and unique within the Service. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] created_by The `identity` of the User that created the channel. # Default is: `system`. diff --git a/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb b/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb index 52d80af89..a24b1df39 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb @@ -17,10 +17,10 @@ class InviteList < ListResource # Initialize the InviteList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Invite # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource belongs # to. # @return [InviteList] InviteList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,11 +34,11 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the InviteInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See - # [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. See + # {access tokens}[https://www.twilio.com/docs/chat/create-tokens] for more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] assigned to the new # member. # @return [InviteInstance] Created InviteInstance def create(identity: nil, role_sid: :unset) @@ -59,9 +59,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -78,9 +78,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -114,9 +114,9 @@ def each # Retrieve a single page of InviteInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -193,10 +193,10 @@ class InviteContext < InstanceContext # Initialize the InviteContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Invite resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Invite resource to fetch. @@ -252,10 +252,10 @@ class InviteInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Invite # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource belongs # to. # @param [String] sid The SID of the Invite resource to fetch. # @return [InviteInstance] InviteInstance diff --git a/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb b/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb index dd7e9db29..c6b764b65 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb @@ -17,10 +17,10 @@ class MemberList < ListResource # Initialize the MemberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Member # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource belongs # to. # @return [MemberList] MemberList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,29 +34,29 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MemberInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See - # [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. See + # {access tokens}[https://www.twilio.com/docs/chat/create-tokens] for more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. # This parameter should only be used when recreating a Member from a # backup/separate source. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. The default value is `null`. Note that this # parameter should only be used when a Member is being recreated from a # backup/separate source and where a Member was previously updated. @@ -92,9 +92,9 @@ def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -111,9 +111,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -147,9 +147,9 @@ def each # Retrieve a single page of MemberInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -226,10 +226,10 @@ class MemberContext < InstanceContext # Initialize the MemberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Member resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Member resource to fetch. This value can be @@ -272,23 +272,23 @@ def delete(x_twilio_webhook_enabled: :unset) ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the - # Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] that the + # Member has read within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -338,10 +338,10 @@ class MemberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Member # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource belongs # to. # @param [String] sid The SID of the Member resource to fetch. This value can be # either the Member's `sid` or its `identity` value. @@ -481,23 +481,23 @@ def delete(x_twilio_webhook_enabled: :unset) ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the - # Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] that the + # Member has read within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] attributes A valid JSON string that contains # application-specific data. diff --git a/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb b/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb index 6633a4544..d5e48e8d0 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb @@ -17,10 +17,10 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource # belongs to. # @return [MessageList] MessageList def initialize(version, service_sid: nil, channel_sid: nil) @@ -33,26 +33,26 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MessageInstance - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the new message's author. The default value is `system`. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. # @param [String] body The message to send to the channel. Can be an empty string # or `null`, which sets the value as an empty string. You can send structured data # in the body by serializing it as a string. # @param [String] media_sid The SID of the - # [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new + # {Media}[https://www.twilio.com/docs/chat/rest/media] to attach to the new # Message. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -212,10 +212,10 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Message resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Message resource to fetch. @@ -261,18 +261,18 @@ def delete(x_twilio_webhook_enabled: :unset) # in the body by serializing it as a string. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the message's author. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -320,10 +320,10 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource # belongs to. # @param [String] sid The SID of the Message resource to fetch. # @return [MessageInstance] MessageInstance @@ -494,18 +494,18 @@ def delete(x_twilio_webhook_enabled: :unset) # in the body by serializing it as a string. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the message's author. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header diff --git a/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb b/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb index b70320c3d..f6ce9e36c 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb @@ -17,10 +17,10 @@ class WebhookList < ListResource # Initialize the WebhookList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # Webhook resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource belongs to. # @return [WebhookList] WebhookList def initialize(version, service_sid: nil, channel_sid: nil) @@ -122,14 +122,14 @@ def get_page(target_url) # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` is `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, @@ -202,10 +202,10 @@ class WebhookContext < InstanceContext # Initialize the WebhookContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] with the # Channel to fetch the Webhook resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource to fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Channel Webhook resource to fetch. @@ -242,14 +242,14 @@ def fetch # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` = `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, @@ -304,10 +304,10 @@ class WebhookInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # Webhook resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource belongs to. # @param [String] sid The SID of the Channel Webhook resource to fetch. # @return [WebhookInstance] WebhookInstance @@ -422,14 +422,14 @@ def fetch # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` = `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, diff --git a/lib/twilio-ruby/rest/chat/v2/service/role.rb b/lib/twilio-ruby/rest/chat/v2/service/role.rb index 56a636cd2..dbe513295 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/role.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/role.rb @@ -16,7 +16,7 @@ class RoleList < ListResource # Initialize the RoleList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role # resource is associated with. # @return [RoleList] RoleList def initialize(version, service_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, service_sid: nil) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `channel` for - # [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles. + # {Channel}[https://www.twilio.com/docs/chat/channels] roles or `deployment` for + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter @@ -172,7 +172,7 @@ class RoleContext < InstanceContext # Initialize the RoleContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Role resource from. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleContext] RoleContext @@ -238,7 +238,7 @@ class RoleInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role # resource is associated with. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleInstance] RoleInstance diff --git a/lib/twilio-ruby/rest/chat/v2/service/user.rb b/lib/twilio-ruby/rest/chat/v2/service/user.rb index a63dacadf..dfcf7e7ef 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/user.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/user.rb @@ -16,7 +16,7 @@ class UserList < ListResource # Initialize the UserList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # resource is associated with. # @return [UserList] UserList def initialize(version, service_sid: nil) @@ -30,12 +30,12 @@ def initialize(version, service_sid: nil) ## # Create the UserInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. This # value is often a username or email address. See the Identity documentation for # more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the new # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -179,7 +179,7 @@ class UserContext < InstanceContext # Initialize the UserContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User resource from. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -215,7 +215,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -302,7 +302,7 @@ class UserInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # resource is associated with. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -445,7 +445,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # User. # @param [String] attributes A valid JSON string that contains # application-specific data. diff --git a/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb b/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb index 1562ffebe..fdffcb968 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb @@ -17,12 +17,12 @@ class UserBindingList < ListResource # Initialize the UserBindingList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Binding resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @return [UserBindingList] UserBindingList def initialize(version, service_sid: nil, user_sid: nil) @@ -38,9 +38,9 @@ def initialize(version, service_sid: nil, user_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -58,9 +58,9 @@ def list(binding_type: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -95,9 +95,9 @@ def each # Retrieve a single page of UserBindingInstance records from the API. # Request is executed immediately. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -175,12 +175,12 @@ class UserBindingContext < InstanceContext # Initialize the UserBindingContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User Binding resource from. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource to fetch. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource to fetch. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] sid The SID of the User Binding resource to fetch. # @return [UserBindingContext] UserBindingContext @@ -235,12 +235,12 @@ class UserBindingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Binding resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] sid The SID of the User Binding resource to fetch. # @return [UserBindingInstance] UserBindingInstance diff --git a/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb b/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb index 70951a1a9..2a5c3ee2b 100644 --- a/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +++ b/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb @@ -17,10 +17,10 @@ class UserChannelList < ListResource # Initialize the UserChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Channel resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] the User Channel # belongs to. # @return [UserChannelList] UserChannelList def initialize(version, service_sid: nil, user_sid: nil) @@ -157,14 +157,14 @@ class UserChannelContext < InstanceContext # Initialize the UserChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User Channel resource from. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] to fetch the User # Channel resource from. This value can be either the `sid` or the `identity` of # the User resource. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel + # {Channel}[https://www.twilio.com/docs/chat/channels] that has the User Channel # to fetch. This value can be either the `sid` or the `unique_name` of the Channel # to fetch. # @return [UserChannelContext] UserChannelContext @@ -203,12 +203,12 @@ def delete # @param [user_channel.NotificationLevel] notification_level The push notification # level to assign to the User Channel. Can be: `default` or `muted`. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. # @return [UserChannelInstance] Updated UserChannelInstance def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) data = Twilio::Values.of({ @@ -249,13 +249,13 @@ class UserChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Channel resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] the User Channel # belongs to. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel + # {Channel}[https://www.twilio.com/docs/chat/channels] that has the User Channel # to fetch. This value can be either the `sid` or the `unique_name` of the Channel # to fetch. # @return [UserChannelInstance] UserChannelInstance @@ -387,12 +387,12 @@ def delete # @param [user_channel.NotificationLevel] notification_level The push notification # level to assign to the User Channel. Can be: `default` or `muted`. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. # @return [UserChannelInstance] Updated UserChannelInstance def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) context.update( diff --git a/lib/twilio-ruby/rest/client.rb b/lib/twilio-ruby/rest/client.rb index 2d2d525fe..071566c85 100644 --- a/lib/twilio-ruby/rest/client.rb +++ b/lib/twilio-ruby/rest/client.rb @@ -333,7 +333,7 @@ def authorized_connect_apps(connect_app_sid=:unset) ## # @param [String] country_code The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country. # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed. # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList] diff --git a/lib/twilio-ruby/rest/conversations/v1/configuration.rb b/lib/twilio-ruby/rest/conversations/v1/configuration.rb index 1fbc34dd4..d85f2ec1a 100644 --- a/lib/twilio-ruby/rest/conversations/v1/configuration.rb +++ b/lib/twilio-ruby/rest/conversations/v1/configuration.rb @@ -91,11 +91,11 @@ def fetch ## # Update the ConfigurationInstance - # @param [String] default_chat_service_sid The SID of the default [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) to use + # @param [String] default_chat_service_sid The SID of the default {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use # when creating a conversation. - # @param [String] default_messaging_service_sid The SID of the default [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) to use when creating a + # @param [String] default_messaging_service_sid The SID of the default {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a # conversation. # @param [String] default_inactive_timer Default ISO8601 duration when # conversation will be switched to `inactive` state. Minimum value for this timer @@ -227,11 +227,11 @@ def fetch ## # Update the ConfigurationInstance - # @param [String] default_chat_service_sid The SID of the default [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) to use + # @param [String] default_chat_service_sid The SID of the default {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use # when creating a conversation. - # @param [String] default_messaging_service_sid The SID of the default [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) to use when creating a + # @param [String] default_messaging_service_sid The SID of the default {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a # conversation. # @param [String] default_inactive_timer Default ISO8601 duration when # conversation will be switched to `inactive` state. Minimum value for this timer diff --git a/lib/twilio-ruby/rest/conversations/v1/conversation.rb b/lib/twilio-ruby/rest/conversations/v1/conversation.rb index e397061e2..cf4f33284 100644 --- a/lib/twilio-ruby/rest/conversations/v1/conversation.rb +++ b/lib/twilio-ruby/rest/conversations/v1/conversation.rb @@ -34,8 +34,8 @@ def initialize(version) # resource's `sid` in the URL. # @param [Time] date_created The date that this resource was created. # @param [Time] date_updated The date that this resource was last updated. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [String] attributes An optional string metadata field you can use to # store any data you wish. The string value must contain structurally valid JSON @@ -219,8 +219,8 @@ def initialize(version, sid) # store any data you wish. The string value must contain structurally valid JSON # if specified. **Note** that if the attributes are not set "{}" will be # returned. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [conversation.State] state Current state of this conversation. Can be # either `active`, `inactive` or `closed` and defaults to `active` @@ -472,8 +472,8 @@ def links # store any data you wish. The string value must contain structurally valid JSON # if specified. **Note** that if the attributes are not set "{}" will be # returned. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [conversation.State] state Current state of this conversation. Can be # either `active`, `inactive` or `closed` and defaults to `active` diff --git a/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb b/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb index 8fb62325b..1d91067c7 100644 --- a/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +++ b/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb @@ -18,7 +18,7 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @return [MessageList] MessageList def initialize(version, conversation_sid: nil) @@ -186,7 +186,7 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -307,7 +307,7 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb b/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb index 9360e97eb..e17e27e19 100644 --- a/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +++ b/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb @@ -19,10 +19,10 @@ class DeliveryReceiptList < ListResource # Initialize the DeliveryReceiptList # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to # @return [DeliveryReceiptList] DeliveryReceiptList def initialize(version, conversation_sid: nil, message_sid: nil) @@ -163,10 +163,10 @@ class DeliveryReceiptContext < InstanceContext # Initialize the DeliveryReceiptContext # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -217,10 +217,10 @@ class DeliveryReceiptInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -311,7 +311,7 @@ def status end ## - # @return [String] The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status + # @return [String] The message {delivery error code}[https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors] for a `failed` status def error_code @properties['error_code'] end diff --git a/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb b/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb index 4bd298d4c..4083a235c 100644 --- a/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +++ b/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb @@ -18,7 +18,7 @@ class ParticipantList < ListResource # Initialize the ParticipantList # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @return [ParticipantList] ParticipantList def initialize(version, conversation_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, conversation_sid: nil) ## # Create the ParticipantInstance # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the # Conversations SDK to communicate. Limited to 256 characters. # @param [String] messaging_binding_address The address of the participant's @@ -55,7 +55,7 @@ def initialize(version, conversation_sid: nil) # phone number that is used in Group MMS. Communication mask for the Conversation # participant with Identity. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -203,7 +203,7 @@ class ParticipantContext < InstanceContext # Initialize the ParticipantContext # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -225,15 +225,15 @@ def initialize(version, conversation_sid, sid) # if specified. **Note** that if the attributes are not set "{}" will be # returned. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [String] messaging_binding_proxy_address The address of the Twilio phone # number that the participant is in contact with. 'null' value will remove it. # @param [String] messaging_binding_projected_address The address of the Twilio # phone number that is used in Group MMS. 'null' value will remove it. # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the # Conversations SDK to communicate. Limited to 256 characters. # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The @@ -309,7 +309,7 @@ class ParticipantInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -416,15 +416,15 @@ def url # if specified. **Note** that if the attributes are not set "{}" will be # returned. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [String] messaging_binding_proxy_address The address of the Twilio phone # number that the participant is in contact with. 'null' value will remove it. # @param [String] messaging_binding_projected_address The address of the Twilio # phone number that is used in Group MMS. 'null' value will remove it. # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the # Conversations SDK to communicate. Limited to 256 characters. # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The diff --git a/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb b/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb index 3a7805738..f86be89da 100644 --- a/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +++ b/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb @@ -18,7 +18,7 @@ class WebhookList < ListResource # Initialize the WebhookList # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @return [WebhookList] WebhookList def initialize(version, conversation_sid: nil) @@ -187,7 +187,7 @@ class WebhookContext < InstanceContext # Initialize the WebhookContext # @param [Version] version Version that contains the resource # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -276,7 +276,7 @@ class WebhookInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/conversations/v1/role.rb b/lib/twilio-ruby/rest/conversations/v1/role.rb index e790641d3..bcb98da8a 100644 --- a/lib/twilio-ruby/rest/conversations/v1/role.rb +++ b/lib/twilio-ruby/rest/conversations/v1/role.rb @@ -30,9 +30,9 @@ def initialize(version) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `conversation` for - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) - # roles or `service` for [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) roles. + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] + # roles or `service` for {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter diff --git a/lib/twilio-ruby/rest/conversations/v1/service/binding.rb b/lib/twilio-ruby/rest/conversations/v1/service/binding.rb index a51b94da2..b9f063dd8 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/binding.rb @@ -17,8 +17,8 @@ class BindingList < ListResource ## # Initialize the BindingList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Binding resource is associated with. # @return [BindingList] BindingList def initialize(version, chat_service_sid: nil) @@ -34,14 +34,14 @@ def initialize(version, chat_service_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. - # @param [String] identity The identity of a [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource) this binding - # belongs to. See [access - # tokens](https://www.twilio.com/docs/conversations/create-tokens) for more + # @param [String] identity The identity of a {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding + # belongs to. See {access + # tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -64,14 +64,14 @@ def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. - # @param [String] identity The identity of a [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource) this binding - # belongs to. See [access - # tokens](https://www.twilio.com/docs/conversations/create-tokens) for more + # @param [String] identity The identity of a {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding + # belongs to. See {access + # tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -106,14 +106,14 @@ def each # Retrieve a single page of BindingInstance records from the API. # Request is executed immediately. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. - # @param [String] identity The identity of a [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource) this binding - # belongs to. See [access - # tokens](https://www.twilio.com/docs/conversations/create-tokens) for more + # @param [String] identity The identity of a {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding + # belongs to. See {access + # tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more # details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -190,8 +190,8 @@ class BindingContext < InstanceContext ## # Initialize the BindingContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Binding resource is associated with. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -247,8 +247,8 @@ class BindingInstance < InstanceResource # Initialize the BindingInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Binding resource is associated with. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb b/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb index e79d5505f..5fdc2fc50 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb @@ -98,16 +98,16 @@ def fetch # Update the ConfigurationInstance # @param [String] default_conversation_creator_role_sid The conversation-level # role assigned to a conversation creator when they join a new conversation. See - # the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @param [String] default_conversation_role_sid The conversation-level role - # assigned to users when they are added to a conversation. See the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # assigned to users when they are added to a conversation. See the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @param [String] default_chat_service_role_sid The service-level role assigned to - # users when they are added to the service. See the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # users when they are added to the service. See the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @return [ConfigurationInstance] Updated ConfigurationInstance def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset) @@ -230,16 +230,16 @@ def fetch # Update the ConfigurationInstance # @param [String] default_conversation_creator_role_sid The conversation-level # role assigned to a conversation creator when they join a new conversation. See - # the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @param [String] default_conversation_role_sid The conversation-level role - # assigned to users when they are added to a conversation. See the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # assigned to users when they are added to a conversation. See the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @param [String] default_chat_service_role_sid The service-level role assigned to - # users when they are added to the service. See the [Conversation - # Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info + # users when they are added to the service. See the {Conversation + # Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info # about roles. # @return [ConfigurationInstance] Updated ConfigurationInstance def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset) diff --git a/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb b/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb index 5227a6a82..fb7a24ad3 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb @@ -72,8 +72,8 @@ class NotificationContext < InstanceContext ## # Initialize the NotificationContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Configuration applies to. # @return [NotificationContext] NotificationContext def initialize(version, chat_service_sid) diff --git a/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb b/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb index 7ce59383c..65b9e26b6 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb @@ -17,8 +17,8 @@ class ConversationList < ListResource ## # Initialize the ConversationList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The unique ID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) this + # @param [String] chat_service_sid The unique ID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] this # conversation belongs to. # @return [ConversationList] ConversationList def initialize(version, chat_service_sid: nil) @@ -40,8 +40,8 @@ def initialize(version, chat_service_sid: nil) # store any data you wish. The string value must contain structurally valid JSON # if specified. **Note** that if the attributes are not set "{}" will be # returned. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [Time] date_created The date that this resource was created. # @param [Time] date_updated The date that this resource was last updated. @@ -224,8 +224,8 @@ def initialize(version, chat_service_sid, sid) # store any data you wish. The string value must contain structurally valid JSON # if specified. **Note** that if the attributes are not set "{}" will be # returned. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [conversation.State] state Current state of this conversation. Can be # either `active`, `inactive` or `closed` and defaults to `active` @@ -372,8 +372,8 @@ class ConversationInstance < InstanceResource # Initialize the ConversationInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The unique ID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) this + # @param [String] chat_service_sid The unique ID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] this # conversation belongs to. # @param [String] sid A 34 character string that uniquely identifies this # resource. Can also be the `unique_name` of the Conversation. @@ -502,8 +502,8 @@ def links # store any data you wish. The string value must contain structurally valid JSON # if specified. **Note** that if the attributes are not set "{}" will be # returned. - # @param [String] messaging_service_sid The unique ID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs + # @param [String] messaging_service_sid The unique ID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs # to. # @param [conversation.State] state Current state of this conversation. Can be # either `active`, `inactive` or `closed` and defaults to `active` diff --git a/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb b/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb index 543526ce9..e00512cd3 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb @@ -18,11 +18,11 @@ class MessageList < ListResource ## # Initialize the MessageList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @return [MessageList] MessageList def initialize(version, chat_service_sid: nil, conversation_sid: nil) @@ -199,11 +199,11 @@ class MessageContext < InstanceContext ## # Initialize the MessageContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -332,11 +332,11 @@ class MessageInstance < InstanceResource # Initialize the MessageInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb b/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb index c22cf8ebc..3d6e5eeac 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb @@ -19,14 +19,14 @@ class DeliveryReceiptList < ListResource ## # Initialize the DeliveryReceiptList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Message resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to # @return [DeliveryReceiptList] DeliveryReceiptList def initialize(version, chat_service_sid: nil, conversation_sid: nil, message_sid: nil) @@ -171,14 +171,14 @@ class DeliveryReceiptContext < InstanceContext ## # Initialize the DeliveryReceiptContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Message resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -234,14 +234,14 @@ class DeliveryReceiptInstance < InstanceResource # Initialize the DeliveryReceiptInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Message resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this message. # @param [String] message_sid The SID of the message within a - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # the delivery receipt belongs to # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -341,7 +341,7 @@ def status end ## - # @return [String] The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status + # @return [String] The message {delivery error code}[https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors] for a `failed` status def error_code @properties['error_code'] end diff --git a/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb b/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb index 4d58462f8..483bbead0 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb @@ -18,11 +18,11 @@ class ParticipantList < ListResource ## # Initialize the ParticipantList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @return [ParticipantList] ParticipantList def initialize(version, chat_service_sid: nil, conversation_sid: nil) @@ -36,8 +36,8 @@ def initialize(version, chat_service_sid: nil, conversation_sid: nil) ## # Create the ParticipantInstance # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the Conversation # SDK to communicate. Limited to 256 characters. # @param [String] messaging_binding_address The address of the participant's @@ -59,7 +59,7 @@ def initialize(version, chat_service_sid: nil, conversation_sid: nil) # phone number that is used in Group MMS. Communication mask for the Conversation # participant with Identity. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -216,11 +216,11 @@ class ParticipantContext < InstanceContext ## # Initialize the ParticipantContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -238,8 +238,8 @@ def initialize(version, chat_service_sid, conversation_sid, sid) # @param [Time] date_created The date that this resource was created. # @param [Time] date_updated The date that this resource was last updated. # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the Conversation # SDK to communicate. Limited to 256 characters. # @param [String] attributes An optional string metadata field you can use to @@ -247,7 +247,7 @@ def initialize(version, chat_service_sid, conversation_sid, sid) # if specified. **Note** that if the attributes are not set "{}" will be # returned. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [String] messaging_binding_proxy_address The address of the Twilio phone # number that the participant is in contact with. 'null' value will remove it. @@ -327,11 +327,11 @@ class ParticipantInstance < InstanceResource # Initialize the ParticipantInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this participant. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -450,8 +450,8 @@ def url # @param [Time] date_created The date that this resource was created. # @param [Time] date_updated The date that this resource was last updated. # @param [String] identity A unique string identifier for the conversation - # participant as [Conversation - # User](https://www.twilio.com/docs/conversations/api/user-resource). This + # participant as {Conversation + # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This # parameter is non-null if (and only if) the participant is using the Conversation # SDK to communicate. Limited to 256 characters. # @param [String] attributes An optional string metadata field you can use to @@ -459,7 +459,7 @@ def url # if specified. **Note** that if the attributes are not set "{}" will be # returned. # @param [String] role_sid The SID of a conversation-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the participant. # @param [String] messaging_binding_proxy_address The address of the Twilio phone # number that the participant is in contact with. 'null' value will remove it. diff --git a/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb b/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb index e5c401e4a..7939a62a6 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb @@ -18,11 +18,11 @@ class WebhookList < ListResource ## # Initialize the WebhookList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @return [WebhookList] WebhookList def initialize(version, chat_service_sid: nil, conversation_sid: nil) @@ -200,11 +200,11 @@ class WebhookContext < InstanceContext ## # Initialize the WebhookContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. @@ -294,11 +294,11 @@ class WebhookInstance < InstanceResource # Initialize the WebhookInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. diff --git a/lib/twilio-ruby/rest/conversations/v1/service/role.rb b/lib/twilio-ruby/rest/conversations/v1/service/role.rb index 5e839b819..c38783697 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/role.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/role.rb @@ -17,8 +17,8 @@ class RoleList < ListResource ## # Initialize the RoleList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Role resource is associated with. # @return [RoleList] RoleList def initialize(version, chat_service_sid: nil) @@ -34,9 +34,9 @@ def initialize(version, chat_service_sid: nil) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `conversation` for - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) - # roles or `service` for [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) roles. + # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] + # roles or `service` for {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter @@ -178,8 +178,8 @@ class RoleContext < InstanceContext ## # Initialize the RoleContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) to + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] to # fetch the Role resource from. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleContext] RoleContext @@ -256,8 +256,8 @@ class RoleInstance < InstanceResource # Initialize the RoleInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Role resource is associated with. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleInstance] RoleInstance diff --git a/lib/twilio-ruby/rest/conversations/v1/service/user.rb b/lib/twilio-ruby/rest/conversations/v1/service/user.rb index edbfeb8de..683f81cb5 100644 --- a/lib/twilio-ruby/rest/conversations/v1/service/user.rb +++ b/lib/twilio-ruby/rest/conversations/v1/service/user.rb @@ -17,8 +17,8 @@ class UserList < ListResource ## # Initialize the UserList # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # User resource is associated with. # @return [UserList] UserList def initialize(version, chat_service_sid: nil) @@ -32,15 +32,15 @@ def initialize(version, chat_service_sid: nil) ## # Create the UserInstance # @param [String] identity The application-defined string that uniquely identifies - # the resource's User within the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource). This + # the resource's User within the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource]. This # value is often a username or an email address, and is case-sensitive. # @param [String] friendly_name The string that you assigned to describe the # resource. # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Created UserInstance def create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset) @@ -180,8 +180,8 @@ class UserContext < InstanceContext ## # Initialize the UserContext # @param [Version] version Version that contains the resource - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) to + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] to # fetch the User resource from. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -201,7 +201,7 @@ def initialize(version, chat_service_sid, sid) # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Updated UserInstance def update(friendly_name: :unset, attributes: :unset, role_sid: :unset) @@ -264,8 +264,8 @@ class UserInstance < InstanceResource # Initialize the UserInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] chat_service_sid The SID of the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource) the + # @param [String] chat_service_sid The SID of the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # User resource is associated with. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -377,7 +377,7 @@ def url # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Updated UserInstance def update(friendly_name: :unset, attributes: :unset, role_sid: :unset) diff --git a/lib/twilio-ruby/rest/conversations/v1/user.rb b/lib/twilio-ruby/rest/conversations/v1/user.rb index 9cd3383a6..13652f799 100644 --- a/lib/twilio-ruby/rest/conversations/v1/user.rb +++ b/lib/twilio-ruby/rest/conversations/v1/user.rb @@ -28,15 +28,15 @@ def initialize(version) ## # Create the UserInstance # @param [String] identity The application-defined string that uniquely identifies - # the resource's User within the [Conversation - # Service](https://www.twilio.com/docs/conversations/api/service-resource). This + # the resource's User within the {Conversation + # Service}[https://www.twilio.com/docs/conversations/api/service-resource]. This # value is often a username or an email address, and is case-sensitive. # @param [String] friendly_name The string that you assigned to describe the # resource. # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Created UserInstance def create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset) @@ -194,7 +194,7 @@ def initialize(version, sid) # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Updated UserInstance def update(friendly_name: :unset, attributes: :unset, role_sid: :unset) @@ -357,7 +357,7 @@ def url # @param [String] attributes The JSON Object string that stores # application-specific data. If attributes have not been set, `{}` is returned. # @param [String] role_sid The SID of a service-level - # [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to + # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to # the user. # @return [UserInstance] Updated UserInstance def update(friendly_name: :unset, attributes: :unset, role_sid: :unset) diff --git a/lib/twilio-ruby/rest/fax/v1/fax.rb b/lib/twilio-ruby/rest/fax/v1/fax.rb index 39179319d..704b394aa 100644 --- a/lib/twilio-ruby/rest/fax/v1/fax.rb +++ b/lib/twilio-ruby/rest/fax/v1/fax.rb @@ -30,15 +30,15 @@ def initialize(version) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] from Retrieve only those faxes sent from this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [String] to Retrieve only those faxes sent to this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [Time] date_created_on_or_before Retrieve only those faxes with a - # `date_created` that is before or equal to this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # `date_created` that is before or equal to this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] date_created_after Retrieve only those faxes with a `date_created` - # that is later than this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # that is later than this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -62,15 +62,15 @@ def list(from: :unset, to: :unset, date_created_on_or_before: :unset, date_creat # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] from Retrieve only those faxes sent from this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [String] to Retrieve only those faxes sent to this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [Time] date_created_on_or_before Retrieve only those faxes with a - # `date_created` that is before or equal to this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # `date_created` that is before or equal to this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] date_created_after Retrieve only those faxes with a `date_created` - # that is later than this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # that is later than this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -110,15 +110,15 @@ def each # Retrieve a single page of FaxInstance records from the API. # Request is executed immediately. # @param [String] from Retrieve only those faxes sent from this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [String] to Retrieve only those faxes sent to this phone number, - # specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. + # specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. # @param [Time] date_created_on_or_before Retrieve only those faxes with a - # `date_created` that is before or equal to this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # `date_created` that is before or equal to this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] date_created_after Retrieve only those faxes with a `date_created` - # that is later than this value, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # that is later than this value, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -155,21 +155,21 @@ def get_page(target_url) ## # Create the FaxInstance # @param [String] to The phone number to receive the fax in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the # recipient's SIP URI. # @param [String] media_url The URL of the PDF that contains the fax. See our - # [security](https://www.twilio.com/docs/usage/security) page for information on + # {security}[https://www.twilio.com/docs/usage/security] page for information on # how to ensure the request for your media comes from Twilio. - # @param [fax.Quality] quality The [Fax Quality - # value](https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values) that + # @param [fax.Quality] quality The {Fax Quality + # value}[https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values] that # describes the fax quality. Can be: `standard`, `fine`, or `superfine` and # defaults to `fine`. # @param [String] status_callback The URL we should call using the `POST` method - # to send [status - # information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback) + # to send {status + # information}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback] # to your application when the status of the fax changes. # @param [String] from The number the fax was sent from. Can be the phone number - # in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP + # in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the SIP # `from` value. The caller ID displayed to the recipient uses this value. If this # is a phone number, it must be a Twilio number or a verified outgoing caller id # from your account. If `to` is a SIP address, this can be any alphanumeric string @@ -273,7 +273,7 @@ def fetch ## # Update the FaxInstance # @param [fax.UpdateStatus] status The new - # [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of + # {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of # the resource. Can be only `canceled`. This may fail if transmission has already # started. # @return [FaxInstance] Updated FaxInstance @@ -494,7 +494,7 @@ def fetch ## # Update the FaxInstance # @param [fax.UpdateStatus] status The new - # [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of + # {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of # the resource. Can be only `canceled`. This may fail if transmission has already # started. # @return [FaxInstance] Updated FaxInstance diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service.rb index 748b30461..a00343a69 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service.rb @@ -193,19 +193,19 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to the service. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to a channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # channel creator when they join a new channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -237,18 +237,18 @@ def delete # create the notification text displayed when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of WebHook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhooks_on_message_send_url The URL of the webhook to call in # response to the `on_message_send` event using the # `webhooks.on_message_send.method` HTTP method. @@ -663,19 +663,19 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to the service. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. + # they are added to a channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Roles - # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # channel creator when they join a new channel. See the {Roles + # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details. + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -707,18 +707,18 @@ def delete # create the notification text displayed when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of WebHook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhooks_on_message_send_url The URL of the webhook to call in # response to the `on_message_send` event using the # `webhooks.on_message_send.method` HTTP method. diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb index bd781074a..1324a15a6 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb @@ -16,7 +16,7 @@ class ChannelList < ListResource # Initialize the ChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [ChannelList] ChannelList def initialize(version, service_sid: nil) @@ -181,7 +181,7 @@ class ChannelContext < InstanceContext # Initialize the ChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the # Channel resource to fetch. @@ -325,7 +325,7 @@ class ChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Channel resource to fetch. diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb index 895f28501..549fc1002 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb @@ -17,10 +17,10 @@ class InviteList < ListResource # Initialize the InviteList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource # belongs to. # @return [InviteList] InviteList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,12 +34,12 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the InviteInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/v1/service]. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to the new # member. # @return [InviteInstance] Created InviteInstance def create(identity: nil, role_sid: :unset) @@ -60,9 +60,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -80,9 +80,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -117,9 +117,9 @@ def each # Retrieve a single page of InviteInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -197,10 +197,10 @@ class InviteContext < InstanceContext # Initialize the InviteContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource to # fetch belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Invite resource to fetch. @@ -256,10 +256,10 @@ class InviteInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the resource # belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Invite resource to fetch. diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb index 0d268af51..a11540497 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb @@ -17,10 +17,10 @@ class MemberList < ListResource # Initialize the MemberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member. + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member. # @return [MemberList] MemberList def initialize(version, service_sid: nil, channel_sid: nil) super(version) @@ -33,14 +33,14 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MemberInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services]. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @return [MemberInstance] Created MemberInstance def create(identity: nil, role_sid: :unset) data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, }) @@ -60,9 +60,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -80,9 +80,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -117,9 +117,9 @@ def each # Retrieve a single page of MemberInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of - # the resources to read. See [access - # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more + # {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of + # the resources to read. See {access + # tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more # details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -197,10 +197,10 @@ class MemberContext < InstanceContext # Initialize the MemberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the member to # fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value. # @param [String] sid The Twilio-provided string that uniquely identifies the # Member resource to fetch. @@ -238,13 +238,13 @@ def delete ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member + # {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member # has read within the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels]. # @return [MemberInstance] Updated MemberInstance def update(role_sid: :unset, last_consumed_message_index: :unset) data = Twilio::Values.of({ @@ -284,10 +284,10 @@ class MemberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member. + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member. # @param [String] sid The Twilio-provided string that uniquely identifies the # Member resource to fetch. # @return [MemberInstance] MemberInstance @@ -417,13 +417,13 @@ def delete ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member. # The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/api/services). + # {Service}[https://www.twilio.com/docs/chat/api/services]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member + # {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member # has read within the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels]. # @return [MemberInstance] Updated MemberInstance def update(role_sid: :unset, last_consumed_message_index: :unset) context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, ) diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb index 90e0c4acf..b909619b3 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb @@ -17,10 +17,10 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message # resource belongs to. # @return [MessageList] MessageList def initialize(version, service_sid: nil, channel_sid: nil) @@ -37,7 +37,7 @@ def initialize(version, service_sid: nil, channel_sid: nil) # string or `null`, which sets the value as an empty string. You can send # structured data in the body by serializing it as a string. # @param [String] from The - # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new + # {identity}[https://www.twilio.com/docs/api/chat/guides/identity] of the new # message's author. The default value is `system`. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -188,10 +188,10 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the message to # fetch belongs to. Can be the Channel's `sid` or `unique_name`. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. @@ -269,10 +269,10 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] channel_sid The unique ID of the - # [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message + # {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message # resource belongs to. # @param [String] sid The Twilio-provided string that uniquely identifies the # Message resource to fetch. diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb index edb25a062..6506a317d 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb @@ -16,7 +16,7 @@ class RoleList < ListResource # Initialize the RoleList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [RoleList] RoleList def initialize(version, service_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, service_sid: nil) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `channel` for - # [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` - # for [Service](https://www.twilio.com/docs/chat/api/services) roles. + # {Channel}[https://www.twilio.com/docs/chat/api/channels] roles or `deployment` + # for {Service}[https://www.twilio.com/docs/chat/api/services] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter @@ -172,7 +172,7 @@ class RoleContext < InstanceContext # Initialize the RoleContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the Role # resource to fetch. @@ -237,7 +237,7 @@ class RoleInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the Role # resource to fetch. diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb index 019eff51b..77945a933 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb @@ -16,7 +16,7 @@ class UserList < ListResource # Initialize the UserList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @return [UserList] UserList def initialize(version, service_sid: nil) @@ -30,12 +30,12 @@ def initialize(version, service_sid: nil) ## # Create the UserInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the - # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is + # resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the + # {Service}[https://www.twilio.com/docs/api/chat/rest/v1/service]. This value is # often a username or email address. See the Identity documentation for more # details. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to the new # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -176,7 +176,7 @@ class UserContext < InstanceContext # Initialize the UserContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the User # resource to fetch. @@ -211,7 +211,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this user. # @param [String] attributes A valid JSON string that contains # application-specific data. # @param [String] friendly_name A descriptive string that you create to describe @@ -266,7 +266,7 @@ class UserInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the User # resource to fetch. @@ -409,7 +409,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user. + # {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this user. # @param [String] attributes A valid JSON string that contains # application-specific data. # @param [String] friendly_name A descriptive string that you create to describe diff --git a/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb b/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb index 459f3f115..318b58d42 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb @@ -17,7 +17,7 @@ class UserChannelList < ListResource # Initialize the UserChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] user_sid The unique string that we created to identify the User # resource. @@ -157,7 +157,7 @@ class UserChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is + # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is # associated with. # @param [String] user_sid The unique string that we created to identify the User # resource. diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service.rb index cbc19730b..bc8440b3b 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service.rb @@ -193,22 +193,22 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to the service. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to a channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # channel creator when they join a new channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -251,18 +251,18 @@ def delete # play when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of webhook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] limits_channel_members The maximum number of Members that can be # added to Channels within this Service. Can be up to 1,000. # @param [String] limits_user_channels The maximum number of Channels Users can be @@ -617,22 +617,22 @@ def delete # @param [String] friendly_name A descriptive string that you create to describe # the resource. # @param [String] default_service_role_sid The service role assigned to users when - # they are added to the service. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to the service. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_role_sid The channel role assigned to users when - # they are added to a channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # they are added to a channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. # @param [String] default_channel_creator_role_sid The channel role assigned to a - # channel creator when they join a new channel. See the [Role - # resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info + # channel creator when they join a new channel. See the {Role + # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info # about roles. - # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption - # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The + # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption + # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The # default is `true`. - # @param [Boolean] reachability_enabled Whether to enable the [Reachability - # Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this + # @param [Boolean] reachability_enabled Whether to enable the {Reachability + # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this # Service instance. The default is `false`. # @param [String] typing_indicator_timeout How long in seconds after a `started # typing` event until clients should assume that user is no longer typing, even if @@ -675,18 +675,18 @@ def delete # play when a user is invited to a channel and # `notifications.invited_to_channel.enabled` is `true`. # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called - # by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] post_webhook_url The URL for post-event webhooks, which are - # called by using the `webhook_method`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # called by using the `webhook_method`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_method The HTTP method to use for calls to the # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - # the default is `POST`. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # the default is `POST`. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] webhook_filters The list of webhook events that are enabled for - # this Service instance. See [Webhook - # Events](https://www.twilio.com/docs/chat/webhook-events) for more details. + # this Service instance. See {Webhook + # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details. # @param [String] limits_channel_members The maximum number of Members that can be # added to Channels within this Service. Can be up to 1,000. # @param [String] limits_user_channels The maximum number of Channels Users can be diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb index 023b8ed4c..03c33b272 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb @@ -16,7 +16,7 @@ class BindingList < ListResource # Initialize the BindingList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding # resource is associated with. # @return [BindingList] BindingList def initialize(version, service_sid: nil) @@ -32,14 +32,14 @@ def initialize(version, service_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -61,14 +61,14 @@ def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -102,14 +102,14 @@ def each # Retrieve a single page of BindingInstance records from the API. # Request is executed immediately. # @param [binding.BindingType] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -182,7 +182,7 @@ class BindingContext < InstanceContext # Initialize the BindingContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Binding resource from. # @param [String] sid The SID of the Binding resource to fetch. # @return [BindingContext] BindingContext @@ -231,7 +231,7 @@ class BindingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding # resource is associated with. # @param [String] sid The SID of the Binding resource to fetch. # @return [BindingInstance] BindingInstance diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb index d30f39e2c..bb6e97db7 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb @@ -16,7 +16,7 @@ class ChannelList < ListResource # Initialize the ChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # resource is associated with. # @return [ChannelList] ChannelList def initialize(version, service_sid: nil) @@ -39,13 +39,13 @@ def initialize(version, service_sid: nil) # application-specific data. # @param [channel.ChannelType] type The visibility of the channel. Can be: # `public` or `private` and defaults to `public`. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. The default value is `null`. Note that this # parameter should only be used in cases where a Channel is being recreated from a # backup/separate source and where a Message was previously updated. @@ -199,7 +199,7 @@ class ChannelContext < InstanceContext # Initialize the ChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Channel resource from. # @param [String] sid The SID of the Channel resource to fetch. This value can be # either the `sid` or the `unique_name` of the Channel resource to fetch. @@ -248,13 +248,13 @@ def delete(x_twilio_webhook_enabled: :unset) # and unique within the Service. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] created_by The `identity` of the User that created the channel. # Default is: `system`. @@ -386,7 +386,7 @@ class ChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # resource is associated with. # @param [String] sid The SID of the Channel resource to fetch. This value can be # either the `sid` or the `unique_name` of the Channel resource to fetch. @@ -538,13 +538,13 @@ def delete(x_twilio_webhook_enabled: :unset) # and unique within the Service. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this should only be used in cases where a Channel is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] created_by The `identity` of the User that created the channel. # Default is: `system`. diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb index 0039f7c93..a24b853e8 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb @@ -17,10 +17,10 @@ class InviteList < ListResource # Initialize the InviteList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Invite # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource belongs # to. # @return [InviteList] InviteList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,11 +34,11 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the InviteInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See - # [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. See + # {access tokens}[https://www.twilio.com/docs/chat/create-tokens] for more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] assigned to the new # member. # @return [InviteInstance] Created InviteInstance def create(identity: nil, role_sid: :unset) @@ -59,9 +59,9 @@ def create(identity: nil, role_sid: :unset) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -78,9 +78,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -114,9 +114,9 @@ def each # Retrieve a single page of InviteInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -193,10 +193,10 @@ class InviteContext < InstanceContext # Initialize the InviteContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Invite resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Invite resource to fetch. @@ -252,10 +252,10 @@ class InviteInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Invite # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Invite resource belongs # to. # @param [String] sid The SID of the Invite resource to fetch. # @return [InviteInstance] InviteInstance diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb index 7b9c4fc2a..4d517c3b4 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb @@ -17,10 +17,10 @@ class MemberList < ListResource # Initialize the MemberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Member # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource belongs # to. # @return [MemberList] MemberList def initialize(version, service_sid: nil, channel_sid: nil) @@ -34,29 +34,29 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MemberInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See - # [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. See + # {access tokens}[https://www.twilio.com/docs/chat/create-tokens] for more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. # This parameter should only be used when recreating a Member from a # backup/separate source. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. The default value is `null`. Note that this # parameter should only be used when a Member is being recreated from a # backup/separate source and where a Member was previously updated. @@ -92,9 +92,9 @@ def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -111,9 +111,9 @@ def list(identity: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -147,9 +147,9 @@ def each # Retrieve a single page of MemberInstance records from the API. # Request is executed immediately. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value - # of the Member resources to read. See [access - # tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value + # of the Member resources to read. See {access + # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 @@ -226,10 +226,10 @@ class MemberContext < InstanceContext # Initialize the MemberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Member resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Member resource to fetch. This value can be @@ -272,23 +272,23 @@ def delete(x_twilio_webhook_enabled: :unset) ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the - # Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] that the + # Member has read within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -338,10 +338,10 @@ class MemberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Member # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs + # {Channel}[https://www.twilio.com/docs/chat/channels] the Member resource belongs # to. # @param [String] sid The SID of the Member resource to fetch. This value can be # either the Member's `sid` or its `identity` value. @@ -481,23 +481,23 @@ def delete(x_twilio_webhook_enabled: :unset) ## # Update the MemberInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # member. The default roles are those specified on the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource). + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the - # Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] that the + # Member has read within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. Note that this parameter should only be used when a Member is # being recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] attributes A valid JSON string that contains # application-specific data. diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb index b643f33f8..46253ce4e 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb @@ -17,10 +17,10 @@ class MessageList < ListResource # Initialize the MessageList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource # belongs to. # @return [MessageList] MessageList def initialize(version, service_sid: nil, channel_sid: nil) @@ -33,26 +33,26 @@ def initialize(version, service_sid: nil, channel_sid: nil) ## # Create the MessageInstance - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the new message's author. The default value is `system`. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. # @param [String] body The message to send to the channel. Can be an empty string # or `null`, which sets the value as an empty string. You can send structured data # in the body by serializing it as a string. # @param [String] media_sid The SID of the - # [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new + # {Media}[https://www.twilio.com/docs/chat/rest/media] to attach to the new # Message. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -212,10 +212,10 @@ class MessageContext < InstanceContext # Initialize the MessageContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Message resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource to # fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Message resource to fetch. @@ -261,18 +261,18 @@ def delete(x_twilio_webhook_enabled: :unset) # in the body by serializing it as a string. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the message's author. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header @@ -320,10 +320,10 @@ class MessageInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message # resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Message resource + # {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource # belongs to. # @param [String] sid The SID of the Message resource to fetch. # @return [MessageInstance] MessageInstance @@ -494,18 +494,18 @@ def delete(x_twilio_webhook_enabled: :unset) # in the body by serializing it as a string. # @param [String] attributes A valid JSON string that contains # application-specific data. - # @param [Time] date_created The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_created The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was created. The default value is the current time set by the # Chat service. This parameter should only be used when a Chat's history is being # recreated from a backup/separate source. - # @param [Time] date_updated The date, specified in [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource + # @param [Time] date_updated The date, specified in {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource # as the date it was last updated. # @param [String] last_updated_by The - # [Identity](https://www.twilio.com/docs/chat/identity) of the User who last + # {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last # updated the Message, if applicable. - # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity) + # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity] # of the message's author. # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The # X-Twilio-Webhook-Enabled HTTP request header diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb index 8f379d873..deceed1a2 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb @@ -17,10 +17,10 @@ class WebhookList < ListResource # Initialize the WebhookList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # Webhook resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource belongs to. # @return [WebhookList] WebhookList def initialize(version, service_sid: nil, channel_sid: nil) @@ -122,14 +122,14 @@ def get_page(target_url) # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` is `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, @@ -202,10 +202,10 @@ class WebhookContext < InstanceContext # Initialize the WebhookContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] with the # Channel to fetch the Webhook resource from. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource to fetch belongs to. This value can be the Channel resource's `sid` or # `unique_name`. # @param [String] sid The SID of the Channel Webhook resource to fetch. @@ -242,14 +242,14 @@ def fetch # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` = `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, @@ -304,10 +304,10 @@ class WebhookInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel # Webhook resource is associated with. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook + # {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook # resource belongs to. # @param [String] sid The SID of the Channel Webhook resource to fetch. # @return [WebhookInstance] WebhookInstance @@ -422,14 +422,14 @@ def fetch # @param [String] configuration_filters The events that cause us to call the # Channel Webhook. Used when `type` is `webhook`. This parameter takes only one # event. To specify more than one event, repeat this parameter for each event. For - # the list of possible events, see [Webhook Event - # Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). + # the list of possible events, see {Webhook Event + # Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger]. # @param [String] configuration_triggers A string that will cause us to call the # webhook when it is present in a message body. This parameter takes only one # trigger string. To specify more than one, repeat this parameter for each trigger # string up to a total of 5 trigger strings. Used only when `type` = `trigger`. # @param [String] configuration_flow_sid The SID of the Studio - # [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event + # {Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event # in `configuration.filters` occurs. Used only when `type` = `studio`. # @param [String] configuration_retry_count The number of times to retry the # webhook if the first attempt fails. Can be an integer between 0 and 3, diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb index 70be77bf8..9e134834b 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb @@ -16,7 +16,7 @@ class RoleList < ListResource # Initialize the RoleList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role # resource is associated with. # @return [RoleList] RoleList def initialize(version, service_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, service_sid: nil) # @param [String] friendly_name A descriptive string that you create to describe # the new resource. It can be up to 64 characters long. # @param [role.RoleType] type The type of role. Can be: `channel` for - # [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles. + # {Channel}[https://www.twilio.com/docs/chat/channels] roles or `deployment` for + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] roles. # @param [String] permission A permission that you grant to the new role. Only one # permission can be granted per parameter. To assign more than one permission, # repeat this parameter for each permission value. The values for this parameter @@ -172,7 +172,7 @@ class RoleContext < InstanceContext # Initialize the RoleContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # Role resource from. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleContext] RoleContext @@ -238,7 +238,7 @@ class RoleInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role # resource is associated with. # @param [String] sid The SID of the Role resource to fetch. # @return [RoleInstance] RoleInstance diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb index 7ccecc42c..24f7621ca 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb @@ -16,7 +16,7 @@ class UserList < ListResource # Initialize the UserList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # resource is associated with. # @return [UserList] UserList def initialize(version, service_sid: nil) @@ -30,12 +30,12 @@ def initialize(version, service_sid: nil) ## # Create the UserInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. This # value is often a username or email address. See the Identity documentation for # more info. # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the new # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -179,7 +179,7 @@ class UserContext < InstanceContext # Initialize the UserContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User resource from. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -215,7 +215,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # User. # @param [String] attributes A valid JSON string that contains # application-specific data. @@ -302,7 +302,7 @@ class UserInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # resource is associated with. # @param [String] sid The SID of the User resource to fetch. This value can be # either the `sid` or the `identity` of the User resource to fetch. @@ -445,7 +445,7 @@ def delete ## # Update the UserInstance # @param [String] role_sid The SID of the - # [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the + # {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the # User. # @param [String] attributes A valid JSON string that contains # application-specific data. diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb index ebe55692d..8cfd69bc0 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb @@ -17,12 +17,12 @@ class UserBindingList < ListResource # Initialize the UserBindingList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Binding resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @return [UserBindingList] UserBindingList def initialize(version, service_sid: nil, user_sid: nil) @@ -38,9 +38,9 @@ def initialize(version, service_sid: nil, user_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -58,9 +58,9 @@ def list(binding_type: :unset, limit: nil, page_size: nil) # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -95,9 +95,9 @@ def each # Retrieve a single page of UserBindingInstance records from the API. # Request is executed immediately. # @param [user_binding.BindingType] binding_type The push technology used by the - # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push + # User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push # notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -175,12 +175,12 @@ class UserBindingContext < InstanceContext # Initialize the UserBindingContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User Binding resource from. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource to fetch. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource to fetch. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] sid The SID of the User Binding resource to fetch. # @return [UserBindingContext] UserBindingContext @@ -235,12 +235,12 @@ class UserBindingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Binding resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User - # Binding resource. See [push notification - # configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User + # Binding resource. See {push notification + # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] # for more info. # @param [String] sid The SID of the User Binding resource to fetch. # @return [UserBindingInstance] UserBindingInstance diff --git a/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb b/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb index f3a55a835..c0d29643f 100644 --- a/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +++ b/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb @@ -17,10 +17,10 @@ class UserChannelList < ListResource # Initialize the UserChannelList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Channel resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] the User Channel # belongs to. # @return [UserChannelList] UserChannelList def initialize(version, service_sid: nil, user_sid: nil) @@ -157,14 +157,14 @@ class UserChannelContext < InstanceContext # Initialize the UserChannelContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # User Channel resource from. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] to fetch the User # Channel resource from. This value can be either the `sid` or the `identity` of # the User resource. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel + # {Channel}[https://www.twilio.com/docs/chat/channels] that has the User Channel # to fetch. This value can be either the `sid` or the `unique_name` of the Channel # to fetch. # @return [UserChannelContext] UserChannelContext @@ -203,12 +203,12 @@ def delete # @param [user_channel.NotificationLevel] notification_level The push notification # level to assign to the User Channel. Can be: `default` or `muted`. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. # @return [UserChannelInstance] Updated UserChannelInstance def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) data = Twilio::Values.of({ @@ -249,13 +249,13 @@ class UserChannelInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User # Channel resource is associated with. # @param [String] user_sid The SID of the - # [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] the User Channel # belongs to. # @param [String] channel_sid The SID of the - # [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel + # {Channel}[https://www.twilio.com/docs/chat/channels] that has the User Channel # to fetch. This value can be either the `sid` or the `unique_name` of the Channel # to fetch. # @return [UserChannelInstance] UserChannelInstance @@ -387,12 +387,12 @@ def delete # @param [user_channel.NotificationLevel] notification_level The push notification # level to assign to the User Channel. Can be: `default` or `muted`. # @param [String] last_consumed_message_index The index of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the - # [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. - # @param [Time] last_consumption_timestamp The [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last - # [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for - # the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] in the + # {Channel}[https://www.twilio.com/docs/chat/channels] that the Member has read. + # @param [Time] last_consumption_timestamp The {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] timestamp of the last + # {Message}[https://www.twilio.com/docs/chat/rest/message-resource] read event for + # the Member within the {Channel}[https://www.twilio.com/docs/chat/channels]. # @return [UserChannelInstance] Updated UserChannelInstance def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) context.update( diff --git a/lib/twilio-ruby/rest/lookups.rb b/lib/twilio-ruby/rest/lookups.rb index 58160cd16..a9938ada4 100644 --- a/lib/twilio-ruby/rest/lookups.rb +++ b/lib/twilio-ruby/rest/lookups.rb @@ -30,7 +30,7 @@ def v1 ## # @param [String] phone_number The phone number in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists # of a + followed by the country code and subscriber number. # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed. # @return [Twilio::REST::Lookups::V1::PhoneNumberList] diff --git a/lib/twilio-ruby/rest/lookups/v1.rb b/lib/twilio-ruby/rest/lookups/v1.rb index 2478360ed..2508eabd7 100644 --- a/lib/twilio-ruby/rest/lookups/v1.rb +++ b/lib/twilio-ruby/rest/lookups/v1.rb @@ -20,7 +20,7 @@ def initialize(domain) ## # @param [String] phone_number The phone number to lookup in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists # of a + followed by the country code and subscriber number. # @return [Twilio::REST::Lookups::V1::PhoneNumberContext] if phone_number was passed. # @return [Twilio::REST::Lookups::V1::PhoneNumberList] diff --git a/lib/twilio-ruby/rest/lookups/v1/phone_number.rb b/lib/twilio-ruby/rest/lookups/v1/phone_number.rb index 36c028ee9..89773aa84 100644 --- a/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +++ b/lib/twilio-ruby/rest/lookups/v1/phone_number.rb @@ -63,7 +63,7 @@ class PhoneNumberContext < InstanceContext # Initialize the PhoneNumberContext # @param [Version] version Version that contains the resource # @param [String] phone_number The phone number to lookup in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists # of a + followed by the country code and subscriber number. # @return [PhoneNumberContext] PhoneNumberContext def initialize(version, phone_number) @@ -76,8 +76,8 @@ def initialize(version, phone_number) ## # Fetch the PhoneNumberInstance - # @param [String] country_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to + # @param [String] country_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to # fetch. This is used to specify the country when the phone number is provided in # a national format. # @param [String] type The type of information to return. Can be: `carrier` or @@ -89,8 +89,8 @@ def initialize(version, phone_number) # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke. # Can be the `unique_name` of an Add-on that is installed on your account. You can # specify multiple instances of this parameter to invoke multiple Add-ons. For - # more information about Add-ons, see the [Add-ons - # documentation](https://www.twilio.com/docs/add-ons). + # more information about Add-ons, see the {Add-ons + # documentation}[https://www.twilio.com/docs/add-ons]. # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke. # The content and format of this value depends on the add-on. # @return [PhoneNumberInstance] Fetched PhoneNumberInstance @@ -128,7 +128,7 @@ class PhoneNumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] phone_number The phone number to lookup in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists # of a + followed by the country code and subscriber number. # @return [PhoneNumberInstance] PhoneNumberInstance def initialize(version, payload, phone_number: nil) @@ -205,8 +205,8 @@ def url ## # Fetch the PhoneNumberInstance - # @param [String] country_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to + # @param [String] country_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to # fetch. This is used to specify the country when the phone number is provided in # a national format. # @param [String] type The type of information to return. Can be: `carrier` or @@ -218,8 +218,8 @@ def url # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke. # Can be the `unique_name` of an Add-on that is installed on your account. You can # specify multiple instances of this parameter to invoke multiple Add-ons. For - # more information about Add-ons, see the [Add-ons - # documentation](https://www.twilio.com/docs/add-ons). + # more information about Add-ons, see the {Add-ons + # documentation}[https://www.twilio.com/docs/add-ons]. # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke. # The content and format of this value depends on the add-on. # @return [PhoneNumberInstance] Fetched PhoneNumberInstance diff --git a/lib/twilio-ruby/rest/messaging/v1/service.rb b/lib/twilio-ruby/rest/messaging/v1/service.rb index 5c291b49f..c15453b54 100644 --- a/lib/twilio-ruby/rest/messaging/v1/service.rb +++ b/lib/twilio-ruby/rest/messaging/v1/service.rb @@ -40,24 +40,24 @@ def initialize(version) # Request URL. # @param [String] fallback_method The HTTP method we should use to call # `fallback_url`. Can be: `GET` or `POST`. - # @param [String] status_callback The URL we should call to [pass status - # updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) + # @param [String] status_callback The URL we should call to {pass status + # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values] # about message delivery. - # @param [Boolean] sticky_sender Whether to enable [Sticky - # Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service + # @param [Boolean] sticky_sender Whether to enable {Sticky + # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service # instance. - # @param [Boolean] mms_converter Whether to enable the [MMS - # Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages + # @param [Boolean] mms_converter Whether to enable the {MMS + # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages # sent through the Service instance. - # @param [Boolean] smart_encoding Whether to enable [Smart - # Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages + # @param [Boolean] smart_encoding Whether to enable {Smart + # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages # sent through the Service instance. # @param [service.ScanMessageContent] scan_message_content Reserved. - # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long - # Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for + # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long + # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for # messages sent through the Service instance. - # @param [Boolean] area_code_geomatch Whether to enable [Area Code - # Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the + # @param [Boolean] area_code_geomatch Whether to enable {Area Code + # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the # Service Instance. # @param [String] validity_period How long, in seconds, messages sent from the # Service are valid. Can be an integer from `1` to `14,400`. @@ -240,24 +240,24 @@ def initialize(version, sid) # Request URL. # @param [String] fallback_method The HTTP method we should use to call # `fallback_url`. Can be: `GET` or `POST`. - # @param [String] status_callback The URL we should call to [pass status - # updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) + # @param [String] status_callback The URL we should call to {pass status + # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values] # about message delivery. - # @param [Boolean] sticky_sender Whether to enable [Sticky - # Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service + # @param [Boolean] sticky_sender Whether to enable {Sticky + # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service # instance. - # @param [Boolean] mms_converter Whether to enable the [MMS - # Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages + # @param [Boolean] mms_converter Whether to enable the {MMS + # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages # sent through the Service instance. - # @param [Boolean] smart_encoding Whether to enable [Smart - # Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages + # @param [Boolean] smart_encoding Whether to enable {Smart + # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages # sent through the Service instance. # @param [service.ScanMessageContent] scan_message_content Reserved. - # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long - # Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for + # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long + # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for # messages sent through the Service instance. - # @param [Boolean] area_code_geomatch Whether to enable [Area Code - # Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the + # @param [Boolean] area_code_geomatch Whether to enable {Area Code + # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the # Service Instance. # @param [String] validity_period How long, in seconds, messages sent from the # Service are valid. Can be an integer from `1` to `14,400`. @@ -558,24 +558,24 @@ def links # Request URL. # @param [String] fallback_method The HTTP method we should use to call # `fallback_url`. Can be: `GET` or `POST`. - # @param [String] status_callback The URL we should call to [pass status - # updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) + # @param [String] status_callback The URL we should call to {pass status + # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values] # about message delivery. - # @param [Boolean] sticky_sender Whether to enable [Sticky - # Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service + # @param [Boolean] sticky_sender Whether to enable {Sticky + # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service # instance. - # @param [Boolean] mms_converter Whether to enable the [MMS - # Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages + # @param [Boolean] mms_converter Whether to enable the {MMS + # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages # sent through the Service instance. - # @param [Boolean] smart_encoding Whether to enable [Smart - # Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages + # @param [Boolean] smart_encoding Whether to enable {Smart + # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages # sent through the Service instance. # @param [service.ScanMessageContent] scan_message_content Reserved. - # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long - # Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for + # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long + # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for # messages sent through the Service instance. - # @param [Boolean] area_code_geomatch Whether to enable [Area Code - # Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the + # @param [Boolean] area_code_geomatch Whether to enable {Area Code + # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the # Service Instance. # @param [String] validity_period How long, in seconds, messages sent from the # Service are valid. Can be an integer from `1` to `14,400`. diff --git a/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb b/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb index 3d4b2d171..e74cfa788 100644 --- a/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +++ b/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb @@ -18,7 +18,7 @@ class AlphaSenderList < ListResource # Initialize the AlphaSenderList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @return [AlphaSenderList] AlphaSenderList def initialize(version, service_sid: nil) @@ -168,7 +168,7 @@ class AlphaSenderContext < InstanceContext # Initialize the AlphaSenderContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # resource from. # @param [String] sid The SID of the AlphaSender resource to fetch. # @return [AlphaSenderContext] AlphaSenderContext @@ -224,7 +224,7 @@ class AlphaSenderInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @param [String] sid The SID of the AlphaSender resource to fetch. # @return [AlphaSenderInstance] AlphaSenderInstance diff --git a/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb b/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb index 10d4bbccc..c698baacc 100644 --- a/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +++ b/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb @@ -18,7 +18,7 @@ class PhoneNumberList < ListResource # Initialize the PhoneNumberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @return [PhoneNumberList] PhoneNumberList def initialize(version, service_sid: nil) @@ -167,7 +167,7 @@ class PhoneNumberContext < InstanceContext # Initialize the PhoneNumberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # resource from. # @param [String] sid The SID of the PhoneNumber resource to fetch. # @return [PhoneNumberContext] PhoneNumberContext @@ -223,7 +223,7 @@ class PhoneNumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @param [String] sid The SID of the PhoneNumber resource to fetch. # @return [PhoneNumberInstance] PhoneNumberInstance diff --git a/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb b/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb index 4e5575900..230c2b575 100644 --- a/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +++ b/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb @@ -18,7 +18,7 @@ class ShortCodeList < ListResource # Initialize the ShortCodeList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @return [ShortCodeList] ShortCodeList def initialize(version, service_sid: nil) @@ -167,7 +167,7 @@ class ShortCodeContext < InstanceContext # Initialize the ShortCodeContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the # resource from. # @param [String] sid The SID of the ShortCode resource to fetch. # @return [ShortCodeContext] ShortCodeContext @@ -218,7 +218,7 @@ class ShortCodeInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource + # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource # is associated with. # @param [String] sid The SID of the ShortCode resource to fetch. # @return [ShortCodeInstance] ShortCodeInstance diff --git a/lib/twilio-ruby/rest/monitor/v1/event.rb b/lib/twilio-ruby/rest/monitor/v1/event.rb index 32ae1c8f0..98c6286a3 100644 --- a/lib/twilio-ruby/rest/monitor/v1/event.rb +++ b/lib/twilio-ruby/rest/monitor/v1/event.rb @@ -29,18 +29,18 @@ def initialize(version) # memory before returning. # @param [String] actor_sid Only include events initiated by this Actor. Useful # for auditing actions taken by specific users or API credentials. - # @param [String] event_type Only include events of this [Event - # Type](https://www.twilio.com/docs/usage/monitor-events#event-types). + # @param [String] event_type Only include events of this {Event + # Type}[https://www.twilio.com/docs/usage/monitor-events#event-types]. # @param [String] resource_sid Only include events that refer to this resource. # Useful for discovering the history of a specific resource. # @param [String] source_ip_address Only include events that originated from this # IP address. Useful for tracking suspicious activity originating from the API or # the Twilio Console. # @param [Time] start_date Only include events that occurred on or after this - # date. Specify the date in GMT and [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # date. Specify the date in GMT and {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only include events that occurred on or before this date. - # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -68,18 +68,18 @@ def list(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_ # is reached. # @param [String] actor_sid Only include events initiated by this Actor. Useful # for auditing actions taken by specific users or API credentials. - # @param [String] event_type Only include events of this [Event - # Type](https://www.twilio.com/docs/usage/monitor-events#event-types). + # @param [String] event_type Only include events of this {Event + # Type}[https://www.twilio.com/docs/usage/monitor-events#event-types]. # @param [String] resource_sid Only include events that refer to this resource. # Useful for discovering the history of a specific resource. # @param [String] source_ip_address Only include events that originated from this # IP address. Useful for tracking suspicious activity originating from the API or # the Twilio Console. # @param [Time] start_date Only include events that occurred on or after this - # date. Specify the date in GMT and [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # date. Specify the date in GMT and {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only include events that occurred on or before this date. - # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -123,18 +123,18 @@ def each # Request is executed immediately. # @param [String] actor_sid Only include events initiated by this Actor. Useful # for auditing actions taken by specific users or API credentials. - # @param [String] event_type Only include events of this [Event - # Type](https://www.twilio.com/docs/usage/monitor-events#event-types). + # @param [String] event_type Only include events of this {Event + # Type}[https://www.twilio.com/docs/usage/monitor-events#event-types]. # @param [String] resource_sid Only include events that refer to this resource. # Useful for discovering the history of a specific resource. # @param [String] source_ip_address Only include events that originated from this # IP address. Useful for tracking suspicious activity originating from the API or # the Twilio Console. # @param [Time] start_date Only include events that occurred on or after this - # date. Specify the date in GMT and [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # date. Specify the date in GMT and {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only include events that occurred on or before this date. - # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # format. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state diff --git a/lib/twilio-ruby/rest/notify/v1/service.rb b/lib/twilio-ruby/rest/notify/v1/service.rb index 14c5ba8a2..554f65912 100644 --- a/lib/twilio-ruby/rest/notify/v1/service.rb +++ b/lib/twilio-ruby/rest/notify/v1/service.rb @@ -30,31 +30,31 @@ def initialize(version) # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] apn_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for APN Bindings. # @param [String] gcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for GCM Bindings. - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/send-messages#messaging-services] to # use for SMS Bindings. This parameter must be set in order to send SMS # notifications. # @param [String] facebook_messenger_page_id Deprecated. # @param [String] default_apn_notification_protocol_version The protocol version # to use for sending APNS notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] default_gcm_notification_protocol_version The protocol version # to use for sending GCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] fcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for FCM Bindings. # @param [String] default_fcm_notification_protocol_version The protocol version # to use for sending FCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or # `false` and the default is `true`. # @param [String] alexa_skill_id Deprecated. @@ -253,31 +253,31 @@ def fetch # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] apn_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for APN Bindings. # @param [String] gcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for GCM Bindings. - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/send-messages#messaging-services] to # use for SMS Bindings. This parameter must be set in order to send SMS # notifications. # @param [String] facebook_messenger_page_id Deprecated. # @param [String] default_apn_notification_protocol_version The protocol version # to use for sending APNS notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] default_gcm_notification_protocol_version The protocol version # to use for sending GCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] fcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for FCM Bindings. # @param [String] default_fcm_notification_protocol_version The protocol version # to use for sending FCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or # `false` and the default is `true`. # @param [String] alexa_skill_id Deprecated. @@ -546,31 +546,31 @@ def fetch # @param [String] friendly_name A descriptive string that you create to describe # the resource. It can be up to 64 characters long. # @param [String] apn_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for APN Bindings. # @param [String] gcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for GCM Bindings. - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/send-messages#messaging-services] to # use for SMS Bindings. This parameter must be set in order to send SMS # notifications. # @param [String] facebook_messenger_page_id Deprecated. # @param [String] default_apn_notification_protocol_version The protocol version # to use for sending APNS notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] default_gcm_notification_protocol_version The protocol version # to use for sending GCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [String] fcm_credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] to use # for FCM Bindings. # @param [String] default_fcm_notification_protocol_version The protocol version # to use for sending FCM notifications. Can be overridden on a Binding by Binding # basis when creating a - # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource. + # {Binding}[https://www.twilio.com/docs/notify/api/binding-resource] resource. # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or # `false` and the default is `true`. # @param [String] alexa_skill_id Deprecated. diff --git a/lib/twilio-ruby/rest/notify/v1/service/binding.rb b/lib/twilio-ruby/rest/notify/v1/service/binding.rb index 3c072d2f9..34bc0d92d 100644 --- a/lib/twilio-ruby/rest/notify/v1/service/binding.rb +++ b/lib/twilio-ruby/rest/notify/v1/service/binding.rb @@ -18,7 +18,7 @@ class BindingList < ListResource # Initialize the BindingList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource + # {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource # is associated with. # @return [BindingList] BindingList def initialize(version, service_sid: nil) @@ -32,8 +32,8 @@ def initialize(version, service_sid: nil) ## # Create the BindingInstance # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/notify/api/service-resource]. Up to 20 # Bindings can be created for the same Identity in a given Service. # @param [binding.BindingType] binding_type The transport technology to use for # the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`. @@ -46,12 +46,12 @@ def initialize(version, service_sid: nil) # @param [String] notification_protocol_version The protocol version to use to # send the notification. This defaults to the value of # `default_xxxx_notification_protocol_version` for the protocol in the - # [Service](https://www.twilio.com/docs/notify/api/service-resource). The current + # {Service}[https://www.twilio.com/docs/notify/api/service-resource]. The current # version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not # applicable to `sms` and `facebook-messenger` type Bindings as the data format is # fixed. # @param [String] credential_sid The SID of the - # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) + # {Credential}[https://www.twilio.com/docs/notify/api/credential-resource] # resource to be used to send notifications to this Binding. If present, this # overrides the Credential specified in the Service resource. Applies to only # `apn`, `fcm`, and `gcm` type Bindings. @@ -82,7 +82,7 @@ def create(identity: nil, binding_type: nil, address: nil, tag: :unset, notifica # @param [Date] end_date Only include usage that occurred on or before this date. # Specify the date in GMT and format as `YYYY-MM-DD`. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value # of the resources to read. # @param [String] tag Only list Bindings that have all of the specified Tags. The # following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, @@ -114,7 +114,7 @@ def list(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, li # @param [Date] end_date Only include usage that occurred on or before this date. # Specify the date in GMT and format as `YYYY-MM-DD`. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value # of the resources to read. # @param [String] tag Only list Bindings that have all of the specified Tags. The # following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, @@ -162,7 +162,7 @@ def each # @param [Date] end_date Only include usage that occurred on or before this date. # Specify the date in GMT and format as `YYYY-MM-DD`. # @param [String] identity The - # [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value + # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value # of the resources to read. # @param [String] tag Only list Bindings that have all of the specified Tags. The # following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, @@ -245,7 +245,7 @@ class BindingContext < InstanceContext # Initialize the BindingContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/notify/api/service-resource) to fetch the + # {Service}[https://www.twilio.com/docs/notify/api/service-resource] to fetch the # resource from. # @param [String] sid The Twilio-provided string that uniquely identifies the # Binding resource to fetch. @@ -297,7 +297,7 @@ class BindingInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource + # {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource # is associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Binding resource to fetch. diff --git a/lib/twilio-ruby/rest/notify/v1/service/notification.rb b/lib/twilio-ruby/rest/notify/v1/service/notification.rb index 54e8ea5ed..fa3f55aaa 100644 --- a/lib/twilio-ruby/rest/notify/v1/service/notification.rb +++ b/lib/twilio-ruby/rest/notify/v1/service/notification.rb @@ -18,7 +18,7 @@ class NotificationList < ListResource # Initialize the NotificationList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource + # {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource # is associated with. # @return [NotificationList] NotificationList def initialize(version, service_sid: nil) @@ -63,8 +63,8 @@ def initialize(version, service_sid: nil) # from deliveries to those channels. # @param [Hash] data The custom key-value pairs of the notification's payload. For # FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM - # and GCM [reserve certain - # keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that + # and GCM {reserve certain + # keys}[https://firebase.google.com/docs/cloud-messaging/http-server-ref] that # cannot be used in those channels. For APNS, attributes of `data` are inserted # into the APNS payload as custom properties outside of the `aps` dictionary. In # all channels, we reserve keys that start with `twi_` for future use. Custom keys @@ -75,23 +75,23 @@ def initialize(version, service_sid: nil) # attributes in the generic payload for APNS Bindings. This property maps to the # APNS `Payload` item, therefore the `aps` key must be used to change standard # attributes. Adds custom key-value pairs to the root of the dictionary. See the - # [APNS - # documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) + # {APNS + # documentation}[https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html] # for more details. We reserve keys that start with `twi_` for future use. Custom # keys that start with `twi_` are not allowed. # @param [Hash] gcm The GCM-specific payload that overrides corresponding # attributes in the generic payload for GCM Bindings. This property maps to the - # root JSON dictionary. See the [GCM - # documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) + # root JSON dictionary. See the {GCM + # documentation}[https://firebase.google.com/docs/cloud-messaging/http-server-ref] # for more details. Target parameters `to`, `registration_ids`, and # `notification_key` are not allowed. We reserve keys that start with `twi_` for # future use. Custom keys that start with `twi_` are not allowed. GCM also - # [reserves certain - # keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref). + # {reserves certain + # keys}[https://firebase.google.com/docs/cloud-messaging/http-server-ref]. # @param [Hash] sms The SMS-specific payload that overrides corresponding # attributes in the generic payload for SMS Bindings. Each attribute in this # value maps to the corresponding `form` parameter of the Twilio - # [Message](https://www.twilio.com/docs/sms/send-messages) resource. These + # {Message}[https://www.twilio.com/docs/sms/send-messages] resource. These # parameters of the Message resource are supported in snake case format: `body`, # `media_urls`, `status_callback`, and `max_price`. The `status_callback` # parameter overrides the corresponding parameter in the messaging service, if @@ -99,13 +99,13 @@ def initialize(version, service_sid: nil) # @param [Hash] facebook_messenger Deprecated. # @param [Hash] fcm The FCM-specific payload that overrides corresponding # attributes in the generic payload for FCM Bindings. This property maps to the - # root JSON dictionary. See the [FCM - # documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) + # root JSON dictionary. See the {FCM + # documentation}[https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream] # for more details. Target parameters `to`, `registration_ids`, `condition`, and # `notification_key` are not allowed in this parameter. We reserve keys that start # with `twi_` for future use. Custom keys that start with `twi_` are not allowed. - # FCM also [reserves certain - # keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which + # FCM also {reserves certain + # keys}[https://firebase.google.com/docs/cloud-messaging/http-server-ref], which # cannot be used in that channel. # @param [String] segment The Segment resource is deprecated. Use the `tag` # parameter, instead. @@ -116,8 +116,8 @@ def initialize(version, service_sid: nil) # phone numbers. # @param [String] delivery_callback_url URL to send webhooks. # @param [String] identity The `identity` value that uniquely identifies the new - # resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within - # the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery + # resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within + # the {Service}[https://www.twilio.com/docs/notify/api/service-resource]. Delivery # will be attempted only to Bindings with an Identity in this list. No more than # 20 items are allowed in this list. # @param [String] tag A tag that selects the Bindings to notify. Repeat this @@ -199,7 +199,7 @@ class NotificationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource + # {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource # is associated with. # @return [NotificationInstance] NotificationInstance def initialize(version, payload, service_sid: nil) diff --git a/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb b/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb index b15df46ea..8df2a049a 100644 --- a/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +++ b/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb @@ -33,8 +33,8 @@ def initialize(version) # signing. # @param [authorization_document.Status] status Status of an instance resource. It # can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. - # failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -55,8 +55,8 @@ def list(email: :unset, status: :unset, limit: nil, page_size: nil) # signing. # @param [authorization_document.Status] status Status of an instance resource. It # can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. - # failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -94,8 +94,8 @@ def each # signing. # @param [authorization_document.Status] status Status of an instance resource. It # can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. - # failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -239,8 +239,8 @@ def fetch # Authorization Document has been sent and signed # @param [authorization_document.Status] status Status of an instance resource. It # can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. - # failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] contact_title The title of the person authorized to sign the # Authorization Document for this phone number. @@ -409,8 +409,8 @@ def fetch # Authorization Document has been sent and signed # @param [authorization_document.Status] status Status of an instance resource. It # can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. - # failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] contact_title The title of the person authorized to sign the # Authorization Document for this phone number. diff --git a/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb b/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb index 3a57af7f7..bd26b97fd 100644 --- a/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +++ b/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb @@ -34,8 +34,8 @@ def initialize(version, signing_document_sid: nil) # memory before returning. # @param [dependent_hosted_number_order.Status] status Status of an instance # resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. - # canceled, 5. failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # canceled, 5. failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] phone_number An E164 formatted phone number hosted by this # HostedNumberOrder. @@ -71,8 +71,8 @@ def list(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset # is reached. # @param [dependent_hosted_number_order.Status] status Status of an instance # resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. - # canceled, 5. failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # canceled, 5. failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] phone_number An E164 formatted phone number hosted by this # HostedNumberOrder. @@ -124,8 +124,8 @@ def each # Request is executed immediately. # @param [dependent_hosted_number_order.Status] status Status of an instance # resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. - # canceled, 5. failed. See the section entitled [Status - # Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + # canceled, 5. failed. See the section entitled {Status + # Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] # for more information on each of these statuses. # @param [String] phone_number An E164 formatted phone number hosted by this # HostedNumberOrder. diff --git a/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb b/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb index b83a56b8d..66eaeaf6a 100644 --- a/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +++ b/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb @@ -164,7 +164,7 @@ def get_page(target_url) ## # Create the HostedNumberOrderInstance # @param [String] phone_number The number to host in - # [+E.164](https://en.wikipedia.org/wiki/E.164) format + # {+E.164}[https://en.wikipedia.org/wiki/E.164] format # @param [Boolean] sms_capability Used to specify that the SMS capability will be # hosted on Twilio's platform. # @param [String] account_sid This defaults to the AccountSid of the authorization diff --git a/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb b/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb index 0e43f1433..33d041049 100644 --- a/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +++ b/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb @@ -27,12 +27,12 @@ def initialize(version) ## # Create the BrandedCallInstance - # @param [String] from The phone number to use as the caller id, given in [E.164 - # format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio + # @param [String] from The phone number to use as the caller id, given in {E.164 + # format}[https://www.twilio.com/docs/glossary/what-e164]. It must be a Twilio # number that has been set up as a Branded Number in the Business Profile section # for your account. - # @param [String] to The terminating Phone Number, given in [E.164 - # format](https://www.twilio.com/docs/glossary/what-e164). + # @param [String] to The terminating Phone Number, given in {E.164 + # format}[https://www.twilio.com/docs/glossary/what-e164]. # @param [String] reason The business reason for this phone call that will appear # in the terminating device's screen. Max 50 characters. # @param [String] call_sid The Call sid this Branded Call should link to. diff --git a/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb b/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb index 1b2fae9e7..f746e6c4b 100644 --- a/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb +++ b/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb @@ -80,11 +80,11 @@ def initialize(version) ## # Fetch the CurrentCallInstance # @param [String] x_xcnam_sensitive_phone_number_from The originating Phone - # Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # Number, given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # This phone number should be a Twilio number, otherwise it will return an error # with HTTP Status Code 400. # @param [String] x_xcnam_sensitive_phone_number_to The terminating Phone Number, - # given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # @return [CurrentCallInstance] Fetched CurrentCallInstance def fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset) headers = Twilio::Values.of({ @@ -244,11 +244,11 @@ def use_case ## # Fetch the CurrentCallInstance # @param [String] x_xcnam_sensitive_phone_number_from The originating Phone - # Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # Number, given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # This phone number should be a Twilio number, otherwise it will return an error # with HTTP Status Code 400. # @param [String] x_xcnam_sensitive_phone_number_to The terminating Phone Number, - # given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # @return [CurrentCallInstance] Fetched CurrentCallInstance def fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset) context.fetch( diff --git a/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb b/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb index 9778ec713..ecdf2cd67 100644 --- a/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +++ b/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb @@ -27,86 +27,86 @@ def initialize(version) ## # Create the PhoneCallInstance - # @param [String] from The phone number to use as the caller id, given in [E.164 - # format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio + # @param [String] from The phone number to use as the caller id, given in {E.164 + # format}[https://www.twilio.com/docs/glossary/what-e164]. It must be a Twilio # number that has been set up as a Branded Number in the Business Profile section # for your account. - # @param [String] to The terminating Phone Number, given in [E.164 - # format](https://www.twilio.com/docs/glossary/what-e164). + # @param [String] to The terminating Phone Number, given in {E.164 + # format}[https://www.twilio.com/docs/glossary/what-e164]. # @param [String] reason The business reason for this phone call that will appear # in the terminating device's screen. Max 50 characters. # @param [String] application_sid Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] caller_id Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] fallback_method Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] fallback_url Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] machine_detection Refers to the parameter with the same name - # when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] machine_detection_silence_timeout Refers to the parameter with - # the same name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # the same name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] machine_detection_speech_end_threshold Refers to the parameter - # with the same name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # with the same name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] machine_detection_speech_threshold Refers to the parameter with - # the same name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # the same name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] machine_detection_timeout Refers to the parameter with the same - # name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] method Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [Boolean] record Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] recording_channels Refers to the parameter with the same name - # when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] recording_status_callback Refers to the parameter with the same - # name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] recording_status_callback_event Refers to the parameter with the - # same name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # same name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] recording_status_callback_method Refers to the parameter with - # the same name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # the same name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] send_digits Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] sip_auth_password Refers to the parameter with the same name - # when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] sip_auth_username Refers to the parameter with the same name - # when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] status_callback Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] status_callback_event Refers to the parameter with the same name - # when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] status_callback_method Refers to the parameter with the same - # name when [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # name when {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @param [String] timeout Refers to the parameter with the same name when - # [initiating a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - # @param [String] trim Refers to the parameter with the same name when [initiating + # {initiating a call via Voice + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] + # @param [String] trim Refers to the parameter with the same name when {initiating # a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - # @param [String] url Refers to the parameter with the same name when [initiating + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] + # @param [String] url Refers to the parameter with the same name when {initiating # a call via Voice - # API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + # API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource] # @return [PhoneCallInstance] Created PhoneCallInstance def create(from: nil, to: nil, reason: :unset, application_sid: :unset, caller_id: :unset, fallback_method: :unset, fallback_url: :unset, machine_detection: :unset, machine_detection_silence_timeout: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_speech_threshold: :unset, machine_detection_timeout: :unset, method: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_event: :unset, recording_status_callback_method: :unset, send_digits: :unset, sip_auth_password: :unset, sip_auth_username: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, timeout: :unset, trim: :unset, url: :unset) data = Twilio::Values.of({ diff --git a/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb b/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb index 0b043c33c..05917e442 100644 --- a/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +++ b/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb @@ -112,8 +112,8 @@ def get_page(target_url) ## # Create the FieldInstance # @param [String] field_type The unique name or sid of the FieldType. It can be - # any [Built-in Field - # Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the + # any {Built-in Field + # Type}[https://www.twilio.com/docs/assistant/api/built-in-field-types] or the # unique_name or the Field Type sid of a custom Field Type. # @param [String] unique_name A user-provided string that uniquely identifies this # resource as an alternative to the sid. Unique up to 64 characters long. diff --git a/lib/twilio-ruby/rest/pricing/v1/messaging.rb b/lib/twilio-ruby/rest/pricing/v1/messaging.rb index 510b0ed8b..4c8be9593 100644 --- a/lib/twilio-ruby/rest/pricing/v1/messaging.rb +++ b/lib/twilio-ruby/rest/pricing/v1/messaging.rb @@ -27,8 +27,8 @@ def initialize(version) ## # Access the countries - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryList] # @return [CountryContext] if iso_country was passed. diff --git a/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb b/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb index d643bd19d..874124f7b 100644 --- a/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +++ b/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb @@ -144,8 +144,8 @@ class CountryContext < InstanceContext ## # Initialize the CountryContext # @param [Version] version Version that contains the resource - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryContext] CountryContext def initialize(version, iso_country) @@ -185,8 +185,8 @@ class CountryInstance < InstanceResource # Initialize the CountryInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryInstance] CountryInstance def initialize(version, payload, iso_country: nil) diff --git a/lib/twilio-ruby/rest/pricing/v1/phone_number.rb b/lib/twilio-ruby/rest/pricing/v1/phone_number.rb index ea1a4647d..af415cd77 100644 --- a/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +++ b/lib/twilio-ruby/rest/pricing/v1/phone_number.rb @@ -27,8 +27,8 @@ def initialize(version) ## # Access the countries - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryList] # @return [CountryContext] if iso_country was passed. diff --git a/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb b/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb index 6c4c64977..4bfa10436 100644 --- a/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +++ b/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb @@ -144,8 +144,8 @@ class CountryContext < InstanceContext ## # Initialize the CountryContext # @param [Version] version Version that contains the resource - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryContext] CountryContext def initialize(version, iso_country) @@ -185,8 +185,8 @@ class CountryInstance < InstanceResource # Initialize the CountryInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryInstance] CountryInstance def initialize(version, payload, iso_country: nil) diff --git a/lib/twilio-ruby/rest/pricing/v1/voice.rb b/lib/twilio-ruby/rest/pricing/v1/voice.rb index 13a80b83c..12e161f54 100644 --- a/lib/twilio-ruby/rest/pricing/v1/voice.rb +++ b/lib/twilio-ruby/rest/pricing/v1/voice.rb @@ -43,8 +43,8 @@ def numbers(number=:unset) ## # Access the countries - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryList] # @return [CountryContext] if iso_country was passed. diff --git a/lib/twilio-ruby/rest/pricing/v1/voice/country.rb b/lib/twilio-ruby/rest/pricing/v1/voice/country.rb index 35e54131e..3b2a4a7fd 100644 --- a/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +++ b/lib/twilio-ruby/rest/pricing/v1/voice/country.rb @@ -144,8 +144,8 @@ class CountryContext < InstanceContext ## # Initialize the CountryContext # @param [Version] version Version that contains the resource - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryContext] CountryContext def initialize(version, iso_country) @@ -185,8 +185,8 @@ class CountryInstance < InstanceResource # Initialize the CountryInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_country The [ISO country - # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing + # @param [String] iso_country The {ISO country + # code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing # information to fetch. # @return [CountryInstance] CountryInstance def initialize(version, payload, iso_country: nil) diff --git a/lib/twilio-ruby/rest/pricing/v2/voice.rb b/lib/twilio-ruby/rest/pricing/v2/voice.rb index df4f1ac13..3fde56e6f 100644 --- a/lib/twilio-ruby/rest/pricing/v2/voice.rb +++ b/lib/twilio-ruby/rest/pricing/v2/voice.rb @@ -28,8 +28,8 @@ def initialize(version) ## # Access the countries - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based # voice pricing information to fetch. # @return [CountryList] # @return [CountryContext] if iso_country was passed. @@ -46,7 +46,7 @@ def countries(iso_country=:unset) ## # Access the numbers # @param [String] destination_number The destination phone number, in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to # fetch the origin-based voice pricing information. E.164 format consists of a + # followed by the country code and subscriber number. # @return [NumberList] diff --git a/lib/twilio-ruby/rest/pricing/v2/voice/country.rb b/lib/twilio-ruby/rest/pricing/v2/voice/country.rb index 5d61c85f4..5d65e7113 100644 --- a/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +++ b/lib/twilio-ruby/rest/pricing/v2/voice/country.rb @@ -144,8 +144,8 @@ class CountryContext < InstanceContext ## # Initialize the CountryContext # @param [Version] version Version that contains the resource - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based # voice pricing information to fetch. # @return [CountryContext] CountryContext def initialize(version, iso_country) @@ -185,8 +185,8 @@ class CountryInstance < InstanceResource # Initialize the CountryInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based # voice pricing information to fetch. # @return [CountryInstance] CountryInstance def initialize(version, payload, iso_country: nil) diff --git a/lib/twilio-ruby/rest/pricing/v2/voice/number.rb b/lib/twilio-ruby/rest/pricing/v2/voice/number.rb index 3000cab1e..2645d6449 100644 --- a/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +++ b/lib/twilio-ruby/rest/pricing/v2/voice/number.rb @@ -64,7 +64,7 @@ class NumberContext < InstanceContext # Initialize the NumberContext # @param [Version] version Version that contains the resource # @param [String] destination_number The destination phone number, in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to # fetch the origin-based voice pricing information. E.164 format consists of a + # followed by the country code and subscriber number. # @return [NumberContext] NumberContext @@ -79,7 +79,7 @@ def initialize(version, destination_number) ## # Fetch the NumberInstance # @param [String] origination_number The origination phone number, in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to # fetch the origin-based voice pricing information. E.164 format consists of a + # followed by the country code and subscriber number. # @return [NumberInstance] Fetched NumberInstance @@ -112,7 +112,7 @@ class NumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] destination_number The destination phone number, in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to # fetch the origin-based voice pricing information. E.164 format consists of a + # followed by the country code and subscriber number. # @return [NumberInstance] NumberInstance @@ -198,7 +198,7 @@ def url ## # Fetch the NumberInstance # @param [String] origination_number The origination phone number, in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to # fetch the origin-based voice pricing information. E.164 format consists of a + # followed by the country code and subscriber number. # @return [NumberInstance] Fetched NumberInstance diff --git a/lib/twilio-ruby/rest/proxy/v1/service.rb b/lib/twilio-ruby/rest/proxy/v1/service.rb index e5eadcd99..389c4d274 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service.rb @@ -126,7 +126,7 @@ def get_page(target_url) # `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. # `prefer-sticky` means that we will try and select the same Proxy Number for a # given participant if they have previous - # [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail + # {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail # if that Proxy Number cannot be used. `avoid-sticky` means that we will try to # use different Proxy Numbers as long as that is possible within a given pool # rather than try and use a previously assigned number. @@ -135,12 +135,12 @@ def get_page(target_url) # continues. # @param [String] out_of_session_callback_url The URL we should call when an # inbound call or SMS action occurs on a closed or non-existent Session. If your - # server (or a Twilio [function](https://www.twilio.com/functions)) responds with - # valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This + # server (or a Twilio {function}[https://www.twilio.com/functions]) responds with + # valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This # means it is possible, for example, to play a message for a call, send an # automated text message response, or redirect a call to another Phone Number. See - # [Out-of-Session Callback Response - # Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) + # {Out-of-Session Callback Response + # Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide] # for more information. # @param [String] chat_instance_sid The SID of the Chat Service Instance managed # by Proxy Service. The Chat Service enables Proxy to forward SMS and channel @@ -260,7 +260,7 @@ def delete # `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. # `prefer-sticky` means that we will try and select the same Proxy Number for a # given participant if they have previous - # [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail + # {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail # if that Proxy Number cannot be used. `avoid-sticky` means that we will try to # use different Proxy Numbers as long as that is possible within a given pool # rather than try and use a previously assigned number. @@ -269,12 +269,12 @@ def delete # continues. # @param [String] out_of_session_callback_url The URL we should call when an # inbound call or SMS action occurs on a closed or non-existent Session. If your - # server (or a Twilio [function](https://www.twilio.com/functions)) responds with - # valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This + # server (or a Twilio {function}[https://www.twilio.com/functions]) responds with + # valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This # means it is possible, for example, to play a message for a call, send an # automated text message response, or redirect a call to another Phone Number. See - # [Out-of-Session Callback Response - # Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) + # {Out-of-Session Callback Response + # Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide] # for more information. # @param [String] chat_instance_sid The SID of the Chat Service Instance managed # by Proxy Service. The Chat Service enables Proxy to forward SMS and channel @@ -532,7 +532,7 @@ def delete # `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. # `prefer-sticky` means that we will try and select the same Proxy Number for a # given participant if they have previous - # [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail + # {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail # if that Proxy Number cannot be used. `avoid-sticky` means that we will try to # use different Proxy Numbers as long as that is possible within a given pool # rather than try and use a previously assigned number. @@ -541,12 +541,12 @@ def delete # continues. # @param [String] out_of_session_callback_url The URL we should call when an # inbound call or SMS action occurs on a closed or non-existent Session. If your - # server (or a Twilio [function](https://www.twilio.com/functions)) responds with - # valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This + # server (or a Twilio {function}[https://www.twilio.com/functions]) responds with + # valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This # means it is possible, for example, to play a message for a call, send an # automated text message response, or redirect a call to another Phone Number. See - # [Out-of-Session Callback Response - # Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) + # {Out-of-Session Callback Response + # Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide] # for more information. # @param [String] chat_instance_sid The SID of the Chat Service Instance managed # by Proxy Service. The Chat Service enables Proxy to forward SMS and channel diff --git a/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb b/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb index b55cc9bf9..2400783a8 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb @@ -18,7 +18,7 @@ class PhoneNumberList < ListResource # Initialize the PhoneNumberList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the PhoneNumber resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @return [PhoneNumberList] PhoneNumberList def initialize(version, service_sid: nil) super(version) @@ -31,16 +31,16 @@ def initialize(version, service_sid: nil) ## # Create the PhoneNumberInstance # @param [String] sid The SID of a Twilio - # [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) + # {IncomingPhoneNumber}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource] # resource that represents the Twilio Number you would like to assign to your # Proxy Service. # @param [String] phone_number The phone number in - # [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone + # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone # numbers consist of a + followed by the country code and subscriber number # without punctuation characters. For example, +14155551234. # @param [Boolean] is_reserved Whether the new phone number should be reserved and - # not be assigned to a participant using proxy pool logic. See [Reserved Phone - # Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more + # not be assigned to a participant using proxy pool logic. See {Reserved Phone + # Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more # information. # @return [PhoneNumberInstance] Created PhoneNumberInstance def create(sid: :unset, phone_number: :unset, is_reserved: :unset) @@ -176,7 +176,7 @@ class PhoneNumberContext < InstanceContext # Initialize the PhoneNumberContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber + # {Service}[https://www.twilio.com/docs/proxy/api/service] of the PhoneNumber # resource to fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # PhoneNumber resource to fetch. @@ -213,8 +213,8 @@ def fetch ## # Update the PhoneNumberInstance # @param [Boolean] is_reserved Whether the phone number should be reserved and not - # be assigned to a participant using proxy pool logic. See [Reserved Phone - # Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more + # be assigned to a participant using proxy pool logic. See {Reserved Phone + # Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more # information. # @return [PhoneNumberInstance] Updated PhoneNumberInstance def update(is_reserved: :unset) @@ -253,7 +253,7 @@ class PhoneNumberInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the PhoneNumber resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # PhoneNumber resource to fetch. # @return [PhoneNumberInstance] PhoneNumberInstance @@ -381,8 +381,8 @@ def fetch ## # Update the PhoneNumberInstance # @param [Boolean] is_reserved Whether the phone number should be reserved and not - # be assigned to a participant using proxy pool logic. See [Reserved Phone - # Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more + # be assigned to a participant using proxy pool logic. See {Reserved Phone + # Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more # information. # @return [PhoneNumberInstance] Updated PhoneNumberInstance def update(is_reserved: :unset) diff --git a/lib/twilio-ruby/rest/proxy/v1/service/session.rb b/lib/twilio-ruby/rest/proxy/v1/service/session.rb index 4d10b3c39..231760dcd 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/session.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/session.rb @@ -18,7 +18,7 @@ class SessionList < ListResource # Initialize the SessionList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/proxy/api/service) the session is + # {Service}[https://www.twilio.com/docs/proxy/api/service] the session is # associated with. # @return [SessionList] SessionList def initialize(version, service_sid: nil) @@ -114,7 +114,7 @@ def get_page(target_url) # @param [String] unique_name An application-defined string that uniquely # identifies the resource. This value must be 191 characters or fewer in length # and be unique. **This value should not have PII.** - # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date when the Session should expire. If this is value is present, it overrides # the `ttl` value. # @param [String] ttl The time, in seconds, when the session will expire. The time @@ -201,7 +201,7 @@ class SessionContext < InstanceContext # Initialize the SessionContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to + # {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to # fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Session resource to fetch. @@ -236,7 +236,7 @@ def delete ## # Update the SessionInstance - # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date when the Session should expire. If this is value is present, it overrides # the `ttl` value. # @param [String] ttl The time, in seconds, when the session will expire. The time @@ -335,7 +335,7 @@ class SessionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/proxy/api/service) the session is + # {Service}[https://www.twilio.com/docs/proxy/api/service] the session is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Session resource to fetch. @@ -491,7 +491,7 @@ def delete ## # Update the SessionInstance - # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date when the Session should expire. If this is value is present, it overrides # the `ttl` value. # @param [String] ttl The time, in seconds, when the session will expire. The time diff --git a/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb b/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb index 13c7a25b1..930b4a9ec 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb @@ -19,9 +19,9 @@ class InteractionList < ListResource # Initialize the InteractionList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @return [InteractionList] InteractionList def initialize(version, service_sid: nil, session_sid: nil) super(version) @@ -161,10 +161,10 @@ class InteractionContext < InstanceContext # Initialize the InteractionContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to + # {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to # fetch. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to + # {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to # fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Interaction resource to fetch. @@ -222,9 +222,9 @@ class InteractionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Interaction resource to fetch. # @return [InteractionInstance] InteractionInstance diff --git a/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb b/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb index 0461d1666..e058e124e 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb @@ -19,9 +19,9 @@ class ParticipantList < ListResource # Initialize the ParticipantList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @return [ParticipantList] ParticipantList def initialize(version, service_sid: nil, session_sid: nil) super(version) @@ -203,10 +203,10 @@ class ParticipantContext < InstanceContext # Initialize the ParticipantContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to + # {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to # fetch. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to + # {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to # fetch. # @param [String] sid The Twilio-provided string that uniquely identifies the # Participant resource to fetch. @@ -296,9 +296,9 @@ class ParticipantInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # Participant resource to fetch. # @return [ParticipantInstance] ParticipantInstance diff --git a/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb b/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb index d5eefd5d1..98d3d541d 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb @@ -20,11 +20,11 @@ class MessageInteractionList < ListResource # Initialize the MessageInteractionList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @param [String] participant_sid The SID of the - # [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. + # {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource. # @return [MessageInteractionList] MessageInteractionList def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil) super(version) @@ -184,13 +184,13 @@ class MessageInteractionContext < InstanceContext # Initialize the MessageInteractionContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to + # {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to # fetch. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to + # {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to # fetch. # @param [String] participant_sid The SID of the - # [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. + # {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # MessageInteraction resource to fetch. # @return [MessageInteractionContext] MessageInteractionContext @@ -246,11 +246,11 @@ class MessageInteractionInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] session_sid The SID of the parent - # [Session](https://www.twilio.com/docs/proxy/api/session) resource. + # {Session}[https://www.twilio.com/docs/proxy/api/session] resource. # @param [String] participant_sid The SID of the - # [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. + # {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # MessageInteraction resource to fetch. # @return [MessageInteractionInstance] MessageInteractionInstance diff --git a/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb b/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb index eb25800b7..b46820088 100644 --- a/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +++ b/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb @@ -18,7 +18,7 @@ class ShortCodeList < ListResource # Initialize the ShortCodeList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the ShortCode resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @return [ShortCodeList] ShortCodeList def initialize(version, service_sid: nil) super(version) @@ -31,7 +31,7 @@ def initialize(version, service_sid: nil) ## # Create the ShortCodeInstance # @param [String] sid The SID of a Twilio - # [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that + # {ShortCode}[https://www.twilio.com/docs/sms/api/short-code] resource that # represents the short code you would like to assign to your Proxy Service. # @return [ShortCodeInstance] Created ShortCodeInstance def create(sid: nil) @@ -167,7 +167,7 @@ class ShortCodeContext < InstanceContext # Initialize the ShortCodeContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the parent - # [Service](https://www.twilio.com/docs/proxy/api/service) to fetch the resource + # {Service}[https://www.twilio.com/docs/proxy/api/service] to fetch the resource # from. # @param [String] sid The Twilio-provided string that uniquely identifies the # ShortCode resource to fetch. @@ -199,8 +199,8 @@ def fetch ## # Update the ShortCodeInstance # @param [Boolean] is_reserved Whether the short code should be reserved and not - # be assigned to a participant using proxy pool logic. See [Reserved Phone - # Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more + # be assigned to a participant using proxy pool logic. See {Reserved Phone + # Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more # information. # @return [ShortCodeInstance] Updated ShortCodeInstance def update(is_reserved: :unset) @@ -234,7 +234,7 @@ class ShortCodeInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the ShortCode resource's parent - # [Service](https://www.twilio.com/docs/proxy/api/service) resource. + # {Service}[https://www.twilio.com/docs/proxy/api/service] resource. # @param [String] sid The Twilio-provided string that uniquely identifies the # ShortCode resource to fetch. # @return [ShortCodeInstance] ShortCodeInstance @@ -348,8 +348,8 @@ def fetch ## # Update the ShortCodeInstance # @param [Boolean] is_reserved Whether the short code should be reserved and not - # be assigned to a participant using proxy pool logic. See [Reserved Phone - # Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more + # be assigned to a participant using proxy pool logic. See {Reserved Phone + # Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more # information. # @return [ShortCodeInstance] Updated ShortCodeInstance def update(is_reserved: :unset) diff --git a/lib/twilio-ruby/rest/studio/v1/flow/execution.rb b/lib/twilio-ruby/rest/studio/v1/flow/execution.rb index 440f12c7e..d9674cbf9 100644 --- a/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +++ b/lib/twilio-ruby/rest/studio/v1/flow/execution.rb @@ -30,10 +30,10 @@ def initialize(version, flow_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -56,10 +56,10 @@ def list(date_created_from: :unset, date_created_to: :unset, limit: nil, page_si # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -98,10 +98,10 @@ def each # Retrieve a single page of ExecutionInstance records from the API. # Request is executed immediately. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state diff --git a/lib/twilio-ruby/rest/studio/v2/flow/execution.rb b/lib/twilio-ruby/rest/studio/v2/flow/execution.rb index ca859add2..4b4ba124e 100644 --- a/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +++ b/lib/twilio-ruby/rest/studio/v2/flow/execution.rb @@ -32,10 +32,10 @@ def initialize(version, flow_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -58,10 +58,10 @@ def list(date_created_from: :unset, date_created_to: :unset, limit: nil, page_si # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -100,10 +100,10 @@ def each # Retrieve a single page of ExecutionInstance records from the API. # Request is executed immediately. # @param [Time] date_created_from Only show Execution resources starting on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given # as `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [Time] date_created_to Only show Execution resources starting before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as # `YYYY-MM-DDThh:mm:ss-hh:mm`. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state diff --git a/lib/twilio-ruby/rest/supersim/v1/command.rb b/lib/twilio-ruby/rest/supersim/v1/command.rb index 1c38ec099..779b20276 100644 --- a/lib/twilio-ruby/rest/supersim/v1/command.rb +++ b/lib/twilio-ruby/rest/supersim/v1/command.rb @@ -28,7 +28,7 @@ def initialize(version) ## # Create the CommandInstance # @param [String] sim The `sid` or `unique_name` of the - # [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command + # {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the Command # to. # @param [String] command The message body of the command. # @param [String] callback_method The HTTP method we should use to call @@ -56,8 +56,8 @@ def create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset # @param [String] sim The SID or unique name of the Sim that Command was sent to # or from. # @param [command.Status] status The status of the Command. Can be: `queued`, - # `sent`, `delivered`, `received` or `failed`. See the [Command Status - # Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) + # `sent`, `delivered`, `received` or `failed`. See the {Command Status + # Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values] # for a description of each. # @param [command.Direction] direction The direction of the Command. Can be # `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term @@ -87,8 +87,8 @@ def list(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: # @param [String] sim The SID or unique name of the Sim that Command was sent to # or from. # @param [command.Status] status The status of the Command. Can be: `queued`, - # `sent`, `delivered`, `received` or `failed`. See the [Command Status - # Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) + # `sent`, `delivered`, `received` or `failed`. See the {Command Status + # Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values] # for a description of each. # @param [command.Direction] direction The direction of the Command. Can be # `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term @@ -129,8 +129,8 @@ def each # @param [String] sim The SID or unique name of the Sim that Command was sent to # or from. # @param [command.Status] status The status of the Command. Can be: `queued`, - # `sent`, `delivered`, `received` or `failed`. See the [Command Status - # Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) + # `sent`, `delivered`, `received` or `failed`. See the {Command Status + # Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values] # for a description of each. # @param [command.Direction] direction The direction of the Command. Can be # `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term diff --git a/lib/twilio-ruby/rest/supersim/v1/network.rb b/lib/twilio-ruby/rest/supersim/v1/network.rb index c8ab00495..5599d4bb4 100644 --- a/lib/twilio-ruby/rest/supersim/v1/network.rb +++ b/lib/twilio-ruby/rest/supersim/v1/network.rb @@ -29,8 +29,8 @@ def initialize(version) # Lists NetworkInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Network resources # to read. # @param [String] mcc The 'mobile country code' of a country. Network resources # with this `mcc` in their `identifiers` will be read. @@ -57,8 +57,8 @@ def list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: n # Streams NetworkInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Network resources # to read. # @param [String] mcc The 'mobile country code' of a country. Network resources # with this `mcc` in their `identifiers` will be read. @@ -96,8 +96,8 @@ def each ## # Retrieve a single page of NetworkInstance records from the API. # Request is executed immediately. - # @param [String] iso_country The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources + # @param [String] iso_country The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Network resources # to read. # @param [String] mcc The 'mobile country code' of a country. Network resources # with this `mcc` in their `identifiers` will be read. diff --git a/lib/twilio-ruby/rest/supersim/v1/sim.rb b/lib/twilio-ruby/rest/supersim/v1/sim.rb index af0ff1581..aa23d8dcd 100644 --- a/lib/twilio-ruby/rest/supersim/v1/sim.rb +++ b/lib/twilio-ruby/rest/supersim/v1/sim.rb @@ -34,7 +34,7 @@ def initialize(version) # @param [String] fleet The SID or unique name of the Fleet to which a list of # Sims are assigned. # @param [String] iccid The - # [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + # {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID] # associated with a Super SIM to filter the list by. Passing this parameter will # always return a list containing zero or one SIMs. # @param [Integer] limit Upper limit for the number of records to return. stream() @@ -57,7 +57,7 @@ def list(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: ni # @param [String] fleet The SID or unique name of the Fleet to which a list of # Sims are assigned. # @param [String] iccid The - # [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + # {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID] # associated with a Super SIM to filter the list by. Passing this parameter will # always return a list containing zero or one SIMs. # @param [Integer] limit Upper limit for the number of records to return. stream() @@ -97,7 +97,7 @@ def each # @param [String] fleet The SID or unique name of the Fleet to which a list of # Sims are assigned. # @param [String] iccid The - # [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + # {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID] # associated with a Super SIM to filter the list by. Passing this parameter will # always return a list containing zero or one SIMs. # @param [String] page_token PageToken provided by the API @@ -201,8 +201,8 @@ def fetch # identifies the resource. It can be used in place of the resource's `sid` in the # URL to address the resource. # @param [sim.StatusUpdate] status The new status of the resource. Can be: - # `ready`, `active`, or `inactive`. See the [Super SIM Status - # Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) + # `ready`, `active`, or `inactive`. See the {Super SIM Status + # Values}[https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values] # for more info. # @param [String] fleet The SID or unique name of the Fleet to which the SIM # resource should be assigned. @@ -353,8 +353,8 @@ def fetch # identifies the resource. It can be used in place of the resource's `sid` in the # URL to address the resource. # @param [sim.StatusUpdate] status The new status of the resource. Can be: - # `ready`, `active`, or `inactive`. See the [Super SIM Status - # Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) + # `ready`, `active`, or `inactive`. See the {Super SIM Status + # Values}[https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values] # for more info. # @param [String] fleet The SID or unique name of the Fleet to which the SIM # resource should be assigned. diff --git a/lib/twilio-ruby/rest/supersim/v1/usage_record.rb b/lib/twilio-ruby/rest/supersim/v1/usage_record.rb index aeb561664..699a481d8 100644 --- a/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +++ b/lib/twilio-ruby/rest/supersim/v1/usage_record.rb @@ -47,10 +47,10 @@ def initialize(version) # is `all`. `all` returns one UsageRecord that describes the usage for the entire # period. # @param [Time] start_time Only include usage that occurred at or after this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is one month before the `end_time`. # @param [Time] end_time Only include usage that occurred before this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is the current time. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -96,10 +96,10 @@ def list(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group # is `all`. `all` returns one UsageRecord that describes the usage for the entire # period. # @param [Time] start_time Only include usage that occurred at or after this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is one month before the `end_time`. # @param [Time] end_time Only include usage that occurred before this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is the current time. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -161,10 +161,10 @@ def each # is `all`. `all` returns one UsageRecord that describes the usage for the entire # period. # @param [Time] start_time Only include usage that occurred at or after this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is one month before the `end_time`. # @param [Time] end_time Only include usage that occurred before this time, - # specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default + # specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default # is the current time. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state diff --git a/lib/twilio-ruby/rest/sync/v1/service.rb b/lib/twilio-ruby/rest/sync/v1/service.rb index 6e54c9c3e..be909d758 100644 --- a/lib/twilio-ruby/rest/sync/v1/service.rb +++ b/lib/twilio-ruby/rest/sync/v1/service.rb @@ -35,7 +35,7 @@ def initialize(version) # `false`. # @param [Boolean] acl_enabled Whether token identities in the Service must be # granted access to Sync objects by using the - # [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. + # {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource. # @param [Boolean] reachability_debouncing_enabled Whether every # `endpoint_disconnected` event should occur after a configurable delay. The # default is `false`, where the `endpoint_disconnected` event occurs immediately @@ -234,7 +234,7 @@ def delete # `false`. # @param [Boolean] acl_enabled Whether token identities in the Service must be # granted access to Sync objects by using the - # [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. + # {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource. # @param [Boolean] reachability_debouncing_enabled Whether every # `endpoint_disconnected` event should occur after a configurable delay. The # default is `false`, where the `endpoint_disconnected` event occurs immediately @@ -508,7 +508,7 @@ def delete # `false`. # @param [Boolean] acl_enabled Whether token identities in the Service must be # granted access to Sync objects by using the - # [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. + # {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource. # @param [Boolean] reachability_debouncing_enabled Whether every # `endpoint_disconnected` event should occur after a configurable delay. The # default is `false`, where the `endpoint_disconnected` event occurs immediately diff --git a/lib/twilio-ruby/rest/sync/v1/service/document.rb b/lib/twilio-ruby/rest/sync/v1/service/document.rb index e8d6a09e8..2466cefe9 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/document.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/document.rb @@ -17,8 +17,8 @@ class DocumentList < ListResource ## # Initialize the DocumentList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @return [DocumentList] DocumentList def initialize(version, service_sid: nil) @@ -178,8 +178,8 @@ class DocumentContext < InstanceContext ## # Initialize the DocumentContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Document + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Document # resource to fetch. # @param [String] sid The SID of the Document resource to fetch. # @return [DocumentContext] DocumentContext @@ -277,8 +277,8 @@ class DocumentInstance < InstanceResource # Initialize the DocumentInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] sid The SID of the Document resource to fetch. # @return [DocumentInstance] DocumentInstance diff --git a/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb b/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb index 81b627959..eb6cf6311 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb @@ -18,8 +18,8 @@ class DocumentPermissionList < ListResource ## # Initialize the DocumentPermissionList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] document_sid The SID of the Sync Document to which the Document # Permission applies. @@ -161,8 +161,8 @@ class DocumentPermissionContext < InstanceContext ## # Initialize the DocumentPermissionContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Document + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Document # Permission resource to fetch. # @param [String] document_sid The SID of the Sync Document with the Document # Permission resource to fetch. Can be the Document resource's `sid` or its @@ -245,8 +245,8 @@ class DocumentPermissionInstance < InstanceResource # Initialize the DocumentPermissionInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] document_sid The SID of the Sync Document to which the Document # Permission applies. diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb index 7ce056ca9..34bdc9f32 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb @@ -17,8 +17,8 @@ class SyncListList < ListResource ## # Initialize the SyncListList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @return [SyncListList] SyncListList def initialize(version, service_sid: nil) @@ -179,8 +179,8 @@ class SyncListContext < InstanceContext ## # Initialize the SyncListContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync List + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync List # resource to fetch. # @param [String] sid The SID of the Sync List resource to fetch. # @return [SyncListContext] SyncListContext @@ -296,8 +296,8 @@ class SyncListInstance < InstanceResource # Initialize the SyncListInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] sid The SID of the Sync List resource to fetch. # @return [SyncListInstance] SyncListInstance diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb index 74a748fa8..436c3058c 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb @@ -18,8 +18,8 @@ class SyncListItemList < ListResource ## # Initialize the SyncListItemList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] list_sid The SID of the Sync List that contains the List Item. # @return [SyncListItemList] SyncListItemList @@ -226,8 +226,8 @@ class SyncListItemContext < InstanceContext ## # Initialize the SyncListItemContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync List Item # resource to fetch. # @param [String] list_sid The SID of the Sync List with the Sync List Item # resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. @@ -327,8 +327,8 @@ class SyncListItemInstance < InstanceResource # Initialize the SyncListItemInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] list_sid The SID of the Sync List that contains the List Item. # @param [String] index The index of the Sync List Item resource to fetch. diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb index 1eaa5f2ff..5ede8fb2e 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb @@ -18,8 +18,8 @@ class SyncListPermissionList < ListResource ## # Initialize the SyncListPermissionList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] list_sid The SID of the Sync List to which the Permission # applies. @@ -161,8 +161,8 @@ class SyncListPermissionContext < InstanceContext ## # Initialize the SyncListPermissionContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync List + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync List # Permission resource to fetch. # @param [String] list_sid The SID of the Sync List with the Sync List Permission # resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. @@ -244,8 +244,8 @@ class SyncListPermissionInstance < InstanceResource # Initialize the SyncListPermissionInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] list_sid The SID of the Sync List to which the Permission # applies. diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb index 76ebd981e..b0d708d71 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb @@ -17,8 +17,8 @@ class SyncMapList < ListResource ## # Initialize the SyncMapList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @return [SyncMapList] SyncMapList def initialize(version, service_sid: nil) @@ -178,8 +178,8 @@ class SyncMapContext < InstanceContext ## # Initialize the SyncMapContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map # resource to fetch. # @param [String] sid The SID of the Sync Map resource to fetch. # @return [SyncMapContext] SyncMapContext @@ -295,8 +295,8 @@ class SyncMapInstance < InstanceResource # Initialize the SyncMapInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] sid The SID of the Sync Map resource to fetch. # @return [SyncMapInstance] SyncMapInstance diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb index 3ce0bd5b9..9cae92c93 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb @@ -18,8 +18,8 @@ class SyncMapItemList < ListResource ## # Initialize the SyncMapItemList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] map_sid The SID of the Sync Map that contains the Map Item. # @return [SyncMapItemList] SyncMapItemList @@ -76,8 +76,8 @@ def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: : # memory before returning. # @param [sync_map_item.QueryResultOrder] order How to order the Map Items # returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) - # and the default is ascending. Map Items are [ordered - # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item + # and the default is ascending. Map Items are {ordered + # lexicographically}[https://en.wikipedia.org/wiki/Lexicographical_order] by Item # key. # @param [String] from The `key` of the first Sync Map Item resource to read. See # also `bounds`. @@ -102,8 +102,8 @@ def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil # is reached. # @param [sync_map_item.QueryResultOrder] order How to order the Map Items # returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) - # and the default is ascending. Map Items are [ordered - # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item + # and the default is ascending. Map Items are {ordered + # lexicographically}[https://en.wikipedia.org/wiki/Lexicographical_order] by Item # key. # @param [String] from The `key` of the first Sync Map Item resource to read. See # also `bounds`. @@ -145,8 +145,8 @@ def each # Request is executed immediately. # @param [sync_map_item.QueryResultOrder] order How to order the Map Items # returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) - # and the default is ascending. Map Items are [ordered - # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item + # and the default is ascending. Map Items are {ordered + # lexicographically}[https://en.wikipedia.org/wiki/Lexicographical_order] by Item # key. # @param [String] from The `key` of the first Sync Map Item resource to read. See # also `bounds`. @@ -235,8 +235,8 @@ class SyncMapItemContext < InstanceContext ## # Initialize the SyncMapItemContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map Item # resource to fetch. # @param [String] map_sid The SID of the Sync Map with the Sync Map Item resource # to fetch. Can be the Sync Map's `sid` or its `unique_name`. @@ -337,8 +337,8 @@ class SyncMapItemInstance < InstanceResource # Initialize the SyncMapItemInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] map_sid The SID of the Sync Map that contains the Map Item. # @param [String] key The `key` value of the Sync Map Item resource to fetch. diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb index 5fed9cf82..aa6cbc7e3 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb @@ -18,8 +18,8 @@ class SyncMapPermissionList < ListResource ## # Initialize the SyncMapPermissionList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] map_sid The SID of the Sync Map to which the Permission applies. # @return [SyncMapPermissionList] SyncMapPermissionList @@ -160,8 +160,8 @@ class SyncMapPermissionContext < InstanceContext ## # Initialize the SyncMapPermissionContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map # Permission resource to fetch. Can be the Service's `sid` value or `default`. # @param [String] map_sid The SID of the Sync Map with the Sync Map Permission # resource to fetch. Can be the Sync Map's `sid` or its `unique_name`. @@ -243,8 +243,8 @@ class SyncMapPermissionInstance < InstanceResource # Initialize the SyncMapPermissionInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] map_sid The SID of the Sync Map to which the Permission applies. # @param [String] identity The application-defined string that uniquely identifies diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb index 7f9562c3e..e0772db63 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb @@ -17,8 +17,8 @@ class SyncStreamList < ListResource ## # Initialize the SyncStreamList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @return [SyncStreamList] SyncStreamList def initialize(version, service_sid: nil) @@ -173,8 +173,8 @@ class SyncStreamContext < InstanceContext ## # Initialize the SyncStreamContext # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Stream # resource to fetch. # @param [String] sid The SID of the Stream resource to fetch. # @return [SyncStreamContext] SyncStreamContext @@ -269,8 +269,8 @@ class SyncStreamInstance < InstanceResource # Initialize the SyncStreamInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] sid The SID of the Stream resource to fetch. # @return [SyncStreamInstance] SyncStreamInstance diff --git a/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb b/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb index fb7a46ecc..9ce5cec1c 100644 --- a/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +++ b/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb @@ -18,8 +18,8 @@ class StreamMessageList < ListResource ## # Initialize the StreamMessageList # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] stream_sid The unique string that we created to identify the # Sync Stream resource. @@ -100,8 +100,8 @@ class StreamMessageInstance < InstanceResource # Initialize the StreamMessageInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the [Sync - # Service](https://www.twilio.com/docs/sync/api/service) the resource is + # @param [String] service_sid The SID of the {Sync + # Service}[https://www.twilio.com/docs/sync/api/service] the resource is # associated with. # @param [String] stream_sid The unique string that we created to identify the # Sync Stream resource. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb index f3035fc02..5440a3d93 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb @@ -117,8 +117,8 @@ def get_page(target_url) # `Customer Support` or `2014 Election Campaign`. # @param [String] event_callback_url The URL we should call when an event occurs. # If provided, the Workspace will publish events to this URL, for example, to - # collect data for reporting. See [Workspace - # Events](https://www.twilio.com/docs/taskrouter/api/event) for more information. + # collect data for reporting. See {Workspace + # Events}[https://www.twilio.com/docs/taskrouter/api/event] for more information. # @param [String] events_filter The list of Workspace events for which to call # event_callback_url. For example if # `EventsFilter=task.created,task.canceled,worker.activity.update`, then @@ -233,7 +233,7 @@ def fetch # @param [String] default_activity_sid The SID of the Activity that will be used # when new Workers are created in the Workspace. # @param [String] event_callback_url The URL we should call when an event occurs. - # See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for + # See {Workspace Events}[https://www.twilio.com/docs/taskrouter/api/event] for # more information. # @param [String] events_filter The list of Workspace events for which to call # event_callback_url. For example if @@ -592,7 +592,7 @@ def fetch # @param [String] default_activity_sid The SID of the Activity that will be used # when new Workers are created in the Workspace. # @param [String] event_callback_url The URL we should call when an event occurs. - # See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for + # See {Workspace Events}[https://www.twilio.com/docs/taskrouter/api/event] for # more information. # @param [String] events_filter The list of Workspace events for which to call # event_callback_url. For example if diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb index 5a532873e..cdb3feed2 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb @@ -30,7 +30,7 @@ def initialize(version, workspace_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] end_date Only include Events that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] event_type The type of Events to read. Returns only Events of # the type specified. @@ -41,7 +41,7 @@ def initialize(version, workspace_sid: nil) # @param [String] reservation_sid The SID of the Reservation with the Events to # read. Returns only Events that pertain to the specified Reservation. # @param [Time] start_date Only include Events from on or after this date and - # time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # Task Attributes for Events older than 30 days will be redacted. # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read. # Returns only the Events that pertain to the specified TaskQueue. @@ -84,7 +84,7 @@ def list(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] end_date Only include Events that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] event_type The type of Events to read. Returns only Events of # the type specified. @@ -95,7 +95,7 @@ def list(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: # @param [String] reservation_sid The SID of the Reservation with the Events to # read. Returns only Events that pertain to the specified Reservation. # @param [Time] start_date Only include Events from on or after this date and - # time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # Task Attributes for Events older than 30 days will be redacted. # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read. # Returns only the Events that pertain to the specified TaskQueue. @@ -154,7 +154,7 @@ def each # Retrieve a single page of EventInstance records from the API. # Request is executed immediately. # @param [Time] end_date Only include Events that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] event_type The type of Events to read. Returns only Events of # the type specified. @@ -165,7 +165,7 @@ def each # @param [String] reservation_sid The SID of the Reservation with the Events to # read. Returns only Events that pertain to the specified Reservation. # @param [Time] start_date Only include Events from on or after this date and - # time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # Task Attributes for Events older than 30 days will be redacted. # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read. # Returns only the Events that pertain to the specified TaskQueue. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb index f613618dc..b3a2bb3f0 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb @@ -209,7 +209,7 @@ def fetch # instruction. # @param [String] dequeue_to The Contact URI of the worker when executing a # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for - # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # Programmable SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] # formatted phone number, depending on the destination. # @param [String] dequeue_status_callback_url The Callback URL for completed call # event when executing a Dequeue instruction. @@ -220,7 +220,7 @@ def fetch # @param [String] call_timeout Timeout for call when executing a Call instruction. # @param [String] call_to The Contact URI of the worker when executing a Call # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a # result of the Call instruction. @@ -236,7 +236,7 @@ def fetch # the Redirect instruction. # @param [String] to The Contact URI of the worker when executing a Conference # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] from The Caller ID of the call to the worker when executing a # Conference instruction. @@ -264,8 +264,8 @@ def fetch # agent leaves. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -305,7 +305,7 @@ def fetch # should use to call `conference_recording_status_callback`. Can be: `GET` or # `POST` and defaults to `POST`. # @param [String] region The - # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) + # {region}[https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls] # where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, # `br1`, `au1`, or `jp1`. # @param [String] sip_auth_username The SIP username used for authentication. @@ -549,7 +549,7 @@ def fetch # instruction. # @param [String] dequeue_to The Contact URI of the worker when executing a # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for - # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # Programmable SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] # formatted phone number, depending on the destination. # @param [String] dequeue_status_callback_url The Callback URL for completed call # event when executing a Dequeue instruction. @@ -560,7 +560,7 @@ def fetch # @param [String] call_timeout Timeout for call when executing a Call instruction. # @param [String] call_to The Contact URI of the worker when executing a Call # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a # result of the Call instruction. @@ -576,7 +576,7 @@ def fetch # the Redirect instruction. # @param [String] to The Contact URI of the worker when executing a Conference # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] from The Caller ID of the call to the worker when executing a # Conference instruction. @@ -604,8 +604,8 @@ def fetch # agent leaves. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -645,7 +645,7 @@ def fetch # should use to call `conference_recording_status_callback`. Can be: `GET` or # `POST` and defaults to `POST`. # @param [String] region The - # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) + # {region}[https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls] # where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, # `br1`, `au1`, or `jp1`. # @param [String] sip_auth_username The SIP username used for authentication. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb index 50b7ab175..4f4faa4ea 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb @@ -152,15 +152,15 @@ def get_page(target_url) # criteria for any Tasks that enter the TaskQueue. For example, `'"language" == # "spanish"'`. The default value is `1==1`. If this value is empty, Tasks will # wait in the TaskQueue until they are deleted or moved to another TaskQueue. For - # more information about Worker selection, see [Describing Worker selection - # criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers). + # more information about Worker selection, see {Describing Worker selection + # criteria}[https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers]. # @param [String] max_reserved_workers The maximum number of Workers to reserve # for the assignment of a Task in the queue. Can be an integer between 1 and 50, # inclusive and defaults to 1. # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers. # Set this parameter to `LIFO` to assign most recently created Task first or FIFO - # to assign the oldest Task first. Default is `FIFO`. [Click - # here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) + # to assign the oldest Task first. Default is `FIFO`. {Click + # here}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo] # to learn more. # @param [String] reservation_activity_sid The SID of the Activity to assign # Workers when a task is reserved for them. @@ -279,8 +279,8 @@ def fetch # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers. # Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the # oldest task first and `LIFO` to assign the most recent task first. For more - # information, see [Queue - # Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo). + # information, see {Queue + # Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo]. # @return [TaskQueueInstance] Updated TaskQueueInstance def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) data = Twilio::Values.of({ @@ -510,8 +510,8 @@ def fetch # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers. # Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the # oldest task first and `LIFO` to assign the most recent task first. For more - # information, see [Queue - # Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo). + # information, see {Queue + # Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo]. # @return [TaskQueueInstance] Updated TaskQueueInstance def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) context.update( diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb index 7b8430284..af1af44e3 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb @@ -89,12 +89,12 @@ def initialize(version, workspace_sid, task_queue_sid) ## # Fetch the TaskQueueCumulativeStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. @@ -331,12 +331,12 @@ def url ## # Fetch the TaskQueueCumulativeStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb index 8e1ac39ed..f03a8207e 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb @@ -89,12 +89,12 @@ def initialize(version, workspace_sid, task_queue_sid) ## # Fetch the TaskQueueStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate real-time and cumulative statistics # for the specified TaskChannel. Can be the TaskChannel's SID or its # `unique_name`, such as `voice`, `sms`, or `default`. @@ -219,12 +219,12 @@ def url ## # Fetch the TaskQueueStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate real-time and cumulative statistics # for the specified TaskChannel. Can be the TaskChannel's SID or its # `unique_name`, such as `voice`, `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb index a3f8c9e0c..9b78107d2 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb @@ -32,14 +32,14 @@ def initialize(version, workspace_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to # read. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or # `default`. @@ -72,14 +72,14 @@ def list(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: : # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to # read. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or # `default`. @@ -128,14 +128,14 @@ def each # Retrieve a single page of TaskQueuesStatisticsInstance records from the API. # Request is executed immediately. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to # read. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default is 15 minutes. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or # `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb index 508ecb57c..a38e274ed 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb @@ -188,7 +188,7 @@ def get_page(target_url) # the new Worker. It can be up to 64 characters long. # @param [String] activity_sid The SID of a valid Activity that will describe the # new Worker's initial state. See - # [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more + # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more # information. If not provided, the new Worker's initial state is the # `default_activity_sid` configured on the Workspace. # @param [String] attributes A valid JSON string that describes the new Worker. @@ -291,7 +291,7 @@ def fetch # Update the WorkerInstance # @param [String] activity_sid The SID of a valid Activity that will describe the # Worker's initial state. See - # [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more + # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more # information. # @param [String] attributes The JSON string that describes the Worker. For # example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is @@ -543,7 +543,7 @@ def fetch # Update the WorkerInstance # @param [String] activity_sid The SID of a valid Activity that will describe the # Worker's initial state. See - # [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more + # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more # information. # @param [String] attributes The JSON string that describes the Worker. For # example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb index 98968229c..60a5a9f4f 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb @@ -210,7 +210,7 @@ def fetch # instruction. # @param [String] dequeue_to The contact URI of the worker when executing a # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for - # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # Programmable SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] # formatted phone number, depending on the destination. # @param [String] dequeue_status_callback_url The callback URL for completed call # event when executing a Dequeue instruction. @@ -222,7 +222,7 @@ def fetch # instruction. # @param [String] call_to The contact URI of the worker when executing a Call # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a # result of the Call instruction. @@ -238,7 +238,7 @@ def fetch # the Redirect instruction. # @param [String] to The Contact URI of the worker when executing a Conference # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] from The caller ID of the call to the worker when executing a # Conference instruction. @@ -268,8 +268,8 @@ def fetch # agent leaves. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -309,7 +309,7 @@ def fetch # should use to call `conference_recording_status_callback`. Can be: `GET` or # `POST` and defaults to `POST`. # @param [String] region The - # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) + # {region}[https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls] # where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, # `br1`, `au1`, or `jp1`. # @param [String] sip_auth_username The SIP username used for authentication. @@ -548,7 +548,7 @@ def fetch # instruction. # @param [String] dequeue_to The contact URI of the worker when executing a # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for - # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # Programmable SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] # formatted phone number, depending on the destination. # @param [String] dequeue_status_callback_url The callback URL for completed call # event when executing a Dequeue instruction. @@ -560,7 +560,7 @@ def fetch # instruction. # @param [String] call_to The contact URI of the worker when executing a Call # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a # result of the Call instruction. @@ -576,7 +576,7 @@ def fetch # the Redirect instruction. # @param [String] to The Contact URI of the worker when executing a Conference # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable - # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # SIP, or the {E.164}[https://www.twilio.com/docs/glossary/what-e164] formatted # phone number, depending on the destination. # @param [String] from The caller ID of the call to the worker when executing a # Conference instruction. @@ -606,8 +606,8 @@ def fetch # agent leaves. # @param [String] wait_url The URL we should call using the `wait_method` for the # music to play while participants are waiting for the conference to start. The - # default value is the URL of our standard hold music. [Learn more about hold - # music](https://www.twilio.com/labs/twimlets/holdmusic). + # default value is the URL of our standard hold music. {Learn more about hold + # music}[https://www.twilio.com/labs/twimlets/holdmusic]. # @param [String] wait_method The HTTP method we should use to call `wait_url`. # Can be `GET` or `POST` and the default is `POST`. When using a static audio # file, this should be `GET` so that we can cache the file. @@ -647,7 +647,7 @@ def fetch # should use to call `conference_recording_status_callback`. Can be: `GET` or # `POST` and defaults to `POST`. # @param [String] region The - # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) + # {region}[https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls] # where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, # `br1`, `au1`, or `jp1`. # @param [String] sip_auth_username The SIP username used for authentication. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb index 48d13391e..62727f323 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb @@ -92,9 +92,9 @@ def initialize(version, workspace_sid, worker_sid) # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or @@ -211,9 +211,9 @@ def url # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb index 3cd4e6b88..1567f3e35 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb @@ -80,12 +80,12 @@ def initialize(version, workspace_sid) ## # Fetch the WorkersCumulativeStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # earlier, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. @@ -236,12 +236,12 @@ def url ## # Fetch the WorkersCumulativeStatisticsInstance # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # earlier, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb index bc8015c98..d9e0359e6 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb @@ -81,10 +81,10 @@ def initialize(version, workspace_sid) # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch # Worker statistics. # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which @@ -197,10 +197,10 @@ def url # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch # Worker statistics. # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb index 2d330633b..0bc0dd966 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb @@ -119,12 +119,12 @@ def get_page(target_url) # the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound # Campaign`. # @param [String] configuration A JSON string that contains the rules to apply to - # the Workflow. See [Configuring - # Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for + # the Workflow. See {Configuring + # Workflows}[https://www.twilio.com/docs/taskrouter/workflow-configuration] for # more information. # @param [String] assignment_callback_url The URL from your application that will - # process task assignment events. See [Handling Task Assignment - # Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) + # process task assignment events. See {Handling Task Assignment + # Callback}[https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks] # for more details. # @param [String] fallback_assignment_callback_url The URL that we should call # when a call to the `assignment_callback_url` fails. @@ -223,14 +223,14 @@ def fetch # the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound # Campaign`. # @param [String] assignment_callback_url The URL from your application that will - # process task assignment events. See [Handling Task Assignment - # Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) + # process task assignment events. See {Handling Task Assignment + # Callback}[https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks] # for more details. # @param [String] fallback_assignment_callback_url The URL that we should call # when a call to the `assignment_callback_url` fails. # @param [String] configuration A JSON string that contains the rules to apply to - # the Workflow. See [Configuring - # Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for + # the Workflow. See {Configuring + # Workflows}[https://www.twilio.com/docs/taskrouter/workflow-configuration] for # more information. # @param [String] task_reservation_timeout How long TaskRouter will wait for a # confirmation response from your application after it assigns a Task to a Worker. @@ -441,14 +441,14 @@ def fetch # the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound # Campaign`. # @param [String] assignment_callback_url The URL from your application that will - # process task assignment events. See [Handling Task Assignment - # Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) + # process task assignment events. See {Handling Task Assignment + # Callback}[https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks] # for more details. # @param [String] fallback_assignment_callback_url The URL that we should call # when a call to the `assignment_callback_url` fails. # @param [String] configuration A JSON string that contains the rules to apply to - # the Workflow. See [Configuring - # Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for + # the Workflow. See {Configuring + # Workflows}[https://www.twilio.com/docs/taskrouter/workflow-configuration] for # more information. # @param [String] task_reservation_timeout How long TaskRouter will wait for a # confirmation response from your application after it assigns a Task to a Worker. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb index 94fd253ef..9255a28b1 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb @@ -89,13 +89,13 @@ def initialize(version, workspace_sid, workflow_sid) ## # Fetch the WorkflowCumulativeStatisticsInstance # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. @@ -335,13 +335,13 @@ def url ## # Fetch the WorkflowCumulativeStatisticsInstance # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb index 434ed638d..825692ce9 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb @@ -92,10 +92,10 @@ def initialize(version, workspace_sid, workflow_sid) # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_channel Only calculate real-time statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. @@ -226,10 +226,10 @@ def url # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_channel Only calculate real-time statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb index bb78025c0..0ed5f7952 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb @@ -81,13 +81,13 @@ def initialize(version, workspace_sid) ## # Fetch the WorkspaceCumulativeStatisticsInstance # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. @@ -312,13 +312,13 @@ def url ## # Fetch the WorkspaceCumulativeStatisticsInstance # @param [Time] end_date Only include usage that occurred on or before this date, - # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] # date-time. # @param [String] minutes Only calculate statistics since this many minutes in the # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] task_channel Only calculate cumulative statistics on this # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, # `sms`, or `default`. diff --git a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb index 86ba37e84..cb634d464 100644 --- a/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +++ b/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb @@ -80,10 +80,10 @@ def initialize(version, workspace_sid) # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or # `default`. @@ -195,10 +195,10 @@ def url # past. The default 15 minutes. This is helpful for displaying statistics for the # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. # @param [Time] start_date Only calculate statistics from this date and time and - # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [Time] end_date Only calculate statistics from this date and time and - # earlier, specified in GMT as an [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. + # earlier, specified in GMT as an {ISO + # 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time. # @param [String] task_channel Only calculate statistics on this TaskChannel. Can # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or # `default`. diff --git a/lib/twilio-ruby/rest/trunking/v1/trunk.rb b/lib/twilio-ruby/rest/trunking/v1/trunk.rb index fff12eb62..ccdbab81d 100644 --- a/lib/twilio-ruby/rest/trunking/v1/trunk.rb +++ b/lib/twilio-ruby/rest/trunking/v1/trunk.rb @@ -29,31 +29,31 @@ def initialize(version) # the resource. It can be up to 64 characters long. # @param [String] domain_name The unique address you reserve on Twilio to which # you route your SIP traffic. Domain names can contain letters, digits, and `-` - # and must end with `pstn.twilio.com`. See [Termination - # Settings](https://www.twilio.com/docs/sip-trunking#termination) for more + # and must end with `pstn.twilio.com`. See {Termination + # Settings}[https://www.twilio.com/docs/sip-trunking#termination] for more # information. # @param [String] disaster_recovery_url The URL we should call using the # `disaster_recovery_method` if an error occurs while sending SIP traffic towards # the configured Origination URL. We retrieve TwiML from the URL and execute the - # instructions like any other normal TwiML call. See [Disaster - # Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more + # instructions like any other normal TwiML call. See {Disaster + # Recovery}[https://www.twilio.com/docs/sip-trunking#disaster-recovery] for more # information. # @param [String] disaster_recovery_method The HTTP method we should use to call # the `disaster_recovery_url`. Can be: `GET` or `POST`. # @param [trunk.TransferSetting] transfer_mode The call transfer settings for the # trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See - # [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) for more + # {Transfer}[https://www.twilio.com/docs/sip-trunking/call-transfer] for more # information. # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If # enabled, all calls going through the trunk will be secure using SRTP for media - # and TLS for signaling. If disabled, then RTP will be used for media. See [Secure - # Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more + # and TLS for signaling. If disabled, then RTP will be used for media. See {Secure + # Trunking}[https://www.twilio.com/docs/sip-trunking#securetrunking] for more # information. # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should # be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from # the United States and Canada automatically perform a CNAM Lookup and display - # Caller ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # Caller ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @return [TrunkInstance] Created TrunkInstance def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset) data = Twilio::Values.of({ @@ -231,31 +231,31 @@ def delete # the resource. It can be up to 64 characters long. # @param [String] domain_name The unique address you reserve on Twilio to which # you route your SIP traffic. Domain names can contain letters, digits, and `-` - # and must end with `pstn.twilio.com`. See [Termination - # Settings](https://www.twilio.com/docs/sip-trunking#termination) for more + # and must end with `pstn.twilio.com`. See {Termination + # Settings}[https://www.twilio.com/docs/sip-trunking#termination] for more # information. # @param [String] disaster_recovery_url The URL we should call using the # `disaster_recovery_method` if an error occurs while sending SIP traffic towards # the configured Origination URL. We retrieve TwiML from the URL and execute the - # instructions like any other normal TwiML call. See [Disaster - # Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more + # instructions like any other normal TwiML call. See {Disaster + # Recovery}[https://www.twilio.com/docs/sip-trunking#disaster-recovery] for more # information. # @param [String] disaster_recovery_method The HTTP method we should use to call # the `disaster_recovery_url`. Can be: `GET` or `POST`. # @param [trunk.TransferSetting] transfer_mode The call transfer settings for the # trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See - # [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) for more + # {Transfer}[https://www.twilio.com/docs/sip-trunking/call-transfer] for more # information. # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If # enabled, all calls going through the trunk will be secure using SRTP for media - # and TLS for signaling. If disabled, then RTP will be used for media. See [Secure - # Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more + # and TLS for signaling. If disabled, then RTP will be used for media. See {Secure + # Trunking}[https://www.twilio.com/docs/sip-trunking#securetrunking] for more # information. # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should # be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from # the United States and Canada automatically perform a CNAM Lookup and display - # Caller ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # Caller ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @return [TrunkInstance] Updated TrunkInstance def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset) data = Twilio::Values.of({ @@ -531,31 +531,31 @@ def delete # the resource. It can be up to 64 characters long. # @param [String] domain_name The unique address you reserve on Twilio to which # you route your SIP traffic. Domain names can contain letters, digits, and `-` - # and must end with `pstn.twilio.com`. See [Termination - # Settings](https://www.twilio.com/docs/sip-trunking#termination) for more + # and must end with `pstn.twilio.com`. See {Termination + # Settings}[https://www.twilio.com/docs/sip-trunking#termination] for more # information. # @param [String] disaster_recovery_url The URL we should call using the # `disaster_recovery_method` if an error occurs while sending SIP traffic towards # the configured Origination URL. We retrieve TwiML from the URL and execute the - # instructions like any other normal TwiML call. See [Disaster - # Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more + # instructions like any other normal TwiML call. See {Disaster + # Recovery}[https://www.twilio.com/docs/sip-trunking#disaster-recovery] for more # information. # @param [String] disaster_recovery_method The HTTP method we should use to call # the `disaster_recovery_url`. Can be: `GET` or `POST`. # @param [trunk.TransferSetting] transfer_mode The call transfer settings for the # trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See - # [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) for more + # {Transfer}[https://www.twilio.com/docs/sip-trunking/call-transfer] for more # information. # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If # enabled, all calls going through the trunk will be secure using SRTP for media - # and TLS for signaling. If disabled, then RTP will be used for media. See [Secure - # Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more + # and TLS for signaling. If disabled, then RTP will be used for media. See {Secure + # Trunking}[https://www.twilio.com/docs/sip-trunking#securetrunking] for more # information. # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should # be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from # the United States and Canada automatically perform a CNAM Lookup and display - # Caller ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # Caller ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @return [TrunkInstance] Updated TrunkInstance def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset) context.update( diff --git a/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb b/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb index e3a225c6b..7d0ecedfc 100644 --- a/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +++ b/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb @@ -28,8 +28,8 @@ def initialize(version, trunk_sid: nil) ## # Create the CredentialListInstance - # @param [String] credential_list_sid The SID of the [Credential - # List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource) + # @param [String] credential_list_sid The SID of the {Credential + # List}[https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource] # that you want to associate with the trunk. Once associated, we will authenticate # access to the trunk against this list. # @return [CredentialListInstance] Created CredentialListInstance diff --git a/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb b/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb index 7575f738a..dbad7a378 100644 --- a/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +++ b/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb @@ -27,8 +27,8 @@ def initialize(version, trunk_sid: nil) ## # Create the IpAccessControlListInstance - # @param [String] ip_access_control_list_sid The SID of the [IP Access Control - # List](https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource) + # @param [String] ip_access_control_list_sid The SID of the {IP Access Control + # List}[https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource] # that you want to associate with the trunk. # @return [IpAccessControlListInstance] Created IpAccessControlListInstance def create(ip_access_control_list_sid: nil) diff --git a/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb b/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb index e671f0e8d..b767bf8c7 100644 --- a/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +++ b/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb @@ -30,8 +30,8 @@ def initialize(version, trunk_sid: nil) ## # Create the PhoneNumberInstance - # @param [String] phone_number_sid The SID of the [Incoming Phone - # Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) + # @param [String] phone_number_sid The SID of the {Incoming Phone + # Number}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource] # that you want to associate with the trunk. # @return [PhoneNumberInstance] Created PhoneNumberInstance def create(phone_number_sid: nil) diff --git a/lib/twilio-ruby/rest/verify/v2/service.rb b/lib/twilio-ruby/rest/verify/v2/service.rb index 042d12212..36a14b7e7 100644 --- a/lib/twilio-ruby/rest/verify/v2/service.rb +++ b/lib/twilio-ruby/rest/verify/v2/service.rb @@ -53,7 +53,7 @@ def initialize(version) # true}. If `include_date` is set to `true`, which is the default, that means that # the push challenge’s response will include the date created value. If # `include_date` is set to `false`, then the date created value will not be - # included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) + # included. See {Challenge}[https://www.twilio.com/docs/verify/api/challenge] # resource’s details parameter for more info # @return [ServiceInstance] Created ServiceInstance def create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset) @@ -259,7 +259,7 @@ def delete # true}. If `include_date` is set to `true`, which is the default, that means that # the push challenge’s response will include the date created value. If # `include_date` is set to `false`, then the date created value will not be - # included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) + # included. See {Challenge}[https://www.twilio.com/docs/verify/api/challenge] # resource’s details parameter for more info # @return [ServiceInstance] Updated ServiceInstance def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset) @@ -595,7 +595,7 @@ def delete # true}. If `include_date` is set to `true`, which is the default, that means that # the push challenge’s response will include the date created value. If # `include_date` is set to `false`, then the date created value will not be - # included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) + # included. See {Challenge}[https://www.twilio.com/docs/verify/api/challenge] # resource’s details parameter for more info # @return [ServiceInstance] Updated ServiceInstance def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset) diff --git a/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb b/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb index 277faf2ee..fc2c61d80 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb @@ -34,14 +34,14 @@ def initialize(version, service_sid: nil, identity: nil) # Create the ChallengeInstance # @param [String] factor_sid The unique SID identifier of the Factor. # @param [Time] expiration_date The future date in which this Challenge will - # expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # expire, given in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. # @param [String] details Details provided to give context about the Challenge. # Shown to the end user. It must be a stringified JSON with the following - # structure: {"message": "string", "fields": [ { "label": "string", "value": + # structure: {"message": "string", "fields": { { "label": "string", "value": # "string"}]}. `message` is required. If you send the `fields` property, each # field has to include `label` and `value` properties. If you had set # `include_date=true` in the `push` configuration of the - # [service](https://www.twilio.com/docs/verify/api/service), the response will + # [service}[https://www.twilio.com/docs/verify/api/service], the response will # also include the challenge's date created value as an additional field called # `date` # @param [String] hidden_details Details provided to give context about the diff --git a/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb b/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb index ddb048daf..32d711fb7 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb @@ -16,7 +16,7 @@ class MessagingConfigurationList < ListResource # Initialize the MessagingConfigurationList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) that the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is # associated with. # @return [MessagingConfigurationList] MessagingConfigurationList def initialize(version, service_sid: nil) @@ -30,11 +30,11 @@ def initialize(version, service_sid: nil) ## # Create the MessagingConfigurationInstance # @param [String] country The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country this configuration will be applied to. If this is a global # configuration, Country will take the value `all`. - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] to be used to send SMS to # the country of this configuration. # @return [MessagingConfigurationInstance] Created MessagingConfigurationInstance def create(country: nil, messaging_service_sid: nil) @@ -166,10 +166,10 @@ class MessagingConfigurationContext < InstanceContext # Initialize the MessagingConfigurationContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) that the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is # associated with. # @param [String] country The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country this configuration will be applied to. If this is a global # configuration, Country will take the value `all`. # @return [MessagingConfigurationContext] MessagingConfigurationContext @@ -183,8 +183,8 @@ def initialize(version, service_sid, country) ## # Update the MessagingConfigurationInstance - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] to be used to send SMS to # the country of this configuration. # @return [MessagingConfigurationInstance] Updated MessagingConfigurationInstance def update(messaging_service_sid: nil) @@ -242,10 +242,10 @@ class MessagingConfigurationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) that the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is # associated with. # @param [String] country The - # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of + # {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of # the country this configuration will be applied to. If this is a global # configuration, Country will take the value `all`. # @return [MessagingConfigurationInstance] MessagingConfigurationInstance @@ -327,8 +327,8 @@ def url ## # Update the MessagingConfigurationInstance - # @param [String] messaging_service_sid The SID of the [Messaging - # Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to + # @param [String] messaging_service_sid The SID of the {Messaging + # Service}[https://www.twilio.com/docs/sms/services/api] to be used to send SMS to # the country of this configuration. # @return [MessagingConfigurationInstance] Updated MessagingConfigurationInstance def update(messaging_service_sid: nil) diff --git a/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb b/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb index ee754dd9b..9096da2c5 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb @@ -16,7 +16,7 @@ class RateLimitList < ListResource # Initialize the RateLimitList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @return [RateLimitList] RateLimitList def initialize(version, service_sid: nil) @@ -163,7 +163,7 @@ class RateLimitContext < InstanceContext # Initialize the RateLimitContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the Rate # Limit resource to fetch. @@ -250,7 +250,7 @@ class RateLimitInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the Rate # Limit resource to fetch. diff --git a/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb b/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb index 90c9509ee..3f8ce8a19 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb @@ -17,7 +17,7 @@ class BucketList < ListResource # Initialize the BucketList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] rate_limit_sid The Twilio-provided string that uniquely # identifies the Rate Limit resource. @@ -175,7 +175,7 @@ class BucketContext < InstanceContext # Initialize the BucketContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] rate_limit_sid The Twilio-provided string that uniquely # identifies the Rate Limit resource. @@ -252,7 +252,7 @@ class BucketInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] rate_limit_sid The Twilio-provided string that uniquely # identifies the Rate Limit resource. diff --git a/lib/twilio-ruby/rest/verify/v2/service/verification.rb b/lib/twilio-ruby/rest/verify/v2/service/verification.rb index 924e0bcce..341cb2fa5 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/verification.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/verification.rb @@ -16,7 +16,7 @@ class VerificationList < ListResource # Initialize the VerificationList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @return [VerificationList] VerificationList def initialize(version, service_sid: nil) @@ -30,10 +30,10 @@ def initialize(version, service_sid: nil) ## # Create the VerificationInstance # @param [String] to The phone number or - # [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must - # be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # {email}[https://www.twilio.com/docs/verify/email] to verify. Phone numbers must + # be in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # @param [String] channel The verification method to use. Can be: - # [`email`](https://www.twilio.com/docs/verify/email), `sms` or `call`. + # {`email`}[https://www.twilio.com/docs/verify/email], `sms` or `call`. # @param [String] custom_friendly_name A custom user defined friendly name that # overwrites the existing one in the verification message # @param [String] custom_message The text of a custom message to use for the @@ -41,7 +41,7 @@ def initialize(version, service_sid: nil) # @param [String] send_digits The digits to send after a phone call is answered, # for example, to dial an extension. For more information, see the Programmable # Voice documentation of - # [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits). + # {sendDigits}[https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits]. # @param [String] locale The locale to use for the verification SMS or call. Can # be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-GB`, `es`, `fi`, `fr`, # `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, @@ -53,15 +53,15 @@ def initialize(version, service_sid: nil) # @param [String] payee The payee of the associated PSD2 compliant transaction. # Requires the PSD2 Service flag enabled. # @param [Hash] rate_limits The custom key-value pairs of Programmable Rate - # Limits. Keys correspond to `unique_name` fields defined when [creating your Rate - # Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated + # Limits. Keys correspond to `unique_name` fields defined when {creating your Rate + # Limit}[https://www.twilio.com/docs/verify/api/service-rate-limits]. Associated # value pairs represent values in the request that you are rate limiting on. You # may include multiple Rate Limit values in each request. # @param [Hash] channel_configuration - # [`email`](https://www.twilio.com/docs/verify/email) channel configuration in + # {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in # json format. Must include 'from' and 'from_name'. - # @param [String] app_hash Your [App - # Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) + # @param [String] app_hash Your {App + # Hash}[https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string] # to be appended at the end of your verification SMS body. Applies only to SMS. # Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`. # @return [VerificationInstance] Created VerificationInstance @@ -127,7 +127,7 @@ class VerificationContext < InstanceContext # Initialize the VerificationContext # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the verification - # [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource + # {Service}[https://www.twilio.com/docs/verify/api/service] to fetch the resource # from. # @param [String] sid The Twilio-provided string that uniquely identifies the # Verification resource to fetch. @@ -193,7 +193,7 @@ class VerificationInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @param [String] sid The Twilio-provided string that uniquely identifies the # Verification resource to fetch. diff --git a/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb b/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb index bc31c0d9e..5ad5eb20a 100644 --- a/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +++ b/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb @@ -16,7 +16,7 @@ class VerificationCheckList < ListResource # Initialize the VerificationCheckList # @param [Version] version Version that contains the resource # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @return [VerificationCheckList] VerificationCheckList def initialize(version, service_sid: nil) @@ -31,12 +31,12 @@ def initialize(version, service_sid: nil) # Create the VerificationCheckInstance # @param [String] code The 4-10 character string being verified. # @param [String] to The phone number or - # [email](https://www.twilio.com/docs/verify/email) to verify. Either this + # {email}[https://www.twilio.com/docs/verify/email] to verify. Either this # parameter or the `verification_sid` must be specified. Phone numbers must be in - # [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + # {E.164 format}[https://www.twilio.com/docs/glossary/what-e164]. # @param [String] verification_sid A SID that uniquely identifies the Verification # Check. Either this parameter or the `to` phone - # number/[email](https://www.twilio.com/docs/verify/email) must be specified. + # number/{email}[https://www.twilio.com/docs/verify/email] must be specified. # @param [String] amount The amount of the associated PSD2 compliant transaction. # Requires the PSD2 Service flag enabled. # @param [String] payee The payee of the associated PSD2 compliant transaction. @@ -98,7 +98,7 @@ class VerificationCheckInstance < InstanceResource # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] service_sid The SID of the - # [Service](https://www.twilio.com/docs/verify/api/service) the resource is + # {Service}[https://www.twilio.com/docs/verify/api/service] the resource is # associated with. # @return [VerificationCheckInstance] VerificationCheckInstance def initialize(version, payload, service_sid: nil) diff --git a/lib/twilio-ruby/rest/video/v1/composition.rb b/lib/twilio-ruby/rest/video/v1/composition.rb index 3a301dd0a..1a1e03e9d 100644 --- a/lib/twilio-ruby/rest/video/v1/composition.rb +++ b/lib/twilio-ruby/rest/video/v1/composition.rb @@ -32,7 +32,7 @@ def initialize(version) # @param [composition.Status] status Read only Composition resources with this # status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`. # @param [Time] date_created_after Read only Composition resources created on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with # time zone. # @param [Time] date_created_before Read only Composition resources created before # this ISO 8601 date-time with time zone. @@ -62,7 +62,7 @@ def list(status: :unset, date_created_after: :unset, date_created_before: :unset # @param [composition.Status] status Read only Composition resources with this # status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`. # @param [Time] date_created_after Read only Composition resources created on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with # time zone. # @param [Time] date_created_before Read only Composition resources created before # this ISO 8601 date-time with time zone. @@ -108,7 +108,7 @@ def each # @param [composition.Status] status Read only Composition resources with this # status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`. # @param [Time] date_created_after Read only Composition resources created on or - # after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with + # after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with # time zone. # @param [Time] date_created_before Read only Composition resources created before # this ISO 8601 date-time with time zone. @@ -151,8 +151,8 @@ def get_page(target_url) # @param [String] room_sid The SID of the Group Room with the media tracks to be # used as composition sources. # @param [Hash] video_layout An object that describes the video layout of the - # composition in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. Please, be aware that either video_layout or audio_sources have # to be provided to get a valid creation request # @param [String] audio_sources An array of track names from the same group room @@ -186,8 +186,8 @@ def get_page(target_url) # # Note that the `resolution` imposes an aspect ratio to the resulting composition. # When the original video tracks are constrained by the aspect ratio, they are - # scaled to fit. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition.Format] format The container format of the composition's # media files. Can be: `mp4` or `webm` and the default is `webm`. If you specify @@ -204,8 +204,8 @@ def get_page(target_url) # media in the composition. The default is `true`. Compositions with `trim` # enabled are shorter when the Room is created and no Participant joins for a # while as well as if all the Participants leave the room and join later, because - # those gaps will be removed. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # those gaps will be removed. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @return [CompositionInstance] Created CompositionInstance def create(room_sid: nil, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset) diff --git a/lib/twilio-ruby/rest/video/v1/composition_hook.rb b/lib/twilio-ruby/rest/video/v1/composition_hook.rb index 38b8735f0..4884b4329 100644 --- a/lib/twilio-ruby/rest/video/v1/composition_hook.rb +++ b/lib/twilio-ruby/rest/video/v1/composition_hook.rb @@ -32,10 +32,10 @@ def initialize(version) # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name Read only CompositionHook resources with friendly # names that match this string. The match is not case sensitive and can include @@ -65,10 +65,10 @@ def list(enabled: :unset, date_created_after: :unset, date_created_before: :unse # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name Read only CompositionHook resources with friendly # names that match this string. The match is not case sensitive and can include @@ -114,10 +114,10 @@ def each # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name Read only CompositionHook resources with friendly # names that match this string. The match is not case sensitive and can include @@ -164,8 +164,8 @@ def get_page(target_url) # the composition hook will be triggered for every completed Group Room in the # account. When `false`, the composition hook will never be triggered. # @param [Hash] video_layout An object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources An array of track names from the same group room # to merge into the compositions created by the composition hook. Can include zero @@ -199,8 +199,8 @@ def get_page(target_url) # # Note that the `resolution` imposes an aspect ratio to the resulting composition. # When the original video tracks are constrained by the aspect ratio, they are - # scaled to fit. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or @@ -217,9 +217,9 @@ def get_page(target_url) # media in the Compositions triggered by the composition hook. The default is # `true`. Compositions with `trim` enabled are shorter when the Room is created # and no Participant joins for a while as well as if all the Participants leave - # the room and join later, because those gaps will be removed. See [Specifying + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @return [CompositionHookInstance] Created CompositionHookInstance def create(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset) @@ -320,8 +320,8 @@ def delete # the composition hook will be triggered for every completed Group Room in the # account. When `false`, the composition hook never triggers. # @param [Hash] video_layout A JSON object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources An array of track names from the same group room # to merge into the compositions created by the composition hook. Can include zero @@ -342,9 +342,9 @@ def delete # media in the compositions triggered by the composition hook. The default is # `true`. Compositions with `trim` enabled are shorter when the Room is created # and no Participant joins for a while as well as if all the Participants leave - # the room and join later, because those gaps will be removed. See [Specifying + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or @@ -368,8 +368,8 @@ def delete # # Note that the `resolution` imposes an aspect ratio to the resulting composition. # When the original video tracks are constrained by the aspect ratio, they are - # scaled to fit. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] status_callback The URL we should call using the # `status_callback_method` to send status information to your application on every @@ -572,8 +572,8 @@ def delete # the composition hook will be triggered for every completed Group Room in the # account. When `false`, the composition hook never triggers. # @param [Hash] video_layout A JSON object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources An array of track names from the same group room # to merge into the compositions created by the composition hook. Can include zero @@ -594,9 +594,9 @@ def delete # media in the compositions triggered by the composition hook. The default is # `true`. Compositions with `trim` enabled are shorter when the Room is created # and no Participant joins for a while as well as if all the Participants leave - # the room and join later, because those gaps will be removed. See [Specifying + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or @@ -620,8 +620,8 @@ def delete # # Note that the `resolution` imposes an aspect ratio to the resulting composition. # When the original video tracks are constrained by the aspect ratio, they are - # scaled to fit. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] status_callback The URL we should call using the # `status_callback_method` to send status information to your application on every diff --git a/lib/twilio-ruby/rest/video/v1/recording.rb b/lib/twilio-ruby/rest/video/v1/recording.rb index 4d5c655b0..9ca276ac1 100644 --- a/lib/twilio-ruby/rest/video/v1/recording.rb +++ b/lib/twilio-ruby/rest/video/v1/recording.rb @@ -33,10 +33,10 @@ def initialize(version) # @param [String] grouping_sid Read only recordings with this `grouping_sid`, # which may include a `participant_sid` and/or a `room_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time # zone. # @param [Time] date_created_before Read only recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone, # given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`. # @param [recording.Type] media_type Read only recordings that have this media # type. Can be either `audio` or `video`. @@ -70,10 +70,10 @@ def list(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_ # @param [String] grouping_sid Read only recordings with this `grouping_sid`, # which may include a `participant_sid` and/or a `room_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time # zone. # @param [Time] date_created_before Read only recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone, # given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`. # @param [recording.Type] media_type Read only recordings that have this media # type. Can be either `audio` or `video`. @@ -123,10 +123,10 @@ def each # @param [String] grouping_sid Read only recordings with this `grouping_sid`, # which may include a `participant_sid` and/or a `room_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time # zone. # @param [Time] date_created_before Read only recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone, # given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`. # @param [recording.Type] media_type Read only recordings that have this media # type. Can be either `audio` or `video`. diff --git a/lib/twilio-ruby/rest/video/v1/room.rb b/lib/twilio-ruby/rest/video/v1/room.rb index 142b6be33..755bb7874 100644 --- a/lib/twilio-ruby/rest/video/v1/room.rb +++ b/lib/twilio-ruby/rest/video/v1/room.rb @@ -25,8 +25,8 @@ def initialize(version) ## # Create the RoomInstance - # @param [Boolean] enable_turn Deprecated. Whether to enable [Twilio's Network - # Traversal TURN service](https://www.twilio.com/stun-turn). TURN service is used + # @param [Boolean] enable_turn Deprecated. Whether to enable {Twilio's Network + # Traversal TURN service}[https://www.twilio.com/stun-turn]. TURN service is used # when direct peer-to-peer media connections cannot be established due to firewall # restrictions. This setting only applies to rooms with type `peer-to-peer`. # @param [room.RoomType] type The type of room. Can be: `peer-to-peer`, @@ -39,8 +39,8 @@ def initialize(version) # as long as the room is `in-progress`. # @param [String] status_callback The URL we should call using the # `status_callback_method` to send status information to your application on every - # room event. See [Status - # Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more + # room event. See {Status + # Callbacks}[https://www.twilio.com/docs/video/api/status-callbacks] for more # info. # @param [String] status_callback_method The HTTP method we should use to call # `status_callback`. Can be `POST` or `GET`. @@ -55,8 +55,8 @@ def initialize(version) # supported when publishing a track in the room. Can be: `VP8` and `H264`. # ***This feature is not available in `peer-to-peer` rooms*** # @param [String] media_region The region for the media server in Group Rooms. - # Can be: one of the [available Media - # Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). + # Can be: one of the {available Media + # Regions}[https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers]. # ***This feature is not available in `peer-to-peer` rooms.*** # @return [RoomInstance] Created RoomInstance def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset) diff --git a/lib/twilio-ruby/rest/video/v1/room/recording.rb b/lib/twilio-ruby/rest/video/v1/room/recording.rb index bfeb554c8..7fed6b939 100644 --- a/lib/twilio-ruby/rest/video/v1/room/recording.rb +++ b/lib/twilio-ruby/rest/video/v1/room/recording.rb @@ -34,9 +34,9 @@ def initialize(version, room_sid: nil) # Can be: `processing`, `completed`, or `deleted`. # @param [String] source_sid Read only the recordings that have this `source_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [Time] date_created_before Read only Recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -63,9 +63,9 @@ def list(status: :unset, source_sid: :unset, date_created_after: :unset, date_cr # Can be: `processing`, `completed`, or `deleted`. # @param [String] source_sid Read only the recordings that have this `source_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [Time] date_created_before Read only Recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -108,9 +108,9 @@ def each # Can be: `processing`, `completed`, or `deleted`. # @param [String] source_sid Read only the recordings that have this `source_sid`. # @param [Time] date_created_after Read only recordings that started on or after - # this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [Time] date_created_before Read only Recordings that started before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone. + # {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 diff --git a/lib/twilio-ruby/rest/video/v1/room/room_participant.rb b/lib/twilio-ruby/rest/video/v1/room/room_participant.rb index 950ab2cb1..5091aad32 100644 --- a/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +++ b/lib/twilio-ruby/rest/video/v1/room/room_participant.rb @@ -34,11 +34,11 @@ def initialize(version, room_sid: nil) # Status is `connected`, for `completed` Rooms only `disconnected` Participants # are returned. # @param [String] identity Read only the Participants with this - # [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] `identity` value. # @param [Time] date_created_after Read only Participants that started after this - # date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [Time] date_created_before Read only Participants that started before - # this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # this date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when @@ -66,11 +66,11 @@ def list(status: :unset, identity: :unset, date_created_after: :unset, date_crea # Status is `connected`, for `completed` Rooms only `disconnected` Participants # are returned. # @param [String] identity Read only the Participants with this - # [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] `identity` value. # @param [Time] date_created_after Read only Participants that started after this - # date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [Time] date_created_before Read only Participants that started before - # this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # this date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when @@ -114,11 +114,11 @@ def each # Status is `connected`, for `completed` Rooms only `disconnected` Participants # are returned. # @param [String] identity Read only the Participants with this - # [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value. + # {User}[https://www.twilio.com/docs/chat/rest/user-resource] `identity` value. # @param [Time] date_created_after Read only Participants that started after this - # date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [Time] date_created_before Read only Participants that started before - # this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. + # this date in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601#UTC] format. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 diff --git a/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb b/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb index 719a79294..0e41d5702 100644 --- a/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +++ b/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb @@ -44,9 +44,9 @@ def fetch ## # Update the SubscribeRulesInstance - # @param [Hash] rules A JSON-encoded array of subscribe rules. See the [Specifying + # @param [Hash] rules A JSON-encoded array of subscribe rules. See the {Specifying # Subscribe - # Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) + # Rules}[https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr] # section for further information. # @return [SubscribeRulesInstance] Updated SubscribeRulesInstance def update(rules: :unset) diff --git a/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb b/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb index cfe67e066..cfb767cd2 100644 --- a/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb +++ b/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb @@ -42,14 +42,14 @@ def initialize(version) # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup is # enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the # United States and Canada automatically perform a CNAM Lookup and display Caller - # ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @param [String] connection_policy_sid The SID of the Connection Policy that # Twilio will use when routing traffic to your communications infrastructure. # @param [String] from_domain_sid The SID of the SIP Domain that should be used in # the `From` header of originating calls sent to your SIP infrastructure. If your # SIP infrastructure allows users to "call back" an incoming call, configure this - # with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure + # with a {SIP Domain}[https://www.twilio.com/docs/voice/api/sending-sip] to ensure # proper routing. If not configured, the from domain will default to # "sip.twilio.com". # @return [ByocTrunkInstance] Created ByocTrunkInstance @@ -230,14 +230,14 @@ def fetch # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup is # enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the # United States and Canada automatically perform a CNAM Lookup and display Caller - # ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @param [String] connection_policy_sid The SID of the Connection Policy that # Twilio will use when routing traffic to your communications infrastructure. # @param [String] from_domain_sid The SID of the SIP Domain that should be used in # the `From` header of originating calls sent to your SIP infrastructure. If your # SIP infrastructure allows users to "call back" an incoming call, configure this - # with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure + # with a {SIP Domain}[https://www.twilio.com/docs/voice/api/sending-sip] to ensure # proper routing. If not configured, the from domain will default to # "sip.twilio.com". # @return [ByocTrunkInstance] Updated ByocTrunkInstance @@ -443,14 +443,14 @@ def fetch # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup is # enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the # United States and Canada automatically perform a CNAM Lookup and display Caller - # ID data on your phone. See [CNAM - # Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information. + # ID data on your phone. See {CNAM + # Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information. # @param [String] connection_policy_sid The SID of the Connection Policy that # Twilio will use when routing traffic to your communications infrastructure. # @param [String] from_domain_sid The SID of the SIP Domain that should be used in # the `From` header of originating calls sent to your SIP infrastructure. If your # SIP infrastructure allows users to "call back" an incoming call, configure this - # with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure + # with a {SIP Domain}[https://www.twilio.com/docs/voice/api/sending-sip] to ensure # proper routing. If not configured, the from domain will default to # "sip.twilio.com". # @return [ByocTrunkInstance] Updated ByocTrunkInstance diff --git a/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb b/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb index 365caada7..9da89b41a 100644 --- a/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +++ b/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb @@ -31,8 +31,8 @@ def initialize(version) ## # Access the countries - # @param [String] iso_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the + # @param [String] iso_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the # DialingPermissions Country resource to fetch # @return [CountryList] # @return [CountryContext] if iso_code was passed. diff --git a/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb b/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb index 79bd06932..e63dfffb5 100644 --- a/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +++ b/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb @@ -31,20 +31,20 @@ def initialize(version) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] iso_code Filter to retrieve the country permissions by - # specifying the [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + # specifying the {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] # @param [String] continent Filter to retrieve the country permissions by # specifying the continent - # @param [String] country_code Filter the results by specified [country - # codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html) + # @param [String] country_code Filter the results by specified {country + # codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html] # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country # permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`. # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the # country permissions with dialing to high-risk special service numbers enabled. # Can be: `true` or `false` # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the - # country permissions with dialing to high-risk [toll - # fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled. + # country permissions with dialing to high-risk {toll + # fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled. # Can be: `true` or `false`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit @@ -71,20 +71,20 @@ def list(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_num # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [String] iso_code Filter to retrieve the country permissions by - # specifying the [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + # specifying the {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] # @param [String] continent Filter to retrieve the country permissions by # specifying the continent - # @param [String] country_code Filter the results by specified [country - # codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html) + # @param [String] country_code Filter the results by specified {country + # codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html] # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country # permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`. # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the # country permissions with dialing to high-risk special service numbers enabled. # Can be: `true` or `false` # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the - # country permissions with dialing to high-risk [toll - # fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled. + # country permissions with dialing to high-risk {toll + # fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled. # Can be: `true` or `false`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. @@ -127,20 +127,20 @@ def each # Retrieve a single page of CountryInstance records from the API. # Request is executed immediately. # @param [String] iso_code Filter to retrieve the country permissions by - # specifying the [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + # specifying the {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] # @param [String] continent Filter to retrieve the country permissions by # specifying the continent - # @param [String] country_code Filter the results by specified [country - # codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html) + # @param [String] country_code Filter the results by specified {country + # codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html] # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country # permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`. # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the # country permissions with dialing to high-risk special service numbers enabled. # Can be: `true` or `false` # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the - # country permissions with dialing to high-risk [toll - # fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled. + # country permissions with dialing to high-risk {toll + # fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled. # Can be: `true` or `false`. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state @@ -221,8 +221,8 @@ class CountryContext < InstanceContext ## # Initialize the CountryContext # @param [Version] version Version that contains the resource - # @param [String] iso_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the + # @param [String] iso_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the # DialingPermissions Country resource to fetch # @return [CountryContext] CountryContext def initialize(version, iso_code) @@ -279,8 +279,8 @@ class CountryInstance < InstanceResource # Initialize the CountryInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the + # @param [String] iso_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the # DialingPermissions Country resource to fetch # @return [CountryInstance] CountryInstance def initialize(version, payload, iso_code: nil) diff --git a/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb b/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb index 54bebb296..0718bf742 100644 --- a/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +++ b/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb @@ -18,8 +18,8 @@ class HighriskSpecialPrefixList < ListResource ## # Initialize the HighriskSpecialPrefixList # @param [Version] version Version that contains the resource - # @param [String] iso_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + # @param [String] iso_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2]. # @return [HighriskSpecialPrefixList] HighriskSpecialPrefixList def initialize(version, iso_code: nil) super(version) @@ -154,8 +154,8 @@ class HighriskSpecialPrefixInstance < InstanceResource # Initialize the HighriskSpecialPrefixInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] iso_code The [ISO country - # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + # @param [String] iso_code The {ISO country + # code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2]. # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance def initialize(version, payload, iso_code: nil) super(version) diff --git a/lib/twilio-ruby/rest/voice/v1/ip_record.rb b/lib/twilio-ruby/rest/voice/v1/ip_record.rb index 764dc2b48..e635e133f 100644 --- a/lib/twilio-ruby/rest/voice/v1/ip_record.rb +++ b/lib/twilio-ruby/rest/voice/v1/ip_record.rb @@ -29,7 +29,7 @@ def initialize(version) # @param [String] friendly_name A descriptive string that you create to describe # the resource. It is not unique and can be up to 255 characters long. # @param [String] cidr_prefix_length An integer representing the length of the - # [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. + # {CIDR}[https://tools.ietf.org/html/rfc4632] prefix to use with this IP address. # By default the entire IP address is used, which for IPv4 is value 32. # @return [IpRecordInstance] Created IpRecordInstance def create(ip_address: nil, friendly_name: :unset, cidr_prefix_length: :unset) @@ -283,7 +283,7 @@ def ip_address end ## - # @return [String] An integer representing the length of the [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32. + # @return [String] An integer representing the length of the {CIDR}[https://tools.ietf.org/html/rfc4632] prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32. def cidr_prefix_length @properties['cidr_prefix_length'] end diff --git a/lib/twilio-ruby/rest/wireless/v1/command.rb b/lib/twilio-ruby/rest/wireless/v1/command.rb index ace493142..68d0b842d 100644 --- a/lib/twilio-ruby/rest/wireless/v1/command.rb +++ b/lib/twilio-ruby/rest/wireless/v1/command.rb @@ -27,8 +27,8 @@ def initialize(version) # Lists CommandInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. - # @param [String] sim The `sid` or `unique_name` of the [Sim - # resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read. + # @param [String] sim The `sid` or `unique_name` of the {Sim + # resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read. # @param [command.Status] status The status of the resources to read. Can be: # `queued`, `sent`, `delivered`, `received`, or `failed`. # @param [command.Direction] direction Only return Commands with this direction @@ -57,8 +57,8 @@ def list(sim: :unset, status: :unset, direction: :unset, transport: :unset, limi # Streams CommandInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. - # @param [String] sim The `sid` or `unique_name` of the [Sim - # resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read. + # @param [String] sim The `sid` or `unique_name` of the {Sim + # resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read. # @param [command.Status] status The status of the resources to read. Can be: # `queued`, `sent`, `delivered`, `received`, or `failed`. # @param [command.Direction] direction Only return Commands with this direction @@ -103,8 +103,8 @@ def each ## # Retrieve a single page of CommandInstance records from the API. # Request is executed immediately. - # @param [String] sim The `sid` or `unique_name` of the [Sim - # resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read. + # @param [String] sim The `sid` or `unique_name` of the {Sim + # resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read. # @param [command.Status] status The status of the resources to read. Can be: # `queued`, `sent`, `delivered`, `received`, or `failed`. # @param [command.Direction] direction Only return Commands with this direction @@ -149,7 +149,7 @@ def get_page(target_url) # @param [String] command The message body of the Command. Can be plain text in # text mode or a Base64 encoded byte string in binary mode. # @param [String] sim The `sid` or `unique_name` of the - # [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command + # {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the Command # to. # @param [String] callback_method The HTTP method we use to call `callback_url`. # Can be: `POST` or `GET`, and the default is `POST`. diff --git a/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb b/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb index 80168b474..7d058ce14 100644 --- a/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +++ b/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb @@ -118,15 +118,15 @@ def get_page(target_url) # same day in the following month. Can be up to 2TB and the default value is # `1000`. # @param [String] data_metering The model used to meter data usage. Can be: `payg` - # and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data + # and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available {data # metering - # models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans). + # models}[https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans]. # @param [Boolean] messaging_enabled Whether SIMs can make, send, and receive SMS - # using [Commands](https://www.twilio.com/docs/wireless/api/command-resource). + # using {Commands}[https://www.twilio.com/docs/wireless/api/command-resource]. # @param [Boolean] voice_enabled Whether SIMs can make and receive voice calls. # @param [Boolean] national_roaming_enabled Whether SIMs can roam on networks - # other than the home network (T-Mobile USA) in the United States. See [national - # roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming). + # other than the home network (T-Mobile USA) in the United States. See {national + # roaming}[https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming]. # @param [String] international_roaming The list of services that SIMs capable of # using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can # be: `data`, `voice`, and `messaging`. @@ -134,8 +134,8 @@ def get_page(target_url) # upload combined) in Megabytes that the Network allows during one month on # non-home networks in the United States. The metering period begins the day of # activation and ends on the same day in the following month. Can be up to 2TB. - # See [national - # roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) + # See {national + # roaming}[https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming] # for more info. # @param [String] international_roaming_data_limit The total data usage (download # and upload combined) in Megabytes that the Network allows during one month when diff --git a/lib/twilio-ruby/rest/wireless/v1/sim.rb b/lib/twilio-ruby/rest/wireless/v1/sim.rb index bdf3980dd..52b7cf568 100644 --- a/lib/twilio-ruby/rest/wireless/v1/sim.rb +++ b/lib/twilio-ruby/rest/wireless/v1/sim.rb @@ -30,8 +30,8 @@ def initialize(version) # @param [sim.Status] status Only return Sim resources with this status. # @param [String] iccid Only return Sim resources with this ICCID. This will # return a list with a maximum size of 1. - # @param [String] rate_plan The SID or unique name of a [RatePlan - # resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only + # @param [String] rate_plan The SID or unique name of a {RatePlan + # resource}[https://www.twilio.com/docs/wireless/api/rateplan-resource]. Only # return Sim resources assigned to this RatePlan resource. # @param [String] e_id Deprecated. # @param [String] sim_registration_code Only return Sim resources with this @@ -62,8 +62,8 @@ def list(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_reg # @param [sim.Status] status Only return Sim resources with this status. # @param [String] iccid Only return Sim resources with this ICCID. This will # return a list with a maximum size of 1. - # @param [String] rate_plan The SID or unique name of a [RatePlan - # resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only + # @param [String] rate_plan The SID or unique name of a {RatePlan + # resource}[https://www.twilio.com/docs/wireless/api/rateplan-resource]. Only # return Sim resources assigned to this RatePlan resource. # @param [String] e_id Deprecated. # @param [String] sim_registration_code Only return Sim resources with this @@ -110,8 +110,8 @@ def each # @param [sim.Status] status Only return Sim resources with this status. # @param [String] iccid Only return Sim resources with this ICCID. This will # return a list with a maximum size of 1. - # @param [String] rate_plan The SID or unique name of a [RatePlan - # resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only + # @param [String] rate_plan The SID or unique name of a {RatePlan + # resource}[https://www.twilio.com/docs/wireless/api/rateplan-resource]. Only # return Sim resources assigned to this RatePlan resource. # @param [String] e_id Deprecated. # @param [String] sim_registration_code Only return Sim resources with this @@ -227,8 +227,8 @@ def fetch # status changes to its final status (`active` or `canceled`). # @param [String] friendly_name A descriptive string that you create to describe # the Sim resource. It does not need to be unique. - # @param [String] rate_plan The SID or unique name of the [RatePlan - # resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which + # @param [String] rate_plan The SID or unique name of the {RatePlan + # resource}[https://www.twilio.com/docs/wireless/api/rateplan-resource] to which # the Sim resource should be assigned. # @param [sim.Status] status The new status of the Sim resource. Can be: `ready`, # `active`, `suspended`, or `deactivated`. @@ -236,7 +236,7 @@ def fetch # `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`. # @param [String] commands_callback_url The URL we should call using the # `commands_callback_method` when the SIM sends a - # [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your + # {Command}[https://www.twilio.com/docs/wireless/api/command-resource]. Your # server should respond with an HTTP status code in the 200 range; any response # body is ignored. # @param [String] sms_fallback_method The HTTP method we should use to call @@ -248,7 +248,7 @@ def fetch # be: `GET` or `POST`. Default is `POST`. # @param [String] sms_url The URL we should call using the `sms_method` when the # SIM-connected device sends an SMS message that is not a - # [Command](https://www.twilio.com/docs/wireless/api/command-resource). + # {Command}[https://www.twilio.com/docs/wireless/api/command-resource]. # @param [String] voice_fallback_method The HTTP method we should use to call # `voice_fallback_url`. Can be: `GET` or `POST`. # @param [String] voice_fallback_url The URL we should call using the @@ -262,12 +262,12 @@ def fetch # Set to `resetting` to initiate a connectivity reset on the SIM. No other value # is valid. # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource + # {Account}[https://www.twilio.com/docs/iam/api/account] to which the Sim resource # should belong. The Account SID can only be that of the requesting Account or - # that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the + # that of a {Subaccount}[https://www.twilio.com/docs/iam/api/subaccounts] of the # requesting Account. Only valid when the Sim resource's status is `new`. For more - # information, see the [Move SIMs between Subaccounts - # documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts). + # information, see the {Move SIMs between Subaccounts + # documentation}[https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts]. # @return [SimInstance] Updated SimInstance def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset, account_sid: :unset) data = Twilio::Values.of({ @@ -561,8 +561,8 @@ def fetch # status changes to its final status (`active` or `canceled`). # @param [String] friendly_name A descriptive string that you create to describe # the Sim resource. It does not need to be unique. - # @param [String] rate_plan The SID or unique name of the [RatePlan - # resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which + # @param [String] rate_plan The SID or unique name of the {RatePlan + # resource}[https://www.twilio.com/docs/wireless/api/rateplan-resource] to which # the Sim resource should be assigned. # @param [sim.Status] status The new status of the Sim resource. Can be: `ready`, # `active`, `suspended`, or `deactivated`. @@ -570,7 +570,7 @@ def fetch # `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`. # @param [String] commands_callback_url The URL we should call using the # `commands_callback_method` when the SIM sends a - # [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your + # {Command}[https://www.twilio.com/docs/wireless/api/command-resource]. Your # server should respond with an HTTP status code in the 200 range; any response # body is ignored. # @param [String] sms_fallback_method The HTTP method we should use to call @@ -582,7 +582,7 @@ def fetch # be: `GET` or `POST`. Default is `POST`. # @param [String] sms_url The URL we should call using the `sms_method` when the # SIM-connected device sends an SMS message that is not a - # [Command](https://www.twilio.com/docs/wireless/api/command-resource). + # {Command}[https://www.twilio.com/docs/wireless/api/command-resource]. # @param [String] voice_fallback_method The HTTP method we should use to call # `voice_fallback_url`. Can be: `GET` or `POST`. # @param [String] voice_fallback_url The URL we should call using the @@ -596,12 +596,12 @@ def fetch # Set to `resetting` to initiate a connectivity reset on the SIM. No other value # is valid. # @param [String] account_sid The SID of the - # [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource + # {Account}[https://www.twilio.com/docs/iam/api/account] to which the Sim resource # should belong. The Account SID can only be that of the requesting Account or - # that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the + # that of a {Subaccount}[https://www.twilio.com/docs/iam/api/subaccounts] of the # requesting Account. Only valid when the Sim resource's status is `new`. For more - # information, see the [Move SIMs between Subaccounts - # documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts). + # information, see the {Move SIMs between Subaccounts + # documentation}[https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts]. # @return [SimInstance] Updated SimInstance def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset, account_sid: :unset) context.update( diff --git a/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb b/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb index 6a56b3972..69cabd7c7 100644 --- a/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +++ b/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb @@ -15,8 +15,8 @@ class DataSessionList < ListResource ## # Initialize the DataSessionList # @param [Version] version Version that contains the resource - # @param [String] sim_sid The SID of the [Sim - # resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data + # @param [String] sim_sid The SID of the {Sim + # resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that the Data # Session is for. # @return [DataSessionList] DataSessionList def initialize(version, sim_sid: nil) @@ -148,8 +148,8 @@ class DataSessionInstance < InstanceResource # Initialize the DataSessionInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] sim_sid The SID of the [Sim - # resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data + # @param [String] sim_sid The SID of the {Sim + # resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that the Data # Session is for. # @return [DataSessionInstance] DataSessionInstance def initialize(version, payload, sim_sid: nil) diff --git a/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb b/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb index 092e977d4..1c85d81c4 100644 --- a/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +++ b/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb @@ -15,8 +15,8 @@ class UsageRecordList < ListResource ## # Initialize the UsageRecordList # @param [Version] version Version that contains the resource - # @param [String] sim_sid The SID of the [Sim - # resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage + # @param [String] sim_sid The SID of the {Sim + # resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage # Record is for. # @return [UsageRecordList] UsageRecordList def initialize(version, sim_sid: nil) @@ -32,10 +32,10 @@ def initialize(version, sim_sid: nil) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] end_ Only include usage that occurred on or before this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is the current time. # @param [Time] start Only include usage that has occurred on or after this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is one month before the `end` parameter value. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of @@ -62,10 +62,10 @@ def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] end_ Only include usage that occurred on or before this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is the current time. # @param [Time] start Only include usage that has occurred on or after this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is one month before the `end` parameter value. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of @@ -103,10 +103,10 @@ def each # Retrieve a single page of UsageRecordInstance records from the API. # Request is executed immediately. # @param [Time] end_ Only include usage that occurred on or before this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is the current time. # @param [Time] start Only include usage that has occurred on or after this date, - # specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # The default is one month before the `end` parameter value. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of @@ -184,8 +184,8 @@ class UsageRecordInstance < InstanceResource # Initialize the UsageRecordInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] sim_sid The SID of the [Sim - # resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage + # @param [String] sim_sid The SID of the {Sim + # resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage # Record is for. # @return [UsageRecordInstance] UsageRecordInstance def initialize(version, payload, sim_sid: nil) diff --git a/lib/twilio-ruby/rest/wireless/v1/usage_record.rb b/lib/twilio-ruby/rest/wireless/v1/usage_record.rb index aefd48d17..c8e81d4b0 100644 --- a/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +++ b/lib/twilio-ruby/rest/wireless/v1/usage_record.rb @@ -28,9 +28,9 @@ def initialize(version) # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Time] end_ Only include usage that has occurred on or before this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [Time] start Only include usage that has occurred on or after this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage # Record that describes the usage for the entire period. @@ -56,9 +56,9 @@ def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Time] end_ Only include usage that has occurred on or before this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [Time] start Only include usage that has occurred on or after this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage # Record that describes the usage for the entire period. @@ -95,9 +95,9 @@ def each # Retrieve a single page of UsageRecordInstance records from the API. # Request is executed immediately. # @param [Time] end_ Only include usage that has occurred on or before this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [Time] start Only include usage that has occurred on or after this date. - # Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). + # Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html]. # @param [usage_record.Granularity] granularity How to summarize the usage by # time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage # Record that describes the usage for the entire period.