Class: Twilio::REST::FlexApi::V1::PluginConfigurationContext::ConfiguredPluginInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, configuration_sid: nil, plugin_sid: nil) ⇒ ConfiguredPluginInstance

Initialize the ConfiguredPluginInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 402

def initialize(version, payload , configuration_sid: nil, plugin_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'configuration_sid' => payload['configuration_sid'],
        'plugin_sid' => payload['plugin_sid'],
        'plugin_version_sid' => payload['plugin_version_sid'],
        'phase' => payload['phase'] == nil ? payload['phase'] : payload['phase'].to_i,
        'plugin_url' => payload['plugin_url'],
        'unique_name' => payload['unique_name'],
        'friendly_name' => payload['friendly_name'],
        'description' => payload['description'],
        'plugin_archived' => payload['plugin_archived'],
        'version' => payload['version'],
        'changelog' => payload['changelog'],
        'plugin_version_archived' => payload['plugin_version_archived'],
        'private' => payload['private'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for.

Returns:



444
445
446
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 444

def 
    @properties['account_sid']
end

#changelog ⇒ String

Returns A changelog that describes the changes this Flex Plugin Version brings.

Returns:

  • (String) —

    A changelog that describes the changes this Flex Plugin Version brings.



510
511
512
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 510

def changelog
    @properties['changelog']
end

#configuration_sid ⇒ String

Returns The SID of the Flex Plugin Configuration that this Flex Plugin belongs to.

Returns:

  • (String) —

    The SID of the Flex Plugin Configuration that this Flex Plugin belongs to.



450
451
452
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 450

def configuration_sid
    @properties['configuration_sid']
end

#context ⇒ ConfiguredPluginContext

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

Returns:



435
436
437
438
439
440
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 435

def context
    unless @instance_context
        @instance_context = ConfiguredPluginContext.new(@version , @params['configuration_sid'], @params['plugin_sid'])
    end
    @instance_context
end

#date_created ⇒ Time

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

Returns:



528
529
530
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 528

def date_created
    @properties['date_created']
end

#description ⇒ String

Returns A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long.

Returns:

  • (String) —

    A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long



492
493
494
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 492

def description
    @properties['description']
end

#fetch(flex_metadata: :unset) ⇒ ConfiguredPluginInstance

Fetch the ConfiguredPluginInstance

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



542
543
544
545
546
547
548
549
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 542

def fetch(
  flex_metadata: :unset
)

    context.fetch(
        flex_metadata: flex_metadata, 
    )
end

#friendly_name ⇒ String

Returns The friendly name of this Flex Plugin resource.

Returns:

  • (String) —

    The friendly name of this Flex Plugin resource.



486
487
488
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 486

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



560
561
562
563
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 560

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

#phase ⇒ String

Returns The phase this Flex Plugin would initialize at runtime.

Returns:

  • (String) —

    The phase this Flex Plugin would initialize at runtime.



468
469
470
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 468

def phase
    @properties['phase']
end

#plugin_archived ⇒ Boolean

Returns Whether the Flex Plugin is archived. The default value is false.

Returns:

  • (Boolean) —

    Whether the Flex Plugin is archived. The default value is false.



498
499
500
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 498

def plugin_archived
    @properties['plugin_archived']
end

#plugin_sid ⇒ String

Returns The SID of the Flex Plugin.

Returns:

  • (String) —

    The SID of the Flex Plugin.



456
457
458
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 456

def plugin_sid
    @properties['plugin_sid']
end

#plugin_url ⇒ String

Returns The URL of where the Flex Plugin Version JavaScript bundle is hosted on.

Returns:

  • (String) —

    The URL of where the Flex Plugin Version JavaScript bundle is hosted on.



474
475
476
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 474

def plugin_url
    @properties['plugin_url']
end

#plugin_version_archived ⇒ Boolean

Returns Whether the Flex Plugin Version is archived. The default value is false.

Returns:

  • (Boolean) —

    Whether the Flex Plugin Version is archived. The default value is false.



516
517
518
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 516

def plugin_version_archived
    @properties['plugin_version_archived']
end

#plugin_version_sid ⇒ String

Returns The SID of the Flex Plugin Version.

Returns:

  • (String) —

    The SID of the Flex Plugin Version.



462
463
464
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 462

def plugin_version_sid
    @properties['plugin_version_sid']
end

#private ⇒ Boolean

Returns Whether to validate the request is authorized to access the Flex Plugin Version.

Returns:

  • (Boolean) —

    Whether to validate the request is authorized to access the Flex Plugin Version.



522
523
524
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 522

def private
    @properties['private']
end

#to_s ⇒ Object

Provide a user friendly representation



553
554
555
556
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 553

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

#unique_name ⇒ String

Returns The name that uniquely identifies this Flex Plugin resource.

Returns:

  • (String) —

    The name that uniquely identifies this Flex Plugin resource.



480
481
482
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 480

def unique_name
    @properties['unique_name']
end

#url ⇒ String

Returns The absolute URL of the Flex Plugin resource.

Returns:

  • (String) —

    The absolute URL of the Flex Plugin resource.



534
535
536
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 534

def url
    @properties['url']
end

#version ⇒ String

Returns The latest version of this Flex Plugin Version.

Returns:

  • (String) —

    The latest version of this Flex Plugin Version.



504
505
506
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 504

def version
    @properties['version']
end