twilio-ruby 5.46.1 → 5.77.0

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

@@ -0,0 +1,419 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class IpCommandList < ListResource
+          ##
+          # Initialize the IpCommandList
+          # @param [Version] version Version that contains the resource
+          # @return [IpCommandList] IpCommandList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/IpCommands"
+          end
+
+          ##
+          # 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 data that will be sent to the device. The payload
+          #   cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is
+          #   encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in
+          #   Base64.
+          # @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 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,
+                'Payload' => payload,
+                'DevicePort' => device_port,
+                'PayloadType' => payload_type,
+                'CallbackUrl' => callback_url,
+                'CallbackMethod' => callback_method,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            IpCommandInstance.new(@version, payload, )
+          end
+
+          ##
+          # 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 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 [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 [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(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,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # 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 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 [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 [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(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,
+                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 IpCommandInstance 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 IpCommandInstance records from the API.
+          # Request is executed immediately.
+          # @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 [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 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,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            IpCommandPage.new(@version, response, @solution)
+          end
+
+          ##
+          # 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 IpCommandInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            IpCommandPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.IpCommandList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class IpCommandPage < Page
+          ##
+          # 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 [IpCommandPage] IpCommandPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of IpCommandInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [IpCommandInstance] IpCommandInstance
+          def get_instance(payload)
+            IpCommandInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.IpCommandPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class IpCommandContext < InstanceContext
+          ##
+          # Initialize the IpCommandContext
+          # @param [Version] version Version that contains the resource
+          # @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 = "/IpCommands/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the IpCommandInstance
+          # @return [IpCommandInstance] Fetched IpCommandInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            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.IpCommandContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<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 IpCommandInstance < InstanceResource
+          ##
+          # 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 IP Command resource to fetch.
+          # @return [IpCommandInstance] IpCommandInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'sim_sid' => payload['sim_sid'],
+                'sim_iccid' => payload['sim_iccid'],
+                'status' => payload['status'],
+                'direction' => payload['direction'],
+                'device_ip' => payload['device_ip'],
+                'device_port' => payload['device_port'] == nil ? payload['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'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [IpCommandContext] IpCommandContext for this IpCommandInstance
+          def context
+            unless @instance_context
+              @instance_context = IpCommandContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @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 ICCID of the Super SIM that this IP Command was sent to or from
+          def sim_iccid
+            @properties['sim_iccid']
+          end
+
+          ##
+          # @return [ip_command.Status] The status of the IP Command
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @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
+            @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
+
+          ##
+          # @return [String] The absolute URL of the IP Command resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the IpCommandInstance
+          # @return [IpCommandInstance] Fetched IpCommandInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<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.IpCommandInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,247 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdateList < ListResource
+          ##
+          # Initialize the SettingsUpdateList
+          # @param [Version] version Version that contains the resource
+          # @return [SettingsUpdateList] SettingsUpdateList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/SettingsUpdates"
+          end
+
+          ##
+          # Lists SettingsUpdateInstance 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 Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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(sim: :unset, status: :unset, limit: nil, page_size: nil)
+            self.stream(sim: sim, status: status, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams SettingsUpdateInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] sim Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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(sim: :unset, status: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(sim: sim, status: status, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields SettingsUpdateInstance 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 SettingsUpdateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] sim Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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 SettingsUpdateInstance
+          def page(sim: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Sim' => sim,
+                'Status' => status,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            SettingsUpdatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of SettingsUpdateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of SettingsUpdateInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            SettingsUpdatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.SettingsUpdateList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdatePage < Page
+          ##
+          # Initialize the SettingsUpdatePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [SettingsUpdatePage] SettingsUpdatePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of SettingsUpdateInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [SettingsUpdateInstance] SettingsUpdateInstance
+          def get_instance(payload)
+            SettingsUpdateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.SettingsUpdatePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdateInstance < InstanceResource
+          ##
+          # Initialize the SettingsUpdateInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [SettingsUpdateInstance] SettingsUpdateInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'iccid' => payload['iccid'],
+                'sim_sid' => payload['sim_sid'],
+                'status' => payload['status'],
+                'packages' => payload['packages'],
+                'date_completed' => Twilio.deserialize_iso8601_datetime(payload['date_completed']),
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+            }
+          end
+
+          ##
+          # @return [String] The unique identifier of this Settings Update
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The ICCID associated with the SIM
+          def iccid
+            @properties['iccid']
+          end
+
+          ##
+          # @return [String] The SID of the Super SIM to which this Settings Update was applied
+          def sim_sid
+            @properties['sim_sid']
+          end
+
+          ##
+          # @return [settings_update.Status] The Status of this Settings Update
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [Array[Hash]] Array containing the different Settings Packages that will be applied to the SIM after the update completes
+          def packages
+            @properties['packages']
+          end
+
+          ##
+          # @return [Time] The time when the update successfully completed and the new settings were applied to the SIM
+          def date_completed
+            @properties['date_completed']
+          end
+
+          ##
+          # @return [Time] The date this Settings Update was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Settings Update was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Supersim.V1.SettingsUpdateInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Supersim.V1.SettingsUpdateInstance>"
+          end
+        end
+      end
+    end
+  end
+end