twilio-ruby 5.58.1 → 5.60.0

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb

@@ -299,18 +299,22 @@ module Twilio
             #   Worker. Defaults to {}.
             # @param [String] friendly_name A descriptive string that you create to describe
             #   the Worker. It can be up to 64 characters long.
-            # @param [Boolean] reject_pending_reservations Whether to reject pending
-            #   reservations.
+            # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
+            #   pending reservations. This option is only valid if the Worker's new
+            #   {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
+            #   `availability` property set to `False`.
+            # @param [String] if_match The If-Match HTTP request header
             # @return [WorkerInstance] Updated WorkerInstance
-            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset)
+            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
               data = Twilio::Values.of({
                   'ActivitySid' => activity_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
                   'RejectPendingReservations' => reject_pending_reservations,
               })
+              headers = Twilio::Values.of({'If-Match' => if_match, })
 
-              payload = @version.update('POST', @uri, data: data)
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
               WorkerInstance.new(
                   @version,
@@ -322,9 +326,12 @@ module Twilio
 
             ##
             # Delete the WorkerInstance
+            # @param [String] if_match The If-Match HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
+            def delete(if_match: :unset)
+              headers = Twilio::Values.of({'If-Match' => if_match, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
@@ -551,23 +558,28 @@ module Twilio
             #   Worker. Defaults to {}.
             # @param [String] friendly_name A descriptive string that you create to describe
             #   the Worker. It can be up to 64 characters long.
-            # @param [Boolean] reject_pending_reservations Whether to reject pending
-            #   reservations.
+            # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
+            #   pending reservations. This option is only valid if the Worker's new
+            #   {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
+            #   `availability` property set to `False`.
+            # @param [String] if_match The If-Match HTTP request header
             # @return [WorkerInstance] Updated WorkerInstance
-            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset)
+            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
               context.update(
                   activity_sid: activity_sid,
                   attributes: attributes,
                   friendly_name: friendly_name,
                   reject_pending_reservations: reject_pending_reservations,
+                  if_match: if_match,
               )
             end
 
             ##
             # Delete the WorkerInstance
+            # @param [String] if_match The If-Match HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
+            def delete(if_match: :unset)
+              context.delete(if_match: if_match, )
             end
 
             ##

data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb

@@ -124,12 +124,14 @@ module Twilio
           #   worker.activity.update`, then TaskRouter will call event_callback_url only when
           #   a task is created, canceled, or a Worker activity is updated.
           # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
-          #   `true` to enable multi-tasking, or `false` to disable it. The default is
-          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
-          #   When enabled (`true`), each Worker can receive parallel reservations up to the
-          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
-          #   only receive a new reservation when the previous task is completed. Learn more
-          #   at {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
+          #   `true` to enable multi-tasking, or `false` to disable it. However, all
+          #   workspaces should be created as multi-tasking. The default is `true`.
+          #   Multi-tasking allows Workers to handle multiple Tasks simultaneously. When
+          #   enabled (`true`), each Worker can receive parallel reservations up to the
+          #   per-channel maximums defined in the Workers section. In single-tasking mode
+          #   (legacy mode), each Worker will only receive a new reservation when the previous
+          #   task is completed. Learn more at
+          #   {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
           # @param [String] template An available template name. Can be: `NONE` or `FIFO`
           #   and the default is `NONE`. Pre-configures the Workspace with the Workflow and
           #   Activities specified in the template. `NONE` will create a Workspace with only a
@@ -243,17 +245,21 @@ module Twilio
           #   the Workspace resource. For example: `Sales Call Center` or `Customer Support
           #   Team`.
           # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
-          #   `true` to enable multi-tasking, or `false` to disable it. The default is
-          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
-          #   When enabled (`true`), each Worker can receive parallel reservations up to the
-          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
-          #   only receive a new reservation when the previous task is completed. Learn more
-          #   at {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
+          #   `true` to enable multi-tasking, or `false` to disable it. However, all
+          #   workspaces should be maintained as multi-tasking. There is no default when
+          #   omitting this parameter. A multi-tasking Workspace can't be updated to
+          #   single-tasking unless it is not a Flex Project and another (legacy)
+          #   single-tasking Workspace exists. Multi-tasking allows Workers to handle multiple
+          #   Tasks simultaneously. In multi-tasking mode, each Worker can receive parallel
+          #   reservations up to the per-channel maximums defined in the Workers section. In
+          #   single-tasking mode (legacy mode), each Worker will only receive a new
+          #   reservation when the previous task is completed. Learn more at
+          #   {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
           # @param [String] timeout_activity_sid The SID of the Activity that will be
           #   assigned to a Worker when a Task reservation times out without a response.
           # @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
           #   prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
-          #   be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see {Queue
+          #   be: `LIFO` or `FIFO`. For more information, see {Queue
           #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
           # @return [WorkspaceInstance] Updated WorkspaceInstance
           def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
@@ -602,17 +608,21 @@ module Twilio
           #   the Workspace resource. For example: `Sales Call Center` or `Customer Support
           #   Team`.
           # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
-          #   `true` to enable multi-tasking, or `false` to disable it. The default is
-          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
-          #   When enabled (`true`), each Worker can receive parallel reservations up to the
-          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
-          #   only receive a new reservation when the previous task is completed. Learn more
-          #   at {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
+          #   `true` to enable multi-tasking, or `false` to disable it. However, all
+          #   workspaces should be maintained as multi-tasking. There is no default when
+          #   omitting this parameter. A multi-tasking Workspace can't be updated to
+          #   single-tasking unless it is not a Flex Project and another (legacy)
+          #   single-tasking Workspace exists. Multi-tasking allows Workers to handle multiple
+          #   Tasks simultaneously. In multi-tasking mode, each Worker can receive parallel
+          #   reservations up to the per-channel maximums defined in the Workers section. In
+          #   single-tasking mode (legacy mode), each Worker will only receive a new
+          #   reservation when the previous task is completed. Learn more at
+          #   {Multitasking}[https://www.twilio.com/docs/taskrouter/multitasking].
           # @param [String] timeout_activity_sid The SID of the Activity that will be
           #   assigned to a Worker when a Task reservation times out without a response.
           # @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
           #   prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
-          #   be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see {Queue
+          #   be: `LIFO` or `FIFO`. For more information, see {Queue
           #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
           # @return [WorkspaceInstance] Updated WorkspaceInstance
           def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)

data/lib/twilio-ruby/rest/trunking/v1/trunk.rb

@@ -54,8 +54,10 @@ module Twilio
           #   the United States and Canada automatically perform a CNAM Lookup and display
           #   Caller ID data on your phone. See {CNAM
           #   Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information.
+          # @param [trunk.TransferCallerId] transfer_caller_id Caller Id for transfer
+          #   target. Can be: `from-transferee` (default) or `from-transferor`.
           # @return [TrunkInstance] Created TrunkInstance
-          def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset)
+          def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DomainName' => domain_name,
@@ -64,6 +66,7 @@ module Twilio
                 'TransferMode' => transfer_mode,
                 'Secure' => secure,
                 'CnamLookupEnabled' => cnam_lookup_enabled,
+                'TransferCallerId' => transfer_caller_id,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -256,8 +259,10 @@ module Twilio
           #   the United States and Canada automatically perform a CNAM Lookup and display
           #   Caller ID data on your phone. See {CNAM
           #   Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information.
+          # @param [trunk.TransferCallerId] transfer_caller_id Caller Id for transfer
+          #   target. Can be: `from-transferee` (default) or `from-transferor`.
           # @return [TrunkInstance] Updated TrunkInstance
-          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset)
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DomainName' => domain_name,
@@ -266,6 +271,7 @@ module Twilio
                 'TransferMode' => transfer_mode,
                 'Secure' => secure,
                 'CnamLookupEnabled' => cnam_lookup_enabled,
+                'TransferCallerId' => transfer_caller_id,
             })
 
             payload = @version.update('POST', @uri, data: data)
@@ -389,6 +395,7 @@ module Twilio
                 'secure' => payload['secure'],
                 'recording' => payload['recording'],
                 'transfer_mode' => payload['transfer_mode'],
+                'transfer_caller_id' => payload['transfer_caller_id'],
                 'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
                 'auth_type' => payload['auth_type'],
                 'auth_type_set' => payload['auth_type_set'],
@@ -463,6 +470,12 @@ module Twilio
             @properties['transfer_mode']
           end
 
+          ##
+          # @return [trunk.TransferCallerId] Caller Id for transfer target
+          def transfer_caller_id
+            @properties['transfer_caller_id']
+          end
+
           ##
           # @return [Boolean] Whether Caller ID Name (CNAM) lookup is enabled for the trunk
           def cnam_lookup_enabled
@@ -556,8 +569,10 @@ module Twilio
           #   the United States and Canada automatically perform a CNAM Lookup and display
           #   Caller ID data on your phone. See {CNAM
           #   Lookups}[https://www.twilio.com/docs/sip-trunking#CNAM] for more information.
+          # @param [trunk.TransferCallerId] transfer_caller_id Caller Id for transfer
+          #   target. Can be: `from-transferee` (default) or `from-transferor`.
           # @return [TrunkInstance] Updated TrunkInstance
-          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset)
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset)
             context.update(
                 friendly_name: friendly_name,
                 domain_name: domain_name,
@@ -566,6 +581,7 @@ module Twilio
                 transfer_mode: transfer_mode,
                 secure: secure,
                 cnam_lookup_enabled: cnam_lookup_enabled,
+                transfer_caller_id: transfer_caller_id,
             )
           end
 

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

@@ -21,7 +21,9 @@ 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. This value must be between 8 and 64 characters long.
+                #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
+                #   characters, and generated by your external system, such as your user's UUID,
+                #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
                 # @param [String] challenge_sid The unique SID identifier of the Challenge.
                 # @return [NotificationList] NotificationList
                 def initialize(version, service_sid: nil, identity: nil, challenge_sid: nil)
@@ -106,7 +108,9 @@ 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. This value must be between 8 and 64 characters long.
+                #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
+                #   characters, and generated by your external system, such as your user's UUID,
+                #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
                 # @param [String] challenge_sid The unique SID identifier of the Challenge.
                 # @return [NotificationInstance] NotificationInstance
                 def initialize(version, payload, service_sid: nil, identity: nil, challenge_sid: nil)

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

@@ -20,7 +20,9 @@ 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. This value must be between 8 and 64 characters long.
+              #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @return [ChallengeList] ChallengeList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -236,10 +238,10 @@ module Twilio
               # Initialize the ChallengeContext
               # @param [Version] version Version that contains the resource
               # @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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Challenges. This identifier should be immutable, not PII, length between 8 and
+              #   64 characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   Challenge.
               # @return [ChallengeContext] ChallengeContext
@@ -331,7 +333,9 @@ 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. This value must be between 8 and 64 characters long.
+              #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @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

@@ -19,10 +19,10 @@ module Twilio
               # Initialize the FactorList
               # @param [Version] version Version that contains the resource
               # @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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @return [FactorList] FactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -163,7 +163,9 @@ 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. This value must be between 8 and 64 characters long.
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @param [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorContext] FactorContext
               def initialize(version, service_sid, identity, sid)
@@ -264,10 +266,10 @@ module Twilio
               # @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 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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @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)

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

@@ -19,10 +19,10 @@ module Twilio
               # Initialize the NewFactorList
               # @param [Version] version Version that contains the resource
               # @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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @return [NewFactorList] NewFactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -175,10 +175,10 @@ module Twilio
               # @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 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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @return [NewFactorInstance] NewFactorInstance
               def initialize(version, payload, service_sid: nil, identity: nil)
                 super(version)

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

@@ -32,7 +32,7 @@ module Twilio
             # @param [String] identity The unique external identifier for the Entity of the
             #   Service. This identifier should be immutable, not PII, length between 8 and 64
             #   characters, and generated by your external system, such as your user's UUID,
-            #   GUID, or SID.
+            #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
             # @return [EntityInstance] Created EntityInstance
             def create(identity: nil)
               data = Twilio::Values.of({'Identity' => identity, })
@@ -168,7 +168,9 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The unique SID identifier of the Service.
             # @param [String] identity The unique external identifier for the Entity of the
-            #   Service
+            #   Service. This identifier should be immutable, not PII, length between 8 and 64
+            #   characters, and generated by your external system, such as your user's UUID,
+            #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
             # @return [EntityContext] EntityContext
             def initialize(version, service_sid, identity)
               super(version)
@@ -288,7 +290,9 @@ 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 The unique external identifier for the Entity of the
-            #   Service
+            #   Service. This identifier should be immutable, not PII, length between 8 and 64
+            #   characters, and generated by your external system, such as your user's UUID,
+            #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
             # @return [EntityInstance] EntityInstance
             def initialize(version, payload, service_sid: nil, identity: nil)
               super(version)

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

@@ -33,7 +33,8 @@ module Twilio
             #   {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`.
+            #   {`email`}[https://www.twilio.com/docs/verify/email], `sms`, `whatsapp` 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
@@ -42,10 +43,11 @@ module Twilio
             #   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].
-            # @param [String] locale The locale to use for the verification SMS or call. Can
-            #   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] locale The locale to use for the verification SMS, WhatsApp or
+            #   call. Can 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.

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

@@ -0,0 +1,206 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class TemplateList < ListResource
+          ##
+          # Initialize the TemplateList
+          # @param [Version] version Version that contains the resource
+          # @return [TemplateList] TemplateList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Templates"
+          end
+
+          ##
+          # Lists TemplateInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @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(friendly_name: :unset, limit: nil, page_size: nil)
+            self.stream(friendly_name: friendly_name, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams TemplateInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @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(friendly_name: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields TemplateInstance 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 TemplateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @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 TemplateInstance
+          def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            TemplatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of TemplateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of TemplateInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            TemplatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V2.TemplateList>'
+          end
+        end
+
+        class TemplatePage < Page
+          ##
+          # Initialize the TemplatePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [TemplatePage] TemplatePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of TemplateInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [TemplateInstance] TemplateInstance
+          def get_instance(payload)
+            TemplateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V2.TemplatePage>'
+          end
+        end
+
+        class TemplateInstance < InstanceResource
+          ##
+          # Initialize the TemplateInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [TemplateInstance] TemplateInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'translations' => payload['translations'],
+            }
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Template
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Account Sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A string to describe the verification template
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [Hash] Ojbect with the template translations.
+          def translations
+            @properties['translations']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Verify.V2.TemplateInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Verify.V2.TemplateInstance>"
+          end
+        end
+      end
+    end
+  end
+end