Class: Phaxio::Resources::FaxRecipient

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Phaxio::Resource

response_collection, response_record

Instance Attribute Details

#bitrate ⇒ Integer

Returns The bitrate in bits/second that the fax was transmitted at.

Returns:

  • (Integer) —

    The bitrate in bits/second that the fax was transmitted at.




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

#completed_at ⇒ Time

Returns The time the job was completed for this recipient.

Returns:

  • (Time) —

    The time the job was completed for this recipient.



38
 
# File 'lib/phaxio/resources/fax_recipient.rb', line 38

has_time_attributes %w[completed_at]

#error_id ⇒ Integer

Returns A numeric error code that corresponds to the error message, if any.

Returns:

  • (Integer) —

    A numeric error code that corresponds to the error message, if any.



31
32
33
 
# File 'lib/phaxio/resources/fax_recipient.rb', line 31

has_normal_attributes %w[
  phone_number status retry_count bitrate resolution error_type error_message error_id
]

#error_message ⇒ String

Returns A more detailed description of what went wrong for this receipient.

Returns:

  • (String) —

    A more detailed description of what went wrong for this receipient.




# File 'lib/phaxio/resources/fax_recipient.rb', line 25

#error_type ⇒ String

Returns One of the Phaxio Error types. Will give you a general idea of what went wrong for this recipient.

Returns:

  • (String) —

    One of the Phaxio Error types. Will give you a general idea of what went wrong for this recipient.




# File 'lib/phaxio/resources/fax_recipient.rb', line 20

#phone_number ⇒ String

Returns The phone number of the recipient in E.164 format.

Returns:

  • (String) —

    The phone number of the recipient in E.164 format.




# File 'lib/phaxio/resources/fax_recipient.rb', line 4

#resolution ⇒ Integer

Returns The horizontal resolution that the fax was transmitted at in pixels per meter.

Returns:

  • (Integer) —

    The horizontal resolution that the fax was transmitted at in pixels per meter.




# File 'lib/phaxio/resources/fax_recipient.rb', line 16

#retry_count ⇒ Integer

Returns The number of retries for this recipient.

Returns:

  • (Integer) —

    The number of retries for this recipient.




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

#status ⇒ String

Returns The status of the recipient.

Returns:

  • (String) —

    The status of the recipient.




# File 'lib/phaxio/resources/fax_recipient.rb', line 7