twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the ParticipantList
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
+            # @param [String] room_sid The SID of the participant's room.
             # @return [ParticipantList] ParticipantList
             def initialize(version, room_sid: nil)
               super(version)
@@ -27,10 +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 The status
-            # @param [String] identity The identity
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @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
@@ -53,10 +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 The status
-            # @param [String] identity The identity
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @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
@@ -85,7 +99,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -95,10 +109,16 @@ module Twilio
             ##
             # Retrieve a single page of ParticipantInstance records from the API.
             # Request is executed immediately.
-            # @param [participant.Status] status The status
-            # @param [String] identity The identity
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @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
@@ -160,7 +180,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ParticipantInstance] ParticipantInstance
             def get_instance(payload)
-              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid])
+              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], )
             end
 
             ##
@@ -174,18 +194,21 @@ 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)
 
               # Path Solution
-              @solution = {room_sid: room_sid, sid: sid}
+              @solution = {room_sid: room_sid, sid: sid, }
               @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:sid]}"
 
               # Dependents
               @published_tracks = nil
+              @subscribed_tracks = nil
+              @subscribe_rules = nil
             end
 
             ##
@@ -200,15 +223,18 @@ module Twilio
                   params,
               )
 
-              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid])
+              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the ParticipantInstance
-            # @param [participant.Status] status The status
+            # @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})
+              data = Twilio::Values.of({'Status' => status, })
 
               payload = @version.update(
                   'POST',
@@ -216,7 +242,7 @@ module Twilio
                   data: data,
               )
 
-              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid])
+              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -227,7 +253,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return PublishedTrackContext.new(@version, @solution[:room_sid], @solution[:sid], sid)
+                return PublishedTrackContext.new(@version, @solution[:room_sid], @solution[:sid], sid, )
               end
 
               unless @published_tracks
@@ -241,12 +267,57 @@ module Twilio
               @published_tracks
             end
 
+            ##
+            # Access the subscribed_tracks
+            # @return [SubscribedTrackList]
+            # @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],
+                    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
@@ -254,8 +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 The room_sid
-            # @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)
@@ -278,7 +349,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'room_sid' => room_sid, 'sid' => sid || @properties['sid']}
+              @params = {'room_sid' => room_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -287,79 +358,79 @@ module Twilio
             # @return [ParticipantContext] ParticipantContext for this ParticipantInstance
             def context
               unless @instance_context
-                @instance_context = ParticipantContext.new(@version, @params['room_sid'], @params['sid'])
+                @instance_context = ParticipantContext.new(@version, @params['room_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The room_sid
+            # @return [String] The SID of the participant's room
             def room_sid
               @properties['room_sid']
             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 [participant.Status] The status
+            # @return [participant.Status] The status of the Participant
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             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 [Time] The date_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 [Time] The start_time
+            # @return [Time] The time of participant connected to the room in ISO 8601 format
             def start_time
               @properties['start_time']
             end
 
             ##
-            # @return [Time] The end_time
+            # @return [Time] The time when the participant disconnected from the room in ISO 8601 format
             def end_time
               @properties['end_time']
             end
 
             ##
-            # @return [String] The duration
+            # @return [String] Duration of time in seconds the participant was connected
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [String] The url
+            # @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
@@ -373,10 +444,13 @@ module Twilio
 
             ##
             # Update the ParticipantInstance
-            # @param [participant.Status] status The status
+            # @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)
+              context.update(status: status, )
             end
 
             ##
@@ -386,6 +460,20 @@ module Twilio
               context.published_tracks
             end
 
+            ##
+            # Access the subscribed_tracks
+            # @return [subscribed_tracks] subscribed_tracks
+            def subscribed_tracks
+              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