twilio-ruby 5.61.2 → 6.9.1

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

@@ -0,0 +1,247 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Verify
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Verify < VerifyBase
+            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 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 ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @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 ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @param [String] country Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
+                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
+                    # @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 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 VerificationAttemptsSummaryInstance < InstanceResource
+                    ##
+                    # Initialize the VerificationAttemptsSummaryInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this VerificationAttemptsSummary
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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'],
+                            '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] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = VerificationAttemptsSummaryContext.new(@version )
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Total of attempts made according to the provided filters
+                    def total_attempts
+                        @properties['total_attempts']
+                    end
+                    
+                    ##
+                    # @return [String] Total of  attempts made that were confirmed by the end user, according to the provided filters.
+                    def total_converted
+                        @properties['total_converted']
+                    end
+                    
+                    ##
+                    # @return [String] Total of attempts made that were not confirmed by the end user, according to the provided filters.
+                    def total_unconverted
+                        @properties['total_unconverted']
+                    end
+                    
+                    ##
+                    # @return [Float] Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. 
+                    def conversion_rate_percentage
+                        @properties['conversion_rate_percentage']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    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 ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @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 ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @param [String] country Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
+                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
+                    # @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

@@ -1,85 +1,106 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Verify
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
 #
-# frozen_string_literal: true
 
 module Twilio
-  module REST
-    class Verify
-      class V2 < Version
-        ##
-        # Initialize the V2 version of Verify
-        def initialize(domain)
-          super
-          @version = 'v2'
-          @forms = nil
-          @services = nil
-          @verification_attempts = nil
-          @templates = nil
-        end
-
-        ##
-        # @param [form.FormTypes] form_type The Type of this Form. Currently only
-        #   `form-push` is supported.
-        # @return [Twilio::REST::Verify::V2::FormContext] if form_type was passed.
-        # @return [Twilio::REST::Verify::V2::FormList]
-        def forms(form_type=:unset)
-          if form_type.nil?
-              raise ArgumentError, 'form_type cannot be nil'
-          end
-          if form_type == :unset
-              @forms ||= FormList.new self
-          else
-              FormContext.new(self, form_type)
-          end
-        end
-
-        ##
-        # @param [String] sid The Twilio-provided string that uniquely identifies the
-        #   Verification Service resource to fetch.
-        # @return [Twilio::REST::Verify::V2::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Verify::V2::ServiceList]
-        def services(sid=:unset)
-          if sid.nil?
-              raise ArgumentError, 'sid cannot be nil'
-          end
-          if sid == :unset
-              @services ||= ServiceList.new self
-          else
-              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::TemplateContext]
-        def templates
-          @templates ||= TemplateList.new self
-        end
+    module REST
+        class Verify
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Verify
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @forms = nil
+                    @safelist = nil
+                    @services = nil
+                    @templates = nil
+                    @verification_attempts = nil
+                    @verification_attempts_summary = nil
+                end
 
-        ##
-        # Provide a user friendly representation
-        def to_s
-          '<Twilio::REST::Verify::V2>'
+                ##
+                # @param [String] form_type The Type of this Form. Currently only `form-push` is supported.
+                # @return [Twilio::REST::Verify::V2::FormContext] if formType was passed.
+                # @return [Twilio::REST::Verify::V2::FormList]
+                def forms(form_type=:unset)
+                    if form_type.nil?
+                        raise ArgumentError, 'form_type cannot be nil'
+                    end
+                    if form_type == :unset
+                        @forms ||= FormList.new self
+                    else
+                        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 phoneNumber 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
+                ##
+                # @param [String] sid The Twilio-provided string that uniquely identifies the Verification Service resource to fetch.
+                # @return [Twilio::REST::Verify::V2::ServiceContext] if sid was passed.
+                # @return [Twilio::REST::Verify::V2::ServiceList]
+                def services(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @services ||= ServiceList.new self
+                    else
+                        ServiceContext.new(self, sid)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::Verify::V2::TemplateList]
+                def templates
+                    @templates ||= TemplateList.new self
+                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
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Verify::V2>';
+                end
+            end
         end
-      end
     end
-  end
-end
+end

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

@@ -1,70 +1,57 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-#
-# frozen_string_literal: true
-
 module Twilio
   module REST
-    class Verify < Domain
-      ##
-      # Initialize the Verify Domain
-      def initialize(twilio)
-        super
-
-        @base_url = 'https://verify.twilio.com'
-        @host = 'verify.twilio.com'
-        @port = 443
-
-        # Versions
-        @v2 = nil
-      end
-
-      ##
-      # Version v2 of verify
-      def v2
-        @v2 ||= V2.new self
-      end
-
+    class Verify < VerifyBase
       ##
       # @param [form.FormTypes] form_type The Type of this Form. Currently only
       #   `form-push` is supported.
       # @return [Twilio::REST::Verify::V2::FormInstance] if form_type was passed.
       # @return [Twilio::REST::Verify::V2::FormList]
       def forms(form_type=:unset)
+        warn "forms is deprecated. Use v2.forms instead."
         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)
+        warn "safelist is deprecated. Use v2.safelist instead."
+        self.v2.safelist(phone_number)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
       # @return [Twilio::REST::Verify::V2::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Verify::V2::ServiceList]
       def services(sid=:unset)
+        warn "services is deprecated. Use v2.services instead."
         self.v2.services(sid)
       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)
+        warn "verification_attempts is deprecated. Use v2.verification_attempts instead."
         self.v2.verification_attempts(sid)
       end
 
       ##
-      # @return [Twilio::REST::Verify::V2::TemplateInstance]
-      def templates
-        self.v2.templates()
+      # @return [Twilio::REST::Verify::V2::VerificationAttemptsSummaryInstance]
+      def verification_attempts_summary
+        warn "verification_attempts_summary is deprecated. Use v2.verification_attempts_summary instead."
+        self.v2.verification_attempts_summary()
       end
 
       ##
-      # Provide a user friendly representation
-      def to_s
-        '#<Twilio::REST::Verify>'
+      # @return [Twilio::REST::Verify::V2::TemplateInstance]
+      def templates
+        warn "templates is deprecated. Use v2.templates instead."
+        self.v2.templates()
       end
     end
   end

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

@@ -0,0 +1,38 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class VerifyBase < Domain
+      ##
+      # Initialize verify domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://verify.twilio.com"
+        @host = "verify.twilio.com"
+        @port = 443
+        @v2 = nil
+      end
+
+      def v2
+        @v2 ||= Verify::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Verify::V2>';
+      end
+    end
+  end
+end