Class: Twilio::REST::Voice::V1::SourceIpMappingInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SourceIpMappingInstance

Initialize the SourceIpMappingInstance

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

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

    The SID of the Call resource to fetch.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 259

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'ip_record_sid' => payload['ip_record_sid'],
        'sip_domain_sid' => payload['sip_domain_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#context ⇒ SourceIpMappingContext

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

Returns:



281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 281

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 308

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



314
315
316
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 314

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SourceIpMappingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



327
328
329
330
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 327

def delete

    context.delete
end

#fetch ⇒ SourceIpMappingInstance

Fetch the SourceIpMappingInstance

Returns:



335
336
337
338
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 335

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



362
363
364
365
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 362

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

#ip_record_sid ⇒ String

Returns The Twilio-provided string that uniquely identifies the IP Record resource to map from.

Returns:

  • (String) —

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



296
297
298
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 296

def ip_record_sid
    @properties['ip_record_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the IP Record resource.

Returns:

  • (String) —

    The unique string that we created to identify the IP Record resource.



290
291
292
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 290

def sid
    @properties['sid']
end

#sip_domain_sid ⇒ String

Returns The SID of the SIP Domain that the IP Record is mapped to.

Returns:

  • (String) —

    The SID of the SIP Domain that the IP Record is mapped to.



302
303
304
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 302

def sip_domain_sid
    @properties['sip_domain_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



355
356
357
358
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 355

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

#update(sip_domain_sid: nil) ⇒ SourceIpMappingInstance

Update the SourceIpMappingInstance

Parameters:

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

    The SID of the SIP Domain that the IP Record should be mapped to.

Returns:



344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 344

def update(
    sip_domain_sid: nil
)

    context.update(
        sip_domain_sid: sip_domain_sid, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



320
321
322
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 320

def url
    @properties['url']
end