twilio-ruby 5.34.1 → 5.39.0

data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb

@@ -40,11 +40,7 @@ module Twilio
                 'CommitMessage' => commit_message,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             FlowValidateInstance.new(@version, payload, )
           end

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

@@ -47,7 +47,17 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Network
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::NetworkInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::NetworkList]
+      def networks(sid=:unset)
+        self.v1.networks(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that identifies the Network Access Profile
+      #   resource.
       # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileInstance] if sid was passed.
       # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
       def network_access_profiles(sid=:unset)

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

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

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

@@ -26,8 +26,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
-          # Request is executed immediately.
+          # 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.
@@ -36,7 +35,7 @@ module Twilio
           #   `callback_url`. Can be: `GET` or `POST` and the default is POST.
           # @param [String] callback_url The URL we should call using the `callback_method`
           #   after we have sent the command.
-          # @return [CommandInstance] Newly created CommandInstance
+          # @return [CommandInstance] Created CommandInstance
           def create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset)
             data = Twilio::Values.of({
                 'Sim' => sim,
@@ -45,11 +44,7 @@ module Twilio
                 'CallbackUrl' => callback_url,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CommandInstance.new(@version, payload, )
           end
@@ -154,11 +149,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params)
+
             CommandPage.new(@version, response, @solution)
           end
 
@@ -230,16 +223,10 @@ module Twilio
           end
 
           ##
-          # Fetch a CommandInstance
+          # Fetch the CommandInstance
           # @return [CommandInstance] Fetched CommandInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CommandInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -355,7 +342,7 @@ module Twilio
           end
 
           ##
-          # Fetch a CommandInstance
+          # Fetch the CommandInstance
           # @return [CommandInstance] Fetched CommandInstance
           def fetch
             context.fetch

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

@@ -26,40 +26,41 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of FleetInstance records from the API.
-          # Request is executed immediately.
+          # Create the FleetInstance
+          # @param [String] network_access_profile The SID or unique name of the Network
+          #   Access Profile that will control which cellular networks the Fleet's SIMs can
+          #   connect to
           # @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 [Boolean] data_enabled Defines whether SIMs in the Fleet are capable of
-          #   using 2G/3G/4G/LTE/CAT-M/NB-IoT data connectivity
+          #   using 2G/3G/4G/LTE/CAT-M data connectivity
+          # @param [String] data_limit The total data usage (download and upload combined)
+          #   in Megabytes that each Sim resource assigned to the Fleet resource can consume
+          #   during a billing period (normally one month). Value must be between 1MB (1) and
+          #   2TB (2,000,000).
           # @param [Boolean] commands_enabled Defines whether SIMs in the Fleet are capable
-          #   of sending and receiving Commands via SMS.
+          #   of sending and receiving machine-to-machine SMS via Commands.
           # @param [String] commands_url The URL that will receive a webhook when a SIM in
-          #   the Fleet originates a machine-to-machine Command. Your server should respond
-          #   with an HTTP status code in the 200 range; any response body will be ignored.
+          #   the Fleet originates a machine-to-machine SMS via Commands. Your server should
+          #   respond with an HTTP status code in the 200 range; any response body will be
+          #   ignored.
           # @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, network_access_profile: :unset)
+          # @return [FleetInstance] Created FleetInstance
+          def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset)
             data = Twilio::Values.of({
+                'NetworkAccessProfile' => network_access_profile,
                 'UniqueName' => unique_name,
                 'DataEnabled' => data_enabled,
+                'DataLimit' => data_limit,
                 'CommandsEnabled' => commands_enabled,
                 'CommandsUrl' => commands_url,
                 'CommandsMethod' => commands_method,
-                'NetworkAccessProfile' => network_access_profile,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             FleetInstance.new(@version, payload, )
           end
@@ -69,8 +70,8 @@ module Twilio
           # 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
+          #   Access Profile that controls which cellular networks 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
@@ -91,8 +92,8 @@ module Twilio
           # 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
+          #   Access Profile that controls which cellular networks 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
@@ -126,8 +127,8 @@ 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
+          #   Access Profile that controls which cellular networks 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
@@ -139,11 +140,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params)
+
             FleetPage.new(@version, response, @solution)
           end
 
@@ -215,16 +214,10 @@ module Twilio
           end
 
           ##
-          # Fetch a FleetInstance
+          # Fetch the FleetInstance
           # @return [FleetInstance] Fetched FleetInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             FleetInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -235,8 +228,8 @@ module Twilio
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
           # @param [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
+          #   Access Profile that will control which cellular networks the Fleet's SIMs can
+          #   connect to
           # @return [FleetInstance] Updated FleetInstance
           def update(unique_name: :unset, network_access_profile: :unset)
             data = Twilio::Values.of({
@@ -244,11 +237,7 @@ module Twilio
                 'NetworkAccessProfile' => network_access_profile,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             FleetInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -289,6 +278,7 @@ module Twilio
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
                 'data_enabled' => payload['data_enabled'],
+                'data_limit' => payload['data_limit'].to_i,
                 'data_metering' => payload['data_metering'],
                 'commands_enabled' => payload['commands_enabled'],
                 'commands_url' => payload['commands_url'],
@@ -354,6 +344,12 @@ module Twilio
             @properties['data_enabled']
           end
 
+          ##
+          # @return [String] The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume
+          def data_limit
+            @properties['data_limit']
+          end
+
           ##
           # @return [fleet.DataMetering] The model by which a SIM is metered and billed
           def data_metering
@@ -361,13 +357,13 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Defines whether SIMs in the Fleet are capable of sending and receiving Commands via SMS
+          # @return [Boolean] Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
           def commands_enabled
             @properties['commands_enabled']
           end
 
           ##
-          # @return [String] The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine Command
+          # @return [String] The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine SMS via Commands
           def commands_url
             @properties['commands_url']
           end
@@ -385,7 +381,7 @@ module Twilio
           end
 
           ##
-          # Fetch a FleetInstance
+          # Fetch the FleetInstance
           # @return [FleetInstance] Fetched FleetInstance
           def fetch
             context.fetch
@@ -397,8 +393,8 @@ module Twilio
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
           # @param [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
+          #   Access Profile that will control which cellular networks the Fleet's SIMs can
+          #   connect to
           # @return [FleetInstance] Updated FleetInstance
           def update(unique_name: :unset, network_access_profile: :unset)
             context.update(unique_name: unique_name, network_access_profile: network_access_profile, )

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

@@ -0,0 +1,307 @@
+##
+# 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 NetworkList < ListResource
+          ##
+          # Initialize the NetworkList
+          # @param [Version] version Version that contains the resource
+          # @return [NetworkList] NetworkList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Networks"
+          end
+
+          ##
+          # Lists NetworkInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] iso_country The [ISO country
+          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources
+          #   to read.
+          # @param [String] mcc The 'mobile country code' of a country. Network resources
+          #   with this `mcc` in their `identifiers` will be read.
+          # @param [String] mnc The 'mobile network code' of a mobile operator network.
+          #   Network resources with this `mnc` in their `identifiers` will be read.
+          # @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(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil)
+            self.stream(
+                iso_country: iso_country,
+                mcc: mcc,
+                mnc: mnc,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams NetworkInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] iso_country The [ISO country
+          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources
+          #   to read.
+          # @param [String] mcc The 'mobile country code' of a country. Network resources
+          #   with this `mcc` in their `identifiers` will be read.
+          # @param [String] mnc The 'mobile network code' of a mobile operator network.
+          #   Network resources with this `mnc` in their `identifiers` will be read.
+          # @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(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(iso_country: iso_country, mcc: mcc, mnc: mnc, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields NetworkInstance 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 NetworkInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] iso_country The [ISO country
+          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources
+          #   to read.
+          # @param [String] mcc The 'mobile country code' of a country. Network resources
+          #   with this `mcc` in their `identifiers` will be read.
+          # @param [String] mnc The 'mobile network code' of a mobile operator network.
+          #   Network resources with this `mnc` in their `identifiers` will be read.
+          # @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 NetworkInstance
+          def page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'IsoCountry' => iso_country,
+                'Mcc' => mcc,
+                'Mnc' => mnc,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params)
+
+            NetworkPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of NetworkInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of NetworkInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            NetworkPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.NetworkList>'
+          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 NetworkPage < Page
+          ##
+          # Initialize the NetworkPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [NetworkPage] NetworkPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of NetworkInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [NetworkInstance] NetworkInstance
+          def get_instance(payload)
+            NetworkInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.NetworkPage>'
+          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 NetworkContext < InstanceContext
+          ##
+          # Initialize the NetworkContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Network resource to fetch.
+          # @return [NetworkContext] NetworkContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Networks/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the NetworkInstance
+          # @return [NetworkInstance] Fetched NetworkInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            NetworkInstance.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.NetworkContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Supersim.V1.NetworkContext #{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 NetworkInstance < InstanceResource
+          ##
+          # Initialize the NetworkInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Network resource to fetch.
+          # @return [NetworkInstance] NetworkInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                'url' => payload['url'],
+                'iso_country' => payload['iso_country'],
+                'identifiers' => payload['identifiers'],
+            }
+
+            # 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 [NetworkContext] NetworkContext for this NetworkInstance
+          def context
+            unless @instance_context
+              @instance_context = NetworkContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] A human readable identifier of this resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Network resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The ISO country code of the Network resource
+          def iso_country
+            @properties['iso_country']
+          end
+
+          ##
+          # @return [Hash] The MCC/MNCs included in the Network resource
+          def identifiers
+            @properties['identifiers']
+          end
+
+          ##
+          # Fetch the NetworkInstance
+          # @return [NetworkInstance] Fetched NetworkInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.NetworkInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.NetworkInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end