twilio-ruby 5.63.1 → 5.65.1

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

@@ -39,16 +39,23 @@ module Twilio
           #   in Megabytes that each Sim resource assigned to the Fleet resource can consume
           #   during a billing period (normally one month). Value must be between 1MB (1) and
           #   2TB (2,000,000). Defaults to 1GB (1,000).
-          # @param [Boolean] commands_enabled Defines whether SIMs in the Fleet are capable
-          #   of sending and receiving machine-to-machine SMS via Commands. Defaults to
-          #   `true`.
-          # @param [String] commands_url The URL that will receive a webhook when a Super
-          #   SIM in the Fleet is used to send an SMS from your device to the Commands number.
-          #   Your server should respond with an HTTP status code in the 200 range; any
-          #   response body will be ignored.
-          # @param [String] commands_method A string representing the HTTP method to use
-          #   when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults
-          #   to `POST`.
+          # @param [Boolean] commands_enabled Deprecated. Use `sms_commands_enabled`
+          #   instead. Defines whether SIMs in the Fleet are capable of sending and receiving
+          #   machine-to-machine SMS via Commands. Defaults to `true`.
+          # @param [String] commands_url Deprecated. Use `sms_commands_url` instead. The URL
+          #   that will receive a webhook when a Super SIM in the Fleet is used to send an SMS
+          #   from your device to the Commands number. Your server should respond with an HTTP
+          #   status code in the 200 range; any response body will be ignored.
+          # @param [String] commands_method Deprecated. Use `sms_commands_method` instead. A
+          #   string representing the HTTP method to use when making a request to
+          #   `commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+          # @param [String] ip_commands_url The URL that will receive a webhook when a Super
+          #   SIM in the Fleet is used to send an IP Command from your device to a special IP
+          #   address. Your server should respond with an HTTP status code in the 200 range;
+          #   any response body will be ignored.
+          # @param [String] ip_commands_method A string representing the HTTP method to use
+          #   when making a request to `ip_commands_url`. Can be one of `POST` or `GET`.
+          #   Defaults to `POST`.
           # @param [Boolean] sms_commands_enabled Defines whether SIMs in the Fleet are
           #   capable of sending and receiving machine-to-machine SMS via Commands. Defaults
           #   to `true`.
@@ -60,7 +67,7 @@ module Twilio
           #   when making a request to `sms_commands_url`. Can be one of `POST` or `GET`.
           #   Defaults to `POST`.
           # @return [FleetInstance] Created FleetInstance
-          def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
+          def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
             data = Twilio::Values.of({
                 'NetworkAccessProfile' => network_access_profile,
                 'UniqueName' => unique_name,
@@ -69,6 +76,8 @@ module Twilio
                 'CommandsEnabled' => commands_enabled,
                 'CommandsUrl' => commands_url,
                 'CommandsMethod' => commands_method,
+                'IpCommandsUrl' => ip_commands_url,
+                'IpCommandsMethod' => ip_commands_method,
                 'SmsCommandsEnabled' => sms_commands_enabled,
                 'SmsCommandsUrl' => sms_commands_url,
                 'SmsCommandsMethod' => sms_commands_method,
@@ -244,13 +253,20 @@ module Twilio
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that will control which cellular networks the Fleet's SIMs can
           #   connect to.
-          # @param [String] commands_url The URL that will receive a webhook when a Super
-          #   SIM in the Fleet is used to send an SMS from your device to the Commands number.
-          #   Your server should respond with an HTTP status code in the 200 range; any
-          #   response body will be ignored.
-          # @param [String] commands_method A string representing the HTTP method to use
-          #   when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults
-          #   to `POST`.
+          # @param [String] commands_url Deprecated. Use `sms_commands_url` instead. The URL
+          #   that will receive a webhook when a Super SIM in the Fleet is used to send an SMS
+          #   from your device to the Commands number. Your server should respond with an HTTP
+          #   status code in the 200 range; any response body will be ignored.
+          # @param [String] commands_method Deprecated. Use `sms_commands_method` instead. A
+          #   string representing the HTTP method to use when making a request to
+          #   `commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+          # @param [String] ip_commands_url The URL that will receive a webhook when a Super
+          #   SIM in the Fleet is used to send an IP Command from your device to a special IP
+          #   address. Your server should respond with an HTTP status code in the 200 range;
+          #   any response body will be ignored.
+          # @param [String] ip_commands_method A string representing the HTTP method to use
+          #   when making a request to `ip_commands_url`. Can be one of `POST` or `GET`.
+          #   Defaults to `POST`.
           # @param [String] sms_commands_url The URL that will receive a webhook when a
           #   Super SIM in the Fleet is used to send an SMS from your device to the SMS
           #   Commands number. Your server should respond with an HTTP status code in the 200
@@ -259,12 +275,14 @@ module Twilio
           #   when making a request to `sms_commands_url`. Can be one of `POST` or `GET`.
           #   Defaults to `POST`.
           # @return [FleetInstance] Updated FleetInstance
-          def update(unique_name: :unset, network_access_profile: :unset, commands_url: :unset, commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
+          def update(unique_name: :unset, network_access_profile: :unset, commands_url: :unset, commands_method: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
             data = Twilio::Values.of({
                 'UniqueName' => unique_name,
                 'NetworkAccessProfile' => network_access_profile,
                 'CommandsUrl' => commands_url,
                 'CommandsMethod' => commands_method,
+                'IpCommandsUrl' => ip_commands_url,
+                'IpCommandsMethod' => ip_commands_method,
                 'SmsCommandsUrl' => sms_commands_url,
                 'SmsCommandsMethod' => sms_commands_method,
             })
@@ -319,6 +337,8 @@ module Twilio
                 'sms_commands_url' => payload['sms_commands_url'],
                 'sms_commands_method' => payload['sms_commands_method'],
                 'network_access_profile_sid' => payload['network_access_profile_sid'],
+                'ip_commands_url' => payload['ip_commands_url'],
+                'ip_commands_method' => payload['ip_commands_method'],
             }
 
             # Context
@@ -392,19 +412,19 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
+          # @return [Boolean] Deprecated
           def commands_enabled
             @properties['commands_enabled']
           end
 
           ##
-          # @return [String] The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the Commands number
+          # @return [String] Deprecated
           def commands_url
             @properties['commands_url']
           end
 
           ##
-          # @return [String] A string representing the HTTP method to use when making a request to `commands_url`
+          # @return [String] Deprecated
           def commands_method
             @properties['commands_method']
           end
@@ -433,6 +453,18 @@ module Twilio
             @properties['network_access_profile_sid']
           end
 
+          ##
+          # @return [String] The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device
+          def ip_commands_url
+            @properties['ip_commands_url']
+          end
+
+          ##
+          # @return [String] A string representing the HTTP method to use when making a request to `ip_commands_url`
+          def ip_commands_method
+            @properties['ip_commands_method']
+          end
+
           ##
           # Fetch the FleetInstance
           # @return [FleetInstance] Fetched FleetInstance
@@ -448,13 +480,20 @@ module Twilio
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that will control which cellular networks the Fleet's SIMs can
           #   connect to.
-          # @param [String] commands_url The URL that will receive a webhook when a Super
-          #   SIM in the Fleet is used to send an SMS from your device to the Commands number.
-          #   Your server should respond with an HTTP status code in the 200 range; any
-          #   response body will be ignored.
-          # @param [String] commands_method A string representing the HTTP method to use
-          #   when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults
-          #   to `POST`.
+          # @param [String] commands_url Deprecated. Use `sms_commands_url` instead. The URL
+          #   that will receive a webhook when a Super SIM in the Fleet is used to send an SMS
+          #   from your device to the Commands number. Your server should respond with an HTTP
+          #   status code in the 200 range; any response body will be ignored.
+          # @param [String] commands_method Deprecated. Use `sms_commands_method` instead. A
+          #   string representing the HTTP method to use when making a request to
+          #   `commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+          # @param [String] ip_commands_url The URL that will receive a webhook when a Super
+          #   SIM in the Fleet is used to send an IP Command from your device to a special IP
+          #   address. Your server should respond with an HTTP status code in the 200 range;
+          #   any response body will be ignored.
+          # @param [String] ip_commands_method A string representing the HTTP method to use
+          #   when making a request to `ip_commands_url`. Can be one of `POST` or `GET`.
+          #   Defaults to `POST`.
           # @param [String] sms_commands_url The URL that will receive a webhook when a
           #   Super SIM in the Fleet is used to send an SMS from your device to the SMS
           #   Commands number. Your server should respond with an HTTP status code in the 200
@@ -463,12 +502,14 @@ module Twilio
           #   when making a request to `sms_commands_url`. Can be one of `POST` or `GET`.
           #   Defaults to `POST`.
           # @return [FleetInstance] Updated FleetInstance
-          def update(unique_name: :unset, network_access_profile: :unset, commands_url: :unset, commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
+          def update(unique_name: :unset, network_access_profile: :unset, commands_url: :unset, commands_method: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
             context.update(
                 unique_name: unique_name,
                 network_access_profile: network_access_profile,
                 commands_url: commands_url,
                 commands_method: commands_method,
+                ip_commands_url: ip_commands_url,
+                ip_commands_method: ip_commands_method,
                 sms_commands_url: sms_commands_url,
                 sms_commands_method: sms_commands_method,
             )

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

@@ -28,7 +28,7 @@ module Twilio
           ##
           # Create the SmsCommandInstance
           # @param [String] sim The `sid` or `unique_name` of the
-          #   {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the SMS
+          #   {SIM}[https://www.twilio.com/docs/iot/supersim/api/sim-resource] to send the SMS
           #   Command to.
           # @param [String] payload The message body of the SMS Command.
           # @param [String] callback_method The HTTP method we should use to call

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

@@ -49,9 +49,9 @@ module Twilio
           # @param [Time] start_time Only include usage that occurred at or after this time,
           #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
           #   is one month before the `end_time`.
-          # @param [Time] end_time Only include usage that occurred before this time,
-          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
-          #   is the current time.
+          # @param [Time] end_time Only include usage that occurred before this time
+          #   (exclusive), specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format. Default is the current time.
           # @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
@@ -98,9 +98,9 @@ module Twilio
           # @param [Time] start_time Only include usage that occurred at or after this time,
           #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
           #   is one month before the `end_time`.
-          # @param [Time] end_time Only include usage that occurred before this time,
-          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
-          #   is the current time.
+          # @param [Time] end_time Only include usage that occurred before this time
+          #   (exclusive), specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format. Default is the current time.
           # @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
@@ -163,9 +163,9 @@ module Twilio
           # @param [Time] start_time Only include usage that occurred at or after this time,
           #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
           #   is one month before the `end_time`.
-          # @param [Time] end_time Only include usage that occurred before this time,
-          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
-          #   is the current time.
+          # @param [Time] end_time Only include usage that occurred before this time
+          #   (exclusive), specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format. Default is the current time.
           # @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

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

@@ -36,12 +36,15 @@ module Twilio
             #   `push`
             # @param [String] factor_friendly_name The friendly name of the factor that is
             #   going to be created with this access token
+            # @param [String] ttl How long, in seconds, the access token is valid. Can be an
+            #   integer between 60 and 300. Default is 60.
             # @return [AccessTokenInstance] Created AccessTokenInstance
-            def create(identity: nil, factor_type: nil, factor_friendly_name: :unset)
+            def create(identity: nil, factor_type: nil, factor_friendly_name: :unset, ttl: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
                   'FactorType' => factor_type,
                   'FactorFriendlyName' => factor_friendly_name,
+                  'Ttl' => ttl,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -158,6 +161,8 @@ module Twilio
                   'factor_friendly_name' => payload['factor_friendly_name'],
                   'token' => payload['token'],
                   'url' => payload['url'],
+                  'ttl' => payload['ttl'].to_i,
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
               }
 
               # Context
@@ -224,6 +229,18 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] How long, in seconds, the access token is valid.
+            def ttl
+              @properties['ttl']
+            end
+
+            ##
+            # @return [Time] The date this access token was created
+            def date_created
+              @properties['date_created']
+            end
+
             ##
             # Fetch the AccessTokenInstance
             # @return [AccessTokenInstance] Fetched AccessTokenInstance

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

@@ -277,9 +277,16 @@ module Twilio
               #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
               #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
               #   characters in length
+              # @param [Hash] metadata Custom metadata associated with the challenge. This is
+              #   added by the Device/SDK directly to allow for the inclusion of device
+              #   information. It must be a stringified JSON with only strings values eg. `{"os":
+              #   "Android"}`. Can be up to 1024 characters in length.
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset)
-                data = Twilio::Values.of({'AuthPayload' => auth_payload, })
+              def update(auth_payload: :unset, metadata: :unset)
+                data = Twilio::Values.of({
+                    'AuthPayload' => auth_payload,
+                    'Metadata' => Twilio.serialize_object(metadata),
+                })
 
                 payload = @version.update('POST', @uri, data: data)
 
@@ -358,6 +365,7 @@ module Twilio
                     'responded_reason' => payload['responded_reason'],
                     'details' => payload['details'],
                     'hidden_details' => payload['hidden_details'],
+                    'metadata' => payload['metadata'],
                     'factor_type' => payload['factor_type'],
                     'url' => payload['url'],
                     'links' => payload['links'],
@@ -468,6 +476,12 @@ module Twilio
                 @properties['hidden_details']
               end
 
+              ##
+              # @return [Hash] Metadata of the challenge.
+              def metadata
+                @properties['metadata']
+              end
+
               ##
               # @return [challenge.FactorTypes] The Factor Type of this Challenge
               def factor_type
@@ -499,9 +513,13 @@ module Twilio
               #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
               #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
               #   characters in length
+              # @param [Hash] metadata Custom metadata associated with the challenge. This is
+              #   added by the Device/SDK directly to allow for the inclusion of device
+              #   information. It must be a stringified JSON with only strings values eg. `{"os":
+              #   "Android"}`. Can be up to 1024 characters in length.
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset)
-                context.update(auth_payload: auth_payload, )
+              def update(auth_payload: :unset, metadata: :unset)
+                context.update(auth_payload: auth_payload, metadata: metadata, )
               end
 
               ##

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

@@ -293,6 +293,7 @@ module Twilio
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
                     'config' => payload['config'],
+                    'metadata' => payload['metadata'],
                     'url' => payload['url'],
                 }
 
@@ -383,6 +384,12 @@ module Twilio
                 @properties['config']
               end
 
+              ##
+              # @return [Hash] Metadata of the factor.
+              def metadata
+                @properties['metadata']
+              end
+
               ##
               # @return [String] The URL of this resource.
               def url

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

@@ -41,9 +41,7 @@ module Twilio
               #   constructing the `binding.uri` property.
               #   At the same time, we recommend avoiding providing PII.
               # @param [new_factor.FactorTypes] factor_type The Type of this Factor. Currently
-              #   `push` and `totp` are supported. For `totp` to work, you need to contact {Twilio
-              #   sales}[https://www.twilio.com/help/sales] first to have the Verify TOTP feature
-              #   enabled for your Twilio account.
+              #   `push` and `totp` are supported.
               # @param [String] binding_alg The algorithm used when `factor_type` is `push`.
               #   Algorithm supported: `ES256`
               # @param [String] binding_public_key The Ecdsa public key in PKIX, ASN.1 DER
@@ -96,8 +94,12 @@ module Twilio
               #   TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`.
               #
               #   Used when `factor_type` is `totp`
+              # @param [Hash] metadata Custom metadata associated with the factor. This is added
+              #   by the Device/SDK directly to allow for the inclusion of device information. It
+              #   must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can
+              #   be up to 1024 characters in length.
               # @return [NewFactorInstance] Created NewFactorInstance
-              def create(friendly_name: nil, factor_type: nil, binding_alg: :unset, binding_public_key: :unset, config_app_id: :unset, config_notification_platform: :unset, config_notification_token: :unset, config_sdk_version: :unset, binding_secret: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+              def create(friendly_name: nil, factor_type: nil, binding_alg: :unset, binding_public_key: :unset, config_app_id: :unset, config_notification_platform: :unset, config_notification_token: :unset, config_sdk_version: :unset, binding_secret: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, metadata: :unset)
                 data = Twilio::Values.of({
                     'FriendlyName' => friendly_name,
                     'FactorType' => factor_type,
@@ -112,6 +114,7 @@ module Twilio
                     'Config.Skew' => config_skew,
                     'Config.CodeLength' => config_code_length,
                     'Config.Alg' => config_alg,
+                    'Metadata' => Twilio.serialize_object(metadata),
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -197,6 +200,7 @@ module Twilio
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
                     'config' => payload['config'],
+                    'metadata' => payload['metadata'],
                     'url' => payload['url'],
                 }
               end
@@ -232,7 +236,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] Unique external identifier of the Entity
+              # @return [Hash] Binding of the factor
               def binding
                 @properties['binding']
               end
@@ -268,11 +272,17 @@ module Twilio
               end
 
               ##
-              # @return [Hash] Binding for a `factor_type`.
+              # @return [Hash] Configurations for a `factor_type`.
               def config
                 @properties['config']
               end
 
+              ##
+              # @return [Hash] Metadata of the factor.
+              def metadata
+                @properties['metadata']
+              end
+
               ##
               # @return [String] The URL of this resource.
               def url

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

@@ -183,7 +183,7 @@ module Twilio
           end
 
           ##
-          # @return [Hash] Ojbect with the template translations.
+          # @return [Hash] Object with the template translations.
           def translations
             @properties['translations']
           end