twilio-ruby 5.52.0 → 5.67.3

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

@@ -0,0 +1,234 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class VerificationAttemptsSummaryList < ListResource
+          ##
+          # Initialize the VerificationAttemptsSummaryList
+          # @param [Version] version Version that contains the resource
+          # @return [VerificationAttemptsSummaryList] VerificationAttemptsSummaryList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V2.VerificationAttemptsSummaryList>'
+          end
+        end
+
+        class VerificationAttemptsSummaryPage < Page
+          ##
+          # Initialize the VerificationAttemptsSummaryPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [VerificationAttemptsSummaryPage] VerificationAttemptsSummaryPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of VerificationAttemptsSummaryInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [VerificationAttemptsSummaryInstance] VerificationAttemptsSummaryInstance
+          def get_instance(payload)
+            VerificationAttemptsSummaryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V2.VerificationAttemptsSummaryPage>'
+          end
+        end
+
+        class VerificationAttemptsSummaryContext < InstanceContext
+          ##
+          # Initialize the VerificationAttemptsSummaryContext
+          # @param [Version] version Version that contains the resource
+          # @return [VerificationAttemptsSummaryContext] VerificationAttemptsSummaryContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Attempts/Summary"
+          end
+
+          ##
+          # Fetch the VerificationAttemptsSummaryInstance
+          # @param [String] verify_service_sid Filter used to consider only Verification
+          #   Attempts of the given verify service on the summary aggregation.
+          # @param [Time] date_created_after Datetime filter used to consider only
+          #   Verification Attempts created after this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [Time] date_created_before Datetime filter used to consider only
+          #   Verification Attempts created before this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [String] country Filter used to consider only Verification Attempts sent
+          #   to the specified destination country on the summary aggregation.
+          # @param [verification_attempts_summary.Channels] channel Filter Verification
+          #   Attempts considered on the summary aggregation by communication channel. Valid
+          #   values are `SMS` and `CALL`
+          # @param [String] destination_prefix Filter the Verification Attempts considered
+          #   on the summary aggregation by Destination prefix. It is the prefix of a phone
+          #   number in E.164 format.
+          # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
+          def fetch(verify_service_sid: :unset, date_created_after: :unset, date_created_before: :unset, country: :unset, channel: :unset, destination_prefix: :unset)
+            params = Twilio::Values.of({
+                'VerifyServiceSid' => verify_service_sid,
+                'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
+                'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
+                'Country' => country,
+                'Channel' => channel,
+                'DestinationPrefix' => destination_prefix,
+            })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            VerificationAttemptsSummaryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptsSummaryContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptsSummaryContext #{context}>"
+          end
+        end
+
+        class VerificationAttemptsSummaryInstance < InstanceResource
+          ##
+          # Initialize the VerificationAttemptsSummaryInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [VerificationAttemptsSummaryInstance] VerificationAttemptsSummaryInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'total_attempts' => payload['total_attempts'].to_i,
+                'total_converted' => payload['total_converted'].to_i,
+                'total_unconverted' => payload['total_unconverted'].to_i,
+                'conversion_rate_percentage' => payload['conversion_rate_percentage'].to_f,
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [VerificationAttemptsSummaryContext] VerificationAttemptsSummaryContext for this VerificationAttemptsSummaryInstance
+          def context
+            unless @instance_context
+              @instance_context = VerificationAttemptsSummaryContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Total of attempts made.
+          def total_attempts
+            @properties['total_attempts']
+          end
+
+          ##
+          # @return [String] Total of attempts confirmed by the end user.
+          def total_converted
+            @properties['total_converted']
+          end
+
+          ##
+          # @return [String] Total of attempts made that were not confirmed by the end user.
+          def total_unconverted
+            @properties['total_unconverted']
+          end
+
+          ##
+          # @return [String] Percentage of the confirmed messages over the total.
+          def conversion_rate_percentage
+            @properties['conversion_rate_percentage']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the VerificationAttemptsSummaryInstance
+          # @param [String] verify_service_sid Filter used to consider only Verification
+          #   Attempts of the given verify service on the summary aggregation.
+          # @param [Time] date_created_after Datetime filter used to consider only
+          #   Verification Attempts created after this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [Time] date_created_before Datetime filter used to consider only
+          #   Verification Attempts created before this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [String] country Filter used to consider only Verification Attempts sent
+          #   to the specified destination country on the summary aggregation.
+          # @param [verification_attempts_summary.Channels] channel Filter Verification
+          #   Attempts considered on the summary aggregation by communication channel. Valid
+          #   values are `SMS` and `CALL`
+          # @param [String] destination_prefix Filter the Verification Attempts considered
+          #   on the summary aggregation by Destination prefix. It is the prefix of a phone
+          #   number in E.164 format.
+          # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
+          def fetch(verify_service_sid: :unset, date_created_after: :unset, date_created_before: :unset, country: :unset, channel: :unset, destination_prefix: :unset)
+            context.fetch(
+                verify_service_sid: verify_service_sid,
+                date_created_after: date_created_after,
+                date_created_before: date_created_before,
+                country: country,
+                channel: channel,
+                destination_prefix: destination_prefix,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptsSummaryInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptsSummaryInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,8 @@ module Twilio
           @forms = nil
           @services = nil
           @verification_attempts = nil
+          @verification_attempts_summary = nil
+          @templates = nil
         end
 
         ##
@@ -67,6 +69,18 @@ module Twilio
           end
         end
 
+        ##
+        # @return [Twilio::REST::Verify::V2::VerificationAttemptsSummaryContext]
+        def verification_attempts_summary
+          @verification_attempts_summary ||= VerificationAttemptsSummaryContext.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Verify::V2::TemplateContext]
+        def templates
+          @templates ||= TemplateList.new self
+        end
+
         ##
         # Provide a user friendly representation
         def to_s

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

@@ -47,14 +47,26 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   Verification Attempt.
+      # @param [String] sid The SID that uniquely identifies the verification attempt
+      #   resource.
       # @return [Twilio::REST::Verify::V2::VerificationAttemptInstance] if sid was passed.
       # @return [Twilio::REST::Verify::V2::VerificationAttemptList]
       def verification_attempts(sid=:unset)
         self.v2.verification_attempts(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Verify::V2::VerificationAttemptsSummaryInstance]
+      def verification_attempts_summary
+        self.v2.verification_attempts_summary()
+      end
+
+      ##
+      # @return [Twilio::REST::Verify::V2::TemplateInstance]
+      def templates
+        self.v2.templates()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Video < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionList < ListResource
           ##
           # Initialize the CompositionList
@@ -234,8 +232,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionPage < Page
           ##
           # Initialize the CompositionPage
@@ -265,8 +261,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionContext < InstanceContext
           ##
           # Initialize the CompositionContext
@@ -312,8 +306,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionInstance < InstanceResource
           ##
           # Initialize the CompositionInstance
@@ -342,6 +334,9 @@ module Twilio
                 'bitrate' => payload['bitrate'].to_i,
                 'size' => payload['size'].to_i,
                 'duration' => payload['duration'].to_i,
+                'media_external_location' => payload['media_external_location'],
+                'status_callback' => payload['status_callback'],
+                'status_callback_method' => payload['status_callback_method'],
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -458,6 +453,24 @@ module Twilio
             @properties['duration']
           end
 
+          ##
+          # @return [String] The URL of the media file associated with the composition when stored externally
+          def media_external_location
+            @properties['media_external_location']
+          end
+
+          ##
+          # @return [String] The URL called to send status information on every composition event.
+          def status_callback
+            @properties['status_callback']
+          end
+
+          ##
+          # @return [String] The HTTP method used to call `status_callback`
+          def status_callback_method
+            @properties['status_callback_method']
+          end
+
           ##
           # @return [String] The absolute URL of the resource
           def url

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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Video < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionHookList < ListResource
           ##
           # Initialize the CompositionHookList
@@ -248,8 +246,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionHookPage < Page
           ##
           # Initialize the CompositionHookPage
@@ -279,8 +275,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionHookContext < InstanceContext
           ##
           # Initialize the CompositionHookContext
@@ -412,8 +406,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CompositionHookInstance < InstanceResource
           ##
           # Initialize the CompositionHookInstance

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

@@ -272,6 +272,9 @@ module Twilio
                 'grouping_sids' => payload['grouping_sids'],
                 'track_name' => payload['track_name'],
                 'offset' => payload['offset'].to_i,
+                'media_external_location' => payload['media_external_location'],
+                'status_callback' => payload['status_callback'],
+                'status_callback_method' => payload['status_callback_method'],
                 'links' => payload['links'],
             }
 
@@ -375,6 +378,24 @@ module Twilio
             @properties['offset']
           end
 
+          ##
+          # @return [String] The URL of the media file associated with the recording when stored externally
+          def media_external_location
+            @properties['media_external_location']
+          end
+
+          ##
+          # @return [String] The URL called to send status information on every recording event.
+          def status_callback
+            @properties['status_callback']
+          end
+
+          ##
+          # @return [String] The HTTP method used to call `status_callback`
+          def status_callback_method
+            @properties['status_callback_method']
+          end
+
           ##
           # @return [String] The URLs of related resources
           def links

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

@@ -255,6 +255,7 @@ module Twilio
                   'grouping_sids' => payload['grouping_sids'],
                   'track_name' => payload['track_name'],
                   'offset' => payload['offset'].to_i,
+                  'media_external_location' => payload['media_external_location'],
                   'room_sid' => payload['room_sid'],
                   'links' => payload['links'],
               }
@@ -359,6 +360,12 @@ module Twilio
               @properties['offset']
             end
 
+            ##
+            # @return [String] The URL of the media file associated with the recording when stored externally
+            def media_external_location
+              @properties['media_external_location']
+            end
+
             ##
             # @return [String] The SID of the Room resource the recording is associated with
             def room_sid

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

@@ -30,10 +30,13 @@ module Twilio
           #   `group-small`, or `group`. The default value is `group`.
           # @param [String] unique_name An application-defined string that uniquely
           #   identifies the resource. It can be used as a `room_sid` in place of the
-          #   resource's `sid` in the URL to address the resource. This value is unique for
-          #   `in-progress` rooms. SDK clients can use this name to connect to the room. REST
-          #   API clients can use this name in place of the Room SID to interact with the room
-          #   as long as the room is `in-progress`.
+          #   resource's `sid` in the URL to address the resource, assuming it does not
+          #   contain any {reserved
+          #   characters}[https://tools.ietf.org/html/rfc3986#section-2.2] that would need to
+          #   be URL encoded. This value is unique for `in-progress` rooms. SDK clients can
+          #   use this name to connect to the room. REST API clients can use this name in
+          #   place of the Room SID to interact with the room as long as the room is
+          #   `in-progress`.
           # @param [String] status_callback The URL we should call using the
           #   `status_callback_method` to send status information to your application on every
           #   room event. See {Status
@@ -57,8 +60,22 @@ module Twilio
           #   ***This feature is not available in `peer-to-peer` rooms.***
           # @param [Hash] recording_rules A collection of Recording Rules that describe how
           #   to include or exclude matching tracks for recording
+          # @param [Boolean] audio_only When set to true, indicates that the participants in
+          #   the room will only publish audio. No video tracks will be allowed. Group rooms
+          #   only.
+          # @param [String] max_participant_duration The maximum number of seconds a
+          #   Participant can be connected to the room. The maximum possible value is 86400
+          #   seconds (24 hours). The default is 14400 seconds (4 hours).
+          # @param [String] empty_room_timeout Configures how long (in minutes) a room will
+          #   remain active after last participant leaves. Valid values range from 1 to 60
+          #   minutes (no fractions).
+          # @param [String] unused_room_timeout Configures how long (in minutes) a room will
+          #   remain active if no one joins. Valid values range from 1 to 60 minutes (no
+          #   fractions).
+          # @param [Boolean] large_room When set to true, indicated that this is the large
+          #   room.
           # @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, recording_rules: :unset)
+          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, recording_rules: :unset, audio_only: :unset, max_participant_duration: :unset, empty_room_timeout: :unset, unused_room_timeout: :unset, large_room: :unset)
             data = Twilio::Values.of({
                 'EnableTurn' => enable_turn,
                 'Type' => type,
@@ -70,6 +87,11 @@ module Twilio
                 'VideoCodecs' => Twilio.serialize_list(video_codecs) { |e| e },
                 'MediaRegion' => media_region,
                 'RecordingRules' => Twilio.serialize_object(recording_rules),
+                'AudioOnly' => audio_only,
+                'MaxParticipantDuration' => max_participant_duration,
+                'EmptyRoomTimeout' => empty_room_timeout,
+                'UnusedRoomTimeout' => unused_room_timeout,
+                'LargeRoom' => large_room,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -360,10 +382,15 @@ module Twilio
                 'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
                 'type' => payload['type'],
                 'max_participants' => payload['max_participants'].to_i,
+                'max_participant_duration' => payload['max_participant_duration'].to_i,
                 'max_concurrent_published_tracks' => payload['max_concurrent_published_tracks'] == nil ? payload['max_concurrent_published_tracks'] : payload['max_concurrent_published_tracks'].to_i,
                 'record_participants_on_connect' => payload['record_participants_on_connect'],
                 'video_codecs' => payload['video_codecs'],
                 'media_region' => payload['media_region'],
+                'audio_only' => payload['audio_only'],
+                'empty_room_timeout' => payload['empty_room_timeout'].to_i,
+                'unused_room_timeout' => payload['unused_room_timeout'].to_i,
+                'large_room' => payload['large_room'],
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -462,6 +489,12 @@ module Twilio
             @properties['max_participants']
           end
 
+          ##
+          # @return [String] The maximum number of seconds a Participant can be connected to the room
+          def max_participant_duration
+            @properties['max_participant_duration']
+          end
+
           ##
           # @return [String] The maximum number of published tracks allowed in the room at the same time
           def max_concurrent_published_tracks
@@ -486,6 +519,30 @@ module Twilio
             @properties['media_region']
           end
 
+          ##
+          # @return [Boolean] Indicates whether the room will only contain audio track participants for group rooms.
+          def audio_only
+            @properties['audio_only']
+          end
+
+          ##
+          # @return [String] The time a room will remain active after last participant leaves.
+          def empty_room_timeout
+            @properties['empty_room_timeout']
+          end
+
+          ##
+          # @return [String] The time a room will remain active when no one joins.
+          def unused_room_timeout
+            @properties['unused_room_timeout']
+          end
+
+          ##
+          # @return [Boolean] Indicates if this is a large room.
+          def large_room
+            @properties['large_room']
+          end
+
           ##
           # @return [String] The absolute URL of the resource
           def url