Class: Twilio::REST::Preview::Understand::AssistantContext::IntentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent.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, sid: nil) ⇒ IntentInstance

Initialize the IntentInstance

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

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

    The sid



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 300

def initialize(version, payload, assistant_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']),
      'friendly_name' => payload['friendly_name'],
      'links' => payload['links'],
      'assistant_sid' => payload['assistant_sid'],
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'assistant_sid' => assistant_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The assistant_sid.

Returns:

  • (String) —

    The assistant_sid



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

def assistant_sid
  @properties['assistant_sid']
end

#context ⇒ IntentContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



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

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IntentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ IntentInstance

Fetch a IntentInstance

Returns:



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

def fetch
  context.fetch
end

#fields ⇒ fields

Access the fields

Returns:



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

def fields
  context.fields
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



432
433
434
435
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 432

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#samples ⇒ samples

Access the samples

Returns:



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

def samples
  context.samples
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 425

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

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset) ⇒ IntentInstance

Update the IntentInstance

Parameters:

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

    The friendly_name

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

    The unique_name

Returns:



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

def update(friendly_name: :unset, unique_name: :unset)
  context.update(friendly_name: friendly_name, unique_name: unique_name, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end