twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/preview/understand/{service/intent → assistant/task}/field.rb

@@ -3,28 +3,30 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Preview < Domain
       class Understand < Version
-        class ServiceContext < InstanceContext
-          class IntentContext < InstanceContext
+        class AssistantContext < InstanceContext
+          class TaskContext < InstanceContext
             ##
             # 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 FieldList < ListResource
               ##
               # Initialize the FieldList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] intent_sid The intent_sid
+              # @param [String] assistant_sid The unique ID of the parent Assistant.
+              # @param [String] task_sid The unique ID of the Task associated with this Field.
               # @return [FieldList] FieldList
-              def initialize(version, service_sid: nil, intent_sid: nil)
+              def initialize(version, assistant_sid: nil, task_sid: nil)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, intent_sid: intent_sid}
-                @uri = "/Services/#{@solution[:service_sid]}/Intents/#{@solution[:intent_sid]}/Fields"
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid}
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Fields"
               end
 
               ##
@@ -56,7 +58,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -68,7 +70,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -88,11 +90,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FieldPage.new(@version, response, @solution)
               end
 
@@ -110,25 +110,24 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FieldInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] field_type The field_type
-              # @param [String] unique_name The unique_name
-              # @return [FieldInstance] Newly created FieldInstance
+              # Create the FieldInstance
+              # @param [String] field_type The unique name or sid of the FieldType. It can be
+              #   any {Built-in Field
+              #   Type}[https://www.twilio.com/docs/assistant/api/built-in-field-types] or the
+              #   unique_name or the Field Type sid of a custom Field Type.
+              # @param [String] unique_name A user-provided string that uniquely identifies this
+              #   resource as an alternative to the sid. Unique up to 64 characters long.
+              # @return [FieldInstance] Created FieldInstance
               def create(field_type: nil, unique_name: nil)
-                data = Twilio::Values.of({'FieldType' => field_type, 'UniqueName' => unique_name})
+                data = Twilio::Values.of({'FieldType' => field_type, 'UniqueName' => unique_name, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FieldInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
-                    intent_sid: @solution[:intent_sid],
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
                 )
               end
 
@@ -163,8 +162,8 @@ module Twilio
                 FieldInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
-                    intent_sid: @solution[:intent_sid],
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
                 )
               end
 
@@ -181,44 +180,39 @@ module Twilio
               ##
               # Initialize the FieldContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] intent_sid The intent_sid
-              # @param [String] sid The sid
+              # @param [String] assistant_sid The unique ID of the Assistant.
+              # @param [String] task_sid The unique ID of the Task associated with this Field.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FieldContext] FieldContext
-              def initialize(version, service_sid, intent_sid, sid)
+              def initialize(version, assistant_sid, task_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, intent_sid: intent_sid, sid: sid}
-                @uri = "/Services/#{@solution[:service_sid]}/Intents/#{@solution[:intent_sid]}/Fields/#{@solution[:sid]}"
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid, sid: sid, }
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Fields/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a FieldInstance
+              # Fetch the FieldInstance
               # @return [FieldInstance] Fetched FieldInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FieldInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
-                    intent_sid: @solution[:intent_sid],
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
                     sid: @solution[:sid],
                 )
               end
 
               ##
-              # Deletes the FieldInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -227,6 +221,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Preview.Understand.FieldContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Understand.FieldContext #{context}>"
+              end
             end
 
             ##
@@ -236,11 +237,12 @@ module Twilio
               # Initialize the FieldInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] intent_sid The intent_sid
-              # @param [String] sid The sid
+              # @param [String] assistant_sid The unique ID of the parent Assistant.
+              # @param [String] task_sid The unique ID of the Task associated with this Field.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FieldInstance] FieldInstance
-              def initialize(version, payload, service_sid: nil, intent_sid: nil, sid: nil)
+              def initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil)
                 super(version)
 
                 # Marshaled Properties
@@ -249,8 +251,8 @@ module Twilio
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                     'field_type' => payload['field_type'],
-                    'intent_sid' => payload['intent_sid'],
-                    'service_sid' => payload['service_sid'],
+                    'task_sid' => payload['task_sid'],
+                    'assistant_sid' => payload['assistant_sid'],
                     'sid' => payload['sid'],
                     'unique_name' => payload['unique_name'],
                     'url' => payload['url'],
@@ -259,8 +261,8 @@ module Twilio
                 # Context
                 @instance_context = nil
                 @params = {
-                    'service_sid' => service_sid,
-                    'intent_sid' => intent_sid,
+                    'assistant_sid' => assistant_sid,
+                    'task_sid' => task_sid,
                     'sid' => sid || @properties['sid'],
                 }
               end
@@ -273,8 +275,8 @@ module Twilio
                 unless @instance_context
                   @instance_context = FieldContext.new(
                       @version,
-                      @params['service_sid'],
-                      @params['intent_sid'],
+                      @params['assistant_sid'],
+                      @params['task_sid'],
                       @params['sid'],
                   )
                 end
@@ -282,49 +284,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique ID of the Account that created this Field.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date that this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date that this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The field_type
+              # @return [String] The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type.
               def field_type
                 @properties['field_type']
               end
 
               ##
-              # @return [String] The intent_sid
-              def intent_sid
-                @properties['intent_sid']
+              # @return [String] The unique ID of the Task associated with this Field.
+              def task_sid
+                @properties['task_sid']
               end
 
               ##
-              # @return [String] The service_sid
-              def service_sid
-                @properties['service_sid']
+              # @return [String] The unique ID of the parent Assistant.
+              def assistant_sid
+                @properties['assistant_sid']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique_name
+              # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
               def unique_name
                 @properties['unique_name']
               end
@@ -336,15 +338,15 @@ module Twilio
               end
 
               ##
-              # Fetch a FieldInstance
+              # Fetch the FieldInstance
               # @return [FieldInstance] Fetched FieldInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FieldInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end