Class: Twilio::REST::Voice::V1::IpRecordContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/voice/v1/ip_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ IpRecordContext

Initialize the IpRecordContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The Twilio-provided string that uniquely identifies the IP Record resource to update.



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 227

def initialize(version, sid)
    super(version)
    

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the IpRecordInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 240

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the IpRecordInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 253

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      ipRecord_instance = IpRecordInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      IpRecordInstanceMetadata.new(@version, ipRecord_instance, response.headers, response.status_code)
end

#fetch ⇒ IpRecordInstance

Fetch the IpRecordInstance

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 272

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    IpRecordInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ IpRecordInstance

Fetch the IpRecordInstanceMetadata

Returns:



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 291

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    ip_record_instance = IpRecordInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    IpRecordInstanceMetadata.new(
        @version,
        ip_record_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 381

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

#to_s ⇒ Object

Provide a user friendly representation



374
375
376
377
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 374

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

#update(friendly_name: :unset) ⇒ IpRecordInstance

Update the IpRecordInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 317

def update(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    IpRecordInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: :unset) ⇒ IpRecordInstance

Update the IpRecordInstanceMetadata

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 343

def update_with_metadata(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    ip_record_instance = IpRecordInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    IpRecordInstanceMetadata.new(
        @version,
        ip_record_instance,
        response.headers,
        response.status_code
    )
end