twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Studio < StudioBase
             class V2 < Version
                 class FlowValidateList < ListResource
+                
                     ##
                     # Initialize the FlowValidateList
                     # @param [Version] version Version that contains the resource
                     # @return [FlowValidateList] FlowValidateList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Flows/Validate"
@@ -37,10 +39,10 @@ module Twilio
                     # @param [String] commit_message Description of change made in the revision.
                     # @return [FlowValidateInstance] Updated FlowValidateInstance
                     def update(
-                        friendly_name: nil, 
-                        status: nil, 
-                        definition: nil, 
-                        commit_message: :unset
+                      friendly_name: nil, 
+                      status: nil, 
+                      definition: nil, 
+                      commit_message: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -50,13 +52,59 @@ module Twilio
                             'CommitMessage' => commit_message,
                         })
 
-                        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)
                         FlowValidateInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Update the FlowValidateInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the Flow.
+                    # @param [Status] status 
+                    # @param [Object] definition JSON representation of flow definition.
+                    # @param [String] commit_message Description of change made in the revision.
+                    # @return [FlowValidateInstance] Updated FlowValidateInstance
+                    def update_with_metadata(
+                      friendly_name: nil, 
+                      status: nil, 
+                      definition: nil, 
+                      commit_message: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Status' => status,
+                            'Definition' => Twilio.serialize_object(definition),
+                            'CommitMessage' => commit_message,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        flow_validate_instance = FlowValidateInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        FlowValidateInstanceMetadata.new(
+                            @version,
+                            flow_validate_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -75,6 +123,7 @@ module Twilio
                     # @return [FlowValidatePage] FlowValidatePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -94,6 +143,66 @@ module Twilio
                         '<Twilio.Studio.V2.FlowValidatePage>'
                     end
                 end
+
+                class FlowValidatePageMetadata < PageMetadata
+                    attr_reader :flow_validate_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_validate_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_validate_page << FlowValidateListResponse.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
+                        @flow_validate_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class FlowValidateListResponse < InstanceListResource
+
+                    # @param [Array<FlowValidateInstance>] 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
+                      @flow_validate = data_list.map do |data|
+                        FlowValidateInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow_validate
+                        @flow_validate
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowValidateInstance < InstanceResource
                     ##
                     # Initialize the FlowValidateInstance
@@ -107,6 +216,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'valid' => payload['valid'],

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

@@ -33,6 +33,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @flows ||= FlowList.new self
                     else

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

@@ -18,12 +18,14 @@ module Twilio
         class Supersim < SupersimBase
             class V1 < Version
                 class EsimProfileList < ListResource
+                
                     ##
                     # Initialize the EsimProfileList
                     # @param [Version] version Version that contains the resource
                     # @return [EsimProfileList] EsimProfileList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/ESimProfiles"
@@ -37,10 +39,10 @@ module Twilio
                     # @param [String] eid Identifier of the eUICC that will claim the eSIM Profile.
                     # @return [EsimProfileInstance] Created EsimProfileInstance
                     def create(
-                        callback_url: :unset, 
-                        callback_method: :unset, 
-                        generate_matching_id: :unset, 
-                        eid: :unset
+                      callback_url: :unset, 
+                      callback_method: :unset, 
+                      generate_matching_id: :unset, 
+                      eid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -50,20 +52,66 @@ module Twilio
                             'Eid' => eid,
                         })
 
-                        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)
                         EsimProfileInstance.new(
                             @version,
                             payload,
                         )
                     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.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
                     # @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/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
+                    # @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
@@ -87,7 +135,7 @@ module Twilio
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
                     # @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/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
+                    # @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
@@ -105,7 +153,39 @@ module Twilio
                             status: status,
                             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 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
 
                     ##
@@ -117,22 +197,26 @@ 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
 
                     ##
                     # Retrieve a single page of EsimProfileInstance records from the API.
                     # Request is executed immediately.
                     # @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/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
+                    # @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 [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 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,
@@ -141,8 +225,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)
 
                         EsimProfilePage.new(@version, response, @solution)
                     end
@@ -169,8 +256,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class EsimProfileContext < InstanceContext
                     ##
                     # Initialize the EsimProfileContext
@@ -179,6 +264,7 @@ module Twilio
                     # @return [EsimProfileContext] EsimProfileContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -191,7 +277,13 @@ module Twilio
                     # @return [EsimProfileInstance] Fetched EsimProfileInstance
                     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)
                         EsimProfileInstance.new(
                             @version,
                             payload,
@@ -199,6 +291,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
@@ -215,6 +332,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
@@ -224,6 +388,7 @@ module Twilio
                     # @return [EsimProfilePage] EsimProfilePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +408,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
@@ -256,6 +481,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -309,7 +535,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The SID of the [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource that this eSIM Profile controls.
+                    # @return [String] The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls.
                     def sim_sid
                         @properties['sim_sid']
                     end