Class: Phaxio::Resources::PortNumberNote

Inherits:
Phaxio::Resource show all
Defined in:
lib/phaxio/resources/port_number_note.rb

Overview

Provides functionality for viewing port number notes.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Phaxio::Resource

response_collection, response_record

Instance Attribute Details

#author ⇒ String

Returns the author of this note.

Returns:

  • (String) —

    the author of this note.




# File 'lib/phaxio/resources/port_number_note.rb', line 13

#created_at ⇒ Time

Returns the time this note was created.

Returns:

  • (Time) —

    the time this note was created.




# File 'lib/phaxio/resources/port_number_note.rb', line 21

#id ⇒ Integer

Returns the ID associated with this note.

Returns:

  • (Integer) —

    the ID associated with this note.




# File 'lib/phaxio/resources/port_number_note.rb', line 10

#note ⇒ String

Returns the content of the note.

Returns:

  • (String) —

    the content of the note



19
 
# File 'lib/phaxio/resources/port_number_note.rb', line 19

has_normal_attributes %w[id note author]

#updated_at ⇒ Time

Returns the time this note was updated.

Returns:

  • (Time) —

    the time this note was updated.



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

has_time_attributes %w[created_at updated_at]

Class Method Details

.list(port_number_id, params = {}) ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PortNumberNote>

List notes for a port number.

Parameters:

  • port_number_id (Integer) —

    The ID of the port number to list notes for.

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

    Any parameters to send to Phaxio. This action takes no unique parameters.

Returns:

Raises:

See Also:



38
39
40
41
 
# File 'lib/phaxio/resources/port_number_note.rb', line 38

def list port_number_id, params = {}
  response = Client.request :get, port_number_notes_endpoint(port_number_id.to_i), params
  response_collection response
end