twilio-ruby 7.9.1 → 7.10.0

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [EsimProfileList] EsimProfileList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/ESimProfiles"
@@ -64,6 +65,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the EsimProfileInstanceMetadata
+                    # @param [String] callback_url The URL we should call using the `callback_method` when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from `reserving` to `available`.
+                    # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
+                    # @param [Boolean] generate_matching_id When set to `true`, a value for `Eid` does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the `matching_id` property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.
+                    # @param [String] eid Identifier of the eUICC that will claim the eSIM Profile.
+                    # @return [EsimProfileInstance] Created EsimProfileInstance
+                    def create_with_metadata(
+                      callback_url: :unset, 
+                      callback_method: :unset, 
+                      generate_matching_id: :unset, 
+                      eid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CallbackUrl' => callback_url,
+                            'CallbackMethod' => callback_method,
+                            'GenerateMatchingId' => generate_matching_id,
+                            'Eid' => eid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        esim_profile_instance = EsimProfileInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        EsimProfileInstanceMetadata.new(
+                            @version,
+                            esim_profile_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists EsimProfileInstance records from the API as a list.
@@ -115,6 +156,34 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists EsimProfilePageMetadata records from the API as a list.
+                      # @param [String] eid List the eSIM Profiles that have been associated with an EId.
+                      # @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
+                      # @param [Status] status List the eSIM Profiles that are in a given status.
+                    # @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(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Eid' => eid,
+                            'SimSid' => sim_sid,
+                            'Status' => status,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EsimProfilePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields EsimProfileInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -139,7 +208,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 EsimProfileInstance
-                    def page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Eid' => eid,
                             'SimSid' => sim_sid,
@@ -187,6 +256,7 @@ module Twilio
                     # @return [EsimProfileContext] EsimProfileContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -213,6 +283,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the EsimProfileInstanceMetadata
+                    # @return [EsimProfileInstance] Fetched EsimProfileInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        esim_profile_instance = EsimProfileInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        EsimProfileInstanceMetadata.new(
+                            @version,
+                            esim_profile_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -229,6 +324,53 @@ module Twilio
                     end
                 end
 
+                class EsimProfileInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EsimProfileInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EsimProfileInstance] esim_profile_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 [EsimProfileInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, esim_profile_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @esim_profile_instance = esim_profile_instance
+                    end
+
+                    def esim_profile
+                        @esim_profile_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EsimProfileInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EsimProfileListResponse < InstanceListResource
+                    # @param [Array<EsimProfileInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @esim_profile_instance = payload.body[key].map do |data|
+                        EsimProfileInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def esim_profile_instance
+                          @instance
+                      end
+                  end
+
                 class EsimProfilePage < Page
                     ##
                     # Initialize the EsimProfilePage
@@ -238,6 +380,7 @@ module Twilio
                     # @return [EsimProfilePage] EsimProfilePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -257,6 +400,66 @@ module Twilio
                         '<Twilio.Supersim.V1.EsimProfilePage>'
                     end
                 end
+
+                class EsimProfilePageMetadata < PageMetadata
+                    attr_reader :esim_profile_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @esim_profile_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @esim_profile_page << EsimProfileListResponse.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
+                        @esim_profile_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class EsimProfileListResponse < InstanceListResource
+
+                    # @param [Array<EsimProfileInstance>] 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
+                      @esim_profile = data_list.map do |data|
+                        EsimProfileInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def esim_profile
+                        @esim_profile
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EsimProfileInstance < InstanceResource
                     ##
                     # Initialize the EsimProfileInstance
@@ -270,6 +473,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [FleetList] FleetList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Fleets"
@@ -79,6 +80,61 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the FleetInstanceMetadata
+                    # @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 data connectivity. Defaults to `true`.
+                    # @param [String] data_limit The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
+                    # @param [String] ip_commands_url The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
+                    # @param [String] ip_commands_method A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+                    # @param [Boolean] sms_commands_enabled Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.
+                    # @param [String] sms_commands_url The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
+                    # @param [String] sms_commands_method A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+                    # @return [FleetInstance] Created FleetInstance
+                    def create_with_metadata(
+                      network_access_profile: nil, 
+                      unique_name: :unset, 
+                      data_enabled: :unset, 
+                      data_limit: :unset, 
+                      ip_commands_url: :unset, 
+                      ip_commands_method: :unset, 
+                      sms_commands_enabled: :unset, 
+                      sms_commands_url: :unset, 
+                      sms_commands_method: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'NetworkAccessProfile' => network_access_profile,
+                            'UniqueName' => unique_name,
+                            'DataEnabled' => data_enabled,
+                            'DataLimit' => data_limit,
+                            'IpCommandsUrl' => ip_commands_url,
+                            'IpCommandsMethod' => ip_commands_method,
+                            'SmsCommandsEnabled' => sms_commands_enabled,
+                            'SmsCommandsUrl' => sms_commands_url,
+                            'SmsCommandsMethod' => sms_commands_method,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        fleet_instance = FleetInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        FleetInstanceMetadata.new(
+                            @version,
+                            fleet_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists FleetInstance records from the API as a list.
@@ -122,6 +178,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists FleetPageMetadata records from the API as a list.
+                      # @param [String] network_access_profile The SID or unique name of the Network 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
+                    #    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(network_access_profile: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'NetworkAccessProfile' => network_access_profile,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        FleetPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields FleetInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -144,7 +224,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 FleetInstance
-                    def page(network_access_profile: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(network_access_profile: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'NetworkAccessProfile' => network_access_profile,
                             'PageToken' => page_token,
@@ -190,6 +270,7 @@ module Twilio
                     # @return [FleetContext] FleetContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -216,6 +297,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FleetInstanceMetadata
+                    # @return [FleetInstance] Fetched FleetInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        fleet_instance = FleetInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FleetInstanceMetadata.new(
+                            @version,
+                            fleet_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the FleetInstance
                     # @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.
@@ -260,6 +366,56 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FleetInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
+                    # @param [String] network_access_profile The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
+                    # @param [String] ip_commands_url The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
+                    # @param [String] ip_commands_method A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+                    # @param [String] sms_commands_url The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
+                    # @param [String] sms_commands_method A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
+                    # @param [String] data_limit The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
+                    # @return [FleetInstance] Updated FleetInstance
+                    def update_with_metadata(
+                      unique_name: :unset, 
+                      network_access_profile: :unset, 
+                      ip_commands_url: :unset, 
+                      ip_commands_method: :unset, 
+                      sms_commands_url: :unset, 
+                      sms_commands_method: :unset, 
+                      data_limit: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'NetworkAccessProfile' => network_access_profile,
+                            'IpCommandsUrl' => ip_commands_url,
+                            'IpCommandsMethod' => ip_commands_method,
+                            'SmsCommandsUrl' => sms_commands_url,
+                            'SmsCommandsMethod' => sms_commands_method,
+                            'DataLimit' => data_limit,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        fleet_instance = FleetInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FleetInstanceMetadata.new(
+                            @version,
+                            fleet_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -276,6 +432,53 @@ module Twilio
                     end
                 end
 
+                class FleetInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FleetInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FleetInstance] fleet_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 [FleetInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, fleet_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @fleet_instance = fleet_instance
+                    end
+
+                    def fleet
+                        @fleet_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FleetInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FleetListResponse < InstanceListResource
+                    # @param [Array<FleetInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @fleet_instance = payload.body[key].map do |data|
+                        FleetInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def fleet_instance
+                          @instance
+                      end
+                  end
+
                 class FleetPage < Page
                     ##
                     # Initialize the FleetPage
@@ -285,6 +488,7 @@ module Twilio
                     # @return [FleetPage] FleetPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -304,6 +508,66 @@ module Twilio
                         '<Twilio.Supersim.V1.FleetPage>'
                     end
                 end
+
+                class FleetPageMetadata < PageMetadata
+                    attr_reader :fleet_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @fleet_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @fleet_page << FleetListResponse.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
+                        @fleet_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class FleetListResponse < InstanceListResource
+
+                    # @param [Array<FleetInstance>] 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
+                      @fleet = data_list.map do |data|
+                        FleetInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def fleet
+                        @fleet
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FleetInstance < InstanceResource
                     ##
                     # Initialize the FleetInstance
@@ -317,6 +581,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],