twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,26 +3,28 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Preview < Domain
       class Understand < Version
-        class ServiceContext < InstanceContext
+        class AssistantContext < 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 FieldTypeList < ListResource
             ##
             # Initialize the FieldTypeList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] assistant_sid The unique ID of the Assistant.
             # @return [FieldTypeList] FieldTypeList
-            def initialize(version, service_sid: nil)
+            def initialize(version, assistant_sid: nil)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/FieldTypes"
+              @solution = {assistant_sid: assistant_sid}
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes"
             end
 
             ##
@@ -54,7 +56,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
@@ -66,7 +68,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],
@@ -86,11 +88,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               FieldTypePage.new(@version, response, @solution)
             end
 
@@ -108,21 +108,18 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of FieldTypeInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [String] friendly_name The friendly_name
-            # @return [FieldTypeInstance] Newly created FieldTypeInstance
+            # Create the FieldTypeInstance
+            # @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.
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
+            # @return [FieldTypeInstance] Created FieldTypeInstance
             def create(unique_name: nil, friendly_name: :unset)
-              data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              FieldTypeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              FieldTypeInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -153,7 +150,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [FieldTypeInstance] FieldTypeInstance
             def get_instance(payload)
-              FieldTypeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              FieldTypeInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -169,57 +166,59 @@ module Twilio
             ##
             # Initialize the FieldTypeContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] assistant_sid The assistant_sid
             # @param [String] sid The sid
             # @return [FieldTypeContext] FieldTypeContext
-            def initialize(version, service_sid, sid)
+            def initialize(version, assistant_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
-              @uri = "/Services/#{@solution[:service_sid]}/FieldTypes/#{@solution[:sid]}"
+              @solution = {assistant_sid: assistant_sid, sid: sid, }
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes/#{@solution[:sid]}"
 
               # Dependents
               @field_values = nil
             end
 
             ##
-            # Fetch a FieldTypeInstance
+            # Fetch the FieldTypeInstance
             # @return [FieldTypeInstance] Fetched FieldTypeInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              FieldTypeInstance.new(
+                  @version,
+                  payload,
+                  assistant_sid: @solution[:assistant_sid],
+                  sid: @solution[:sid],
               )
-
-              FieldTypeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
             end
 
             ##
             # Update the FieldTypeInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
+            # @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 [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              FieldTypeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              FieldTypeInstance.new(
+                  @version,
+                  payload,
+                  assistant_sid: @solution[:assistant_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
-            # Deletes the FieldTypeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the FieldTypeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -230,13 +229,13 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return FieldValueContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return FieldValueContext.new(@version, @solution[:assistant_sid], @solution[:sid], sid, )
               end
 
               unless @field_values
                 @field_values = FieldValueList.new(
                     @version,
-                    service_sid: @solution[:service_sid],
+                    assistant_sid: @solution[:assistant_sid],
                     field_type_sid: @solution[:sid],
                 )
               end
@@ -250,6 +249,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Understand.FieldTypeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Understand.FieldTypeContext #{context}>"
+            end
           end
 
           ##
@@ -259,10 +265,10 @@ module Twilio
             # Initialize the FieldTypeInstance
             # @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] assistant_sid The unique ID of the Assistant.
             # @param [String] sid The sid
             # @return [FieldTypeInstance] FieldTypeInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -272,7 +278,7 @@ module Twilio
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'friendly_name' => payload['friendly_name'],
                   'links' => payload['links'],
-                  'service_sid' => payload['service_sid'],
+                  'assistant_sid' => payload['assistant_sid'],
                   'sid' => payload['sid'],
                   'unique_name' => payload['unique_name'],
                   'url' => payload['url'],
@@ -280,7 +286,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'assistant_sid' => assistant_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -289,31 +295,31 @@ module Twilio
             # @return [FieldTypeContext] FieldTypeContext for this FieldTypeInstance
             def context
               unless @instance_context
-                @instance_context = FieldTypeContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = FieldTypeContext.new(@version, @params['assistant_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique ID of the Account that created this Field Type.
             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 friendly_name
+            # @return [String] A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.
             def friendly_name
               @properties['friendly_name']
             end
@@ -325,19 +331,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The service_sid
-            def service_sid
-              @properties['service_sid']
+            # @return [String] The unique ID of the 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
@@ -349,7 +355,7 @@ module Twilio
             end
 
             ##
-            # Fetch a FieldTypeInstance
+            # Fetch the FieldTypeInstance
             # @return [FieldTypeInstance] Fetched FieldTypeInstance
             def fetch
               context.fetch
@@ -357,16 +363,18 @@ module Twilio
 
             ##
             # Update the FieldTypeInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
+            # @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 [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
-              context.update(friendly_name: friendly_name, unique_name: unique_name)
+              context.update(friendly_name: friendly_name, unique_name: unique_name, )
             end
 
             ##
-            # Deletes the FieldTypeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the FieldTypeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end