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.



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

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



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

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



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

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:



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 329

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SampleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



426
427
428
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 426

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch the SampleInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



439
440
441
442
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 439

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



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

def language
  @properties['language']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

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



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

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



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

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



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



432
433
434
435
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 432

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:



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

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



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

def url
  @properties['url']
end