twilio-ruby 5.46.0 → 5.50.0

data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_evaluations.rb

@@ -0,0 +1,328 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Trusthub < Domain
+      class V1 < Version
+        class TrustProductsContext < InstanceContext
+          class TrustProductsEvaluationsList < ListResource
+            ##
+            # Initialize the TrustProductsEvaluationsList
+            # @param [Version] version Version that contains the resource
+            # @param [String] trust_product_sid The unique string that we created to identify
+            #   the trust_product resource.
+            # @return [TrustProductsEvaluationsList] TrustProductsEvaluationsList
+            def initialize(version, trust_product_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {trust_product_sid: trust_product_sid}
+              @uri = "/TrustProducts/#{@solution[:trust_product_sid]}/Evaluations"
+            end
+
+            ##
+            # Create the TrustProductsEvaluationsInstance
+            # @param [String] policy_sid The unique string of a policy that is associated to
+            #   the customer_profile resource.
+            # @return [TrustProductsEvaluationsInstance] Created TrustProductsEvaluationsInstance
+            def create(policy_sid: nil)
+              data = Twilio::Values.of({'PolicySid' => policy_sid, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              TrustProductsEvaluationsInstance.new(
+                  @version,
+                  payload,
+                  trust_product_sid: @solution[:trust_product_sid],
+              )
+            end
+
+            ##
+            # Lists TrustProductsEvaluationsInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @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(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams TrustProductsEvaluationsInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @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(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields TrustProductsEvaluationsInstance 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 TrustProductsEvaluationsInstance records from the API.
+            # Request is executed immediately.
+            # @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 TrustProductsEvaluationsInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              TrustProductsEvaluationsPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of TrustProductsEvaluationsInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of TrustProductsEvaluationsInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              TrustProductsEvaluationsPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Trusthub.V1.TrustProductsEvaluationsList>'
+            end
+          end
+
+          class TrustProductsEvaluationsPage < Page
+            ##
+            # Initialize the TrustProductsEvaluationsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [TrustProductsEvaluationsPage] TrustProductsEvaluationsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of TrustProductsEvaluationsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [TrustProductsEvaluationsInstance] TrustProductsEvaluationsInstance
+            def get_instance(payload)
+              TrustProductsEvaluationsInstance.new(
+                  @version,
+                  payload,
+                  trust_product_sid: @solution[:trust_product_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Trusthub.V1.TrustProductsEvaluationsPage>'
+            end
+          end
+
+          class TrustProductsEvaluationsContext < InstanceContext
+            ##
+            # Initialize the TrustProductsEvaluationsContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] trust_product_sid The unique string that we created to identify
+            #   the trust_product resource.
+            # @param [String] sid The unique string that identifies the Evaluation resource.
+            # @return [TrustProductsEvaluationsContext] TrustProductsEvaluationsContext
+            def initialize(version, trust_product_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {trust_product_sid: trust_product_sid, sid: sid, }
+              @uri = "/TrustProducts/#{@solution[:trust_product_sid]}/Evaluations/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the TrustProductsEvaluationsInstance
+            # @return [TrustProductsEvaluationsInstance] Fetched TrustProductsEvaluationsInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              TrustProductsEvaluationsInstance.new(
+                  @version,
+                  payload,
+                  trust_product_sid: @solution[:trust_product_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trusthub.V1.TrustProductsEvaluationsContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trusthub.V1.TrustProductsEvaluationsContext #{context}>"
+            end
+          end
+
+          class TrustProductsEvaluationsInstance < InstanceResource
+            ##
+            # Initialize the TrustProductsEvaluationsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] trust_product_sid The unique string that we created to identify
+            #   the trust_product resource.
+            # @param [String] sid The unique string that identifies the Evaluation resource.
+            # @return [TrustProductsEvaluationsInstance] TrustProductsEvaluationsInstance
+            def initialize(version, payload, trust_product_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'policy_sid' => payload['policy_sid'],
+                  'trust_product_sid' => payload['trust_product_sid'],
+                  'status' => payload['status'],
+                  'results' => payload['results'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'trust_product_sid' => trust_product_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 [TrustProductsEvaluationsContext] TrustProductsEvaluationsContext for this TrustProductsEvaluationsInstance
+            def context
+              unless @instance_context
+                @instance_context = TrustProductsEvaluationsContext.new(
+                    @version,
+                    @params['trust_product_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the Evaluation resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The unique string of a policy
+            def policy_sid
+              @properties['policy_sid']
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def trust_product_sid
+              @properties['trust_product_sid']
+            end
+
+            ##
+            # @return [trust_products_evaluations.Status] The compliance status of the Evaluation resource
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [Array[Hash]] The results of the Evaluation resource
+            def results
+              @properties['results']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the TrustProductsEvaluationsInstance
+            # @return [TrustProductsEvaluationsInstance] Fetched TrustProductsEvaluationsInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trusthub.V1.TrustProductsEvaluationsInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trusthub.V1.TrustProductsEvaluationsInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -46,6 +46,15 @@ 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
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -17,6 +17,7 @@ module Twilio
           @version = 'v2'
           @forms = nil
           @services = nil
+          @verification_attempts = nil
         end
 
         ##
@@ -26,11 +27,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,11 +43,27 @@ 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
 

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

@@ -20,7 +20,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Challenge
+              #   Challenge. This value must be between 8 and 64 characters long.
               # @return [ChallengeList] ChallengeList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -208,7 +208,8 @@ module Twilio
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity The unique external identifier for the Entity of the
               #   Service. This identifier should be immutable, not PII, and generated by your
-              #   external system, such as your user's UUID, GUID, or SID.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   Challenge.
               # @return [ChallengeContext] ChallengeContext
@@ -278,7 +279,7 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Challenge
+              #   Challenge. This value must be between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   Challenge.
               # @return [ChallengeInstance] ChallengeInstance

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

@@ -21,7 +21,8 @@ module Twilio
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity The unique external identifier for the Entity of the
               #   Service. This identifier should be immutable, not PII, and generated by your
-              #   external system, such as your user's UUID, GUID, or SID.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @return [FactorList] FactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -33,7 +34,8 @@ module Twilio
 
               ##
               # Create the FactorInstance
-              # @param [String] friendly_name The friendly name of this Factor
+              # @param [String] friendly_name The friendly name of this Factor. It can be up to
+              #   64 characters.
               # @param [factor.FactorTypes] factor_type The Type of this Factor. Currently only
               #   `push` is supported
               # @param [String] binding_alg The algorithm used when `factor_type` is `push`.
@@ -42,17 +44,30 @@ module Twilio
               #   format encoded in Base64
               # @param [String] config_app_id The ID that uniquely identifies your app in the
               #   Google or Apple store, such as `com.example.myapp`. Required when `factor_type`
-              #   is `push`
+              #   is `push`. If specified, it can be up to 100 characters long.
               # @param [factor.NotificationPlatforms] config_notification_platform The transport
               #   technology used to generate the Notification Token. Can be `apn` or `fcm`.
               #   Required when `factor_type` is `push`
               # @param [String] config_notification_token For APN, the device token. For FCM the
               #   registration token. It used to send the push notifications. Required when
-              #   `factor_type` is `push`
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
               # @param [String] config_sdk_version The Verify Push SDK version used to configure
               #   the factor
+              # @param [String] binding_secret The shared secret for TOTP factors encoded in
+              #   Base32
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive. Defaults to 30 seconds
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults
+              #   to 1
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive. Defaults to 6
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`
               # @return [FactorInstance] Created FactorInstance
-              def create(friendly_name: nil, factor_type: nil, binding_alg: :unset, binding_public_key: :unset, config_app_id: :unset, config_notification_platform: :unset, config_notification_token: :unset, config_sdk_version: :unset)
+              def create(friendly_name: nil, factor_type: nil, binding_alg: :unset, binding_public_key: :unset, config_app_id: :unset, config_notification_platform: :unset, config_notification_token: :unset, config_sdk_version: :unset, binding_secret: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
                 data = Twilio::Values.of({
                     'FriendlyName' => friendly_name,
                     'FactorType' => factor_type,
@@ -62,6 +77,11 @@ module Twilio
                     'Config.NotificationPlatform' => config_notification_platform,
                     'Config.NotificationToken' => config_notification_token,
                     'Config.SdkVersion' => config_sdk_version,
+                    'Binding.Secret' => binding_secret,
+                    'Config.TimeStep' => config_time_step,
+                    'Config.Skew' => config_skew,
+                    'Config.CodeLength' => config_code_length,
+                    'Config.Alg' => config_alg,
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -205,7 +225,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Factor
+              #   Factor. This value must be between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorContext] FactorContext
               def initialize(version, service_sid, identity, sid)
@@ -242,19 +262,34 @@ module Twilio
               # Update the FactorInstance
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
-              # @param [String] friendly_name The new friendly name of this Factor
+              # @param [String] friendly_name The new friendly name of this Factor. It can be up
+              #   to 64 characters.
               # @param [String] config_notification_token For APN, the device token. For FCM the
               #   registration token. It used to send the push notifications. Required when
-              #   `factor_type` is `push`
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
               # @param [String] config_sdk_version The Verify Push SDK version used to configure
               #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
                 data = Twilio::Values.of({
                     'AuthPayload' => auth_payload,
                     'FriendlyName' => friendly_name,
                     'Config.NotificationToken' => config_notification_token,
                     'Config.SdkVersion' => config_sdk_version,
+                    'Config.TimeStep' => config_time_step,
+                    'Config.Skew' => config_skew,
+                    'Config.CodeLength' => config_code_length,
+                    'Config.Alg' => config_alg,
                 })
 
                 payload = @version.update('POST', @uri, data: data)
@@ -293,7 +328,8 @@ module Twilio
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity The unique external identifier for the Entity of the
               #   Service. This identifier should be immutable, not PII, and generated by your
-              #   external system, such as your user's UUID, GUID, or SID.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorInstance] FactorInstance
               def initialize(version, payload, service_sid: nil, identity: nil, sid: nil)
@@ -426,19 +462,34 @@ module Twilio
               # Update the FactorInstance
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
-              # @param [String] friendly_name The new friendly name of this Factor
+              # @param [String] friendly_name The new friendly name of this Factor. It can be up
+              #   to 64 characters.
               # @param [String] config_notification_token For APN, the device token. For FCM the
               #   registration token. It used to send the push notifications. Required when
-              #   `factor_type` is `push`
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
               # @param [String] config_sdk_version The Verify Push SDK version used to configure
               #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
                 context.update(
                     auth_payload: auth_payload,
                     friendly_name: friendly_name,
                     config_notification_token: config_notification_token,
                     config_sdk_version: config_sdk_version,
+                    config_time_step: config_time_step,
+                    config_skew: config_skew,
+                    config_code_length: config_code_length,
+                    config_alg: config_alg,
                 )
               end