twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/autopilot.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -29,7 +29,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34-character string that uniquely identifies this
+      # @param [String] sid The unique string that we created to identify the Assistant
       #   resource.
       # @return [Twilio::REST::Autopilot::V1::AssistantInstance] if sid was passed.
       # @return [Twilio::REST::Autopilot::V1::AssistantList]
@@ -37,6 +37,12 @@ module Twilio
         self.v1.assistants(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Autopilot::V1::RestoreAssistantInstance]
+      def restore_assistant
+        self.v1.restore_assistant()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

data/lib/twilio-ruby/rest/autopilot/v1.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,11 +16,12 @@ module Twilio
           super
           @version = 'v1'
           @assistants = nil
+          @restore_assistant = nil
         end
 
         ##
-        # @param [String] sid A 34-character string that uniquely identifies this
-        #   resource.
+        # @param [String] sid The Twilio-provided string that uniquely identifies the
+        #   Assistant resource to fetch.
         # @return [Twilio::REST::Autopilot::V1::AssistantContext] if sid was passed.
         # @return [Twilio::REST::Autopilot::V1::AssistantList]
         def assistants(sid=:unset)
@@ -33,6 +34,12 @@ module Twilio
           end
         end
 
+        ##
+        # @return [Twilio::REST::Autopilot::V1::RestoreAssistantContext]
+        def restore_assistant
+          @restore_assistant ||= RestoreAssistantList.new self
+        end
+
         ##
         # Provide a user friendly representation
         def to_s

data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -86,11 +86,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             AssistantPage.new(@version, response, @solution)
           end
 
@@ -108,26 +106,23 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of AssistantInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name A text description for the Assistant. It is
-          #   non-unique and can be up to 255 characters long.
-          # @param [Boolean] log_queries A boolean that specifies whether queries should be
-          #   logged for 30 days past training. If `false`, no queries will be stored. If
-          #   `true`, queries will be stored for 30 days and deleted thereafter. Defaults to
-          #   `true` if no value is provided.
-          # @param [String] unique_name A user-provided string that uniquely identifies this
-          #   resource as an alternative to the sid. You can use the unique name in the URL
-          #   path when addressing this resource. Unique up to 64 characters long.
-          # @param [String] callback_url The callback_url
-          # @param [String] callback_events A space-separated list of callback events that
-          #   will trigger callbacks
-          # @param [Hash] style_sheet A JSON object that defines the assistant [style
-          #   sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)
-          # @param [Hash] defaults A JSON object that defines the assistant's [default
-          #   tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various
-          #   scenarios, including initation actions and fallback tasks.
-          # @return [AssistantInstance] Newly created AssistantInstance
+          # Create the AssistantInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the new resource. It is not unique and can be up to 255 characters long.
+          # @param [Boolean] log_queries Whether queries should be logged and kept after
+          #   training. Can be: `true` or `false` and defaults to `true`. If `true`, queries
+          #   are stored for 30 days, and then deleted. If `false`, no queries are stored.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the new resource. It can be used as an alternative to the `sid` in
+          #   the URL path to address the resource. The first 64 characters must be unique.
+          # @param [String] callback_url Reserved.
+          # @param [String] callback_events Reserved.
+          # @param [Hash] style_sheet The JSON string that defines the Assistant's {style
+          #   sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet]
+          # @param [Hash] defaults A JSON object that defines the Assistant's {default
+          #   tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various
+          #   scenarios, including initiation actions and fallback tasks.
+          # @return [AssistantInstance] Created AssistantInstance
           def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -139,11 +134,7 @@ module Twilio
                 'Defaults' => Twilio.serialize_object(defaults),
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             AssistantInstance.new(@version, payload, )
           end
@@ -192,8 +183,8 @@ module Twilio
           ##
           # Initialize the AssistantContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34-character string that uniquely identifies this
-          #   resource.
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Assistant resource to fetch.
           # @return [AssistantContext] AssistantContext
           def initialize(version, sid)
             super(version)
@@ -210,44 +201,39 @@ module Twilio
             @style_sheet = nil
             @defaults = nil
             @dialogues = nil
+            @webhooks = nil
           end
 
           ##
-          # Fetch a AssistantInstance
+          # Fetch the AssistantInstance
           # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the AssistantInstance
-          # @param [String] friendly_name A text description for the Assistant. It is
-          #   non-unique and can be up to 255 characters long.
-          # @param [Boolean] log_queries A boolean that specifies whether queries should be
-          #   logged for 30 days past training. If `false`, no queries will be stored. If
-          #   `true`, queries will be stored for 30 days and deleted thereafter. Defaults to
-          #   `true` if no value is provided.
-          # @param [String] unique_name A user-provided string that uniquely identifies this
-          #   resource as an alternative to the sid. You can use the unique name in the URL
-          #   path when addressing this resource. Unique up to 64 characters long.
-          # @param [String] callback_url The callback_url
-          # @param [String] callback_events A space-separated list of callback events that
-          #   will trigger callbacks
-          # @param [Hash] style_sheet A JSON object that defines the assistant [style
-          #   sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)
-          # @param [Hash] defaults A JSON object that defines the assistant's [default
-          #   tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various
-          #   scenarios, including initation actions and fallback tasks.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It is not unique and can be up to 255 characters long.
+          # @param [Boolean] log_queries Whether queries should be logged and kept after
+          #   training. Can be: `true` or `false` and defaults to `true`. If `true`, queries
+          #   are stored for 30 days, and then deleted. If `false`, no queries are stored.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used as an alternative to the `sid` in the
+          #   URL path to address the resource. The first 64 characters must be unique.
+          # @param [String] callback_url Reserved.
+          # @param [String] callback_events Reserved.
+          # @param [Hash] style_sheet The JSON string that defines the Assistant's {style
+          #   sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet]
+          # @param [Hash] defaults A JSON object that defines the Assistant's {default
+          #   tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various
+          #   scenarios, including initiation actions and fallback tasks.
+          # @param [String] development_stage A string describing the state of the
+          #   assistant.
           # @return [AssistantInstance] Updated AssistantInstance
-          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset)
+          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset, development_stage: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'LogQueries' => log_queries,
@@ -256,22 +242,19 @@ module Twilio
                 'CallbackEvents' => callback_events,
                 'StyleSheet' => Twilio.serialize_object(style_sheet),
                 'Defaults' => Twilio.serialize_object(defaults),
+                'DevelopmentStage' => development_stage,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the AssistantInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the AssistantInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -380,12 +363,37 @@ module Twilio
             @dialogues
           end
 
+          ##
+          # Access the webhooks
+          # @return [WebhookList]
+          # @return [WebhookContext] if sid was passed.
+          def webhooks(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return WebhookContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @webhooks
+              @webhooks = WebhookList.new(@version, assistant_sid: @solution[:sid], )
+            end
+
+            @webhooks
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Autopilot.V1.AssistantContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Autopilot.V1.AssistantContext #{context}>"
+          end
         end
 
         ##
@@ -395,8 +403,8 @@ module Twilio
           # Initialize the AssistantInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34-character string that uniquely identifies this
-          #   resource.
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Assistant resource to fetch.
           # @return [AssistantInstance] AssistantInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -410,6 +418,8 @@ module Twilio
                 'latest_model_build_sid' => payload['latest_model_build_sid'],
                 'links' => payload['links'],
                 'log_queries' => payload['log_queries'],
+                'development_stage' => payload['development_stage'],
+                'needs_model_build' => payload['needs_model_build'],
                 'sid' => payload['sid'],
                 'unique_name' => payload['unique_name'],
                 'url' => payload['url'],
@@ -434,79 +444,91 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique ID of the Account that created this Assistant.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [Time] The date that this resource was created
+          # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date that this resource was last updated
+          # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] A text description for the Assistant. It is non-unique and can be up to 255 characters long.
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] The latest_model_build_sid
+          # @return [String] Reserved
           def latest_model_build_sid
             @properties['latest_model_build_sid']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] A list of the URLs of the Assistant's related resources
           def links
             @properties['links']
           end
 
           ##
-          # @return [Boolean] A boolean that specifies whether queries should be logged for 30 days past training. If `false`, no queries will be stored. If `true`, queries will be stored for 30 days and deleted thereafter.
+          # @return [Boolean] Whether queries should be logged and kept after training
           def log_queries
             @properties['log_queries']
           end
 
           ##
-          # @return [String] A 34-character string that uniquely identifies this resource.
+          # @return [String] A string describing the state of the assistant.
+          def development_stage
+            @properties['development_stage']
+          end
+
+          ##
+          # @return [Boolean] Whether model needs to be rebuilt
+          def needs_model_build
+            @properties['needs_model_build']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
+          # @return [String] An application-defined string that uniquely identifies the resource
           def unique_name
             @properties['unique_name']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the Assistant resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The callback_url
+          # @return [String] Reserved
           def callback_url
             @properties['callback_url']
           end
 
           ##
-          # @return [String] The callback_events
+          # @return [String] Reserved
           def callback_events
             @properties['callback_events']
           end
 
           ##
-          # Fetch a AssistantInstance
+          # Fetch the AssistantInstance
           # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
             context.fetch
@@ -514,25 +536,25 @@ module Twilio
 
           ##
           # Update the AssistantInstance
-          # @param [String] friendly_name A text description for the Assistant. It is
-          #   non-unique and can be up to 255 characters long.
-          # @param [Boolean] log_queries A boolean that specifies whether queries should be
-          #   logged for 30 days past training. If `false`, no queries will be stored. If
-          #   `true`, queries will be stored for 30 days and deleted thereafter. Defaults to
-          #   `true` if no value is provided.
-          # @param [String] unique_name A user-provided string that uniquely identifies this
-          #   resource as an alternative to the sid. You can use the unique name in the URL
-          #   path when addressing this resource. Unique up to 64 characters long.
-          # @param [String] callback_url The callback_url
-          # @param [String] callback_events A space-separated list of callback events that
-          #   will trigger callbacks
-          # @param [Hash] style_sheet A JSON object that defines the assistant [style
-          #   sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)
-          # @param [Hash] defaults A JSON object that defines the assistant's [default
-          #   tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various
-          #   scenarios, including initation actions and fallback tasks.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It is not unique and can be up to 255 characters long.
+          # @param [Boolean] log_queries Whether queries should be logged and kept after
+          #   training. Can be: `true` or `false` and defaults to `true`. If `true`, queries
+          #   are stored for 30 days, and then deleted. If `false`, no queries are stored.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used as an alternative to the `sid` in the
+          #   URL path to address the resource. The first 64 characters must be unique.
+          # @param [String] callback_url Reserved.
+          # @param [String] callback_events Reserved.
+          # @param [Hash] style_sheet The JSON string that defines the Assistant's {style
+          #   sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet]
+          # @param [Hash] defaults A JSON object that defines the Assistant's {default
+          #   tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various
+          #   scenarios, including initiation actions and fallback tasks.
+          # @param [String] development_stage A string describing the state of the
+          #   assistant.
           # @return [AssistantInstance] Updated AssistantInstance
-          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset)
+          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset, development_stage: :unset)
             context.update(
                 friendly_name: friendly_name,
                 log_queries: log_queries,
@@ -541,12 +563,13 @@ module Twilio
                 callback_events: callback_events,
                 style_sheet: style_sheet,
                 defaults: defaults,
+                development_stage: development_stage,
             )
           end
 
           ##
-          # Deletes the AssistantInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the AssistantInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
@@ -600,6 +623,13 @@ module Twilio
             context.dialogues
           end
 
+          ##
+          # Access the webhooks
+          # @return [webhooks] webhooks
+          def webhooks
+            context.webhooks
+          end
+
           ##
           # Provide a user friendly representation
           def to_s