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

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

    The SID of the RatePlan resource to fetch.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 267

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



320
321
322
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 320

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:



299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 299

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



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

def data_enabled
  @properties['data_enabled']
end

#data_limit ⇒ String

Returns The total data usage in Megabytes that the Network allows during one month on the home network.

Returns:

  • (String) —

    The total data usage in Megabytes that the Network allows during one month on the home network



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

def data_limit
  @properties['data_limit']
end

#data_metering ⇒ String

Returns The model used to meter data usage.

Returns:

  • (String) —

    The model used to meter data usage



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

def data_metering
  @properties['data_metering']
end

#date_created ⇒ Time

Returns The date when the resource was created, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The date when the resource was created, given as GMT in ISO 8601 format



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date when the resource was last updated, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The date when the resource was last updated, given as GMT in ISO 8601 format



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



424
425
426
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 424

def delete
  context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#international_roaming ⇒ String

Returns The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States.

Returns:

  • (String) —

    The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States



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

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.

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



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

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.

Returns:

  • (Boolean) —

    Whether SIMs can make, send, and receive SMS using Commands



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

def messaging_enabled
  @properties['messaging_enabled']
end

#national_roaming_data_limit ⇒ String

Returns The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States.

Returns:

  • (String) —

    The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States



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

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 in the United States.

Returns:

  • (Boolean) —

    Whether SIMs can roam on networks other than the home network in the United States



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

def national_roaming_enabled
  @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



308
309
310
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 308

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



430
431
432
433
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 430

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.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



314
315
316
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 314

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:



417
418
419
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 417

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



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

def url
  @properties['url']
end

#voice_enabled ⇒ Boolean

Returns Whether SIMs can make and receive voice calls.

Returns:

  • (Boolean) —

    Whether SIMs can make and receive voice calls



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

def voice_enabled
  @properties['voice_enabled']
end