Class: Twilio::REST::Preview::Marketplace::InstalledAddOnInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Preview::Marketplace::InstalledAddOnInstance
- Defined in:
- lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource.
-
#configuration ⇒ Hash
The JSON object that represents the current configuration of installed Add-on.
-
#context ⇒ InstalledAddOnContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the InstalledAddOnInstance.
-
#description ⇒ String
A short description of the Add-on’s functionality.
-
#extensions ⇒ extensions
Access the extensions.
-
#fetch ⇒ InstalledAddOnInstance
Fetch the InstalledAddOnInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, sid: nil) ⇒ InstalledAddOnInstance
constructor
Initialize the InstalledAddOnInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of related resources.
-
#sid ⇒ String
The unique string that we created to identify the InstalledAddOn resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(configuration: :unset, unique_name: :unset) ⇒ InstalledAddOnInstance
Update the InstalledAddOnInstance.
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ InstalledAddOnInstance
Initialize the InstalledAddOnInstance
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 289 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'friendly_name' => payload['friendly_name'], 'description' => payload['description'], 'configuration' => payload['configuration'], 'unique_name' => payload['unique_name'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { '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 InstalledAddOn resource.
330 331 332 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 330 def account_sid @properties['account_sid'] end |
#configuration ⇒ Hash
Returns The JSON object that represents the current configuration of installed Add-on.
348 349 350 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 348 def configuration @properties['configuration'] end |
#context ⇒ InstalledAddOnContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
315 316 317 318 319 320 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 315 def context unless @instance_context @instance_context = InstalledAddOnContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
360 361 362 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 360 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
366 367 368 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 366 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the InstalledAddOnInstance
385 386 387 388 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 385 def delete context.delete end |
#description ⇒ String
Returns A short description of the Add-on’s functionality.
342 343 344 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 342 def description @properties['description'] end |
#extensions ⇒ extensions
Access the extensions
417 418 419 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 417 def extensions context.extensions end |
#fetch ⇒ InstalledAddOnInstance
Fetch the InstalledAddOnInstance
393 394 395 396 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 393 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
336 337 338 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 336 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
430 431 432 433 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 430 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Marketplace.InstalledAddOnInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of related resources.
378 379 380 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 378 def links @properties['links'] end |
#sid ⇒ String
Returns The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the ‘Available Add-on Sid’.
324 325 326 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 324 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
423 424 425 426 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 423 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Marketplace.InstalledAddOnInstance #{values}>" end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the resource.
354 355 356 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 354 def unique_name @properties['unique_name'] end |
#update(configuration: :unset, unique_name: :unset) ⇒ InstalledAddOnInstance
Update the InstalledAddOnInstance
403 404 405 406 407 408 409 410 411 412 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 403 def update( configuration: :unset, unique_name: :unset ) context.update( configuration: configuration, unique_name: unique_name, ) end |
#url ⇒ String
Returns The absolute URL of the resource.
372 373 374 |
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 372 def url @properties['url'] end |