twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Supersim < SupersimBase
             class V1 < Version
                 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"
@@ -39,12 +41,12 @@ module Twilio
                     # @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
+                      sim: nil, 
+                      payload: nil, 
+                      device_port: nil, 
+                      payload_type: :unset, 
+                      callback_url: :unset, 
+                      callback_method: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -56,13 +58,65 @@ module Twilio
                             'CallbackMethod' => callback_method,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         IpCommandInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the IpCommandInstanceMetadata
+                    # @param [String] sim The `sid` or `unique_name` of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.
+                    # @param [String] payload The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.
+                    # @param [String] device_port The device port to which the IP Command will be sent.
+                    # @param [PayloadType] payload_type 
+                    # @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_with_metadata(
+                      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,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        ip_command_instance = IpCommandInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        IpCommandInstanceMetadata.new(
+                            @version,
+                            ip_command_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists IpCommandInstance records from the API as a list.
@@ -115,7 +169,41 @@ module Twilio
                             direction: direction,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists IpCommandPageMetadata records from the API as a list.
+                      # @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 [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/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
+                      # @param [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_with_metadata(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Sim' => sim,
+                            'SimIccid' => sim_iccid,
+                            'Status' => status,
+                            'Direction' => direction,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        IpCommandPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -127,9 +215,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -143,7 +235,7 @@ module Twilio
                     # @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)
+                    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,
@@ -153,8 +245,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         IpCommandPage.new(@version, response, @solution)
                     end
@@ -181,8 +276,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class IpCommandContext < InstanceContext
                     ##
                     # Initialize the IpCommandContext
@@ -191,6 +284,7 @@ module Twilio
                     # @return [IpCommandContext] IpCommandContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -203,7 +297,13 @@ module Twilio
                     # @return [IpCommandInstance] Fetched IpCommandInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         IpCommandInstance.new(
                             @version,
                             payload,
@@ -211,6 +311,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the IpCommandInstanceMetadata
+                    # @return [IpCommandInstance] Fetched IpCommandInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        ip_command_instance = IpCommandInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        IpCommandInstanceMetadata.new(
+                            @version,
+                            ip_command_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -227,6 +352,53 @@ module Twilio
                     end
                 end
 
+                class IpCommandInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new IpCommandInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}IpCommandInstance] ip_command_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [IpCommandInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, ip_command_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @ip_command_instance = ip_command_instance
+                    end
+
+                    def ip_command
+                        @ip_command_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.IpCommandInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class IpCommandListResponse < InstanceListResource
+                    # @param [Array<IpCommandInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @ip_command_instance = payload.body[key].map do |data|
+                        IpCommandInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def ip_command_instance
+                          @instance
+                      end
+                  end
+
                 class IpCommandPage < Page
                     ##
                     # Initialize the IpCommandPage
@@ -236,6 +408,7 @@ module Twilio
                     # @return [IpCommandPage] IpCommandPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -255,6 +428,66 @@ module Twilio
                         '<Twilio.Supersim.V1.IpCommandPage>'
                     end
                 end
+
+                class IpCommandPageMetadata < PageMetadata
+                    attr_reader :ip_command_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @ip_command_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @ip_command_page << IpCommandListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @ip_command_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class IpCommandListResponse < InstanceListResource
+
+                    # @param [Array<IpCommandInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @ip_command = data_list.map do |data|
+                        IpCommandInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def ip_command
+                        @ip_command
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class IpCommandInstance < InstanceResource
                     ##
                     # Initialize the IpCommandInstance
@@ -268,6 +501,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -18,12 +18,14 @@ module Twilio
         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"
@@ -77,7 +79,39 @@ module Twilio
                             mnc: mnc,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists NetworkPageMetadata records from the API as a list.
+                      # @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_with_metadata(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'IsoCountry' => iso_country,
+                            'Mcc' => mcc,
+                            'Mnc' => mnc,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        NetworkPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -89,9 +123,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -104,7 +142,7 @@ module Twilio
                     # @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)
+                    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,
@@ -113,8 +151,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         NetworkPage.new(@version, response, @solution)
                     end
@@ -141,8 +182,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class NetworkContext < InstanceContext
                     ##
                     # Initialize the NetworkContext
@@ -151,6 +190,7 @@ module Twilio
                     # @return [NetworkContext] NetworkContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -163,7 +203,13 @@ module Twilio
                     # @return [NetworkInstance] Fetched NetworkInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         NetworkInstance.new(
                             @version,
                             payload,
@@ -171,6 +217,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the NetworkInstanceMetadata
+                    # @return [NetworkInstance] Fetched NetworkInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        network_instance = NetworkInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        NetworkInstanceMetadata.new(
+                            @version,
+                            network_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -187,6 +258,53 @@ module Twilio
                     end
                 end
 
+                class NetworkInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new NetworkInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}NetworkInstance] network_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [NetworkInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, network_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @network_instance = network_instance
+                    end
+
+                    def network
+                        @network_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.NetworkInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class NetworkListResponse < InstanceListResource
+                    # @param [Array<NetworkInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @network_instance = payload.body[key].map do |data|
+                        NetworkInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def network_instance
+                          @instance
+                      end
+                  end
+
                 class NetworkPage < Page
                     ##
                     # Initialize the NetworkPage
@@ -196,6 +314,7 @@ module Twilio
                     # @return [NetworkPage] NetworkPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -215,6 +334,66 @@ module Twilio
                         '<Twilio.Supersim.V1.NetworkPage>'
                     end
                 end
+
+                class NetworkPageMetadata < PageMetadata
+                    attr_reader :network_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @network_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @network_page << NetworkListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @network_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class NetworkListResponse < InstanceListResource
+
+                    # @param [Array<NetworkInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @network = data_list.map do |data|
+                        NetworkInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def network
+                        @network
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class NetworkInstance < InstanceResource
                     ##
                     # Initialize the NetworkInstance
@@ -228,6 +407,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],