twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/wireless/v1/sim.rb

@@ -18,12 +18,14 @@ module Twilio
         class Wireless < WirelessBase
             class V1 < Version
                 class SimList < ListResource
+                
                     ##
                     # Initialize the SimList
                     # @param [Version] version Version that contains the resource
                     # @return [SimList] SimList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Sims"
@@ -85,7 +87,43 @@ module Twilio
                             sim_registration_code: sim_registration_code,
                             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 SimPageMetadata records from the API as a list.
+                      # @param [Status] status Only return Sim resources with this status.
+                      # @param [String] iccid Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.
+                      # @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
+                      # @param [String] e_id Deprecated.
+                      # @param [String] sim_registration_code Only return Sim resources with this registration code. This will return a list with a maximum size of 1.
+                    # @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(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Status' => status,
+                            'Iccid' => iccid,
+                            'RatePlan' => rate_plan,
+                            'EId' => e_id,
+                            'SimRegistrationCode' => sim_registration_code,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SimPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -97,9 +135,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
 
                     ##
@@ -114,7 +156,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 SimInstance
-                    def page(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Status' => status,
                             'Iccid' => iccid,
@@ -125,8 +167,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)
 
                         SimPage.new(@version, response, @solution)
                     end
@@ -161,6 +206,7 @@ module Twilio
                     # @return [SimContext] SimContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -175,7 +221,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the SimInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          sim_instance = SimInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SimInstanceMetadata.new(@version, sim_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -183,7 +253,13 @@ module Twilio
                     # @return [SimInstance] Fetched SimInstance
                     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)
                         SimInstance.new(
                             @version,
                             payload,
@@ -191,6 +267,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SimInstanceMetadata
+                    # @return [SimInstance] Fetched SimInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        sim_instance = SimInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SimInstanceMetadata.new(
+                            @version,
+                            sim_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SimInstance
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource.
@@ -213,24 +314,24 @@ module Twilio
                     # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
                     # @return [SimInstance] Updated SimInstance
                     def update(
-                        unique_name: :unset, 
-                        callback_method: :unset, 
-                        callback_url: :unset, 
-                        friendly_name: :unset, 
-                        rate_plan: :unset, 
-                        status: :unset, 
-                        commands_callback_method: :unset, 
-                        commands_callback_url: :unset, 
-                        sms_fallback_method: :unset, 
-                        sms_fallback_url: :unset, 
-                        sms_method: :unset, 
-                        sms_url: :unset, 
-                        voice_fallback_method: :unset, 
-                        voice_fallback_url: :unset, 
-                        voice_method: :unset, 
-                        voice_url: :unset, 
-                        reset_status: :unset, 
-                        account_sid: :unset
+                      unique_name: :unset, 
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset, 
+                      rate_plan: :unset, 
+                      status: :unset, 
+                      commands_callback_method: :unset, 
+                      commands_callback_url: :unset, 
+                      sms_fallback_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_method: :unset, 
+                      sms_url: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_url: :unset, 
+                      reset_status: :unset, 
+                      account_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -254,7 +355,13 @@ module Twilio
                             'AccountSid' => account_sid,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         SimInstance.new(
                             @version,
                             payload,
@@ -262,6 +369,89 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SimInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource.
+                    # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+                    # @param [String] callback_url The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).
+                    # @param [String] friendly_name A descriptive string that you create to describe the Sim resource. It does not need to be unique.
+                    # @param [String] rate_plan The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
+                    # @param [Status] status 
+                    # @param [String] commands_callback_method The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+                    # @param [String] commands_callback_url The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
+                    # @param [String] sms_fallback_method The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
+                    # @param [String] sms_fallback_url The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.
+                    # @param [String] sms_method The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.
+                    # @param [String] sms_url The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource).
+                    # @param [String] voice_fallback_method Deprecated.
+                    # @param [String] voice_fallback_url Deprecated.
+                    # @param [String] voice_method Deprecated.
+                    # @param [String] voice_url Deprecated.
+                    # @param [ResetStatus] reset_status 
+                    # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
+                    # @return [SimInstance] Updated SimInstance
+                    def update_with_metadata(
+                      unique_name: :unset, 
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset, 
+                      rate_plan: :unset, 
+                      status: :unset, 
+                      commands_callback_method: :unset, 
+                      commands_callback_url: :unset, 
+                      sms_fallback_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_method: :unset, 
+                      sms_url: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_url: :unset, 
+                      reset_status: :unset, 
+                      account_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'CallbackMethod' => callback_method,
+                            'CallbackUrl' => callback_url,
+                            'FriendlyName' => friendly_name,
+                            'RatePlan' => rate_plan,
+                            'Status' => status,
+                            'CommandsCallbackMethod' => commands_callback_method,
+                            'CommandsCallbackUrl' => commands_callback_url,
+                            'SmsFallbackMethod' => sms_fallback_method,
+                            'SmsFallbackUrl' => sms_fallback_url,
+                            'SmsMethod' => sms_method,
+                            'SmsUrl' => sms_url,
+                            'VoiceFallbackMethod' => voice_fallback_method,
+                            'VoiceFallbackUrl' => voice_fallback_url,
+                            'VoiceMethod' => voice_method,
+                            'VoiceUrl' => voice_url,
+                            'ResetStatus' => reset_status,
+                            'AccountSid' => account_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        sim_instance = SimInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SimInstanceMetadata.new(
+                            @version,
+                            sim_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the data_sessions
                     # @return [DataSessionList]
@@ -300,6 +490,53 @@ module Twilio
                     end
                 end
 
+                class SimInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SimInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SimInstance] sim_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 [SimInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, sim_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @sim_instance = sim_instance
+                    end
+
+                    def sim
+                        @sim_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SimInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SimListResponse < InstanceListResource
+                    # @param [Array<SimInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @sim_instance = payload.body[key].map do |data|
+                        SimInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def sim_instance
+                          @instance
+                      end
+                  end
+
                 class SimPage < Page
                     ##
                     # Initialize the SimPage
@@ -309,6 +546,7 @@ module Twilio
                     # @return [SimPage] SimPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -328,6 +566,66 @@ module Twilio
                         '<Twilio.Wireless.V1.SimPage>'
                     end
                 end
+
+                class SimPageMetadata < PageMetadata
+                    attr_reader :sim_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sim_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sim_page << SimListResponse.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
+                        @sim_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Wireless::V1PageMetadata>';
+                    end
+                end
+                class SimListResponse < InstanceListResource
+
+                    # @param [Array<SimInstance>] 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
+                      @sim = data_list.map do |data|
+                        SimInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sim
+                        @sim
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SimInstance < InstanceResource
                     ##
                     # Initialize the SimInstance
@@ -341,6 +639,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -567,24 +866,24 @@ module Twilio
                     # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
                     # @return [SimInstance] Updated SimInstance
                     def update(
-                        unique_name: :unset, 
-                        callback_method: :unset, 
-                        callback_url: :unset, 
-                        friendly_name: :unset, 
-                        rate_plan: :unset, 
-                        status: :unset, 
-                        commands_callback_method: :unset, 
-                        commands_callback_url: :unset, 
-                        sms_fallback_method: :unset, 
-                        sms_fallback_url: :unset, 
-                        sms_method: :unset, 
-                        sms_url: :unset, 
-                        voice_fallback_method: :unset, 
-                        voice_fallback_url: :unset, 
-                        voice_method: :unset, 
-                        voice_url: :unset, 
-                        reset_status: :unset, 
-                        account_sid: :unset
+                      unique_name: :unset, 
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset, 
+                      rate_plan: :unset, 
+                      status: :unset, 
+                      commands_callback_method: :unset, 
+                      commands_callback_url: :unset, 
+                      sms_fallback_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_method: :unset, 
+                      sms_url: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_url: :unset, 
+                      reset_status: :unset, 
+                      account_sid: :unset
                     )
 
                         context.update(