Class: Twilio::REST::Wireless::V1::UsageRecordInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/wireless/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.



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 181

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'period' => payload['period'],
        'commands' => payload['commands'],
        'data' => payload['data'],
    }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



196
197
198
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 196

def 
    @properties['account_sid']
end

#commands ⇒ Hash

Returns An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#commands-usage-object).

Returns:



208
209
210
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 208

def commands
    @properties['commands']
end

#data ⇒ Hash

Returns An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#data-usage-object).

Returns:



214
215
216
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 214

def data
    @properties['data']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



226
227
228
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 226

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

#period ⇒ Hash

Returns The time period for which usage is reported. Contains ‘start` and `end` properties that describe the period using GMT date-time values specified in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

Returns:



202
203
204
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 202

def period
    @properties['period']
end

#to_s ⇒ Object

Provide a user friendly representation



220
221
222
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 220

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