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 assistant_sid

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

    The intent_sid

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

    The sid



282
283
284
285
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/preview/understand/assistant/intent/sample.rb', line 282

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

Returns:

  • (String) —

    The account_sid



326
327
328
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 326

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The assistant_sid.

Returns:

  • (String) —

    The assistant_sid



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

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
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 312

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

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SampleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SampleInstance

Fetch a SampleInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#intent_sid ⇒ String

Returns The intent_sid.

Returns:

  • (String) —

    The intent_sid



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

def intent_sid
  @properties['intent_sid']
end

#language ⇒ String

Returns The language.

Returns:

  • (String) —

    The language



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

def language
  @properties['language']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#source_channel ⇒ String

Returns The source_channel.

Returns:

  • (String) —

    The source_channel



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

def source_channel
  @properties['source_channel']
end

#tagged_text ⇒ String

Returns The tagged_text.

Returns:

  • (String) —

    The tagged_text



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

def tagged_text
  @properties['tagged_text']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    The language

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

    The tagged_text

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

    The source_channel

Returns:



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

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



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

def url
  @properties['url']
end