twilio-ruby 5.31.1 → 5.54.0

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the RateLimitList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [RateLimitList] RateLimitList
             def initialize(version, service_sid: nil)
@@ -28,21 +28,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of RateLimitInstance records from the API.
-            # Request is executed immediately.
+            # Create the RateLimitInstance
             # @param [String] unique_name Provides a unique and addressable name to be
             #   assigned to this Rate Limit, assigned by the developer, to be optionally used in
             #   addition to SID. **This value should not contain PII.**
             # @param [String] description Description of this Rate Limit
-            # @return [RateLimitInstance] Newly created RateLimitInstance
+            # @return [RateLimitInstance] Created RateLimitInstance
             def create(unique_name: nil, description: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Description' => description, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               RateLimitInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -108,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RateLimitPage.new(@version, response, @solution)
             end
 
@@ -170,7 +163,7 @@ module Twilio
             # Initialize the RateLimitContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Rate
             #   Limit resource to fetch.
@@ -193,35 +186,25 @@ module Twilio
             def update(description: :unset)
               data = Twilio::Values.of({'Description' => description, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               RateLimitInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Fetch a RateLimitInstance
+            # Fetch the RateLimitInstance
             # @return [RateLimitInstance] Fetched RateLimitInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               RateLimitInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RateLimitInstance
+            # Delete the RateLimitInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -267,7 +250,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Rate
             #   Limit resource to fetch.
@@ -367,14 +350,14 @@ module Twilio
             end
 
             ##
-            # Fetch a RateLimitInstance
+            # Fetch the RateLimitInstance
             # @return [RateLimitInstance] Fetched RateLimitInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RateLimitInstance
+            # Delete the RateLimitInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the BucketList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.
@@ -31,20 +31,15 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of BucketInstance records from the API.
-              # Request is executed immediately.
+              # Create the BucketInstance
               # @param [String] max Maximum number of requests permitted in during the interval.
               # @param [String] interval Number of seconds that the rate limit will be enforced
               #   over.
-              # @return [BucketInstance] Newly created BucketInstance
+              # @return [BucketInstance] Created BucketInstance
               def create(max: nil, interval: nil)
                 data = Twilio::Values.of({'Max' => max, 'Interval' => interval, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 BucketInstance.new(
                     @version,
@@ -115,11 +110,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 BucketPage.new(@version, response, @solution)
               end
 
@@ -182,7 +175,7 @@ module Twilio
               # Initialize the BucketContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.
@@ -205,11 +198,7 @@ module Twilio
               def update(max: :unset, interval: :unset)
                 data = Twilio::Values.of({'Max' => max, 'Interval' => interval, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 BucketInstance.new(
                     @version,
@@ -221,16 +210,10 @@ module Twilio
               end
 
               ##
-              # Fetch a BucketInstance
+              # Fetch the BucketInstance
               # @return [BucketInstance] Fetched BucketInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 BucketInstance.new(
                     @version,
@@ -242,10 +225,10 @@ module Twilio
               end
 
               ##
-              # Deletes the BucketInstance
+              # Delete the BucketInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -269,7 +252,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.
@@ -381,14 +364,14 @@ module Twilio
               end
 
               ##
-              # Fetch a BucketInstance
+              # Fetch the BucketInstance
               # @return [BucketInstance] Fetched BucketInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the BucketInstance
+              # Delete the BucketInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the VerificationList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [VerificationList] VerificationList
             def initialize(version, service_sid: nil)
@@ -28,22 +28,24 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of VerificationInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] to The phone number or email to verify. Phone numbers must be in
-            #   [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+            # Create the VerificationInstance
+            # @param [String] to The phone number or
+            #   {email}[https://www.twilio.com/docs/verify/email] to verify. Phone numbers must
+            #   be in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
             # @param [String] channel The verification method to use. Can be:
-            #   [`email`*](#email-channel-availability), `sms` or `call`.
+            #   {`email`}[https://www.twilio.com/docs/verify/email], `sms` or `call`.
+            # @param [String] custom_friendly_name A custom user defined friendly name that
+            #   overwrites the existing one in the verification message
             # @param [String] custom_message The text of a custom message to use for the
             #   verification.
             # @param [String] send_digits The digits to send after a phone call is answered,
             #   for example, to dial an extension. For more information, see the Programmable
             #   Voice documentation of
-            #   [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
+            #   {sendDigits}[https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits].
             # @param [String] locale The locale to use for the verification SMS or call. Can
-            #   be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`,
-            #   `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pr-BR`,
-            #   `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`
+            #   be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-GB`, `es`, `fi`, `fr`,
+            #   `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`,
+            #   `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`
             # @param [String] custom_code A pre-generated code to use for verification. The
             #   code can be between 4 and 10 characters, inclusive.
             # @param [String] amount The amount of the associated PSD2 compliant transaction.
@@ -51,16 +53,23 @@ module Twilio
             # @param [String] payee The payee of the associated PSD2 compliant transaction.
             #   Requires the PSD2 Service flag enabled.
             # @param [Hash] rate_limits The custom key-value pairs of Programmable Rate
-            #   Limits. Keys should be the unique_name configured while creating you Rate Limit
-            #   along with the associated values for each particular request. You may include
-            #   multiple Rate Limit values in each request.
-            # @param [Hash] channel_configuration `email` channel configuration in json
-            #   format. Must include 'from' and 'from_name'.
-            # @return [VerificationInstance] Newly created VerificationInstance
-            def create(to: nil, channel: nil, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset)
+            #   Limits. Keys correspond to `unique_name` fields defined when {creating your Rate
+            #   Limit}[https://www.twilio.com/docs/verify/api/service-rate-limits]. Associated
+            #   value pairs represent values in the request that you are rate limiting on. You
+            #   may include multiple Rate Limit values in each request.
+            # @param [Hash] channel_configuration
+            #   {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in
+            #   json format. Must include 'from' and 'from_name'.
+            # @param [String] app_hash Your {App
+            #   Hash}[https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string]
+            #   to be appended at the end of your verification SMS body. Applies only to SMS.
+            #   Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
+            # @return [VerificationInstance] Created VerificationInstance
+            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'Channel' => channel,
+                  'CustomFriendlyName' => custom_friendly_name,
                   'CustomMessage' => custom_message,
                   'SendDigits' => send_digits,
                   'Locale' => locale,
@@ -69,13 +78,10 @@ module Twilio
                   'Payee' => payee,
                   'RateLimits' => Twilio.serialize_object(rate_limits),
                   'ChannelConfiguration' => Twilio.serialize_object(channel_configuration),
+                  'AppHash' => app_hash,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               VerificationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -121,7 +127,7 @@ module Twilio
             # Initialize the VerificationContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the verification
-            #   [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] to fetch the resource
             #   from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Verification resource to fetch.
@@ -142,11 +148,7 @@ module Twilio
             def update(status: nil)
               data = Twilio::Values.of({'Status' => status, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               VerificationInstance.new(
                   @version,
@@ -157,16 +159,10 @@ module Twilio
             end
 
             ##
-            # Fetch a VerificationInstance
+            # Fetch the VerificationInstance
             # @return [VerificationInstance] Fetched VerificationInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               VerificationInstance.new(
                   @version,
@@ -197,7 +193,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Verification resource to fetch.
@@ -217,6 +213,7 @@ module Twilio
                   'lookup' => payload['lookup'],
                   'amount' => payload['amount'],
                   'payee' => payload['payee'],
+                  'send_code_attempts' => payload['send_code_attempts'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
@@ -298,6 +295,12 @@ module Twilio
               @properties['payee']
             end
 
+            ##
+            # @return [Array[Hash]] An array of verification attempt objects.
+            def send_code_attempts
+              @properties['send_code_attempts']
+            end
+
             ##
             # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
@@ -326,7 +329,7 @@ module Twilio
             end
 
             ##
-            # Fetch a VerificationInstance
+            # Fetch the VerificationInstance
             # @return [VerificationInstance] Fetched VerificationInstance
             def fetch
               context.fetch

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the VerificationCheckList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [VerificationCheckList] VerificationCheckList
             def initialize(version, service_sid: nil)
@@ -28,22 +28,20 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of VerificationCheckInstance records from the API.
-            # Request is executed immediately.
+            # Create the VerificationCheckInstance
             # @param [String] code The 4-10 character string being verified.
             # @param [String] to The phone number or
-            #   [email](https://www.twilio.com/docs/verify/tutorials/email) to verify. Either
-            #   this parameter or the `verification_sid` must be specified. Phone numbers must
-            #   be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+            #   {email}[https://www.twilio.com/docs/verify/email] to verify. Either this
+            #   parameter or the `verification_sid` must be specified. Phone numbers must be in
+            #   {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
             # @param [String] verification_sid A SID that uniquely identifies the Verification
             #   Check. Either this parameter or the `to` phone
-            #   number/[email](https://www.twilio.com/docs/verify/tutorials/email) must be
-            #   specified.
+            #   number/{email}[https://www.twilio.com/docs/verify/email] must be specified.
             # @param [String] amount The amount of the associated PSD2 compliant transaction.
             #   Requires the PSD2 Service flag enabled.
             # @param [String] payee The payee of the associated PSD2 compliant transaction.
             #   Requires the PSD2 Service flag enabled.
-            # @return [VerificationCheckInstance] Newly created VerificationCheckInstance
+            # @return [VerificationCheckInstance] Created VerificationCheckInstance
             def create(code: nil, to: :unset, verification_sid: :unset, amount: :unset, payee: :unset)
               data = Twilio::Values.of({
                   'Code' => code,
@@ -53,11 +51,7 @@ module Twilio
                   'Payee' => payee,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               VerificationCheckInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -104,7 +98,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [VerificationCheckInstance] VerificationCheckInstance
             def initialize(version, payload, service_sid: nil)