twilio-ruby 5.40.3 → 5.74.1

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

@@ -11,7 +11,7 @@ module Twilio
     class Supersim < Domain
       class V1 < Version
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimList < ListResource
           ##
           # Initialize the SimList
@@ -25,6 +25,22 @@ module Twilio
             @uri = "/Sims"
           end
 
+          ##
+          # Create the SimInstance
+          # @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
+          #   SIM for your Account.
+          # @return [SimInstance] Created SimInstance
+          def create(iccid: nil, registration_code: nil)
+            data = Twilio::Values.of({'Iccid' => iccid, 'RegistrationCode' => registration_code, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            SimInstance.new(@version, payload, )
+          end
+
           ##
           # Lists SimInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
@@ -34,7 +50,7 @@ module Twilio
           # @param [String] fleet The SID or unique name of the Fleet to which a list of
           #   Sims are assigned.
           # @param [String] iccid The
-          #   [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID)
+          #   {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID]
           #   associated with a Super SIM to filter the list by. Passing this parameter will
           #   always return a list containing zero or one SIMs.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -57,7 +73,7 @@ module Twilio
           # @param [String] fleet The SID or unique name of the Fleet to which a list of
           #   Sims are assigned.
           # @param [String] iccid The
-          #   [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID)
+          #   {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID]
           #   associated with a Super SIM to filter the list by. Passing this parameter will
           #   always return a list containing zero or one SIMs.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -97,7 +113,7 @@ module Twilio
           # @param [String] fleet The SID or unique name of the Fleet to which a list of
           #   Sims are assigned.
           # @param [String] iccid The
-          #   [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID)
+          #   {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID]
           #   associated with a Super SIM to filter the list by. Passing this parameter will
           #   always return a list containing zero or one SIMs.
           # @param [String] page_token PageToken provided by the API
@@ -140,7 +156,7 @@ module Twilio
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimPage < Page
           ##
           # Initialize the SimPage
@@ -171,7 +187,7 @@ module Twilio
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimContext < InstanceContext
           ##
           # Initialize the SimContext
@@ -184,6 +200,10 @@ module Twilio
             # Path Solution
             @solution = {sid: sid, }
             @uri = "/Sims/#{@solution[:sid]}"
+
+            # Dependents
+            @billing_periods = nil
+            @sim_ip_addresses = nil
           end
 
           ##
@@ -201,8 +221,8 @@ module Twilio
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
           # @param [sim.StatusUpdate] status The new status of the resource. Can be:
-          #   `ready`, `active`, or `inactive`. See the [Super SIM Status
-          #   Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values)
+          #   `ready`, `active`, or `inactive`. See the {Super SIM Status
+          #   Values}[https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values]
           #   for more info.
           # @param [String] fleet The SID or unique name of the Fleet to which the SIM
           #   resource should be assigned.
@@ -230,6 +250,30 @@ 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
+
+          ##
+          # Access the sim_ip_addresses
+          # @return [SimIpAddressList]
+          # @return [SimIpAddressContext]
+          def sim_ip_addresses
+            unless @sim_ip_addresses
+              @sim_ip_addresses = SimIpAddressList.new(@version, sim_sid: @solution[:sid], )
+            end
+
+            @sim_ip_addresses
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -246,7 +290,7 @@ module Twilio
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimInstance < InstanceResource
           ##
           # Initialize the SimInstance
@@ -268,6 +312,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
@@ -340,6 +385,12 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
           ##
           # Fetch the SimInstance
           # @return [SimInstance] Fetched SimInstance
@@ -353,8 +404,8 @@ module Twilio
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
           # @param [sim.StatusUpdate] status The new status of the resource. Can be:
-          #   `ready`, `active`, or `inactive`. See the [Super SIM Status
-          #   Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values)
+          #   `ready`, `active`, or `inactive`. See the {Super SIM Status
+          #   Values}[https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values]
           #   for more info.
           # @param [String] fleet The SID or unique name of the Fleet to which the SIM
           #   resource should be assigned.
@@ -378,6 +429,20 @@ module Twilio
             )
           end
 
+          ##
+          # Access the billing_periods
+          # @return [billing_periods] billing_periods
+          def billing_periods
+            context.billing_periods
+          end
+
+          ##
+          # Access the sim_ip_addresses
+          # @return [sim_ip_addresses] sim_ip_addresses
+          def sim_ip_addresses
+            context.sim_ip_addresses
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/supersim/v1/{command.rb → sms_command.rb}

@@ -11,56 +11,57 @@ module Twilio
     class Supersim < Domain
       class V1 < Version
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class CommandList < ListResource
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SmsCommandList < ListResource
           ##
-          # Initialize the CommandList
+          # Initialize the SmsCommandList
           # @param [Version] version Version that contains the resource
-          # @return [CommandList] CommandList
+          # @return [SmsCommandList] SmsCommandList
           def initialize(version)
             super(version)
 
             # Path Solution
             @solution = {}
-            @uri = "/Commands"
+            @uri = "/SmsCommands"
           end
 
           ##
-          # Create the CommandInstance
+          # 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 Command
-          #   to.
-          # @param [String] command The message body of the command.
+          #   {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
           #   `callback_url`. Can be: `GET` or `POST` and the default is POST.
           # @param [String] callback_url The URL we should call using the `callback_method`
           #   after we have sent the command.
-          # @return [CommandInstance] Created CommandInstance
-          def create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset)
+          # @return [SmsCommandInstance] Created SmsCommandInstance
+          def create(sim: nil, payload: nil, callback_method: :unset, callback_url: :unset)
             data = Twilio::Values.of({
                 'Sim' => sim,
-                'Command' => command,
+                'Payload' => payload,
                 'CallbackMethod' => callback_method,
                 'CallbackUrl' => callback_url,
             })
 
             payload = @version.create('POST', @uri, data: data)
 
-            CommandInstance.new(@version, payload, )
+            SmsCommandInstance.new(@version, payload, )
           end
 
           ##
-          # Lists CommandInstance records from the API as a list.
+          # 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 Command was sent to
-          #   or from.
-          # @param [command.Status] status The status of the Command. Can be: `queued`,
-          #   `sent`, `delivered`, `received` or `failed`. See the [Command Status
-          #   Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values)
+          # @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
+          #   Values}[https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
-          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          # @param [sms_command.Direction] direction The direction of the SMS Command. Can
+          #   be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
           #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
           #   originated`.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -81,17 +82,18 @@ module Twilio
           end
 
           ##
-          # Streams CommandInstance records from the API as an Enumerable.
+          # 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 Command was sent to
-          #   or from.
-          # @param [command.Status] status The status of the Command. Can be: `queued`,
-          #   `sent`, `delivered`, `received` or `failed`. See the [Command Status
-          #   Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values)
+          # @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
+          #   Values}[https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
-          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          # @param [sms_command.Direction] direction The direction of the SMS Command. Can
+          #   be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
           #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
           #   originated`.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -110,7 +112,7 @@ module Twilio
           end
 
           ##
-          # When passed a block, yields CommandInstance records from the API.
+          # When passed a block, yields SmsCommandInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           def each
@@ -124,22 +126,23 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
+          # 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 Command was sent to
-          #   or from.
-          # @param [command.Status] status The status of the Command. Can be: `queued`,
-          #   `sent`, `delivered`, `received` or `failed`. See the [Command Status
-          #   Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values)
+          # @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
+          #   Values}[https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
-          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          # @param [sms_command.Direction] direction The direction of the SMS Command. Can
+          #   be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
           #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
           #   originated`.
           # @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 CommandInstance
+          # @return [Page] Page of SmsCommandInstance
           def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'Sim' => sim,
@@ -152,38 +155,38 @@ module Twilio
 
             response = @version.page('GET', @uri, params: params)
 
-            CommandPage.new(@version, response, @solution)
+            SmsCommandPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
+          # Retrieve a single page of SmsCommandInstance records from the API.
           # Request is executed immediately.
           # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of CommandInstance
+          # @return [Page] Page of SmsCommandInstance
           def get_page(target_url)
             response = @version.domain.request(
                 'GET',
                 target_url
             )
-            CommandPage.new(@version, response, @solution)
+            SmsCommandPage.new(@version, response, @solution)
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Supersim.V1.CommandList>'
+            '#<Twilio.Supersim.V1.SmsCommandList>'
           end
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class CommandPage < Page
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SmsCommandPage < Page
           ##
-          # Initialize the CommandPage
+          # Initialize the SmsCommandPage
           # @param [Version] version Version that contains the resource
           # @param [Response] response Response from the API
           # @param [Hash] solution Path solution for the resource
-          # @return [CommandPage] CommandPage
+          # @return [SmsCommandPage] SmsCommandPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -192,69 +195,69 @@ module Twilio
           end
 
           ##
-          # Build an instance of CommandInstance
+          # Build an instance of SmsCommandInstance
           # @param [Hash] payload Payload response from the API
-          # @return [CommandInstance] CommandInstance
+          # @return [SmsCommandInstance] SmsCommandInstance
           def get_instance(payload)
-            CommandInstance.new(@version, payload, )
+            SmsCommandInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Supersim.V1.CommandPage>'
+            '<Twilio.Supersim.V1.SmsCommandPage>'
           end
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class CommandContext < InstanceContext
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SmsCommandContext < InstanceContext
           ##
-          # Initialize the CommandContext
+          # Initialize the SmsCommandContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The SID of the Command resource to fetch.
-          # @return [CommandContext] CommandContext
+          # @param [String] sid The SID of the SMS Command resource to fetch.
+          # @return [SmsCommandContext] SmsCommandContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/Commands/#{@solution[:sid]}"
+            @uri = "/SmsCommands/#{@solution[:sid]}"
           end
 
           ##
-          # Fetch the CommandInstance
-          # @return [CommandInstance] Fetched CommandInstance
+          # Fetch the SmsCommandInstance
+          # @return [SmsCommandInstance] Fetched SmsCommandInstance
           def fetch
             payload = @version.fetch('GET', @uri)
 
-            CommandInstance.new(@version, payload, sid: @solution[:sid], )
+            SmsCommandInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Supersim.V1.CommandContext #{context}>"
+            "#<Twilio.Supersim.V1.SmsCommandContext #{context}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Supersim.V1.CommandContext #{context}>"
+            "#<Twilio.Supersim.V1.SmsCommandContext #{context}>"
           end
         end
 
         ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class CommandInstance < InstanceResource
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SmsCommandInstance < InstanceResource
           ##
-          # Initialize the CommandInstance
+          # Initialize the SmsCommandInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The SID of the Command resource to fetch.
-          # @return [CommandInstance] CommandInstance
+          # @param [String] sid The SID of the SMS Command resource to fetch.
+          # @return [SmsCommandInstance] SmsCommandInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
@@ -263,7 +266,7 @@ module Twilio
                 'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'sim_sid' => payload['sim_sid'],
-                'command' => payload['command'],
+                'payload' => payload['payload'],
                 'status' => payload['status'],
                 'direction' => payload['direction'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -279,10 +282,10 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @return [CommandContext] CommandContext for this CommandInstance
+          # @return [SmsCommandContext] SmsCommandContext for this SmsCommandInstance
           def context
             unless @instance_context
-              @instance_context = CommandContext.new(@version, @params['sid'], )
+              @instance_context = SmsCommandContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -300,25 +303,25 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the SIM that this Command was sent to or from
+          # @return [String] The SID of the SIM that this SMS Command was sent to or from
           def sim_sid
             @properties['sim_sid']
           end
 
           ##
-          # @return [String] The message body of the command sent to or from the SIM
-          def command
-            @properties['command']
+          # @return [String] The message body of the SMS Command sent to or from the SIM
+          def payload
+            @properties['payload']
           end
 
           ##
-          # @return [command.Status] The status of the Command
+          # @return [sms_command.Status] The status of the SMS Command
           def status
             @properties['status']
           end
 
           ##
-          # @return [command.Direction] The direction of the Command
+          # @return [sms_command.Direction] The direction of the SMS Command
           def direction
             @properties['direction']
           end
@@ -336,14 +339,14 @@ module Twilio
           end
 
           ##
-          # @return [String] The absolute URL of the Command resource
+          # @return [String] The absolute URL of the SMS Command resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch the CommandInstance
-          # @return [CommandInstance] Fetched CommandInstance
+          # Fetch the SmsCommandInstance
+          # @return [SmsCommandInstance] Fetched SmsCommandInstance
           def fetch
             context.fetch
           end
@@ -352,14 +355,14 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Supersim.V1.CommandInstance #{values}>"
+            "<Twilio.Supersim.V1.SmsCommandInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Supersim.V1.CommandInstance #{values}>"
+            "<Twilio.Supersim.V1.SmsCommandInstance #{values}>"
           end
         end
       end