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.



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

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) 


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

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:



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

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


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

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


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

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns:

  • (String) 


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

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:



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

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def voice_enabled
    @properties['voice_enabled']
end