twilio-ruby 5.40.2 → 5.43.0

data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb

@@ -44,9 +44,9 @@ module Twilio
 
               ##
               # 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)

data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb

@@ -0,0 +1,150 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Video < Domain
+      class V1 < Version
+        class RoomContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class RecordingRulesList < ListResource
+            ##
+            # Initialize the RecordingRulesList
+            # @param [Version] version Version that contains the resource
+            # @param [String] room_sid The SID of the Room resource for the Recording Rules
+            # @return [RecordingRulesList] RecordingRulesList
+            def initialize(version, room_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {room_sid: room_sid}
+              @uri = "/Rooms/#{@solution[:room_sid]}/RecordingRules"
+            end
+
+            ##
+            # Fetch the RecordingRulesInstance
+            # @return [RecordingRulesInstance] Fetched RecordingRulesInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              RecordingRulesInstance.new(@version, payload, room_sid: @solution[:room_sid], )
+            end
+
+            ##
+            # Update the RecordingRulesInstance
+            # @param [Hash] rules A JSON-encoded array of recording rules.
+            # @return [RecordingRulesInstance] Updated RecordingRulesInstance
+            def update(rules: :unset)
+              data = Twilio::Values.of({'Rules' => Twilio.serialize_object(rules), })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              RecordingRulesInstance.new(@version, payload, room_sid: @solution[:room_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Video.V1.RecordingRulesList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class RecordingRulesPage < Page
+            ##
+            # Initialize the RecordingRulesPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [RecordingRulesPage] RecordingRulesPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of RecordingRulesInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [RecordingRulesInstance] RecordingRulesInstance
+            def get_instance(payload)
+              RecordingRulesInstance.new(@version, payload, room_sid: @solution[:room_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Video.V1.RecordingRulesPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class RecordingRulesInstance < InstanceResource
+            ##
+            # Initialize the RecordingRulesInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] room_sid The SID of the Room resource for the Recording Rules
+            # @return [RecordingRulesInstance] RecordingRulesInstance
+            def initialize(version, payload, room_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'room_sid' => payload['room_sid'],
+                  'rules' => payload['rules'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] The SID of the Room resource for the Recording Rules
+            def room_sid
+              @properties['room_sid']
+            end
+
+            ##
+            # @return [String] A collection of recording Rules that describe how to include or exclude matching tracks for recording
+            def rules
+              @properties['rules']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Video.V1.RecordingRulesInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Video.V1.RecordingRulesInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb

@@ -42,14 +42,14 @@ module Twilio
           # @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 @@ module Twilio
           # @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 @@ module Twilio
           # @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

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb

@@ -31,8 +31,8 @@ module Twilio
 
           ##
           # 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.
@@ -48,12 +48,9 @@ module Twilio
 
           ##
           # Access the settings
-          # @return [SettingsList]
-          # @return [SettingsContext]
+          # @return [SettingsContext] SettingsContext
           def settings
             return SettingsContext.new(@version, )
-
-            @settings ||= SettingsList.new(@version, )
           end
 
           ##

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb

@@ -31,20 +31,20 @@ module Twilio
             # 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 @@ module Twilio
             # 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 @@ module Twilio
             # 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 @@ module Twilio
             ##
             # 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 @@ module Twilio
             # 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)

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb

@@ -18,8 +18,8 @@ module Twilio
               ##
               # 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 @@ module Twilio
               # 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)

data/lib/twilio-ruby/rest/voice/v1/ip_record.rb

@@ -29,7 +29,7 @@ module Twilio
           # @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 @@ module Twilio
           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

data/lib/twilio-ruby/rest/wireless/v1/command.rb

@@ -27,8 +27,8 @@ module Twilio
           # 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 @@ module Twilio
           # 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 @@ module Twilio
           ##
           # 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 @@ module Twilio
           # @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`.

data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb

@@ -118,15 +118,15 @@ module Twilio
           #   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,9 @@ module Twilio
           #   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) for more info.
+          #   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
           #   roaming outside the United States. Can be up to 2TB.