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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 280

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 



324
325
326
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 324

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String 



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

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



310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 310

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 



330
331
332
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 330

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



336
337
338
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 336

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SampleInstance



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

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch the SampleInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#language ⇒ String 



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

def language
  @properties['language']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#source_channel ⇒ String 



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

def source_channel
  @properties['source_channel']
end

#tagged_text ⇒ String 



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

def tagged_text
  @properties['tagged_text']
end

#task_sid ⇒ String 



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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 



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

def url
  @properties['url']
end