twilio-ruby 5.6.0 → 5.33.0

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

@@ -0,0 +1,265 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Autopilot < Domain
+      class V1 < Version
+        class AssistantContext < InstanceContext
+          class TaskContext < 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 TaskActionsList < ListResource
+              ##
+              # Initialize the TaskActionsList
+              # @param [Version] version Version that contains the resource
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the
+              #   resource.
+              # @return [TaskActionsList] TaskActionsList
+              def initialize(version, assistant_sid: nil, task_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Autopilot.V1.TaskActionsList>'
+              end
+            end
+
+            ##
+            # 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 TaskActionsPage < Page
+              ##
+              # Initialize the TaskActionsPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [TaskActionsPage] TaskActionsPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of TaskActionsInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [TaskActionsInstance] TaskActionsInstance
+              def get_instance(payload)
+                TaskActionsInstance.new(
+                    @version,
+                    payload,
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Autopilot.V1.TaskActionsPage>'
+              end
+            end
+
+            ##
+            # 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 TaskActionsContext < InstanceContext
+              ##
+              # Initialize the TaskActionsContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the Task for which the task actions to fetch were defined.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task
+              #   actions to fetch were defined.
+              # @return [TaskActionsContext] TaskActionsContext
+              def initialize(version, assistant_sid, task_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid, }
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Actions"
+              end
+
+              ##
+              # Fetch a TaskActionsInstance
+              # @return [TaskActionsInstance] Fetched TaskActionsInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                TaskActionsInstance.new(
+                    @version,
+                    payload,
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
+                )
+              end
+
+              ##
+              # Update the TaskActionsInstance
+              # @param [Hash] actions The JSON string that specifies the
+              #   [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the
+              #   Assistant on how to perform the task.
+              # @return [TaskActionsInstance] Updated TaskActionsInstance
+              def update(actions: :unset)
+                data = Twilio::Values.of({'Actions' => Twilio.serialize_object(actions), })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                TaskActionsInstance.new(
+                    @version,
+                    payload,
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskActionsContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskActionsContext #{context}>"
+              end
+            end
+
+            ##
+            # 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 TaskActionsInstance < InstanceResource
+              ##
+              # Initialize the TaskActionsInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the
+              #   resource.
+              # @return [TaskActionsInstance] TaskActionsInstance
+              def initialize(version, payload, assistant_sid: nil, task_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'assistant_sid' => payload['assistant_sid'],
+                    'task_sid' => payload['task_sid'],
+                    'url' => payload['url'],
+                    'data' => payload['data'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'assistant_sid' => assistant_sid, 'task_sid' => task_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [TaskActionsContext] TaskActionsContext for this TaskActionsInstance
+              def context
+                unless @instance_context
+                  @instance_context = TaskActionsContext.new(@version, @params['assistant_sid'], @params['task_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Assistant that is the parent of the Task associated with the resource
+              def assistant_sid
+                @properties['assistant_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Task associated with the resource
+              def task_sid
+                @properties['task_sid']
+              end
+
+              ##
+              # @return [String] The absolute URL of the TaskActions resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # @return [Hash] The JSON string that specifies the actions that instruct the Assistant on how to perform the task
+              def data
+                @properties['data']
+              end
+
+              ##
+              # Fetch a TaskActionsInstance
+              # @return [TaskActionsInstance] Fetched TaskActionsInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Update the TaskActionsInstance
+              # @param [Hash] actions The JSON string that specifies the
+              #   [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the
+              #   Assistant on how to perform the task.
+              # @return [TaskActionsInstance] Updated TaskActionsInstance
+              def update(actions: :unset)
+                context.update(actions: actions, )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Autopilot.V1.TaskActionsInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Autopilot.V1.TaskActionsInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,243 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Autopilot < Domain
+      class V1 < Version
+        class AssistantContext < InstanceContext
+          class TaskContext < 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 TaskStatisticsList < ListResource
+              ##
+              # Initialize the TaskStatisticsList
+              # @param [Version] version Version that contains the resource
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics
+              #   were collected.
+              # @return [TaskStatisticsList] TaskStatisticsList
+              def initialize(version, assistant_sid: nil, task_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Autopilot.V1.TaskStatisticsList>'
+              end
+            end
+
+            ##
+            # 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 TaskStatisticsPage < Page
+              ##
+              # Initialize the TaskStatisticsPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [TaskStatisticsPage] TaskStatisticsPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of TaskStatisticsInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [TaskStatisticsInstance] TaskStatisticsInstance
+              def get_instance(payload)
+                TaskStatisticsInstance.new(
+                    @version,
+                    payload,
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Autopilot.V1.TaskStatisticsPage>'
+              end
+            end
+
+            ##
+            # 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 TaskStatisticsContext < InstanceContext
+              ##
+              # Initialize the TaskStatisticsContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the resource to fetch.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with
+              #   the resource to fetch.
+              # @return [TaskStatisticsContext] TaskStatisticsContext
+              def initialize(version, assistant_sid, task_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {assistant_sid: assistant_sid, task_sid: task_sid, }
+                @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Statistics"
+              end
+
+              ##
+              # Fetch a TaskStatisticsInstance
+              # @return [TaskStatisticsInstance] Fetched TaskStatisticsInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                TaskStatisticsInstance.new(
+                    @version,
+                    payload,
+                    assistant_sid: @solution[:assistant_sid],
+                    task_sid: @solution[:task_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskStatisticsContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskStatisticsContext #{context}>"
+              end
+            end
+
+            ##
+            # 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 TaskStatisticsInstance < InstanceResource
+              ##
+              # Initialize the TaskStatisticsInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] assistant_sid The SID of the
+              #   [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics
+              #   were collected.
+              # @return [TaskStatisticsInstance] TaskStatisticsInstance
+              def initialize(version, payload, assistant_sid: nil, task_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'assistant_sid' => payload['assistant_sid'],
+                    'task_sid' => payload['task_sid'],
+                    'samples_count' => payload['samples_count'].to_i,
+                    'fields_count' => payload['fields_count'].to_i,
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'assistant_sid' => assistant_sid, 'task_sid' => task_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [TaskStatisticsContext] TaskStatisticsContext for this TaskStatisticsInstance
+              def context
+                unless @instance_context
+                  @instance_context = TaskStatisticsContext.new(
+                      @version,
+                      @params['assistant_sid'],
+                      @params['task_sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Assistant that is the parent of the Task associated with the resource
+              def assistant_sid
+                @properties['assistant_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Task for which the statistics were collected
+              def task_sid
+                @properties['task_sid']
+              end
+
+              ##
+              # @return [String] The total number of Samples associated with the Task
+              def samples_count
+                @properties['samples_count']
+              end
+
+              ##
+              # @return [String] The total number of Fields associated with the Task
+              def fields_count
+                @properties['fields_count']
+              end
+
+              ##
+              # @return [String] The absolute URL of the TaskStatistics resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch a TaskStatisticsInstance
+              # @return [TaskStatisticsInstance] Fetched TaskStatisticsInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Autopilot.V1.TaskStatisticsInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Autopilot.V1.TaskStatisticsInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end