twilio-ruby 5.31.1 → 5.46.1

data/lib/twilio-ruby/rest/video/v1/recording_settings.rb

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Video < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsList < ListResource
           ##
           # Initialize the RecordingSettingsList
@@ -31,8 +29,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsPage < Page
           ##
           # Initialize the RecordingSettingsPage
@@ -62,8 +58,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsContext < InstanceContext
           ##
           # Initialize the RecordingSettingsContext
@@ -78,23 +72,16 @@ module Twilio
           end
 
           ##
-          # Fetch a RecordingSettingsInstance
+          # Fetch the RecordingSettingsInstance
           # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             RecordingSettingsInstance.new(@version, payload, )
           end
 
           ##
-          # Retrieve a single page of RecordingSettingsInstance records from the API.
-          # Request is executed immediately.
+          # Create the RecordingSettingsInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource and be shown to users in the console
           # @param [String] aws_credentials_sid The SID of the stored Credential resource.
@@ -102,13 +89,15 @@ module Twilio
           #   encryption.
           # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
           #   should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
-          #   `recordings` is the path in which you want the recordings to be stored.
+          #   `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
+          #   the path in which you want the recordings to be stored. This URL accepts only
+          #   URI-valid characters, as described in the <a
+          #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
           # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
           #   the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
           # @param [Boolean] encryption_enabled Whether all recordings should be stored in
           #   an encrypted form. The default is `false`.
-          # @return [RecordingSettingsInstance] Newly created RecordingSettingsInstance
+          # @return [RecordingSettingsInstance] Created RecordingSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -119,11 +108,7 @@ module Twilio
                 'EncryptionEnabled' => encryption_enabled,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             RecordingSettingsInstance.new(@version, payload, )
           end
@@ -143,8 +128,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsInstance < InstanceResource
           ##
           # Initialize the RecordingSettingsInstance
@@ -231,15 +214,14 @@ module Twilio
           end
 
           ##
-          # Fetch a RecordingSettingsInstance
+          # Fetch the RecordingSettingsInstance
           # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Retrieve a single page of RecordingSettingsInstance records from the API.
-          # Request is executed immediately.
+          # Create the RecordingSettingsInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource and be shown to users in the console
           # @param [String] aws_credentials_sid The SID of the stored Credential resource.
@@ -247,13 +229,15 @@ module Twilio
           #   encryption.
           # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
           #   should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
-          #   `recordings` is the path in which you want the recordings to be stored.
+          #   `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
+          #   the path in which you want the recordings to be stored. This URL accepts only
+          #   URI-valid characters, as described in the <a
+          #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
           # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
           #   the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
           # @param [Boolean] encryption_enabled Whether all recordings should be stored in
           #   an encrypted form. The default is `false`.
-          # @return [RecordingSettingsInstance] Newly created RecordingSettingsInstance
+          # @return [RecordingSettingsInstance] Created RecordingSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             context.create(
                 friendly_name: friendly_name,

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

@@ -24,13 +24,9 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of RoomInstance records from the API.
-          # Request is executed immediately.
-          # @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`,
+          # Create the RoomInstance
+          # @param [Boolean] enable_turn Deprecated, now always considered to be true.
+          # @param [room.RoomType] type The type of room. Can be: `go`, `peer-to-peer`,
           #   `group-small`, or `group`. The default value is `group`.
           # @param [String] unique_name An application-defined string that uniquely
           #   identifies the resource. It can be used as a `room_sid` in place of the
@@ -40,8 +36,8 @@ module Twilio
           #   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`.
@@ -52,13 +48,14 @@ module Twilio
           # @param [Boolean] record_participants_on_connect Whether to start recording when
           #   Participants connect. ***This feature is not available in `peer-to-peer`
           #   rooms.***
-          # @param [room.VideoCodec] video_codecs An array of the video codecs that are
-          #   supported when publishing a track in the room.  Can be: `VP8` and `H264`.
+          # @param [Array[room.VideoCodec]] video_codecs An array of the video codecs that
+          #   are 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). ***This feature is not available in `peer-to-peer` rooms.***
-          # @return [RoomInstance] Newly created RoomInstance
+          #   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)
             data = Twilio::Values.of({
                 'EnableTurn' => enable_turn,
@@ -72,11 +69,7 @@ module Twilio
                 'MediaRegion' => media_region,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             RoomInstance.new(@version, payload, )
           end
@@ -180,11 +173,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             RoomPage.new(@version, response, @solution)
           end
 
@@ -253,19 +244,14 @@ module Twilio
             # Dependents
             @recordings = nil
             @participants = nil
+            @recording_rules = nil
           end
 
           ##
-          # Fetch a RoomInstance
+          # Fetch the RoomInstance
           # @return [RoomInstance] Fetched RoomInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             RoomInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -278,11 +264,7 @@ module Twilio
           def update(status: nil)
             data = Twilio::Values.of({'Status' => status, })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             RoomInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -323,6 +305,18 @@ module Twilio
             @participants
           end
 
+          ##
+          # Access the recording_rules
+          # @return [RecordingRulesList]
+          # @return [RecordingRulesContext]
+          def recording_rules
+            unless @recording_rules
+              @recording_rules = RecordingRulesList.new(@version, room_sid: @solution[:sid], )
+            end
+
+            @recording_rules
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -363,6 +357,7 @@ module Twilio
                 'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
                 'type' => payload['type'],
                 'max_participants' => payload['max_participants'].to_i,
+                'max_concurrent_published_tracks' => payload['max_concurrent_published_tracks'] == nil ? payload['max_concurrent_published_tracks'] : payload['max_concurrent_published_tracks'].to_i,
                 'record_participants_on_connect' => payload['record_participants_on_connect'],
                 'video_codecs' => payload['video_codecs'],
                 'media_region' => payload['media_region'],
@@ -464,6 +459,12 @@ module Twilio
             @properties['max_participants']
           end
 
+          ##
+          # @return [String] The maximum number of published tracks allowed in the room at the same time
+          def max_concurrent_published_tracks
+            @properties['max_concurrent_published_tracks']
+          end
+
           ##
           # @return [Boolean] Whether to start recording when Participants connect
           def record_participants_on_connect
@@ -471,7 +472,7 @@ module Twilio
           end
 
           ##
-          # @return [room.VideoCodec] An array of the video codecs that are supported when publishing a track in the room
+          # @return [Array[room.VideoCodec]] An array of the video codecs that are supported when publishing a track in the room
           def video_codecs
             @properties['video_codecs']
           end
@@ -495,7 +496,7 @@ module Twilio
           end
 
           ##
-          # Fetch a RoomInstance
+          # Fetch the RoomInstance
           # @return [RoomInstance] Fetched RoomInstance
           def fetch
             context.fetch
@@ -524,6 +525,13 @@ module Twilio
             context.participants
           end
 
+          ##
+          # Access the recording_rules
+          # @return [recording_rules] recording_rules
+          def recording_rules
+            context.recording_rules
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

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

@@ -34,9 +34,9 @@ module Twilio
             #   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 @@ module Twilio
             #   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 @@ module Twilio
             #   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
@@ -125,11 +125,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RoomRecordingPage.new(@version, response, @solution)
             end
 
@@ -199,25 +197,19 @@ module Twilio
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RoomRecordingInstance
+            # Delete the RoomRecordingInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -380,14 +372,14 @@ module Twilio
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RoomRecordingInstance
+            # Delete the RoomRecordingInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -34,11 +34,11 @@ module Twilio
             #   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 @@ module Twilio
             #   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 @@ module Twilio
             #   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
@@ -133,11 +133,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ParticipantPage.new(@version, response, @solution)
             end
 
@@ -212,16 +210,10 @@ module Twilio
             end
 
             ##
-            # Fetch a ParticipantInstance
+            # Fetch the ParticipantInstance
             # @return [ParticipantInstance] Fetched ParticipantInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
@@ -236,11 +228,7 @@ module Twilio
             def update(status: :unset)
               data = Twilio::Values.of({'Status' => status, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
@@ -436,7 +424,7 @@ module Twilio
             end
 
             ##
-            # Fetch a ParticipantInstance
+            # Fetch the ParticipantInstance
             # @return [ParticipantInstance] Fetched ParticipantInstance
             def fetch
               context.fetch