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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/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.



289
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
315
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 289

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'],
        'national_roaming_data_limit' => payload['national_roaming_data_limit'] == nil ? payload['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'] == nil ? payload['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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the RatePlan resource.

Returns:



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:



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

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

#data_enabled ⇒ Boolean

Returns Whether SIMs can use GPRS/3G/4G/LTE data connectivity.

Returns:

  • (Boolean) —

    Whether SIMs can use GPRS/3G/4G/LTE data connectivity.



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 total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB.

Returns:

  • (String) —

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB.



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 model used to meter data usage. Can be: ‘payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).

Returns:



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 and time in GMT when the resource was created specified in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



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 and time in GMT when the resource was last updated specified in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



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



465
466
467
468
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 465

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

#international_roaming ⇒ Array<String>

Returns The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: ‘data` and `messaging`.

Returns:

  • (Array<String>) —

    The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: ‘data` and `messaging`.



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 total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.

Returns:

  • (String) —

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.



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 Whether SIMs can make, send, and receive SMS using [Commands](www.twilio.com/docs/wireless/api/command-resource).

Returns:



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 total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB.

Returns:

  • (String) —

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB.



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 Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).

Returns:



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 unique string that we created to identify the RatePlan resource.

Returns:

  • (String) —

    The unique string that we created to identify the RatePlan resource.



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



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

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.



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

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

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

    A descriptive string that you create to describe the resource. It does not have to be unique.

Returns:



445
446
447
448
449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 445

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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns Deprecated. Whether SIMs can make and receive voice calls.

Returns:

  • (Boolean) —

    Deprecated. Whether SIMs can make and receive voice calls.



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

def voice_enabled
    @properties['voice_enabled']
end