twilio-ruby 5.27.0 → 5.27.1

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

@@ -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
@@ -198,10 +194,9 @@ module Twilio
             ##
             # Initialize the ParticipantContext
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid A system-generated 34-character string that uniquely
-            #   identifies a Room.
-            # @param [String] sid A system-generated 34-character string that uniquely
-            #   identifies this Participant.
+            # @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)
@@ -233,7 +228,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)
               data = Twilio::Values.of({'Status' => status, })
@@ -327,10 +325,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 A system-generated 34-character string that uniquely
-            #   identifies this Participant.
+            # @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)
@@ -368,73 +364,73 @@ 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
@@ -448,7 +444,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, )

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

@@ -16,9 +16,10 @@ module Twilio
               ##
               # Initialize the PublishedTrackList
               # @param [Version] version Version that contains the resource
-              # @param [String] room_sid Unique Room identifier where this Track is published.
-              # @param [String] participant_sid Unique Participant identifier that publishes
-              #   this Track.
+              # @param [String] room_sid The SID of the Room resource where the track is
+              #   published.
+              # @param [String] participant_sid The SID of the Participant resource with the
+              #   published track.
               # @return [PublishedTrackList] PublishedTrackList
               def initialize(version, room_sid: nil, participant_sid: nil)
                 super(version)
@@ -155,11 +156,12 @@ module Twilio
               ##
               # Initialize the PublishedTrackContext
               # @param [Version] version Version that contains the resource
-              # @param [String] room_sid Unique Room identifier where this Track is published.
-              # @param [String] participant_sid Unique Participant identifier that publishes
-              #   this Track.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   resource.
+              # @param [String] room_sid The SID of the Room resource where the Track resource
+              #   to fetch is published.
+              # @param [String] participant_sid The SID of the Participant resource with the
+              #   published track to fetch.
+              # @param [String] sid The SID of the RoomParticipantPublishedTrack resource to
+              #   fetch.
               # @return [PublishedTrackContext] PublishedTrackContext
               def initialize(version, room_sid, participant_sid, sid)
                 super(version)
@@ -210,11 +212,12 @@ module Twilio
               # Initialize the PublishedTrackInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] room_sid Unique Room identifier where this Track is published.
-              # @param [String] participant_sid Unique Participant identifier that publishes
-              #   this Track.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   resource.
+              # @param [String] room_sid The SID of the Room resource where the track is
+              #   published.
+              # @param [String] participant_sid The SID of the Participant resource with the
+              #   published track.
+              # @param [String] sid The SID of the RoomParticipantPublishedTrack resource to
+              #   fetch.
               # @return [PublishedTrackInstance] PublishedTrackInstance
               def initialize(version, payload, room_sid: nil, participant_sid: nil, sid: nil)
                 super(version)
@@ -258,55 +261,55 @@ 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] Unique Participant identifier that publishes this Track.
+              # @return [String] The SID of the Participant resource with the published track
               def participant_sid
                 @properties['participant_sid']
               end
 
               ##
-              # @return [String] Unique Room identifier where this Track is published.
+              # @return [String] The SID of the Room resource where the track is published
               def room_sid
                 @properties['room_sid']
               end
 
               ##
-              # @return [String] Track name. Limited to 128 characters.
+              # @return [String] The track name
               def name
                 @properties['name']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @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.
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Boolean] Specifies whether the Track is enabled or not.
+              # @return [Boolean] Whether the track is enabled
               def enabled
                 @properties['enabled']
               end
 
               ##
-              # @return [published_track.Kind] Specifies whether Track represents `audio`, `video` or `data`
+              # @return [published_track.Kind] The track type
               def kind
                 @properties['kind']
               end
 
               ##
-              # @return [String] The absolute URL for this resource.
+              # @return [String] The absolute URL of the resource
               def url
                 @properties['url']
               end

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the SubscribeRulesList
               # @param [Version] version Version that contains the resource
-              # @param [String] room_sid The unique Room identifier for the Subscribe Rules
-              # @param [String] participant_sid The unique Participant identifier for the
+              # @param [String] room_sid The SID of the Room resource for the Subscribe Rules
+              # @param [String] participant_sid The SID of the Participant resource for the
               #   Subscribe Rules.
               # @return [SubscribeRulesList] SubscribeRulesList
               def initialize(version, room_sid: nil, participant_sid: nil)
@@ -52,7 +52,7 @@ 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)
               #   section for further information.
@@ -124,8 +124,8 @@ module Twilio
               # Initialize the SubscribeRulesInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] room_sid The unique Room identifier for the Subscribe Rules
-              # @param [String] participant_sid The unique Participant identifier for the
+              # @param [String] room_sid The SID of the Room resource for the Subscribe Rules
+              # @param [String] participant_sid The SID of the Participant resource for the
               #   Subscribe Rules.
               # @return [SubscribeRulesInstance] SubscribeRulesInstance
               def initialize(version, payload, room_sid: nil, participant_sid: nil)
@@ -142,31 +142,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique Participant identifier for the Subscribe Rules.
+              # @return [String] The SID of the Participant resource for the Subscribe Rules
               def participant_sid
                 @properties['participant_sid']
               end
 
               ##
-              # @return [String] The unique Room identifier for the Subscribe Rules
+              # @return [String] The SID of the Room resource for the Subscribe Rules
               def room_sid
                 @properties['room_sid']
               end
 
               ##
-              # @return [String] A collection of Subscribe Rules to include or exclude matching Tracks.
+              # @return [String] A collection of Subscribe Rules that describe how to include or exclude matching tracks
               def rules
                 @properties['rules']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @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.
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end

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

@@ -16,9 +16,9 @@ module Twilio
               ##
               # Initialize the SubscribedTrackList
               # @param [Version] version Version that contains the resource
-              # @param [String] room_sid Unique Room identifier where this Track is published.
-              # @param [String] participant_sid Unique Participant identifier that subscribes to
-              #   this Track.
+              # @param [String] room_sid The SID of the room where the track is published.
+              # @param [String] participant_sid The SID of the participant that subscribes to
+              #   the track.
               # @return [SubscribedTrackList] SubscribedTrackList
               def initialize(version, room_sid: nil, participant_sid: nil)
                 super(version)
@@ -155,11 +155,12 @@ module Twilio
               ##
               # Initialize the SubscribedTrackContext
               # @param [Version] version Version that contains the resource
-              # @param [String] room_sid Unique Room identifier where this Track is subscribed.
-              # @param [String] participant_sid Unique Participant identifier that subscribes to
-              #   this Track.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   resource.
+              # @param [String] room_sid The SID of the Room where the Track resource to fetch
+              #   is subscribed.
+              # @param [String] participant_sid The SID of the participant that subscribes to
+              #   the Track resource to fetch.
+              # @param [String] sid The SID of the RoomParticipantSubscribedTrack resource to
+              #   fetch.
               # @return [SubscribedTrackContext] SubscribedTrackContext
               def initialize(version, room_sid, participant_sid, sid)
                 super(version)
@@ -210,11 +211,11 @@ module Twilio
               # Initialize the SubscribedTrackInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] room_sid Unique Room identifier where this Track is published.
-              # @param [String] participant_sid Unique Participant identifier that subscribes to
-              #   this Track.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   resource.
+              # @param [String] room_sid The SID of the room where the track is published.
+              # @param [String] participant_sid The SID of the participant that subscribes to
+              #   the track.
+              # @param [String] sid The SID of the RoomParticipantSubscribedTrack resource to
+              #   fetch.
               # @return [SubscribedTrackInstance] SubscribedTrackInstance
               def initialize(version, payload, room_sid: nil, participant_sid: nil, sid: nil)
                 super(version)
@@ -259,61 +260,61 @@ 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] Unique Participant identifier that subscribes to this Track.
+              # @return [String] The SID of the participant that subscribes to the track
               def participant_sid
                 @properties['participant_sid']
               end
 
               ##
-              # @return [String] Unique Participant identifier that publishes this Track.
+              # @return [String] The SID of the participant that publishes the track
               def publisher_sid
                 @properties['publisher_sid']
               end
 
               ##
-              # @return [String] Unique Room identifier where this Track is published.
+              # @return [String] The SID of the room where the track is published
               def room_sid
                 @properties['room_sid']
               end
 
               ##
-              # @return [String] Track name. Limited to 128 characters.
+              # @return [String] The track name
               def name
                 @properties['name']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @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.
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Boolean] Specifies whether the Track is enabled or not.
+              # @return [Boolean] Whether the track is enabled
               def enabled
                 @properties['enabled']
               end
 
               ##
-              # @return [subscribed_track.Kind] Specifies whether Track represents `audio`, `video` or `data`
+              # @return [subscribed_track.Kind] The track type
               def kind
                 @properties['kind']
               end
 
               ##
-              # @return [String] The absolute URL for this resource.
+              # @return [String] The absolute URL of the resource
               def url
                 @properties['url']
               end