Class: Twilio::REST::Numbers::V2::ApplicationInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/application.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ApplicationInstance

Initialize the ApplicationInstance

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

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 287

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'bundle_sid' => payload['bundle_sid'],
        'application_requirements_sid' => payload['application_requirements_sid'],
        'friendly_name' => payload['friendly_name'],
        'iso_country' => payload['iso_country'],
        'state' => payload['state'],
    }

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

Instance Method Details

#application_requirements_sidString

Returns The Application Requirements SID.

Returns:

  • (String)

    The Application Requirements SID.



330
331
332
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 330

def application_requirements_sid
    @properties['application_requirements_sid']
end

#bundle_sidString

Returns The Bundle SID for regulatory compliance.

Returns:

  • (String)

    The Bundle SID for regulatory compliance.



324
325
326
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 324

def bundle_sid
    @properties['bundle_sid']
end

#contextApplicationContext

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

Returns:



309
310
311
312
313
314
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 309

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

#fetchApplicationInstance

Fetch the ApplicationInstance

Returns:



355
356
357
358
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 355

def fetch

    context.fetch
end

#friendly_nameString

Returns The friendly name of the application.

Returns:

  • (String)

    The friendly name of the application.



336
337
338
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 336

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



369
370
371
372
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 369

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

#iso_countryString

Returns The ISO country code.

Returns:

  • (String)

    The ISO country code.



342
343
344
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 342

def iso_country
    @properties['iso_country']
end

#sidString

Returns The unique identifier of the Short Code Application.

Returns:

  • (String)

    The unique identifier of the Short Code Application.



318
319
320
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 318

def sid
    @properties['sid']
end

#stateString

Returns The state of the application.

Returns:

  • (String)

    The state of the application.



348
349
350
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 348

def state
    @properties['state']
end

#to_sObject

Provide a user friendly representation



362
363
364
365
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 362

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