Class: Twilio::REST::Preview::Wireless::SimContext::UsageInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UsageInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 286

def initialize(version, payload , sim_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sim_sid' => payload['sim_sid'],
        'sim_unique_name' => payload['sim_unique_name'],
        'account_sid' => payload['account_sid'],
        'period' => payload['period'],
        'commands_usage' => payload['commands_usage'],
        'commands_costs' => payload['commands_costs'],
        'data_usage' => payload['data_usage'],
        'data_costs' => payload['data_costs'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sim_sid' => sim_sid  || @properties['sim_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


333
334
335
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 333

def 
    @properties['account_sid']
end

#commands_costs ⇒ Hash

Returns:

  • (Hash) 


351
352
353
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 351

def commands_costs
    @properties['commands_costs']
end

#commands_usage ⇒ Hash

Returns:

  • (Hash) 


345
346
347
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 345

def commands_usage
    @properties['commands_usage']
end

#context ⇒ UsageContext

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

Returns:



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 312

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

#data_costs ⇒ Hash

Returns:

  • (Hash) 


363
364
365
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 363

def data_costs
    @properties['data_costs']
end

#data_usage ⇒ Hash

Returns:

  • (Hash) 


357
358
359
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 357

def data_usage
    @properties['data_usage']
end

#fetch(end_: :unset, start: :unset) ⇒ UsageInstance

Fetch the UsageInstance

Parameters:

  • end_ (String) (defaults to: :unset)
  • start (String) (defaults to: :unset)

Returns:



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 378

def fetch(
    end_: :unset, 
    start: :unset
)

    context.fetch(
        end_: end_, 
        start: start, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 398

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

#period ⇒ Hash

Returns:

  • (Hash) 


339
340
341
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 339

def period
    @properties['period']
end

#sim_sid ⇒ String

Returns:

  • (String) 


321
322
323
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 321

def sim_sid
    @properties['sim_sid']
end

#sim_unique_name ⇒ String

Returns:

  • (String) 


327
328
329
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 327

def sim_unique_name
    @properties['sim_unique_name']
end

#to_s ⇒ Object

Provide a user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 391

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

#url ⇒ String

Returns:

  • (String) 


369
370
371
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 369

def url
    @properties['url']
end