twilio-ruby 7.3.3 → 7.10.1

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [RoomList] RoomList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Rooms"
@@ -35,14 +36,16 @@ module Twilio
                     # @param [Boolean] enable_turn Deprecated, now always considered to be true.
                     # @param [RoomType] type 
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.
-                    # @param [String] status_callback The URL we should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
-                    # @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`.
-                    # @param [String] max_participants The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants.
-                    # @param [Boolean] record_participants_on_connect Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***
-                    # @param [Array[VideoCodec]] video_codecs An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.  ***This feature is not available in `peer-to-peer` rooms***
-                    # @param [String] media_region The region for the media server in Group Rooms.  Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***
+                    # @param [String] status_callback The URL Twilio should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
+                    # @param [String] status_callback_method The HTTP method Twilio should use to call `status_callback`. Can be `POST` or `GET`.
+                    # @param [String] max_participants The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50.
+                    # @param [Boolean] record_participants_on_connect Whether to start recording when Participants connect.
+                    # @param [Boolean] transcribe_participants_on_connect Whether to start transcriptions when Participants connect. If TranscriptionsConfiguration is not provided, default settings will be used.
+                    # @param [Array[VideoCodec]] video_codecs An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.
+                    # @param [String] media_region The region for the Room's media server.  Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers).
                     # @param [Object] recording_rules A collection of Recording Rules that describe how to include or exclude matching tracks for recording
-                    # @param [Boolean] audio_only When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only.
+                    # @param [Object] transcriptions_configuration A collection of properties that describe transcription behaviour. If TranscribeParticipantsOnConnect is set to true and TranscriptionsConfiguration is not provided, default settings will be used.
+                    # @param [Boolean] audio_only When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.
                     # @param [String] max_participant_duration The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).
                     # @param [String] empty_room_timeout Configures how long (in minutes) a room will remain active after last participant leaves. Valid values range from 1 to 60 minutes (no fractions).
                     # @param [String] unused_room_timeout Configures how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes (no fractions).
@@ -56,9 +59,11 @@ module Twilio
                         status_callback_method: :unset, 
                         max_participants: :unset, 
                         record_participants_on_connect: :unset, 
+                        transcribe_participants_on_connect: :unset, 
                         video_codecs: :unset, 
                         media_region: :unset, 
                         recording_rules: :unset, 
+                        transcriptions_configuration: :unset, 
                         audio_only: :unset, 
                         max_participant_duration: :unset, 
                         empty_room_timeout: :unset, 
@@ -74,9 +79,11 @@ module Twilio
                             'StatusCallbackMethod' => status_callback_method,
                             'MaxParticipants' => max_participants,
                             'RecordParticipantsOnConnect' => record_participants_on_connect,
+                            'TranscribeParticipantsOnConnect' => transcribe_participants_on_connect,
                             'VideoCodecs' => Twilio.serialize_list(video_codecs) { |e| e },
                             'MediaRegion' => media_region,
                             'RecordingRules' => Twilio.serialize_object(recording_rules),
+                            'TranscriptionsConfiguration' => Twilio.serialize_object(transcriptions_configuration),
                             'AudioOnly' => audio_only,
                             'MaxParticipantDuration' => max_participant_duration,
                             'EmptyRoomTimeout' => empty_room_timeout,
@@ -86,6 +93,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         RoomInstance.new(
                             @version,
@@ -93,6 +104,85 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the RoomInstanceMetadata
+                    # @param [Boolean] enable_turn Deprecated, now always considered to be true.
+                    # @param [RoomType] type 
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.
+                    # @param [String] status_callback The URL Twilio should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
+                    # @param [String] status_callback_method The HTTP method Twilio should use to call `status_callback`. Can be `POST` or `GET`.
+                    # @param [String] max_participants The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50.
+                    # @param [Boolean] record_participants_on_connect Whether to start recording when Participants connect.
+                    # @param [Boolean] transcribe_participants_on_connect Whether to start transcriptions when Participants connect. If TranscriptionsConfiguration is not provided, default settings will be used.
+                    # @param [Array[VideoCodec]] video_codecs An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.
+                    # @param [String] media_region The region for the Room's media server.  Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers).
+                    # @param [Object] recording_rules A collection of Recording Rules that describe how to include or exclude matching tracks for recording
+                    # @param [Object] transcriptions_configuration A collection of properties that describe transcription behaviour. If TranscribeParticipantsOnConnect is set to true and TranscriptionsConfiguration is not provided, default settings will be used.
+                    # @param [Boolean] audio_only When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.
+                    # @param [String] max_participant_duration The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).
+                    # @param [String] empty_room_timeout Configures how long (in minutes) a room will remain active after last participant leaves. Valid values range from 1 to 60 minutes (no fractions).
+                    # @param [String] unused_room_timeout Configures how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes (no fractions).
+                    # @param [Boolean] large_room When set to true, indicated that this is the large room.
+                    # @return [RoomInstance] Created RoomInstance
+                    def create_with_metadata(
+                      enable_turn: :unset, 
+                      type: :unset, 
+                      unique_name: :unset, 
+                      status_callback: :unset, 
+                      status_callback_method: :unset, 
+                      max_participants: :unset, 
+                      record_participants_on_connect: :unset, 
+                      transcribe_participants_on_connect: :unset, 
+                      video_codecs: :unset, 
+                      media_region: :unset, 
+                      recording_rules: :unset, 
+                      transcriptions_configuration: :unset, 
+                      audio_only: :unset, 
+                      max_participant_duration: :unset, 
+                      empty_room_timeout: :unset, 
+                      unused_room_timeout: :unset, 
+                      large_room: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'EnableTurn' => enable_turn,
+                            'Type' => type,
+                            'UniqueName' => unique_name,
+                            'StatusCallback' => status_callback,
+                            'StatusCallbackMethod' => status_callback_method,
+                            'MaxParticipants' => max_participants,
+                            'RecordParticipantsOnConnect' => record_participants_on_connect,
+                            'TranscribeParticipantsOnConnect' => transcribe_participants_on_connect,
+                            'VideoCodecs' => Twilio.serialize_list(video_codecs) { |e| e },
+                            'MediaRegion' => media_region,
+                            'RecordingRules' => Twilio.serialize_object(recording_rules),
+                            'TranscriptionsConfiguration' => Twilio.serialize_object(transcriptions_configuration),
+                            'AudioOnly' => audio_only,
+                            'MaxParticipantDuration' => max_participant_duration,
+                            'EmptyRoomTimeout' => empty_room_timeout,
+                            'UnusedRoomTimeout' => unused_room_timeout,
+                            'LargeRoom' => large_room,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        room_instance = RoomInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        RoomInstanceMetadata.new(
+                            @version,
+                            room_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists RoomInstance records from the API as a list.
@@ -148,6 +238,36 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists RoomPageMetadata records from the API as a list.
+                      # @param [RoomStatus] status Read only the rooms with this status. Can be: `in-progress` (default) or `completed`
+                      # @param [String] unique_name Read only rooms with the this `unique_name`.
+                      # @param [Time] date_created_after Read only rooms that started on or after this date, given as `YYYY-MM-DD`.
+                      # @param [Time] date_created_before Read only rooms that started before this date, given as `YYYY-MM-DD`.
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Status' => status,
+                            'UniqueName' => unique_name,
+                            'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
+                            'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RoomPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields RoomInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -173,7 +293,7 @@ module Twilio
                     # @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
                     # @return [Page] Page of RoomInstance
-                    def page(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Status' => status,
                             'UniqueName' => unique_name,
@@ -183,8 +303,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         RoomPage.new(@version, response, @solution)
                     end
@@ -219,6 +342,7 @@ module Twilio
                     # @return [RoomContext] RoomContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -227,6 +351,7 @@ module Twilio
                         # Dependents
                         @recording_rules = nil
                         @participants = nil
+                        @transcriptions = nil
                         @recordings = nil
                     end
                     ##
@@ -236,6 +361,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         RoomInstance.new(
                             @version,
@@ -244,6 +373,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RoomInstanceMetadata
+                    # @return [RoomInstance] Fetched RoomInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        room_instance = RoomInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RoomInstanceMetadata.new(
+                            @version,
+                            room_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the RoomInstance
                     # @param [RoomStatus] status 
@@ -258,6 +412,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         RoomInstance.new(
                             @version,
@@ -266,6 +424,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the RoomInstanceMetadata
+                    # @param [RoomStatus] status 
+                    # @return [RoomInstance] Updated RoomInstance
+                    def update_with_metadata(
+                      status: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        room_instance = RoomInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RoomInstanceMetadata.new(
+                            @version,
+                            room_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the recording_rules
                     # @return [RecordingRulesList]
@@ -297,6 +487,25 @@ module Twilio
                      @participants
                     end
                     ##
+                    # Access the transcriptions
+                    # @return [TranscriptionsList]
+                    # @return [TranscriptionsContext] if sid was passed.
+                    def transcriptions(ttid=:unset)
+
+                        raise ArgumentError, 'ttid cannot be nil' if ttid.nil?
+
+                        if ttid != :unset
+                            return TranscriptionsContext.new(@version, @solution[:sid],ttid )
+                        end
+
+                        unless @transcriptions
+                            @transcriptions = TranscriptionsList.new(
+                                @version, room_sid: @solution[:sid], )
+                        end
+
+                     @transcriptions
+                    end
+                    ##
                     # Access the recordings
                     # @return [RoomRecordingList]
                     # @return [RoomRecordingContext] if sid was passed.
@@ -331,6 +540,53 @@ module Twilio
                     end
                 end
 
+                class RoomInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RoomInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RoomInstance] room_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [RoomInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, room_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @room_instance = room_instance
+                    end
+
+                    def room
+                        @room_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RoomInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RoomListResponse < InstanceListResource
+                    # @param [Array<RoomInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @room_instance = payload.body[key].map do |data|
+                        RoomInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def room_instance
+                          @instance
+                      end
+                  end
+
                 class RoomPage < Page
                     ##
                     # Initialize the RoomPage
@@ -340,6 +596,7 @@ module Twilio
                     # @return [RoomPage] RoomPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -359,6 +616,66 @@ module Twilio
                         '<Twilio.Video.V1.RoomPage>'
                     end
                 end
+
+                class RoomPageMetadata < PageMetadata
+                    attr_reader :room_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @room_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @room_page << RoomListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @room_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class RoomListResponse < InstanceListResource
+
+                    # @param [Array<RoomInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @room = data_list.map do |data|
+                        RoomInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def room
+                        @room
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RoomInstance < InstanceResource
                     ##
                     # Initialize the RoomInstance
@@ -372,6 +689,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -417,7 +735,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The unique string that we created to identify the Room resource.
+                    # @return [String] The unique string that Twilio created to identify the Room resource.
                     def sid
                         @properties['sid']
                     end
@@ -459,13 +777,13 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The URL we call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
+                    # @return [String] The URL Twilio calls using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
                     def status_callback
                         @properties['status_callback']
                     end
                     
                     ##
-                    # @return [String] The HTTP method we use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`.
+                    # @return [String] The HTTP method Twilio uses to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`.
                     def status_callback_method
                         @properties['status_callback_method']
                     end
@@ -507,25 +825,25 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Boolean] Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***
+                    # @return [Boolean] Whether to start recording when Participants connect.
                     def record_participants_on_connect
                         @properties['record_participants_on_connect']
                     end
                     
                     ##
-                    # @return [Array<VideoCodec>] An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.  ***This feature is not available in `peer-to-peer` rooms***
+                    # @return [Array<VideoCodec>] An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.
                     def video_codecs
                         @properties['video_codecs']
                     end
                     
                     ##
-                    # @return [String] The region for the media server in Group Rooms.  Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers). ***This feature is not available in `peer-to-peer` rooms.***
+                    # @return [String] The region for the Room's media server.  Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers).
                     def media_region
                         @properties['media_region']
                     end
                     
                     ##
-                    # @return [Boolean] When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only.
+                    # @return [Boolean] When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.
                     def audio_only
                         @properties['audio_only']
                     end
@@ -595,6 +913,13 @@ module Twilio
                         context.participants
                     end
 
+                    ##
+                    # Access the transcriptions
+                    # @return [transcriptions] transcriptions
+                    def transcriptions
+                        context.transcriptions
+                    end
+
                     ##
                     # Access the recordings
                     # @return [recordings] recordings