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.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#contextRatePlanContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


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

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

#data_enabledBoolean

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

Returns:

  • (Boolean)

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


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

def data_enabled
  @properties['data_enabled']
end

#data_limitString

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


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

def data_limit
  @properties['data_limit']
end

#data_meteringString

Returns The model used to meter data usage.

Returns:

  • (String)

    The model used to meter data usage


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

def data_metering
  @properties['data_metering']
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the RatePlanInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchRatePlanInstance

Fetch the RatePlanInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#international_roamingArray[String]

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

Returns:

  • (Array[String])

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


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

def international_roaming
  @properties['international_roaming']
end

#international_roaming_data_limitString

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


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

def international_roaming_data_limit
  @properties['international_roaming_data_limit']
end

#messaging_enabledBoolean

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

Returns:

  • (Boolean)

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


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

def messaging_enabled
  @properties['messaging_enabled']
end

#national_roaming_data_limitString

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


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

def national_roaming_data_limit
  @properties['national_roaming_data_limit']
end

#national_roaming_enabledBoolean

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


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

def national_roaming_enabled
  @properties['national_roaming_enabled']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#unique_nameString

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


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

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:


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

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end

#voice_enabledBoolean

Returns Whether SIMs can make and receive voice calls.

Returns:

  • (Boolean)

    Whether SIMs can make and receive voice calls


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

def voice_enabled
  @properties['voice_enabled']
end