so Search.tsf and Search.rdf work

[freeside.git] / FS / FS.pm

diff --git a/FS/FS.pm b/FS/FS.pm
index 60831ec..f5b2b96 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -3,7 +3,10 @@ package FS;
 use strict;
 use vars qw($VERSION);
 
-$VERSION = '0.01';
+$VERSION = '%%%VERSION%%%';
+
+#find missing entries in this file with:
+# for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
 
 1;
 __END__
@@ -26,6 +29,12 @@ L<FS::UID> - User class (not yet OO)
 
 L<FS::CGI> - Non OO-subroutines for the web interface.
 
+L<FS::Msgcat> - Message catalog
+
+L<FS::SearchCache> - Search cache
+
+L<FS::raddb> - RADIUS dictionary
+
 =head2 Database record classes
 
 L<FS::Record> - Database record base class
@@ -39,45 +48,68 @@ L<FS::part_referral> - Referral class
 
 L<FS::cust_main_county> - Locale (tax rate) class
 
+L<FS::cust_tax_exempt> - Tax exemption record class
+
 L<FS::svc_Common> - Service base class
 
 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
 
+L<FS::acct_snarf> - External mail account class
+
+L<FS::radius_usergroup> - RADIUS groups
+
 L<FS::svc_domain> - Domain class
 
 L<FS::domain_record> - DNS zone entries
 
 L<FS::svc_forward> - Mail forwarding class
 
-L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
-
 L<FS::svc_www> - Web virtual host class.
 
+L<FS::svc_broadband> - DSL, wireless and other broadband class.
+
+L<FS::svc_external> - Externally tracked service class.
+
 L<FS::part_svc> - Service definition class
 
 L<FS::part_svc_column> - Column constraint class
 
+L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
+with exports (see L<FS::part_export>)
+
 L<FS::part_export> - External provisioning export class
 
 L<FS::part_export_option> - Export option class
 
-L<FS::part_pkg> - Package (billing item) definition class
+L<FS::part_pkg> - Package definition class
 
-L<FS::pkg_svc> - Class linking package (billing item)
-definitions (see L<FS::part_pkg>) with service definitions
-(see L<FS::part_svc>)
+L<FS::part_pkg_option> - Package definition option class
+
+L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
+service definitions (see L<FS::part_svc>)
+
+L<FS::reg_code> - One-time registration codes
+
+L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
+
+L<FS::rate> - Rate plans for call billing
+
+L<FS::rate_region> - Rate regions for call billing
+
+L<FS::rate_prefix> - Rate region prefixes for call billing
+
+L<FS::rate_detail> - Rate plan detail for call billing
 
 L<FS::agent> - Agent (reseller) class
 
 L<FS::agent_type> - Agent type class
 
-L<FS::type_pkgs> - Class linking agent types (see
-L<FS::agent_type>) with package (billing item) definitions
-(see L<FS::part_pkg>)
+L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with
+package definitions (see L<FS::part_pkg>)
 
 L<FS::cust_svc> - Service class
 
-L<FS::cust_pkg> - Package (billing item) class
+L<FS::cust_pkg> - Customer package class
 
 L<FS::cust_main> - Customer class
 
@@ -88,21 +120,27 @@ L<FS::cust_bill> - Invoice class
 
 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::cust_bill_event> - Completed invoice event class
 
 L<FS::cust_pay> - Payment class
 
+L<FS::cust_pay_void> - Voided payment class
+
 L<FS::cust_bill_pay> - Payment application class
 
 L<FS::cust_credit> - Credit class
 
 L<FS::cust_refund> - Refund class
 
-L<FS::cust_credit_refund> - Refund application class
+L<FS::cust_credit_refund> - Refund application to credit class
 
-L<FS::cust_credit_bill> - Credit invoice application class
+L<FS::cust_credit_bill> - Credit application to invoice class
+
+L<FS::cust_pay_refund> - Refund application to payment class
 
 L<FS::cust_pay_batch> - Credit card transaction queue class
 
@@ -118,35 +156,65 @@ L<FS::queue> - Job queue
 
 L<FS::queue_arg> - Job arguments
 
+L<FS::queue_depend> - Job dependencies
+
+L<FS::msgcat> - Message catalogs
+
+L<FS::clientapi_session>
+
+L<FS::clientapi_session_field>
+
+=head1 Client API
+
+L<FS::ClientAPI>
+
+L<FS::ClientAPI_SessionCache>
+
+L<FS::ClientAPI::Signup>
+
+L<FS::ClientAPI::passwd>
+
+L<FS::ClientAPI::MyAccount>
+
+L<FS::ClientAPI::Agent>
+
 =head1 Remote API modules
 
+L<FS::SelfService>
+
 L<FS::SignupClient>
 
 L<FS::SessionClient>
 
-L<FS::MailAdminServer>
+L<FS::MailAdminServer> (deprecated in favor of the self-service server)
 
 =head2 Command-line utilities
 
-L<freeside-email>
+L<freeside-adduser>
 
 L<freeside-queued>
 
-L<freeside-adduser>
+L<freeside-daily>
 
-L<freeside-bill>
+L<freeside-expiration-alerter>
 
-L<freeside-overdue>
+L<freeside-email>
 
-=head2 User Interface classes (under (stalled) development; not yet usable)
+L<freeside-cc-receipts-report>
 
-L<FS::UI::Base> - User-interface base class
+L<freeside-credit-report>
 
-L<FS::UI::Gtk> - Gtk user-interface class
+L<freeside-receivables-report>
+
+L<freeside-tax-report>
+
+L<freeside-bill>
+
+L<freeside-overdue>
 
-L<FS::UI::CGI> - CGI (HTML) user-interface class
+=head2 User Interface classes
 
-L<FS::UI::agent> - agent table user-interface class
+L<FS::UI::Web> - Web user-interface class
 
 =head2 Notes
 
@@ -155,7 +223,7 @@ first time, the suggested order will tend to reduce the number of forward
 references."
 
 If you've never used OO modules before,
-http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
+http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 
 =head1 DESCRIPTION