twilio-ruby 5.39.2 → 5.60.0

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

@@ -0,0 +1,329 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class VerificationAttemptList < ListResource
+          ##
+          # Initialize the VerificationAttemptList
+          # @param [Version] version Version that contains the resource
+          # @return [VerificationAttemptList] VerificationAttemptList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Attempts"
+          end
+
+          ##
+          # Lists VerificationAttemptInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Time] date_created_after Datetime filter used to query Verification
+          #   Attempts created after this datetime.
+          # @param [Time] date_created_before Datetime filter used to query Verification
+          #   Attempts created before this datetime.
+          # @param [String] channel_data_to Destination of a verification. Depending on the
+          #   type of channel, it could be a phone number in E.164 format or an email address.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, limit: nil, page_size: nil)
+            self.stream(
+                date_created_after: date_created_after,
+                date_created_before: date_created_before,
+                channel_data_to: channel_data_to,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams VerificationAttemptInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Time] date_created_after Datetime filter used to query Verification
+          #   Attempts created after this datetime.
+          # @param [Time] date_created_before Datetime filter used to query Verification
+          #   Attempts created before this datetime.
+          # @param [String] channel_data_to Destination of a verification. Depending on the
+          #   type of channel, it could be a phone number in E.164 format or an email address.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(
+                date_created_after: date_created_after,
+                date_created_before: date_created_before,
+                channel_data_to: channel_data_to,
+                page_size: limits[:page_size],
+            )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields VerificationAttemptInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of VerificationAttemptInstance records from the API.
+          # Request is executed immediately.
+          # @param [Time] date_created_after Datetime filter used to query Verification
+          #   Attempts created after this datetime.
+          # @param [Time] date_created_before Datetime filter used to query Verification
+          #   Attempts created before this datetime.
+          # @param [String] channel_data_to Destination of a verification. Depending on the
+          #   type of channel, it could be a phone number in E.164 format or an email address.
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of VerificationAttemptInstance
+          def page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
+                'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
+                'ChannelData.To' => channel_data_to,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            VerificationAttemptPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of VerificationAttemptInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of VerificationAttemptInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            VerificationAttemptPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V2.VerificationAttemptList>'
+          end
+        end
+
+        class VerificationAttemptPage < Page
+          ##
+          # Initialize the VerificationAttemptPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [VerificationAttemptPage] VerificationAttemptPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of VerificationAttemptInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [VerificationAttemptInstance] VerificationAttemptInstance
+          def get_instance(payload)
+            VerificationAttemptInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V2.VerificationAttemptPage>'
+          end
+        end
+
+        class VerificationAttemptContext < InstanceContext
+          ##
+          # Initialize the VerificationAttemptContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The unique SID identifier of a Verification Attempt
+          # @return [VerificationAttemptContext] VerificationAttemptContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Attempts/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the VerificationAttemptInstance
+          # @return [VerificationAttemptInstance] Fetched VerificationAttemptInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            VerificationAttemptInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptContext #{context}>"
+          end
+        end
+
+        class VerificationAttemptInstance < InstanceResource
+          ##
+          # Initialize the VerificationAttemptInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The unique SID identifier of a Verification Attempt
+          # @return [VerificationAttemptInstance] VerificationAttemptInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'service_sid' => payload['service_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'conversion_status' => payload['conversion_status'],
+                'channel' => payload['channel'],
+                'channel_data' => payload['channel_data'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [VerificationAttemptContext] VerificationAttemptContext for this VerificationAttemptInstance
+          def context
+            unless @instance_context
+              @instance_context = VerificationAttemptContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Verification Attempt
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Account Sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The service_sid
+          def service_sid
+            @properties['service_sid']
+          end
+
+          ##
+          # @return [Time] The date this Attempt was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Attempt was updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [verification_attempt.ConversionStatus] Status of a conversion
+          def conversion_status
+            @properties['conversion_status']
+          end
+
+          ##
+          # @return [verification_attempt.Channels] Channel used for the attempt
+          def channel
+            @properties['channel']
+          end
+
+          ##
+          # @return [Hash] Object with the channel information for an attempt
+          def channel_data
+            @properties['channel_data']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the VerificationAttemptInstance
+          # @return [VerificationAttemptInstance] Fetched VerificationAttemptInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,6 +17,8 @@ module Twilio
           @version = 'v2'
           @forms = nil
           @services = nil
+          @verification_attempts = nil
+          @templates = nil
         end
 
         ##
@@ -26,11 +28,12 @@ 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
 
@@ -41,14 +44,36 @@ 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)
+          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
-            ServiceContext.new(self, sid)
+              VerificationAttemptContext.new(self, sid)
           end
         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

@@ -46,6 +46,21 @@ module Twilio
         self.v2.services(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   Verification Attempt.
+      # @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::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
@@ -32,7 +30,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -62,7 +60,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -108,7 +106,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -151,22 +149,25 @@ module Twilio
           # @param [String] room_sid The SID of the Group Room with the media tracks to be
           #   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
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the new composition. Can include zero or more track names. The new
-          #   composition includes all audio sources specified in `audio_sources` except for
-          #   those specified in `audio_sources_excluded`. The track names in this parameter
-          #   can include an asterisk as a wild card character, which will match zero or more
-          #   characters in a track name. For example, `student*` includes `student` as well
-          #   as `studentTeam`. Please, be aware that either video_layout or audio_sources
-          #   have to be provided to get a valid creation request
-          # @param [String] audio_sources_excluded An array of track names to exclude. The
-          #   new composition includes all audio sources specified in `audio_sources` except
-          #   for those specified in `audio_sources_excluded`. The track names in this
+          #   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
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the new composition. Can include zero or more track names.
+          #   The new composition includes all audio sources specified in `audio_sources`
+          #   except for those specified in `audio_sources_excluded`. The track names in this
           #   parameter can include an asterisk as a wild card character, which will match
-          #   zero or more characters in a track name. For example, `student*` excludes
-          #   `student` as well as `studentTeam`. This parameter can also be empty.
+          #   zero or more characters in a track name. For example, `student*` includes
+          #   `student` as well as `studentTeam`. Please, be aware that either video_layout or
+          #   audio_sources have to be provided to get a valid creation request
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. The new composition includes all audio sources specified in
+          #   `audio_sources` except for those specified in `audio_sources_excluded`. The
+          #   track names in this parameter can include an asterisk as a wild card character,
+          #   which will match zero or more characters in a track name. For example,
+          #   `student*` excludes `student` as well as `studentTeam`. This parameter can also
+          #   be empty.
           # @param [String] resolution A string that describes the columns (width) and rows
           #   (height) of the generated composed video in pixels. Defaults to `640x480`.
           #   The string's format is `{width}x{height}` where:
@@ -184,8 +185,9 @@ 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.
+          #   scaled to fit. See {Specifying Video
+          #   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
@@ -201,8 +203,9 @@ module Twilio
           #   media in the composition. The default is `true`. Compositions with `trim`
           #   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.
+          #   those gaps will be removed. See {Specifying Video
+          #   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({
@@ -229,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
@@ -260,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
@@ -307,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
@@ -400,13 +397,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The array of track names to include in the composition
+          # @return [Array[String]] The array of track names to include in the composition
           def audio_sources
             @properties['audio_sources']
           end
 
           ##
-          # @return [String] The array of track names to exclude from the composition
+          # @return [Array[String]] The array of track names to exclude from the composition
           def audio_sources_excluded
             @properties['audio_sources_excluded']
           end