twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/preview/understand/{service → assistant}/model_build.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 ModelBuildList < ListResource
             ##
             # Initialize the ModelBuildList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] assistant_sid The unique ID of the parent Assistant.
             # @return [ModelBuildList] ModelBuildList
-            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]}/ModelBuilds"
+              @solution = {assistant_sid: assistant_sid}
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/ModelBuilds"
             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],
@@ -111,10 +113,12 @@ module Twilio
             # Retrieve a single page of ModelBuildInstance records from the API.
             # Request is executed immediately.
             # @param [String] status_callback The status_callback
-            # @param [String] unique_name The unique_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. For
+            #   example: v0.1
             # @return [ModelBuildInstance] Newly created ModelBuildInstance
             def create(status_callback: :unset, unique_name: :unset)
-              data = Twilio::Values.of({'StatusCallback' => status_callback, 'UniqueName' => unique_name})
+              data = Twilio::Values.of({'StatusCallback' => status_callback, 'UniqueName' => unique_name, })
 
               payload = @version.create(
                   'POST',
@@ -122,7 +126,7 @@ module Twilio
                   data: data
               )
 
-              ModelBuildInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ModelBuildInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -153,7 +157,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ModelBuildInstance] ModelBuildInstance
             def get_instance(payload)
-              ModelBuildInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ModelBuildInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -169,15 +173,15 @@ module Twilio
             ##
             # Initialize the ModelBuildContext
             # @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 [ModelBuildContext] ModelBuildContext
-            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]}/ModelBuilds/#{@solution[:sid]}"
+              @solution = {assistant_sid: assistant_sid, sid: sid, }
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/ModelBuilds/#{@solution[:sid]}"
             end
 
             ##
@@ -192,15 +196,22 @@ module Twilio
                   params,
               )
 
-              ModelBuildInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ModelBuildInstance.new(
+                  @version,
+                  payload,
+                  assistant_sid: @solution[:assistant_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Update the ModelBuildInstance
-            # @param [String] unique_name The unique_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. For
+            #   example: v0.1
             # @return [ModelBuildInstance] Updated ModelBuildInstance
             def update(unique_name: :unset)
-              data = Twilio::Values.of({'UniqueName' => unique_name})
+              data = Twilio::Values.of({'UniqueName' => unique_name, })
 
               payload = @version.update(
                   'POST',
@@ -208,12 +219,17 @@ module Twilio
                   data: data,
               )
 
-              ModelBuildInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ModelBuildInstance.new(
+                  @version,
+                  payload,
+                  assistant_sid: @solution[:assistant_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the ModelBuildInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -224,6 +240,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Understand.ModelBuildContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Understand.ModelBuildContext #{context}>"
+            end
           end
 
           ##
@@ -233,10 +256,10 @@ module Twilio
             # Initialize the ModelBuildInstance
             # @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 parent Assistant.
             # @param [String] sid The sid
             # @return [ModelBuildInstance] ModelBuildInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -244,16 +267,18 @@ module Twilio
                   'account_sid' => payload['account_sid'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'service_sid' => payload['service_sid'],
+                  'assistant_sid' => payload['assistant_sid'],
                   'sid' => payload['sid'],
                   'status' => payload['status'],
                   'unique_name' => payload['unique_name'],
                   'url' => payload['url'],
+                  'build_duration' => payload['build_duration'] == nil ? payload['build_duration'] : payload['build_duration'].to_i,
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'assistant_sid' => assistant_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -262,49 +287,49 @@ module Twilio
             # @return [ModelBuildContext] ModelBuildContext for this ModelBuildInstance
             def context
               unless @instance_context
-                @instance_context = ModelBuildContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = ModelBuildContext.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 Model Build.
             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 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 [model_build.Status] The status
+            # @return [model_build.Status] A string that described the model build status. The values can be: enqueued, building, completed, failed
             def status
               @properties['status']
             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
@@ -315,6 +340,18 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] The time in seconds it took to build the model.
+            def build_duration
+              @properties['build_duration']
+            end
+
+            ##
+            # @return [String] The error_code
+            def error_code
+              @properties['error_code']
+            end
+
             ##
             # Fetch a ModelBuildInstance
             # @return [ModelBuildInstance] Fetched ModelBuildInstance
@@ -324,15 +361,17 @@ module Twilio
 
             ##
             # Update the ModelBuildInstance
-            # @param [String] unique_name The unique_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. For
+            #   example: v0.1
             # @return [ModelBuildInstance] Updated ModelBuildInstance
             def update(unique_name: :unset)
-              context.update(unique_name: unique_name)
+              context.update(unique_name: unique_name, )
             end
 
             ##
             # Deletes the ModelBuildInstance
-            # @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}/query.rb

@@ -3,35 +3,39 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  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 QueryList < ListResource
             ##
             # Initialize the QueryList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] assistant_sid The unique ID of the parent Assistant.
             # @return [QueryList] QueryList
-            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]}/Queries"
+              @solution = {assistant_sid: assistant_sid}
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/Queries"
             end
 
             ##
             # Lists QueryInstance 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] model_build The model_build
-            # @param [String] status The status
+            # @param [String] language An ISO language-country string of the sample.
+            # @param [String] model_build The Model Build Sid or unique name of the Model
+            #   Build to be queried.
+            # @param [String] status A string that described the query status. The values can
+            #   be: pending_review, reviewed, discarded
             # @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
@@ -53,9 +57,11 @@ module Twilio
             # Streams QueryInstance 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] model_build The model_build
-            # @param [String] status The status
+            # @param [String] language An ISO language-country string of the sample.
+            # @param [String] model_build The Model Build Sid or unique name of the Model
+            #   Build to be queried.
+            # @param [String] status A string that described the query status. The values can
+            #   be: pending_review, reviewed, discarded
             # @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
@@ -83,7 +89,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],
@@ -93,9 +99,11 @@ module Twilio
             ##
             # Retrieve a single page of QueryInstance records from the API.
             # Request is executed immediately.
-            # @param [String] language The language
-            # @param [String] model_build The model_build
-            # @param [String] status The status
+            # @param [String] language An ISO language-country string of the sample.
+            # @param [String] model_build The Model Build Sid or unique name of the Model
+            #   Build to be queried.
+            # @param [String] status A string that described the query status. The values can
+            #   be: pending_review, reviewed, discarded
             # @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
@@ -133,21 +141,25 @@ module Twilio
             ##
             # Retrieve a single page of QueryInstance records from the API.
             # Request is executed immediately.
-            # @param [String] language The language
-            # @param [String] query The query
-            # @param [String] intent The intent
-            # @param [String] model_build The model_build
-            # @param [String] field The field
-            # @param [String] named_entity The named_entity
+            # @param [String] language An ISO language-country string of the sample.
+            # @param [String] query A user-provided string that uniquely identifies this
+            #   resource as an alternative to the sid. It can be up to 2048 characters long.
+            # @param [String] tasks Constraints the query to a set of tasks. Useful when you
+            #   need to constrain the paths the user can take. Tasks should be comma separated
+            #   *task-unique-name-1*, *task-unique-name-2*
+            # @param [String] model_build The Model Build Sid or unique name of the Model
+            #   Build to be queried.
+            # @param [String] field Constraints the query to a given Field with an task.
+            #   Useful when you know the Field you are expecting. It accepts one field in the
+            #   format *task-unique-name-1*:*field-unique-name*
             # @return [QueryInstance] Newly created QueryInstance
-            def create(language: nil, query: nil, intent: :unset, model_build: :unset, field: :unset, named_entity: :unset)
+            def create(language: nil, query: nil, tasks: :unset, model_build: :unset, field: :unset)
               data = Twilio::Values.of({
                   'Language' => language,
                   'Query' => query,
-                  'Intent' => intent,
+                  'Tasks' => tasks,
                   'ModelBuild' => model_build,
                   'Field' => field,
-                  'NamedEntity' => named_entity,
               })
 
               payload = @version.create(
@@ -156,7 +168,7 @@ module Twilio
                   data: data
               )
 
-              QueryInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              QueryInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -187,7 +199,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [QueryInstance] QueryInstance
             def get_instance(payload)
-              QueryInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              QueryInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
@@ -203,15 +215,16 @@ module Twilio
             ##
             # Initialize the QueryContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] assistant_sid The unique ID of the Assistant.
+            # @param [String] sid A 34 character string that uniquely identifies this
+            #   resource.
             # @return [QueryContext] QueryContext
-            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]}/Queries/#{@solution[:sid]}"
+              @solution = {assistant_sid: assistant_sid, sid: sid, }
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/Queries/#{@solution[:sid]}"
             end
 
             ##
@@ -226,16 +239,18 @@ module Twilio
                   params,
               )
 
-              QueryInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              QueryInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the QueryInstance
-            # @param [String] sample_sid The sample_sid
-            # @param [String] status The status
+            # @param [String] sample_sid An optional reference to the Sample created from this
+            #   query.
+            # @param [String] status A string that described the query status. The values can
+            #   be: pending_review, reviewed, discarded
             # @return [QueryInstance] Updated QueryInstance
             def update(sample_sid: :unset, status: :unset)
-              data = Twilio::Values.of({'SampleSid' => sample_sid, 'Status' => status})
+              data = Twilio::Values.of({'SampleSid' => sample_sid, 'Status' => status, })
 
               payload = @version.update(
                   'POST',
@@ -243,12 +258,12 @@ module Twilio
                   data: data,
               )
 
-              QueryInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              QueryInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the QueryInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -259,6 +274,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Understand.QueryContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Understand.QueryContext #{context}>"
+            end
           end
 
           ##
@@ -268,10 +290,11 @@ module Twilio
             # Initialize the QueryInstance
             # @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] sid The sid
+            # @param [String] assistant_sid The unique ID of the parent Assistant.
+            # @param [String] sid A 34 character string that uniquely identifies this
+            #   resource.
             # @return [QueryInstance] QueryInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -284,15 +307,16 @@ module Twilio
                   'model_build_sid' => payload['model_build_sid'],
                   'query' => payload['query'],
                   'sample_sid' => payload['sample_sid'],
-                  'service_sid' => payload['service_sid'],
+                  'assistant_sid' => payload['assistant_sid'],
                   'sid' => payload['sid'],
                   'status' => payload['status'],
                   'url' => payload['url'],
+                  'source_channel' => payload['source_channel'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'assistant_sid' => assistant_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -301,73 +325,73 @@ module Twilio
             # @return [QueryContext] QueryContext for this QueryInstance
             def context
               unless @instance_context
-                @instance_context = QueryContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = QueryContext.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 Query.
             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 [Hash] The results
+            # @return [Hash] The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.
             def results
               @properties['results']
             end
 
             ##
-            # @return [String] The language
+            # @return [String] An ISO language-country string of the sample.
             def language
               @properties['language']
             end
 
             ##
-            # @return [String] The model_build_sid
+            # @return [String] The unique ID of the Model Build queried.
             def model_build_sid
               @properties['model_build_sid']
             end
 
             ##
-            # @return [String] The query
+            # @return [String] The end-user's natural language input.
             def query
               @properties['query']
             end
 
             ##
-            # @return [String] The sample_sid
+            # @return [String] An optional reference to the Sample created from this query.
             def sample_sid
               @properties['sample_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 status
+            # @return [String] A string that described the query status. The values can be: pending_review, reviewed, discarded
             def status
               @properties['status']
             end
@@ -378,6 +402,12 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] The communication channel where this end-user input came from
+            def source_channel
+              @properties['source_channel']
+            end
+
             ##
             # Fetch a QueryInstance
             # @return [QueryInstance] Fetched QueryInstance
@@ -387,16 +417,18 @@ module Twilio
 
             ##
             # Update the QueryInstance
-            # @param [String] sample_sid The sample_sid
-            # @param [String] status The status
+            # @param [String] sample_sid An optional reference to the Sample created from this
+            #   query.
+            # @param [String] status A string that described the query status. The values can
+            #   be: pending_review, reviewed, discarded
             # @return [QueryInstance] Updated QueryInstance
             def update(sample_sid: :unset, status: :unset)
-              context.update(sample_sid: sample_sid, status: status)
+              context.update(sample_sid: sample_sid, status: status, )
             end
 
             ##
             # Deletes the QueryInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end