Class: Twilio::REST::Preview::Understand::AssistantInstance

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

Initialize the AssistantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The sid



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 340

def initialize(version, payload, 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'],
      'latest_model_build_sid' => payload['latest_model_build_sid'],
      'links' => payload['links'],
      'log_queries' => payload['log_queries'],
      'sid' => payload['sid'],
      'ttl' => payload['ttl'].to_i,
      'unique_name' => payload['unique_name'],
      'url' => payload['url'],
      'response_url' => payload['response_url'],
      'callback_url' => payload['callback_url'],
      'callback_events' => payload['callback_events'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#callback_events ⇒ String

Returns The callback_events.

Returns:

  • (String) —

    The callback_events



457
458
459
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 457

def callback_events
  @properties['callback_events']
end

#callback_url ⇒ String

Returns The callback_url.

Returns:

  • (String) —

    The callback_url



451
452
453
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 451

def callback_url
  @properties['callback_url']
end

#context ⇒ AssistantContext

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

Returns:



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

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



391
392
393
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 391

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AssistantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



493
494
495
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 493

def delete
  context.delete
end

#fetch ⇒ AssistantInstance

Fetch a AssistantInstance

Returns:



464
465
466
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 464

def fetch
  context.fetch
end

#field_types ⇒ field_types

Access the field_types

Returns:



500
501
502
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 500

def field_types
  context.field_types
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



534
535
536
537
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 534

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

#intents ⇒ intents

Access the intents

Returns:



507
508
509
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 507

def intents
  context.intents
end

#latest_model_build_sid ⇒ String

Returns The latest_model_build_sid.

Returns:

  • (String) —

    The latest_model_build_sid



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

def latest_model_build_sid
  @properties['latest_model_build_sid']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#log_queries ⇒ Boolean

Returns The log_queries.

Returns:

  • (Boolean) —

    The log_queries



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

def log_queries
  @properties['log_queries']
end

#model_builds ⇒ model_builds

Access the model_builds

Returns:



514
515
516
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 514

def model_builds
  context.model_builds
end

#queries ⇒ queries

Access the queries

Returns:



521
522
523
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 521

def queries
  context.queries
end

#response_url ⇒ String

Returns The response_url.

Returns:

  • (String) —

    The response_url



445
446
447
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 445

def response_url
  @properties['response_url']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



527
528
529
530
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 527

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

#ttl ⇒ String

Returns The ttl.

Returns:

  • (String) —

    The ttl



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

def ttl
  @properties['ttl']
end

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset) ⇒ AssistantInstance

Update the AssistantInstance

Parameters:

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

    The friendly_name

  • log_queries (Boolean) (defaults to: :unset) —

    The log_queries

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

    The ttl

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

    The unique_name

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

    The response_url

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

    The callback_url

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

    The callback_events

Returns:



478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 478

def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
  context.update(
      friendly_name: friendly_name,
      log_queries: log_queries,
      ttl: ttl,
      unique_name: unique_name,
      response_url: response_url,
      callback_url: callback_url,
      callback_events: callback_events,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end