start adding package locations, RT#4499

[freeside.git] / FS / FS.pm

diff --git a/FS/FS.pm b/FS/FS.pm
index d097071..c4be977 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -25,6 +25,8 @@ L<FS::Schema> - Freeside database schema
 
 L<FS::Setup> - Setup subroutines
 
+L<FS::Upgrade> - Upgrade subroutines
+
 L<FS::Conf> - Freeside configuration values
 
 L<FS::ConfItem> - Freeside configuration option meta-data.
@@ -41,15 +43,13 @@ L<FS::Msgcat> - Message catalog
 
 L<FS::SearchCache> - Search cache
 
-L<FS::raddb> - RADIUS dictionary
-
 L<FS::AccessRight> - Access control rights.
 
 L<FS::Report> - Report data objects
 
 L<FS::Report::Table> - Report data objects
 
-L<FS::Report::Monthly> - Report data objects
+L<FS::Report::Table::Monthly> - Report data objects
 
 L<FS::XMLRPC> - Backend XML::RPC server
 
@@ -57,8 +57,12 @@ L<FS::Misc> - Miscellaneous subroutines
 
 L<FS::payby> - Payment types
 
+L<FS::ClientAPI_SessionCache> - ClientAPI session cache
+
 L<FS::Pony> - A pony
 
+L<FS::cust_main::Import> - Batch customer importing
+
 =head2 Database record classes
 
 L<FS::Record> - Database record base class
@@ -69,7 +73,7 @@ L<FS::m2name_Common> - Base class for tables with a related table listing names
 
 L<FS::option_Common> - Base class for option sub-classes
 
-L<FS::pkg_class> - Package class class
+L<FS::conf> - Configuration value class
 
 L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
 
@@ -92,6 +96,8 @@ L<FS::part_pop_local> - Local calling area class
 
 L<FS::part_referral> - Referral class
 
+L<FS::pkg_referral> - Package referral class
+
 L<FS::cust_main_county> - Locale (tax rate) class
 
 L<FS::cust_tax_exempt> - Tax exemption record class
@@ -106,6 +112,8 @@ L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
 
 L<FS::acct_snarf> - External mail account class
 
+L<FS::acct_rt_transaction> - Time worked application to account class
+
 L<FS::radius_usergroup> - RADIUS groups
 
 L<FS::svc_domain> - Domain class
@@ -124,8 +132,12 @@ L<FS::addr_block> - Address block class
 
 L<FS::router> - Router class
 
+L<FS::part_virtual_field> - Broadband virtual field class
+
 L<FS::svc_phone> - Phone service class
 
+L<FS::phone_avail> - Phone number availability cache
+
 L<FS::cdr> - Call Detail Record class
 
 L<FS::cdr_calltype> - CDR calltype class
@@ -153,10 +165,16 @@ L<FS::part_export> - External provisioning export class
 
 L<FS::part_export_option> - Export option class
 
+L<FS::pkg_category> - Package category class
+
 L<FS::pkg_class> - Package class class
 
 L<FS::part_pkg> - Package definition class
 
+L<FS::part_pkg_link> - Package definition link class
+
+L<FS::part_pkg_taxclass> - Tax class class
+
 L<FS::part_pkg_option> - Package definition option class
 
 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
@@ -174,6 +192,8 @@ L<FS::rate_prefix> - Rate region prefixes for call billing
 
 L<FS::rate_detail> - Rate plan detail for call billing
 
+L<FS::usage_class> - Usage class class
+
 L<FS::agent> - Agent (reseller) class
 
 L<FS::agent_type> - Agent type class
@@ -192,6 +212,8 @@ L<FS::cust_pkg> - Customer package class
 
 L<FS::cust_pkg_option> - Customer package option class
 
+L<FS::cust_pkg_detail> - Customer package details class
+
 L<FS::reason_type> - Reason type class
 
 L<FS::reason> - Reason class
@@ -200,6 +222,8 @@ L<FS::cust_pkg_reason> - Package reason class
 
 L<FS::cust_main> - Customer class
 
+L<FS::cust_main_location> - Customer location class
+
 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 
 L<FS::cust_main_invoice> - Invoice destination class
@@ -214,14 +238,32 @@ L<FS::cust_bill_pkg> - Invoice line item class
 
 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 
-L<FS::part_bill_event> - Invoice event definition class
+L<FS::part_bill_event> - (Old) Invoice event definition class
+
+L<FS::cust_bill_event> - (Old) Completed invoice event class
+
+L<FS::part_event> - (New) Billing event definition class
+
+L<FS::part_event_option> - (New) Billing event option class
+
+L<FS::part_event::Condition> - (New) Billing event condition base class
 
-L<FS::cust_bill_event> - Completed invoice event class
+L<FS::part_event::Action> - (New) Billing event action base class
+
+L<FS::part_event_condition> - (New) Billing event condition class
+
+L<FS::part_event_condition_option> - (New) Billing event condition option class
+
+L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
+
+L<FS::cust_event> - (New) Customer event class
 
 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
 
 L<FS::cust_pay> - Payment class
 
+L<FS::cust_pay_pending> - Pending payment class
+
 L<FS::cust_pay_void> - Voided payment class
 
 L<FS::cust_bill_pay> - Payment application class
@@ -270,6 +312,10 @@ L<FS::clientapi_session_field>
 
 L<FS::h_Common> - History table base class
 
+L<FS::h_cust_pay> - Historical record of customer payment changes
+
+L<FS::h_cust_credit> - Historical record of customer credit changes
+
 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
 
 L<FS::h_cust_svc> - Object method for h_cust_svc objects
@@ -292,59 +338,57 @@ L<FS::h_svc_phone> - Historical phone number objects
 
 L<FS::h_svc_www> - Historical web virtual host objects
 
-=head2 Client API
-
-L<FS::ClientAPI>
+=head2 Remote API modules
 
-L<FS::ClientAPI_SessionCache>
+L<FS::SelfService> - Self-service API
 
-L<FS::ClientAPI::Signup>
+L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
 
-L<FS::ClientAPI::passwd>
+=head2 User Interface classes
 
-L<FS::ClientAPI::MyAccount>
+L<FS::UI::Web> - Web user-interface class
 
-L<FS::ClientAPI::Agent>
+L<FS::UI::bytecount> - Byte counter user-interface class
 
-=head2 Remote API modules
+=head2 Command-line utilities
 
-L<FS::SelfService>
+L<freeside-adduser> - Command line interface to add (freeside) users.
 
-L<FS::SignupClient>
+L<freeside-daily> - Run daily billing and collection events.
 
-L<FS::SessionClient>
+L<freeside-monthly> - Run monthly billing and invoice collection events.
 
-L<FS::MailAdminServer> (deprecated in favor of the self-service server)
+L<freeside-dbdef-create> - Recreate database schema cache
 
-=head2 User Interface classes
+L<freeside-deluser> - Command line interface to delete (freeside) users.
 
-L<FS::UI::Web> - Web user-interface class
+L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
 
-L<FS::UI::bytecount> - Byte counter user-interface class
+L<freeside-email> -  Prints email addresses of all users on STDOUT
 
-=head2 Command-line utilities
+L<freeside-fetch> - Send a freeside page to a list of employees.
 
-L<freeside-adduser>
+L<freeside-prepaidd> - Real-time daemon for prepaid packages
 
-L<freeside-queued>
+L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
 
-L<freeside-daily>
+L<freeside-queued> - Job queue daemon
 
-L<freeside-expiration-alerter>
+L<freeside-radgroup> - Command line utility to manipulate radius groups
 
-L<freeside-email>
+L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
 
-L<freeside-cc-receipts-report>
+L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
 
-L<freeside-credit-report>
+L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
 
-L<freeside-receivables-report>
+L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
 
-L<freeside-tax-report>
+L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
 
-L<freeside-bill>
+L<freeside-sqlradius-seconds> - Command line time-online tool
 
-L<freeside-overdue>
+L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
 
 =head1 Notes