twilio-ruby 5.63.1 → 5.64.0

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

@@ -15,7 +15,7 @@ module Twilio
             ##
             # Initialize the ConferenceParticipantList
             # @param [Version] version Version that contains the resource
-            # @param [String] conference_sid The conference_sid
+            # @param [String] conference_sid The unique SID identifier of the Conference.
             # @return [ConferenceParticipantList] ConferenceParticipantList
             def initialize(version, conference_sid: nil)
               super(version)
@@ -29,9 +29,10 @@ module Twilio
             # Lists ConferenceParticipantInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] participant_sid The participant_sid
-            # @param [String] label The label
-            # @param [String] events The events
+            # @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
@@ -53,9 +54,10 @@ module Twilio
             # Streams ConferenceParticipantInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] participant_sid The participant_sid
-            # @param [String] label The label
-            # @param [String] events The events
+            # @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
@@ -93,9 +95,10 @@ module Twilio
             ##
             # Retrieve a single page of ConferenceParticipantInstance records from the API.
             # Request is executed immediately.
-            # @param [String] participant_sid The participant_sid
-            # @param [String] label The label
-            # @param [String] events The events
+            # @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 [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -168,8 +171,8 @@ module Twilio
             ##
             # Initialize the ConferenceParticipantContext
             # @param [Version] version Version that contains the resource
-            # @param [String] conference_sid The conference_sid
-            # @param [String] participant_sid The participant_sid
+            # @param [String] conference_sid The unique SID identifier of the Conference.
+            # @param [String] participant_sid The unique SID identifier of the Participant.
             # @return [ConferenceParticipantContext] ConferenceParticipantContext
             def initialize(version, conference_sid, participant_sid)
               super(version)
@@ -181,8 +184,9 @@ module Twilio
 
             ##
             # Fetch the ConferenceParticipantInstance
-            # @param [String] events The events
-            # @param [String] metrics The metrics
+            # @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(events: :unset, metrics: :unset)
               params = Twilio::Values.of({'Events' => events, 'Metrics' => metrics, })
@@ -217,8 +221,8 @@ module Twilio
             # Initialize the ConferenceParticipantInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] conference_sid The conference_sid
-            # @param [String] participant_sid The participant_sid
+            # @param [String] conference_sid The unique SID identifier of the Conference.
+            # @param [String] participant_sid The unique SID identifier of the Participant.
             # @return [ConferenceParticipantInstance] ConferenceParticipantInstance
             def initialize(version, payload, conference_sid: nil, participant_sid: nil)
               super(version)
@@ -233,14 +237,12 @@ module Twilio
                   'call_direction' => payload['call_direction'],
                   'from' => payload['from'],
                   'to' => payload['to'],
-                  'call_state' => payload['call_state'],
+                  'call_status' => payload['call_status'],
                   'country_code' => payload['country_code'],
                   'is_moderator' => payload['is_moderator'],
                   'join_time' => Twilio.deserialize_iso8601_datetime(payload['join_time']),
                   'leave_time' => Twilio.deserialize_iso8601_datetime(payload['leave_time']),
                   'duration_seconds' => payload['duration_seconds'] == nil ? payload['duration_seconds'] : payload['duration_seconds'].to_i,
-                  'whisper' => payload['whisper'],
-                  'agent_audio' => payload['agent_audio'],
                   'outbound_queue_length' => payload['outbound_queue_length'] == nil ? payload['outbound_queue_length'] : payload['outbound_queue_length'].to_i,
                   'outbound_time_in_queue' => payload['outbound_time_in_queue'] == nil ? payload['outbound_time_in_queue'] : payload['outbound_time_in_queue'].to_i,
                   'jitter_buffer_size' => payload['jitter_buffer_size'],
@@ -249,7 +251,7 @@ module Twilio
                   'participant_region' => payload['participant_region'],
                   'conference_region' => payload['conference_region'],
                   'call_type' => payload['call_type'],
-                  'quality_issues' => payload['quality_issues'] == nil ? payload['quality_issues'] : payload['quality_issues'].to_i,
+                  'processing_state' => payload['processing_state'],
                   'properties' => payload['properties'],
                   'events' => payload['events'],
                   'metrics' => payload['metrics'],
@@ -280,183 +282,172 @@ module Twilio
             end
 
             ##
-            # @return [String] The participant_sid
+            # @return [String] SID for this participant.
             def participant_sid
               @properties['participant_sid']
             end
 
             ##
-            # @return [String] The label
+            # @return [String] The user-specified label of this participant.
             def label
               @properties['label']
             end
 
             ##
-            # @return [String] The conference_sid
+            # @return [String] Conference SID.
             def conference_sid
               @properties['conference_sid']
             end
 
             ##
-            # @return [String] The call_sid
+            # @return [String] Unique SID identifier of the call.
             def call_sid
               @properties['call_sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] Account SID.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [conference_participant.CallDirection] The call_direction
+            # @return [conference_participant.CallDirection] Call direction of the participant.
             def call_direction
               @properties['call_direction']
             end
 
             ##
-            # @return [String] The from
+            # @return [String] Caller ID of the calling party.
             def from
               @properties['from']
             end
 
             ##
-            # @return [String] The to
+            # @return [String] Called party.
             def to
               @properties['to']
             end
 
             ##
-            # @return [conference_participant.CallState] The call_state
-            def call_state
-              @properties['call_state']
+            # @return [conference_participant.CallStatus] Call status of the call that generated the participant.
+            def call_status
+              @properties['call_status']
             end
 
             ##
-            # @return [String] The country_code
+            # @return [String] ISO alpha-2 country code of the participant.
             def country_code
               @properties['country_code']
             end
 
             ##
-            # @return [Boolean] The is_moderator
+            # @return [Boolean] Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
             def is_moderator
               @properties['is_moderator']
             end
 
             ##
-            # @return [Time] The join_time
+            # @return [Time] ISO 8601 timestamp of participant join event.
             def join_time
               @properties['join_time']
             end
 
             ##
-            # @return [Time] The leave_time
+            # @return [Time] ISO 8601 timestamp of participant leave event.
             def leave_time
               @properties['leave_time']
             end
 
             ##
-            # @return [String] The duration_seconds
+            # @return [String] Participant durations in seconds.
             def duration_seconds
               @properties['duration_seconds']
             end
 
             ##
-            # @return [String] The whisper
-            def whisper
-              @properties['whisper']
-            end
-
-            ##
-            # @return [Boolean] The agent_audio
-            def agent_audio
-              @properties['agent_audio']
-            end
-
-            ##
-            # @return [String] The outbound_queue_length
+            # @return [String] Estimated time in queue at call creation.
             def outbound_queue_length
               @properties['outbound_queue_length']
             end
 
             ##
-            # @return [String] The outbound_time_in_queue
+            # @return [String] Actual time in queue (seconds).
             def outbound_time_in_queue
               @properties['outbound_time_in_queue']
             end
 
             ##
-            # @return [conference_participant.JitterBufferSize] The jitter_buffer_size
+            # @return [conference_participant.JitterBufferSize] The Jitter Buffer Size of this Conference Participant.
             def jitter_buffer_size
               @properties['jitter_buffer_size']
             end
 
             ##
-            # @return [Boolean] The is_coach
+            # @return [Boolean] Boolean. Indicated whether participant was a coach.
             def is_coach
               @properties['is_coach']
             end
 
             ##
-            # @return [Array[String]] The coached_participants
+            # @return [Array[String]] Call SIDs coached by this participant.
             def coached_participants
               @properties['coached_participants']
             end
 
             ##
-            # @return [conference_participant.Region] The participant_region
+            # @return [conference_participant.Region] Twilio region where the participant media originates.
             def participant_region
               @properties['participant_region']
             end
 
             ##
-            # @return [conference_participant.Region] The conference_region
+            # @return [conference_participant.Region] The Conference Region of this Conference Participant.
             def conference_region
               @properties['conference_region']
             end
 
             ##
-            # @return [conference_participant.CallType] The call_type
+            # @return [conference_participant.CallType] The Call Type of this Conference Participant.
             def call_type
               @properties['call_type']
             end
 
             ##
-            # @return [String] The quality_issues
-            def quality_issues
-              @properties['quality_issues']
+            # @return [conference_participant.ProcessingState] Processing state of the Participant Summary.
+            def processing_state
+              @properties['processing_state']
             end
 
             ##
-            # @return [Hash] The properties
+            # @return [Hash] Participant properties and metadata.
             def properties
               @properties['properties']
             end
 
             ##
-            # @return [Hash] The events
+            # @return [Hash] Object containing information of actions taken by participants. Nested resource URLs.
             def events
               @properties['events']
             end
 
             ##
-            # @return [Hash] The metrics
+            # @return [Hash] Object. Contains participant quality metrics.
             def metrics
               @properties['metrics']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The URL of this resource.
             def url
               @properties['url']
             end
 
             ##
             # Fetch the ConferenceParticipantInstance
-            # @param [String] events The events
-            # @param [String] metrics The metrics
+            # @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(events: :unset, metrics: :unset)
               context.fetch(events: events, metrics: metrics, )

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

@@ -27,16 +27,23 @@ module Twilio
           # Lists ConferenceInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] conference_sid The conference_sid
-          # @param [String] friendly_name The friendly_name
-          # @param [String] status The status
-          # @param [String] created_after The created_after
-          # @param [String] created_before The created_before
-          # @param [String] mixer_region The mixer_region
-          # @param [String] tags The tags
-          # @param [String] subaccount The subaccount
-          # @param [String] detected_issues The detected_issues
-          # @param [String] end_reason The end_reason
+          # @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
@@ -65,16 +72,23 @@ module Twilio
           # Streams ConferenceInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] conference_sid The conference_sid
-          # @param [String] friendly_name The friendly_name
-          # @param [String] status The status
-          # @param [String] created_after The created_after
-          # @param [String] created_before The created_before
-          # @param [String] mixer_region The mixer_region
-          # @param [String] tags The tags
-          # @param [String] subaccount The subaccount
-          # @param [String] detected_issues The detected_issues
-          # @param [String] end_reason The end_reason
+          # @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
@@ -119,16 +133,23 @@ module Twilio
           ##
           # Retrieve a single page of ConferenceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] conference_sid The conference_sid
-          # @param [String] friendly_name The friendly_name
-          # @param [String] status The status
-          # @param [String] created_after The created_after
-          # @param [String] created_before The created_before
-          # @param [String] mixer_region The mixer_region
-          # @param [String] tags The tags
-          # @param [String] subaccount The subaccount
-          # @param [String] detected_issues The detected_issues
-          # @param [String] end_reason The end_reason
+          # @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 [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
           # @param [Integer] page_size Number of records to return, defaults to 50
@@ -208,7 +229,7 @@ module Twilio
           ##
           # Initialize the ConferenceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] conference_sid The conference_sid
+          # @param [String] conference_sid The unique SID identifier of the Conference.
           # @return [ConferenceContext] ConferenceContext
           def initialize(version, conference_sid)
             super(version)
@@ -271,7 +292,7 @@ module Twilio
           # Initialize the ConferenceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] conference_sid The conference_sid
+          # @param [String] conference_sid The unique SID identifier of the Conference.
           # @return [ConferenceInstance] ConferenceInstance
           def initialize(version, payload, conference_sid: nil)
             super(version)
@@ -298,6 +319,7 @@ module Twilio
                 'detected_issues' => payload['detected_issues'],
                 'tags' => payload['tags'],
                 'tag_info' => payload['tag_info'],
+                'processing_state' => payload['processing_state'],
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -319,133 +341,139 @@ module Twilio
           end
 
           ##
-          # @return [String] The conference_sid
+          # @return [String] Conference SID.
           def conference_sid
             @properties['conference_sid']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Account SID.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] Custom label for the conference.
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The create_time
+          # @return [Time] Conference creation date/time.
           def create_time
             @properties['create_time']
           end
 
           ##
-          # @return [Time] The start_time
+          # @return [Time] Timestamp in ISO 8601 format when the conference started.
           def start_time
             @properties['start_time']
           end
 
           ##
-          # @return [Time] The end_time
+          # @return [Time] Conference end date/time.
           def end_time
             @properties['end_time']
           end
 
           ##
-          # @return [String] The duration_seconds
+          # @return [String] Conference duration in seconds.
           def duration_seconds
             @properties['duration_seconds']
           end
 
           ##
-          # @return [String] The connect_duration_seconds
+          # @return [String] Duration of the conference in seconds.
           def connect_duration_seconds
             @properties['connect_duration_seconds']
           end
 
           ##
-          # @return [conference.ConferenceStatus] The status
+          # @return [conference.ConferenceStatus] Status of conference
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The max_participants
+          # @return [String] Max participants specified in config.
           def max_participants
             @properties['max_participants']
           end
 
           ##
-          # @return [String] The max_concurrent_participants
+          # @return [String] Actual maximum concurrent participants.
           def max_concurrent_participants
             @properties['max_concurrent_participants']
           end
 
           ##
-          # @return [String] The unique_participants
+          # @return [String] Unique conference participants.
           def unique_participants
             @properties['unique_participants']
           end
 
           ##
-          # @return [conference.ConferenceEndReason] The end_reason
+          # @return [conference.ConferenceEndReason] Conference end reason.
           def end_reason
             @properties['end_reason']
           end
 
           ##
-          # @return [String] The ended_by
+          # @return [String] Call SID that ended the conference.
           def ended_by
             @properties['ended_by']
           end
 
           ##
-          # @return [conference.Region] The mixer_region
+          # @return [conference.Region] Region where the conference was mixed.
           def mixer_region
             @properties['mixer_region']
           end
 
           ##
-          # @return [conference.Region] The mixer_region_requested
+          # @return [conference.Region] Configuration-requested conference mixer region.
           def mixer_region_requested
             @properties['mixer_region_requested']
           end
 
           ##
-          # @return [Boolean] The recording_enabled
+          # @return [Boolean] Boolean. Indicates whether recording was enabled.
           def recording_enabled
             @properties['recording_enabled']
           end
 
           ##
-          # @return [Hash] The detected_issues
+          # @return [Hash] Potential issues detected during the conference.
           def detected_issues
             @properties['detected_issues']
           end
 
           ##
-          # @return [Array[conference.Tag]] The tags
+          # @return [Array[conference.Tag]] Tags for detected conference conditions and participant behaviors.
           def tags
             @properties['tags']
           end
 
           ##
-          # @return [Hash] The tag_info
+          # @return [Hash] Object. Contains details about conference tags.
           def tag_info
             @properties['tag_info']
           end
 
           ##
-          # @return [String] The url
+          # @return [conference.ProcessingState] Processing state for the Conference Summary resource.
+          def processing_state
+            @properties['processing_state']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end

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

@@ -50,7 +50,7 @@ module Twilio
         end
 
         ##
-        # @param [String] conference_sid The conference_sid
+        # @param [String] conference_sid The unique SID identifier of the Conference.
         # @return [Twilio::REST::Insights::V1::ConferenceContext] if conference_sid was passed.
         # @return [Twilio::REST::Insights::V1::ConferenceList]
         def conferences(conference_sid=:unset)

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

@@ -49,7 +49,7 @@ module Twilio
       end
 
       ##
-      # @param [String] conference_sid The conference_sid
+      # @param [String] conference_sid The unique SID identifier of the Conference.
       # @return [Twilio::REST::Insights::V1::ConferenceInstance] if conference_sid was passed.
       # @return [Twilio::REST::Insights::V1::ConferenceList]
       def conferences(conference_sid=:unset)