twilio-ruby 5.51.0 → 5.53.0

data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb

@@ -147,7 +147,7 @@ module Twilio
                   'us_app_to_person_usecase' => payload['us_app_to_person_usecase'],
                   'has_embedded_links' => payload['has_embedded_links'],
                   'has_embedded_phone' => payload['has_embedded_phone'],
-                  'status' => payload['status'],
+                  'campaign_status' => payload['campaign_status'],
                   'campaign_id' => payload['campaign_id'],
                   'is_externally_registered' => payload['is_externally_registered'],
                   'rate_limits' => payload['rate_limits'],
@@ -207,8 +207,8 @@ module Twilio
 
             ##
             # @return [String] Campaign status
-            def status
-              @properties['status']
+            def campaign_status
+              @properties['campaign_status']
             end
 
             ##

data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb

@@ -140,7 +140,7 @@ module Twilio
             #   available as variable `{{contact.channel.address}}`.
             # @param [String] from The Twilio phone number to send messages or initiate calls
             #   from during the Flow's Execution. Available as variable
-            #   `{{flow.channel.address}}`.
+            #   `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID.
             # @param [Hash] parameters JSON data that will be added to the Flow's context and
             #   that can be accessed as variables inside your Flow. For example, if you pass in
             #   `Parameters={"name":"Zeke"}`, a widget in your Flow can reference the variable

data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb

@@ -140,7 +140,7 @@ module Twilio
             #   available as variable `{{contact.channel.address}}`.
             # @param [String] from The Twilio phone number to send messages or initiate calls
             #   from during the Flow's Execution. Available as variable
-            #   `{{flow.channel.address}}`.
+            #   `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID.
             # @param [Hash] parameters JSON data that will be added to the Flow's context and
             #   that can be accessed as variables inside your Flow. For example, if you pass in
             #   `Parameters={"name":"Zeke"}`, a widget in your Flow can reference the variable

data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb

@@ -53,8 +53,8 @@ module Twilio
           # Lists SmsCommandInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] sim The SID or unique name of the Sim that SMS Command was sent
-          #   to or from.
+          # @param [String] sim The SID or unique name of the Sim resource that SMS Command
+          #   was sent to or from.
           # @param [sms_command.Status] status The status of the SMS Command. Can be:
           #   `queued`, `sent`, `delivered`, `received` or `failed`. See the {SMS Command
           #   Status
@@ -85,8 +85,8 @@ module Twilio
           # Streams SmsCommandInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] sim The SID or unique name of the Sim that SMS Command was sent
-          #   to or from.
+          # @param [String] sim The SID or unique name of the Sim resource that SMS Command
+          #   was sent to or from.
           # @param [sms_command.Status] status The status of the SMS Command. Can be:
           #   `queued`, `sent`, `delivered`, `received` or `failed`. See the {SMS Command
           #   Status
@@ -128,8 +128,8 @@ module Twilio
           ##
           # Retrieve a single page of SmsCommandInstance records from the API.
           # Request is executed immediately.
-          # @param [String] sim The SID or unique name of the Sim that SMS Command was sent
-          #   to or from.
+          # @param [String] sim The SID or unique name of the Sim resource that SMS Command
+          #   was sent to or from.
           # @param [sms_command.Status] status The status of the SMS Command. Can be:
           #   `queued`, `sent`, `delivered`, `received` or `failed`. See the {SMS Command
           #   Status

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

@@ -360,9 +360,16 @@ module Twilio
 
             ##
             # Delete the TaskInstance
+            # @param [String] if_match If provided, deletes this Task if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @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
 
             ##
@@ -623,9 +630,14 @@ module Twilio
 
             ##
             # Delete the TaskInstance
+            # @param [String] if_match If provided, deletes this Task if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @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/verify/v2/service.rb

@@ -60,8 +60,21 @@ module Twilio
           #   factors. Set the FCM Credential for this service. This will allow to send push
           #   notifications to Android devices. See {Credential
           #   Resource}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI. Defaults to the service friendly name if not provided.
+          # @param [String] totp_time_step Optional configuration for the TOTP factors.
+          #   Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is
+          #   generated every time_step seconds. Must be between 20 and 60 seconds, inclusive.
+          #   Defaults to 30 seconds
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew Optional configuration for the TOTP factors. The
+          #   number of time-steps, past and future, that are valid for validation of TOTP
+          #   codes. Must be between 0 and 2, inclusive. Defaults to 1
           # @return [ServiceInstance] Created ServiceInstance
-          def create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset)
+          def create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -75,6 +88,10 @@ module Twilio
                 'Push.IncludeDate' => push_include_date,
                 'Push.ApnCredentialSid' => push_apn_credential_sid,
                 'Push.FcmCredentialSid' => push_fcm_credential_sid,
+                'Totp.Issuer' => totp_issuer,
+                'Totp.TimeStep' => totp_time_step,
+                'Totp.CodeLength' => totp_code_length,
+                'Totp.Skew' => totp_skew,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -273,8 +290,21 @@ module Twilio
           #   factors. Set the FCM Credential for this service. This will allow to send push
           #   notifications to Android devices. See {Credential
           #   Resource}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI.
+          # @param [String] totp_time_step Optional configuration for the TOTP factors.
+          #   Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is
+          #   generated every time_step seconds. Must be between 20 and 60 seconds, inclusive.
+          #   Defaults to 30 seconds
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew Optional configuration for the TOTP factors. The
+          #   number of time-steps, past and future, that are valid for validation of TOTP
+          #   codes. Must be between 0 and 2, inclusive. Defaults to 1
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset)
+          def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -288,6 +318,10 @@ module Twilio
                 'Push.IncludeDate' => push_include_date,
                 'Push.ApnCredentialSid' => push_apn_credential_sid,
                 'Push.FcmCredentialSid' => push_fcm_credential_sid,
+                'Totp.Issuer' => totp_issuer,
+                'Totp.TimeStep' => totp_time_step,
+                'Totp.CodeLength' => totp_code_length,
+                'Totp.Skew' => totp_skew,
             })
 
             payload = @version.update('POST', @uri, data: data)
@@ -449,6 +483,7 @@ module Twilio
                 'do_not_share_warning_enabled' => payload['do_not_share_warning_enabled'],
                 'custom_code_enabled' => payload['custom_code_enabled'],
                 'push' => payload['push'],
+                'totp' => payload['totp'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -543,6 +578,12 @@ module Twilio
             @properties['push']
           end
 
+          ##
+          # @return [Hash] The service level configuration of factor TOTP type.
+          def totp
+            @properties['totp']
+          end
+
           ##
           # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
@@ -616,8 +657,21 @@ module Twilio
           #   factors. Set the FCM Credential for this service. This will allow to send push
           #   notifications to Android devices. See {Credential
           #   Resource}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI.
+          # @param [String] totp_time_step Optional configuration for the TOTP factors.
+          #   Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is
+          #   generated every time_step seconds. Must be between 20 and 60 seconds, inclusive.
+          #   Defaults to 30 seconds
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew Optional configuration for the TOTP factors. The
+          #   number of time-steps, past and future, that are valid for validation of TOTP
+          #   codes. Must be between 0 and 2, inclusive. Defaults to 1
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset)
+          def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset)
             context.update(
                 friendly_name: friendly_name,
                 code_length: code_length,
@@ -631,6 +685,10 @@ module Twilio
                 push_include_date: push_include_date,
                 push_apn_credential_sid: push_apn_credential_sid,
                 push_fcm_credential_sid: push_fcm_credential_sid,
+                totp_issuer: totp_issuer,
+                totp_time_step: totp_time_step,
+                totp_code_length: totp_code_length,
+                totp_skew: totp_skew,
             )
           end
 

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

@@ -45,14 +45,18 @@ module Twilio
               # @param [Hash] hidden_details Details provided to give context about the
               #   Challenge. Not shown to the end user. It must be a stringified JSON with only
               #   strings values eg. `{"ip": "172.168.1.234"}`
+              # @param [String] auth_payload Optional payload used to verify the Challenge upon
+              #   creation. Only used with a Factor of type `totp` to carry the TOTP code that
+              #   needs to be verified.
               # @return [ChallengeInstance] Created ChallengeInstance
-              def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset)
+              def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
                 data = Twilio::Values.of({
                     'FactorSid' => factor_sid,
                     'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
                     'Details.Message' => details_message,
                     'Details.Fields' => Twilio.serialize_list(details_fields) { |e| Twilio.serialize_object(e) },
                     'HiddenDetails' => Twilio.serialize_object(hidden_details),
+                    'AuthPayload' => auth_payload,
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -219,6 +223,9 @@ module Twilio
                 # Path Solution
                 @solution = {service_sid: service_sid, identity: identity, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges/#{@solution[:sid]}"
+
+                # Dependents
+                @notifications = nil
               end
 
               ##
@@ -255,6 +262,23 @@ module Twilio
                 )
               end
 
+              ##
+              # Access the notifications
+              # @return [NotificationList]
+              # @return [NotificationContext]
+              def notifications
+                unless @notifications
+                  @notifications = NotificationList.new(
+                      @version,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:sid],
+                  )
+                end
+
+                @notifications
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
@@ -304,6 +328,7 @@ module Twilio
                     'hidden_details' => payload['hidden_details'],
                     'factor_type' => payload['factor_type'],
                     'url' => payload['url'],
+                    'links' => payload['links'],
                 }
 
                 # Context
@@ -423,6 +448,12 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] Nested resource URLs.
+              def links
+                @properties['links']
+              end
+
               ##
               # Fetch the ChallengeInstance
               # @return [ChallengeInstance] Fetched ChallengeInstance
@@ -439,6 +470,13 @@ module Twilio
                 context.update(auth_payload: auth_payload, )
               end
 
+              ##
+              # Access the notifications
+              # @return [notifications] notifications
+              def notifications
+                context.notifications
+              end
+
               ##
               # Provide a user friendly representation
               def to_s

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

@@ -0,0 +1,202 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class EntityContext < InstanceContext
+            class ChallengeContext < InstanceContext
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationList < ListResource
+                ##
+                # Initialize the NotificationList
+                # @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.
+                # @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)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {service_sid: service_sid, identity: identity, challenge_sid: challenge_sid}
+                  @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges/#{@solution[:challenge_sid]}/Notifications"
+                end
+
+                ##
+                # Create the NotificationInstance
+                # @param [String] ttl How long, in seconds, the Notification is valid. Delivery
+                #   will be attempted if the device is offline until the TTL elapses. 0 means that
+                #   the notification delivery is attempted immediately, only once, and is not stored
+                #   for future delivery. Must be an integer between 0 and 300 seconds, inclusive.
+                #   Defaults to 300 seconds.
+                # @return [NotificationInstance] Created NotificationInstance
+                def create(ttl: :unset)
+                  data = Twilio::Values.of({'Ttl' => ttl, })
+
+                  payload = @version.create('POST', @uri, data: data)
+
+                  NotificationInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:challenge_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '#<Twilio.Verify.V2.NotificationList>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationPage < Page
+                ##
+                # Initialize the NotificationPage
+                # @param [Version] version Version that contains the resource
+                # @param [Response] response Response from the API
+                # @param [Hash] solution Path solution for the resource
+                # @return [NotificationPage] NotificationPage
+                def initialize(version, response, solution)
+                  super(version, response)
+
+                  # Path Solution
+                  @solution = solution
+                end
+
+                ##
+                # Build an instance of NotificationInstance
+                # @param [Hash] payload Payload response from the API
+                # @return [NotificationInstance] NotificationInstance
+                def get_instance(payload)
+                  NotificationInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:challenge_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '<Twilio.Verify.V2.NotificationPage>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationInstance < InstanceResource
+                ##
+                # Initialize the NotificationInstance
+                # @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 owner of the
+                #   Challenge. This value must be between 8 and 64 characters long.
+                # @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)
+                  super(version)
+
+                  # Marshaled Properties
+                  @properties = {
+                      'sid' => payload['sid'],
+                      'account_sid' => payload['account_sid'],
+                      'service_sid' => payload['service_sid'],
+                      'entity_sid' => payload['entity_sid'],
+                      'identity' => payload['identity'],
+                      'challenge_sid' => payload['challenge_sid'],
+                      'priority' => payload['priority'],
+                      'ttl' => payload['ttl'].to_i,
+                      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  }
+                end
+
+                ##
+                # @return [String] A string that uniquely identifies this Notification.
+                def sid
+                  @properties['sid']
+                end
+
+                ##
+                # @return [String] Account Sid.
+                def account_sid
+                  @properties['account_sid']
+                end
+
+                ##
+                # @return [String] Service Sid.
+                def service_sid
+                  @properties['service_sid']
+                end
+
+                ##
+                # @return [String] Entity Sid.
+                def entity_sid
+                  @properties['entity_sid']
+                end
+
+                ##
+                # @return [String] Unique external identifier of the Entity
+                def identity
+                  @properties['identity']
+                end
+
+                ##
+                # @return [String] Challenge Sid.
+                def challenge_sid
+                  @properties['challenge_sid']
+                end
+
+                ##
+                # @return [String] The priority of the Notification.
+                def priority
+                  @properties['priority']
+                end
+
+                ##
+                # @return [String] How long, in seconds, the Notification is valid.
+                def ttl
+                  @properties['ttl']
+                end
+
+                ##
+                # @return [Time] The date this Notification was created
+                def date_created
+                  @properties['date_created']
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  "<Twilio.Verify.V2.NotificationInstance>"
+                end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  "<Twilio.Verify.V2.NotificationInstance>"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end