twilio-ruby 5.19.0 → 5.77.0

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

@@ -0,0 +1,240 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Video < Domain
+      class V1 < Version
+        class RoomContext < InstanceContext
+          class ParticipantContext < InstanceContext
+            class AnonymizeList < ListResource
+              ##
+              # Initialize the AnonymizeList
+              # @param [Version] version Version that contains the resource
+              # @param [String] room_sid The SID of the participant's room.
+              # @param [String] sid The unique string that we created to identify the
+              #   RoomParticipant resource.
+              # @return [AnonymizeList] AnonymizeList
+              def initialize(version, room_sid: nil, sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {room_sid: room_sid, sid: sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Video.V1.AnonymizeList>'
+              end
+            end
+
+            class AnonymizePage < Page
+              ##
+              # Initialize the AnonymizePage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [AnonymizePage] AnonymizePage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of AnonymizeInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [AnonymizeInstance] AnonymizeInstance
+              def get_instance(payload)
+                AnonymizeInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Video.V1.AnonymizePage>'
+              end
+            end
+
+            class AnonymizeContext < InstanceContext
+              ##
+              # Initialize the AnonymizeContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] room_sid The SID of the room with the participant to update.
+              # @param [String] sid The SID of the RoomParticipant resource to update.
+              # @return [AnonymizeContext] AnonymizeContext
+              def initialize(version, room_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {room_sid: room_sid, sid: sid, }
+                @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:sid]}/Anonymize"
+              end
+
+              ##
+              # Update the AnonymizeInstance
+              # @return [AnonymizeInstance] Updated AnonymizeInstance
+              def update
+                payload = @version.update('POST', @uri)
+
+                AnonymizeInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Video.V1.AnonymizeContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Video.V1.AnonymizeContext #{context}>"
+              end
+            end
+
+            class AnonymizeInstance < InstanceResource
+              ##
+              # Initialize the AnonymizeInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] room_sid The SID of the participant's room.
+              # @param [String] sid The unique string that we created to identify the
+              #   RoomParticipant resource.
+              # @return [AnonymizeInstance] AnonymizeInstance
+              def initialize(version, payload, room_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'room_sid' => payload['room_sid'],
+                    'account_sid' => payload['account_sid'],
+                    'status' => payload['status'],
+                    'identity' => payload['identity'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                    'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                    'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                    'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'room_sid' => room_sid, 'sid' => sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [AnonymizeContext] AnonymizeContext for this AnonymizeInstance
+              def context
+                unless @instance_context
+                  @instance_context = AnonymizeContext.new(@version, @params['room_sid'], @params['sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The unique string that identifies the resource
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The SID of the participant's room
+              def room_sid
+                @properties['room_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [anonymize.Status] The status of the Participant
+              def status
+                @properties['status']
+              end
+
+              ##
+              # @return [String] The SID of the participant
+              def identity
+                @properties['identity']
+              end
+
+              ##
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @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 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 the participant was connected
+              def duration
+                @properties['duration']
+              end
+
+              ##
+              # @return [String] The absolute URL of the resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Update the AnonymizeInstance
+              # @return [AnonymizeInstance] Updated AnonymizeInstance
+              def update
+                context.update
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Video.V1.AnonymizeInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Video.V1.AnonymizeInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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)
@@ -89,11 +90,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 PublishedTrackPage.new(@version, response, @solution)
               end
 
@@ -155,11 +154,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)
@@ -170,16 +170,10 @@ module Twilio
               end
 
               ##
-              # Fetch a PublishedTrackInstance
+              # Fetch the PublishedTrackInstance
               # @return [PublishedTrackInstance] Fetched PublishedTrackInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 PublishedTrackInstance.new(
                     @version,
@@ -196,6 +190,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Video.V1.PublishedTrackContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Video.V1.PublishedTrackContext #{context}>"
+              end
             end
 
             class PublishedTrackInstance < InstanceResource
@@ -203,11 +204,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)
@@ -251,61 +253,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 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
 
               ##
-              # Fetch a PublishedTrackInstance
+              # Fetch the PublishedTrackInstance
               # @return [PublishedTrackInstance] Fetched PublishedTrackInstance
               def fetch
                 context.fetch

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

@@ -0,0 +1,175 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Video < Domain
+      class V1 < Version
+        class RoomContext < InstanceContext
+          class ParticipantContext < InstanceContext
+            class SubscribeRulesList < ListResource
+              ##
+              # Initialize the SubscribeRulesList
+              # @param [Version] version Version that contains the resource
+              # @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)
+                super(version)
+
+                # Path Solution
+                @solution = {room_sid: room_sid, participant_sid: participant_sid}
+                @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:participant_sid]}/SubscribeRules"
+              end
+
+              ##
+              # Fetch the SubscribeRulesInstance
+              # @return [SubscribeRulesInstance] Fetched SubscribeRulesInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Update the SubscribeRulesInstance
+              # @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.
+              # @return [SubscribeRulesInstance] Updated SubscribeRulesInstance
+              def update(rules: :unset)
+                data = Twilio::Values.of({'Rules' => Twilio.serialize_object(rules), })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Video.V1.SubscribeRulesList>'
+              end
+            end
+
+            class SubscribeRulesPage < Page
+              ##
+              # Initialize the SubscribeRulesPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [SubscribeRulesPage] SubscribeRulesPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of SubscribeRulesInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [SubscribeRulesInstance] SubscribeRulesInstance
+              def get_instance(payload)
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Video.V1.SubscribeRulesPage>'
+              end
+            end
+
+            class SubscribeRulesInstance < InstanceResource
+              ##
+              # 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 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)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'participant_sid' => payload['participant_sid'],
+                    'room_sid' => payload['room_sid'],
+                    'rules' => payload['rules'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                }
+              end
+
+              ##
+              # @return [String] The SID of the Participant resource for the Subscribe Rules
+              def participant_sid
+                @properties['participant_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Room resource for the Subscribe Rules
+              def room_sid
+                @properties['room_sid']
+              end
+
+              ##
+              # @return [Array[String]] A collection of Subscribe Rules that describe how to include or exclude matching tracks
+              def rules
+                @properties['rules']
+              end
+
+              ##
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Video.V1.SubscribeRulesInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Video.V1.SubscribeRulesInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end