Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::SampleInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/task/sample.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, task_sid: nil, sid: nil) ⇒ SampleInstance

Initialize the SampleInstance



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 297

def initialize(version, payload, assistant_sid: nil, task_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']),
      'task_sid' => payload['task_sid'],
      'language' => payload['language'],
      'assistant_sid' => payload['assistant_sid'],
      'sid' => payload['sid'],
      'tagged_text' => payload['tagged_text'],
      'url' => payload['url'],
      'source_channel' => payload['source_channel'],
  }

  # Context
  @instance_context = nil
  @params = {
      'assistant_sid' => assistant_sid,
      'task_sid' => task_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String 



341
342
343
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 341

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String 



371
372
373
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 371

def assistant_sid
  @properties['assistant_sid']
end

#context ⇒ SampleContext

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



327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 327

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

#date_created ⇒ Time 



347
348
349
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 347

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



353
354
355
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 353

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SampleInstance



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

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch a SampleInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#language ⇒ String 



365
366
367
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 365

def language
  @properties['language']
end

#sid ⇒ String 



377
378
379
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 377

def sid
  @properties['sid']
end

#source_channel ⇒ String 



395
396
397
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 395

def source_channel
  @properties['source_channel']
end

#tagged_text ⇒ String 



383
384
385
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 383

def tagged_text
  @properties['tagged_text']
end

#task_sid ⇒ String 



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(language: :unset, tagged_text: :unset, source_channel: :unset) ⇒ SampleInstance

Update the SampleInstance



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

def update(language: :unset, tagged_text: :unset, source_channel: :unset)
  context.update(language: language, tagged_text: tagged_text, source_channel: source_channel, )
end

#url ⇒ String 



389
390
391
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 389

def url
  @properties['url']
end