twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class ParticipantContext < InstanceContext
 
                      class SubscribedTrackList < ListResource
+                
                     ##
                     # Initialize the SubscribedTrackList
                     # @param [Version] version Version that contains the resource
                     # @return [SubscribedTrackList] SubscribedTrackList
                     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]}/SubscribedTracks"
@@ -68,7 +70,33 @@ module Twilio
                         page = self.page(
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists SubscribedTrackPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SubscribedTrackPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -80,9 +108,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -92,14 +124,17 @@ 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 SubscribedTrackInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             '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)
 
                         SubscribedTrackPage.new(@version, response, @solution)
                     end
@@ -136,6 +171,7 @@ module Twilio
                     # @return [SubscribedTrackContext] SubscribedTrackContext
                     def initialize(version, room_sid, participant_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { room_sid: room_sid, participant_sid: participant_sid, sid: sid,  }
@@ -148,7 +184,13 @@ module Twilio
                     # @return [SubscribedTrackInstance] Fetched SubscribedTrackInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         SubscribedTrackInstance.new(
                             @version,
                             payload,
@@ -158,6 +200,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SubscribedTrackInstanceMetadata
+                    # @return [SubscribedTrackInstance] Fetched SubscribedTrackInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        subscribed_track_instance = SubscribedTrackInstance.new(
+                            @version,
+                            response.body,
+                            room_sid: @solution[:room_sid],
+                            participant_sid: @solution[:participant_sid],
+                            sid: @solution[:sid],
+                        )
+                        SubscribedTrackInstanceMetadata.new(
+                            @version,
+                            subscribed_track_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -174,6 +243,53 @@ module Twilio
                     end
                 end
 
+                class SubscribedTrackInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SubscribedTrackInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SubscribedTrackInstance] subscribed_track_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 [SubscribedTrackInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, subscribed_track_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @subscribed_track_instance = subscribed_track_instance
+                    end
+
+                    def subscribed_track
+                        @subscribed_track_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SubscribedTrackInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SubscribedTrackListResponse < InstanceListResource
+                    # @param [Array<SubscribedTrackInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @subscribed_track_instance = payload.body[key].map do |data|
+                        SubscribedTrackInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def subscribed_track_instance
+                          @instance
+                      end
+                  end
+
                 class SubscribedTrackPage < Page
                     ##
                     # Initialize the SubscribedTrackPage
@@ -183,6 +299,7 @@ module Twilio
                     # @return [SubscribedTrackPage] SubscribedTrackPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -202,6 +319,66 @@ module Twilio
                         '<Twilio.Video.V1.SubscribedTrackPage>'
                     end
                 end
+
+                class SubscribedTrackPageMetadata < PageMetadata
+                    attr_reader :subscribed_track_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @subscribed_track_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @subscribed_track_page << SubscribedTrackListResponse.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
+                        @subscribed_track_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class SubscribedTrackListResponse < InstanceListResource
+
+                    # @param [Array<SubscribedTrackInstance>] 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
+                      @subscribed_track = data_list.map do |data|
+                        SubscribedTrackInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def subscribed_track
+                        @subscribed_track
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SubscribedTrackInstance < InstanceResource
                     ##
                     # Initialize the SubscribedTrackInstance
@@ -215,6 +392,7 @@ module Twilio
                     def initialize(version, payload , room_sid: nil, participant_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -20,12 +20,14 @@ module Twilio
                 class RoomContext < InstanceContext
 
                      class ParticipantList < ListResource
+                
                     ##
                     # Initialize the ParticipantList
                     # @param [Version] version Version that contains the resource
                     # @return [ParticipantList] ParticipantList
                     def initialize(version, room_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { room_sid: room_sid }
                         @uri = "/Rooms/#{@solution[:room_sid]}/Participants"
@@ -83,7 +85,41 @@ module Twilio
                             date_created_before: date_created_before,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists ParticipantPageMetadata records from the API as a list.
+                      # @param [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
+                    #    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, identity: :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,
+                            'Identity' => identity,
+                            '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)
+
+                        ParticipantPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -95,9 +131,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -111,7 +151,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 ParticipantInstance
-                    def page(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Status' => status,
                             'Identity' => identity,
@@ -121,8 +161,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)
 
                         ParticipantPage.new(@version, response, @solution)
                     end
@@ -158,6 +201,7 @@ module Twilio
                     # @return [ParticipantContext] ParticipantContext
                     def initialize(version, room_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { room_sid: room_sid, sid: sid,  }
@@ -174,7 +218,13 @@ module Twilio
                     # @return [ParticipantInstance] Fetched ParticipantInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         ParticipantInstance.new(
                             @version,
                             payload,
@@ -183,19 +233,51 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ParticipantInstanceMetadata
+                    # @return [ParticipantInstance] Fetched ParticipantInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            room_sid: @solution[:room_sid],
+                            sid: @solution[:sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ParticipantInstance
                     # @param [Status] status 
                     # @return [ParticipantInstance] Updated ParticipantInstance
                     def update(
-                        status: :unset
+                      status: :unset
                     )
 
                         data = Twilio::Values.of({
                             'Status' => status,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         ParticipantInstance.new(
                             @version,
                             payload,
@@ -204,6 +286,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ParticipantInstanceMetadata
+                    # @param [Status] status 
+                    # @return [ParticipantInstance] Updated ParticipantInstance
+                    def update_with_metadata(
+                      status: :unset
+                    )
+
+                        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)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            room_sid: @solution[:room_sid],
+                            sid: @solution[:sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the subscribe_rules
                     # @return [SubscribeRulesList]
@@ -280,6 +395,53 @@ module Twilio
                     end
                 end
 
+                class ParticipantInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ParticipantInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ParticipantInstance] participant_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 [ParticipantInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, participant_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @participant_instance = participant_instance
+                    end
+
+                    def participant
+                        @participant_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ParticipantInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ParticipantListResponse < InstanceListResource
+                    # @param [Array<ParticipantInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @participant_instance = payload.body[key].map do |data|
+                        ParticipantInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def participant_instance
+                          @instance
+                      end
+                  end
+
                 class ParticipantPage < Page
                     ##
                     # Initialize the ParticipantPage
@@ -289,6 +451,7 @@ module Twilio
                     # @return [ParticipantPage] ParticipantPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -308,6 +471,66 @@ module Twilio
                         '<Twilio.Video.V1.ParticipantPage>'
                     end
                 end
+
+                class ParticipantPageMetadata < PageMetadata
+                    attr_reader :participant_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @participant_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @participant_page << ParticipantListResponse.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
+                        @participant_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class ParticipantListResponse < InstanceListResource
+
+                    # @param [Array<ParticipantInstance>] 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
+                      @participant = data_list.map do |data|
+                        ParticipantInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def participant
+                        @participant
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ParticipantInstance < InstanceResource
                     ##
                     # Initialize the ParticipantInstance
@@ -321,6 +544,7 @@ module Twilio
                     def initialize(version, payload , room_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -438,7 +662,7 @@ module Twilio
                     # @param [Status] status 
                     # @return [ParticipantInstance] Updated ParticipantInstance
                     def update(
-                        status: :unset
+                      status: :unset
                     )
 
                         context.update(