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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent/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, intent_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 unique ID of the Assistant.

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

    The unique ID of the Intent associated with this Sample.

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

    The sid



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 290

def initialize(version, payload, assistant_sid: nil, intent_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']),
      'intent_sid' => payload['intent_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,
      'intent_sid' => intent_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that created this Sample.

Returns:

  • (String) —

    The unique ID of the Account that created this Sample.



334
335
336
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 334

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The unique ID of the Assistant.

Returns:

  • (String) —

    The unique ID of the Assistant.



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

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:



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 320

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SampleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch a SampleInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#intent_sid ⇒ String

Returns The unique ID of the Intent associated with this Sample.

Returns:

  • (String) —

    The unique ID of the Intent associated with this Sample.



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

def intent_sid
  @properties['intent_sid']
end

#language ⇒ String

Returns An ISO language-country string of the sample.

Returns:

  • (String) —

    An ISO language-country string of the sample.



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

def language
  @properties['language']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#source_channel ⇒ String

Returns The communication channel the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null.

Returns:

  • (String) —

    The communication channel the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null



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

def source_channel
  @properties['source_channel']
end

#tagged_text ⇒ String

Returns The text example of how end-users may express this intent. The sample may contain Field tag blocks.

Returns:

  • (String) —

    The text example of how end-users may express this intent. The sample may contain Field tag blocks.



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

def tagged_text
  @properties['tagged_text']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

Parameters:

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

    An ISO language-country string of the sample.

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

    The text example of how end-users may express this intent. The sample may contain Field tag blocks.

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

    The communication channel the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null

Returns:



408
409
410
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 408

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 url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end