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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 322

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_sidString



357
358
359
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 357

def 
  @properties['account_sid']
end

#actions_urlString



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

def actions_url
  @properties['actions_url']
end

#assistant_sidString



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

def assistant_sid
  @properties['assistant_sid']
end

#contextTaskContext

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



348
349
350
351
352
353
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 348

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

#date_createdTime



363
364
365
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 363

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the TaskInstance



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

def delete
  context.delete
end

#fetchTaskInstance

Fetch the TaskInstance



418
419
420
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 418

def fetch
  context.fetch
end

#fieldsfields

Access the fields



452
453
454
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 452

def fields
  context.fields
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



486
487
488
489
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 486

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


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

def links
  @properties['links']
end

#samplessamples

Access the samples



459
460
461
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 459

def samples
  context.samples
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



473
474
475
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 473

def statistics
  context.statistics
end

#task_actionstask_actions

Access the task_actions



466
467
468
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 466

def task_actions
  context.task_actions
end

#to_sObject

Provide a user friendly representation



479
480
481
482
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 479

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

#unique_nameString



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

def unique_name
  @properties['unique_name']
end

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

Update the TaskInstance



433
434
435
436
437
438
439
440
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task.rb', line 433

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

#urlString



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

def url
  @properties['url']
end