twilio-ruby 5.34.0 → 5.34.1

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

@@ -46,6 +46,14 @@ module Twilio
         self.v1.fleets(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
+      def network_access_profiles(sid=:unset)
+        self.v1.network_access_profiles(sid)
+      end
+
       ##
       # @param [String] sid The unique string that identifies the Sim resource.
       # @return [Twilio::REST::Supersim::V1::SimInstance] if sid was passed.

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

@@ -17,6 +17,7 @@ module Twilio
           @version = 'v1'
           @commands = nil
           @fleets = nil
+          @network_access_profiles = nil
           @sims = nil
           @usage_records = nil
         end
@@ -49,6 +50,20 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
+        def network_access_profiles(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @network_access_profiles ||= NetworkAccessProfileList.new self
+          else
+            NetworkAccessProfileContext.new(self, sid)
+          end
+        end
+
         ##
         # @param [String] sid The SID of the Sim resource to fetch.
         # @return [Twilio::REST::Supersim::V1::SimContext] if sid was passed.

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

@@ -41,14 +41,18 @@ module Twilio
           # @param [String] commands_method A string representing the HTTP method to use
           #   when making a request to `commands_url`. Can be one of POST or GET. Defaults to
           #   POST.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that will control which cellular network operators the Fleet's
+          #   SIMs can connect to
           # @return [FleetInstance] Newly created FleetInstance
-          def create(unique_name: :unset, data_enabled: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset)
+          def create(unique_name: :unset, data_enabled: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset, network_access_profile: :unset)
             data = Twilio::Values.of({
                 'UniqueName' => unique_name,
                 'DataEnabled' => data_enabled,
                 'CommandsEnabled' => commands_enabled,
                 'CommandsUrl' => commands_url,
                 'CommandsMethod' => commands_method,
+                'NetworkAccessProfile' => network_access_profile,
             })
 
             payload = @version.create(
@@ -64,6 +68,9 @@ module Twilio
           # Lists FleetInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that controls which cellular network operators the Fleet's SIMs
+          #   can connect to
           # @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
@@ -71,14 +78,21 @@ 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(limit: nil, page_size: nil)
-            self.stream(limit: limit, page_size: page_size).entries
+          def list(network_access_profile: :unset, limit: nil, page_size: nil)
+            self.stream(
+                network_access_profile: network_access_profile,
+                limit: limit,
+                page_size: page_size
+            ).entries
           end
 
           ##
           # Streams FleetInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that controls which cellular network operators the Fleet's SIMs
+          #   can connect to
           # @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
@@ -86,10 +100,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 [Enumerable] Enumerable that will yield up to limit results
-          def stream(limit: nil, page_size: nil)
+          def stream(network_access_profile: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(network_access_profile: network_access_profile, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -111,12 +125,16 @@ module Twilio
           ##
           # Retrieve a single page of FleetInstance records from the API.
           # Request is executed immediately.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that controls which cellular network operators the Fleet's SIMs
+          #   can connect to
           # @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 FleetInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(network_access_profile: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'NetworkAccessProfile' => network_access_profile,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
@@ -216,9 +234,15 @@ module Twilio
           # @param [String] unique_name An application-defined string that uniquely
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that will control which cellular network operators the Fleet's
+          #   SIMs can connect to
           # @return [FleetInstance] Updated FleetInstance
-          def update(unique_name: :unset)
-            data = Twilio::Values.of({'UniqueName' => unique_name, })
+          def update(unique_name: :unset, network_access_profile: :unset)
+            data = Twilio::Values.of({
+                'UniqueName' => unique_name,
+                'NetworkAccessProfile' => network_access_profile,
+            })
 
             payload = @version.update(
                 'POST',
@@ -269,6 +293,7 @@ module Twilio
                 'commands_enabled' => payload['commands_enabled'],
                 'commands_url' => payload['commands_url'],
                 'commands_method' => payload['commands_method'],
+                'network_access_profile_sid' => payload['network_access_profile_sid'],
             }
 
             # Context
@@ -353,6 +378,12 @@ module Twilio
             @properties['commands_method']
           end
 
+          ##
+          # @return [String] The SID of the Network Access Profile of the Fleet
+          def network_access_profile_sid
+            @properties['network_access_profile_sid']
+          end
+
           ##
           # Fetch a FleetInstance
           # @return [FleetInstance] Fetched FleetInstance
@@ -365,9 +396,12 @@ module Twilio
           # @param [String] unique_name An application-defined string that uniquely
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that will control which cellular network operators the Fleet's
+          #   SIMs can connect to
           # @return [FleetInstance] Updated FleetInstance
-          def update(unique_name: :unset)
-            context.update(unique_name: unique_name, )
+          def update(unique_name: :unset, network_access_profile: :unset)
+            context.update(unique_name: unique_name, network_access_profile: network_access_profile, )
           end
 
           ##

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

@@ -0,0 +1,337 @@
+##
+# 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 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 NetworkAccessProfileList < ListResource
+          ##
+          # Initialize the NetworkAccessProfileList
+          # @param [Version] version Version that contains the resource
+          # @return [NetworkAccessProfileList] NetworkAccessProfileList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/NetworkAccessProfiles"
+          end
+
+          ##
+          # Retrieve a single page of NetworkAccessProfileInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] unique_name The unique_name
+          # @param [String] networks The networks
+          # @return [NetworkAccessProfileInstance] Newly created NetworkAccessProfileInstance
+          def create(unique_name: :unset, networks: :unset)
+            data = Twilio::Values.of({
+                'UniqueName' => unique_name,
+                'Networks' => Twilio.serialize_list(networks) { |e| e },
+            })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            NetworkAccessProfileInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists NetworkAccessProfileInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams NetworkAccessProfileInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields NetworkAccessProfileInstance 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 NetworkAccessProfileInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of NetworkAccessProfileInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            NetworkAccessProfilePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of NetworkAccessProfileInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of NetworkAccessProfileInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            NetworkAccessProfilePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.NetworkAccessProfileList>'
+          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 NetworkAccessProfilePage < Page
+          ##
+          # Initialize the NetworkAccessProfilePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [NetworkAccessProfilePage] NetworkAccessProfilePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of NetworkAccessProfileInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [NetworkAccessProfileInstance] NetworkAccessProfileInstance
+          def get_instance(payload)
+            NetworkAccessProfileInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.NetworkAccessProfilePage>'
+          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 NetworkAccessProfileContext < InstanceContext
+          ##
+          # Initialize the NetworkAccessProfileContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The sid
+          # @return [NetworkAccessProfileContext] NetworkAccessProfileContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/NetworkAccessProfiles/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch a NetworkAccessProfileInstance
+          # @return [NetworkAccessProfileInstance] Fetched NetworkAccessProfileInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            NetworkAccessProfileInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the NetworkAccessProfileInstance
+          # @param [String] unique_name The unique_name
+          # @return [NetworkAccessProfileInstance] Updated NetworkAccessProfileInstance
+          def update(unique_name: :unset)
+            data = Twilio::Values.of({'UniqueName' => unique_name, })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            NetworkAccessProfileInstance.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.NetworkAccessProfileContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Supersim.V1.NetworkAccessProfileContext #{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 NetworkAccessProfileInstance < InstanceResource
+          ##
+          # Initialize the NetworkAccessProfileInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The sid
+          # @return [NetworkAccessProfileInstance] NetworkAccessProfileInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'unique_name' => payload['unique_name'],
+                'account_sid' => payload['account_sid'],
+                '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 [NetworkAccessProfileContext] NetworkAccessProfileContext for this NetworkAccessProfileInstance
+          def context
+            unless @instance_context
+              @instance_context = NetworkAccessProfileContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The unique_name
+          def unique_name
+            @properties['unique_name']
+          end
+
+          ##
+          # @return [String] The account_sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Time] The date_created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date_updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a NetworkAccessProfileInstance
+          # @return [NetworkAccessProfileInstance] Fetched NetworkAccessProfileInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the NetworkAccessProfileInstance
+          # @param [String] unique_name The unique_name
+          # @return [NetworkAccessProfileInstance] Updated NetworkAccessProfileInstance
+          def update(unique_name: :unset)
+            context.update(unique_name: unique_name, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.NetworkAccessProfileInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.NetworkAccessProfileInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end