Class: Twilio::REST::Preview::Wireless::RatePlanInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/wireless/rate_plan.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the RatePlanInstance

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

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 292

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'data_enabled' => payload['data_enabled'],
        'data_metering' => payload['data_metering'],
        'data_limit' => payload['data_limit'] == nil ? payload['data_limit'] : payload['data_limit'].to_i,
        'messaging_enabled' => payload['messaging_enabled'],
        'voice_enabled' => payload['voice_enabled'],
        'national_roaming_enabled' => payload['national_roaming_enabled'],
        'international_roaming' => payload['international_roaming'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


343
344
345
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 343

def 
    @properties['account_sid']
end

#context ⇒ RatePlanContext

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

Returns:



322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 322

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


355
356
357
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 355

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


367
368
369
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 367

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


361
362
363
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 361

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


397
398
399
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 397

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


403
404
405
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 403

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



416
417
418
419
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 416

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



424
425
426
427
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 424

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


349
350
351
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 349

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



454
455
456
457
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 454

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


391
392
393
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 391

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


373
374
375
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 373

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


385
386
387
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 385

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


331
332
333
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 331

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



447
448
449
450
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 447

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

#unique_name ⇒ String

Returns:

  • (String) 


337
338
339
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 337

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, friendly_name: :unset) ⇒ RatePlanInstance

Update the RatePlanInstance

Parameters:

  • unique_name (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)

Returns:



434
435
436
437
438
439
440
441
442
443
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 434

def update(
    unique_name: :unset, 
    friendly_name: :unset
)

    context.update(
        unique_name: unique_name, 
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns:

  • (String) 


409
410
411
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 409

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


379
380
381
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 379

def voice_enabled
    @properties['voice_enabled']
end