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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

  • sim_sid (String) (defaults to: nil) —

    The sim_sid



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 124

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, }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#commands_costs ⇒ Hash

Returns The commands_costs.

Returns:

  • (Hash) —

    The commands_costs



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

def commands_costs
  @properties['commands_costs']
end

#commands_usage ⇒ Hash

Returns The commands_usage.

Returns:

  • (Hash) —

    The commands_usage



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

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:



149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 149

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

#data_costs ⇒ Hash

Returns The data_costs.

Returns:

  • (Hash) —

    The data_costs



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

def data_costs
  @properties['data_costs']
end

#data_usage ⇒ Hash

Returns The data_usage.

Returns:

  • (Hash) —

    The data_usage



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

def data_usage
  @properties['data_usage']
end

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

Fetch a UsageInstance

Parameters:

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

    The end

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

    The start

Returns:



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



228
229
230
231
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 228

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

#period ⇒ Hash

Returns The period.

Returns:

  • (Hash) —

    The period



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

def period
  @properties['period']
end

#sim_sid ⇒ String

Returns The sim_sid.

Returns:

  • (String) —

    The sim_sid



158
159
160
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim/usage.rb', line 158

def sim_sid
  @properties['sim_sid']
end

#sim_unique_name ⇒ String

Returns The sim_unique_name.

Returns:

  • (String) —

    The sim_unique_name



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

def sim_unique_name
  @properties['sim_unique_name']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end