Class: Twilio::REST::Preview::Understand::AssistantContext::TaskInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/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 unique ID of the Assistant.

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

    A 34 character string that uniquely identifies this resource.



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 332

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 unique ID of the Account that created this Task.

Returns:

  • (String) —

    The unique ID of the Account that created this Task.



367
368
369
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 367

def 
  @properties['account_sid']
end

#actions_url ⇒ String

Returns User-provided HTTP endpoint where from the assistant fetches actions.

Returns:

  • (String) —

    User-provided HTTP endpoint where from the assistant fetches actions



415
416
417
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 415

def actions_url
  @properties['actions_url']
end

#assistant_sid ⇒ String

Returns The unique ID of the Assistant.

Returns:

  • (String) —

    The unique ID of the Assistant.



397
398
399
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 397

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:



358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 358

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 that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



373
374
375
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 373

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



379
380
381
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 379

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



455
456
457
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 455

def delete
  context.delete
end

#fetch ⇒ TaskInstance

Fetch a TaskInstance

Returns:



428
429
430
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 428

def fetch
  context.fetch
end

#fields ⇒ fields

Access the fields

Returns:



462
463
464
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 462

def fields
  context.fields
end

#friendly_name ⇒ String

Returns A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

Returns:

  • (String) —

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.



385
386
387
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 385

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



496
497
498
499
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 496

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



391
392
393
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 391

def links
  @properties['links']
end

#samples ⇒ samples

Access the samples

Returns:



469
470
471
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 469

def samples
  context.samples
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



403
404
405
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 403

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



483
484
485
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 483

def statistics
  context.statistics
end

#task_actions ⇒ task_actions

Access the task_actions

Returns:



476
477
478
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 476

def task_actions
  context.task_actions
end

#to_s ⇒ Object

Provide a user friendly representation



489
490
491
492
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 489

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

#unique_name ⇒ String

Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

Returns:

  • (String) —

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.



409
410
411
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 409

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 user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

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

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

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

    A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.

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

    User-provided HTTP endpoint where from the assistant fetches actions

Returns:



443
444
445
446
447
448
449
450
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 443

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

Returns:

  • (String) —

    The url



421
422
423
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 421

def url
  @properties['url']
end