Class: Twilio::REST::Supersim::V1::UsageRecordInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/usage_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ UsageRecordInstance

Initialize the UsageRecordInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 211

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sim_sid' => payload['sim_sid'],
        'network_sid' => payload['network_sid'],
        'fleet_sid' => payload['fleet_sid'],
        'iso_country' => payload['iso_country'],
        'period' => payload['period'],
        'data_upload' => payload['data_upload'],
        'data_download' => payload['data_download'],
        'data_total' => payload['data_total'],
        'data_total_billed' => payload['data_total_billed'],
        'billed_unit' => payload['billed_unit'],
    }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



233
234
235
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 233

def 
    @properties['account_sid']
end

#billed_unit ⇒ String

Returns The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. ‘USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.

Returns:



293
294
295
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 293

def billed_unit
    @properties['billed_unit']
end

#data_download ⇒ String

Returns Total data downloaded in bytes, aggregated by the query parameters.

Returns:

  • (String) —

    Total data downloaded in bytes, aggregated by the query parameters.



275
276
277
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 275

def data_download
    @properties['data_download']
end

#data_total ⇒ String

Returns Total of data_upload and data_download.

Returns:

  • (String) —

    Total of data_upload and data_download.



281
282
283
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 281

def data_total
    @properties['data_total']
end

#data_total_billed ⇒ Float

Returns Total amount in the ‘billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio’s billing system. Refer to [Data Usage Processing](www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.

Returns:

  • (Float) —

    Total amount in the ‘billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio’s billing system. Refer to [Data Usage Processing](www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.



287
288
289
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 287

def data_total_billed
    @properties['data_total_billed']
end

#data_upload ⇒ String

Returns Total data uploaded in bytes, aggregated by the query parameters.

Returns:

  • (String) —

    Total data uploaded in bytes, aggregated by the query parameters.



269
270
271
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 269

def data_upload
    @properties['data_upload']
end

#fleet_sid ⇒ String

Returns SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the ‘Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`.

Returns:

  • (String) —

    SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the ‘Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`.



251
252
253
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 251

def fleet_sid
    @properties['fleet_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



305
306
307
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 305

def inspect
    "<Twilio.Supersim.V1.UsageRecordInstance>"
end

#iso_country ⇒ String

Returns Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the ‘IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`.

Returns:

  • (String) —

    Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the ‘IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`.



257
258
259
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 257

def iso_country
    @properties['iso_country']
end

#network_sid ⇒ String

Returns SID of the Network resource the usage occurred on. Value will only be present when either a value for the ‘Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`.

Returns:

  • (String) —

    SID of the Network resource the usage occurred on. Value will only be present when either a value for the ‘Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`.



245
246
247
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 245

def network_sid
    @properties['network_sid']
end

#period ⇒ Hash

Returns The time period for which the usage is reported. The period is represented as a pair of ‘start_time` and `end_time` timestamps specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:

  • (Hash) —

    The time period for which the usage is reported. The period is represented as a pair of ‘start_time` and `end_time` timestamps specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.



263
264
265
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 263

def period
    @properties['period']
end

#sim_sid ⇒ String

Returns SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the ‘Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`.

Returns:

  • (String) —

    SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the ‘Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`.



239
240
241
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 239

def sim_sid
    @properties['sim_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



299
300
301
 
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 299

def to_s
    "<Twilio.Supersim.V1.UsageRecordInstance>"
end