Class: Phaxio::Resources::PortNumber

Inherits:

Phaxio::Resource

• Object
• Phaxio::Resource
• Phaxio::Resources::PortNumber

Defined in:

lib/phaxio/resources/port_number.rb

Overview

Provides functionality for viewing port numbers.

Instance Attribute Summary

• #id ⇒ Integer

  The ID associated with this number.

• #port_number ⇒ String

  The E.164 number.

• #status ⇒ String

  The status of this number.

Class Method Summary

• .get(id, params = {}) ⇒ Phaxio::Resource::PortNumber (also: retrieve, find)

  Get port number info.

Methods inherited from Phaxio::Resource

response_collection, response_record

Instance Attribute Details

#id ⇒ Integer

Returns the ID associated with this number.

Returns:

• (Integer) —

  the ID associated with this number.

# File 'lib/phaxio/resources/port_number.rb', line 8

#port_number ⇒ String

Returns the E.164 number.

Returns:

• (String) —

  the E.164 number.

# File 'lib/phaxio/resources/port_number.rb', line 11

#status ⇒ String

Returns the status of this number.

Returns:

• (String) —

  the status of this number.

# File 'lib/phaxio/resources/port_number.rb', line 17

has_normal_attributes %w(id port_number status)

Class Method Details

.get(id, params = {}) ⇒ Phaxio::Resource::PortNumber Also known as: retrieve, find

Get port number info.

Parameters:

• id (Integer) —

  The ID of the number to retrieve.

• params (Hash) (defaults to: {}) —

  A hash of parameters to send to Phaxio. This action takes no unique parameters.

Returns:

• (Phaxio::Resource::PortNumber)

Raises:

• (Phaxio::Error::PhaxioError)

See Also:

• https://www.phaxio.com/docs/api/v2/port_numbers/get_port_number

# File 'lib/phaxio/resources/port_number.rb', line 27

def get id, params = {}
  response = Client.request :get, port_number_endpoint(id.to_i), params
  response_record response
end