6 $VERSION = '%%%VERSION%%%';
8 #find missing entries in this file with:
9 # for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
16 FS - Freeside Perl modules
20 Freeside perl modules and CLI utilities.
22 =head2 Utility classes
24 L<FS::Conf> - Freeside configuration values
26 L<FS::ConfItem> - Freeside configuration option meta-data.
28 L<FS::UID> - User class (not yet OO)
30 L<FS::CGI> - Non OO-subroutines for the web interface.
32 L<FS::Msgcat> - Message catalog
34 L<FS::SearchCache> - Search cache
36 L<FS::raddb> - RADIUS dictionary
38 =head2 Database record classes
40 L<FS::Record> - Database record base class
42 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
43 Office Protocol) class
45 L<FS::part_pop_local> - Local calling area class
47 L<FS::part_referral> - Referral class
49 L<FS::cust_main_county> - Locale (tax rate) class
51 L<FS::cust_tax_exempt> - Tax exemption record class
53 L<FS::svc_Common> - Service base class
55 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
57 L<FS::acct_snarf> - External mail account class
59 L<FS::radius_usergroup> - RADIUS groups
61 L<FS::svc_domain> - Domain class
63 L<FS::domain_record> - DNS zone entries
65 L<FS::svc_forward> - Mail forwarding class
67 L<FS::svc_www> - Web virtual host class.
69 L<FS::svc_broadband> - DSL, wireless and other broadband class.
71 L<FS::svc_external> - Externally tracked service class.
73 L<FS::part_svc> - Service definition class
75 L<FS::part_svc_column> - Column constraint class
77 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
78 with exports (see L<FS::part_export>)
80 L<FS::part_export> - External provisioning export class
82 L<FS::part_export_option> - Export option class
84 L<FS::part_pkg> - Package definition class
86 L<FS::part_pkg_option> - Package definition option class
88 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
89 service definitions (see L<FS::part_svc>)
91 L<FS::reg_code> - One-time registration codes
93 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
95 L<FS::rate> - Rate plans for call billing
97 L<FS::rate_region> - Rate regions for call billing
99 L<FS::rate_prefix> - Rate region prefixes for call billing
101 L<FS::rate_detail> - Rate plan detail for call billing
103 L<FS::agent> - Agent (reseller) class
105 L<FS::agent_type> - Agent type class
107 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with
108 package definitions (see L<FS::part_pkg>)
110 L<FS::cust_svc> - Service class
112 L<FS::cust_pkg> - Customer package class
114 L<FS::cust_pkg_option> - Customer package option class
116 L<FS::cust_main> - Customer class
118 L<FS::cust_main_invoice> - Invoice destination
121 L<FS::cust_bill> - Invoice class
123 L<FS::cust_bill_pkg> - Invoice line item class
125 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
127 L<FS::part_bill_event> - Invoice event definition class
129 L<FS::cust_bill_event> - Completed invoice event class
131 L<FS::cust_pay> - Payment class
133 L<FS::cust_pay_void> - Voided payment class
135 L<FS::cust_bill_pay> - Payment application class
137 L<FS::cust_credit> - Credit class
139 L<FS::cust_refund> - Refund class
141 L<FS::cust_credit_refund> - Refund application to credit class
143 L<FS::cust_credit_bill> - Credit application to invoice class
145 L<FS::cust_pay_refund> - Refund application to payment class
147 L<FS::pay_batch> - Credit card transaction queue class
149 L<FS::cust_pay_batch> - Credit card transaction member queue class
151 L<FS::prepay_credit> - Prepaid "calling card" credit class.
153 L<FS::nas> - Network Access Server class
155 L<FS::port> - NAS port class
157 L<FS::session> - User login session class
159 L<FS::queue> - Job queue
161 L<FS::queue_arg> - Job arguments
163 L<FS::queue_depend> - Job dependencies
165 L<FS::msgcat> - Message catalogs
167 L<FS::clientapi_session>
169 L<FS::clientapi_session_field>
175 L<FS::ClientAPI_SessionCache>
177 L<FS::ClientAPI::Signup>
179 L<FS::ClientAPI::passwd>
181 L<FS::ClientAPI::MyAccount>
183 L<FS::ClientAPI::Agent>
185 =head1 Remote API modules
193 L<FS::MailAdminServer> (deprecated in favor of the self-service server)
195 =head2 Command-line utilities
203 L<freeside-expiration-alerter>
207 L<freeside-cc-receipts-report>
209 L<freeside-credit-report>
211 L<freeside-receivables-report>
213 L<freeside-tax-report>
219 =head2 User Interface classes
221 L<FS::UI::Web> - Web user-interface class
225 To quote perl(1), "If you're intending to read these straight through for the
226 first time, the suggested order will tend to reduce the number of forward
229 If you've never used OO modules before,
230 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
234 Freeside is a billing and administration package for Internet Service
237 The Freeside home page is at <http://www.sisd.com/freeside>.
239 The main documentation is in httemplate/docs.
243 A mailing list for users is available. Send a blank message to
244 <freeside-users-subscribe@sisd.com> to subscribe.
246 A mailing list for developers is available. It is intended to be lower volume
247 and higher SNR than the users list. Send a blank message to
248 <freeside-devel-subscribe@sisd.com> to subscribe.
250 Commercial support is available; see
251 <http://www.sisd.com/freeside/commercial.html>.
255 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
257 See the CREDITS file in the Freeside distribution for a (hopefully) complete
258 list and the individal files for details.
262 perl(1), main Freeside documentation in htdocs/docs/
266 Those modules which would be useful separately should be pulled out,
267 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH