Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskContext::TaskActionsInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Autopilot::V1::AssistantContext::TaskContext::TaskActionsInstance

Defined in:

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

Overview

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.

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #assistant_sid ⇒ String

  The SID of the Assistant that is the parent of the Task associated with the resource.

• #context ⇒ TaskActionsContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #data ⇒ Hash

  The JSON string that specifies the actions that instruct the Assistant on how to perform the task.

• #fetch ⇒ TaskActionsInstance

  Fetch a TaskActionsInstance.

• #initialize(version, payload, assistant_sid: nil, task_sid: nil) ⇒ TaskActionsInstance constructor

  Initialize the TaskActionsInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #task_sid ⇒ String

  The SID of the Task associated with the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(actions: :unset) ⇒ TaskActionsInstance

  Update the TaskActionsInstance.

• #url ⇒ String

  The absolute URL of the TaskActions resource.

Constructor Details

#initialize(version, payload, assistant_sid: nil, task_sid: nil) ⇒ TaskActionsInstance

Initialize the TaskActionsInstance

Parameters:

• version (Version) —

  Version that contains the resource

• payload (Hash) —

  payload that contains response from Twilio

• assistant_sid (String) (defaults to: nil) —

  The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource.

• task_sid (String) (defaults to: nil) —

  The SID of the [Task](www.twilio.com/docs/autopilot/api/task) associated with the resource.

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 171

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

• (String) —

  The SID of the Account that created the resource

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 201

def account_sid
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the Assistant that is the parent of the Task associated with the resource.

Returns:

• (String) —

  The SID of the Assistant that is the parent of the Task associated with the resource

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 207

def assistant_sid
  @properties['assistant_sid']
end

#context ⇒ TaskActionsContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

• (TaskActionsContext) —

  TaskActionsContext for this TaskActionsInstance

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 192

def context
  unless @instance_context
    @instance_context = TaskActionsContext.new(@version, @params['assistant_sid'], @params['task_sid'], )
  end
  @instance_context
end

#data ⇒ Hash

Returns The JSON string that specifies the actions that instruct the Assistant on how to perform the task.

Returns:

• (Hash) —

  The JSON string that specifies the actions that instruct the Assistant on how to perform the task

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 225

def data
  @properties['data']
end

#fetch ⇒ TaskActionsInstance

Fetch a TaskActionsInstance

Returns:

• (TaskActionsInstance) —

  Fetched TaskActionsInstance

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 232

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 255

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Autopilot.V1.TaskActionsInstance #{values}>"
end

#task_sid ⇒ String

Returns The SID of the Task associated with the resource.

Returns:

• (String) —

  The SID of the Task associated with the resource

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 213

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 248

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Autopilot.V1.TaskActionsInstance #{values}>"
end

#update(actions: :unset) ⇒ TaskActionsInstance

Update the TaskActionsInstance

Parameters:

• actions (Hash) (defaults to: :unset) —

  The JSON string that specifies the [actions](www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task.

Returns:

• (TaskActionsInstance) —

  Updated TaskActionsInstance

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 242

def update(actions: :unset)
  context.update(actions: actions, )
end

#url ⇒ String

Returns The absolute URL of the TaskActions resource.

Returns:

• (String) —

  The absolute URL of the TaskActions resource

# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb', line 219

def url
  @properties['url']
end