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 unique ID of the Assistant.

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

    The sid



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/preview/understand/assistant/intent.rb', line 304

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 unique ID of the Account that created this Intent.

Returns:

  • (String) —

    The unique ID of the Account that created this Intent.



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

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The unique ID of the Assistant.

Returns:

  • (String) —

    The unique ID of the Assistant.



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

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:



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

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 that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IntentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ IntentInstance

Fetch a IntentInstance

Returns:



393
394
395
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 393

def fetch
  context.fetch
end

#fields ⇒ fields

Access the fields

Returns:



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

def fields
  context.fields
end

#friendly_name ⇒ String

Returns A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

Returns:

  • (String) —

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



438
439
440
441
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 438

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



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

def links
  @properties['links']
end

#samples ⇒ samples

Access the samples

Returns:



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

def samples
  context.samples
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

Returns:

  • (String) —

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.



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

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

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

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

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

Returns:



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

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



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

def url
  @properties['url']
end