Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/task.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 [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ TaskInstance

Initialize the TaskInstance

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 resource.

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

    The Twilio-provided string that uniquely identifies the Task resource to fetch.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 349

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, 'sid' => sid || @properties['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



384
385
386
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 384

def 
  @properties['account_sid']
end

#actions_url ⇒ String

Returns The URL from which the Assistant can fetch actions.

Returns:

  • (String) —

    The URL from which the Assistant can fetch actions



432
433
434
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 432

def actions_url
  @properties['actions_url']
end

#assistant_sid ⇒ String

Returns The SID of the Assistant that is the parent of the resource.

Returns:

  • (String) —

    The SID of the Assistant that is the parent of the resource



414
415
416
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 414

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

Returns:



375
376
377
378
379
380
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 375

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



390
391
392
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 390

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



396
397
398
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 396

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



474
475
476
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 474

def delete
  context.delete
end

#fetch ⇒ TaskInstance

Fetch a TaskInstance

Returns:



445
446
447
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 445

def fetch
  context.fetch
end

#fields ⇒ fields

Access the fields

Returns:



481
482
483
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 481

def fields
  context.fields
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



402
403
404
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 402

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



515
516
517
518
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 515

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

#links ⇒ String

Returns A list of the URLs of related resources.

Returns:

  • (String) —

    A list of the URLs of related resources



408
409
410
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 408

def links
  @properties['links']
end

#samples ⇒ samples

Access the samples

Returns:



488
489
490
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 488

def samples
  context.samples
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



420
421
422
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 420

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



502
503
504
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 502

def statistics
  context.statistics
end

#task_actions ⇒ task_actions

Access the task_actions

Returns:



495
496
497
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 495

def task_actions
  context.task_actions
end

#to_s ⇒ Object

Provide a user friendly representation



508
509
510
511
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 508

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.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



426
427
428
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 426

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset) ⇒ TaskInstance

Update the TaskInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

  • unique_name (String) (defaults to: :unset) —

    An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the ‘sid` in the URL path to address the resource.

  • 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.

  • actions_url (String) (defaults to: :unset) —

    The URL from which the Assistant can fetch actions.

Returns:



462
463
464
465
466
467
468
469
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 462

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.

Returns:

  • (String) —

    The absolute URL of the Task resource



438
439
440
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 438

def url
  @properties['url']
end