twilio-ruby 5.47.0 → 5.74.0

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'] == nil ? payload['total_attempts'] : payload['total_attempts'].to_i,
+                'total_converted' => payload['total_converted'] == nil ? payload['total_converted'] : payload['total_converted'].to_i,
+                'total_unconverted' => payload['total_unconverted'] == nil ? payload['total_unconverted'] : payload['total_unconverted'].to_i,
+                'conversion_rate_percentage' => payload['conversion_rate_percentage'] == nil ? payload['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

@@ -16,7 +16,11 @@ module Twilio
           super
           @version = 'v2'
           @forms = nil
+          @safelist = nil
           @services = nil
+          @verification_attempts = nil
+          @verification_attempts_summary = nil
+          @templates = nil
         end
 
         ##
@@ -26,11 +30,29 @@ module Twilio
         # @return [Twilio::REST::Verify::V2::FormList]
         def forms(form_type=:unset)
           if form_type.nil?
-            raise ArgumentError, 'form_type cannot be nil'
-          elsif form_type == :unset
-            @forms ||= FormList.new self
+              raise ArgumentError, 'form_type cannot be nil'
+          end
+          if form_type == :unset
+              @forms ||= FormList.new self
           else
-            FormContext.new(self, form_type)
+              FormContext.new(self, form_type)
+          end
+        end
+
+        ##
+        # @param [String] phone_number The phone number to be fetched from SafeList. Phone
+        #   numbers must be in {E.164
+        #   format}[https://www.twilio.com/docs/glossary/what-e164].
+        # @return [Twilio::REST::Verify::V2::SafelistContext] if phone_number was passed.
+        # @return [Twilio::REST::Verify::V2::SafelistList]
+        def safelist(phone_number=:unset)
+          if phone_number.nil?
+              raise ArgumentError, 'phone_number cannot be nil'
+          end
+          if phone_number == :unset
+              @safelist ||= SafelistList.new self
+          else
+              SafelistContext.new(self, phone_number)
           end
         end
 
@@ -41,14 +63,42 @@ module Twilio
         # @return [Twilio::REST::Verify::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 
+        ##
+        # @param [String] sid The unique SID identifier of a Verification Attempt
+        # @return [Twilio::REST::Verify::V2::VerificationAttemptContext] if sid was passed.
+        # @return [Twilio::REST::Verify::V2::VerificationAttemptList]
+        def verification_attempts(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @verification_attempts ||= VerificationAttemptList.new self
+          else
+              VerificationAttemptContext.new(self, sid)
+          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

@@ -37,6 +37,14 @@ module Twilio
         self.v2.forms(form_type)
       end
 
+      ##
+      # @param [String] phone_number The phone number in SafeList.
+      # @return [Twilio::REST::Verify::V2::SafelistInstance] if phone_number was passed.
+      # @return [Twilio::REST::Verify::V2::SafelistList]
+      def safelist(phone_number=:unset)
+        self.v2.safelist(phone_number)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
@@ -46,6 +54,27 @@ module Twilio
         self.v2.services(sid)
       end
 
+      ##
+      # @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
@@ -339,9 +331,12 @@ module Twilio
                 'resolution' => payload['resolution'],
                 'trim' => payload['trim'],
                 'format' => payload['format'],
-                'bitrate' => payload['bitrate'].to_i,
-                'size' => payload['size'].to_i,
-                'duration' => payload['duration'].to_i,
+                'bitrate' => payload['bitrate'] == nil ? payload['bitrate'] : payload['bitrate'].to_i,
+                'size' => payload['size'] == nil ? payload['size'] : payload['size'].to_i,
+                'duration' => payload['duration'] == nil ? payload['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

@@ -263,7 +263,7 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'sid' => payload['sid'],
                 'source_sid' => payload['source_sid'],
-                'size' => payload['size'].to_i,
+                'size' => payload['size'] == nil ? payload['size'] : payload['size'].to_i,
                 'url' => payload['url'],
                 'type' => payload['type'],
                 'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
@@ -271,7 +271,10 @@ module Twilio
                 'codec' => payload['codec'],
                 'grouping_sids' => payload['grouping_sids'],
                 'track_name' => payload['track_name'],
-                'offset' => payload['offset'].to_i,
+                'offset' => payload['offset'] == nil ? payload['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

@@ -246,7 +246,7 @@ module Twilio
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'sid' => payload['sid'],
                   'source_sid' => payload['source_sid'],
-                  'size' => payload['size'].to_i,
+                  'size' => payload['size'] == nil ? payload['size'] : payload['size'].to_i,
                   'url' => payload['url'],
                   'type' => payload['type'],
                   'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
@@ -254,7 +254,8 @@ module Twilio
                   'codec' => payload['codec'],
                   'grouping_sids' => payload['grouping_sids'],
                   'track_name' => payload['track_name'],
-                  'offset' => payload['offset'].to_i,
+                  'offset' => payload['offset'] == nil ? payload['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