Class: Twilio::REST::FlexApi::V1::PluginVersionArchiveInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, plugin_sid: nil, sid: nil) ⇒ PluginVersionArchiveInstance

Initialize the PluginVersionArchiveInstance

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

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 275

def initialize(version, payload , plugin_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'plugin_sid' => payload['plugin_sid'],
        'account_sid' => payload['account_sid'],
        'version' => payload['version'],
        'plugin_url' => payload['plugin_url'],
        'changelog' => payload['changelog'],
        'private' => payload['private'],
        'archived' => payload['archived'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource.

Returns:



323
324
325
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 323

def 
    @properties['account_sid']
end

#archivedBoolean

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.



353
354
355
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 353

def archived
    @properties['archived']
end

#changelogString

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.



341
342
343
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 341

def changelog
    @properties['changelog']
end

#contextPluginVersionArchiveContext

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

Returns:



302
303
304
305
306
307
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 302

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

#date_createdTime

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

Returns:



359
360
361
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 359

def date_created
    @properties['date_created']
end

#inspectObject

Provide a detailed, user friendly representation



391
392
393
394
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 391

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

#plugin_sidString

Returns The SID of the Flex Plugin resource this Flex Plugin Version belongs to.

Returns:

  • (String)

    The SID of the Flex Plugin resource this Flex Plugin Version belongs to.



317
318
319
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 317

def plugin_sid
    @properties['plugin_sid']
end

#plugin_urlString

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.



335
336
337
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 335

def plugin_url
    @properties['plugin_url']
end

#privateBoolean

Returns Whether to inject credentials while accessing this Plugin Version. The default value is false.

Returns:

  • (Boolean)

    Whether to inject credentials while accessing this Plugin Version. The default value is false.



347
348
349
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 347

def private
    @properties['private']
end

#sidString

Returns The unique string that we created to identify the Flex Plugin Version resource.

Returns:

  • (String)

    The unique string that we created to identify the Flex Plugin Version resource.



311
312
313
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 311

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



384
385
386
387
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 384

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

#update(flex_metadata: :unset) ⇒ PluginVersionArchiveInstance

Update the PluginVersionArchiveInstance

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



373
374
375
376
377
378
379
380
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 373

def update(
    flex_metadata: :unset
)

    context.update(
        flex_metadata: , 
    )
end

#urlString

Returns The absolute URL of the Flex Plugin Version resource.

Returns:

  • (String)

    The absolute URL of the Flex Plugin Version resource.



365
366
367
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 365

def url
    @properties['url']
end

#versionString

Returns The unique version of this Flex Plugin Version.

Returns:

  • (String)

    The unique version of this Flex Plugin Version.



329
330
331
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 329

def version
    @properties['version']
end