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.



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

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) 


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

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:



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

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


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

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


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

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns:

  • (String) 


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

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:



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

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def voice_enabled
    @properties['voice_enabled']
end