twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb

@@ -20,12 +20,14 @@ module Twilio
                 class ConferenceContext < InstanceContext
 
                      class ConferenceParticipantList < ListResource
+                
                     ##
                     # Initialize the ConferenceParticipantList
                     # @param [Version] version Version that contains the resource
                     # @return [ConferenceParticipantList] ConferenceParticipantList
                     def initialize(version, conference_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { conference_sid: conference_sid }
                         @uri = "/Conferences/#{@solution[:conference_sid]}/Participants"
@@ -79,7 +81,39 @@ module Twilio
                             events: events,
                             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 ConferenceParticipantPageMetadata records from the API as a list.
+                      # @param [String] participant_sid The unique SID identifier of the Participant.
+                      # @param [String] label User-specified label for a participant.
+                      # @param [String] events Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.
+                    # @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(participant_sid: :unset, label: :unset, events: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'ParticipantSid' => participant_sid,
+                            'Label' => label,
+                            'Events' => events,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConferenceParticipantPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -91,9 +125,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
 
                     ##
@@ -106,7 +144,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 ConferenceParticipantInstance
-                    def page(participant_sid: :unset, label: :unset, events: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(participant_sid: :unset, label: :unset, events: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'ParticipantSid' => participant_sid,
                             'Label' => label,
@@ -115,8 +153,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)
 
                         ConferenceParticipantPage.new(@version, response, @solution)
                     end
@@ -152,6 +193,7 @@ module Twilio
                     # @return [ConferenceParticipantContext] ConferenceParticipantContext
                     def initialize(version, conference_sid, participant_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { conference_sid: conference_sid, participant_sid: participant_sid,  }
@@ -165,15 +207,21 @@ module Twilio
                     # @param [String] metrics Object. Contains participant call quality metrics.
                     # @return [ConferenceParticipantInstance] Fetched ConferenceParticipantInstance
                     def fetch(
-                        events: :unset, 
-                        metrics: :unset
+                      events: :unset, 
+                      metrics: :unset
                     )
 
                         params = Twilio::Values.of({
                             'Events' => events,
                             'Metrics' => metrics,
                         })
-                        payload = @version.fetch('GET', @uri, params: params)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         ConferenceParticipantInstance.new(
                             @version,
                             payload,
@@ -182,6 +230,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ConferenceParticipantInstanceMetadata
+                    # @param [String] events Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.
+                    # @param [String] metrics Object. Contains participant call quality metrics.
+                    # @return [ConferenceParticipantInstance] Fetched ConferenceParticipantInstance
+                    def fetch_with_metadata(
+                      events: :unset, 
+                      metrics: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Events' => events,
+                            'Metrics' => metrics,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        conference_participant_instance = ConferenceParticipantInstance.new(
+                            @version,
+                            response.body,
+                            conference_sid: @solution[:conference_sid],
+                            participant_sid: @solution[:participant_sid],
+                        )
+                        ConferenceParticipantInstanceMetadata.new(
+                            @version,
+                            conference_participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -198,6 +281,53 @@ module Twilio
                     end
                 end
 
+                class ConferenceParticipantInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ConferenceParticipantInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ConferenceParticipantInstance] conference_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 [ConferenceParticipantInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, conference_participant_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @conference_participant_instance = conference_participant_instance
+                    end
+
+                    def conference_participant
+                        @conference_participant_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ConferenceParticipantInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ConferenceParticipantListResponse < InstanceListResource
+                    # @param [Array<ConferenceParticipantInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @conference_participant_instance = payload.body[key].map do |data|
+                        ConferenceParticipantInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def conference_participant_instance
+                          @instance
+                      end
+                  end
+
                 class ConferenceParticipantPage < Page
                     ##
                     # Initialize the ConferenceParticipantPage
@@ -207,6 +337,7 @@ module Twilio
                     # @return [ConferenceParticipantPage] ConferenceParticipantPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -226,6 +357,66 @@ module Twilio
                         '<Twilio.Insights.V1.ConferenceParticipantPage>'
                     end
                 end
+
+                class ConferenceParticipantPageMetadata < PageMetadata
+                    attr_reader :conference_participant_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @conference_participant_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @conference_participant_page << ConferenceParticipantListResponse.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
+                        @conference_participant_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class ConferenceParticipantListResponse < InstanceListResource
+
+                    # @param [Array<ConferenceParticipantInstance>] 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
+                      @conference_participant = data_list.map do |data|
+                        ConferenceParticipantInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def conference_participant
+                        @conference_participant
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ConferenceParticipantInstance < InstanceResource
                     ##
                     # Initialize the ConferenceParticipantInstance
@@ -239,6 +430,7 @@ module Twilio
                     def initialize(version, payload , conference_sid: nil, participant_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'participant_sid' => payload['participant_sid'],
@@ -454,8 +646,8 @@ module Twilio
                     # @param [String] metrics Object. Contains participant call quality metrics.
                     # @return [ConferenceParticipantInstance] Fetched ConferenceParticipantInstance
                     def fetch(
-                        events: :unset, 
-                        metrics: :unset
+                      events: :unset, 
+                      metrics: :unset
                     )
 
                         context.fetch(

data/lib/twilio-ruby/rest/insights/v1/conference.rb

@@ -18,12 +18,14 @@ module Twilio
         class Insights < InsightsBase
             class V1 < Version
                 class ConferenceList < ListResource
+                
                     ##
                     # Initialize the ConferenceList
                     # @param [Version] version Version that contains the resource
                     # @return [ConferenceList] ConferenceList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Conferences"
@@ -105,7 +107,53 @@ module Twilio
                             end_reason: end_reason,
                             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 ConferencePageMetadata records from the API as a list.
+                      # @param [String] conference_sid The SID of the conference.
+                      # @param [String] friendly_name Custom label for the conference resource, up to 64 characters.
+                      # @param [String] status Conference status.
+                      # @param [String] created_after Conferences created after the provided timestamp specified in ISO 8601 format
+                      # @param [String] created_before Conferences created before the provided timestamp specified in ISO 8601 format.
+                      # @param [String] mixer_region Twilio region where the conference media was mixed.
+                      # @param [String] tags Tags applied by Twilio for common potential configuration, quality, or performance issues.
+                      # @param [String] subaccount Account SID for the subaccount whose resources you wish to retrieve.
+                      # @param [String] detected_issues Potential configuration, behavior, or performance issues detected during the conference.
+                      # @param [String] end_reason Conference end reason; e.g. last participant left, modified by API, etc.
+                    # @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(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'ConferenceSid' => conference_sid,
+                            'FriendlyName' => friendly_name,
+                            'Status' => status,
+                            'CreatedAfter' => created_after,
+                            'CreatedBefore' => created_before,
+                            'MixerRegion' => mixer_region,
+                            'Tags' => tags,
+                            'Subaccount' => subaccount,
+                            'DetectedIssues' => detected_issues,
+                            'EndReason' => end_reason,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConferencePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -117,9 +165,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
 
                     ##
@@ -139,7 +191,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 ConferenceInstance
-                    def page(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'ConferenceSid' => conference_sid,
                             'FriendlyName' => friendly_name,
@@ -155,8 +207,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)
 
                         ConferencePage.new(@version, response, @solution)
                     end
@@ -191,6 +246,7 @@ module Twilio
                     # @return [ConferenceContext] ConferenceContext
                     def initialize(version, conference_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { conference_sid: conference_sid,  }
@@ -204,7 +260,13 @@ module Twilio
                     # @return [ConferenceInstance] Fetched ConferenceInstance
                     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)
                         ConferenceInstance.new(
                             @version,
                             payload,
@@ -212,6 +274,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ConferenceInstanceMetadata
+                    # @return [ConferenceInstance] Fetched ConferenceInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        conference_instance = ConferenceInstance.new(
+                            @version,
+                            response.body,
+                            conference_sid: @solution[:conference_sid],
+                        )
+                        ConferenceInstanceMetadata.new(
+                            @version,
+                            conference_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the conference_participants
                     # @return [ConferenceParticipantList]
@@ -247,6 +334,53 @@ module Twilio
                     end
                 end
 
+                class ConferenceInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ConferenceInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ConferenceInstance] conference_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 [ConferenceInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, conference_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @conference_instance = conference_instance
+                    end
+
+                    def conference
+                        @conference_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ConferenceInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ConferenceListResponse < InstanceListResource
+                    # @param [Array<ConferenceInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @conference_instance = payload.body[key].map do |data|
+                        ConferenceInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def conference_instance
+                          @instance
+                      end
+                  end
+
                 class ConferencePage < Page
                     ##
                     # Initialize the ConferencePage
@@ -256,6 +390,7 @@ module Twilio
                     # @return [ConferencePage] ConferencePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -275,6 +410,66 @@ module Twilio
                         '<Twilio.Insights.V1.ConferencePage>'
                     end
                 end
+
+                class ConferencePageMetadata < PageMetadata
+                    attr_reader :conference_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @conference_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @conference_page << ConferenceListResponse.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
+                        @conference_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class ConferenceListResponse < InstanceListResource
+
+                    # @param [Array<ConferenceInstance>] 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
+                      @conference = data_list.map do |data|
+                        ConferenceInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def conference
+                        @conference
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ConferenceInstance < InstanceResource
                     ##
                     # Initialize the ConferenceInstance
@@ -288,6 +483,7 @@ module Twilio
                     def initialize(version, payload , conference_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'conference_sid' => payload['conference_sid'],