twilio-ruby 5.6.0 → 5.33.0

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
@@ -116,11 +122,14 @@ module Twilio
               ##
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
-              # @param [String] language The language
-              # @param [String] value The value
+              # @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] Newly created FieldValueInstance
-              def create(language: nil, value: nil)
-                data = Twilio::Values.of({'Language' => language, 'Value' => value})
+              def create(language: nil, value: nil, synonym_of: :unset)
+                data = Twilio::Values.of({'Language' => language, 'Value' => value, 'SynonymOf' => synonym_of, })
 
                 payload = @version.create(
                     'POST',
@@ -131,7 +140,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
@@ -167,7 +176,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,16 +194,16 @@ 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
 
               ##
@@ -212,7 +221,7 @@ module Twilio
                 FieldValueInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
+                    assistant_sid: @solution[:assistant_sid],
                     field_type_sid: @solution[:field_type_sid],
                     sid: @solution[:sid],
                 )
@@ -220,7 +229,7 @@ module Twilio
 
               ##
               # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -231,6 +240,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 +256,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 +271,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 +295,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 +304,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
@@ -339,6 +357,12 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @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 a FieldValueInstance
               # @return [FieldValueInstance] Fetched FieldValueInstance
@@ -348,7 +372,7 @@ module Twilio
 
               ##
               # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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],
@@ -110,11 +112,13 @@ module Twilio
             ##
             # 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
+            # @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] Newly 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',
@@ -122,7 +126,7 @@ module Twilio
                   data: data
               )
 
-              FieldTypeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              FieldTypeInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -153,7 +157,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,15 +173,15 @@ 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
@@ -195,16 +199,23 @@ module Twilio
                   params,
               )
 
-              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
 
             ##
             # 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',
@@ -212,12 +223,17 @@ module Twilio
                   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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -230,13 +246,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 +266,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 +282,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 +295,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 +303,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 +312,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 +348,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
@@ -357,16 +380,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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end