twilio-ruby 5.42.0 → 5.46.0

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/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

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

@@ -15,7 +15,8 @@ module Twilio
             ##
             # Initialize the RecordingList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The unique string that we created to identify the
+            #   Trunk resource.
             # @return [RecordingList] RecordingList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -86,9 +87,16 @@ module Twilio
 
             ##
             # Update the RecordingInstance
+            # @param [recording.RecordingMode] mode The recording mode for the trunk. Can be
+            #   do-not-record (default), record-from-ringing, record-from-answer,
+            #   record-from-ringing-dual, or record-from-answer-dual.
+            # @param [recording.RecordingTrim] trim The recording trim setting for the trunk.
+            #   Can be do-not-trim (default) or trim-silence.
             # @return [RecordingInstance] Updated RecordingInstance
-            def update
-              payload = @version.update('POST', @uri)
+            def update(mode: :unset, trim: :unset)
+              data = Twilio::Values.of({'Mode' => mode, 'Trim' => trim, })
+
+              payload = @version.update('POST', @uri, data: data)
 
               RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
@@ -113,18 +121,14 @@ module Twilio
             # Initialize the RecordingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The unique string that we created to identify the
+            #   Trunk resource.
             # @return [RecordingInstance] RecordingInstance
             def initialize(version, payload, trunk_sid: nil)
               super(version)
 
               # Marshaled Properties
-              @properties = {
-                  'mode' => payload['mode'],
-                  'trim' => payload['trim'],
-                  'url' => payload['url'],
-                  'trunk_sid' => payload['trunk_sid'],
-              }
+              @properties = {'mode' => payload['mode'], 'trim' => payload['trim'], }
 
               # Context
               @instance_context = nil
@@ -154,18 +158,6 @@ module Twilio
               @properties['trim']
             end
 
-            ##
-            # @return [String] The url
-            def url
-              @properties['url']
-            end
-
-            ##
-            # @return [String] The trunk_sid
-            def trunk_sid
-              @properties['trunk_sid']
-            end
-
             ##
             # Fetch the RecordingInstance
             # @return [RecordingInstance] Fetched RecordingInstance
@@ -175,9 +167,14 @@ module Twilio
 
             ##
             # Update the RecordingInstance
+            # @param [recording.RecordingMode] mode The recording mode for the trunk. Can be
+            #   do-not-record (default), record-from-ringing, record-from-answer,
+            #   record-from-ringing-dual, or record-from-answer-dual.
+            # @param [recording.RecordingTrim] trim The recording trim setting for the trunk.
+            #   Can be do-not-trim (default) or trim-silence.
             # @return [RecordingInstance] Updated RecordingInstance
-            def update
-              context.update
+            def update(mode: :unset, trim: :unset)
+              context.update(mode: mode, trim: trim, )
             end
 
             ##

data/lib/twilio-ruby/rest/verify/v2/service.rb

@@ -26,7 +26,7 @@ module Twilio
           ##
           # Create the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.
@@ -241,7 +241,7 @@ module Twilio
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.
@@ -584,7 +584,7 @@ module Twilio
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.

data/lib/twilio-ruby/rest/verify/v2/service/entity.rb

@@ -30,7 +30,9 @@ module Twilio
             ##
             # Create the EntityInstance
             # @param [String] identity The unique external identifier for the Entity of the
-            #   Service
+            #   Service. This identifier should be immutable, not PII, length between 8 and 64
+            #   characters, and generated by your external system, such as your user's UUID,
+            #   GUID, or SID.
             # @return [EntityInstance] Created EntityInstance
             def create(identity: nil)
               data = Twilio::Values.of({'Identity' => identity, })

data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb

@@ -33,13 +33,15 @@ module Twilio
               ##
               # Create the ChallengeInstance
               # @param [String] factor_sid The unique SID identifier of the Factor.
-              # @param [Time] expiration_date The future date in which this Challenge will
-              #   expire, given in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @param [Time] expiration_date The date-time when this Challenge expires, given
+              #   in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. The default value
+              #   is five (5) minutes after Challenge creation. The max value is sixty (60)
+              #   minutes after creation.
               # @param [String] details_message Shown to the user when the push notification
               #   arrives. Required when `factor_type` is `push`
-              # @param [Hash] details_fields A list of objects that describe the Fields included
-              #   in the Challenge. Each object contains the label and value of the field. Used
-              #   when `factor_type` is `push`.
+              # @param [Array[Hash]] details_fields A list of objects that describe the Fields
+              #   included in the Challenge. Each object contains the label and value of the
+              #   field. Used when `factor_type` is `push`.
               # @param [Hash] hidden_details Details provided to give context about the
               #   Challenge. Not shown to the end user. It must be a stringified JSON with only
               #   strings values eg. `{"ip": "172.168.1.234"}`
@@ -379,7 +381,7 @@ module Twilio
               end
 
               ##
-              # @return [Time] The date this Challenge is expired
+              # @return [Time] The date-time when this Challenge expires
               def expiration_date
                 @properties['expiration_date']
               end

data/lib/twilio-ruby/rest/verify/v2/service/verification.rb

@@ -296,7 +296,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] An array of verification attempt objects.
+            # @return [Array[Hash]] An array of verification attempt objects.
             def send_code_attempts
               @properties['send_code_attempts']
             end

data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb

@@ -31,9 +31,9 @@ module Twilio
             # Create the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`
@@ -191,9 +191,9 @@ module Twilio
             # Update the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`
@@ -312,7 +312,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The array of events that this Webhook is subscribed to.
+            # @return [Array[String]] The array of events that this Webhook is subscribed to.
             def event_types
               @properties['event_types']
             end
@@ -357,9 +357,9 @@ module Twilio
             # Update the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`

data/lib/twilio-ruby/rest/video/v1/composition.rb

@@ -155,20 +155,21 @@ module Twilio
           #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
           #   for more info. Please, be aware that either video_layout or audio_sources have
           #   to be provided to get a valid creation request
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the new composition. Can include zero or more track names. The new
-          #   composition includes all audio sources specified in `audio_sources` except for
-          #   those specified in `audio_sources_excluded`. The track names in this parameter
-          #   can include an asterisk as a wild card character, which will match zero or more
-          #   characters in a track name. For example, `student*` includes `student` as well
-          #   as `studentTeam`. Please, be aware that either video_layout or audio_sources
-          #   have to be provided to get a valid creation request
-          # @param [String] audio_sources_excluded An array of track names to exclude. The
-          #   new composition includes all audio sources specified in `audio_sources` except
-          #   for those specified in `audio_sources_excluded`. The track names in this
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the new composition. Can include zero or more track names.
+          #   The new composition includes all audio sources specified in `audio_sources`
+          #   except for those specified in `audio_sources_excluded`. The track names in this
           #   parameter can include an asterisk as a wild card character, which will match
-          #   zero or more characters in a track name. For example, `student*` excludes
-          #   `student` as well as `studentTeam`. This parameter can also be empty.
+          #   zero or more characters in a track name. For example, `student*` includes
+          #   `student` as well as `studentTeam`. Please, be aware that either video_layout or
+          #   audio_sources have to be provided to get a valid creation request
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. The new composition includes all audio sources specified in
+          #   `audio_sources` except for those specified in `audio_sources_excluded`. The
+          #   track names in this parameter can include an asterisk as a wild card character,
+          #   which will match zero or more characters in a track name. For example,
+          #   `student*` excludes `student` as well as `studentTeam`. This parameter can also
+          #   be empty.
           # @param [String] resolution A string that describes the columns (width) and rows
           #   (height) of the generated composed video in pixels. Defaults to `640x480`.
           #   The string's format is `{width}x{height}` where:
@@ -404,13 +405,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The array of track names to include in the composition
+          # @return [Array[String]] The array of track names to include in the composition
           def audio_sources
             @properties['audio_sources']
           end
 
           ##
-          # @return [String] The array of track names to exclude from the composition
+          # @return [Array[String]] The array of track names to exclude from the composition
           def audio_sources_excluded
             @properties['audio_sources_excluded']
           end

data/lib/twilio-ruby/rest/video/v1/composition_hook.rb

@@ -167,17 +167,17 @@ module Twilio
           #   composition hook in terms of regions. See {Specifying Video
           #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
           #   for more info.
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the compositions created by the composition hook. Can include zero
-          #   or more track names. A composition triggered by the composition hook includes
-          #   all audio sources specified in `audio_sources` except those specified in
-          #   `audio_sources_excluded`. The track names in this parameter can include an
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the compositions created by the composition hook. Can include
+          #   zero or more track names. A composition triggered by the composition hook
+          #   includes all audio sources specified in `audio_sources` except those specified
+          #   in `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` includes tracks named `student` as well as
           #   `studentTeam`.
-          # @param [String] audio_sources_excluded An array of track names to exclude. A
-          #   composition triggered by the composition hook includes all audio sources
-          #   specified in `audio_sources` except for those specified in
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. A composition triggered by the composition hook includes all audio
+          #   sources specified in `audio_sources` except for those specified in
           #   `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` excludes `student` as well as `studentTeam`.
@@ -323,17 +323,17 @@ module Twilio
           #   composition hook in terms of regions. See {Specifying Video
           #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
           #   for more info.
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the compositions created by the composition hook. Can include zero
-          #   or more track names. A composition triggered by the composition hook includes
-          #   all audio sources specified in `audio_sources` except those specified in
-          #   `audio_sources_excluded`. The track names in this parameter can include an
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the compositions created by the composition hook. Can include
+          #   zero or more track names. A composition triggered by the composition hook
+          #   includes all audio sources specified in `audio_sources` except those specified
+          #   in `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` includes tracks named `student` as well as
           #   `studentTeam`.
-          # @param [String] audio_sources_excluded An array of track names to exclude. A
-          #   composition triggered by the composition hook includes all audio sources
-          #   specified in `audio_sources` except for those specified in
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. A composition triggered by the composition hook includes all audio
+          #   sources specified in `audio_sources` except for those specified in
           #   `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` excludes `student` as well as `studentTeam`.
@@ -496,13 +496,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The array of track names to include in the compositions created by the composition hook
+          # @return [Array[String]] The array of track names to include in the compositions created by the composition hook
           def audio_sources
             @properties['audio_sources']
           end
 
           ##
-          # @return [String] The array of track names to exclude from the compositions created by the composition hook
+          # @return [Array[String]] The array of track names to exclude from the compositions created by the composition hook
           def audio_sources_excluded
             @properties['audio_sources_excluded']
           end
@@ -575,17 +575,17 @@ module Twilio
           #   composition hook in terms of regions. See {Specifying Video
           #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
           #   for more info.
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the compositions created by the composition hook. Can include zero
-          #   or more track names. A composition triggered by the composition hook includes
-          #   all audio sources specified in `audio_sources` except those specified in
-          #   `audio_sources_excluded`. The track names in this parameter can include an
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the compositions created by the composition hook. Can include
+          #   zero or more track names. A composition triggered by the composition hook
+          #   includes all audio sources specified in `audio_sources` except those specified
+          #   in `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` includes tracks named `student` as well as
           #   `studentTeam`.
-          # @param [String] audio_sources_excluded An array of track names to exclude. A
-          #   composition triggered by the composition hook includes all audio sources
-          #   specified in `audio_sources` except for those specified in
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. A composition triggered by the composition hook includes all audio
+          #   sources specified in `audio_sources` except for those specified in
           #   `audio_sources_excluded`. The track names in this parameter can include an
           #   asterisk as a wild card character, which matches zero or more characters in a
           #   track name. For example, `student*` excludes `student` as well as `studentTeam`.

data/lib/twilio-ruby/rest/video/v1/composition_settings.rb

@@ -89,9 +89,9 @@ module Twilio
           #   encryption.
           # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
           #   should be stored. We only support DNS-compliant URLs like
-          #   `https://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
-          #   `compositions` is the path in which you want the compositions to be stored. This
-          #   URL accepts only URI-valid characters, as described in the <a
+          #   `https://documentation-example-twilio-bucket/compositions`, where `compositions`
+          #   is the path in which you want the compositions to be stored. This URL accepts
+          #   only URI-valid characters, as described in the <a
           #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
           # @param [Boolean] aws_storage_enabled Whether all compositions should be written
           #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
@@ -229,9 +229,9 @@ module Twilio
           #   encryption.
           # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
           #   should be stored. We only support DNS-compliant URLs like
-          #   `https://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
-          #   `compositions` is the path in which you want the compositions to be stored. This
-          #   URL accepts only URI-valid characters, as described in the <a
+          #   `https://documentation-example-twilio-bucket/compositions`, where `compositions`
+          #   is the path in which you want the compositions to be stored. This URL accepts
+          #   only URI-valid characters, as described in the <a
           #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
           # @param [Boolean] aws_storage_enabled Whether all compositions should be written
           #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.

data/lib/twilio-ruby/rest/video/v1/recording.rb

@@ -30,8 +30,8 @@ module Twilio
           # @param [recording.Status] status Read only the recordings that have this status.
           #   Can be: `processing`, `completed`, or `deleted`.
           # @param [String] source_sid Read only the recordings that have this `source_sid`.
-          # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
-          #   which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
           # @param [Time] date_created_after Read only recordings that started on or after
           #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
           #   zone.
@@ -67,8 +67,8 @@ module Twilio
           # @param [recording.Status] status Read only the recordings that have this status.
           #   Can be: `processing`, `completed`, or `deleted`.
           # @param [String] source_sid Read only the recordings that have this `source_sid`.
-          # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
-          #   which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
           # @param [Time] date_created_after Read only recordings that started on or after
           #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
           #   zone.
@@ -120,8 +120,8 @@ module Twilio
           # @param [recording.Status] status Read only the recordings that have this status.
           #   Can be: `processing`, `completed`, or `deleted`.
           # @param [String] source_sid Read only the recordings that have this `source_sid`.
-          # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
-          #   which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
           # @param [Time] date_created_after Read only recordings that started on or after
           #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
           #   zone.