Difference between revisions of "Freeside:1.9:Documentation:Developer/FS"

From Freeside
Jump to: navigation, search
(import from POD)
(import from POD)
Line 6: Line 6:
  
 
===Utility classes===
 
===Utility classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/Schema|FS::Schema]] - Freeside database schema
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Setup|FS::Setup]] - Setup subroutines
 +
 
[[Freeside:1.9:Documentation:Developer/FS/Conf|FS::Conf]] - Freeside configuration values
 
[[Freeside:1.9:Documentation:Developer/FS/Conf|FS::Conf]] - Freeside configuration values
  
 
[[Freeside:1.9:Documentation:Developer/FS/ConfItem|FS::ConfItem]] - Freeside configuration option meta-data.
 
[[Freeside:1.9:Documentation:Developer/FS/ConfItem|FS::ConfItem]] - Freeside configuration option meta-data.
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/ConfDefaults|FS::ConfDefaults]] - Freeside configuration default and available values
  
 
[[Freeside:1.9:Documentation:Developer/FS/UID|FS::UID]] - User class (not yet OO)
 
[[Freeside:1.9:Documentation:Developer/FS/UID|FS::UID]] - User class (not yet OO)
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/CurrentUser|FS::CurrentUser]] - Package representing the current user
  
 
[[Freeside:1.9:Documentation:Developer/FS/CGI|FS::CGI]] - Non OO-subroutines for the web interface.
 
[[Freeside:1.9:Documentation:Developer/FS/CGI|FS::CGI]] - Non OO-subroutines for the web interface.
Line 19: Line 27:
  
 
[[Freeside:1.9:Documentation:Developer/FS/raddb|FS::raddb]] - RADIUS dictionary
 
[[Freeside:1.9:Documentation:Developer/FS/raddb|FS::raddb]] - RADIUS dictionary
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/AccessRight|FS::AccessRight]] - Access control rights.
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Report|FS::Report]] - Report data objects
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Report/Table|FS::Report::Table]] - Report data objects
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Report/Monthly|FS::Report::Monthly]] - Report data objects
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/XMLRPC|FS::XMLRPC]] - Backend XML::RPC server
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Misc|FS::Misc]] - Miscellaneous subroutines
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/payby|FS::payby]] - Payment types
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/Pony|FS::Pony]] - A pony
  
 
===Database record classes===
 
===Database record classes===
 
[[Freeside:1.9:Documentation:Developer/FS/Record|FS::Record]] - Database record base class
 
[[Freeside:1.9:Documentation:Developer/FS/Record|FS::Record]] - Database record base class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/m2m Common|FS::m2m_Common]] - Mixin class for classes in a many-to-many relationship
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/m2name Common|FS::m2name_Common]] - Base class for tables with a related table listing names
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/option Common|FS::option_Common]] - Base class for option sub-classes
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/conf|FS::conf]] - Configuration value class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/payinfo Mixin|FS::payinfo_Mixin]] - Mixin class for records in tables that contain payinfo.
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access user|FS::access_user]] - Employees / internal users
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access user pref|FS::access_user_pref]] - Employee preferences
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access group|FS::access_group]] - Employee groups
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access usergroup|FS::access_usergroup]] - Employee group membership
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access groupagent|FS::access_groupagent]] - Group reseller access
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/access right|FS::access_right]] - Access rights
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc acct pop|FS::svc_acct_pop]] - POP (Point of Presence, not Post Office Protocol) class
 
[[Freeside:1.9:Documentation:Developer/FS/svc acct pop|FS::svc_acct_pop]] - POP (Point of Presence, not Post Office Protocol) class
Line 28: Line 74:
  
 
[[Freeside:1.9:Documentation:Developer/FS/part referral|FS::part_referral]] - Referral class
 
[[Freeside:1.9:Documentation:Developer/FS/part referral|FS::part_referral]] - Referral class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/pkg referral|FS::pkg_referral]] - Package referral class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust main county|FS::cust_main_county]] - Locale (tax rate) class
 
[[Freeside:1.9:Documentation:Developer/FS/cust main county|FS::cust_main_county]] - Locale (tax rate) class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust tax exempt|FS::cust_tax_exempt]] - Tax exemption record class
 
[[Freeside:1.9:Documentation:Developer/FS/cust tax exempt|FS::cust_tax_exempt]] - Tax exemption record class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust tax exempt pkg|FS::cust_tax_exempt_pkg]] - Line-item specific tax exemption record class
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc Common|FS::svc_Common]] - Service base class
 
[[Freeside:1.9:Documentation:Developer/FS/svc Common|FS::svc_Common]] - Service base class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/svc Parent Mixin|FS::svc_Parent_Mixin]] - Mixin class for svc_ classes with a parent_svcnum field
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc acct|FS::svc_acct]] - Account (shell, RADIUS, POP3) class
 
[[Freeside:1.9:Documentation:Developer/FS/svc acct|FS::svc_acct]] - Account (shell, RADIUS, POP3) class
  
 
[[Freeside:1.9:Documentation:Developer/FS/acct snarf|FS::acct_snarf]] - External mail account class
 
[[Freeside:1.9:Documentation:Developer/FS/acct snarf|FS::acct_snarf]] - External mail account class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/acct rt transaction|FS::acct_rt_transaction]] - Time worked application to account class
  
 
[[Freeside:1.9:Documentation:Developer/FS/radius usergroup|FS::radius_usergroup]] - RADIUS groups
 
[[Freeside:1.9:Documentation:Developer/FS/radius usergroup|FS::radius_usergroup]] - RADIUS groups
Line 44: Line 98:
  
 
[[Freeside:1.9:Documentation:Developer/FS/domain record|FS::domain_record]] - DNS zone entries
 
[[Freeside:1.9:Documentation:Developer/FS/domain record|FS::domain_record]] - DNS zone entries
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/registrar|FS::registrar]] - Domain registrar class
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc forward|FS::svc_forward]] - Mail forwarding class
 
[[Freeside:1.9:Documentation:Developer/FS/svc forward|FS::svc_forward]] - Mail forwarding class
Line 50: Line 106:
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc broadband|FS::svc_broadband]] - DSL, wireless and other broadband class.
 
[[Freeside:1.9:Documentation:Developer/FS/svc broadband|FS::svc_broadband]] - DSL, wireless and other broadband class.
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/addr block|FS::addr_block]] - Address block class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/router|FS::router]] - Router class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/part virtual field|FS::part_virtual_field]] - Broadband virtual field class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/svc phone|FS::svc_phone]] - Phone service class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cdr|FS::cdr]] - Call Detail Record class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cdr calltype|FS::cdr_calltype]] - CDR calltype class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cdr carrier|FS::cdr_carrier]] - CDR carrier class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cdr upstream rate|FS::cdr_upstream_rate]] - CDR upstream rate class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cdr type|FS::cdr_type]] - CDR type class
  
 
[[Freeside:1.9:Documentation:Developer/FS/svc external|FS::svc_external]] - Externally tracked service class.
 
[[Freeside:1.9:Documentation:Developer/FS/svc external|FS::svc_external]] - Externally tracked service class.
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/inventory class|FS::inventory_class]] - Inventory classes
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/inventory item|FS::inventory_item]] - Inventory items
  
 
[[Freeside:1.9:Documentation:Developer/FS/part svc|FS::part_svc]] - Service definition class
 
[[Freeside:1.9:Documentation:Developer/FS/part svc|FS::part_svc]] - Service definition class
Line 62: Line 140:
  
 
[[Freeside:1.9:Documentation:Developer/FS/part export option|FS::part_export_option]] - Export option class
 
[[Freeside:1.9:Documentation:Developer/FS/part export option|FS::part_export_option]] - Export option class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/pkg class|FS::pkg_class]] - Package class class
  
 
[[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]] - Package definition class
 
[[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]] - Package definition class
Line 86: Line 166:
  
 
[[Freeside:1.9:Documentation:Developer/FS/type pkgs|FS::type_pkgs]] - Class linking agent types (see [[Freeside:1.9:Documentation:Developer/FS/agent type|FS::agent_type]]) with package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]])
 
[[Freeside:1.9:Documentation:Developer/FS/type pkgs|FS::type_pkgs]] - Class linking agent types (see [[Freeside:1.9:Documentation:Developer/FS/agent type|FS::agent_type]]) with package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]])
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/payment gateway|FS::payment_gateway]] - Payment gateway class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/payment gateway option|FS::payment_gateway_option]] - Payment gateway option class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/agent payment gateway|FS::agent_payment_gateway]] - Agent payment gateway class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust svc|FS::cust_svc]] - Service class
 
[[Freeside:1.9:Documentation:Developer/FS/cust svc|FS::cust_svc]] - Service class
Line 92: Line 178:
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust pkg option|FS::cust_pkg_option]] - Customer package option class
 
[[Freeside:1.9:Documentation:Developer/FS/cust pkg option|FS::cust_pkg_option]] - Customer package option class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/reason type|FS::reason_type]] - Reason type class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/reason|FS::reason]] - Reason class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pkg reason|FS::cust_pkg_reason]] - Package reason class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust main|FS::cust_main]] - Customer class
 
[[Freeside:1.9:Documentation:Developer/FS/cust main|FS::cust_main]] - Customer class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust main Mixin|FS::cust_main_Mixin]] - Mixin class for records that contain fields from cust_main
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust main invoice|FS::cust_main_invoice]] - Invoice destination class
 
[[Freeside:1.9:Documentation:Developer/FS/cust main invoice|FS::cust_main_invoice]] - Invoice destination class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust main note|FS::cust_main_note]] - Customer note class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/banned pay|FS::banned_pay]] - Banned payment information class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill|FS::cust_bill]] - Invoice class
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill|FS::cust_bill]] - Invoice class
Line 103: Line 201:
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill pkg detail|FS::cust_bill_pkg_detail]] - Invoice line item detail class
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill pkg detail|FS::cust_bill_pkg_detail]] - Invoice line item detail class
  
[[Freeside:1.9:Documentation:Developer/FS/part bill event|FS::part_bill_event]] - Invoice event definition class
+
[[Freeside:1.9:Documentation:Developer/FS/part bill event|FS::part_bill_event]] - (Old) Invoice event definition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill event|FS::cust_bill_event]] - (Old) Completed invoice event class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event|FS::part_event]] - (New) Billing event definition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event option|FS::part_event_option]] - (New) Billing event option class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event/Condition|FS::part_event::Condition]] - (New) Billing event condition base class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event/Action|FS::part_event::Action]] - (New) Billing event action base class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event condition|FS::part_event_condition]] - (New) Billing event condition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part event condition option|FS::part_event_condition_option]] - (New) Billing event condition option class
  
[[Freeside:1.9:Documentation:Developer/FS/cust bill event|FS::cust_bill_event]] - Completed invoice event class
+
[[Freeside:1.9:Documentation:Developer/FS/part event condition option option|FS::part_event_condition_option_option]] - (New) Billing event condition compound option class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust event|FS::cust_event]] - (New) Customer event class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill ApplicationCommon|FS::cust_bill_ApplicationCommon]] - Base class for bill application classes
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust pay|FS::cust_pay]] - Payment class
 
[[Freeside:1.9:Documentation:Developer/FS/cust pay|FS::cust_pay]] - Payment class
Line 112: Line 228:
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]] - Payment application class
 
[[Freeside:1.9:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]] - Payment application class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill pay pkg|FS::cust_bill_pay_pkg]] - Line-item specific payment application class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill pay batch|FS::cust_bill_pay_batch]] - Batch payment application class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust credit|FS::cust_credit]] - Credit class
 
[[Freeside:1.9:Documentation:Developer/FS/cust credit|FS::cust_credit]] - Credit class
Line 120: Line 240:
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]] - Credit application to invoice class
 
[[Freeside:1.9:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]] - Credit application to invoice class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/cust credit bill pkg|FS::cust_credit_bill_pkg]] - Line-item specific credit application to invoice class
  
 
[[Freeside:1.9:Documentation:Developer/FS/cust pay refund|FS::cust_pay_refund]] - Refund application to payment class
 
[[Freeside:1.9:Documentation:Developer/FS/cust pay refund|FS::cust_pay_refund]] - Refund application to payment class
Line 147: Line 269:
 
[[Freeside:1.9:Documentation:Developer/FS/clientapi session field|FS::clientapi_session_field]]
 
[[Freeside:1.9:Documentation:Developer/FS/clientapi session field|FS::clientapi_session_field]]
  
==Client API==
+
===Historical database record classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/h Common|FS::h_Common]] - History table base class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h cust bill|FS::h_cust_bill]] - Historical record of customer tax changes (old-style)
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h cust svc|FS::h_cust_svc]] - Object method for h_cust_svc objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h cust tax exempt|FS::h_cust_tax_exempt]] - Historical record of customer tax changes (old-style)
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h domain record|FS::h_domain_record]] - Historical DNS entry objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc acct|FS::h_svc_acct]] - Historical account objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc broadband|FS::h_svc_broadband]] - Historical broadband connection objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc domain|FS::h_svc_domain]] - Historical domain objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc external|FS::h_svc_external]] - Historical externally tracked service objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc forward|FS::h_svc_forward]] - Historical mail forwarding alias objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc phone|FS::h_svc_phone]] - Historical phone number objects
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/h svc www|FS::h_svc_www]] - Historical web virtual host objects
 +
 
 +
===Client API===
 
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI|FS::ClientAPI]]
 
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI|FS::ClientAPI]]
  
Line 160: Line 307:
 
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/Agent|FS::ClientAPI::Agent]]
 
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/Agent|FS::ClientAPI::Agent]]
  
==Remote API modules==
+
===Remote API modules===
 
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService]]
 
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService]]
  
Line 168: Line 315:
  
 
[[Freeside:1.9:Documentation:Developer/FS/MailAdminServer|FS::MailAdminServer]] (deprecated in favor of the self-service server)
 
[[Freeside:1.9:Documentation:Developer/FS/MailAdminServer|FS::MailAdminServer]] (deprecated in favor of the self-service server)
 +
 +
===User Interface classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/UI/Web|FS::UI::Web]] - Web user-interface class
 +
 +
[[Freeside:1.9:Documentation:Developer/FS/UI/bytecount|FS::UI::bytecount]] - Byte counter user-interface class
  
 
===Command-line utilities===
 
===Command-line utilities===
Line 192: Line 344:
 
[[Freeside:1.9:Documentation:Developer/freeside-overdue|freeside-overdue]]
 
[[Freeside:1.9:Documentation:Developer/freeside-overdue|freeside-overdue]]
  
===User Interface classes===
+
==Notes==
[[Freeside:1.9:Documentation:Developer/FS/UI/Web|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."
 
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."
  
Line 201: Line 350:
  
 
==DESCRIPTION==
 
==DESCRIPTION==
Freeside is a billing and administration package for Internet Service Providers.
+
Freeside is a billing and administration package for wired and wireless ISPs, VoIP, hosting, service and content providers and other online businesses.
  
 
The Freeside home page is at <http://www.sisd.com/freeside>.
 
The Freeside home page is at <http://www.sisd.com/freeside>.
  
The main documentation is in httemplate/docs.
+
The main documentation is at <http://www.sisd.com/mediawiki>.
  
 
==SUPPORT==
 
==SUPPORT==
Line 214: Line 363:
 
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
 
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
  
==AUTHOR==
+
==AUTHORS==
Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
+
Primarily Ivan Kohler, with help from many kind folks, including core contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
  
 
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
 
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
  
 
==SEE ALSO==
 
==SEE ALSO==
perl(1), main Freeside documentation in htdocs/docs/
+
perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
  
 
==BUGS==
 
==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...
 
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...

Revision as of 17:22, 3 October 2007

NAME

FS - Freeside Perl modules

SYNOPSIS

Freeside perl modules and CLI utilities.

Utility classes

FS::Schema - Freeside database schema

FS::Setup - Setup subroutines

FS::Conf - Freeside configuration values

FS::ConfItem - Freeside configuration option meta-data.

FS::ConfDefaults - Freeside configuration default and available values

FS::UID - User class (not yet OO)

FS::CurrentUser - Package representing the current user

FS::CGI - Non OO-subroutines for the web interface.

FS::Msgcat - Message catalog

FS::SearchCache - Search cache

FS::raddb - RADIUS dictionary

FS::AccessRight - Access control rights.

FS::Report - Report data objects

FS::Report::Table - Report data objects

FS::Report::Monthly - Report data objects

FS::XMLRPC - Backend XML::RPC server

FS::Misc - Miscellaneous subroutines

FS::payby - Payment types

FS::Pony - A pony

Database record classes

FS::Record - Database record base class

FS::m2m_Common - Mixin class for classes in a many-to-many relationship

FS::m2name_Common - Base class for tables with a related table listing names

FS::option_Common - Base class for option sub-classes

FS::conf - Configuration value class

FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.

FS::access_user - Employees / internal users

FS::access_user_pref - Employee preferences

FS::access_group - Employee groups

FS::access_usergroup - Employee group membership

FS::access_groupagent - Group reseller access

FS::access_right - Access rights

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::pkg_referral - Package referral class

FS::cust_main_county - Locale (tax rate) class

FS::cust_tax_exempt - Tax exemption record class

FS::cust_tax_exempt_pkg - Line-item specific tax exemption record class

FS::svc_Common - Service base class

FS::svc_Parent_Mixin - Mixin class for svc_ classes with a parent_svcnum field

FS::svc_acct - Account (shell, RADIUS, POP3) class

FS::acct_snarf - External mail account class

FS::acct_rt_transaction - Time worked application to account class

FS::radius_usergroup - RADIUS groups

FS::svc_domain - Domain class

FS::domain_record - DNS zone entries

FS::registrar - Domain registrar class

FS::svc_forward - Mail forwarding class

FS::svc_www - Web virtual host class.

FS::svc_broadband - DSL, wireless and other broadband class.

FS::addr_block - Address block class

FS::router - Router class

FS::part_virtual_field - Broadband virtual field class

FS::svc_phone - Phone service class

FS::cdr - Call Detail Record class

FS::cdr_calltype - CDR calltype class

FS::cdr_carrier - CDR carrier class

FS::cdr_upstream_rate - CDR upstream rate class

FS::cdr_type - CDR type class

FS::svc_external - Externally tracked service class.

FS::inventory_class - Inventory classes

FS::inventory_item - Inventory items

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::pkg_class - Package class 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::payment_gateway - Payment gateway class

FS::payment_gateway_option - Payment gateway option class

FS::agent_payment_gateway - Agent payment gateway class

FS::cust_svc - Service class

FS::cust_pkg - Customer package class

FS::cust_pkg_option - Customer package option class

FS::reason_type - Reason type class

FS::reason - Reason class

FS::cust_pkg_reason - Package reason class

FS::cust_main - Customer class

FS::cust_main_Mixin - Mixin class for records that contain fields from cust_main

FS::cust_main_invoice - Invoice destination class

FS::cust_main_note - Customer note class

FS::banned_pay - Banned payment information 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 - (Old) Invoice event definition class

FS::cust_bill_event - (Old) Completed invoice event class

FS::part_event - (New) Billing event definition class

FS::part_event_option - (New) Billing event option class

FS::part_event::Condition - (New) Billing event condition base class

FS::part_event::Action - (New) Billing event action base class

FS::part_event_condition - (New) Billing event condition class

FS::part_event_condition_option - (New) Billing event condition option class

FS::part_event_condition_option_option - (New) Billing event condition compound option class

FS::cust_event - (New) Customer event class

FS::cust_bill_ApplicationCommon - Base class for bill application classes

FS::cust_pay - Payment class

FS::cust_pay_void - Voided payment class

FS::cust_bill_pay - Payment application class

FS::cust_bill_pay_pkg - Line-item specific payment application class

FS::cust_bill_pay_batch - Batch 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_credit_bill_pkg - Line-item specific 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

FS::clientapi_session

FS::clientapi_session_field

Historical database record classes

FS::h_Common - History table base class

FS::h_cust_bill - Historical record of customer tax changes (old-style)

FS::h_cust_svc - Object method for h_cust_svc objects

FS::h_cust_tax_exempt - Historical record of customer tax changes (old-style)

FS::h_domain_record - Historical DNS entry objects

FS::h_svc_acct - Historical account objects

FS::h_svc_broadband - Historical broadband connection objects

FS::h_svc_domain - Historical domain objects

FS::h_svc_external - Historical externally tracked service objects

FS::h_svc_forward - Historical mail forwarding alias objects

FS::h_svc_phone - Historical phone number objects

FS::h_svc_www - Historical web virtual host objects

Client API

FS::ClientAPI

FS::ClientAPI_SessionCache

FS::ClientAPI::Signup

FS::ClientAPI::passwd

FS::ClientAPI::MyAccount

FS::ClientAPI::Agent

Remote API modules

FS::SelfService

FS::SignupClient

FS::SessionClient

FS::MailAdminServer (deprecated in favor of the self-service server)

User Interface classes

FS::UI::Web - Web user-interface class

FS::UI::bytecount - Byte counter user-interface class

Command-line utilities

freeside-adduser

freeside-queued

freeside-daily

freeside-expiration-alerter

freeside-email

freeside-cc-receipts-report

freeside-credit-report

freeside-receivables-report

freeside-tax-report

freeside-bill

freeside-overdue

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 wired and wireless ISPs, VoIP, hosting, service and content providers and other online businesses.

The Freeside home page is at <http://www.sisd.com/freeside>.

The main documentation is at <http://www.sisd.com/mediawiki>.

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>.

AUTHORS

Primarily Ivan Kohler, with help from many kind folks, including core contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.

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 at <http://www.sisd.com/mediawiki/>

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...