Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Autopilot::V1::AssistantContext::TaskInstance
- Defined in:
- lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Task resource.
-
#actions_url ⇒ String
The URL from which the Assistant can fetch actions.
-
#assistant_sid ⇒ String
The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.
-
#context ⇒ TaskContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the TaskInstance.
-
#fetch ⇒ TaskInstance
Fetch the TaskInstance.
-
#fields ⇒ fields
Access the fields.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ TaskInstance
constructor
Initialize the TaskInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
A list of the URLs of related resources.
-
#samples ⇒ samples
Access the samples.
-
#sid ⇒ String
The unique string that we created to identify the Task resource.
-
#statistics ⇒ statistics
Access the statistics.
-
#task_actions ⇒ task_actions
Access the task_actions.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset) ⇒ TaskInstance
Update the TaskInstance.
-
#url ⇒ String
The absolute URL of the Task resource.
Constructor Details
#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ TaskInstance
Initialize the TaskInstance
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 345 def initialize(version, payload , assistant_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'friendly_name' => payload['friendly_name'], 'links' => payload['links'], 'assistant_sid' => payload['assistant_sid'], 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'actions_url' => payload['actions_url'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'assistant_sid' => assistant_sid || @properties['assistant_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Task resource.
380 381 382 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 380 def account_sid @properties['account_sid'] end |
#actions_url ⇒ String
Returns The URL from which the Assistant can fetch actions.
428 429 430 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 428 def actions_url @properties['actions_url'] end |
#assistant_sid ⇒ String
Returns The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.
410 411 412 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 410 def assistant_sid @properties['assistant_sid'] end |
#context ⇒ TaskContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
371 372 373 374 375 376 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 371 def context unless @instance_context @instance_context = TaskContext.new(@version , @params['assistant_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
386 387 388 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 386 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
392 393 394 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 392 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the TaskInstance
441 442 443 444 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 441 def delete context.delete end |
#fetch ⇒ TaskInstance
Fetch the TaskInstance
449 450 451 452 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 449 def fetch context.fetch end |
#fields ⇒ fields
Access the fields
500 501 502 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 500 def fields context.fields end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.
398 399 400 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 398 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
513 514 515 516 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 513 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Autopilot.V1.TaskInstance #{values}>" end |
#links ⇒ Hash
Returns A list of the URLs of related resources.
404 405 406 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 404 def links @properties['links'] end |
#samples ⇒ samples
Access the samples
479 480 481 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 479 def samples context.samples end |
#sid ⇒ String
Returns The unique string that we created to identify the Task resource.
416 417 418 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 416 def sid @properties['sid'] end |
#statistics ⇒ statistics
Access the statistics
493 494 495 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 493 def statistics context.statistics end |
#task_actions ⇒ task_actions
Access the task_actions
486 487 488 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 486 def task_actions context.task_actions end |
#to_s ⇒ Object
Provide a user friendly representation
506 507 508 509 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 506 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Autopilot.V1.TaskInstance #{values}>" end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.
422 423 424 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 422 def unique_name @properties['unique_name'] end |
#update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset) ⇒ TaskInstance
Update the TaskInstance
461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 461 def update( friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset ) context.update( friendly_name: friendly_name, unique_name: unique_name, actions: actions, actions_url: actions_url, ) end |
#url ⇒ String
Returns The absolute URL of the Task resource.
434 435 436 |
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 434 def url @properties['url'] end |