twilio-ruby 5.45.1 → 5.49.0

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

@@ -11,8 +11,6 @@ module Twilio
     class Sync < Domain
       class V1 < Version
         class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamList < ListResource
             ##
             # Initialize the SyncStreamList
@@ -35,11 +33,9 @@ module Twilio
             #   identifies the resource. This value must be unique within its Service and it can
             #   be up to 320 characters long. The `unique_name` value can be used as an
             #   alternative to the `sid` in the URL path to address the resource.
-            # @param [String] ttl How long, in seconds, before the Stream expires and is
-            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
-            #   default value is `0`, which means the Stream does not expire. The Stream will be
-            #   deleted automatically after it expires, but there can be a delay between the
-            #   expiration time and the resources's deletion.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
             # @return [SyncStreamInstance] Created SyncStreamInstance
             def create(unique_name: :unset, ttl: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -53,9 +49,6 @@ module Twilio
             # Lists SyncStreamInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
-            #   Streams will show both active and expired items. It is possible to filter only
-            #   the active ones by hiding the expired ones.
             # @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
@@ -63,17 +56,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(hide_expired: :unset, limit: nil, page_size: nil)
-              self.stream(hide_expired: hide_expired, 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 SyncStreamInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
-            #   Streams will show both active and expired items. It is possible to filter only
-            #   the active ones by hiding the expired ones.
             # @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
@@ -81,10 +71,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(hide_expired: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(hide_expired: hide_expired, 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
@@ -106,16 +96,12 @@ module Twilio
             ##
             # Retrieve a single page of SyncStreamInstance records from the API.
             # Request is executed immediately.
-            # @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
-            #   Streams will show both active and expired items. It is possible to filter only
-            #   the active ones by hiding the expired ones.
             # @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 SyncStreamInstance
-            def page(hide_expired: :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({
-                  'HideExpired' => hide_expired,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -146,8 +132,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamPage < Page
             ##
             # Initialize the SyncStreamPage
@@ -177,8 +161,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamContext < InstanceContext
             ##
             # Initialize the SyncStreamContext
@@ -222,11 +204,9 @@ module Twilio
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl How long, in seconds, before the Stream expires and is
-            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
-            #   default value is `0`, which means the Stream does not expire. The Stream will be
-            #   deleted automatically after it expires, but there can be a delay between the
-            #   expiration time and the resources's deletion.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
@@ -272,8 +252,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamInstance < InstanceResource
             ##
             # Initialize the SyncStreamInstance
@@ -393,11 +371,9 @@ module Twilio
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl How long, in seconds, before the Stream expires and is
-            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
-            #   default value is `0`, which means the Stream does not expire. The Stream will be
-            #   deleted automatically after it expires, but there can be a delay between the
-            #   expiration time and the resources's deletion.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               context.update(ttl: ttl, )

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb

@@ -12,8 +12,6 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class SyncStreamContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessageList < ListResource
               ##
               # Initialize the StreamMessageList
@@ -35,7 +33,7 @@ module Twilio
               ##
               # Create the StreamMessageInstance
               # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-              #   object that makes up the Stream Message body. Can be up to 4KB in length.
+              #   object that makes up the Stream Message body. Can be up to 4 KiB in length.
               # @return [StreamMessageInstance] Created StreamMessageInstance
               def create(data: nil)
                 data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
@@ -57,8 +55,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessagePage < Page
               ##
               # Initialize the StreamMessagePage
@@ -93,8 +89,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessageInstance < InstanceResource
               ##
               # Initialize the StreamMessageInstance

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

@@ -24,11 +24,12 @@ module Twilio
         # @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
         def workspaces(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @workspaces ||= WorkspaceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @workspaces ||= WorkspaceList.new self
           else
-            WorkspaceContext.new(self, sid)
+              WorkspaceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb

@@ -31,10 +31,10 @@ module Twilio
             # memory before returning.
             # @param [String] priority The priority value of the Tasks to read. Returns the
             #   list of all Tasks in the Workspace with the specified priority.
-            # @param [String] assignment_status The `assignment_status` of the Tasks you want
-            #   to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or
-            #   `completed`. Returns all Tasks in the Workspace with the specified
-            #   `assignment_status`.
+            # @param [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
+            #   specified `assignment_status`.
             # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
             #   Returns the Tasks controlled by the Workflow identified by this SID.
             # @param [String] workflow_name The friendly name of the Workflow with the Tasks
@@ -86,10 +86,10 @@ module Twilio
             # is reached.
             # @param [String] priority The priority value of the Tasks to read. Returns the
             #   list of all Tasks in the Workspace with the specified priority.
-            # @param [String] assignment_status The `assignment_status` of the Tasks you want
-            #   to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or
-            #   `completed`. Returns all Tasks in the Workspace with the specified
-            #   `assignment_status`.
+            # @param [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
+            #   specified `assignment_status`.
             # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
             #   Returns the Tasks controlled by the Workflow identified by this SID.
             # @param [String] workflow_name The friendly name of the Workflow with the Tasks
@@ -157,10 +157,10 @@ module Twilio
             # Request is executed immediately.
             # @param [String] priority The priority value of the Tasks to read. Returns the
             #   list of all Tasks in the Workspace with the specified priority.
-            # @param [String] assignment_status The `assignment_status` of the Tasks you want
-            #   to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or
-            #   `completed`. Returns all Tasks in the Workspace with the specified
-            #   `assignment_status`.
+            # @param [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
+            #   specified `assignment_status`.
             # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
             #   Returns the Tasks controlled by the Workflow identified by this SID.
             # @param [String] workflow_name The friendly name of the Workflow with the Tasks
@@ -223,10 +223,10 @@ module Twilio
 
             ##
             # Create the TaskInstance
-            # @param [String] timeout The amount of time in seconds the new task is allowed to
-            #   live. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value
-            #   is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire
-            #   with description `Task TTL Exceeded`.
+            # @param [String] timeout The amount of time in seconds the new task can live
+            #   before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds).
+            #   The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled`
+            #   event will fire with description `Task TTL Exceeded`.
             # @param [String] priority The priority to assign the new task and override the
             #   default. When supplied, the new Task will have this priority unless it matches a
             #   Workflow Target with a Priority set. When not supplied, the new Task will have
@@ -539,7 +539,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The amount of time in seconds that the Task is allowed to live
+            # @return [String] The amount of time in seconds that the Task can live before being assigned
             def timeout
               @properties['timeout']
             end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb

@@ -244,8 +244,8 @@ module Twilio
               #   `status_callback_method` to send status information to your application.
               # @param [String] status_callback_method The HTTP method we should use to call
               #   `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
-              # @param [reservation.CallStatus] status_callback_event The call progress events
-              #   that we will send to `status_callback`. Can be: `initiated`, `ringing`,
+              # @param [Array[reservation.CallStatus]] status_callback_event The call progress
+              #   events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, or `completed`.
               # @param [String] timeout Timeout for call when executing a Conference
               #   instruction.
@@ -282,7 +282,7 @@ module Twilio
               # @param [String] conference_status_callback_method The HTTP method we should use
               #   to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
               #   `POST`.
-              # @param [reservation.ConferenceEvent] conference_status_callback_event The
+              # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
               #   conference status events that we will send to `conference_status_callback`. Can
               #   be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
               # @param [String] conference_record Whether to record the conference the
@@ -310,8 +310,8 @@ module Twilio
               #   `br1`, `au1`, or `jp1`.
               # @param [String] sip_auth_username The SIP username used for authentication.
               # @param [String] sip_auth_password The SIP password for authentication.
-              # @param [String] dequeue_status_callback_event The Call progress events sent via
-              #   webhooks as a result of a Dequeue instruction.
+              # @param [Array[String]] dequeue_status_callback_event The Call progress events
+              #   sent via webhooks as a result of a Dequeue instruction.
               # @param [String] post_work_activity_sid The new worker activity SID after
               #   executing a Conference instruction.
               # @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when
@@ -584,8 +584,8 @@ module Twilio
               #   `status_callback_method` to send status information to your application.
               # @param [String] status_callback_method The HTTP method we should use to call
               #   `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
-              # @param [reservation.CallStatus] status_callback_event The call progress events
-              #   that we will send to `status_callback`. Can be: `initiated`, `ringing`,
+              # @param [Array[reservation.CallStatus]] status_callback_event The call progress
+              #   events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, or `completed`.
               # @param [String] timeout Timeout for call when executing a Conference
               #   instruction.
@@ -622,7 +622,7 @@ module Twilio
               # @param [String] conference_status_callback_method The HTTP method we should use
               #   to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
               #   `POST`.
-              # @param [reservation.ConferenceEvent] conference_status_callback_event The
+              # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
               #   conference status events that we will send to `conference_status_callback`. Can
               #   be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
               # @param [String] conference_record Whether to record the conference the
@@ -650,8 +650,8 @@ module Twilio
               #   `br1`, `au1`, or `jp1`.
               # @param [String] sip_auth_username The SIP username used for authentication.
               # @param [String] sip_auth_password The SIP password for authentication.
-              # @param [String] dequeue_status_callback_event The Call progress events sent via
-              #   webhooks as a result of a Dequeue instruction.
+              # @param [Array[String]] dequeue_status_callback_event The Call progress events
+              #   sent via webhooks as a result of a Dequeue instruction.
               # @param [String] post_work_activity_sid The new worker activity SID after
               #   executing a Conference instruction.
               # @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb

@@ -178,7 +178,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The number of current Workers by Activity
+              # @return [Array[Hash]] The number of current Workers by Activity
               def activity_statistics
                 @properties['activity_statistics']
               end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb

@@ -246,8 +246,8 @@ module Twilio
               #   `status_callback_method` to send status information to your application.
               # @param [String] status_callback_method The HTTP method we should use to call
               #   `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
-              # @param [reservation.CallStatus] status_callback_event The call progress events
-              #   that we will send to `status_callback`. Can be: `initiated`, `ringing`,
+              # @param [Array[reservation.CallStatus]] status_callback_event The call progress
+              #   events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, or `completed`.
               # @param [String] timeout The timeout for a call when executing a Conference
               #   instruction.
@@ -286,7 +286,7 @@ module Twilio
               # @param [String] conference_status_callback_method The HTTP method we should use
               #   to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
               #   `POST`.
-              # @param [reservation.ConferenceEvent] conference_status_callback_event The
+              # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
               #   conference status events that we will send to `conference_status_callback`. Can
               #   be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
               # @param [String] conference_record Whether to record the conference the
@@ -314,8 +314,8 @@ module Twilio
               #   `br1`, `au1`, or `jp1`.
               # @param [String] sip_auth_username The SIP username used for authentication.
               # @param [String] sip_auth_password The SIP password for authentication.
-              # @param [String] dequeue_status_callback_event The call progress events sent via
-              #   webhooks as a result of a Dequeue instruction.
+              # @param [Array[String]] dequeue_status_callback_event The call progress events
+              #   sent via webhooks as a result of a Dequeue instruction.
               # @param [String] post_work_activity_sid The new worker activity SID after
               #   executing a Conference instruction.
               # @param [Boolean] end_conference_on_customer_exit Whether to end the conference
@@ -584,8 +584,8 @@ module Twilio
               #   `status_callback_method` to send status information to your application.
               # @param [String] status_callback_method The HTTP method we should use to call
               #   `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
-              # @param [reservation.CallStatus] status_callback_event The call progress events
-              #   that we will send to `status_callback`. Can be: `initiated`, `ringing`,
+              # @param [Array[reservation.CallStatus]] status_callback_event The call progress
+              #   events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, or `completed`.
               # @param [String] timeout The timeout for a call when executing a Conference
               #   instruction.
@@ -624,7 +624,7 @@ module Twilio
               # @param [String] conference_status_callback_method The HTTP method we should use
               #   to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
               #   `POST`.
-              # @param [reservation.ConferenceEvent] conference_status_callback_event The
+              # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
               #   conference status events that we will send to `conference_status_callback`. Can
               #   be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
               # @param [String] conference_record Whether to record the conference the
@@ -652,8 +652,8 @@ module Twilio
               #   `br1`, `au1`, or `jp1`.
               # @param [String] sip_auth_username The SIP username used for authentication.
               # @param [String] sip_auth_password The SIP password for authentication.
-              # @param [String] dequeue_status_callback_event The call progress events sent via
-              #   webhooks as a result of a Dequeue instruction.
+              # @param [Array[String]] dequeue_status_callback_event The call progress events
+              #   sent via webhooks as a result of a Dequeue instruction.
               # @param [String] post_work_activity_sid The new worker activity SID after
               #   executing a Conference instruction.
               # @param [Boolean] end_conference_on_customer_exit Whether to end the conference

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb

@@ -180,7 +180,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The minimum, average, maximum, and total time that Workers spent in each Activity
+              # @return [Array[Hash]] The minimum, average, maximum, and total time that Workers spent in each Activity
               def activity_durations
                 @properties['activity_durations']
               end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb

@@ -149,7 +149,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The number of current Workers by Activity
+              # @return [Array[Hash]] The number of current Workers by Activity
               def activity_statistics
                 @properties['activity_statistics']
               end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb

@@ -150,7 +150,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The number of current Workers by Activity
+            # @return [Array[Hash]] The number of current Workers by Activity
             def activity_statistics
               @properties['activity_statistics']
             end

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Trunking::V1::TrunkList]
         def trunks(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @trunks ||= TrunkList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @trunks ||= TrunkList.new self
           else
-            TrunkContext.new(self, sid)
+              TrunkContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/trunking/v1/trunk.rb

@@ -476,7 +476,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Reserved
+          # @return [Array[String]] Reserved
           def auth_type_set
             @properties['auth_type_set']
           end