twilio-ruby 5.61.1 → 5.63.1

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

@@ -0,0 +1,416 @@
+##
+# 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 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 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'].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.rb

@@ -16,7 +16,9 @@ module Twilio
           super
           @version = 'v1'
           @commands = nil
+          @esim_profiles = nil
           @fleets = nil
+          @ip_commands = nil
           @networks = nil
           @network_access_profiles = nil
           @sims = nil
@@ -39,6 +41,21 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The SID of the eSIM Profile resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::EsimProfileContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::EsimProfileList]
+        def esim_profiles(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @esim_profiles ||= EsimProfileList.new self
+          else
+              EsimProfileContext.new(self, sid)
+          end
+        end
+
         ##
         # @param [String] sid The SID of the Fleet resource to fetch.
         # @return [Twilio::REST::Supersim::V1::FleetContext] if sid was passed.
@@ -54,6 +71,21 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The SID of the IP Command resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::IpCommandContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::IpCommandList]
+        def ip_commands(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @ip_commands ||= IpCommandList.new self
+          else
+              IpCommandContext.new(self, sid)
+          end
+        end
+
         ##
         # @param [String] sid The SID of the Network resource to fetch.
         # @return [Twilio::REST::Supersim::V1::NetworkContext] if sid was passed.

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

@@ -37,6 +37,15 @@ module Twilio
         self.v1.commands(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the eSIM
+      #   Profile resource.
+      # @return [Twilio::REST::Supersim::V1::EsimProfileInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::EsimProfileList]
+      def esim_profiles(sid=:unset)
+        self.v1.esim_profiles(sid)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Fleet
       #   resource.
@@ -46,6 +55,15 @@ module Twilio
         self.v1.fleets(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the IP Command
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::IpCommandInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::IpCommandList]
+      def ip_commands(sid=:unset)
+        self.v1.ip_commands(sid)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Network
       #   resource.

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

@@ -17,8 +17,7 @@ module Twilio
             ##
             # Initialize the AccessTokenList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique string that we created to identify the
-            #   Service resource.
+            # @param [String] service_sid The unique SID identifier of the Verify Service.
             # @return [AccessTokenList] AccessTokenList
             def initialize(version, service_sid: nil)
               super(version)
@@ -35,9 +34,15 @@ module Twilio
             #   external system, such as your user's UUID, GUID, or SID.
             # @param [access_token.FactorTypes] factor_type The Type of this Factor. Eg.
             #   `push`
+            # @param [String] factor_friendly_name The friendly name of the factor that is
+            #   going to be created with this access token
             # @return [AccessTokenInstance] Created AccessTokenInstance
-            def create(identity: nil, factor_type: nil)
-              data = Twilio::Values.of({'Identity' => identity, 'FactorType' => factor_type, })
+            def create(identity: nil, factor_type: nil, factor_friendly_name: :unset)
+              data = Twilio::Values.of({
+                  'Identity' => identity,
+                  'FactorType' => factor_type,
+                  'FactorFriendlyName' => factor_friendly_name,
+              })
 
               payload = @version.create('POST', @uri, data: data)
 
@@ -82,6 +87,53 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AccessTokenContext < InstanceContext
+            ##
+            # Initialize the AccessTokenContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid A 34 character string that uniquely identifies this Access
+            #   Token.
+            # @return [AccessTokenContext] AccessTokenContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:service_sid]}/AccessTokens/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the AccessTokenInstance
+            # @return [AccessTokenInstance] Fetched AccessTokenInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AccessTokenInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.AccessTokenContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.AccessTokenContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AccessTokenInstance < InstanceResource
@@ -89,14 +141,75 @@ module Twilio
             # Initialize the AccessTokenInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique string that we created to identify the
-            #   Service resource.
+            # @param [String] service_sid The unique SID identifier of the Verify Service.
+            # @param [String] sid A 34 character string that uniquely identifies this Access
+            #   Token.
             # @return [AccessTokenInstance] AccessTokenInstance
-            def initialize(version, payload, service_sid: nil)
+            def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
-              @properties = {'token' => payload['token'], }
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'entity_identity' => payload['entity_identity'],
+                  'factor_type' => payload['factor_type'],
+                  'factor_friendly_name' => payload['factor_friendly_name'],
+                  'token' => payload['token'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'service_sid' => service_sid, '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 [AccessTokenContext] AccessTokenContext for this AccessTokenInstance
+            def context
+              unless @instance_context
+                @instance_context = AccessTokenContext.new(@version, @params['service_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Access Token.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Verify Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] Unique external identifier of the Entity
+            def entity_identity
+              @properties['entity_identity']
+            end
+
+            ##
+            # @return [access_token.FactorTypes] The Type of the Factor
+            def factor_type
+              @properties['factor_type']
+            end
+
+            ##
+            # @return [String] A human readable description of this factor.
+            def factor_friendly_name
+              @properties['factor_friendly_name']
             end
 
             ##
@@ -105,16 +218,31 @@ module Twilio
               @properties['token']
             end
 
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the AccessTokenInstance
+            # @return [AccessTokenInstance] Fetched AccessTokenInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Verify.V2.AccessTokenInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Verify.V2.AccessTokenInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
             end
           end
         end