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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/preview/wireless/sim.rb,
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].

Defined Under Namespace

Classes: UsageContext, UsageInstance, UsageList, UsagePage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ SimContext

Initialize the SimContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)


164
165
166
167
168
169
170
171
172
173
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 164

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Sims/#{@solution[:sid]}"

    # Dependents
    @usage = nil
end

Instance Method Details

#fetchSimInstance

Fetch the SimInstance

Returns:



177
178
179
180
181
182
183
184
185
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 177

def fetch

    payload = @version.fetch('GET', @uri)
    SimInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspectObject

Provide a detailed, user friendly representation



272
273
274
275
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 272

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Wireless.SimContext #{context}>"
end

#to_sObject

Provide a user friendly representation



265
266
267
268
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 265

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Wireless.SimContext #{context}>"
end

#update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset) ⇒ SimInstance

Update the SimInstance

Parameters:

  • unique_name (String) (defaults to: :unset)
  • callback_method (String) (defaults to: :unset)
  • callback_url (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • rate_plan (String) (defaults to: :unset)
  • status (String) (defaults to: :unset)
  • commands_callback_method (String) (defaults to: :unset)
  • commands_callback_url (String) (defaults to: :unset)
  • sms_fallback_method (String) (defaults to: :unset)
  • sms_fallback_url (String) (defaults to: :unset)
  • sms_method (String) (defaults to: :unset)
  • sms_url (String) (defaults to: :unset)
  • voice_fallback_method (String) (defaults to: :unset)
  • voice_fallback_url (String) (defaults to: :unset)
  • voice_method (String) (defaults to: :unset)
  • voice_url (String) (defaults to: :unset)

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 206

def update(
    unique_name: :unset, 
    callback_method: :unset, 
    callback_url: :unset, 
    friendly_name: :unset, 
    rate_plan: :unset, 
    status: :unset, 
    commands_callback_method: :unset, 
    commands_callback_url: :unset, 
    sms_fallback_method: :unset, 
    sms_fallback_url: :unset, 
    sms_method: :unset, 
    sms_url: :unset, 
    voice_fallback_method: :unset, 
    voice_fallback_url: :unset, 
    voice_method: :unset, 
    voice_url: :unset
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'CallbackMethod' => callback_method,
        'CallbackUrl' => callback_url,
        'FriendlyName' => friendly_name,
        'RatePlan' => rate_plan,
        'Status' => status,
        'CommandsCallbackMethod' => commands_callback_method,
        'CommandsCallbackUrl' => commands_callback_url,
        'SmsFallbackMethod' => sms_fallback_method,
        'SmsFallbackUrl' => sms_fallback_url,
        'SmsMethod' => sms_method,
        'SmsUrl' => sms_url,
        'VoiceFallbackMethod' => voice_fallback_method,
        'VoiceFallbackUrl' => voice_fallback_url,
        'VoiceMethod' => voice_method,
        'VoiceUrl' => voice_url,
    })

    payload = @version.update('POST', @uri, data: data)
    SimInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#usageUsageList, UsageContext

Access the usage

Returns:



256
257
258
259
260
261
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 256

def usage
    UsageContext.new(
            @version,
            @solution[:sid]
            )
end