Class: Twilio::REST::Wireless::V1::RatePlanInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Wireless::V1::RatePlanInstance
- Defined in:
- lib/twilio-ruby/rest/wireless/v1/rate_plan.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the RatePlan resource.
-
#context ⇒ RatePlanContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#data_enabled ⇒ Boolean
Whether SIMs can use GPRS/3G/4G/LTE data connectivity.
-
#data_limit ⇒ 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).
-
#data_metering ⇒ String
The model used to meter data usage.
-
#date_created ⇒ Time
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.
-
#date_updated ⇒ Time
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.
-
#delete ⇒ Boolean
Delete the RatePlanInstance.
-
#fetch ⇒ RatePlanInstance
Fetch the RatePlanInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, sid: nil) ⇒ RatePlanInstance
constructor
Initialize the RatePlanInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#international_roaming ⇒ Array<String>
The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States.
-
#international_roaming_data_limit ⇒ String
The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States.
-
#messaging_enabled ⇒ Boolean
Whether SIMs can make, send, and receive SMS using [Commands](www.twilio.com/docs/iot/wireless/api/command-resource).
-
#national_roaming_data_limit ⇒ 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.
-
#national_roaming_enabled ⇒ Boolean
Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States.
-
#sid ⇒ String
The unique string that we created to identify the RatePlan resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(unique_name: :unset, friendly_name: :unset) ⇒ RatePlanInstance
Update the RatePlanInstance.
-
#url ⇒ String
The absolute URL of the resource.
-
#voice_enabled ⇒ Boolean
Deprecated.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ RatePlanInstance
Initialize the RatePlanInstance
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 317 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.
370 371 372 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 370 def account_sid @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
349 350 351 352 353 354 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 349 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.
382 383 384 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 382 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.
394 395 396 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 394 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/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
388 389 390 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 388 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.
436 437 438 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 436 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.
442 443 444 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 442 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the RatePlanInstance
455 456 457 458 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 455 def delete context.delete end |
#fetch ⇒ RatePlanInstance
Fetch the RatePlanInstance
463 464 465 466 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 463 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
376 377 378 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 376 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
493 494 495 496 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 493 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`.
424 425 426 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 424 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.
430 431 432 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 430 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/iot/wireless/api/command-resource).
400 401 402 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 400 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.
418 419 420 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 418 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/iot/wireless/api/rateplan-resource#national-roaming).
412 413 414 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 412 def national_roaming_enabled @properties['national_roaming_enabled'] end |
#sid ⇒ String
Returns The unique string that we created to identify the RatePlan resource.
358 359 360 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 358 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
486 487 488 489 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 486 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.
364 365 366 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 364 def unique_name @properties['unique_name'] end |
#update(unique_name: :unset, friendly_name: :unset) ⇒ RatePlanInstance
Update the RatePlanInstance
473 474 475 476 477 478 479 480 481 482 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 473 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.
448 449 450 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 448 def url @properties['url'] end |
#voice_enabled ⇒ Boolean
Returns Deprecated. Whether SIMs can make and receive voice calls.
406 407 408 |
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 406 def voice_enabled @properties['voice_enabled'] end |