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.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 224

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:



265
266
267
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 265

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.



331
332
333
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 331

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.



271
272
273
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 271

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:



256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 256

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:



349
350
351
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 349

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



313
314
315
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 313

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:



363
364
365
366
367
368
369
370
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 363

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.



307
308
309
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 307

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 381

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.



289
290
291
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 289

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.



319
320
321
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 319

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.



277
278
279
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 277

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.



295
296
297
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 295

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.



337
338
339
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 337

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.



283
284
285
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 283

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.



343
344
345
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 343

def private
    @properties['private']
end

#to_s ⇒ Object

Provide a user friendly representation



374
375
376
377
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 374

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.



301
302
303
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 301

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.



355
356
357
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 355

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.



325
326
327
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 325

def version
    @properties['version']
end