Class: Telnyx::Fax

Inherits:

APIResource

• Object
• TelnyxObject
• APIResource
• Telnyx::Fax

Extended by:

APIOperations::Create, APIOperations::List, APIOperations::NestedResource

Includes:

APIOperations::Delete, APIOperations::Save

Defined in:

lib/telnyx/fax.rb

Constant Summary

ACTIONS =

%w[refresh cancel].freeze

OBJECT_NAME =

"fax".freeze

RESOURCE_PATH =

"faxes".freeze

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Class Method Summary

• .retrieve(id, opts = {}) ⇒ Object

Methods included from APIOperations::List

list

Methods included from APIOperations::Create

create

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

#delete

Methods inherited from APIResource

class_name, identified_resource_url, inherited, #refresh, resource_url, #resource_url, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from TelnyxObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Telnyx::TelnyxObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Telnyx::TelnyxObject

Class Method Details

.retrieve(id, opts = {}) ⇒ Object

# File 'lib/telnyx/fax.rb', line 21

def self.retrieve(id, opts = {})
  id, retrieve_params = Util.normalize_id(id)
  resp, opts = request(:get, "#{resource_url}/#{CGI.escape(id)}", retrieve_params, opts)
  Util.convert_to_telnyx_object(resp.data, opts)
end