twilio-ruby 5.52.0 → 5.56.0

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/sim.rb

@@ -30,7 +30,7 @@ module Twilio
           # @param [String] iccid The
           #   {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID] of the
           #   Super SIM to be added to your Account.
-          # @param [String] registration_code The 10 digit code required to claim the Super
+          # @param [String] registration_code The 10-digit code required to claim the Super
           #   SIM for your Account.
           # @return [SimInstance] Created SimInstance
           def create(iccid: nil, registration_code: nil)
@@ -200,6 +200,9 @@ module Twilio
             # Path Solution
             @solution = {sid: sid, }
             @uri = "/Sims/#{@solution[:sid]}"
+
+            # Dependents
+            @billing_periods = nil
           end
 
           ##
@@ -246,6 +249,18 @@ module Twilio
             SimInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Access the billing_periods
+          # @return [BillingPeriodList]
+          # @return [BillingPeriodContext]
+          def billing_periods
+            unless @billing_periods
+              @billing_periods = BillingPeriodList.new(@version, sim_sid: @solution[:sid], )
+            end
+
+            @billing_periods
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -284,6 +299,7 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
+                'links' => payload['links'],
             }
 
             # Context
@@ -356,6 +372,12 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
           ##
           # Fetch the SimInstance
           # @return [SimInstance] Fetched SimInstance
@@ -394,6 +416,13 @@ module Twilio
             )
           end
 
+          ##
+          # Access the billing_periods
+          # @return [billing_periods] billing_periods
+          def billing_periods
+            context.billing_periods
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb

@@ -0,0 +1,231 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        class SimContext < InstanceContext
+          class BillingPeriodList < ListResource
+            ##
+            # Initialize the BillingPeriodList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodList] BillingPeriodList
+            def initialize(version, sim_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sim_sid: sim_sid}
+              @uri = "/Sims/#{@solution[:sim_sid]}/BillingPeriods"
+            end
+
+            ##
+            # Lists BillingPeriodInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    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(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams BillingPeriodInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    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(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields BillingPeriodInstance 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 BillingPeriodInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] page_token PageToken provided by the API
+            # @param [Integer] page_number Page Number, this value is simply for client state
+            # @param [Integer] page_size Number of records to return, defaults to 50
+            # @return [Page] Page of BillingPeriodInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of BillingPeriodInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of BillingPeriodInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Supersim.V1.BillingPeriodList>'
+            end
+          end
+
+          class BillingPeriodPage < Page
+            ##
+            # Initialize the BillingPeriodPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [BillingPeriodPage] BillingPeriodPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BillingPeriodInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def get_instance(payload)
+              BillingPeriodInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Supersim.V1.BillingPeriodPage>'
+            end
+          end
+
+          class BillingPeriodInstance < InstanceResource
+            ##
+            # Initialize the BillingPeriodInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def initialize(version, payload, sim_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'sim_sid' => payload['sim_sid'],
+                  'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                  'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                  'period_type' => payload['period_type'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] The SID of the Billing Period
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account the Super SIM belongs to
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The SID of the Super SIM the Billing Period belongs to
+            def sim_sid
+              @properties['sim_sid']
+            end
+
+            ##
+            # @return [Time] The start time of the Billing Period
+            def start_time
+              @properties['start_time']
+            end
+
+            ##
+            # @return [Time] The end time of the Billing Period
+            def end_time
+              @properties['end_time']
+            end
+
+            ##
+            # @return [billing_period.BpType] The type of the Billing Period
+            def period_type
+              @properties['period_type']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -38,16 +38,21 @@ module Twilio
               #   is five (5) minutes after Challenge creation. The max value is sixty (60)
               #   minutes after creation.
               # @param [String] details_message Shown to the user when the push notification
-              #   arrives. Required when `factor_type` is `push`
+              #   arrives. Required when `factor_type` is `push`. Can be up to 256 characters in
+              #   length
               # @param [Array[Hash]] details_fields A list of objects that describe the Fields
               #   included in the Challenge. Each object contains the label and value of the
-              #   field. Used when `factor_type` is `push`.
+              #   field, the label can be up to 36 characters in length and the value can be up to
+              #   128 characters in length. Used when `factor_type` is `push`. There can be up to
+              #   20 details fields.
               # @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"}`
+              #   strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in
+              #   length
               # @param [String] auth_payload Optional payload used to verify the Challenge upon
-              #   creation. Only used with a Factor of type `totp` to carry an OTP used in the
-              #   verification.
+              #   creation. Only used with a Factor of type `totp` to carry the TOTP code that
+              #   needs to be verified. For `TOTP` this value must be between 3 and 8 characters
+              #   long.
               # @return [ChallengeInstance] Created ChallengeInstance
               def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
                 data = Twilio::Values.of({
@@ -246,7 +251,9 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   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
               # @return [ChallengeInstance] Updated ChallengeInstance
               def update(auth_payload: :unset)
                 data = Twilio::Values.of({'AuthPayload' => auth_payload, })
@@ -464,7 +471,9 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   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
               # @return [ChallengeInstance] Updated ChallengeInstance
               def update(auth_payload: :unset)
                 context.update(auth_payload: auth_payload, )

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

@@ -34,11 +34,10 @@ module Twilio
 
                 ##
                 # 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.
+                # @param [String] ttl How long, in seconds, the notification is valid. Can be an
+                #   integer between 0 and 300. Default is 300. Delivery is attempted until the TTL
+                #   elapses, even if the device is offline. 0 means that the notification delivery
+                #   is attempted immediately, only once, and is not stored for future delivery.
                 # @return [NotificationInstance] Created NotificationInstance
                 def create(ttl: :unset)
                   data = Twilio::Values.of({'Ttl' => ttl, })
@@ -164,13 +163,13 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The priority of the Notification.
+                # @return [String] The priority of the notification.
                 def priority
                   @properties['priority']
                 end
 
                 ##
-                # @return [String] How long, in seconds, the Notification is valid.
+                # @return [String] How long, in seconds, the notification is valid.
                 def ttl
                   @properties['ttl']
                 end

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

@@ -34,43 +34,68 @@ module Twilio
 
               ##
               # Create the NewFactorInstance
-              # @param [String] friendly_name The friendly name of this Factor. It can be up to
-              #   64 characters.
+              # @param [String] friendly_name The friendly name of this Factor. This can be any
+              #   string up to 64 characters, meant for humans to distinguish between Factors.
+              #   For `factor_type` `push`, this could be a device name.
+              #   For `factor_type` `totp`, this value is used as the “account name” in
+              #   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 first to have the Verify TOTP feature enabled for your Twilio account.
+              #   `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.
               # @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
-              #   format encoded in Base64
+              #   format encoded in Base64.
+              #
+              #   Required when `factor_type` is `push`
               # @param [String] config_app_id The ID that uniquely identifies your app in the
-              #   Google or Apple store, such as `com.example.myapp`. Required when `factor_type`
-              #   is `push`. If specified, it can be up to 100 characters long.
+              #   Google or Apple store, such as `com.example.myapp`. It can be up to 100
+              #   characters long.
+              #
+              #   Required when `factor_type` is `push`.
               # @param [new_factor.NotificationPlatforms] config_notification_platform The
               #   transport technology used to generate the Notification Token. Can be `apn` or
-              #   `fcm`. Required when `factor_type` is `push`
+              #   `fcm`.
+              #
+              #   Required when `factor_type` is `push`.
               # @param [String] config_notification_token For APN, the device token. For FCM the
-              #   registration token. It used to send the push notifications. Required when
-              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
-              #   characters long.
+              #   registration token. It used to send the push notifications. Must be between 32
+              #   and 255 characters long.
+              #
+              #   Required when `factor_type` is `push`.
               # @param [String] config_sdk_version The Verify Push SDK version used to configure
               #   the factor
+              #
+              #   Required when `factor_type` is `push`
               # @param [String] binding_secret The shared secret for TOTP factors encoded in
-              #   Base32
+              #   Base32. This can be provided when creating the Factor, otherwise it will be
+              #   generated.
+              #
+              #   Used when `factor_type` is `totp`
               # @param [String] config_time_step 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. The default value is defined at the
-              #   service level in the property totp.time_step. If not configured defaults to 30
-              #   seconds
+              #   service level in the property `totp.time_step`. Defaults to 30 seconds if not
+              #   configured.
+              #
+              #   Used when `factor_type` is `totp`
               # @param [String] config_skew The number of time-steps, past and future, that are
               #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The
-              #   default value is defined at the service level in the property totp.skew. If not
-              #   configured defaults to 1
+              #   default value is defined at the service level in the property `totp.skew`. If
+              #   not configured defaults to 1.
+              #
+              #   Used when `factor_type` is `totp`
               # @param [String] config_code_length Number of digits for generated TOTP codes.
               #   Must be between 3 and 8, inclusive. The default value is defined at the service
-              #   level in the property totp.code_length. If not configured defaults to 6
+              #   level in the property `totp.code_length`. If not configured defaults to 6.
+              #
+              #   Used when `factor_type` is `totp`
               # @param [new_factor.TotpAlgorithms] config_alg The algorithm used to derive the
-              #   TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`
+              #   TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`.
+              #
+              #   Used when `factor_type` is `totp`
               # @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)
                 data = Twilio::Values.of({