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



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

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



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

def 
  @properties['account_sid']
end

#callback_events ⇒ String

Returns The callback_events.

Returns:

  • (String) —

    The callback_events



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

def callback_events
  @properties['callback_events']
end

#callback_url ⇒ String

Returns The callback_url.

Returns:

  • (String) —

    The callback_url



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

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:



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

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AssistantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ AssistantInstance

Fetch a AssistantInstance

Returns:



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

def fetch
  context.fetch
end

#field_types ⇒ field_types

Access the field_types

Returns:



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

def field_types
  context.field_types
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#intents ⇒ intents

Access the intents

Returns:



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

def intents
  context.intents
end

#latest_model_build_sid ⇒ String

Returns The latest_model_build_sid.

Returns:

  • (String) —

    The latest_model_build_sid



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

def latest_model_build_sid
  @properties['latest_model_build_sid']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#log_queries ⇒ Boolean

Returns The log_queries.

Returns:

  • (Boolean) —

    The log_queries



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

def log_queries
  @properties['log_queries']
end

#model_builds ⇒ model_builds

Access the model_builds

Returns:



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

def model_builds
  context.model_builds
end

#queries ⇒ queries

Access the queries

Returns:



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

def queries
  context.queries
end

#response_url ⇒ String

Returns The response_url.

Returns:

  • (String) —

    The response_url



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

def response_url
  @properties['response_url']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def ttl
  @properties['ttl']
end

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

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:



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

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



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

def url
  @properties['url']
end