twilio-ruby 5.52.0 → 5.67.3

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

@@ -12,54 +12,62 @@ module Twilio
       class V1 < Version
         ##
         # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CommandList < ListResource
+        class IpCommandList < ListResource
           ##
-          # Initialize the CommandList
+          # Initialize the IpCommandList
           # @param [Version] version Version that contains the resource
-          # @return [CommandList] CommandList
+          # @return [IpCommandList] IpCommandList
           def initialize(version)
             super(version)
 
             # Path Solution
             @solution = {}
-            @uri = "/Commands"
+            @uri = "/IpCommands"
           end
 
           ##
-          # Create the CommandInstance
-          # @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.
-          # @param [String] callback_method The HTTP method we should use to call
-          #   `callback_url`. Can be: `GET` or `POST` and the default is POST.
+          # Create the IpCommandInstance
+          # @param [String] sim The `sid` or `unique_name` of the {Super
+          #   SIM}[https://www.twilio.com/docs/iot/supersim/api/sim-resource] to send the IP
+          #   Command to.
+          # @param [String] payload The payload to be delivered to the device.
+          # @param [String] device_port The device port to which the IP Command will be
+          #   sent.
+          # @param [ip_command.PayloadType] payload_type Indicates how the payload is
+          #   encoded. Either `text` or `binary`. Defaults to `text`.
           # @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)
+          #   after we have sent the IP 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`.
+          # @return [IpCommandInstance] Created IpCommandInstance
+          def create(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset)
             data = Twilio::Values.of({
                 'Sim' => sim,
-                'Command' => command,
-                'CallbackMethod' => callback_method,
+                'Payload' => payload,
+                'DevicePort' => device_port,
+                'PayloadType' => payload_type,
                 'CallbackUrl' => callback_url,
+                'CallbackMethod' => callback_method,
             })
 
             payload = @version.create('POST', @uri, data: data)
 
-            CommandInstance.new(@version, payload, )
+            IpCommandInstance.new(@version, payload, )
           end
 
           ##
-          # Lists CommandInstance records from the API as a list.
+          # Lists IpCommandInstance 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 IP Command
+          #   was sent to or from.
+          # @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent
+          #   to or from.
+          # @param [ip_command.Status] status The status of the IP Command. Can be:
+          #   `queued`, `sent`, `received` or `failed`. See the {IP Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/ipcommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
+          # @param [ip_command.Direction] direction The direction of the IP 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`.
@@ -70,9 +78,10 @@ module Twilio
           #    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(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
+          def list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
             self.stream(
                 sim: sim,
+                sim_iccid: sim_iccid,
                 status: status,
                 direction: direction,
                 limit: limit,
@@ -81,16 +90,18 @@ module Twilio
           end
 
           ##
-          # Streams CommandInstance records from the API as an Enumerable.
+          # Streams IpCommandInstance 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 IP Command
+          #   was sent to or from.
+          # @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent
+          #   to or from.
+          # @param [ip_command.Status] status The status of the IP Command. Can be:
+          #   `queued`, `sent`, `received` or `failed`. See the {IP Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/ipcommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
+          # @param [ip_command.Direction] direction The direction of the IP 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`.
@@ -101,16 +112,22 @@ module Twilio
           #    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(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
+          def stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(sim: sim, status: status, direction: direction, page_size: limits[:page_size], )
+            page = self.page(
+                sim: sim,
+                sim_iccid: sim_iccid,
+                status: status,
+                direction: direction,
+                page_size: limits[:page_size],
+            )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
 
           ##
-          # When passed a block, yields CommandInstance records from the API.
+          # When passed a block, yields IpCommandInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           def each
@@ -124,25 +141,28 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
+          # Retrieve a single page of IpCommandInstance 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 IP Command
+          #   was sent to or from.
+          # @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent
+          #   to or from.
+          # @param [ip_command.Status] status The status of the IP Command. Can be:
+          #   `queued`, `sent`, `received` or `failed`. See the {IP Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/ipcommand-resource#status-values]
           #   for a description of each.
-          # @param [command.Direction] direction The direction of the Command. Can be
+          # @param [ip_command.Direction] direction The direction of the IP 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
-          def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+          # @return [Page] Page of IpCommandInstance
+          def page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'Sim' => sim,
+                'SimIccid' => sim_iccid,
                 'Status' => status,
                 'Direction' => direction,
                 'PageToken' => page_token,
@@ -152,38 +172,38 @@ module Twilio
 
             response = @version.page('GET', @uri, params: params)
 
-            CommandPage.new(@version, response, @solution)
+            IpCommandPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
+          # Retrieve a single page of IpCommandInstance 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 IpCommandInstance
           def get_page(target_url)
             response = @version.domain.request(
                 'GET',
                 target_url
             )
-            CommandPage.new(@version, response, @solution)
+            IpCommandPage.new(@version, response, @solution)
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Supersim.V1.CommandList>'
+            '#<Twilio.Supersim.V1.IpCommandList>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CommandPage < Page
+        class IpCommandPage < Page
           ##
-          # Initialize the CommandPage
+          # Initialize the IpCommandPage
           # @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 [IpCommandPage] IpCommandPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -192,69 +212,69 @@ module Twilio
           end
 
           ##
-          # Build an instance of CommandInstance
+          # Build an instance of IpCommandInstance
           # @param [Hash] payload Payload response from the API
-          # @return [CommandInstance] CommandInstance
+          # @return [IpCommandInstance] IpCommandInstance
           def get_instance(payload)
-            CommandInstance.new(@version, payload, )
+            IpCommandInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Supersim.V1.CommandPage>'
+            '<Twilio.Supersim.V1.IpCommandPage>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CommandContext < InstanceContext
+        class IpCommandContext < InstanceContext
           ##
-          # Initialize the CommandContext
+          # Initialize the IpCommandContext
           # @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 IP Command resource to fetch.
+          # @return [IpCommandContext] IpCommandContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/Commands/#{@solution[:sid]}"
+            @uri = "/IpCommands/#{@solution[:sid]}"
           end
 
           ##
-          # Fetch the CommandInstance
-          # @return [CommandInstance] Fetched CommandInstance
+          # Fetch the IpCommandInstance
+          # @return [IpCommandInstance] Fetched IpCommandInstance
           def fetch
             payload = @version.fetch('GET', @uri)
 
-            CommandInstance.new(@version, payload, sid: @solution[:sid], )
+            IpCommandInstance.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.IpCommandContext #{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.IpCommandContext #{context}>"
           end
         end
 
         ##
         # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CommandInstance < InstanceResource
+        class IpCommandInstance < InstanceResource
           ##
-          # Initialize the CommandInstance
+          # Initialize the IpCommandInstance
           # @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 IP Command resource to fetch.
+          # @return [IpCommandInstance] IpCommandInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
@@ -263,9 +283,13 @@ module Twilio
                 'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'sim_sid' => payload['sim_sid'],
-                'command' => payload['command'],
+                'sim_iccid' => payload['sim_iccid'],
                 'status' => payload['status'],
                 'direction' => payload['direction'],
+                'device_ip' => payload['device_ip'],
+                'device_port' => payload['device_port'].to_i,
+                'payload_type' => payload['payload_type'],
+                'payload' => payload['payload'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -279,10 +303,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 [IpCommandContext] IpCommandContext for this IpCommandInstance
           def context
             unless @instance_context
-              @instance_context = CommandContext.new(@version, @params['sid'], )
+              @instance_context = IpCommandContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -300,29 +324,53 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the SIM that this Command was sent to or from
+          # @return [String] The SID of the Super SIM that this IP 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 ICCID of the Super SIM that this IP Command was sent to or from
+          def sim_iccid
+            @properties['sim_iccid']
           end
 
           ##
-          # @return [command.Status] The status of the Command
+          # @return [ip_command.Status] The status of the IP Command
           def status
             @properties['status']
           end
 
           ##
-          # @return [command.Direction] The direction of the Command
+          # @return [ip_command.Direction] The direction of the IP Command
           def direction
             @properties['direction']
           end
 
+          ##
+          # @return [String] The IP address of the device that the IP Command was sent to or received from
+          def device_ip
+            @properties['device_ip']
+          end
+
+          ##
+          # @return [String] The port that the IP Command either originated from or was sent to
+          def device_port
+            @properties['device_port']
+          end
+
+          ##
+          # @return [ip_command.PayloadType] The payload type of the IP Command
+          def payload_type
+            @properties['payload_type']
+          end
+
+          ##
+          # @return [String] The payload of the IP Command sent to or from the Super SIM
+          def payload
+            @properties['payload']
+          end
+
           ##
           # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
@@ -336,14 +384,14 @@ module Twilio
           end
 
           ##
-          # @return [String] The absolute URL of the Command resource
+          # @return [String] The absolute URL of the IP Command resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch the CommandInstance
-          # @return [CommandInstance] Fetched CommandInstance
+          # Fetch the IpCommandInstance
+          # @return [IpCommandInstance] Fetched IpCommandInstance
           def fetch
             context.fetch
           end
@@ -352,14 +400,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.IpCommandInstance #{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.IpCommandInstance #{values}>"
           end
         end
       end