twilio-ruby 5.37.0 → 5.39.3

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

@@ -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
 
@@ -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
 
               ##
@@ -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

@@ -28,13 +28,14 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of VerificationInstance records from the API.
-            # Request is executed immediately.
+            # 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`](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,
@@ -61,11 +62,12 @@ module Twilio
             #   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] 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, app_hash: :unset)
+            # @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,
@@ -77,11 +79,7 @@ module Twilio
                   '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
@@ -148,11 +146,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,
@@ -163,16 +157,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,
@@ -339,7 +327,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

@@ -28,8 +28,7 @@ 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/email) to verify. Either this
@@ -42,7 +41,7 @@ module Twilio
             #   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,
@@ -52,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

data/lib/twilio-ruby/rest/{authy/v1/service/entity.rb → verify/v2/service/webhook.rb}

@@ -8,44 +8,51 @@
 
 module Twilio
   module REST
-    class Authy < Domain
-      class V1 < Version
+    class Verify < Domain
+      class V2 < Version
         class ServiceContext < InstanceContext
           ##
           # 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 EntityList < ListResource
+          class WebhookList < ListResource
             ##
-            # Initialize the EntityList
+            # Initialize the WebhookList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The unique SID identifier of the Service.
-            # @return [EntityList] EntityList
+            # @return [WebhookList] WebhookList
             def initialize(version, service_sid: nil)
               super(version)
 
               # Path Solution
               @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/Entities"
-            end
+              @uri = "/Services/#{@solution[:service_sid]}/Webhooks"
+            end
+
+            ##
+            # Create the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [String] event_types The array of events that this Webhook is subscribed
+            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
+            #   challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Created WebhookInstance
+            def create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
+                  'WebhookUrl' => webhook_url,
+                  'Status' => status,
+              })
 
-            ##
-            # Retrieve a single page of EntityInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity Customer unique identity for the Entity of the Service
-            # @return [EntityInstance] Newly created EntityInstance
-            def create(identity: nil)
-              data = Twilio::Values.of({'Identity' => identity, })
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
-            # Lists EntityInstance records from the API as a list.
+            # Lists WebhookInstance 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()
@@ -60,7 +67,7 @@ module Twilio
             end
 
             ##
-            # Streams EntityInstance records from the API as an Enumerable.
+            # Streams WebhookInstance 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()
@@ -79,7 +86,7 @@ module Twilio
             end
 
             ##
-            # When passed a block, yields EntityInstance records from the API.
+            # When passed a block, yields WebhookInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             def each
@@ -93,55 +100,53 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of EntityInstance records from the API.
+            # Retrieve a single page of WebhookInstance 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 EntityInstance
+            # @return [Page] Page of WebhookInstance
             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
-              )
-              EntityPage.new(@version, response, @solution)
+
+              response = @version.page('GET', @uri, params: params)
+
+              WebhookPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of EntityInstance records from the API.
+            # Retrieve a single page of WebhookInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of EntityInstance
+            # @return [Page] Page of WebhookInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              EntityPage.new(@version, response, @solution)
+              WebhookPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Authy.V1.EntityList>'
+              '#<Twilio.Verify.V2.WebhookList>'
             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 EntityPage < Page
+          class WebhookPage < Page
             ##
-            # Initialize the EntityPage
+            # Initialize the WebhookPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [EntityPage] EntityPage
+            # @return [WebhookPage] WebhookPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -150,226 +155,250 @@ module Twilio
             end
 
             ##
-            # Build an instance of EntityInstance
+            # Build an instance of WebhookInstance
             # @param [Hash] payload Payload response from the API
-            # @return [EntityInstance] EntityInstance
+            # @return [WebhookInstance] WebhookInstance
             def get_instance(payload)
-              EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Authy.V1.EntityPage>'
+              '<Twilio.Verify.V2.WebhookPage>'
             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 EntityContext < InstanceContext
+          class WebhookContext < InstanceContext
             ##
-            # Initialize the EntityContext
+            # Initialize the WebhookContext
             # @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 of the Service
-            # @return [EntityContext] EntityContext
-            def initialize(version, service_sid, identity)
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Webhook resource to fetch.
+            # @return [WebhookContext] WebhookContext
+            def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, identity: identity, }
-              @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}"
+              @solution = {service_sid: service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:service_sid]}/Webhooks/#{@solution[:sid]}"
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [String] event_types The array of events that this Webhook is subscribed
+            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
+            #   challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
+                  'WebhookUrl' => webhook_url,
+                  'Status' => status,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
 
-              # Dependents
-              @factors = nil
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the EntityInstance
+            # Delete the WebhookInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a EntityInstance
-            # @return [EntityInstance] Fetched EntityInstance
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
-
-              EntityInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-                  identity: @solution[:identity],
-              )
-            end
-
-            ##
-            # Access the factors
-            # @return [FactorList]
-            # @return [FactorContext] if sid was passed.
-            def factors(sid=:unset)
-              raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-              if sid != :unset
-                return FactorContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
-              end
+              payload = @version.fetch('GET', @uri)
 
-              unless @factors
-                @factors = FactorList.new(
-                    @version,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
-              @factors
+              WebhookInstance.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.Authy.V1.EntityContext #{context}>"
+              "#<Twilio.Verify.V2.WebhookContext #{context}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Authy.V1.EntityContext #{context}>"
+              "#<Twilio.Verify.V2.WebhookContext #{context}>"
             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 EntityInstance < InstanceResource
+          class WebhookInstance < InstanceResource
             ##
-            # Initialize the EntityInstance
+            # Initialize the WebhookInstance
             # @param [Version] version Version that contains the resource
             # @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 of the Service
-            # @return [EntityInstance] EntityInstance
-            def initialize(version, payload, service_sid: nil, identity: nil)
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Webhook resource to fetch.
+            # @return [WebhookInstance] WebhookInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
-                  'identity' => payload['identity'],
-                  'account_sid' => payload['account_sid'],
                   'service_sid' => payload['service_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'event_types' => payload['event_types'],
+                  'status' => payload['status'],
+                  'webhook_url' => payload['webhook_url'],
+                  'webhook_method' => payload['webhook_method'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
-                  'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'identity' => identity || @properties['identity'], }
+              @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 [EntityContext] EntityContext for this EntityInstance
+            # @return [WebhookContext] WebhookContext for this WebhookInstance
             def context
               unless @instance_context
-                @instance_context = EntityContext.new(@version, @params['service_sid'], @params['identity'], )
+                @instance_context = WebhookContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Entity.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Unique identity of the Entity
-            def identity
-              @properties['identity']
+            # @return [String] Service Sid.
+            def service_sid
+              @properties['service_sid']
             end
 
             ##
-            # @return [String] Account Sid.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Service Sid.
-            def service_sid
-              @properties['service_sid']
+            # @return [String] The string that you assigned to describe the webhook
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The array of events that this Webhook is subscribed to.
+            def event_types
+              @properties['event_types']
             end
 
             ##
-            # @return [Time] The date this Entity was created
+            # @return [webhook.Status] The webhook status
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [String] The URL associated with this Webhook.
+            def webhook_url
+              @properties['webhook_url']
+            end
+
+            ##
+            # @return [webhook.Methods] The method used when calling the webhook's URL.
+            def webhook_method
+              @properties['webhook_method']
+            end
+
+            ##
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Entity was updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the Webhook resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
-            def links
-              @properties['links']
+            # Update the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [String] event_types The array of events that this Webhook is subscribed
+            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
+            #   challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+              context.update(
+                  friendly_name: friendly_name,
+                  event_types: event_types,
+                  webhook_url: webhook_url,
+                  status: status,
+              )
             end
 
             ##
-            # Deletes the EntityInstance
+            # Delete the WebhookInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a EntityInstance
-            # @return [EntityInstance] Fetched EntityInstance
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
             def fetch
               context.fetch
             end
 
-            ##
-            # Access the factors
-            # @return [factors] factors
-            def factors
-              context.factors
-            end
-
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Authy.V1.EntityInstance #{values}>"
+              "<Twilio.Verify.V2.WebhookInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Authy.V1.EntityInstance #{values}>"
+              "<Twilio.Verify.V2.WebhookInstance #{values}>"
             end
           end
         end