twilio-ruby 7.3.1 → 7.3.3

data/lib/twilio-ruby/rest/{preview/deployed_devices/fleet/key.rb → assistants/v1/assistant/assistants_knowledge.rb}

@@ -4,7 +4,7 @@
 #     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
-#    Twilio - Preview
+#    Twilio - Assistants
 #    This is the public Twilio REST API.
 #
 #    NOTE: This class is auto generated by OpenAPI Generator.
@@ -15,54 +15,28 @@
 
 module Twilio
     module REST
-        class Preview < PreviewBase
-            class DeployedDevices < Version
-                class FleetContext < InstanceContext
+        class Assistants < AssistantsBase
+            class V1 < Version
+                class AssistantContext < InstanceContext
 
-                     class KeyList < ListResource
+                     class AssistantsKnowledgeList < ListResource
                 
                     ##
-                    # Initialize the KeyList
+                    # Initialize the AssistantsKnowledgeList
                     # @param [Version] version Version that contains the resource
-                    # @return [KeyList] KeyList
-                    def initialize(version, fleet_sid: nil)
+                    # @return [AssistantsKnowledgeList] AssistantsKnowledgeList
+                    def initialize(version, assistant_id: nil)
                         super(version)
                         # Path Solution
-                        @solution = { fleet_sid: fleet_sid }
-                        @uri = "/Fleets/#{@solution[:fleet_sid]}/Keys"
+                        @solution = { assistant_id: assistant_id }
+                        @uri = "/Assistants/#{@solution[:assistant_id]}/Knowledge"
                         
                     end
-                    ##
-                    # Create the KeyInstance
-                    # @param [String] friendly_name Provides a human readable descriptive text for this Key credential, up to 256 characters long.
-                    # @param [String] device_sid Provides the unique string identifier of an existing Device to become authenticated with this Key credential.
-                    # @return [KeyInstance] Created KeyInstance
-                    def create(
-                        friendly_name: :unset, 
-                        device_sid: :unset
-                    )
-
-                        data = Twilio::Values.of({
-                            'FriendlyName' => friendly_name,
-                            'DeviceSid' => device_sid,
-                        })
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        payload = @version.create('POST', @uri, data: data, headers: headers)
-                        KeyInstance.new(
-                            @version,
-                            payload,
-                            fleet_sid: @solution[:fleet_sid],
-                        )
-                    end
-
                 
                     ##
-                    # Lists KeyInstance records from the API as a list.
+                    # Lists AssistantsKnowledgeInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
-                    # @param [String] device_sid Filters the resulting list of Keys by a unique string identifier of an authenticated Device.
                     # @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
@@ -70,9 +44,8 @@ module Twilio
                     #    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(device_sid: :unset, limit: nil, page_size: nil)
+                    def list(limit: nil, page_size: nil)
                         self.stream(
-                            device_sid: device_sid,
                             limit: limit,
                             page_size: page_size
                         ).entries
@@ -82,7 +55,6 @@ module Twilio
                     # Streams Instance records from the API as an Enumerable.
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
-                    # @param [String] device_sid Filters the resulting list of Keys by a unique string identifier of an authenticated Device.
                     # @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
@@ -90,18 +62,17 @@ module Twilio
                     #    but a limit is defined, stream() will attempt to read the limit with the most
                     #    efficient page size, i.e. min(limit, 1000)
                     # @return [Enumerable] Enumerable that will yield up to limit results
-                    def stream(device_sid: :unset, limit: nil, page_size: nil)
+                    def stream(limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
-                            device_sid: device_sid,
                             page_size: limits[:page_size], )
 
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
                     ##
-                    # When passed a block, yields KeyInstance records from the API.
+                    # When passed a block, yields AssistantsKnowledgeInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
                     def each
@@ -115,16 +86,14 @@ module Twilio
                     end
 
                     ##
-                    # Retrieve a single page of KeyInstance records from the API.
+                    # Retrieve a single page of AssistantsKnowledgeInstance records from the API.
                     # Request is executed immediately.
-                    # @param [String] device_sid Filters the resulting list of Keys by a unique string identifier of an authenticated Device.
                     # @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 KeyInstance
-                    def page(device_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    # @return [Page] Page of AssistantsKnowledgeInstance
+                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
                         params = Twilio::Values.of({
-                            'DeviceSid' => device_sid,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
@@ -132,97 +101,71 @@ module Twilio
 
                         response = @version.page('GET', @uri, params: params)
 
-                        KeyPage.new(@version, response, @solution)
+                        AssistantsKnowledgePage.new(@version, response, @solution)
                     end
 
                     ##
-                    # Retrieve a single page of KeyInstance records from the API.
+                    # Retrieve a single page of AssistantsKnowledgeInstance records from the API.
                     # Request is executed immediately.
                     # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of KeyInstance
+                    # @return [Page] Page of AssistantsKnowledgeInstance
                     def get_page(target_url)
                         response = @version.domain.request(
                             'GET',
                             target_url
                         )
-                    KeyPage.new(@version, response, @solution)
+                    AssistantsKnowledgePage.new(@version, response, @solution)
                     end
                     
 
 
                     # Provide a user friendly representation
                     def to_s
-                        '#<Twilio.Preview.DeployedDevices.KeyList>'
+                        '#<Twilio.Assistants.V1.AssistantsKnowledgeList>'
                     end
                 end
 
 
-                class KeyContext < InstanceContext
+                class AssistantsKnowledgeContext < InstanceContext
                     ##
-                    # Initialize the KeyContext
+                    # Initialize the AssistantsKnowledgeContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] fleet_sid 
-                    # @param [String] sid Provides a 34 character string that uniquely identifies the requested Key credential resource.
-                    # @return [KeyContext] KeyContext
-                    def initialize(version, fleet_sid, sid)
+                    # @param [String] assistant_id The assistant ID.
+                    # @param [String] id The knowledge ID.
+                    # @return [AssistantsKnowledgeContext] AssistantsKnowledgeContext
+                    def initialize(version, assistant_id, id)
                         super(version)
 
                         # Path Solution
-                        @solution = { fleet_sid: fleet_sid, sid: sid,  }
-                        @uri = "/Fleets/#{@solution[:fleet_sid]}/Keys/#{@solution[:sid]}"
+                        @solution = { assistant_id: assistant_id, id: id,  }
+                        @uri = "/Assistants/#{@solution[:assistant_id]}/Knowledge/#{@solution[:id]}"
 
                         
                     end
                     ##
-                    # Delete the KeyInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
+                    # Create the AssistantsKnowledgeInstance
+                    # @return [AssistantsKnowledgeInstance] Created AssistantsKnowledgeInstance
+                    def create
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
-                        @version.delete('DELETE', @uri, headers: headers)
-                    end
-
-                    ##
-                    # Fetch the KeyInstance
-                    # @return [KeyInstance] Fetched KeyInstance
-                    def fetch
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        payload = @version.fetch('GET', @uri, headers: headers)
-                        KeyInstance.new(
+                        payload = @version.create('POST', @uri, headers: headers)
+                        AssistantsKnowledgeInstance.new(
                             @version,
                             payload,
-                            fleet_sid: @solution[:fleet_sid],
-                            sid: @solution[:sid],
+                            assistant_id: @solution[:assistant_id],
+                            id: @solution[:id],
                         )
                     end
 
                     ##
-                    # Update the KeyInstance
-                    # @param [String] friendly_name Provides a human readable descriptive text for this Key credential, up to 256 characters long.
-                    # @param [String] device_sid Provides the unique string identifier of an existing Device to become authenticated with this Key credential.
-                    # @return [KeyInstance] Updated KeyInstance
-                    def update(
-                        friendly_name: :unset, 
-                        device_sid: :unset
-                    )
-
-                        data = Twilio::Values.of({
-                            'FriendlyName' => friendly_name,
-                            'DeviceSid' => device_sid,
-                        })
+                    # Delete the AssistantsKnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
-                        payload = @version.update('POST', @uri, data: data, headers: headers)
-                        KeyInstance.new(
-                            @version,
-                            payload,
-                            fleet_sid: @solution[:fleet_sid],
-                            sid: @solution[:sid],
-                        )
+                        @version.delete('DELETE', @uri, headers: headers)
                     end
 
 
@@ -230,24 +173,24 @@ module Twilio
                     # Provide a user friendly representation
                     def to_s
                         context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Preview.DeployedDevices.KeyContext #{context}>"
+                        "#<Twilio.Assistants.V1.AssistantsKnowledgeContext #{context}>"
                     end
 
                     ##
                     # Provide a detailed, user friendly representation
                     def inspect
                         context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Preview.DeployedDevices.KeyContext #{context}>"
+                        "#<Twilio.Assistants.V1.AssistantsKnowledgeContext #{context}>"
                     end
                 end
 
-                class KeyPage < Page
+                class AssistantsKnowledgePage < Page
                     ##
-                    # Initialize the KeyPage
+                    # Initialize the AssistantsKnowledgePage
                     # @param [Version] version Version that contains the resource
                     # @param [Response] response Response from the API
                     # @param [Hash] solution Path solution for the resource
-                    # @return [KeyPage] KeyPage
+                    # @return [AssistantsKnowledgePage] AssistantsKnowledgePage
                     def initialize(version, response, solution)
                         super(version, response)
 
@@ -256,159 +199,150 @@ module Twilio
                     end
 
                     ##
-                    # Build an instance of KeyInstance
+                    # Build an instance of AssistantsKnowledgeInstance
                     # @param [Hash] payload Payload response from the API
-                    # @return [KeyInstance] KeyInstance
+                    # @return [AssistantsKnowledgeInstance] AssistantsKnowledgeInstance
                     def get_instance(payload)
-                        KeyInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid])
+                        AssistantsKnowledgeInstance.new(@version, payload, assistant_id: @solution[:assistant_id])
                     end
 
                     ##
                     # Provide a user friendly representation
                     def to_s
-                        '<Twilio.Preview.DeployedDevices.KeyPage>'
+                        '<Twilio.Assistants.V1.AssistantsKnowledgePage>'
                     end
                 end
-                class KeyInstance < InstanceResource
+                class AssistantsKnowledgeInstance < InstanceResource
                     ##
-                    # Initialize the KeyInstance
+                    # Initialize the AssistantsKnowledgeInstance
                     # @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 Key
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this AssistantsKnowledge
                     #   resource.
                     # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [KeyInstance] KeyInstance
-                    def initialize(version, payload , fleet_sid: nil, sid: nil)
+                    # @return [AssistantsKnowledgeInstance] AssistantsKnowledgeInstance
+                    def initialize(version, payload , assistant_id: nil, id: nil)
                         super(version)
                         
                         # Marshaled Properties
                         @properties = { 
-                            'sid' => payload['sid'],
-                            'url' => payload['url'],
-                            'friendly_name' => payload['friendly_name'],
-                            'fleet_sid' => payload['fleet_sid'],
+                            'description' => payload['description'],
+                            'id' => payload['id'],
                             'account_sid' => payload['account_sid'],
-                            'device_sid' => payload['device_sid'],
-                            'secret' => payload['secret'],
+                            'knowledge_source_details' => payload['knowledge_source_details'],
+                            'name' => payload['name'],
+                            'status' => payload['status'],
+                            'type' => payload['type'],
+                            'url' => payload['url'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                         }
 
                         # Context
                         @instance_context = nil
-                        @params = { 'fleet_sid' => fleet_sid  || @properties['fleet_sid']  ,'sid' => sid  || @properties['sid']  , }
+                        @params = { 'assistant_id' => assistant_id  || @properties['assistant_id']  ,'id' => id  || @properties['id']  , }
                     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 [KeyContext] CallContext for this CallInstance
+                    # @return [AssistantsKnowledgeContext] CallContext for this CallInstance
                     def context
                         unless @instance_context
-                            @instance_context = KeyContext.new(@version , @params['fleet_sid'], @params['sid'])
+                            @instance_context = AssistantsKnowledgeContext.new(@version , @params['assistant_id'], @params['id'])
                         end
                         @instance_context
                     end
                     
                     ##
-                    # @return [String] Contains a 34 character string that uniquely identifies this Key credential resource.
-                    def sid
-                        @properties['sid']
+                    # @return [String] The type of knowledge source.
+                    def description
+                        @properties['description']
                     end
                     
                     ##
-                    # @return [String] Contains an absolute URL for this Key credential resource.
-                    def url
-                        @properties['url']
+                    # @return [String] The description of knowledge.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @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] Contains a human readable descriptive text for this Key credential, up to 256 characters long.
-                    def friendly_name
-                        @properties['friendly_name']
+                    # @return [Hash] The details of the knowledge source based on the type.
+                    def knowledge_source_details
+                        @properties['knowledge_source_details']
                     end
                     
                     ##
-                    # @return [String] Specifies the unique string identifier of the Fleet that the given Key credential belongs to.
-                    def fleet_sid
-                        @properties['fleet_sid']
+                    # @return [String] The name of the knowledge source.
+                    def name
+                        @properties['name']
                     end
                     
                     ##
-                    # @return [String] Specifies the unique string identifier of the Account responsible for this Key credential.
-                    def account_sid
-                        @properties['account_sid']
+                    # @return [String] The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def status
+                        @properties['status']
                     end
                     
                     ##
-                    # @return [String] Specifies the unique string identifier of a Device authenticated with this Key credential.
-                    def device_sid
-                        @properties['device_sid']
+                    # @return [String] The type of knowledge source ('Web', 'Database', 'Text', 'File')
+                    def type
+                        @properties['type']
                     end
                     
                     ##
-                    # @return [String] Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device.
-                    def secret
-                        @properties['secret']
+                    # @return [String] The url of the knowledge resource.
+                    def url
+                        @properties['url']
                     end
                     
                     ##
-                    # @return [Time] Specifies the date this Key credential was created, given in UTC ISO 8601 format.
+                    # @return [Time] The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_created
                         @properties['date_created']
                     end
                     
                     ##
-                    # @return [Time] Specifies the date this Key credential was last updated, given in UTC ISO 8601 format.
+                    # @return [Time] The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_updated
                         @properties['date_updated']
                     end
                     
                     ##
-                    # Delete the KeyInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
+                    # Create the AssistantsKnowledgeInstance
+                    # @return [AssistantsKnowledgeInstance] Created AssistantsKnowledgeInstance
+                    def create
 
-                        context.delete
+                        context.create
                     end
 
                     ##
-                    # Fetch the KeyInstance
-                    # @return [KeyInstance] Fetched KeyInstance
-                    def fetch
-
-                        context.fetch
-                    end
+                    # Delete the AssistantsKnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
 
-                    ##
-                    # Update the KeyInstance
-                    # @param [String] friendly_name Provides a human readable descriptive text for this Key credential, up to 256 characters long.
-                    # @param [String] device_sid Provides the unique string identifier of an existing Device to become authenticated with this Key credential.
-                    # @return [KeyInstance] Updated KeyInstance
-                    def update(
-                        friendly_name: :unset, 
-                        device_sid: :unset
-                    )
-
-                        context.update(
-                            friendly_name: friendly_name, 
-                            device_sid: device_sid, 
-                        )
+                        context.delete
                     end
 
                     ##
                     # Provide a user friendly representation
                     def to_s
                         values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Preview.DeployedDevices.KeyInstance #{values}>"
+                        "<Twilio.Assistants.V1.AssistantsKnowledgeInstance #{values}>"
                     end
 
                     ##
                     # Provide a detailed, user friendly representation
                     def inspect
                         values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Preview.DeployedDevices.KeyInstance #{values}>"
+                        "<Twilio.Assistants.V1.AssistantsKnowledgeInstance #{values}>"
                     end
                 end