twilio-ruby 5.39.2 → 5.40.3

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

@@ -31,7 +31,8 @@ module Twilio
             ##
             # Create the PhoneNumberInstance
             # @param [String] phone_number_sid The SID of the [Incoming Phone
-            #   Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) that you want to associate with the trunk.
+            #   Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource)
+            #   that you want to associate with the trunk.
             # @return [PhoneNumberInstance] Created PhoneNumberInstance
             def create(phone_number_sid: nil)
               data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })

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

@@ -0,0 +1,201 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Trunking < Domain
+      class V1 < Version
+        class TrunkContext < InstanceContext
+          class RecordingList < ListResource
+            ##
+            # Initialize the RecordingList
+            # @param [Version] version Version that contains the resource
+            # @param [String] trunk_sid The trunk_sid
+            # @return [RecordingList] RecordingList
+            def initialize(version, trunk_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {trunk_sid: trunk_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Trunking.V1.RecordingList>'
+            end
+          end
+
+          class RecordingPage < Page
+            ##
+            # Initialize the RecordingPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [RecordingPage] RecordingPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of RecordingInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [RecordingInstance] RecordingInstance
+            def get_instance(payload)
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Trunking.V1.RecordingPage>'
+            end
+          end
+
+          class RecordingContext < InstanceContext
+            ##
+            # Initialize the RecordingContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the recording
+            #   settings.
+            # @return [RecordingContext] RecordingContext
+            def initialize(version, trunk_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {trunk_sid: trunk_sid, }
+              @uri = "/Trunks/#{@solution[:trunk_sid]}/Recording"
+            end
+
+            ##
+            # Fetch the RecordingInstance
+            # @return [RecordingInstance] Fetched RecordingInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Update the RecordingInstance
+            # @return [RecordingInstance] Updated RecordingInstance
+            def update
+              payload = @version.update('POST', @uri)
+
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.RecordingContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.RecordingContext #{context}>"
+            end
+          end
+
+          class RecordingInstance < InstanceResource
+            ##
+            # 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
+            # @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'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'trunk_sid' => trunk_sid, }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [RecordingContext] RecordingContext for this RecordingInstance
+            def context
+              unless @instance_context
+                @instance_context = RecordingContext.new(@version, @params['trunk_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [recording.RecordingMode] The recording mode for the trunk.
+            def mode
+              @properties['mode']
+            end
+
+            ##
+            # @return [recording.RecordingTrim] The recording trim setting for the trunk.
+            def trim
+              @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
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the RecordingInstance
+            # @return [RecordingInstance] Updated RecordingInstance
+            def update
+              context.update
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trunking.V1.RecordingInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trunking.V1.RecordingInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -47,10 +47,14 @@ module Twilio
           # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
           #   a custom code instead of a randomly generated one. Not available for all
           #   customers.
-          # @param [Hash] push The optional service level push factors configuration. If
-          #   present it must be a json string with the following format:
+          # @param [Hash] push Configurations for the Push factors (channel) created under
+          #   this Service. If present, it must be a json string with the following format:
           #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
-          #   true}
+          #   true}. If `include_date` is set to `true`, which is the default, that means that
+          #   the push challenge’s response will include the date created value. If
+          #   `include_date` is set to `false`, then the date created value will not be
+          #   included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge)
+          #   resource’s details parameter for more info
           # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset)
             data = Twilio::Values.of({
@@ -249,10 +253,14 @@ module Twilio
           # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
           #   a custom code instead of a randomly generated one. Not available for all
           #   customers.
-          # @param [Hash] push The optional service level push factors configuration. If
-          #   present it must be a json string with the following format:
+          # @param [Hash] push Configurations for the Push factors (channel) created under
+          #   this Service. If present, it must be a json string with the following format:
           #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
-          #   true}
+          #   true}. If `include_date` is set to `true`, which is the default, that means that
+          #   the push challenge’s response will include the date created value. If
+          #   `include_date` is set to `false`, then the date created value will not be
+          #   included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge)
+          #   resource’s details parameter for more info
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset)
             data = Twilio::Values.of({
@@ -581,10 +589,14 @@ module Twilio
           # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
           #   a custom code instead of a randomly generated one. Not available for all
           #   customers.
-          # @param [Hash] push The optional service level push factors configuration. If
-          #   present it must be a json string with the following format:
+          # @param [Hash] push Configurations for the Push factors (channel) created under
+          #   this Service. If present, it must be a json string with the following format:
           #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
-          #   true}
+          #   true}. If `include_date` is set to `true`, which is the default, that means that
+          #   the push challenge’s response will include the date created value. If
+          #   `include_date` is set to `false`, then the date created value will not be
+          #   included. See [Challenge](https://www.twilio.com/docs/verify/api/challenge)
+          #   resource’s details parameter for more info
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push: :unset)
             context.update(

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

@@ -36,9 +36,17 @@ module Twilio
               # @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 [String] details Details provided to give context about the Challenge.
-              #   Shown to the end user.
+              #   Shown to the end user. It must be a stringified JSON with the following
+              #   structure: {"message": "string", "fields": [ { "label": "string", "value":
+              #   "string"}]}. `message` is required. If you send the `fields` property, each
+              #   field has to include `label` and `value` properties. If you had set
+              #   `include_date=true` in the `push` configuration of the
+              #   [service](https://www.twilio.com/docs/verify/api/service), the response will
+              #   also include the challenge's date created value as an additional field called
+              #   `date`
               # @param [String] hidden_details Details provided to give context about the
-              #   Challenge. Not shown to the end user.
+              #   Challenge. Not shown to the end user. It must be a stringified JSON with only
+              #   strings values eg. `{"ip": "172.168.1.234"}`
               # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Created ChallengeInstance
               def create(factor_sid: nil, expiration_date: :unset, details: :unset, hidden_details: :unset, twilio_sandbox_mode: :unset)

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

@@ -34,6 +34,8 @@ module Twilio
             #   be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
             # @param [String] channel The verification method to use. Can be:
             #   [`email`](https://www.twilio.com/docs/verify/email), `sms` or `call`.
+            # @param [String] custom_friendly_name A custom user defined friendly name that
+            #   overwrites the existing one in the verification message
             # @param [String] custom_message The text of a custom message to use for the
             #   verification.
             # @param [String] send_digits The digits to send after a phone call is answered,
@@ -59,12 +61,15 @@ module Twilio
             #   [`email`](https://www.twilio.com/docs/verify/email) channel configuration in
             #   json format. Must include 'from' and 'from_name'.
             # @param [String] app_hash Your [App
-            #   Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
+            #   Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string)
+            #   to be appended at the end of your verification SMS body. Applies only to SMS.
+            #   Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
             # @return [VerificationInstance] Created VerificationInstance
-            def create(to: nil, channel: nil, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset)
+            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'Channel' => channel,
+                  'CustomFriendlyName' => custom_friendly_name,
                   'CustomMessage' => custom_message,
                   'SendDigits' => send_digits,
                   'Locale' => locale,

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

@@ -152,7 +152,9 @@ module Twilio
           #   used as composition sources.
           # @param [Hash] video_layout An object that describes the video layout of the
           #   composition in terms of regions. See [Specifying Video
-          #   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
+          #   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
@@ -185,7 +187,8 @@ module Twilio
           #   Note that the `resolution` imposes an aspect ratio to the resulting composition.
           #   When the original video tracks are constrained by the aspect ratio, they are
           #   scaled to fit. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [composition.Format] format The container format of the composition's
           #   media files. Can be: `mp4` or `webm` and the default is `webm`. If you specify
           #   `mp4` or `webm`, you must also specify one or more `audio_sources` and/or a
@@ -202,7 +205,8 @@ module Twilio
           #   enabled are shorter when the Room is created and no Participant joins for a
           #   while as well as if all the Participants leave the room and join later, because
           #   those gaps will be removed. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @return [CompositionInstance] Created CompositionInstance
           def create(room_sid: nil, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset)
             data = Twilio::Values.of({

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

@@ -165,7 +165,8 @@ module Twilio
           #   account. When `false`, the composition hook will never be triggered.
           # @param [Hash] video_layout An object that describes the video layout of the
           #   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.
+          #   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
@@ -199,7 +200,8 @@ module Twilio
           #   Note that the `resolution` imposes an aspect ratio to the resulting composition.
           #   When the original video tracks are constrained by the aspect ratio, they are
           #   scaled to fit. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [composition_hook.Format] format The container format of the media files
           #   used by the compositions created by the composition hook. Can be: `mp4` or
           #   `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have
@@ -217,7 +219,8 @@ module Twilio
           #   and no Participant joins for a while as well as if all the Participants leave
           #   the room and join later, because those gaps will be removed. See [Specifying
           #   Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @return [CompositionHookInstance] Created CompositionHookInstance
           def create(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset)
             data = Twilio::Values.of({
@@ -318,7 +321,8 @@ module Twilio
           #   account. When `false`, the composition hook never triggers.
           # @param [Hash] video_layout A JSON object that describes the video layout of the
           #   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.
+          #   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
@@ -340,7 +344,8 @@ module Twilio
           #   and no Participant joins for a while as well as if all the Participants leave
           #   the room and join later, because those gaps will be removed. See [Specifying
           #   Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [composition_hook.Format] format The container format of the media files
           #   used by the compositions created by the composition hook. Can be: `mp4` or
           #   `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have
@@ -364,7 +369,8 @@ module Twilio
           #   Note that the `resolution` imposes an aspect ratio to the resulting composition.
           #   When the original video tracks are constrained by the aspect ratio, they are
           #   scaled to fit. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [String] status_callback The URL we should call using the
           #   `status_callback_method` to send status information to your application on every
           #   composition event. If not provided, status callback events will not be
@@ -567,7 +573,8 @@ module Twilio
           #   account. When `false`, the composition hook never triggers.
           # @param [Hash] video_layout A JSON object that describes the video layout of the
           #   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.
+          #   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
@@ -589,7 +596,8 @@ module Twilio
           #   and no Participant joins for a while as well as if all the Participants leave
           #   the room and join later, because those gaps will be removed. See [Specifying
           #   Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [composition_hook.Format] format The container format of the media files
           #   used by the compositions created by the composition hook. Can be: `mp4` or
           #   `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have
@@ -613,7 +621,8 @@ module Twilio
           #   Note that the `resolution` imposes an aspect ratio to the resulting composition.
           #   When the original video tracks are constrained by the aspect ratio, they are
           #   scaled to fit. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts)
+          #   for more info.
           # @param [String] status_callback The URL we should call using the
           #   `status_callback_method` to send status information to your application on every
           #   composition event. If not provided, status callback events will not be

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

@@ -56,7 +56,8 @@ module Twilio
           #   ***This feature is not available in `peer-to-peer` rooms***
           # @param [String] media_region The region for the media server in Group Rooms.
           #   Can be: one of the [available Media
-          #   Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***
+          #   Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers).
+          #   ***This feature is not available in `peer-to-peer` rooms.***
           # @return [RoomInstance] Created RoomInstance
           def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset)
             data = Twilio::Values.of({

data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb

@@ -12,8 +12,6 @@ module Twilio
       class V1 < Version
         class RoomContext < InstanceContext
           class ParticipantContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SubscribeRulesList < ListResource
               ##
               # Initialize the SubscribeRulesList
@@ -71,8 +69,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SubscribeRulesPage < Page
               ##
               # Initialize the SubscribeRulesPage
@@ -107,8 +103,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SubscribeRulesInstance < InstanceResource
               ##
               # Initialize the SubscribeRulesInstance