twilio-ruby 5.61.2 → 5.64.0

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

@@ -17,8 +17,7 @@ module Twilio
             ##
             # Initialize the AccessTokenList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique string that we created to identify the
-            #   Service resource.
+            # @param [String] service_sid The unique SID identifier of the Verify Service.
             # @return [AccessTokenList] AccessTokenList
             def initialize(version, service_sid: nil)
               super(version)
@@ -88,6 +87,53 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AccessTokenContext < InstanceContext
+            ##
+            # Initialize the AccessTokenContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid A 34 character string that uniquely identifies this Access
+            #   Token.
+            # @return [AccessTokenContext] AccessTokenContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:service_sid]}/AccessTokens/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the AccessTokenInstance
+            # @return [AccessTokenInstance] Fetched AccessTokenInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AccessTokenInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.AccessTokenContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.AccessTokenContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AccessTokenInstance < InstanceResource
@@ -95,14 +141,75 @@ module Twilio
             # Initialize the AccessTokenInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique string that we created to identify the
-            #   Service resource.
+            # @param [String] service_sid The unique SID identifier of the Verify Service.
+            # @param [String] sid A 34 character string that uniquely identifies this Access
+            #   Token.
             # @return [AccessTokenInstance] AccessTokenInstance
-            def initialize(version, payload, service_sid: nil)
+            def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
-              @properties = {'token' => payload['token'], }
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'entity_identity' => payload['entity_identity'],
+                  'factor_type' => payload['factor_type'],
+                  'factor_friendly_name' => payload['factor_friendly_name'],
+                  'token' => payload['token'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'service_sid' => service_sid, '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 [AccessTokenContext] AccessTokenContext for this AccessTokenInstance
+            def context
+              unless @instance_context
+                @instance_context = AccessTokenContext.new(@version, @params['service_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Access Token.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Verify Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] Unique external identifier of the Entity
+            def entity_identity
+              @properties['entity_identity']
+            end
+
+            ##
+            # @return [access_token.FactorTypes] The Type of the Factor
+            def factor_type
+              @properties['factor_type']
+            end
+
+            ##
+            # @return [String] A human readable description of this factor.
+            def factor_friendly_name
+              @properties['factor_friendly_name']
             end
 
             ##
@@ -111,16 +218,31 @@ module Twilio
               @properties['token']
             end
 
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the AccessTokenInstance
+            # @return [AccessTokenInstance] Fetched AccessTokenInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Verify.V2.AccessTokenInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Verify.V2.AccessTokenInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
             end
           end
         end

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

@@ -442,8 +442,14 @@ module Twilio
           ##
           # Access the access_tokens
           # @return [AccessTokenList]
-          # @return [AccessTokenContext]
-          def access_tokens
+          # @return [AccessTokenContext] if sid was passed.
+          def access_tokens(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return AccessTokenContext.new(@version, @solution[:sid], sid, )
+            end
+
             unless @access_tokens
               @access_tokens = AccessTokenList.new(@version, service_sid: @solution[:sid], )
             end

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

@@ -183,7 +183,7 @@ module Twilio
           end
 
           ##
-          # @return [Hash] Ojbect with the template translations.
+          # @return [Hash] Object with the template translations.
           def translations
             @properties['translations']
           end

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

@@ -28,11 +28,24 @@ module Twilio
           # 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.
+          #   Attempts created after this datetime. Given as GMT in RFC 2822 format.
           # @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.
+          #   Attempts created before this datetime. Given as GMT in RFC 2822 format.
+          # @param [String] channel_data_to Destination of a verification. It is phone
+          #   number in E.164 format.
+          # @param [String] country Filter used to query Verification Attempts sent to the
+          #   specified destination country.
+          # @param [verification_attempt.Channels] channel Filter used to query Verification
+          #   Attempts by communication channel. Valid values are `SMS` and `CALL`
+          # @param [String] verify_service_sid Filter used to query Verification Attempts by
+          #   verify service. Only attempts of the provided SID will be returned.
+          # @param [String] verification_sid Filter used to return all the Verification
+          #   Attempts of a single verification. Only attempts of the provided verification
+          #   SID will be returned.
+          # @param [verification_attempt.ConversionStatus] status Filter used to query
+          #   Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for
+          #   attempts that were not converted, and `CONVERTED`, for attempts that were
+          #   confirmed.
           # @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
@@ -40,11 +53,16 @@ module Twilio
           #    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)
+          def list(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :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,
+                country: country,
+                channel: channel,
+                verify_service_sid: verify_service_sid,
+                verification_sid: verification_sid,
+                status: status,
                 limit: limit,
                 page_size: page_size
             ).entries
@@ -55,11 +73,24 @@ module Twilio
           # 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.
+          #   Attempts created after this datetime. Given as GMT in RFC 2822 format.
           # @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.
+          #   Attempts created before this datetime. Given as GMT in RFC 2822 format.
+          # @param [String] channel_data_to Destination of a verification. It is phone
+          #   number in E.164 format.
+          # @param [String] country Filter used to query Verification Attempts sent to the
+          #   specified destination country.
+          # @param [verification_attempt.Channels] channel Filter used to query Verification
+          #   Attempts by communication channel. Valid values are `SMS` and `CALL`
+          # @param [String] verify_service_sid Filter used to query Verification Attempts by
+          #   verify service. Only attempts of the provided SID will be returned.
+          # @param [String] verification_sid Filter used to return all the Verification
+          #   Attempts of a single verification. Only attempts of the provided verification
+          #   SID will be returned.
+          # @param [verification_attempt.ConversionStatus] status Filter used to query
+          #   Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for
+          #   attempts that were not converted, and `CONVERTED`, for attempts that were
+          #   confirmed.
           # @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
@@ -67,13 +98,18 @@ module Twilio
           #    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)
+          def stream(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :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,
+                country: country,
+                channel: channel,
+                verify_service_sid: verify_service_sid,
+                verification_sid: verification_sid,
+                status: status,
                 page_size: limits[:page_size],
             )
 
@@ -98,20 +134,38 @@ module Twilio
           # 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.
+          #   Attempts created after this datetime. Given as GMT in RFC 2822 format.
           # @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.
+          #   Attempts created before this datetime. Given as GMT in RFC 2822 format.
+          # @param [String] channel_data_to Destination of a verification. It is phone
+          #   number in E.164 format.
+          # @param [String] country Filter used to query Verification Attempts sent to the
+          #   specified destination country.
+          # @param [verification_attempt.Channels] channel Filter used to query Verification
+          #   Attempts by communication channel. Valid values are `SMS` and `CALL`
+          # @param [String] verify_service_sid Filter used to query Verification Attempts by
+          #   verify service. Only attempts of the provided SID will be returned.
+          # @param [String] verification_sid Filter used to return all the Verification
+          #   Attempts of a single verification. Only attempts of the provided verification
+          #   SID will be returned.
+          # @param [verification_attempt.ConversionStatus] status Filter used to query
+          #   Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for
+          #   attempts that were not converted, and `CONVERTED`, for attempts that were
+          #   confirmed.
           # @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)
+          def page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :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,
+                'Country' => country,
+                'Channel' => channel,
+                'VerifyServiceSid' => verify_service_sid,
+                'VerificationSid' => verification_sid,
+                'Status' => status,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
@@ -224,10 +278,12 @@ module Twilio
                 'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'service_sid' => payload['service_sid'],
+                'verification_sid' => payload['verification_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'],
+                'price' => payload['price'],
                 'channel_data' => payload['channel_data'],
                 'url' => payload['url'],
             }
@@ -249,23 +305,29 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Verification Attempt
+          # @return [String] The SID that uniquely identifies the verification attempt.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] Account Sid
+          # @return [String] The SID of the Account that created the verification.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The service_sid
+          # @return [String] The SID of the verify service that generated this attempt.
           def service_sid
             @properties['service_sid']
           end
 
+          ##
+          # @return [String] The SID of the verification that generated this attempt.
+          def verification_sid
+            @properties['verification_sid']
+          end
+
           ##
           # @return [Time] The date this Attempt was created
           def date_created
@@ -279,19 +341,25 @@ module Twilio
           end
 
           ##
-          # @return [verification_attempt.ConversionStatus] Status of a conversion
+          # @return [verification_attempt.ConversionStatus] Status of the conversion for the verification.
           def conversion_status
             @properties['conversion_status']
           end
 
           ##
-          # @return [verification_attempt.Channels] Channel used for the attempt
+          # @return [verification_attempt.Channels] Communication channel used for the attempt.
           def channel
             @properties['channel']
           end
 
           ##
-          # @return [Hash] Object with the channel information for an attempt
+          # @return [Hash] An object containing the charge for this verification attempt.
+          def price
+            @properties['price']
+          end
+
+          ##
+          # @return [Hash] An object containing the channel specific information for an attempt.
           def channel_data
             @properties['channel_data']
           end

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

@@ -47,8 +47,8 @@ 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)

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

@@ -334,6 +334,7 @@ module Twilio
                 'bitrate' => payload['bitrate'].to_i,
                 'size' => payload['size'].to_i,
                 'duration' => payload['duration'].to_i,
+                'media_external_location' => payload['media_external_location'],
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -450,6 +451,12 @@ 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 absolute URL of the resource
           def url

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

@@ -272,6 +272,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'],
                 'links' => payload['links'],
             }
 
@@ -375,6 +376,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 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
@@ -63,8 +66,14 @@ module Twilio
           # @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).
           # @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, audio_only: :unset, max_participant_duration: :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)
             data = Twilio::Values.of({
                 'EnableTurn' => enable_turn,
                 'Type' => type,
@@ -78,6 +87,8 @@ module Twilio
                 'RecordingRules' => Twilio.serialize_object(recording_rules),
                 'AudioOnly' => audio_only,
                 'MaxParticipantDuration' => max_participant_duration,
+                'EmptyRoomTimeout' => empty_room_timeout,
+                'UnusedRoomTimeout' => unused_room_timeout,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -374,6 +385,8 @@ module Twilio
                 '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,
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -508,6 +521,18 @@ module Twilio
             @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 [String] The absolute URL of the resource
           def url