twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/{microvisor/v1/app.rb → assistants/v1/knowledge/chunk.rb}

@@ -4,7 +4,7 @@
 #     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
-#    Twilio - Microvisor
+#    Twilio - Assistants
 #    This is the public Twilio REST API.
 #
 #    NOTE: This class is auto generated by OpenAPI Generator.
@@ -15,23 +15,27 @@
 
 module Twilio
     module REST
-        class Microvisor < MicrovisorBase
+        class Assistants < AssistantsBase
             class V1 < Version
-                class AppList < ListResource
+                class Knowledge < InstanceContext
+
+                     class ChunkList < ListResource
+                
                     ##
-                    # Initialize the AppList
+                    # Initialize the ChunkList
                     # @param [Version] version Version that contains the resource
-                    # @return [AppList] AppList
-                    def initialize(version)
+                    # @return [ChunkList] ChunkList
+                    def initialize(version, id: nil)
                         super(version)
+                        
                         # Path Solution
-                        @solution = {  }
-                        @uri = "/Apps"
+                        @solution = { id: id }
+                        @uri = "/Knowledge/#{@solution[:id]}/Chunks"
                         
                     end
                 
                     ##
-                    # Lists AppInstance records from the API as a list.
+                    # Lists ChunkInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
                     # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -65,11 +69,37 @@ 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 ChunkPageMetadata 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)
+
+                        ChunkPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
-                    # When passed a block, yields AppInstance records from the API.
+                    # When passed a block, yields ChunkInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
                     def each
@@ -77,273 +107,219 @@ 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 AppInstance records from the API.
+                    # Retrieve a single page of ChunkInstance records from the API.
                     # Request is executed immediately.
                     # @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 AppInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    # @return [Page] Page of ChunkInstance
+                    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)
 
-                        AppPage.new(@version, response, @solution)
+                        ChunkPage.new(@version, response, @solution)
                     end
 
                     ##
-                    # Retrieve a single page of AppInstance records from the API.
+                    # Retrieve a single page of ChunkInstance records from the API.
                     # Request is executed immediately.
                     # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of AppInstance
+                    # @return [Page] Page of ChunkInstance
                     def get_page(target_url)
                         response = @version.domain.request(
                             'GET',
                             target_url
                         )
-                    AppPage.new(@version, response, @solution)
+                    ChunkPage.new(@version, response, @solution)
                     end
                     
 
 
                     # Provide a user friendly representation
                     def to_s
-                        '#<Twilio.Microvisor.V1.AppList>'
+                        '#<Twilio.Assistants.V1.ChunkList>'
                     end
                 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 AppContext < InstanceContext
+                class ChunkPage < Page
                     ##
-                    # Initialize the AppContext
+                    # Initialize the ChunkPage
                     # @param [Version] version Version that contains the resource
-                    # @param [String] sid A 34-character string that uniquely identifies this App.
-                    # @return [AppContext] AppContext
-                    def initialize(version, sid)
-                        super(version)
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ChunkPage] ChunkPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
 
                         # Path Solution
-                        @solution = { sid: sid,  }
-                        @uri = "/Apps/#{@solution[:sid]}"
-
-                        # Dependents
-                        @app_manifests = nil
-                    end
-                    ##
-                    # Delete the AppInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        @version.delete('DELETE', @uri)
-                    end
-
-                    ##
-                    # Fetch the AppInstance
-                    # @return [AppInstance] Fetched AppInstance
-                    def fetch
-
-                        payload = @version.fetch('GET', @uri)
-                        AppInstance.new(
-                            @version,
-                            payload,
-                            sid: @solution[:sid],
-                        )
+                        @solution = solution
                     end
 
                     ##
-                    # Access the app_manifests
-                    # @return [AppManifestList]
-                    # @return [AppManifestContext]
-                    def app_manifests
-                        AppManifestContext.new(
-                                @version,
-                                @solution[:sid]
-                                )
+                    # Build an instance of ChunkInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ChunkInstance] ChunkInstance
+                    def get_instance(payload)
+                        ChunkInstance.new(@version, payload, id: @solution[:id])
                     end
 
                     ##
                     # Provide a user friendly representation
                     def to_s
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Microvisor.V1.AppContext #{context}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Microvisor.V1.AppContext #{context}>"
+                        '<Twilio.Assistants.V1.ChunkPage>'
                     end
                 end
 
-                class AppPage < Page
-                    ##
-                    # Initialize the AppPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [AppPage] AppPage
-                    def initialize(version, response, solution)
-                        super(version, response)
+                class ChunkPageMetadata < PageMetadata
+                    attr_reader :chunk_page
 
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @chunk_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @chunk_page << ChunkListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
                         # Path Solution
                         @solution = solution
                     end
 
-                    ##
-                    # Build an instance of AppInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [AppInstance] AppInstance
-                    def get_instance(payload)
-                        AppInstance.new(@version, payload)
+                    def each
+                        @chunk_page.each do |record|
+                          yield record
+                        end
                     end
 
-                    ##
-                    # Provide a user friendly representation
                     def to_s
-                        '<Twilio.Microvisor.V1.AppPage>'
+                      '<Twilio::REST::Assistants::V1PageMetadata>';
+                    end
+                end
+                class ChunkListResponse < InstanceListResource
+
+                    # @param [Array<ChunkInstance>] 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
+                      @chunk = data_list.map do |data|
+                        ChunkInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def chunk
+                        @chunk
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
                     end
                 end
-                class AppInstance < InstanceResource
+
+                class ChunkInstance < InstanceResource
                     ##
-                    # Initialize the AppInstance
+                    # Initialize the ChunkInstance
                     # @param [Version] version Version that contains the resource
                     # @param [Hash] payload payload that contains response from Twilio
                     # @param [String] account_sid The SID of the
-                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this App
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Chunk
                     #   resource.
                     # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [AppInstance] AppInstance
-                    def initialize(version, payload , sid: nil)
+                    # @return [ChunkInstance] ChunkInstance
+                    def initialize(version, payload , id: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
-                            'sid' => payload['sid'],
                             'account_sid' => payload['account_sid'],
-                            'hash' => payload['hash'],
-                            'unique_name' => payload['unique_name'],
+                            'content' => payload['content'],
+                            'metadata' => payload['metadata'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                            'url' => payload['url'],
-                            'links' => payload['links'],
                         }
-
-                        # Context
-                        @instance_context = nil
-                        @params = { 'sid' => sid  || @properties['sid']  , }
                     end
 
-                    ##
-                    # Generate an instance context for the instance, the context is capable of
-                    # performing various actions.  All instance actions are proxied to the context
-                    # @return [AppContext] CallContext for this CallInstance
-                    def context
-                        unless @instance_context
-                            @instance_context = AppContext.new(@version , @params['sid'])
-                        end
-                        @instance_context
-                    end
-                    
-                    ##
-                    # @return [String] A 34-character string that uniquely identifies this App.
-                    def sid
-                        @properties['sid']
-                    end
                     
                     ##
-                    # @return [String] The unique SID identifier of the Account.
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [String] App manifest hash represented as `hash_algorithm:hash_value`.
-                    def hash
-                        @properties['hash']
+                    # @return [String] The chunk content.
+                    def content
+                        @properties['content']
                     end
                     
                     ##
-                    # @return [String] A developer-defined string that uniquely identifies the App. This value must be unique for all Apps on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.
-                    def unique_name
-                        @properties['unique_name']
+                    # @return [Hash] The metadata of the chunk.
+                    def metadata
+                        @properties['metadata']
                     end
                     
                     ##
-                    # @return [Time] The date that this App was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    # @return [Time] The date and time in GMT when the Chunk was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_created
                         @properties['date_created']
                     end
                     
                     ##
-                    # @return [Time] The date that this App was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    # @return [Time] The date and time in GMT when the Chunk was updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_updated
                         @properties['date_updated']
                     end
                     
-                    ##
-                    # @return [String] The URL of this resource.
-                    def url
-                        @properties['url']
-                    end
-                    
-                    ##
-                    # @return [Hash] 
-                    def links
-                        @properties['links']
-                    end
-                    
-                    ##
-                    # Delete the AppInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        context.delete
-                    end
-
-                    ##
-                    # Fetch the AppInstance
-                    # @return [AppInstance] Fetched AppInstance
-                    def fetch
-
-                        context.fetch
-                    end
-
-                    ##
-                    # Access the app_manifests
-                    # @return [app_manifests] app_manifests
-                    def app_manifests
-                        context.app_manifests
-                    end
-
                     ##
                     # Provide a user friendly representation
                     def to_s
-                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Microvisor.V1.AppInstance #{values}>"
+                        "<Twilio.Assistants.V1.ChunkInstance>"
                     end
 
                     ##
                     # Provide a detailed, user friendly representation
                     def inspect
-                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Microvisor.V1.AppInstance #{values}>"
+                        "<Twilio.Assistants.V1.ChunkInstance>"
                     end
                 end
 
+             end
             end
         end
     end
 end
+
+