Faxage

gem 'faxage'

class LoginError < StandardError
  # "One or more of username, company, password is incorrect or your account is disabled for some reason."
end

class FaxageInternalError < StandardError
  # "Internal FAXAGE error."
end

class UnknownOperationError < StandardError
  # "Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes. #{response.parsed_response}"
end

class NoResponseError < StandardError
  # "An empty response was returned from Faxage."
end

class InvalidJobIdError < StandardError
  # "Internal FAXAGE error – the job was not properly inserted into our database."
end

class InvalidFaxNoError < StandardError
  # "The faxno variable does not contain a 10-digit numeric only string."
end

class NoFilesError < StandardError
  # "No valid files were found in faxfilenames[] and/or faxfiledata[]."
end

class BlockedNumberError < StandardError
  # "The number you tried to fax to was blocked (outside of continental US, Canada and Hawaii or a 555, 911, or other invalid/blocked type of number)."
end

class NoIncomingFaxesError < StandardError
  # "There are no incoming faxes to list for you."
end

class FaxIdNotFoundError < StandardError
  # The faxid passed in is invalid or is an ID that does not belong to your company.
end

Faxage::SendFax.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
  recipname: # Recipient Name – 32 characters max
  faxno: # Fax Number – 10 digits, numeric only
  faxfilenames: # Array of file names. These must end in a
  # supported extension – see the table above for a list
  faxfiledata: # Corresponding array of base64-encoded strings that are the
  # contents/data of the file in faxfilenames. E.g.: if faxfilenames[0] is
  # test.doc, then faxfiledata[0] should be the base64-encoded contents
  # of test.doc
  debug: # A debugging URL is also provided that is equivalent to
  # the httpsfax.php URL, except that
  # it also returns the contents of your POST:
  # Note that the debugging URL is still live and identical to the
  # regular/production URL.
  # For example, if you send a fax using the sendfax operation with
  # the debugging URL, the fax will still get sent as normal.
).sendfax()

# Practical example of faxing a template from your Rails app:
# html = ActionController::Base.new().render_to_string(template: 'path-to-your-template')
# encoded_file_data = Base64.encode64(html)

Faxage::SendFax.new(
  username: "your-username", # string
  company: "your-faxage-company-id", # string
  password: "your-faxage-password", # string
  recipname: "ABC company", #string
  faxno: "5555555555", # string (no hyphens, parenthesis, or spaces)
  faxfilenames: ['my-file.html'],
  faxfiledata: [encoded_file_data],
  debug: false
).sendfax()

# Expected response:

# {
#   job_id: 543211
# }

Faxage::ReceiveFax.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).listfax()

Faxage::ReceiveFax.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).getfax(recvid:) # The numeric ID of the fax to get, retrieved from the listfax operation (the recvid in listfax)

# The actual data returned will be the binary contents of the fax itself.

# A practical example of uploading the file to AWS S3 in a Rails application could look like:

get_fax = Faxage::ReceiveFax.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).getfax(recvid:)

creds = Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
s3_resource = Aws::S3::Resource.new(region: ENV['AWS_S3_REGION'], credentials: creds)
obj = s3_resource.bucket(ENV['AWS_BUCKET_NAME']).object("path-to-your-file-on-S3/your-file-name.pdf")
obj.put(body: get_fax)

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).handlecount

# Example response:
# {
#   total_count: 10,
#   handled_count: 5
# }

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).pendcount

# Example response:
# {
#   pending_count: 10
# }

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).qstatus

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).incomingcalls

# Example response:
# {
#   incoming_count: 0,
#   allocated_count: 1
# }

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).busycalls

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).portstatus

Faxage::InformationGathering.new(
  username: # Assigned FAXAGE username
  company: # Assigned FAXAGE company credential
  password: # Assigned FAXAGE password
).auditlog