twilio-ruby 5.41.0 → 5.45.1

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

@@ -53,14 +53,19 @@ module Twilio
               #   Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
               #   of the call into one channel. `dual` records each party of a 2-party call into
               #   separate channels.
+              # @param [String] recording_track The audio track to record for the call. Can be:
+              #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+              #   audio that is received by Twilio. `outbound` records the audio that is generated
+              #   from Twilio. `both` records the audio that is received and generated by Twilio.
               # @return [RecordingInstance] Created RecordingInstance
-              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
+              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, recording_track: :unset)
                 data = Twilio::Values.of({
                     'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
                     'RecordingStatusCallback' => recording_status_callback,
                     'RecordingStatusCallbackMethod' => recording_status_callback_method,
                     'Trim' => trim,
                     'RecordingChannels' => recording_channels,
+                    'RecordingTrack' => recording_track,
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -335,6 +340,7 @@ module Twilio
                     'channels' => payload['channels'].to_i,
                     'source' => payload['source'],
                     'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                    'track' => payload['track'],
                 }
 
                 # Context
@@ -460,6 +466,12 @@ module Twilio
                 @properties['error_code']
               end
 
+              ##
+              # @return [String] The recorded track. Can be: `inbound`, `outbound`, or `both`.
+              def track
+                @properties['track']
+              end
+
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The new status of the recording. Can be:

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

@@ -162,8 +162,12 @@ module Twilio
               # @param [String] call_reason The Reason for the outgoing call. Use it to specify
               #   the purpose of the call that is presented on the called party's phone. (Branded
               #   Calls Beta)
+              # @param [String] recording_track The audio track to record for the call. Can be:
+              #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+              #   audio that is received by Twilio. `outbound` records the audio that is sent from
+              #   Twilio. `both` records the audio that is received and sent by Twilio.
               # @return [ParticipantInstance] Created ParticipantInstance
-              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, call_reason: :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, call_reason: :unset, recording_track: :unset)
                 data = Twilio::Values.of({
                     'From' => from,
                     'To' => to,
@@ -202,6 +206,7 @@ module Twilio
                     'Byoc' => byoc,
                     'CallerId' => caller_id,
                     'CallReason' => call_reason,
+                    'RecordingTrack' => recording_track,
                 })
 
                 payload = @version.create('POST', @uri, data: data)

data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb

@@ -31,8 +31,6 @@ module Twilio
             # Lists DayInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] next_token The next_token
-            # @param [String] previous_token The previous_token
             # @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
@@ -40,21 +38,14 @@ module Twilio
             #    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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
-              self.stream(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  limit: limit,
-                  page_size: page_size
-              ).entries
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
             end
 
             ##
             # Streams DayInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] next_token The next_token
-            # @param [String] previous_token The previous_token
             # @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
@@ -62,14 +53,10 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  page_size: limits[:page_size],
-              )
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -91,16 +78,12 @@ module Twilio
             ##
             # Retrieve a single page of DayInstance records from the API.
             # Request is executed immediately.
-            # @param [String] next_token The next_token
-            # @param [String] previous_token The previous_token
             # @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
             # @return [Page] Page of DayInstance
-            def page(next_token: :unset, previous_token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
-                  'NextToken' => next_token,
-                  'PreviousToken' => previous_token,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,

data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

@@ -31,10 +31,6 @@ module Twilio
             # Lists ExportCustomJobInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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
@@ -42,23 +38,14 @@ module Twilio
             #    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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
-              self.stream(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  limit: limit,
-                  page_size: page_size
-              ).entries
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
             end
 
             ##
             # Streams ExportCustomJobInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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
@@ -66,14 +53,10 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  page_size: limits[:page_size],
-              )
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -95,18 +78,12 @@ module Twilio
             ##
             # Retrieve a single page of ExportCustomJobInstance records from the API.
             # Request is executed immediately.
-            # @param [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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
             # @return [Page] Page of ExportCustomJobInstance
-            def page(next_token: :unset, previous_token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
-                  'NextToken' => next_token,
-                  'PreviousToken' => previous_token,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -132,18 +109,26 @@ module Twilio
 
             ##
             # Create the ExportCustomJobInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] start_day The start_day
-            # @param [String] end_day The end_day
-            # @param [String] webhook_url The webhook_url
-            # @param [String] webhook_method The webhook_method
-            # @param [String] email The email
+            # @param [String] start_day The start day for the custom export specified as a
+            #   string in the format of yyyy-mm-dd
+            # @param [String] end_day The end day for the custom export specified as a string
+            #   in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier
+            #   than the current UTC day.
+            # @param [String] friendly_name The friendly name specified when creating the job
+            # @param [String] webhook_url The optional webhook url called on completion of the
+            #   job. If this is supplied, `WebhookMethod` must also be supplied. If you set
+            #   neither webhook nor email, you will have to check your job's status manually.
+            # @param [String] webhook_method This is the method used to call the webhook on
+            #   completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
+            # @param [String] email The optional email to send the completion notification to.
+            #   You can set both webhook, and email, or one or the other. If you set neither,
+            #   the job will run but you will have to query to determine your job's status.
             # @return [ExportCustomJobInstance] Created ExportCustomJobInstance
-            def create(friendly_name: :unset, start_day: :unset, end_day: :unset, webhook_url: :unset, webhook_method: :unset, email: :unset)
+            def create(start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset)
               data = Twilio::Values.of({
-                  'FriendlyName' => friendly_name,
                   'StartDay' => start_day,
                   'EndDay' => end_day,
+                  'FriendlyName' => friendly_name,
                   'WebhookUrl' => webhook_url,
                   'WebhookMethod' => webhook_method,
                   'Email' => email,
@@ -231,13 +216,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The start time for the export specified when creating the job
+            # @return [String] The start day for the custom export specified as a string in the format of yyyy-MM-dd
             def start_day
               @properties['start_day']
             end
 
             ##
-            # @return [String] The end time for the export specified when creating the job
+            # @return [String] The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.
             def end_day
               @properties['end_day']
             end
@@ -261,13 +246,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The job_sid returned when the export was created
+            # @return [String] The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.
             def job_sid
               @properties['job_sid']
             end
 
             ##
-            # @return [Hash] The details
+            # @return [Hash] The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job
             def details
               @properties['details']
             end

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

@@ -13,11 +13,11 @@ module Twilio
     class Client
       @@default_region = 'us1'
 
-      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge, :logger
 
       ##
       # Initializes the Twilio Client
-      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=nil)
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=nil, logger=nil)
         @username = username || Twilio.account_sid
         @password = password || Twilio.auth_token
         @region = region || Twilio.region
@@ -26,6 +26,7 @@ module Twilio
         @auth_token = @password
         @auth = [@username, @password]
         @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+        @logger = logger || Twilio.logger
 
         # Domains
         @accounts = nil
@@ -80,7 +81,24 @@ module Twilio
 
         uri = build_uri(uri)
 
-        @http_client.request(
+        if @logger
+          @logger.debug("--BEGIN Twilio API Request--")
+          @logger.debug("Request Method: <#{method}>")
+
+          headers.each do |key, value|
+            unless key.downcase == 'authorization'
+              @logger.debug("#{key}:#{value}")
+            end
+          end
+
+          url = URI(uri)
+          @logger.debug("Host:#{url.host}")
+          @logger.debug("Path:#{url.path}")
+          @logger.debug("Query:#{url.query}")
+          @logger.debug("Request Params:#{params}")
+        end
+
+        response = @http_client.request(
           host,
           port,
           method,
@@ -91,6 +109,14 @@ module Twilio
           auth,
           timeout
         )
+
+        if @logger
+          @logger.debug("Response Status Code:#{response.status_code}")
+          @logger.debug("Response Headers:#{response.headers}")
+          @logger.debug("--END TWILIO API REQUEST--")
+        end
+
+        response
       end
 
       ##

data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb

@@ -230,10 +230,16 @@ module Twilio
             #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
             #   parameter is non-null if (and only if) the participant is using the
             #   Conversations SDK to communicate. Limited to 256 characters.
+            # @param [String] last_read_message_index Index of last “read” message in the
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+            #   for the Participant.
+            # @param [String] last_read_timestamp Timestamp of last “read” message in the
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+            #   for the Participant.
             # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ParticipantInstance] Updated ParticipantInstance
-            def update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, x_twilio_webhook_enabled: :unset)
+            def update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
@@ -242,6 +248,8 @@ module Twilio
                   'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
                   'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
                   'Identity' => identity,
+                  'LastReadMessageIndex' => last_read_message_index,
+                  'LastReadTimestamp' => last_read_timestamp,
               })
               headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -321,6 +329,8 @@ module Twilio
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'last_read_message_index' => payload['last_read_message_index'] == nil ? payload['last_read_message_index'] : payload['last_read_message_index'].to_i,
+                  'last_read_timestamp' => payload['last_read_timestamp'],
               }
 
               # Context
@@ -399,6 +409,18 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] Index of last “read” message in the Conversation for the Participant.
+            def last_read_message_index
+              @properties['last_read_message_index']
+            end
+
+            ##
+            # @return [String] Timestamp of last “read” message in the Conversation for the Participant.
+            def last_read_timestamp
+              @properties['last_read_timestamp']
+            end
+
             ##
             # Update the ParticipantInstance
             # @param [Time] date_created The date that this resource was created.
@@ -419,10 +441,16 @@ module Twilio
             #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
             #   parameter is non-null if (and only if) the participant is using the
             #   Conversations SDK to communicate. Limited to 256 characters.
+            # @param [String] last_read_message_index Index of last “read” message in the
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+            #   for the Participant.
+            # @param [String] last_read_timestamp Timestamp of last “read” message in the
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+            #   for the Participant.
             # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ParticipantInstance] Updated ParticipantInstance
-            def update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, x_twilio_webhook_enabled: :unset)
+            def update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset)
               context.update(
                   date_created: date_created,
                   date_updated: date_updated,
@@ -431,6 +459,8 @@ module Twilio
                   messaging_binding_proxy_address: messaging_binding_proxy_address,
                   messaging_binding_projected_address: messaging_binding_projected_address,
                   identity: identity,
+                  last_read_message_index: last_read_message_index,
+                  last_read_timestamp: last_read_timestamp,
                   x_twilio_webhook_enabled: x_twilio_webhook_enabled,
               )
             end

data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb

@@ -103,12 +103,16 @@ module Twilio
             #   users when they are added to the service. See the {Conversation
             #   Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info
             #   about roles.
+            # @param [Boolean] reachability_enabled Whether the {Reachability
+            #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] is enabled
+            #   for this Conversations Service. The default is `false`.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
-            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)
+            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset)
               data = Twilio::Values.of({
                   'DefaultConversationCreatorRoleSid' => default_conversation_creator_role_sid,
                   'DefaultConversationRoleSid' => default_conversation_role_sid,
                   'DefaultChatServiceRoleSid' => default_chat_service_role_sid,
+                  'ReachabilityEnabled' => reachability_enabled,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -157,6 +161,7 @@ module Twilio
                   'default_chat_service_role_sid' => payload['default_chat_service_role_sid'],
                   'url' => payload['url'],
                   'links' => payload['links'],
+                  'reachability_enabled' => payload['reachability_enabled'],
               }
 
               # Context
@@ -211,6 +216,12 @@ module Twilio
               @properties['links']
             end
 
+            ##
+            # @return [Boolean] Whether the Reachability Indicator feature is enabled for this Conversations Service
+            def reachability_enabled
+              @properties['reachability_enabled']
+            end
+
             ##
             # Fetch the ConfigurationInstance
             # @return [ConfigurationInstance] Fetched ConfigurationInstance
@@ -233,12 +244,16 @@ module Twilio
             #   users when they are added to the service. See the {Conversation
             #   Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info
             #   about roles.
+            # @param [Boolean] reachability_enabled Whether the {Reachability
+            #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] is enabled
+            #   for this Conversations Service. The default is `false`.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
-            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)
+            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset)
               context.update(
                   default_conversation_creator_role_sid: default_conversation_creator_role_sid,
                   default_conversation_role_sid: default_conversation_role_sid,
                   default_chat_service_role_sid: default_chat_service_role_sid,
+                  reachability_enabled: reachability_enabled,
               )
             end