Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskContext::SampleInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the SampleInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Sample resource.

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

    The SID of the Call resource to fetch.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 286

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  || @properties['assistant_sid']  ,'task_sid' => task_sid  || @properties['task_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Sample resource.

Returns:



321
322
323
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 321

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource.

Returns:



351
352
353
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 351

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

Returns:



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 312

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

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



327
328
329
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 327

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



333
334
335
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 333

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SampleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ SampleInstance

Fetch the SampleInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



423
424
425
426
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 423

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

#language ⇒ String

Returns The [ISO language-country](docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: ‘en-US`.

Returns:



345
346
347
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 345

def language
    @properties['language']
end

#sid ⇒ String

Returns The unique string that we created to identify the Sample resource.

Returns:

  • (String) —

    The unique string that we created to identify the Sample resource.



357
358
359
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 357

def sid
    @properties['sid']
end

#source_channel ⇒ String

Returns The communication channel from which the sample was captured. Can be: ‘voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.

Returns:

  • (String) —

    The communication channel from which the sample was captured. Can be: ‘voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.



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

def source_channel
    @properties['source_channel']
end

#tagged_text ⇒ String

Returns The text example of how end users might express the task. The sample can contain [Field tag blocks](www.twilio.com/docs/autopilot/api/task-sample#field-tagging).

Returns:



363
364
365
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 363

def tagged_text
    @properties['tagged_text']
end

#task_sid ⇒ String

Returns The SID of the [Task](www.twilio.com/docs/autopilot/api/task) associated with the resource.

Returns:



339
340
341
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 339

def task_sid
    @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



416
417
418
419
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 416

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

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

Update the SampleInstance

Parameters:

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

    The [ISO language-country](docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: ‘en-US`.

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

    The text example of how end users might express the task. The sample can contain [Field tag blocks](www.twilio.com/docs/autopilot/api/task-sample#field-tagging).

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

    The communication channel from which the sample was captured. Can be: ‘voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.

Returns:



401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 401

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

Returns The absolute URL of the Sample resource.

Returns:

  • (String) —

    The absolute URL of the Sample resource.



369
370
371
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 369

def url
    @properties['url']
end