twilio-ruby 5.63.1 → 5.65.1

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

@@ -152,57 +152,6 @@ module Twilio
             FaxPage.new(@version, response, @solution)
           end
 
-          ##
-          # Create the FaxInstance
-          # @param [String] to The phone number to receive the fax in
-          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the
-          #   recipient's SIP URI.
-          # @param [String] media_url The URL of the PDF that contains the fax. See our
-          #   {security}[https://www.twilio.com/docs/usage/security] page for information on
-          #   how to ensure the request for your media comes from Twilio.
-          # @param [fax.Quality] quality The {Fax Quality
-          #   value}[https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values] that
-          #   describes the fax quality. Can be: `standard`, `fine`, or `superfine` and
-          #   defaults to `fine`.
-          # @param [String] status_callback The URL we should call using the `POST` method
-          #   to send {status
-          #   information}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback]
-          #   to your application when the status of the fax changes.
-          # @param [String] from The number the fax was sent from. Can be the phone number
-          #   in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the SIP
-          #   `from` value. The caller ID displayed to the recipient uses this value. If this
-          #   is a phone number, it must be a Twilio number or a verified outgoing caller id
-          #   from your account. If `to` is a SIP address, this can be any alphanumeric string
-          #   (and also the characters `+`, `_`, `.`, and `-`), which will be used in the
-          #   `from` header of the SIP request.
-          # @param [String] sip_auth_username The username to use with the
-          #   `sip_auth_password` to authenticate faxes sent to a SIP address.
-          # @param [String] sip_auth_password The password to use with `sip_auth_username`
-          #   to authenticate faxes sent to a SIP address.
-          # @param [Boolean] store_media Whether to store a copy of the sent media on our
-          #   servers for later retrieval. Can be: `true` or `false` and the default is
-          #   `true`.
-          # @param [String] ttl How long in minutes from when the fax is initiated that we
-          #   should try to send the fax.
-          # @return [FaxInstance] Created FaxInstance
-          def create(to: nil, media_url: nil, quality: :unset, status_callback: :unset, from: :unset, sip_auth_username: :unset, sip_auth_password: :unset, store_media: :unset, ttl: :unset)
-            data = Twilio::Values.of({
-                'To' => to,
-                'MediaUrl' => media_url,
-                'Quality' => quality,
-                'StatusCallback' => status_callback,
-                'From' => from,
-                'SipAuthUsername' => sip_auth_username,
-                'SipAuthPassword' => sip_auth_password,
-                'StoreMedia' => store_media,
-                'Ttl' => ttl,
-            })
-
-            payload = @version.create('POST', @uri, data: data)
-
-            FaxInstance.new(@version, payload, )
-          end
-
           ##
           # Provide a user friendly representation
           def to_s
@@ -270,21 +219,6 @@ module Twilio
             FaxInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
-          ##
-          # Update the FaxInstance
-          # @param [fax.UpdateStatus] status The new
-          #   {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of
-          #   the resource. Can be only `canceled`. This may fail if transmission has already
-          #   started.
-          # @return [FaxInstance] Updated FaxInstance
-          def update(status: :unset)
-            data = Twilio::Values.of({'Status' => status, })
-
-            payload = @version.update('POST', @uri, data: data)
-
-            FaxInstance.new(@version, payload, sid: @solution[:sid], )
-          end
-
           ##
           # Delete the FaxInstance
           # @return [Boolean] true if delete succeeds, false otherwise
@@ -491,17 +425,6 @@ module Twilio
             context.fetch
           end
 
-          ##
-          # Update the FaxInstance
-          # @param [fax.UpdateStatus] status The new
-          #   {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of
-          #   the resource. Can be only `canceled`. This may fail if transmission has already
-          #   started.
-          # @return [FaxInstance] Updated FaxInstance
-          def update(status: :unset)
-            context.update(status: status, )
-          end
-
           ##
           # Delete the FaxInstance
           # @return [Boolean] true if delete succeeds, false otherwise

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, )