twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb

@@ -18,12 +18,14 @@ module Twilio
         class Preview < PreviewBase
             class Marketplace < Version
                 class InstalledAddOnList < ListResource
+                
                     ##
                     # Initialize the InstalledAddOnList
                     # @param [Version] version Version that contains the resource
                     # @return [InstalledAddOnList] InstalledAddOnList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/InstalledAddOns"
@@ -37,10 +39,10 @@ module Twilio
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
                     # @return [InstalledAddOnInstance] Created InstalledAddOnInstance
                     def create(
-                        available_add_on_sid: nil, 
-                        accept_terms_of_service: nil, 
-                        configuration: :unset, 
-                        unique_name: :unset
+                      available_add_on_sid: nil, 
+                      accept_terms_of_service: nil, 
+                      configuration: :unset, 
+                      unique_name: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -50,13 +52,59 @@ module Twilio
                             'UniqueName' => unique_name,
                         })
 
-                        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)
                         InstalledAddOnInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the InstalledAddOnInstanceMetadata
+                    # @param [String] available_add_on_sid The SID of the AvaliableAddOn to install.
+                    # @param [Boolean] accept_terms_of_service Whether the Terms of Service were accepted.
+                    # @param [Object] configuration The JSON object that represents the configuration of the new Add-on being installed.
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
+                    # @return [InstalledAddOnInstance] Created InstalledAddOnInstance
+                    def create_with_metadata(
+                      available_add_on_sid: nil, 
+                      accept_terms_of_service: nil, 
+                      configuration: :unset, 
+                      unique_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AvailableAddOnSid' => available_add_on_sid,
+                            'AcceptTermsOfService' => accept_terms_of_service,
+                            'Configuration' => Twilio.serialize_object(configuration),
+                            'UniqueName' => unique_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        installed_add_on_instance = InstalledAddOnInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        InstalledAddOnInstanceMetadata.new(
+                            @version,
+                            installed_add_on_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists InstalledAddOnInstance records from the API as a list.
@@ -93,7 +141,33 @@ module Twilio
                         page = self.page(
                             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 InstalledAddOnPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        InstalledAddOnPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -105,9 +179,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
 
                     ##
@@ -117,14 +195,17 @@ 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 InstalledAddOnInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             '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)
 
                         InstalledAddOnPage.new(@version, response, @solution)
                     end
@@ -151,8 +232,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
                 class InstalledAddOnContext < InstanceContext
                     ##
                     # Initialize the InstalledAddOnContext
@@ -161,6 +240,7 @@ module Twilio
                     # @return [InstalledAddOnContext] InstalledAddOnContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -174,7 +254,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 InstalledAddOnInstanceMetadata
+                    # @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)
+                          installedAddOn_instance = InstalledAddOnInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          InstalledAddOnInstanceMetadata.new(@version, installedAddOn_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -182,7 +286,13 @@ module Twilio
                     # @return [InstalledAddOnInstance] Fetched InstalledAddOnInstance
                     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)
                         InstalledAddOnInstance.new(
                             @version,
                             payload,
@@ -190,14 +300,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the InstalledAddOnInstanceMetadata
+                    # @return [InstalledAddOnInstance] Fetched InstalledAddOnInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        installed_add_on_instance = InstalledAddOnInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        InstalledAddOnInstanceMetadata.new(
+                            @version,
+                            installed_add_on_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the InstalledAddOnInstance
                     # @param [Object] configuration Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
                     # @return [InstalledAddOnInstance] Updated InstalledAddOnInstance
                     def update(
-                        configuration: :unset, 
-                        unique_name: :unset
+                      configuration: :unset, 
+                      unique_name: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -205,7 +340,13 @@ module Twilio
                             'UniqueName' => unique_name,
                         })
 
-                        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)
                         InstalledAddOnInstance.new(
                             @version,
                             payload,
@@ -213,6 +354,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the InstalledAddOnInstanceMetadata
+                    # @param [Object] configuration Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
+                    # @return [InstalledAddOnInstance] Updated InstalledAddOnInstance
+                    def update_with_metadata(
+                      configuration: :unset, 
+                      unique_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Configuration' => Twilio.serialize_object(configuration),
+                            'UniqueName' => unique_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        installed_add_on_instance = InstalledAddOnInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        InstalledAddOnInstanceMetadata.new(
+                            @version,
+                            installed_add_on_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the extensions
                     # @return [InstalledAddOnExtensionList]
@@ -248,6 +424,53 @@ module Twilio
                     end
                 end
 
+                class InstalledAddOnInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new InstalledAddOnInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}InstalledAddOnInstance] installed_add_on_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 [InstalledAddOnInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, installed_add_on_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @installed_add_on_instance = installed_add_on_instance
+                    end
+
+                    def installed_add_on
+                        @installed_add_on_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.InstalledAddOnInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class InstalledAddOnListResponse < InstanceListResource
+                    # @param [Array<InstalledAddOnInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @installed_add_on_instance = payload.body[key].map do |data|
+                        InstalledAddOnInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def installed_add_on_instance
+                          @instance
+                      end
+                  end
+
                 class InstalledAddOnPage < Page
                     ##
                     # Initialize the InstalledAddOnPage
@@ -257,6 +480,7 @@ module Twilio
                     # @return [InstalledAddOnPage] InstalledAddOnPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -276,6 +500,66 @@ module Twilio
                         '<Twilio.Preview.Marketplace.InstalledAddOnPage>'
                     end
                 end
+
+                class InstalledAddOnPageMetadata < PageMetadata
+                    attr_reader :installed_add_on_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @installed_add_on_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @installed_add_on_page << InstalledAddOnListResponse.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
+                        @installed_add_on_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Preview::MarketplacePageMetadata>';
+                    end
+                end
+                class InstalledAddOnListResponse < InstanceListResource
+
+                    # @param [Array<InstalledAddOnInstance>] 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
+                      @installed_add_on = data_list.map do |data|
+                        InstalledAddOnInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def installed_add_on
+                        @installed_add_on
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InstalledAddOnInstance < InstanceResource
                     ##
                     # Initialize the InstalledAddOnInstance
@@ -289,6 +573,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -401,8 +686,8 @@ module Twilio
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
                     # @return [InstalledAddOnInstance] Updated InstalledAddOnInstance
                     def update(
-                        configuration: :unset, 
-                        unique_name: :unset
+                      configuration: :unset, 
+                      unique_name: :unset
                     )
 
                         context.update(

data/lib/twilio-ruby/rest/preview/marketplace.rb

@@ -33,6 +33,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @available_add_ons ||= AvailableAddOnList.new self
                     else
@@ -47,6 +48,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @installed_add_ons ||= InstalledAddOnList.new self
                     else