Class: Twilio::REST::Assistants::V1::ToolInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, id: nil) ⇒ ToolInstance

Initialize the ToolInstance

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 Tool resource.

  • sid (String) —

    The SID of the Call resource to fetch.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/twilio-ruby/rest/assistants/v1/tool.rb', line 453

def initialize(version, payload , id: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'description' => payload['description'],
        'enabled' => payload['enabled'],
        'id' => payload['id'],
        'meta' => payload['meta'],
        'name' => payload['name'],
        'requires_auth' => payload['requires_auth'],
        'type' => payload['type'],
        'url' => payload['url'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'policies' => payload['policies'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Tool resource.

Returns:



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

def 
    @properties['account_sid']
end

#context ⇒ ToolContext

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

Returns:



481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/assistants/v1/tool.rb', line 481

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

#date_created ⇒ Time

Returns The date and time in GMT when the Tool was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Tool was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ToolInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#description ⇒ String

Returns The description of the tool.

Returns:

  • (String) —

    The description of the tool.



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

def description
    @properties['description']
end

#enabled ⇒ Boolean

Returns True if the tool is enabled.

Returns:

  • (Boolean) —

    True if the tool is enabled.



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

def enabled
    @properties['enabled']
end

#fetch ⇒ ToolInstance

Fetch the ToolInstance

Returns:



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

def fetch

    context.fetch
end

#id ⇒ String

Returns The tool ID.

Returns:

  • (String) —

    The tool ID.



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

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



596
597
598
599
 
# File 'lib/twilio-ruby/rest/assistants/v1/tool.rb', line 596

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

#meta ⇒ Hash

Returns The metadata related to method, url, input_schema to used with the Tool.

Returns:

  • (Hash) —

    The metadata related to method, url, input_schema to used with the Tool.



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

def meta
    @properties['meta']
end

#name ⇒ String

Returns The name of the tool.

Returns:

  • (String) —

    The name of the tool.



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

def name
    @properties['name']
end

#policies ⇒ Array<AssistantsV1ServicePolicy>

Returns The Policies associated with the tool.

Returns:

  • (Array<AssistantsV1ServicePolicy>) —

    The Policies associated with the tool.



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

def policies
    @properties['policies']
end

#requires_auth ⇒ Boolean

Returns The authentication requirement for the tool.

Returns:

  • (Boolean) —

    The authentication requirement for the tool.



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

def requires_auth
    @properties['requires_auth']
end

#to_s ⇒ Object

Provide a user friendly representation



589
590
591
592
 
# File 'lib/twilio-ruby/rest/assistants/v1/tool.rb', line 589

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

#type ⇒ String

Returns The type of the tool. (‘WEBHOOK’).

Returns:

  • (String) —

    The type of the tool. (‘WEBHOOK’)



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

def type
    @properties['type']
end

#update(assistants_v1_service_update_tool_request: :unset) ⇒ ToolInstance

Update the ToolInstance

Parameters:

  • assistants_v1_service_update_tool_request (AssistantsV1ServiceUpdateToolRequest) (defaults to: :unset)

Returns:



580
581
582
583
584
585
 
# File 'lib/twilio-ruby/rest/assistants/v1/tool.rb', line 580

def update(assistants_v1_service_update_tool_request: :unset
)

    context.update(
    )
end

#url ⇒ String

Returns The url of the tool resource.

Returns:

  • (String) —

    The url of the tool resource.



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

def url
    @properties['url']
end