Class: Twilio::REST::Wireless::V1::RatePlanInstance

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    The sid



284
285
286
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
312
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 284

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'].to_i,
      'messaging_enabled' => payload['messaging_enabled'],
      'voice_enabled' => payload['voice_enabled'],
      'national_roaming_enabled' => payload['national_roaming_enabled'],
      'national_roaming_data_limit' => payload['national_roaming_data_limit'].to_i,
      'international_roaming' => payload['international_roaming'],
      'international_roaming_data_limit' => payload['international_roaming_data_limit'].to_i,
      '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 The account_sid.

Returns:

  • (String) —

    The account_sid



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

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
324
325
326
 
# File 'lib/twilio-ruby/rest/wireless/v1/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 The data_enabled.

Returns:

  • (Boolean) —

    The data_enabled



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

def data_enabled
  @properties['data_enabled']
end

#data_limit ⇒ String

Returns The data_limit.

Returns:

  • (String) —

    The data_limit



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

def data_limit
  @properties['data_limit']
end

#data_metering ⇒ String

Returns The data_metering.

Returns:

  • (String) —

    The data_metering



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

def data_metering
  @properties['data_metering']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RatePlanInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ RatePlanInstance

Fetch a RatePlanInstance

Returns:



427
428
429
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 427

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 459

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

#international_roaming ⇒ String

Returns The international_roaming.

Returns:

  • (String) —

    The international_roaming



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

def international_roaming
  @properties['international_roaming']
end

#international_roaming_data_limit ⇒ String

Returns The international_roaming_data_limit.

Returns:

  • (String) —

    The international_roaming_data_limit



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

def international_roaming_data_limit
  @properties['international_roaming_data_limit']
end

#messaging_enabled ⇒ Boolean

Returns The messaging_enabled.

Returns:

  • (Boolean) —

    The messaging_enabled



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

def messaging_enabled
  @properties['messaging_enabled']
end

#national_roaming_data_limit ⇒ String

Returns The national_roaming_data_limit.

Returns:

  • (String) —

    The national_roaming_data_limit



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

def national_roaming_data_limit
  @properties['national_roaming_data_limit']
end

#national_roaming_enabled ⇒ Boolean

Returns The national_roaming_enabled.

Returns:

  • (Boolean) —

    The national_roaming_enabled



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

def national_roaming_enabled
  @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

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) —

    The unique_name

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

    The friendly_name

Returns:



436
437
438
439
440
441
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 436

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#voice_enabled ⇒ Boolean

Returns The voice_enabled.

Returns:

  • (Boolean) —

    The voice_enabled



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

def voice_enabled
  @properties['voice_enabled']
end