Class: Twilio::REST::Voice::V1::IpRecordInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the IpRecordInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

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


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 230

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'sid' => payload['sid'],
      'friendly_name' => payload['friendly_name'],
      'ip_address' => payload['ip_address'],
      'cidr_prefix_length' => payload['cidr_prefix_length'].to_i,
      '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

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


263
264
265
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 263

def 
  @properties['account_sid']
end

#cidr_prefix_lengthString

Returns An integer representing the length of the CIDR prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.

Returns:

  • (String)

    An integer representing the length of the CIDR prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.


287
288
289
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 287

def cidr_prefix_length
  @properties['cidr_prefix_length']
end

#contextIpRecordContext

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

Returns:


254
255
256
257
258
259
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 254

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

#date_createdTime

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was created


293
294
295
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 293

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was last updated


299
300
301
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 299

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the IpRecordInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchIpRecordInstance

Fetch the IpRecordInstance

Returns:


312
313
314
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 312

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


275
276
277
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 275

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


341
342
343
344
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 341

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

#ip_addressString

Returns An IP address in dotted decimal notation, IPv4 only.

Returns:

  • (String)

    An IP address in dotted decimal notation, IPv4 only.


281
282
283
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 281

def ip_address
  @properties['ip_address']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


269
270
271
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 269

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Voice.V1.IpRecordInstance #{values}>"
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:


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

def update(friendly_name: :unset)
  context.update(friendly_name: friendly_name, )
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


305
306
307
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 305

def url
  @properties['url']
end