Class: Twilio::REST::Autopilot::V1::AssistantInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant.rb

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

  • account_sid (String) —

    The SID of the Account that created this Assistant resource.

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

    The SID of the Call resource to fetch.



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 439

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'],
        'development_stage' => payload['development_stage'],
        'needs_model_build' => payload['needs_model_build'],
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'url' => payload['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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Assistant resource.

Returns:



478
479
480
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 478

def 
    @properties['account_sid']
end

#callback_events ⇒ String

Returns Reserved.

Returns:

  • (String) —

    Reserved.



556
557
558
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 556

def callback_events
    @properties['callback_events']
end

#callback_url ⇒ String

Returns Reserved.

Returns:

  • (String) —

    Reserved.



550
551
552
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 550

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:



469
470
471
472
473
474
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 469

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 484

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



490
491
492
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 490

def date_updated
    @properties['date_updated']
end

#defaults ⇒ defaults

Access the defaults

Returns:



620
621
622
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 620

def defaults
    context.defaults
end

#delete ⇒ Boolean

Delete the AssistantInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



563
564
565
566
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 563

def delete

    context.delete
end

#development_stage ⇒ String

Returns A string describing the state of the assistant.

Returns:

  • (String) —

    A string describing the state of the assistant.



520
521
522
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 520

def development_stage
    @properties['development_stage']
end

#dialogues ⇒ dialogues

Access the dialogues

Returns:



634
635
636
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 634

def dialogues
    context.dialogues
end

#fetch ⇒ AssistantInstance

Fetch the AssistantInstance

Returns:



571
572
573
574
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 571

def fetch

    context.fetch
end

#field_types ⇒ field_types

Access the field_types

Returns:



648
649
650
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 648

def field_types
    context.field_types
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.

Returns:

  • (String) —

    The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.



496
497
498
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 496

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



675
676
677
678
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 675

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

#latest_model_build_sid ⇒ String

Returns Reserved.

Returns:

  • (String) —

    Reserved.



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

def latest_model_build_sid
    @properties['latest_model_build_sid']
end

#links ⇒ Hash

Returns A list of the URLs of the Assistant’s related resources.

Returns:

  • (Hash) —

    A list of the URLs of the Assistant’s related resources.



508
509
510
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 508

def links
    @properties['links']
end

#log_queries ⇒ Boolean

Returns Whether queries should be logged and kept after training. Can be: ‘true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.

Returns:

  • (Boolean) —

    Whether queries should be logged and kept after training. Can be: ‘true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.



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

def log_queries
    @properties['log_queries']
end

#model_builds ⇒ model_builds

Access the model_builds

Returns:



641
642
643
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 641

def model_builds
    context.model_builds
end

#needs_model_build ⇒ Boolean

Returns Whether model needs to be rebuilt.

Returns:

  • (Boolean) —

    Whether model needs to be rebuilt.



526
527
528
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 526

def needs_model_build
    @properties['needs_model_build']
end

#queries ⇒ queries

Access the queries

Returns:



662
663
664
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 662

def queries
    context.queries
end

#sid ⇒ String

Returns The unique string that we created to identify the Assistant resource.

Returns:

  • (String) —

    The unique string that we created to identify the Assistant resource.



532
533
534
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 532

def sid
    @properties['sid']
end

#style_sheet ⇒ style_sheet

Access the style_sheet

Returns:



655
656
657
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 655

def style_sheet
    context.style_sheet
end

#tasks ⇒ tasks

Access the tasks

Returns:



613
614
615
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 613

def tasks
    context.tasks
end

#to_s ⇒ Object

Provide a user friendly representation



668
669
670
671
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 668

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource. It can be up to 64 characters long.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource. It can be up to 64 characters long.



538
539
540
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 538

def unique_name
    @properties['unique_name']
end

#update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset, development_stage: :unset) ⇒ AssistantInstance

Update the AssistantInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

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

    Whether queries should be logged and kept after training. Can be: ‘true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.

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

    An application-defined string that uniquely identifies the resource. It can be used as an alternative to the ‘sid` in the URL path to address the resource. The first 64 characters must be unique.

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

    Reserved.

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

    Reserved.

  • style_sheet (Object) (defaults to: :unset) —

    The JSON string that defines the Assistant’s [style sheet](www.twilio.com/docs/autopilot/api/assistant/stylesheet)

  • defaults (Object) (defaults to: :unset) —

    A JSON object that defines the Assistant’s [default tasks](www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks.

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

    A string describing the state of the assistant.

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 587

def update(
    friendly_name: :unset, 
    log_queries: :unset, 
    unique_name: :unset, 
    callback_url: :unset, 
    callback_events: :unset, 
    style_sheet: :unset, 
    defaults: :unset, 
    development_stage: :unset
)

    context.update(
        friendly_name: friendly_name, 
        log_queries: log_queries, 
        unique_name: unique_name, 
        callback_url: callback_url, 
        callback_events: callback_events, 
        style_sheet: style_sheet, 
        defaults: defaults, 
        development_stage: development_stage, 
    )
end

#url ⇒ String

Returns The absolute URL of the Assistant resource.

Returns:

  • (String) —

    The absolute URL of the Assistant resource.



544
545
546
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 544

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



627
628
629
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant.rb', line 627

def webhooks
    context.webhooks
end