twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,12 +3,14 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Preview < Domain
       class Understand < Version
-        class ServiceContext < InstanceContext
+        class AssistantContext < InstanceContext
           class FieldTypeContext < 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.
@@ -16,22 +18,24 @@ module Twilio
               ##
               # Initialize the FieldValueList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] field_type_sid The field_type_sid
+              # @param [String] assistant_sid The unique ID of the Assistant.
+              # @param [String] field_type_sid The unique ID of the Field Type associated with
+              #   this Field Value.
               # @return [FieldValueList] FieldValueList
-              def initialize(version, service_sid: nil, field_type_sid: nil)
+              def initialize(version, assistant_sid: nil, field_type_sid: nil)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, field_type_sid: field_type_sid}
-                @uri = "/Services/#{@solution[:service_sid]}/FieldTypes/#{@solution[:field_type_sid]}/FieldValues"
+                @solution = {assistant_sid: assistant_sid, field_type_sid: field_type_sid}
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes/#{@solution[:field_type_sid]}/FieldValues"
               end
 
               ##
               # Lists FieldValueInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -47,7 +51,8 @@ module Twilio
               # Streams FieldValueInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -58,7 +63,7 @@ module Twilio
               def stream(language: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(language: language, page_size: limits[:page_size])
+                page = self.page(language: language, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -70,7 +75,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],
@@ -80,7 +85,8 @@ module Twilio
               ##
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -92,11 +98,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FieldValuePage.new(@version, response, @solution)
               end
 
@@ -114,24 +118,22 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FieldValueInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] language The language
-              # @param [String] value The value
-              # @return [FieldValueInstance] Newly created FieldValueInstance
-              def create(language: nil, value: nil)
-                data = Twilio::Values.of({'Language' => language, 'Value' => value})
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+              # Create the FieldValueInstance
+              # @param [String] language An ISO language-country string of the value.
+              # @param [String] value A user-provided string that uniquely identifies this
+              #   resource as an alternative to the sid. Unique up to 64 characters long.
+              # @param [String] synonym_of A value that indicates this field value is a synonym
+              #   of. Empty if the value is not a synonym.
+              # @return [FieldValueInstance] Created FieldValueInstance
+              def create(language: nil, value: nil, synonym_of: :unset)
+                data = Twilio::Values.of({'Language' => language, 'Value' => value, 'SynonymOf' => synonym_of, })
+
+                payload = @version.create('POST', @uri, data: data)
 
                 FieldValueInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
+                    assistant_sid: @solution[:assistant_sid],
                     field_type_sid: @solution[:field_type_sid],
                 )
               end
@@ -167,7 +169,7 @@ module Twilio
                 FieldValueInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
+                    assistant_sid: @solution[:assistant_sid],
                     field_type_sid: @solution[:field_type_sid],
                 )
               end
@@ -185,44 +187,38 @@ module Twilio
               ##
               # Initialize the FieldValueContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
+              # @param [String] assistant_sid The assistant_sid
               # @param [String] field_type_sid The field_type_sid
               # @param [String] sid The sid
               # @return [FieldValueContext] FieldValueContext
-              def initialize(version, service_sid, field_type_sid, sid)
+              def initialize(version, assistant_sid, field_type_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, field_type_sid: field_type_sid, sid: sid}
-                @uri = "/Services/#{@solution[:service_sid]}/FieldTypes/#{@solution[:field_type_sid]}/FieldValues/#{@solution[:sid]}"
+                @solution = {assistant_sid: assistant_sid, field_type_sid: field_type_sid, sid: sid, }
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes/#{@solution[:field_type_sid]}/FieldValues/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a FieldValueInstance
+              # Fetch the FieldValueInstance
               # @return [FieldValueInstance] Fetched FieldValueInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FieldValueInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
+                    assistant_sid: @solution[:assistant_sid],
                     field_type_sid: @solution[:field_type_sid],
                     sid: @solution[:sid],
                 )
               end
 
               ##
-              # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldValueInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -231,6 +227,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Preview.Understand.FieldValueContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Understand.FieldValueContext #{context}>"
+              end
             end
 
             ##
@@ -240,11 +243,12 @@ module Twilio
               # Initialize the FieldValueInstance
               # @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] field_type_sid The field_type_sid
+              # @param [String] assistant_sid The unique ID of the Assistant.
+              # @param [String] field_type_sid The unique ID of the Field Type associated with
+              #   this Field Value.
               # @param [String] sid The sid
               # @return [FieldValueInstance] FieldValueInstance
-              def initialize(version, payload, service_sid: nil, field_type_sid: nil, sid: nil)
+              def initialize(version, payload, assistant_sid: nil, field_type_sid: nil, sid: nil)
                 super(version)
 
                 # Marshaled Properties
@@ -254,16 +258,17 @@ module Twilio
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                     'field_type_sid' => payload['field_type_sid'],
                     'language' => payload['language'],
-                    'service_sid' => payload['service_sid'],
+                    'assistant_sid' => payload['assistant_sid'],
                     'sid' => payload['sid'],
                     'value' => payload['value'],
                     'url' => payload['url'],
+                    'synonym_of' => payload['synonym_of'],
                 }
 
                 # Context
                 @instance_context = nil
                 @params = {
-                    'service_sid' => service_sid,
+                    'assistant_sid' => assistant_sid,
                     'field_type_sid' => field_type_sid,
                     'sid' => sid || @properties['sid'],
                 }
@@ -277,7 +282,7 @@ module Twilio
                 unless @instance_context
                   @instance_context = FieldValueContext.new(
                       @version,
-                      @params['service_sid'],
+                      @params['assistant_sid'],
                       @params['field_type_sid'],
                       @params['sid'],
                   )
@@ -286,49 +291,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique ID of the Account that created this Field Value.
               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_sid
+              # @return [String] The unique ID of the Field Type associated with this Field Value.
               def field_type_sid
                 @properties['field_type_sid']
               end
 
               ##
-              # @return [String] The language
+              # @return [String] An ISO language-country string of the value.
               def language
                 @properties['language']
               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 value
+              # @return [String] The Field Value itself.
               def value
                 @properties['value']
               end
@@ -340,15 +345,21 @@ module Twilio
               end
 
               ##
-              # Fetch a FieldValueInstance
+              # @return [String] A value that indicates this field value is a synonym of. Empty if the value is not a synonym.
+              def synonym_of
+                @properties['synonym_of']
+              end
+
+              ##
+              # Fetch the FieldValueInstance
               # @return [FieldValueInstance] Fetched FieldValueInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldValueInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end