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.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 138

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) 


184
185
186
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 184

def 
    @properties['account_sid']
end

#commands_costs ⇒ Hash

Returns:

  • (Hash) 


202
203
204
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 202

def commands_costs
    @properties['commands_costs']
end

#commands_usage ⇒ Hash

Returns:

  • (Hash) 


196
197
198
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 196

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:



163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 163

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

#data_costs ⇒ Hash

Returns:

  • (Hash) 


214
215
216
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 214

def data_costs
    @properties['data_costs']
end

#data_usage ⇒ Hash

Returns:

  • (Hash) 


208
209
210
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 208

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:



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 229

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



249
250
251
252
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 249

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

#period ⇒ Hash

Returns:

  • (Hash) 


190
191
192
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 190

def period
    @properties['period']
end

#sim_sid ⇒ String

Returns:

  • (String) 


172
173
174
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 172

def sim_sid
    @properties['sim_sid']
end

#sim_unique_name ⇒ String

Returns:

  • (String) 


178
179
180
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 178

def sim_unique_name
    @properties['sim_unique_name']
end

#to_s ⇒ Object

Provide a user friendly representation



242
243
244
245
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 242

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

#url ⇒ String

Returns:

  • (String) 


220
221
222
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 220

def url
    @properties['url']
end