twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,312 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Supersim
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Supersim < SupersimBase
+            class V1 < Version
+                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 Instance 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: 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 beta products that are subject to change. Use them with caution.
+                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
+
+                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
+                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] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Network
+                    #   resource.
+                    # @param [String] sid The SID of the Call 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] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = NetworkContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Network 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource.
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are 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

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

@@ -0,0 +1,344 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Supersim
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Supersim < SupersimBase
+            class V1 < Version
+                class NetworkAccessProfileContext < InstanceContext
+
+                     class NetworkAccessProfileNetworkList < ListResource
+                    ##
+                    # Initialize the NetworkAccessProfileNetworkList
+                    # @param [Version] version Version that contains the resource
+                    # @return [NetworkAccessProfileNetworkList] NetworkAccessProfileNetworkList
+                    def initialize(version, network_access_profile_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { network_access_profile_sid: network_access_profile_sid }
+                        @uri = "/NetworkAccessProfiles/#{@solution[:network_access_profile_sid]}/Networks"
+                        
+                    end
+                    ##
+                    # Create the NetworkAccessProfileNetworkInstance
+                    # @param [String] network The SID of the Network resource to be added to the Network Access Profile resource.
+                    # @return [NetworkAccessProfileNetworkInstance] Created NetworkAccessProfileNetworkInstance
+                    def create(
+                        network: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Network' => network,
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        NetworkAccessProfileNetworkInstance.new(
+                            @version,
+                            payload,
+                            network_access_profile_sid: @solution[:network_access_profile_sid],
+                        )
+                    end
+
+                
+                    ##
+                    # Lists NetworkAccessProfileNetworkInstance 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 Instance 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 NetworkAccessProfileNetworkInstance 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 NetworkAccessProfileNetworkInstance 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 NetworkAccessProfileNetworkInstance
+                    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: params)
+
+                        NetworkAccessProfileNetworkPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of NetworkAccessProfileNetworkInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of NetworkAccessProfileNetworkInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    NetworkAccessProfileNetworkPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Supersim.V1.NetworkAccessProfileNetworkList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class NetworkAccessProfileNetworkContext < InstanceContext
+                    ##
+                    # Initialize the NetworkAccessProfileNetworkContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] network_access_profile_sid The unique string that identifies the Network Access Profile resource.
+                    # @param [String] sid The SID of the Network resource to fetch.
+                    # @return [NetworkAccessProfileNetworkContext] NetworkAccessProfileNetworkContext
+                    def initialize(version, network_access_profile_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { network_access_profile_sid: network_access_profile_sid, sid: sid,  }
+                        @uri = "/NetworkAccessProfiles/#{@solution[:network_access_profile_sid]}/Networks/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the NetworkAccessProfileNetworkInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the NetworkAccessProfileNetworkInstance
+                    # @return [NetworkAccessProfileNetworkInstance] Fetched NetworkAccessProfileNetworkInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        NetworkAccessProfileNetworkInstance.new(
+                            @version,
+                            payload,
+                            network_access_profile_sid: @solution[:network_access_profile_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Supersim.V1.NetworkAccessProfileNetworkContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Supersim.V1.NetworkAccessProfileNetworkContext #{context}>"
+                    end
+                end
+
+                class NetworkAccessProfileNetworkPage < Page
+                    ##
+                    # Initialize the NetworkAccessProfileNetworkPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [NetworkAccessProfileNetworkPage] NetworkAccessProfileNetworkPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of NetworkAccessProfileNetworkInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [NetworkAccessProfileNetworkInstance] NetworkAccessProfileNetworkInstance
+                    def get_instance(payload)
+                        NetworkAccessProfileNetworkInstance.new(@version, payload, network_access_profile_sid: @solution[:network_access_profile_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Supersim.V1.NetworkAccessProfileNetworkPage>'
+                    end
+                end
+                class NetworkAccessProfileNetworkInstance < InstanceResource
+                    ##
+                    # Initialize the NetworkAccessProfileNetworkInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this NetworkAccessProfileNetwork
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [NetworkAccessProfileNetworkInstance] NetworkAccessProfileNetworkInstance
+                    def initialize(version, payload , network_access_profile_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'network_access_profile_sid' => payload['network_access_profile_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'iso_country' => payload['iso_country'],
+                            'identifiers' => payload['identifiers'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'network_access_profile_sid' => network_access_profile_sid  || @properties['network_access_profile_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 [NetworkAccessProfileNetworkContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = NetworkAccessProfileNetworkContext.new(@version , @params['network_access_profile_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that identifies the Network resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that identifies the Network resource's Network Access Profile resource.
+                    def network_access_profile_sid
+                        @properties['network_access_profile_sid']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable identifier of the Network this resource refers to.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource.
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource.
+                    def identifiers
+                        @properties['identifiers']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Network resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Delete the NetworkAccessProfileNetworkInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the NetworkAccessProfileNetworkInstance
+                    # @return [NetworkAccessProfileNetworkInstance] Fetched NetworkAccessProfileNetworkInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Supersim.V1.NetworkAccessProfileNetworkInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Supersim.V1.NetworkAccessProfileNetworkInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+