Class: Twilio::REST::Wireless::V1::SimContext::DataSessionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sim_sid: nil) ⇒ DataSessionInstance

Initialize the DataSessionInstance

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 DataSession resource.

  • sid (String) —

    The SID of the Call resource to fetch.



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 253

def initialize(version, payload , sim_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'sim_sid' => payload['sim_sid'],
        'account_sid' => payload['account_sid'],
        'radio_link' => payload['radio_link'],
        'operator_mcc' => payload['operator_mcc'],
        'operator_mnc' => payload['operator_mnc'],
        'operator_country' => payload['operator_country'],
        'operator_name' => payload['operator_name'],
        'cell_id' => payload['cell_id'],
        'cell_location_estimate' => payload['cell_location_estimate'],
        'packets_uploaded' => payload['packets_uploaded'] == nil ? payload['packets_uploaded'] : payload['packets_uploaded'].to_i,
        'packets_downloaded' => payload['packets_downloaded'] == nil ? payload['packets_downloaded'] : payload['packets_downloaded'].to_i,
        'last_updated' => Twilio.deserialize_iso8601_datetime(payload['last_updated']),
        'start' => Twilio.deserialize_iso8601_datetime(payload['start']),
        '_end' => Twilio.deserialize_iso8601_datetime(payload['_end']),
        'imei' => payload['imei'],
    }
end

Instance Method Details

#_end ⇒ Time

Returns The date that the record ended, given as GMT in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



365
366
367
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 365

def _end
    @properties['_end']
end

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the DataSession resource.

Returns:



293
294
295
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 293

def 
    @properties['account_sid']
end

#cell_id ⇒ String

Returns The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated.

Returns:

  • (String) —

    The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated.



329
330
331
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 329

def cell_id
    @properties['cell_id']
end

#cell_location_estimate ⇒ Hash

Returns An object that describes the estimated location in latitude and longitude where the device’s Data Session took place. The location is derived from the cell_id when the Data Session was last updated. See [Cell Location Estimate Object](www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object).

Returns:



335
336
337
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 335

def cell_location_estimate
    @properties['cell_location_estimate']
end

#imei ⇒ String

Returns The ‘international mobile equipment identity’ is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula.

Returns:

  • (String) —

    The ‘international mobile equipment identity’ is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula.



371
372
373
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 371

def imei
    @properties['imei']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



383
384
385
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 383

def inspect
    "<Twilio.Wireless.V1.DataSessionInstance>"
end

#last_updated ⇒ Time

Returns The date that the resource was last updated, given as GMT in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



353
354
355
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 353

def last_updated
    @properties['last_updated']
end

#operator_country ⇒ String

Returns The three letter country code representing where the device’s Data Session took place. This is determined by looking up the operator_mcc.

Returns:

  • (String) —

    The three letter country code representing where the device’s Data Session took place. This is determined by looking up the operator_mcc.



317
318
319
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 317

def operator_country
    @properties['operator_country']
end

#operator_mcc ⇒ String

Returns The ‘mobile country code’ is the unique ID of the home country where the Data Session took place. See: [MCC/MNC lookup](mcc-mnc.com/).

Returns:

  • (String) —

    The ‘mobile country code’ is the unique ID of the home country where the Data Session took place. See: [MCC/MNC lookup](mcc-mnc.com/).



305
306
307
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 305

def operator_mcc
    @properties['operator_mcc']
end

#operator_mnc ⇒ String

Returns The ‘mobile network code’ is the unique ID specific to the mobile operator network where the Data Session took place.

Returns:

  • (String) —

    The ‘mobile network code’ is the unique ID specific to the mobile operator network where the Data Session took place.



311
312
313
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 311

def operator_mnc
    @properties['operator_mnc']
end

#operator_name ⇒ String

Returns The friendly name of the mobile operator network that the [SIM](www.twilio.com/docs/iot/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the operator_mnc.

Returns:



323
324
325
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 323

def operator_name
    @properties['operator_name']
end

#packets_downloaded ⇒ String

Returns The number of packets downloaded by the device between the start time and when the Data Session was last updated.

Returns:

  • (String) —

    The number of packets downloaded by the device between the start time and when the Data Session was last updated.



347
348
349
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 347

def packets_downloaded
    @properties['packets_downloaded']
end

#packets_uploaded ⇒ String

Returns The number of packets uploaded by the device between the start time and when the Data Session was last updated.

Returns:

  • (String) —

    The number of packets uploaded by the device between the start time and when the Data Session was last updated.



341
342
343
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 341

def packets_uploaded
    @properties['packets_uploaded']
end

#radio_link ⇒ String

Returns The generation of wireless technology that the device was using.

Returns:

  • (String) —

    The generation of wireless technology that the device was using.



299
300
301
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 299

def radio_link
    @properties['radio_link']
end

#sid ⇒ String

Returns The unique string that we created to identify the DataSession resource.

Returns:

  • (String) —

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



281
282
283
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 281

def sid
    @properties['sid']
end

#sim_sid ⇒ String

Returns The SID of the [Sim resource](www.twilio.com/docs/iot/wireless/api/sim-resource) that the Data Session is for.

Returns:



287
288
289
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 287

def sim_sid
    @properties['sim_sid']
end

#start ⇒ Time

Returns The date that the Data Session started, given as GMT in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



359
360
361
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 359

def start
    @properties['start']
end

#to_s ⇒ Object

Provide a user friendly representation



377
378
379
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 377

def to_s
    "<Twilio.Wireless.V1.DataSessionInstance>"
end