twilio-ruby 5.34.0 → 5.38.0

data/lib/twilio-ruby/rest/api/v2010/account/conference.rb

@@ -363,6 +363,8 @@ module Twilio
                   'status' => payload['status'],
                   'uri' => payload['uri'],
                   'subresource_uris' => payload['subresource_uris'],
+                  'reason_conference_ended' => payload['reason_conference_ended'],
+                  'call_sid_ending_conference' => payload['call_sid_ending_conference'],
               }
 
               # Context
@@ -441,6 +443,18 @@ module Twilio
               @properties['subresource_uris']
             end
 
+            ##
+            # @return [conference.ReasonConferenceEnded] The reason why a conference ended.
+            def reason_conference_ended
+              @properties['reason_conference_ended']
+            end
+
+            ##
+            # @return [String] The call SID that caused the conference to end
+            def call_sid_ending_conference
+              @properties['call_sid_ending_conference']
+            end
+
             ##
             # Fetch a ConferenceInstance
             # @return [ConferenceInstance] Fetched ConferenceInstance

data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

@@ -32,10 +32,21 @@ module Twilio
               ##
               # Retrieve a single page of ParticipantInstance records from the API.
               # Request is executed immediately.
-              # @param [String] from The `from` phone number that will dial the new conference
-              #   participant. Can be a phone number or a client id.
-              # @param [String] to The phone number, client id, or sip address to invite to the
-              #   conference. [Custom
+              # @param [String] from The phone number, Client identifier, or username portion of
+              #   SIP address that made this call. Phone numbers are in
+              #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g.,
+              #   +16175551212). Client identifiers are formatted `client:name`. If using a phone
+              #   number, it must be a Twilio number or a Verified [outgoing caller
+              #   id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account.
+              #   If the `to` parameter is a phone number, `from` must also be a phone number. If
+              #   `to` is sip address, this value of `from` should be a username portion to be
+              #   used to populate the P-Asserted-Identity header that is passed to the SIP
+              #   endpoint.
+              # @param [String] to The phone number, SIP address, or Client identifier that
+              #   received this call. Phone numbers are in
+              #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g.,
+              #   +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client
+              #   identifiers are formatted `client:name`. [Custom
               #   parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified.
               # @param [String] status_callback The URL we should call using the
               #   `status_callback_method` to send status information to your application.
@@ -45,6 +56,8 @@ module Twilio
               #   generate a call to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, and `completed`. Separate multiple values with a space. The default
               #   value is `completed`.
+              # @param [String] label A label for this participant. If one is supplied, it may
+              #   subsequently be used to fetch, update or delete the participant.
               # @param [String] timeout The number of seconds that we should allow the phone to
               #   ring before assuming there is no answer. Can be an integer between `5` and
               #   `600`, inclusive. The default value is `60`. We always add a 5-second timeout
@@ -128,17 +141,31 @@ module Twilio
               # @param [String] call_sid_to_coach The SID of the participant who is being
               #   `coached`. The participant being coached is the only participant who can hear
               #   the participant who is `coaching`.
+              # @param [String] jitter_buffer_size Jitter buffer size for the connecting
+              #   participant. Twilio will use this setting to apply Jitter Buffer before
+              #   participant's audio is mixed into the conference. Can be: `off`, `small`,
+              #   `medium`, and `large`. Default to `large`.
               # @param [String] byoc The SID of a BYOC (Bring Your Own Carrier) trunk to route
               #   this call with. Note that `byoc` is only meaningful when `to` is a phone number;
               #   it will otherwise be ignored. (Beta)
+              # @param [String] caller_id The phone number, Client identifier, or username
+              #   portion of SIP address that made this call. Phone numbers are in
+              #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g.,
+              #   +16175551212). Client identifiers are formatted `client:name`. If using a phone
+              #   number, it must be a Twilio number or a Verified [outgoing caller
+              #   id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account.
+              #   If the `to` parameter is a phone number, `callerId` must also be a phone number.
+              #   If `to` is sip address, this value of `callerId` should be a username portion to
+              #   be used to populate the From header that is passed to the SIP endpoint.
               # @return [ParticipantInstance] Newly created ParticipantInstance
-              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, byoc: :unset)
+              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, label: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, jitter_buffer_size: :unset, byoc: :unset, caller_id: :unset)
                 data = Twilio::Values.of({
                     'From' => from,
                     'To' => to,
                     'StatusCallback' => status_callback,
                     'StatusCallbackMethod' => status_callback_method,
                     'StatusCallbackEvent' => Twilio.serialize_list(status_callback_event) { |e| e },
+                    'Label' => label,
                     'Timeout' => timeout,
                     'Record' => record,
                     'Muted' => muted,
@@ -166,7 +193,9 @@ module Twilio
                     'ConferenceRecordingStatusCallbackEvent' => Twilio.serialize_list(conference_recording_status_callback_event) { |e| e },
                     'Coaching' => coaching,
                     'CallSidToCoach' => call_sid_to_coach,
+                    'JitterBufferSize' => jitter_buffer_size,
                     'Byoc' => byoc,
+                    'CallerId' => caller_id,
                 })
 
                 payload = @version.create(
@@ -343,8 +372,9 @@ module Twilio
               # @param [String] conference_sid The SID of the conference with the participant to
               #   fetch.
               # @param [String] call_sid The
-              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource
-              #   to fetch.
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the
+              #   participant to fetch. Non URL safe characters in a label must be percent
+              #   encoded, for example, a space character is represented as %20.
               # @return [ParticipantContext] ParticipantContext
               def initialize(version, account_sid, conference_sid, call_sid)
                 super(version)
@@ -475,8 +505,9 @@ module Twilio
               #   Participant resource.
               # @param [String] conference_sid The SID of the conference the participant is in.
               # @param [String] call_sid The
-              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource
-              #   to fetch.
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the
+              #   participant to fetch. Non URL safe characters in a label must be percent
+              #   encoded, for example, a space character is represented as %20.
               # @return [ParticipantInstance] ParticipantInstance
               def initialize(version, payload, account_sid: nil, conference_sid: nil, call_sid: nil)
                 super(version)
@@ -485,6 +516,7 @@ module Twilio
                 @properties = {
                     'account_sid' => payload['account_sid'],
                     'call_sid' => payload['call_sid'],
+                    'label' => payload['label'],
                     'call_sid_to_coach' => payload['call_sid_to_coach'],
                     'coaching' => payload['coaching'],
                     'conference_sid' => payload['conference_sid'],
@@ -535,6 +567,12 @@ module Twilio
                 @properties['call_sid']
               end
 
+              ##
+              # @return [String] The label of this participant
+              def label
+                @properties['label']
+              end
+
               ##
               # @return [String] The SID of the participant who is being `coached`
               def call_sid_to_coach

data/lib/twilio-ruby/rest/api/v2010/account/message.rb

@@ -413,26 +413,26 @@ module Twilio
 
               # Marshaled Properties
               @properties = {
-                  'account_sid' => payload['account_sid'],
-                  'api_version' => payload['api_version'],
                   'body' => payload['body'],
-                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                  'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
+                  'num_segments' => payload['num_segments'],
                   'direction' => payload['direction'],
-                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
-                  'error_message' => payload['error_message'],
                   'from' => payload['from'],
-                  'messaging_service_sid' => payload['messaging_service_sid'],
-                  'num_media' => payload['num_media'],
-                  'num_segments' => payload['num_segments'],
+                  'to' => payload['to'],
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
                   'price' => payload['price'],
-                  'price_unit' => payload['price_unit'],
-                  'sid' => payload['sid'],
+                  'error_message' => payload['error_message'],
+                  'uri' => payload['uri'],
+                  'account_sid' => payload['account_sid'],
+                  'num_media' => payload['num_media'],
                   'status' => payload['status'],
+                  'messaging_service_sid' => payload['messaging_service_sid'],
+                  'sid' => payload['sid'],
+                  'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                  'price_unit' => payload['price_unit'],
+                  'api_version' => payload['api_version'],
                   'subresource_uris' => payload['subresource_uris'],
-                  'to' => payload['to'],
-                  'uri' => payload['uri'],
               }
 
               # Context
@@ -451,18 +451,6 @@ module Twilio
               @instance_context
             end
 
-            ##
-            # @return [String] The SID of the Account that created the resource
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] The API version used to process the message
-            def api_version
-              @properties['api_version']
-            end
-
             ##
             # @return [String] The message text
             def body
@@ -470,33 +458,39 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
-            def date_created
-              @properties['date_created']
+            # @return [String] The number of messages used to deliver the message body
+            def num_segments
+              @properties['num_segments']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [message.Direction] The direction of the message
+            def direction
+              @properties['direction']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the message was sent
-            def date_sent
-              @properties['date_sent']
+            # @return [String] The phone number that initiated the message
+            def from
+              @properties['from']
             end
 
             ##
-            # @return [message.Direction] The direction of the message
-            def direction
-              @properties['direction']
+            # @return [String] The phone number that received the message
+            def to
+              @properties['to']
             end
 
             ##
-            # @return [String] The error code associated with the message
-            def error_code
-              @properties['error_code']
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The amount billed for the message
+            def price
+              @properties['price']
             end
 
             ##
@@ -506,15 +500,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The phone number that initiated the message
-            def from
-              @properties['from']
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
+            def uri
+              @properties['uri']
             end
 
             ##
-            # @return [String] The SID of the Messaging Service used with the message.
-            def messaging_service_sid
-              @properties['messaging_service_sid']
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
@@ -524,21 +518,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The number of messages used to deliver the message body
-            def num_segments
-              @properties['num_segments']
-            end
-
-            ##
-            # @return [String] The amount billed for the message
-            def price
-              @properties['price']
+            # @return [message.Status] The status of the message
+            def status
+              @properties['status']
             end
 
             ##
-            # @return [String] The currency in which price is measured
-            def price_unit
-              @properties['price_unit']
+            # @return [String] The SID of the Messaging Service used with the message.
+            def messaging_service_sid
+              @properties['messaging_service_sid']
             end
 
             ##
@@ -548,27 +536,39 @@ module Twilio
             end
 
             ##
-            # @return [message.Status] The status of the message
-            def status
-              @properties['status']
+            # @return [Time] The RFC 2822 date and time in GMT when the message was sent
+            def date_sent
+              @properties['date_sent']
             end
 
             ##
-            # @return [String] A list of related resources identified by their relative URIs
-            def subresource_uris
-              @properties['subresource_uris']
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+            def date_created
+              @properties['date_created']
             end
 
             ##
-            # @return [String] The phone number that received the message
-            def to
-              @properties['to']
+            # @return [String] The error code associated with the message
+            def error_code
+              @properties['error_code']
             end
 
             ##
-            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
-            def uri
-              @properties['uri']
+            # @return [String] The currency in which price is measured
+            def price_unit
+              @properties['price_unit']
+            end
+
+            ##
+            # @return [String] The API version used to process the message
+            def api_version
+              @properties['api_version']
+            end
+
+            ##
+            # @return [String] A list of related resources identified by their relative URIs
+            def subresource_uris
+              @properties['subresource_uris']
             end
 
             ##

data/lib/twilio-ruby/rest/api/v2010/account/queue.rb

@@ -280,15 +280,15 @@ module Twilio
 
               # Marshaled Properties
               @properties = {
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                  'current_size' => payload['current_size'].to_i,
+                  'friendly_name' => payload['friendly_name'],
+                  'uri' => payload['uri'],
                   'account_sid' => payload['account_sid'],
                   'average_wait_time' => payload['average_wait_time'].to_i,
-                  'current_size' => payload['current_size'].to_i,
+                  'sid' => payload['sid'],
                   'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                  'friendly_name' => payload['friendly_name'],
                   'max_size' => payload['max_size'].to_i,
-                  'sid' => payload['sid'],
-                  'uri' => payload['uri'],
               }
 
               # Context
@@ -308,15 +308,9 @@ module Twilio
             end
 
             ##
-            # @return [String] The SID of the Account that created this resource
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] Average wait time of members in the queue
-            def average_wait_time
-              @properties['average_wait_time']
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
+            def date_updated
+              @properties['date_updated']
             end
 
             ##
@@ -326,27 +320,27 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that this resource was created
-            def date_created
-              @properties['date_created']
+            # @return [String] A string that you assigned to describe this resource
+            def friendly_name
+              @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
+            def uri
+              @properties['uri']
             end
 
             ##
-            # @return [String] A string that you assigned to describe this resource
-            def friendly_name
-              @properties['friendly_name']
+            # @return [String] The SID of the Account that created this resource
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
-            # @return [String] The max number of calls allowed in the queue
-            def max_size
-              @properties['max_size']
+            # @return [String] Average wait time of members in the queue
+            def average_wait_time
+              @properties['average_wait_time']
             end
 
             ##
@@ -356,9 +350,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
-            def uri
-              @properties['uri']
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The max number of calls allowed in the queue
+            def max_size
+              @properties['max_size']
             end
 
             ##