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

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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

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

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

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

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

    The Twilio-provided string that uniquely identifies the Sample resource to fetch.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 316

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

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the Assistant that is the parent of the Task associated with the resource.

Returns:

  • (String) —

    The SID of the Assistant that is the parent of the Task associated with the resource



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

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:



346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 346

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 RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SampleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



443
444
445
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 443

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch a SampleInstance

Returns:



421
422
423
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 421

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



456
457
458
459
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 456

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

#language ⇒ String

Returns An ISO language-country string that specifies the language used for the sample.

Returns:

  • (String) —

    An ISO language-country string that specifies the language used for the sample



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

def language
  @properties['language']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



396
397
398
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 396

def sid
  @properties['sid']
end

#source_channel ⇒ String

Returns The communication channel from which the sample was captured.

Returns:

  • (String) —

    The communication channel from which the sample was captured



414
415
416
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 414

def source_channel
  @properties['source_channel']
end

#tagged_text ⇒ String

Returns The text example of how end users might express the task.

Returns:

  • (String) —

    The text example of how end users might express the task



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

def tagged_text
  @properties['tagged_text']
end

#task_sid ⇒ String

Returns The SID of the Task associated with the resource.

Returns:

  • (String) —

    The SID of the Task associated with the resource



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



449
450
451
452
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 449

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:



436
437
438
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 436

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



408
409
410
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 408

def url
  @properties['url']
end