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.



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

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) 


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

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:



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

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


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

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


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

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns:

  • (String) 


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

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:



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

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def voice_enabled
    @properties['voice_enabled']
end