Freeside:1.9:Documentation:Developer/FS
Contents
NAME
FS - Freeside Perl modules
SYNOPSIS
Freeside perl modules and CLI utilities.
Utility classes
FS::Conf - Freeside configuration values
FS::ConfItem - Freeside configuration option meta-data.
FS::UID - User class (not yet OO)
FS::CGI - Non OO-subroutines for the web interface.
FS::Msgcat - Message catalog
FS::SearchCache - Search cache
FS::raddb - RADIUS dictionary
Database record classes
FS::Record - Database record base class
FS::svc_acct_pop - POP (Point of Presence, not Post Office Protocol) class
FS::part_pop_local - Local calling area class
FS::part_referral - Referral class
FS::cust_main_county - Locale (tax rate) class
FS::cust_tax_exempt - Tax exemption record class
FS::svc_Common - Service base class
FS::svc_acct - Account (shell, RADIUS, POP3) class
FS::acct_snarf - External mail account class
FS::radius_usergroup - RADIUS groups
FS::svc_domain - Domain class
FS::domain_record - DNS zone entries
FS::svc_forward - Mail forwarding class
FS::svc_www - Web virtual host class.
FS::svc_broadband - DSL, wireless and other broadband class.
FS::svc_external - Externally tracked service class.
FS::part_svc - Service definition class
FS::part_svc_column - Column constraint class
FS::export_svc - Class linking service definitions (see FS::part_svc) with exports (see FS::part_export)
FS::part_export - External provisioning export class
FS::part_export_option - Export option class
FS::part_pkg - Package definition class
FS::part_pkg_option - Package definition option class
FS::pkg_svc - Class linking package definitions (see FS::part_pkg) with service definitions (see FS::part_svc)
FS::reg_code - One-time registration codes
FS::reg_code_pkg - Class linking registration codes (see FS::reg_code) with package definitions (see FS::part_pkg)
FS::rate - Rate plans for call billing
FS::rate_region - Rate regions for call billing
FS::rate_prefix - Rate region prefixes for call billing
FS::rate_detail - Rate plan detail for call billing
FS::agent - Agent (reseller) class
FS::agent_type - Agent type class
FS::type_pkgs - Class linking agent types (see FS::agent_type) with package definitions (see FS::part_pkg)
FS::cust_svc - Service class
FS::cust_pkg - Customer package class
FS::cust_pkg_option - Customer package option class
FS::cust_main - Customer class
FS::cust_main_invoice - Invoice destination class
FS::cust_bill - Invoice class
FS::cust_bill_pkg - Invoice line item class
FS::cust_bill_pkg_detail - Invoice line item detail class
FS::part_bill_event - Invoice event definition class
FS::cust_bill_event - Completed invoice event class
FS::cust_pay - Payment class
FS::cust_pay_void - Voided payment class
FS::cust_bill_pay - Payment application class
FS::cust_credit - Credit class
FS::cust_refund - Refund class
FS::cust_credit_refund - Refund application to credit class
FS::cust_credit_bill - Credit application to invoice class
FS::cust_pay_refund - Refund application to payment class
FS::pay_batch - Credit card transaction queue class
FS::cust_pay_batch - Credit card transaction member queue class
FS::prepay_credit - Prepaid "calling card" credit class.
FS::nas - Network Access Server class
FS::port - NAS port class
FS::session - User login session class
FS::queue - Job queue
FS::queue_arg - Job arguments
FS::queue_depend - Job dependencies
FS::msgcat - Message catalogs
Client API
Remote API modules
FS::MailAdminServer (deprecated in favor of the self-service server)
Command-line utilities
User Interface classes
FS::UI::Web - Web user-interface class
Notes
To quote perl(1), "If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references."
If you've never used OO modules before, http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
DESCRIPTION
Freeside is a billing and administration package for Internet Service Providers.
The Freeside home page is at <http://www.sisd.com/freeside>.
The main documentation is in httemplate/docs.
SUPPORT
A mailing list for users is available. Send a blank message to <freeside-users-subscribe@sisd.com> to subscribe.
A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <freeside-devel-subscribe@sisd.com> to subscribe.
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
AUTHOR
Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
SEE ALSO
perl(1), main Freeside documentation in htdocs/docs/
BUGS
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...
