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.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 136

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_sid ⇒ String

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:



183
184
185
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 183

def 
    @properties['account_sid']
end

#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.



213
214
215
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 213

def archived
    @properties['archived']
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.



201
202
203
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 201

def changelog
    @properties['changelog']
end

#context ⇒ PluginVersionArchiveContext

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

Returns:



162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 162

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

#date_created ⇒ Time

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:



219
220
221
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 219

def date_created
    @properties['date_created']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



251
252
253
254
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 251

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

#plugin_sid ⇒ String

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.



177
178
179
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 177

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.



195
196
197
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 195

def plugin_url
    @properties['plugin_url']
end

#private ⇒ Boolean

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.



207
208
209
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 207

def private
    @properties['private']
end

#sid ⇒ String

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.



171
172
173
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 171

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



244
245
246
247
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 244

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:



233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 233

def update(
    flex_metadata: :unset
)

    context.update(
        flex_metadata: flex_metadata, 
    )
end

#url ⇒ String

Returns The absolute URL of the Flex Plugin Version resource.

Returns:

  • (String) —

    The absolute URL of the Flex Plugin Version resource.



225
226
227
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 225

def url
    @properties['url']
end

#version ⇒ String

Returns The unique version of this Flex Plugin Version.

Returns:

  • (String) —

    The unique version of this Flex Plugin Version.



189
190
191
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb', line 189

def version
    @properties['version']
end