twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,7 +15,8 @@ module Twilio
             ##
             # Initialize the RoomRecordingList
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
+            # @param [String] room_sid The SID of the Room resource the recording is
+            #   associated with.
             # @return [RoomRecordingList] RoomRecordingList
             def initialize(version, room_sid: nil)
               super(version)
@@ -29,10 +30,13 @@ module Twilio
             # Lists RoomRecordingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   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.
+            # @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.
             # @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
@@ -55,10 +59,13 @@ module Twilio
             # Streams RoomRecordingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   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.
+            # @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.
             # @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
@@ -97,10 +104,13 @@ module Twilio
             ##
             # Retrieve a single page of RoomRecordingInstance records from the API.
             # Request is executed immediately.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   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.
+            # @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.
             # @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
@@ -115,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
 
@@ -176,8 +184,9 @@ module Twilio
             ##
             # Initialize the RoomRecordingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the Room resource with the recording to
+            #   fetch.
+            # @param [String] sid The SID of the RoomRecording resource to fetch.
             # @return [RoomRecordingContext] RoomRecordingContext
             def initialize(version, room_sid, sid)
               super(version)
@@ -188,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
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -215,6 +218,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Video.V1.RoomRecordingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Video.V1.RoomRecordingContext #{context}>"
+            end
           end
 
           class RoomRecordingInstance < InstanceResource
@@ -222,8 +232,9 @@ module Twilio
             # Initialize the RoomRecordingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the Room resource the recording is
+            #   associated with.
+            # @param [String] sid The SID of the RoomRecording resource to fetch.
             # @return [RoomRecordingInstance] RoomRecordingInstance
             def initialize(version, payload, room_sid: nil, sid: nil)
               super(version)
@@ -265,111 +276,111 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [room_recording.Status] The status
+            # @return [room_recording.Status] The status of the recording
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The source_sid
+            # @return [String] The SID of the recording source
             def source_sid
               @properties['source_sid']
             end
 
             ##
-            # @return [String] The size
+            # @return [String] The size of the recorded track in bytes
             def size
               @properties['size']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [room_recording.Type] The type
+            # @return [room_recording.Type] The recording's media type
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The duration
+            # @return [String] The duration of the recording in seconds
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [room_recording.Format] The container_format
+            # @return [room_recording.Format] The file format for the recording
             def container_format
               @properties['container_format']
             end
 
             ##
-            # @return [room_recording.Codec] The codec
+            # @return [room_recording.Codec] The codec used for the recording
             def codec
               @properties['codec']
             end
 
             ##
-            # @return [Hash] The grouping_sids
+            # @return [Hash] A list of SIDs related to the Recording
             def grouping_sids
               @properties['grouping_sids']
             end
 
             ##
-            # @return [String] The track_name
+            # @return [String] The name that was given to the source track of the recording
             def track_name
               @properties['track_name']
             end
 
             ##
-            # @return [String] The offset
+            # @return [String] The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started
             def offset
               @properties['offset']
             end
 
             ##
-            # @return [String] The room_sid
+            # @return [String] The SID of the Room resource the recording is associated with
             def room_sid
               @properties['room_sid']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RoomRecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,8 +15,7 @@ module Twilio
             ##
             # Initialize the ParticipantList
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid A system-generated 34-character string that uniquely
-            #   identifies. this room
+            # @param [String] room_sid The SID of the participant's room.
             # @return [ParticipantList] ParticipantList
             def initialize(version, room_sid: nil)
               super(version)
@@ -30,17 +29,16 @@ module Twilio
             # Lists ParticipantInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [participant.Status] status Only show Participants with the given Status.
-            #    For `in-progress` Rooms the default Status is `connected`, for `completed`
-            #   Rooms only `disconnected` Participants are returned.
-            # @param [String] identity Only show Participants that connected to the Room using
-            #   the provided Identity.
-            # @param [Time] date_created_after Only show Participants that started after this
-            #   date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
-            # @param [Time] date_created_before Only show Participants that started before
-            #   this date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
+            # @param [participant.Status] status Read only the participants with this status.
+            #   Can be: `connected` or `disconnected`. For `in-progress` Rooms the default
+            #   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.
+            # @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.
+            # @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.
             # @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,17 +61,16 @@ module Twilio
             # Streams ParticipantInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [participant.Status] status Only show Participants with the given Status.
-            #    For `in-progress` Rooms the default Status is `connected`, for `completed`
-            #   Rooms only `disconnected` Participants are returned.
-            # @param [String] identity Only show Participants that connected to the Room using
-            #   the provided Identity.
-            # @param [Time] date_created_after Only show Participants that started after this
-            #   date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
-            # @param [Time] date_created_before Only show Participants that started before
-            #   this date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
+            # @param [participant.Status] status Read only the participants with this status.
+            #   Can be: `connected` or `disconnected`. For `in-progress` Rooms the default
+            #   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.
+            # @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.
+            # @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.
             # @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
@@ -112,17 +109,16 @@ module Twilio
             ##
             # Retrieve a single page of ParticipantInstance records from the API.
             # Request is executed immediately.
-            # @param [participant.Status] status Only show Participants with the given Status.
-            #    For `in-progress` Rooms the default Status is `connected`, for `completed`
-            #   Rooms only `disconnected` Participants are returned.
-            # @param [String] identity Only show Participants that connected to the Room using
-            #   the provided Identity.
-            # @param [Time] date_created_after Only show Participants that started after this
-            #   date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
-            # @param [Time] date_created_before Only show Participants that started before
-            #   this date, given as an [UTC ISO 8601
-            #   Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC).
+            # @param [participant.Status] status Read only the participants with this status.
+            #   Can be: `connected` or `disconnected`. For `in-progress` Rooms the default
+            #   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.
+            # @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.
+            # @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.
             # @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
@@ -137,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
 
@@ -198,8 +192,9 @@ module Twilio
             ##
             # Initialize the ParticipantContext
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the room with the Participant resource to
+            #   fetch.
+            # @param [String] sid The SID of the RoomParticipant resource to fetch.
             # @return [ParticipantContext] ParticipantContext
             def initialize(version, room_sid, sid)
               super(version)
@@ -211,35 +206,29 @@ module Twilio
               # Dependents
               @published_tracks = nil
               @subscribed_tracks = nil
+              @subscribe_rules = nil
             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
 
             ##
             # Update the ParticipantInstance
-            # @param [participant.Status] status Set to `disconnected` to remove participant.
+            # @param [participant.Status] status The new status of the resource. Can be:
+            #   `connected` or `disconnected`. For `in-progress` Rooms the default Status is
+            #   `connected`, for `completed` Rooms only `disconnected` Participants are
+            #   returned.
             # @return [ParticipantInstance] Updated ParticipantInstance
             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
@@ -269,25 +258,54 @@ module Twilio
             ##
             # Access the subscribed_tracks
             # @return [SubscribedTrackList]
-            # @return [SubscribedTrackContext]
-            def subscribed_tracks
+            # @return [SubscribedTrackContext] if sid was passed.
+            def subscribed_tracks(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return SubscribedTrackContext.new(@version, @solution[:room_sid], @solution[:sid], sid, )
+              end
+
               unless @subscribed_tracks
                 @subscribed_tracks = SubscribedTrackList.new(
                     @version,
                     room_sid: @solution[:room_sid],
-                    subscriber_sid: @solution[:sid],
+                    participant_sid: @solution[:sid],
                 )
               end
 
               @subscribed_tracks
             end
 
+            ##
+            # Access the subscribe_rules
+            # @return [SubscribeRulesList]
+            # @return [SubscribeRulesContext]
+            def subscribe_rules
+              unless @subscribe_rules
+                @subscribe_rules = SubscribeRulesList.new(
+                    @version,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:sid],
+                )
+              end
+
+              @subscribe_rules
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Video.V1.ParticipantContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Video.V1.ParticipantContext #{context}>"
+            end
           end
 
           class ParticipantInstance < InstanceResource
@@ -295,9 +313,8 @@ module Twilio
             # Initialize the ParticipantInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] room_sid A system-generated 34-character string that uniquely
-            #   identifies. this room
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the participant's room.
+            # @param [String] sid The SID of the RoomParticipant resource to fetch.
             # @return [ParticipantInstance] ParticipantInstance
             def initialize(version, payload, room_sid: nil, sid: nil)
               super(version)
@@ -335,79 +352,79 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] A system-generated 34-character string that uniquely identifies.
+            # @return [String] The SID of the participant's room
             def room_sid
               @properties['room_sid']
             end
 
             ##
-            # @return [String] The unique ID of the Account associated with this Room.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [participant.Status] A string representing the status of the Participant.
+            # @return [participant.Status] The status of the Participant
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] The unique name identifier that is assigned to this Participant.
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Time] The date that this resource was created, given as a UTC ISO 8601 Timestamp.
+            # @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 date that this resource was last updated, given as a UTC ISO 8601 Timestamp.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [Time] The time of Participant connected to the Room, given as a UTC ISO 8601 Timestamp.
+            # @return [Time] The time of participant connected to the room in ISO 8601 format
             def start_time
               @properties['start_time']
             end
 
             ##
-            # @return [Time] The time of Participant disconnected from the Room, given as a UTC ISO 8601 Timestamp.
+            # @return [Time] The time when the participant disconnected from the room in ISO 8601 format
             def end_time
               @properties['end_time']
             end
 
             ##
-            # @return [String] Duration of time in seconds this Participant was connected.
+            # @return [String] Duration of time in seconds the participant was connected
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [String] The absolute URL for this resource.
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a ParticipantInstance
+            # Fetch the ParticipantInstance
             # @return [ParticipantInstance] Fetched ParticipantInstance
             def fetch
               context.fetch
@@ -415,7 +432,10 @@ module Twilio
 
             ##
             # Update the ParticipantInstance
-            # @param [participant.Status] status Set to `disconnected` to remove participant.
+            # @param [participant.Status] status The new status of the resource. Can be:
+            #   `connected` or `disconnected`. For `in-progress` Rooms the default Status is
+            #   `connected`, for `completed` Rooms only `disconnected` Participants are
+            #   returned.
             # @return [ParticipantInstance] Updated ParticipantInstance
             def update(status: :unset)
               context.update(status: status, )
@@ -435,6 +455,13 @@ module Twilio
               context.subscribed_tracks
             end
 
+            ##
+            # Access the subscribe_rules
+            # @return [subscribe_rules] subscribe_rules
+            def subscribe_rules
+              context.subscribe_rules
+            end
+
             ##
             # Provide a user friendly representation
             def to_s